AssetTransferParams
AssetTransferParams =
CommonTransactionParams&object
Defined in: algokit-utils-ts/src/types/composer.ts:283
Parameters to define an asset transfer transaction.
Type Declaration
Section titled “Type Declaration”amount
Section titled “amount”amount:
bigint
Amount of the asset to transfer (in smallest divisible (decimal) units).
assetId
Section titled “assetId”assetId:
bigint
ID of the asset to transfer.
clawbackTarget?
Section titled “clawbackTarget?”
optionalclawbackTarget?:string|Address
Optional address of an account to clawback the asset from.
Requires the sender to be the clawback account.
Warning: Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly.
closeAssetTo?
Section titled “closeAssetTo?”
optionalcloseAssetTo?:string|Address
Optional address of an account to close the asset position to.
Warning: Be careful with this parameter as it can lead to loss of funds if not used correctly.
receiver
Section titled “receiver”receiver:
string|Address
The address of the account that will receive the asset unit(s).