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

    Type Alias ApiPerpetualsDepositCollateralBody

    ApiPerpetualsDepositCollateralBody: {
        accountCapId?: ObjectId;
        accountId: PerpetualsAccountId;
        collateralCoinType: CoinType;
        isSponsoredTx?: boolean;
        sponsor?: PerpetualsSponsorConfig;
        txKind?: SerializedTransaction;
        walletAddress: SuiAddress;
    } & (
        | { depositAmount: Balance }
        | { depositCoinArg: TransactionObjectArgument }
    )

    Request body for depositing collateral into a perpetuals account.

    The deposit can be provided by:

    • depositAmount (numeric amount), or
    • depositCoinArg (Sui coin object).

    Type Declaration

    • OptionalaccountCapId?: ObjectId

      Optional account capability object ID used to authorize the account operation.

    • accountId: PerpetualsAccountId

      Account ID associated with the request.

    • collateralCoinType: CoinType

      Move coin type used as collateral.

    • OptionalisSponsoredTx?: boolean

      Whether the transaction is sponsored rather than paid directly by the wallet.

    • Optionalsponsor?: PerpetualsSponsorConfig

      Optional transaction sponsorship configuration.

    • OptionaltxKind?: SerializedTransaction

      Serialized transaction kind sent to the service.

    • walletAddress: SuiAddress

      Wallet address used to identify the signer or owner.

    • { depositAmount: Balance }
      • depositAmount: Balance

        Collateral amount to deposit.

    • { depositCoinArg: TransactionObjectArgument }
      • depositCoinArg: TransactionObjectArgument

        Coin argument containing the collateral deposit.

    Settings
    Member Visibility