Class TransactionAssetTransfer

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

Implements

Constructors

constructor

Properties

amount assetId closeAmount? closeTo? receiver sender? encodingSchemaValue

Accessors

encodingSchema

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

  • new TransactionAssetTransfer(__namedParameters): TransactionAssetTransfer

  • Creates a new TransactionAssetTransfer object.

    Parameters

    • __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

Properties

amount

amount: bigint

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

assetId

assetId: bigint

(xaid) ID of the asset being transferred.

Optional closeAmount

closeAmount?: bigint

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

Optional closeTo

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

receiver: string

(arcv) Recipient address of the transfer.

Optional sender

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.

Static Private encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

Static encodingSchema

Methods

getEncodingSchema

toEncodingData

Static fromEncodingData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc