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

    Interface ApiFarmsUnstakeBody

    Parameters for withdrawing principal and optionally harvesting rewards.

    interface ApiFarmsUnstakeBody {
        claimSuiAsAfSui?: boolean;
        rewardCoinTypes: string[];
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        walletAddress: string;
        withdrawAmount: bigint;
    }
    Index
    claimSuiAsAfSui? rewardCoinTypes stakeCoinType stakedPositionId stakingPoolId walletAddress withdrawAmount
    claimSuiAsAfSui?: boolean

    Whether SUI rewards should be claimed as afSUI when supported.

    rewardCoinTypes: string[]

    Reward coin types to harvest before the position is destroyed.

    stakeCoinType: string

    Fully qualified Move type of the staked coin.

    stakedPositionId: string

    Staked-position object ID.

    stakingPoolId: string

    Staking pool object ID that owns the position.

    walletAddress: string

    Address that signs the transaction.

    withdrawAmount: bigint

    Principal to withdraw, in the stake coin's base units.

    Settings
    Member Visibility

    On This Page
    Properties