$Transaction

const $Transaction: object

Type declaration

description

readonly description: “Contains all fields common to all transactions and serves as an envelope to all transactions type. Represents both regular and inner transactions.\n\nDefinition:\ndata/transactions/signedtxn.go : SignedTxn\ndata/transactions/transaction.go : Transaction\n”

properties

readonly properties: object

properties.application-transaction

readonly properties.application-transaction: object

properties.application-transaction.$ref

readonly properties.application-transaction.$ref: "#/components/schemas/TransactionApplication" = '#/components/schemas/TransactionApplication'

properties.asset-config-transaction

readonly properties.asset-config-transaction: object

properties.asset-config-transaction.$ref

readonly properties.asset-config-transaction.$ref: "#/components/schemas/TransactionAssetConfig" = '#/components/schemas/TransactionAssetConfig'

properties.asset-freeze-transaction

readonly properties.asset-freeze-transaction: object

properties.asset-freeze-transaction.$ref

readonly properties.asset-freeze-transaction.$ref: "#/components/schemas/TransactionAssetFreeze" = '#/components/schemas/TransactionAssetFreeze'

properties.asset-transfer-transaction

readonly properties.asset-transfer-transaction: object

properties.asset-transfer-transaction.$ref

readonly properties.asset-transfer-transaction.$ref: "#/components/schemas/TransactionAssetTransfer" = '#/components/schemas/TransactionAssetTransfer'

properties.auth-addr

readonly properties.auth-addr: object

properties.auth-addr.description

readonly properties.auth-addr.description: ”\[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.” = '\\[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.'

properties.auth-addr.type

readonly properties.auth-addr.type: "string" = 'string'

properties.auth-addr.x-algorand-format

readonly properties.auth-addr.x-algorand-format: "Address" = 'Address'

properties.close-rewards

readonly properties.close-rewards: object

properties.close-rewards.description

readonly properties.close-rewards.description: ”\[rc\] rewards applied to close-remainder-to account.” = '\\[rc\\] rewards applied to close-remainder-to account.'

properties.close-rewards.type

readonly properties.close-rewards.type: "integer" = 'integer'

properties.closing-amount

readonly properties.closing-amount: object

properties.closing-amount.description

readonly properties.closing-amount.description: ”\[ca\] closing amount for transaction.” = '\\[ca\\] closing amount for transaction.'

properties.closing-amount.type

readonly properties.closing-amount.type: "integer" = 'integer'

properties.confirmed-round

readonly properties.confirmed-round: object

properties.confirmed-round.description

readonly properties.confirmed-round.description: "Round when the transaction was confirmed." = 'Round when the transaction was confirmed.'

properties.confirmed-round.type

readonly properties.confirmed-round.type: "integer" = 'integer'

properties.created-application-index

readonly properties.created-application-index: object

properties.created-application-index.description

readonly properties.created-application-index.description: "Specifies an application index (ID) if an application was created with this transaction." = 'Specifies an application index (ID) if an application was created with this transaction.'

properties.created-application-index.type

readonly properties.created-application-index.type: "integer" = 'integer'

properties.created-asset-index

readonly properties.created-asset-index: object

properties.created-asset-index.description

readonly properties.created-asset-index.description: "Specifies an asset index (ID) if an asset was created with this transaction." = 'Specifies an asset index (ID) if an asset was created with this transaction.'

properties.created-asset-index.type

readonly properties.created-asset-index.type: "integer" = 'integer'

properties.fee

readonly properties.fee: object

properties.fee.description

readonly properties.fee.description: ”\[fee\] Transaction fee.” = '\\[fee\\] Transaction fee.'

properties.fee.type

readonly properties.fee.type: "integer" = 'integer'

properties.first-valid

readonly properties.first-valid: object

properties.first-valid.description

readonly properties.first-valid.description: ”\[fv\] First valid round for this transaction.” = '\\[fv\\] First valid round for this transaction.'

properties.first-valid.type

readonly properties.first-valid.type: "integer" = 'integer'

properties.genesis-hash

readonly properties.genesis-hash: object

properties.genesis-hash.description

readonly properties.genesis-hash.description: ”\[gh\] Hash of genesis block.” = '\\[gh\\] Hash of genesis block.'

properties.genesis-hash.format

readonly properties.genesis-hash.format: "byte" = 'byte'

properties.genesis-hash.pattern

readonly properties.genesis-hash.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.genesis-hash.type

readonly properties.genesis-hash.type: "string" = 'string'

properties.genesis-id

readonly properties.genesis-id: object

properties.genesis-id.description

readonly properties.genesis-id.description: ”\[gen\] genesis block ID.” = '\\[gen\\] genesis block ID.'

properties.genesis-id.type

readonly properties.genesis-id.type: "string" = 'string'

properties.global-state-delta

readonly properties.global-state-delta: object

properties.global-state-delta.$ref

readonly properties.global-state-delta.$ref: "#/components/schemas/StateDelta" = '#/components/schemas/StateDelta'

properties.group

readonly properties.group: object

properties.group.description

readonly properties.group.description: ”\[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.” = '\\[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.'

properties.group.format

readonly properties.group.format: "byte" = 'byte'

properties.group.pattern

readonly properties.group.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.group.type

readonly properties.group.type: "string" = 'string'

properties.id

readonly properties.id: object

properties.id.description

readonly properties.id.description: "Transaction ID" = 'Transaction ID'

properties.id.type

readonly properties.id.type: "string" = 'string'

properties.inner-txns

readonly properties.inner-txns: object

properties.inner-txns.description

readonly properties.inner-txns.description: "Inner transactions produced by application execution." = 'Inner transactions produced by application execution.'

properties.inner-txns.items

readonly properties.inner-txns.items: object

properties.inner-txns.items.$ref

readonly properties.inner-txns.items.$ref: "#/components/schemas/Transaction" = '#/components/schemas/Transaction'

properties.inner-txns.type

readonly properties.inner-txns.type: "array" = 'array'

properties.intra-round-offset

readonly properties.intra-round-offset: object

properties.intra-round-offset.description

readonly properties.intra-round-offset.description: "Offset into the round where this transaction was confirmed." = 'Offset into the round where this transaction was confirmed.'

properties.intra-round-offset.type

readonly properties.intra-round-offset.type: "integer" = 'integer'

properties.keyreg-transaction

readonly properties.keyreg-transaction: object

properties.keyreg-transaction.$ref

readonly properties.keyreg-transaction.$ref: "#/components/schemas/TransactionKeyreg" = '#/components/schemas/TransactionKeyreg'

properties.last-valid

readonly properties.last-valid: object

properties.last-valid.description

readonly properties.last-valid.description: ”\[lv\] Last valid round for this transaction.” = '\\[lv\\] Last valid round for this transaction.'

properties.last-valid.type

readonly properties.last-valid.type: "integer" = 'integer'

properties.lease

readonly properties.lease: object

properties.lease.description

readonly properties.lease.description: ”\[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.” = '\\[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.'

properties.lease.format

readonly properties.lease.format: "byte" = 'byte'

properties.lease.pattern

readonly properties.lease.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.lease.type

readonly properties.lease.type: "string" = 'string'

properties.local-state-delta

readonly properties.local-state-delta: object

properties.local-state-delta.description

readonly properties.local-state-delta.description: ”\[ld\] Local state key/value changes for the application being executed by this transaction.” = '\\[ld\\] Local state key/value changes for the application being executed by this transaction.'

properties.local-state-delta.items

readonly properties.local-state-delta.items: object

properties.local-state-delta.items.$ref

readonly properties.local-state-delta.items.$ref: "#/components/schemas/AccountStateDelta" = '#/components/schemas/AccountStateDelta'

properties.local-state-delta.type

readonly properties.local-state-delta.type: "array" = 'array'

properties.logs

readonly properties.logs: object

properties.logs.description

readonly properties.logs.description: ”\[lg\] Logs for the application being executed by this transaction.” = '\\[lg\\] Logs for the application being executed by this transaction.'

properties.logs.items

readonly properties.logs.items: object

properties.logs.items.format

readonly properties.logs.items.format: "byte" = 'byte'

properties.logs.items.pattern

readonly properties.logs.items.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.logs.items.type

readonly properties.logs.items.type: "string" = 'string'

properties.logs.type

readonly properties.logs.type: "array" = 'array'

properties.note

readonly properties.note: object

properties.note.description

readonly properties.note.description: ”\[note\] Free form data.” = '\\[note\\] Free form data.'

properties.note.format

readonly properties.note.format: "byte" = 'byte'

properties.note.pattern

readonly properties.note.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.note.type

readonly properties.note.type: "string" = 'string'

properties.payment-transaction

readonly properties.payment-transaction: object

properties.payment-transaction.$ref

readonly properties.payment-transaction.$ref: "#/components/schemas/TransactionPayment" = '#/components/schemas/TransactionPayment'

properties.receiver-rewards

readonly properties.receiver-rewards: object

properties.receiver-rewards.description

readonly properties.receiver-rewards.description: ”\[rr\] rewards applied to receiver account.” = '\\[rr\\] rewards applied to receiver account.'

properties.receiver-rewards.type

readonly properties.receiver-rewards.type: "integer" = 'integer'

properties.rekey-to

readonly properties.rekey-to: object

properties.rekey-to.description

readonly properties.rekey-to.description: ”\[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.” = '\\[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.'

properties.rekey-to.type

readonly properties.rekey-to.type: "string" = 'string'

properties.rekey-to.x-algorand-format

readonly properties.rekey-to.x-algorand-format: "Address" = 'Address'

properties.round-time

readonly properties.round-time: object

properties.round-time.description

readonly properties.round-time.description: "Time when the block this transaction is in was confirmed." = 'Time when the block this transaction is in was confirmed.'

properties.round-time.type

readonly properties.round-time.type: "integer" = 'integer'

properties.sender

readonly properties.sender: object

properties.sender.description

readonly properties.sender.description: ”\[snd\] Sender’s address.” = "\\[snd\\] Sender's address."

properties.sender.type

readonly properties.sender.type: "string" = 'string'

properties.sender-rewards

readonly properties.sender-rewards: object

properties.sender-rewards.description

readonly properties.sender-rewards.description: ”\[rs\] rewards applied to sender account.” = '\\[rs\\] rewards applied to sender account.'

properties.sender-rewards.type

readonly properties.sender-rewards.type: "integer" = 'integer'

properties.signature

readonly properties.signature: object

properties.signature.$ref

readonly properties.signature.$ref: "#/components/schemas/TransactionSignature" = '#/components/schemas/TransactionSignature'

properties.state-proof-transaction

readonly properties.state-proof-transaction: object

properties.state-proof-transaction.$ref

readonly properties.state-proof-transaction.$ref: "#/components/schemas/TransactionStateProof" = '#/components/schemas/TransactionStateProof'

properties.tx-type

readonly properties.tx-type: object

properties.tx-type.description

readonly properties.tx-type.description: “[type] Indicates what type of transaction this is. Different types have different fields.\n\nValid types, and where their fields are stored:\n* [pay] payment-transaction\n* [keyreg] keyreg-transaction\n* [acfg] asset-config-transaction\n* [axfer] asset-transfer-transaction\n* [afrz] asset-freeze-transaction\n* [appl] application-transaction\n* [stpf] state-proof-transaction”

properties.tx-type.enum

readonly properties.tx-type.enum: readonly ["pay", "keyreg", "acfg", "axfer", "afrz", "appl", "stpf"]

properties.tx-type.type

readonly properties.tx-type.type: "string" = 'string'

properties.tx-type.x-algorand-format

readonly properties.tx-type.x-algorand-format: "tx-type-enum" = 'tx-type-enum'

required

readonly required: readonly ["fee", "first-valid", "last-valid", "sender", "tx-type"]

type

readonly type: "object" = 'object'

Defined in

schemas.gen.ts:1164