Documentation

Wallet Actions

wallet_actions

Domain types

EarnAsset = { address, decimals, symbol }

Asset metadata for an earn vault position.

EarnDepositActionResponse = { id, asset_address, caip2, 13 more... }

Response for an earn deposit action.

EarnDepositRequestBody = { vault_id, amount, raw_amount }

Input for depositing assets into an ERC-4626 vault. Exactly one of amount or raw_amount must be provided.

EarnIncentiveClaimActionResponse = { id, chain, created_at, 6 more... }

Response for an earn incentive claim action.

EarnIncentiveClaimRequestBody = { chain }

Input for claiming incentive rewards.

EarnIncentiveRewardEntry = { amount_claimed, amount_unclaimed, token_address, 2 more... }

A reward token with claimed and unclaimed amounts.

EarnIncentiveRewardsQuery = { chain }

Query parameters for fetching incentive rewards.

EarnIncentiveRewardsResponse = { rewards }

All incentive rewards for a wallet, with claimed and unclaimed amounts per token.

EarnIncetiveClaimRewardEntry = { amount, token_address, token_symbol, 1 more... }

A specific reward token and amount associated with an earn incentive claim.

EarnWithdrawActionResponse = { id, asset_address, caip2, 13 more... }

Response for an earn withdraw action.

EarnWithdrawRequestBody = { vault_id, amount, raw_amount }

Input for withdrawing assets from an ERC-4626 vault. Exactly one of amount or raw_amount must be provided.

EthereumEarnPositionQuery = { vault_id }

Query parameters for fetching an earn vault position.

EthereumEarnPositionResponse = { asset, assets_in_vault, shares_in_vault, 2 more... }

A wallet's position in an earn vault.

EthereumEarnProvider = "morpho" | "aave"

Supported earn provider protocols.

EthereumEarnVaultDetailsResponse = { id, app_apy, asset, 7 more... }

Detailed vault information including current APY, liquidity, and asset metadata.

EvmTransactionWalletActionStep = { caip2, status, transaction_hash, 2 more... }

A wallet action step consisting of an EVM transaction.

EvmUserOperationWalletActionStep = { bundle_transaction_hash, caip2, entrypoint_version, 4 more... }

A wallet action step consisting of an EVM user operation.

EvmWalletActionStepStatus = "preparing" | "queued" | "pending" | 6 more...

Status of an EVM step in a wallet action.

ExternalTransactionWalletActionStep = { status, type, failure_reason }

A wallet action step representing a cross-chain/cross-asset fill by an external provider.

ExternalTransactionWalletActionStepStatus = "preparing" | "queued" | "pending" | 3 more...

Status of an external transaction step in a wallet action.

FailureReason = { message, details }

A description of why a wallet action (or a step within a wallet action) failed.

SvmTransactionWalletActionStep = { caip2, status, transaction_signature, 2 more... }

A wallet action step consisting of an SVM (Solana) transaction.

SvmWalletActionStepStatus = "preparing" | "queued" | "pending" | 5 more...

Status of an SVM step in a wallet action.

SwapActionResponse = { id, caip2, created_at, 14 more... }

Response for a swap action.

TransferActionResponse = { id, created_at, destination_address, 17 more... }

Response for a transfer action.

WalletActionResponse =
SwapActionResponse
|
TransferActionResponse
|
EarnDepositActionResponse
| 2 more...

Response for a wallet action, discriminated on type.

WalletActionStatus = "pending" | "succeeded" | "rejected" | 1 more...

Status of a wallet action.

WalletActionStep =
EvmTransactionWalletActionStep
|
EvmUserOperationWalletActionStep
|
SvmTransactionWalletActionStep
| 1 more...

A step within a wallet action, representing a single onchain action.

WalletActionStepType = "evm_transaction" | "evm_user_operation" | "svm_transaction" | 1 more...

Type of a wallet action step.

WalletActionType = "swap" | "transfer" | "earn_deposit" | 2 more...

Type of wallet action