TransferAssetParams

Defined in: algokit-utils-ts/src/types/transfer.ts:56

Extends

SendTransactionParams

Properties

amount

amount: number | bigint

Defined in: algokit-utils-ts/src/types/transfer.ts:64

The amount to send as the smallest divisible unit value

assetId

assetId: number

Defined in: algokit-utils-ts/src/types/transfer.ts:62

The asset id that will be transferred

atc?

optional atc?: AtomicTransactionComposer

Defined in: algokit-utils-ts/src/types/transaction.ts:36

An optional AtomicTransactionComposer to add the transaction to, if specified then skipSending: undefined has the same effect as skipSending: true

Inherited from

SendTransactionParams.atc

clawbackFrom?

optional clawbackFrom?: string | SendTransactionFrom

Defined in: algokit-utils-ts/src/types/transfer.ts:68

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.

fee?

optional fee?: AlgoAmount

Defined in: algokit-utils-ts/src/types/transaction.ts:40

The flat fee you want to pay, useful for covering extra fees in a transaction group or app call

Inherited from

SendTransactionParams.fee

from

from: SendTransactionFrom

Defined in: algokit-utils-ts/src/types/transfer.ts:58

The account that will send the asset

lease?

optional lease?: string | Uint8Array<ArrayBufferLike>

Defined in: algokit-utils-ts/src/types/transfer.ts:72

An (optional) transaction lease to apply

maxFee?

optional maxFee?: AlgoAmount

Defined in: algokit-utils-ts/src/types/transaction.ts:42

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

SendTransactionParams.maxFee

maxRoundsToWaitForConfirmation?

optional maxRoundsToWaitForConfirmation?: number

Defined in: algokit-utils-ts/src/types/transaction.ts:44

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

note?

optional note?: TransactionNote

Defined in: algokit-utils-ts/src/types/transfer.ts:70

The (optional) transaction note

populateAppCallResources?

optional populateAppCallResources?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:46

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

skipSending?

optional skipSending?: boolean

Defined in: algokit-utils-ts/src/types/transaction.ts:32

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