EarnClientImpl class

Yield vault discovery, positions, rewards, deposits, withdrawals, and reward claims. Instances share the root client's state. NOTE: not yet thread-safe.

Implemented types

• EarnClient
• DynamicExtension

Properties

hashCode → int

The hash code for this object.

no setter, inherited

name → String

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

claimRewards(String vaultId, String ownerAddress, [bool? sponsored]) → Future<YieldTransactionResult>

Claims accrued vault rewards and returns the transaction hash.

override

configure() → void

Installs Earn with its EVM transaction executor.

override

deposit(String vaultId, String ownerAddress, String amount, [String? receiverAddress, bool? sponsored]) → Future<YieldTransactionResult>

Deposits into a yield vault and returns the transaction hash.

override

getDetails(String vaultId) → Future<YieldVaultDetails>

Gets registry and live protocol data for one vault.

override

getEarnings(String ownerAddress, String chainId) → Future<YieldEarnings>

Gets a wallet's indexed earnings on one EVM chain.

override

getPerformance(String vaultId, String ownerAddress) → Future<YieldVaultPositionPerformance>

Gets a wallet's indexed performance in one vault.

override

getPosition(String vaultId, String ownerAddress) → Future<YieldVaultPosition>

Gets a wallet's live position in one vault.

override

getRewards(String vaultId, String ownerAddress) → Future<List<YieldVaultReward>>

Gets a wallet's accrued rewards in one vault.

override

install(DynamicClient client) → void

override

listVaults() → Future<List<YieldVaultSummary>>

Lists yield vaults available to this environment.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

withdraw(String vaultId, String ownerAddress, String amount, [String? receiverAddress, bool? sponsored]) → Future<YieldTransactionResult>

Withdraws from a yield vault and returns the transaction hash.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited