Type alias TokenTransferOptions

TokenTransferOptions: {
    amount: IntegerType;
    fee?: IntegerType;
    memo?: string;
    network?: StacksNetworkName | StacksNetwork;
    nonce?: IntegerType;
    recipient: string | PrincipalCV;
    sponsored?: boolean;
} & ApiParam

STX token transfer transaction options

Note: Standard STX transfer does not allow post-conditions.

Type declaration

  • amount: IntegerType

    the amount to be transfered in microstacks

  • Optional fee?: IntegerType

    the transaction fee in microstacks

  • Optional memo?: string

    an arbitrary string to include in the transaction, must be less than 34 bytes

  • Optional network?: StacksNetworkName | StacksNetwork

    the network that the transaction will ultimately be broadcast to

  • Optional nonce?: IntegerType

    the transaction nonce, which must be increased monotonically with each new transaction

  • recipient: string | PrincipalCV

    the address of the recipient of the token transfer

  • Optional sponsored?: boolean

    set to true if another account is sponsoring the transaction (covering the transaction fee)

Generated using TypeDoc