types transfer.TransferAssetParams
@algorandfoundation/algokit-utils / types/transfer / TransferAssetParams
Interface: TransferAssetParams¶
types/transfer.TransferAssetParams
Parameters for transferAsset call.
Hierarchy¶
↳ TransferAssetParams
Table of contents¶
Properties¶
- amount
- assetId
- atc
- clawbackFrom
- fee
- from
- lease
- maxFee
- maxRoundsToWaitForConfirmation
- note
- populateAppCallResources
- skipSending
- skipWaiting
- suppressLog
- to
- transactionParams
Properties¶
amount¶
• amount: number | bigint
The amount to send as the smallest divisible unit value
Defined in¶
assetId¶
• assetId: number
The asset id that will be transfered
Defined in¶
atc¶
• Optional atc: AtomicTransactionComposer
An optional AtomicTransactionComposer to add the transaction to, if specified then skipSending: undefined has the same effect as skipSending: true
Inherited from¶
Defined in¶
clawbackFrom¶
• Optional clawbackFrom: string | SendTransactionFrom
An address of a target account from which to perform a clawback operation. Please note, in such cases senderAccount must be equal to clawback field on ASA metadata.
Defined in¶
fee¶
• Optional fee: AlgoAmount
The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
Inherited from¶
Defined in¶
from¶
• from: SendTransactionFrom
The account that will send the asset
Defined in¶
lease¶
• Optional lease: string | Uint8Array
An (optional) transaction lease to apply
Defined in¶
maxFee¶
• Optional maxFee: AlgoAmount
The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion
Inherited from¶
Defined in¶
maxRoundsToWaitForConfirmation¶
• Optional maxRoundsToWaitForConfirmation: number
The maximum number of rounds to wait for confirmation, only applies if skipWaiting is undefined or false, default: wait up to 5 rounds
Inherited from¶
SendTransactionParams.maxRoundsToWaitForConfirmation
Defined in¶
note¶
• Optional note: TransactionNote
The (optional) transaction note
Defined in¶
populateAppCallResources¶
• Optional populateAppCallResources: boolean
WARNING: Not recommended for production use due to https://github.com/algorand/go-algorand/issues/5914. Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group.
Inherited from¶
SendTransactionParams.populateAppCallResources
Defined in¶
skipSending¶
• Optional skipSending: boolean
Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless atc specified)
and instead just return the raw transaction, e.g. so you can add it to a group of transactions
Inherited from¶
SendTransactionParams.skipSending
Defined in¶
skipWaiting¶
• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from¶
SendTransactionParams.skipWaiting
Defined in¶
suppressLog¶
• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from¶
SendTransactionParams.suppressLog
Defined in¶
to¶
• to: string | SendTransactionFrom
The account / account address that will receive the asset
Defined in¶
transactionParams¶
• Optional transactionParams: SuggestedParams
Optional transaction parameters