- `required`: caller provides an amount - `optional`: omitted means everything eligible - `wholeBalance`: the operation always applies to the whole balance - `none`: amount does not apply

StakingApi

type

Exposed as `api.staking` on the staked asset, base asset or token, when `api.features.stakingApi` is true. Never exposed on combined assets; staking lives on their network member assets.

Properties

canPerform

any

classifyTx

`asset` is the asset whose activity is rendered; `tx` may come from its base asset tx log.

any

getCapabilities

any

getLimits

any

getStakingState

any

listTargets?

Only when `capabilities.target.selection` is `selectable`.

any

prepare?

Builds the transactions of one operation declared in `capabilities.operations`. `prepare` and `submit` are present when at least one operation is declared. Rejects with `StakingRejectionError`.

any

submit?

Rejects with `StakingRejectionError` before sending, or `StakingSubmitError` when a transaction fails.

any

StakingAsset

type

Asset exposing `api.staking`: a base asset or a token, never a combined asset.

StakingAsyncParams

type

Params of async methods. They load account state, fee data and addresses through the asset client interface.

Properties

asset

StakingAsset

walletAccount

WalletAccountLike

StakingAutoCompound

type

Properties

active

boolean

enabled

boolean

expiresAt?

Timestamp

StakingCanPerformResult

type

Properties

boolean

reasonCode?

StakingReasonCode

shortfall?

Extra amount needed to pass, rendered as is by the wallet.

NumberUnit

shortfallAssetName?

Asset the shortfall is denominated in.

string

warnings?

Non blocking conditions, e.g. `LOW_FEE_BALANCE` when a stake leaves too little to pay later exit fees, or `LOW_FEE_BALANCE_FOR_CLAIM` when an unstake leaves too little to pay the claim fee.

StakingReasonCode[]

StakingCapabilities

type

Properties

activation?

any

claimUnstaked

"automatic" | "manual" | "none"

feeAssetName

Asset paying the fees of staking transactions, e.g. ethereum for polygon.

string

hardwareWallets?

Hardware wallet sources whose accounts can sign staking txs, e.g. `['trezor']`.

string[]

liquid

Staked funds remain spendable; `frozen` excludes them.

boolean

maxPositions?

Unbonding positions allowed per staking target, e.g. 7 per validator on cosmos.

number

operations

Only the declared operations have a `prepare*` method. Empty for passive chains.

Partial

participation

StakingParticipation

positions

"aggregate" | "multiple"

rewards

any

target

any

unbonding

any

StakingLimits

type

Limits of one operation. Rules spanning amounts, e.g. minimum remaining stake, are enforced by `canPerform`.

Properties

estimatedFee?

Fee estimate shown before confirming, in `capabilities.feeAssetName`; the plan fee is authoritative.

NumberUnit

max

Estimate for a max button; a plan prepared with `isMax` is authoritative.

NumberUnit

min?

NumberUnit

reserve?

Balance kept aside, e.g. exit fees or rent exempt remainder.

NumberUnit

StakingOperation

type

StakingOperationCapability

type

Properties

amount

StakingAmountMode

multiTx

The plan may contain more than one transaction.

boolean

positionSelectable

Caller may pick `positionIds`.

boolean

supportsMax

`isMax` is supported; the plan deducts fees from the amount.

boolean

StakingOperationIntent

type

Properties

amount?

NumberUnit

isMax?

boolean

positionIds?

string[]

StakingParticipation

type

StakingPosition

type

Properties

amount

NumberUnit

availableAt?

When an activating position becomes active or a deactivating one becomes withdrawable.

Timestamp

Stake account address, validator address, unbond nonce or unbonding entry key.

string

rewards?

NumberUnit

status

StakingPositionStatus

target?

StakingTarget

StakingPositionStatus

type

StakingPrepareParams

type

StakingReasonCode

type

StakingRejectionError

type

Thrown by `prepare` and `submit` when an operation is rejected, e.g. by the `canPerform` rules or `PLAN_EXPIRED`.

StakingRewardsDistribution

type

StakingState

type

Properties

autoCompound?

StakingAutoCompound

earned?

Lifetime rewards, informational; not part of any balance. `undefined` while not loaded; zero only when known to be zero.

NumberUnit

hasPosition

Any non zero staking bucket; lets the wallet keep exits reachable when staking is disabled.

boolean

isStaking

A delegation or active position exists.

boolean

loaded

Monitor fetched staking data at least once.

boolean

nextRewardAt?

Estimated time of the next reward (the first one while no reward was earned yet), UTC ms. Computed by the chain; wallets render it as a countdown.

Timestamp

pendingOperation?

Operation pending confirmation, derived from unconfirmed txs.

StakingOperation

positions

Empty for aggregate chains without per position detail.

StakingPosition[]

target?

Current delegation target for delegation chains.

StakingTarget

totals

StakingTotals

StakingSubmitError

type

Thrown by `submit` when a transaction fails; earlier transactions of the plan may already be broadcast.

StakingSubmitMode

type

StakingSubmitParams

type

StakingSubmitProgress

type

Properties

index

Index in `plan.txs` of the transaction about to be signed and broadcast.

number

total

number

StakingSubmitResult

type

Properties

bundleId?

string

txIds

In plan order.

string[]

StakingSyncParams

type

Params of sync methods. They must not perform I/O. `accountState` and `feeData` are opaque to callers: pass them through, never read them.

Properties

accountState

Account state of `asset.baseAsset` for `walletAccount`, also for tokens.

AccountState

asset

The staked asset, base asset or token.

StakingAsset

feeData

Fee data of `asset.feeAsset`.

unknown

txLog?

Tx log of the staked asset; pending txs are applied to balances and pending operations.

TxSet

walletAccount

WalletAccountLike

StakingTarget

type

Properties

Validator address, pool hash, baker address or provider id.

string

kind

StakingTargetKind

name?

string

StakingTargetKind

type

StakingTotals

type

Must equal the staking fields returned by `api.getBalances`.

Properties

rewards

staked

staking

unstaked

unstaking

StakingTxClassification

type

Properties

amount?

NumberUnit

autoCompounded?

Rewards restaked automatically instead of being paid out.

boolean

availableAt?

`unstake` / `redelegate`: when the unbonding or redelegation completes.

Timestamp

deposit?

Refundable deposit the tx paid on top of its fee, e.g. the cardano stake key deposit on stake.

NumberUnit

direction?

Rewards: whether the rewards reached this wallet or another withdraw address.

"received" | "sent"

enabled?

`setAutoCompound`: whether auto compounding was turned on or off.

boolean

operation

StakingOperation | "reward"

refund?

Deposit the tx returned to the balance, e.g. the cardano stake key deposit on unstake.

NumberUnit

StakingTxPlan

type

Properties

amount

Effective amount, after deducting fees for `isMax`.

NumberUnit

assetName

string

deposit?

Part of `fee` that is a refundable deposit, e.g. the cardano stake key deposit; returned by a later operation.

NumberUnit

expiresAt?

The plan must be prepared again after this time, e.g. recent blockhash or nonce validity.

Timestamp

fee

Total fee of all transactions, in `feeAssetName`.

NumberUnit

feeAssetName

string

operation

StakingOperation

refund?

Deposit returned to the balance once the plan confirms, e.g. the cardano stake key deposit on unstake.

NumberUnit

submit

StakingSubmitMode

txs

Ordered transactions, e.g. approve then delegate.

UnsignedTxPayload[]

walletAccount

string

StakingUnbondingKind

type

StrictTxSendParams

type

Timestamp

type

Milliseconds since the Unix epoch, UTC.

TokenAsset

type

TokenAssetApi

type

Properties

getBalances

any

TokenOptInCost

type

Properties

accountReserve

fee

reserve

total

TokenOptInFeeData

type

TokensApi

type

Properties

canOptIn

any

canOptOut

any

createOptInTx

any

createOptOutTx

any

getOptInCost

any

isOptedIn

any

isRecipientOptedIn

any

TxSendParams

type

UnsignedTxPayload

type

Properties

txData

Extendable

txMeta

Extendable

WalletAccountLike

type

WalletAccountParams

type

WithRequired

type

Mark the given keys of target type as required

XOR

type

Exclusive OR

Overview @exodus/solidity-contract