Earn

​

sdk.earn

​

getVaults

try await sdk.earn.getVaults() -> [EarnVaultSummary]

​

Returns

• [EarnVaultSummary] — Vaults available to the environment, ordered as the API returns them

​

Example

let sdk = DynamicSDK.instance()

let vaults = try await sdk.earn.getVaults()
for vault in vaults {
    print("\(vault.assetSymbol) by \(vault.curator), chain \(vault.chainId)")
}

​

getVaultDetails

try await sdk.earn.getVaultDetails(vaultId: String) -> EarnVaultDetails

​

Parameters

• vaultId (String) — Opaque vault identifier, from getVaults

​

Returns

• EarnVaultDetails — Vault metadata including assetDecimals and contractAddress

​

Example

let vault = try await sdk.earn.getVaultDetails(vaultId: vaults[0].vaultId)
print("Asset decimals: \(vault.assetDecimals)")

​

getVaultPosition

try await sdk.earn.getVaultPosition(
    vaultId: String,
    ownerAddress: String
) -> EarnVaultPosition

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address that owns the position

​

Returns

• EarnVaultPosition — shares and assets, both in raw token units. Show assets; it grows as yield accrues

​

Example

let position = try await sdk.earn.getVaultPosition(
    vaultId: vault.vaultId,
    ownerAddress: wallet.address
)
print("Position: \(position.assets) raw units")

​

getVaultRewards

try await sdk.earn.getVaultRewards(
    vaultId: String,
    ownerAddress: String
) -> [EarnVaultReward]

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address that owns the rewards

​

Returns

• [EarnVaultReward] — Accrued rewards, empty when the wallet has none. Each reward carries accrued in raw units and its own tokenDecimals

​

getVaultPerformance

try await sdk.earn.getVaultPerformance(
    vaultId: String,
    ownerAddress: String
) -> EarnVaultPerformance

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address that owns the position

​

Returns

• EarnVaultPerformance — netEarningsAssets in raw token units and returnOnCapital as a decimal, nil when the position has too little history

​

getEarnings

try await sdk.earn.getEarnings(
    chainId: Int,
    ownerAddress: String
) -> EarnEarnings

​

Parameters

• chainId (Int) — EVM chain ID the earnings are aggregated on, for example 8453 for Base
• ownerAddress (String) — Wallet address the earnings belong to

​

Returns

• EarnEarnings — totalAssetsUsd and totalPnlUsd totals plus a per-vault vaults breakdown. Positions whose provider does not report a cost basis carry nil PNL fields

​

deposit

try await sdk.earn.deposit(
    vaultId: String,
    ownerAddress: String,
    amount: String,
    receiverAddress: String? = nil
) -> EarnVaultActionResponse

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address funding the deposit
• amount (String) — Human-readable amount in the vault asset ("12.5"), with a leading digit ("0.01", not ".01")
• receiverAddress (String?, optional) — Wallet that receives the vault shares. Defaults to ownerAddress

​

Returns

• EarnVaultActionResponse — Carries the signingPayload to pass to execute

​

withdraw

try await sdk.earn.withdraw(
    vaultId: String,
    ownerAddress: String,
    amount: String,
    receiverAddress: String? = nil
) -> EarnVaultActionResponse

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address that owns the shares
• amount (String) — Human-readable amount in the vault asset
• receiverAddress (String?, optional) — Wallet that receives the withdrawn assets. Defaults to ownerAddress

​

Returns

• EarnVaultActionResponse — Carries the signingPayload to pass to execute

​

claim

try await sdk.earn.claim(
    vaultId: String,
    ownerAddress: String
) -> EarnVaultActionResponse

​

Parameters

• vaultId (String) — Opaque vault identifier
• ownerAddress (String) — Wallet address that owns the rewards

​

Returns

• EarnVaultActionResponse — Carries the signingPayload to pass to execute

​

execute

try await sdk.earn.execute(
    payload: EarnSigningPayload,
    wallet: BaseWallet,
    sponsored: Bool? = nil,
    onStepChange: ((EarnExecutionStep) -> Void)? = nil,
    onTransactionStepChange: ((EarnTransactionStepChange) -> Void)? = nil
) -> String

​

Parameters

• payload (EarnSigningPayload) — The signingPayload from a vault action response
• wallet (BaseWallet) — Wallet to sign with. Its chain must match the payload’s chainName
• sponsored (Bool?, optional) — How fees are paid. true requires gas sponsorship and throws EarnSponsorError when unavailable, false always pays from the wallet, nil sponsors when the environment enables it
• onStepChange ((EarnExecutionStep) -> Void, optional) — Reports .approval before an ERC-20 approval is sent and .transaction before each vault transaction
• onTransactionStepChange ((EarnTransactionStepChange) -> Void, optional) — Solana only: reports each transaction’s ordinal, total, and label as it begins

​

Returns

• String — The vault transaction hash (the last signature on Solana)

​

Example

let deposit = try await sdk.earn.deposit(
    vaultId: vault.vaultId,
    ownerAddress: wallet.address,
    amount: "12.5"
)

let transactionHash = try await sdk.earn.execute(
    payload: deposit.signingPayload,
    wallet: wallet,
    onStepChange: { step in
        print("Step: \(step)")
    },
    onTransactionStepChange: { step in
        print("Transaction \(step.ordinal + 1) of \(step.total)")
    }
)

​

Error types

​

EarnError

​

EarnSolanaStepError

​

EarnSponsorError