Skip to content

Create Publication

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

types transfer.AlgoTransferParams

@algorandfoundation/algokit-utils / types/transfer / AlgoTransferParams

Interface: AlgoTransferParams

types/transfer.AlgoTransferParams

Parameters for transferAlgos call.

Hierarchy

AlgoTransferParams

Table of contents

Properties

Properties

amount

amount: AlgoAmount

The amount to send

Defined in

src/types/transfer.ts:14


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

SendTransactionParams.atc

Defined in

src/types/transaction.ts:35


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

SendTransactionParams.fee

Defined in

src/types/transaction.ts:39


from

from: SendTransactionFrom

The account that will send the ALGOs

Defined in

src/types/transfer.ts:10


lease

Optional lease: string | Uint8Array

An (optional) transaction lease to apply

Defined in

src/types/transfer.ts:20


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

SendTransactionParams.maxFee

Defined in

src/types/transaction.ts:41


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

src/types/transaction.ts:43


note

Optional note: TransactionNote

The (optional) transaction note

Defined in

src/types/transfer.ts:18


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

src/types/transaction.ts:31


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

src/types/transaction.ts:33


suppressLog

Optional suppressLog: boolean

Whether to suppress log messages from transaction send, default: do not suppress

Inherited from

SendTransactionParams.suppressLog

Defined in

src/types/transaction.ts:37


to

to: string | SendTransactionFrom

The account / account address that will receive the ALGOs

Defined in

src/types/transfer.ts:12


transactionParams

Optional transactionParams: SuggestedParams

Optional transaction parameters

Defined in

src/types/transfer.ts:16