aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface ApiStakeBody

    Inputs for building a liquid-staking transaction that converts SUI to afSUI.

    suiStakeAmount uses raw SUI units. The builder also requires the selected validator to be active and applies the external-fee bounds before it adds the transaction commands.

    interface ApiStakeBody {
        externalFee?: ExternalFee;
        isSponsoredTx?: boolean;
        referrer?: string;
        suiStakeAmount: bigint;
        validatorAddress: string;
        walletAddress: string;
    }
    Index
    externalFee? isSponsoredTx? referrer? suiStakeAmount validatorAddress walletAddress
    externalFee?: ExternalFee

    Optional third-party fee recipient and decimal fee ratio. The builder requires a ratio greater than 0 and strictly less than 0.5.

    isSponsoredTx?: boolean

    Whether the SUI coin-selection helper should build for a sponsored flow.

    referrer?: string

    Optional address recorded in the referral vault before staking.

    suiStakeAmount: bigint

    SUI amount to stake, in raw SUI units. 1_000_000_000n is 1 SUI.

    validatorAddress: string

    Active validator that receives the native stake.

    walletAddress: string

    Wallet address that owns the SUI coin and receives the afSUI result.

    Settings
    Member Visibility

    On This Page
    Properties