Class TransactionAssetTransfer

Fields for an asset transfer transaction. Definition: data/transactions/asset.go : AssetTransferTxnFields



  • Creates a new TransactionAssetTransfer object.


    • __namedParameters: { amount: number | bigint; assetId: number | bigint; closeAmount?: number | bigint; closeTo?: string; receiver: string; sender?: string }
      • amount: number | bigint
      • assetId: number | bigint
      • Optional closeAmount?: number | bigint
      • Optional closeTo?: string
      • receiver: string
      • Optional sender?: string

    Returns TransactionAssetTransfer


amount: number | bigint

(aamt) Amount of asset to transfer. A zero amount transferred to self allocates that asset in the account's Assets map.

assetId: number | bigint

(xaid) ID of the asset being transferred.

attribute_map: Record<string, string>
closeAmount?: number | bigint

Number of assets transfered to the close-to account as part of the transaction.

closeTo?: string

(aclose) Indicates that the asset should be removed from the account's Assets map, and specifies where the remaining asset holdings should be transferred. It's always valid to transfer remaining asset holdings to the creator account.

receiver: string

(arcv) Recipient address of the transfer.

sender?: string

(asnd) The effective sender during a clawback transactions. If this is not a zero value, the real transaction sender must be the Clawback address from the AssetParams.


  • Get an object ready for encoding to either JSON or msgpack.


    • binary: boolean = false

      Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.

    Returns Record<string, any>

Generated using TypeDoc