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

    Interface ApiGasPoolWithdrawBody

    Inputs for withdrawing SUI from a gas pool.

    interface ApiGasPoolWithdrawBody {
        amount: bigint;
        deferTransfer?: boolean;
        gasPoolArg?: TransactionObjectArgument;
        recipientAddress?: string;
        txKind?: string;
        walletAddress: string;
    }
    Index
    amount deferTransfer? gasPoolArg? recipientAddress? txKind? walletAddress
    amount: bigint

    Amount of SUI to withdraw, in MIST.

    deferTransfer?: boolean

    When true, the withdrawn coin is not transferred; its arg is returned instead.

    gasPoolArg?: TransactionObjectArgument

    PTB gas-pool argument from an earlier command in the same transaction.

    recipientAddress?: string

    Wallet that receives the withdrawal. Defaults to walletAddress.

    txKind?: string

    Serialized transaction kind to submit when the server builds the transaction.

    walletAddress: string

    Wallet submitting the withdrawal.

    Settings
    Member Visibility

    On This Page
    Properties