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

    Interface ApiGasPoolDepositBody

    Inputs for depositing SUI or another supported coin into a gas pool.

    interface ApiGasPoolDepositBody {
        amount?: bigint;
        coinArg?: TransactionObjectArgument;
        coinType?: string;
        gasPoolArg?: TransactionObjectArgument;
        isSponsoredTx?: boolean;
        slippage?: number;
        txKind?: string;
        walletAddress: string;
    }
    Index
    amount? coinArg? coinType? gasPoolArg? isSponsoredTx? slippage? txKind? walletAddress
    amount?: bigint

    Amount of the input coin to deposit or swap, as a bigint in that coin's smallest unit.

    coinArg?: TransactionObjectArgument

    PTB coin argument to use as the input coin. If omitted, sourced from wallet.

    coinType?: string

    Coin type of the deposit token. Defaults to SUI if omitted. When set to a non-SUI type, the endpoint swaps to SUI before depositing.

    gasPoolArg?: TransactionObjectArgument

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

    isSponsoredTx?: boolean

    Whether to build the transaction for sponsored gas. Defaults to false.

    slippage?: number

    Slippage tolerance for non-SUI swaps (0.0–1.0). Defaults to 0.01.

    txKind?: string

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

    walletAddress: string

    Wallet submitting the deposit.

    Settings
    Member Visibility

    On This Page
    Properties