Transaction
Defined in: packages/transact/src/transactions/transaction.ts:160
Represents a complete Algorand transaction.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Transaction(
params):Transaction
Defined in: packages/transact/src/transactions/transaction.ts:282
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Transaction
Properties
Section titled “Properties”appCall?
Section titled “appCall?”
optionalappCall:AppCallTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:260
App call specific fields
Implementation of
Section titled “Implementation of”TransactionParams.appCall
assetConfig?
Section titled “assetConfig?”
optionalassetConfig:AssetConfigTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:255
Asset config specific fields
Implementation of
Section titled “Implementation of”TransactionParams.assetConfig
assetFreeze?
Section titled “assetFreeze?”
optionalassetFreeze:AssetFreezeTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:270
Asset freeze specific fields
Implementation of
Section titled “Implementation of”TransactionParams.assetFreeze
assetTransfer?
Section titled “assetTransfer?”
optionalassetTransfer:AssetTransferTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:250
Asset transfer specific fields
Implementation of
Section titled “Implementation of”TransactionParams.assetTransfer
optionalfee:bigint
Defined in: packages/transact/src/transactions/transaction.ts:181
Optional transaction fee in microALGO.
When not set, the fee will be interpreted as 0 by the network.
Implementation of
Section titled “Implementation of”TransactionParams.fee
firstValid
Section titled “firstValid”firstValid:
bigint
Defined in: packages/transact/src/transactions/transaction.ts:186
First round for when the transaction is valid.
Implementation of
Section titled “Implementation of”TransactionParams.firstValid
genesisHash?
Section titled “genesisHash?”
optionalgenesisHash:Uint8Array<ArrayBufferLike>
Defined in: packages/transact/src/transactions/transaction.ts:200
Hash of the genesis block of the network.
Used to identify which network the transaction is for.
Implementation of
Section titled “Implementation of”TransactionParams.genesisHash
genesisId?
Section titled “genesisId?”
optionalgenesisId:string
Defined in: packages/transact/src/transactions/transaction.ts:207
Genesis ID of the network.
A human-readable string used alongside genesis hash to identify the network.
Implementation of
Section titled “Implementation of”TransactionParams.genesisId
group?
Section titled “group?”
optionalgroup:Uint8Array<ArrayBufferLike>
Defined in: packages/transact/src/transactions/transaction.ts:240
Optional group ID for atomic transaction grouping.
Transactions with the same group ID must execute together or not at all.
Implementation of
Section titled “Implementation of”TransactionParams.group
heartbeat?
Section titled “heartbeat?”
optionalheartbeat:HeartbeatTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:275
Heartbeat specific fields
Implementation of
Section titled “Implementation of”TransactionParams.heartbeat
keyRegistration?
Section titled “keyRegistration?”
optionalkeyRegistration:KeyRegistrationTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:265
Key registration specific fields
Implementation of
Section titled “Implementation of”TransactionParams.keyRegistration
lastValid
Section titled “lastValid”lastValid:
bigint
Defined in: packages/transact/src/transactions/transaction.ts:193
Last round for when the transaction is valid.
After this round, the transaction will be expired.
Implementation of
Section titled “Implementation of”TransactionParams.lastValid
lease?
Section titled “lease?”
optionallease:Uint8Array<ArrayBufferLike>
Defined in: packages/transact/src/transactions/transaction.ts:233
Optional lease value to enforce mutual transaction exclusion.
When a transaction with a non-empty lease field is confirmed, the lease is acquired. A lease X is acquired by the sender, generating the (sender, X) lease. The lease is kept active until the last_valid round of the transaction has elapsed. No other transaction sent by the same sender can be confirmed until the lease expires.
Implementation of
Section titled “Implementation of”TransactionParams.lease
optionalnote:Uint8Array<ArrayBufferLike>
Defined in: packages/transact/src/transactions/transaction.ts:214
Optional user-defined note field.
Can contain arbitrary data up to 1KB in size.
Implementation of
Section titled “Implementation of”TransactionParams.note
payment?
Section titled “payment?”
optionalpayment:PaymentTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:245
Payment specific fields
Implementation of
Section titled “Implementation of”TransactionParams.payment
rekeyTo?
Section titled “rekeyTo?”
optionalrekeyTo:Address
Defined in: packages/transact/src/transactions/transaction.ts:223
Optional authorized account for future transactions.
If set, only this account will be used for transaction authorization going forward. Reverting back control to the original address must be done by setting this field to the original address.
Implementation of
Section titled “Implementation of”TransactionParams.rekeyTo
sender
Section titled “sender”sender:
Address
Defined in: packages/transact/src/transactions/transaction.ts:174
The account that authorized the transaction.
Fees are deducted from this account.
Implementation of
Section titled “Implementation of”TransactionParams.sender
stateProof?
Section titled “stateProof?”
optionalstateProof:StateProofTransactionFields
Defined in: packages/transact/src/transactions/transaction.ts:280
State proof specific fields
Implementation of
Section titled “Implementation of”TransactionParams.stateProof
type:
TransactionType
Defined in: packages/transact/src/transactions/transaction.ts:167
The type of transaction
Implementation of
Section titled “Implementation of”TransactionParams.type
Methods
Section titled “Methods”txId()
Section titled “txId()”txId():
string
Defined in: packages/transact/src/transactions/transaction.ts:317
Get the transaction ID as a base32-encoded string.
Returns
Section titled “Returns”string