CommonTransactionParams

CommonTransactionParams = object

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

Common parameters for defining a transaction.

Properties

extraFee?

optional extraFee?: AlgoAmount

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

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

optional firstValidRound?: bigint

Defined in: algokit-utils-ts/src/types/composer.ts:81

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

optional lastValidRound?: bigint

Defined in: algokit-utils-ts/src/types/composer.ts:83

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

optional lease?: Uint8Array | string

Defined in: algokit-utils-ts/src/types/composer.ts:66

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

optional maxFee?: AlgoAmount

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

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

optional note?: Uint8Array | string

Defined in: algokit-utils-ts/src/types/composer.ts:60

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

optional rekeyTo?: string | Address

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

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender

sender: string | Address

Defined in: algokit-utils-ts/src/types/composer.ts:48

The address of the account sending the transaction.

signer?

optional signer?: algosdk.TransactionSigner | TransactionSignerAccount

Defined in: algokit-utils-ts/src/types/composer.ts:53

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

optional staticFee?: AlgoAmount

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

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

optional validityWindow?: number | bigint

Defined in: algokit-utils-ts/src/types/composer.ts:74

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.