internal/earn library

Classes

EarnClient
Yield vault discovery, positions, rewards, deposits, withdrawals, and reward claims. Implemented by EarnClientImpl; hosts can substitute this interface in tests.
EarnClientImpl
Yield vault discovery, positions, rewards, deposits, withdrawals, and reward claims. Instances share the root client's state. NOTE: not yet thread-safe.
EarnExtension
Registers EarnClientImpl on the root client. Access it through client.earn.
YieldEarnings
A wallet's aggregate and per-vault earnings on one chain.
YieldEvmApproval
ERC-20 allowance required before a yield action.
YieldEvmTransaction
Unsigned EVM transaction data for a yield action.
YieldSigningPayload
Unsigned chain payload returned for a yield action.
YieldTransactionResult
The hash of a submitted yield transaction.
YieldVaultActionRequest
A deposit or withdrawal request in human-readable asset units.
YieldVaultActionResponse
A vault identifier and its unsigned action payload.
YieldVaultClaimRequest
A reward claim request for one wallet.
YieldVaultDetails
Registry and live protocol data for one yield vault.
YieldVaultEarnings
A wallet's indexed earnings in one protocol vault.
YieldVaultListResponse
Yield vaults available to the current environment.
YieldVaultPosition
A wallet's live share balance and asset value in a vault.
YieldVaultPositionPerformance
A wallet's indexed earnings and return in one vault.
YieldVaultReward
One accrued reward token for a vault position.
YieldVaultRewardsResponse
Accrued rewards for a wallet in one vault.
YieldVaultSummary
A yield vault available to the current environment.

Extensions

DynamicClientEarn on DynamicClient
Convenience accessor: fetches the installed EarnClientImpl. Throws a clear error instead of a raw getExtension
EarnBuilder on DynamicClient
Installs Earn and returns the client for chaining.