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

    Interface ApiUnstakeBody

    Inputs for building an afSUI-to-SUI unstaking transaction.

    afSuiUnstakeAmount uses raw afSUI units. Atomic mode depends on the vault's SUI reserves; queued mode creates a request for epoch processing.

    interface ApiUnstakeBody {
        afSuiUnstakeAmount: bigint;
        externalFee?: ExternalFee;
        isAtomic: boolean;
        isSponsoredTx?: boolean;
        referrer?: string;
        walletAddress: string;
    }
    Index
    afSuiUnstakeAmount externalFee? isAtomic isSponsoredTx? referrer? walletAddress
    afSuiUnstakeAmount: bigint

    afSUI amount to unstake, in raw afSUI units. 1_000_000_000n is 1 afSUI.

    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.

    isAtomic: boolean

    Selects the atomic entry point when true and the queued request entry point when false. Atomic execution can fail with Insufficient Sui Reserves.

    isSponsoredTx?: boolean

    Sponsorship flag accepted by the shared input shape. The current unstake builder does not forward it to afSUI coin selection.

    referrer?: string

    Optional address recorded in the referral vault before unstaking.

    walletAddress: string

    Wallet address that owns the afSUI coin and receives returned SUI in atomic mode.

    Settings
    Member Visibility

    On This Page
    Properties