@algorandfoundation/algokit-subscriber / types/subscription / SubscribedTransaction
types/subscription.SubscribedTransaction
The common model used to expose a transaction that is returned from a subscription.
Substantively, based on the Indexer TransactionResult model format with some modifications to:
parentTransactionId field so inner transactions have a reference to their parentinner-txns to be SubscribedTransaction[] so inner transactions (recursively) get these extra fields tooarc28EventsTransaction
↳ SubscribedTransaction
• new SubscribedTransaction(«destructured»): SubscribedTransaction
| Name | Type |
|---|---|
«destructured» |
Omit<SubscribedTransaction, "getEncodingSchema" | "toEncodingData"> |
algosdk.indexerModels.Transaction.constructor
• Optional applicationTransaction: TransactionApplication
Fields for application transactions. Definition: data/transactions/application.go : ApplicationCallTxnFields
algosdk.indexerModels.Transaction.applicationTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2176
• Optional arc28Events: EmittedArc28Event[]
Any ARC-28 events emitted from an app call.
• Optional assetConfigTransaction: TransactionAssetConfig
Fields for asset allocation, re-configuration, and destruction. A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction. Definition: data/transactions/asset.go : AssetConfigTxnFields
algosdk.indexerModels.Transaction.assetConfigTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2184
• Optional assetFreezeTransaction: TransactionAssetFreeze
Fields for an asset freeze transaction. Definition: data/transactions/asset.go : AssetFreezeTxnFields
algosdk.indexerModels.Transaction.assetFreezeTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2190
• Optional assetTransferTransaction: TransactionAssetTransfer
Fields for an asset transfer transaction. Definition: data/transactions/asset.go : AssetTransferTxnFields
algosdk.indexerModels.Transaction.assetTransferTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2196
• Optional authAddr: Address
(sgnr) this is included with signed transactions when the signing address does not equal the sender. The backend can use this to ensure that auth addr is equal to the accounts auth addr.
algosdk.indexerModels.Transaction.authAddr
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2202
• Optional balanceChanges: BalanceChange[]
The balance changes in the transaction.
• Optional closeRewards: bigint
(rc) rewards applied to close-remainder-to account.
algosdk.indexerModels.Transaction.closeRewards
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2206
• Optional closingAmount: bigint
(ca) closing amount for transaction.
algosdk.indexerModels.Transaction.closingAmount
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2210
• Optional confirmedRound: bigint
Round when the transaction was confirmed.
algosdk.indexerModels.Transaction.confirmedRound
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2214
• Optional createdApplicationIndex: bigint
Specifies an application index (ID) if an application was created with this transaction.
algosdk.indexerModels.Transaction.createdApplicationIndex
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2219
• Optional createdAssetIndex: bigint
Specifies an asset index (ID) if an asset was created with this transaction.
algosdk.indexerModels.Transaction.createdAssetIndex
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2223
• fee: bigint
(fee) Transaction fee.
algosdk.indexerModels.Transaction.fee
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2158
• Optional filtersMatched: string[]
The names of any filters that matched the given transaction to result in it being ‘subscribed’.
• firstValid: bigint
(fv) First valid round for this transaction.
algosdk.indexerModels.Transaction.firstValid
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2162
• Optional genesisHash: Uint8Array
(gh) Hash of genesis block.
algosdk.indexerModels.Transaction.genesisHash
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2227
• Optional genesisId: string
(gen) genesis block ID.
algosdk.indexerModels.Transaction.genesisId
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2231
• Optional globalStateDelta: EvalDeltaKeyValue[]
(gd) Global state key/value changes for the application being executed by this transaction.
algosdk.indexerModels.Transaction.globalStateDelta
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2236
• Optional group: Uint8Array
(grp) Base64 encoded byte array of a sha512/256 digest. When present indicates that this transaction is part of a transaction group and the value is the sha512/256 hash of the transactions in that group.
algosdk.indexerModels.Transaction.group
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2242
• Optional heartbeatTransaction: TransactionHeartbeat
Fields for a heartbeat transaction. Definition: data/transactions/heartbeat.go : HeartbeatTxnFields
algosdk.indexerModels.Transaction.heartbeatTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2248
• id: string
algosdk.indexerModels.Transaction.id
• Optional innerTxns: SubscribedTransaction[]
Inner transactions produced by application execution.
algosdk.indexerModels.Transaction.innerTxns
• Optional intraRoundOffset: number
Offset into the round where this transaction was confirmed.
algosdk.indexerModels.Transaction.intraRoundOffset
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2260
• Optional keyregTransaction: TransactionKeyreg
Fields for a keyreg transaction. Definition: data/transactions/keyreg.go : KeyregTxnFields
algosdk.indexerModels.Transaction.keyregTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2266
• lastValid: bigint
(lv) Last valid round for this transaction.
algosdk.indexerModels.Transaction.lastValid
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2166
• Optional lease: Uint8Array
(lx) Base64 encoded 32-byte array. Lease enforces mutual exclusion of transactions. If this field is nonzero, then once the transaction is confirmed, it acquires the lease identified by the (Sender, Lease) pair of the transaction until the LastValid round passes. While this transaction possesses the lease, no other transaction specifying this lease can be confirmed.
algosdk.indexerModels.Transaction.lease
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2274
• Optional localStateDelta: AccountStateDelta[]
(ld) Local state key/value changes for the application being executed by this transaction.
algosdk.indexerModels.Transaction.localStateDelta
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2279
• Optional logs: Uint8Array[]
(lg) Logs for the application being executed by this transaction.
algosdk.indexerModels.Transaction.logs
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2283
• Optional note: Uint8Array
(note) Free form data.
algosdk.indexerModels.Transaction.note
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2287
• Optional parentIntraRoundOffset: number
The intra-round offset of the parent of this transaction (if it’s an inner transaction).
• Optional parentTransactionId: string
The transaction ID of the parent of this transaction (if it’s an inner transaction).
• Optional paymentTransaction: TransactionPayment
Fields for a payment transaction. Definition: data/transactions/payment.go : PaymentTxnFields
algosdk.indexerModels.Transaction.paymentTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2293
• Optional receiverRewards: bigint
(rr) rewards applied to receiver account.
algosdk.indexerModels.Transaction.receiverRewards
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2297
• Optional rekeyTo: Address
(rekey) when included in a valid transaction, the accounts auth addr will be updated with this value and future signatures must be signed with the key represented by this address.
algosdk.indexerModels.Transaction.rekeyTo
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2303
• Optional roundTime: number
Time when the block this transaction is in was confirmed.
algosdk.indexerModels.Transaction.roundTime
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2307
• sender: string
(snd) Sender’s address.
algosdk.indexerModels.Transaction.sender
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2170
• Optional senderRewards: bigint
(rs) rewards applied to sender account.
algosdk.indexerModels.Transaction.senderRewards
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2311
• Optional signature: TransactionSignature
Validation signature associated with some data. Only one of the signatures should be provided.
algosdk.indexerModels.Transaction.signature
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2316
• Optional stateProofTransaction: TransactionStateProof
Fields for a state proof transaction. Definition: data/transactions/stateproof.go : StateProofTxnFields
algosdk.indexerModels.Transaction.stateProofTransaction
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2322
• Optional txType: string
(type) Indicates what type of transaction this is. Different types have different fields. Valid types, and where their fields are stored:
algosdk.indexerModels.Transaction.txType
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2336
• get encodingSchema(): Schema
Schema
algosdk.indexerModels.Transaction.encodingSchema
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2154
▸ getEncodingSchema(): Schema
Schema
algosdk.indexerModels.Transaction.getEncodingSchema
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2454
▸ toEncodingData(): Map<string, unknown>
Map<string, unknown>
algosdk.indexerModels.Transaction.toEncodingData
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2455
▸ fromEncodingData(data): Transaction
| Name | Type |
|---|---|
data |
unknown |
Transaction
algosdk.indexerModels.Transaction.fromEncodingData
node_modules/algosdk/dist/types/client/v2/indexer/models/types.d.ts:2456