BlockMetadata
@algorandfoundation/algokit-subscriber
Interface: BlockMetadata
Section titled “Interface: BlockMetadata”Defined in: src/types/subscription.ts:33
Metadata about a block that was retrieved from algod.
Properties
Section titled “Properties”fullTransactionCount
Section titled “fullTransactionCount”fullTransactionCount:
number
Defined in: src/types/subscription.ts:53
Full count of transactions and inner transactions (recursively) in this block.
genesisHash
Section titled “genesisHash”genesisHash:
string
Defined in: src/types/subscription.ts:43
The base64 genesis hash of the chain.
genesisId
Section titled “genesisId”genesisId:
string
Defined in: src/types/subscription.ts:41
The genesis ID of the chain.
optionalhash:string
Defined in: src/types/subscription.ts:35
The base64 block hash.
parentTransactionCount
Section titled “parentTransactionCount”parentTransactionCount:
number
Defined in: src/types/subscription.ts:51
Count of parent transactions in this block
participationUpdates?
Section titled “participationUpdates?”
optionalparticipationUpdates:ParticipationUpdates
Defined in: src/types/subscription.ts:68
Participation account data that needs to be checked/acted on by the network.
previousBlockHash?
Section titled “previousBlockHash?”
optionalpreviousBlockHash:string
Defined in: src/types/subscription.ts:45
The base64 previous block hash.
proposer?
Section titled “proposer?”
optionalproposer:string
Defined in: src/types/subscription.ts:70
Address of the proposer of this block
rewards?
Section titled “rewards?”
optionalrewards:BlockRewards
Defined in: src/types/subscription.ts:49
Fields relating to rewards
round:
bigint
Defined in: src/types/subscription.ts:37
The round of the block.
seed:
string
Defined in: src/types/subscription.ts:47
The base64 seed of the block.
stateProofTracking?
Section titled “stateProofTracking?”
optionalstateProofTracking:BlockStateProofTracking[]
Defined in: src/types/subscription.ts:64
Tracks the status of state proofs.
timestamp
Section titled “timestamp”timestamp:
number
Defined in: src/types/subscription.ts:39
Block creation timestamp in seconds since epoch
transactionsRoot
Section titled “transactionsRoot”transactionsRoot:
string
Defined in: src/types/subscription.ts:58
TransactionsRoot authenticates the set of transactions appearing in the block. More specifically, it’s the root of a merkle tree whose leaves are the block’s Txids, in lexicographic order. For the empty block, it’s 0. Note that the TxnRoot does not authenticate the signatures on the transactions, only the transactions themselves. Two blocks with the same transactions but in a different order and with different signatures will have the same TxnRoot. Pattern : ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$“
transactionsRootSha256
Section titled “transactionsRootSha256”transactionsRootSha256:
string
Defined in: src/types/subscription.ts:60
TransactionsRootSHA256 is an auxiliary TransactionRoot, built using a vector commitment instead of a merkle tree, and SHA256 hash function instead of the default SHA512_256. This commitment can be used on environments where only the SHA256 function exists.
txnCounter
Section titled “txnCounter”txnCounter:
bigint
Defined in: src/types/subscription.ts:55
Number of the next transaction that will be committed after this block. It is 0 when no transactions have ever been committed (since TxnCounter started being supported).
upgradeState?
Section titled “upgradeState?”
optionalupgradeState:BlockUpgradeState
Defined in: src/types/subscription.ts:62
Fields relating to a protocol upgrade.
upgradeVote?
Section titled “upgradeVote?”
optionalupgradeVote:BlockUpgradeVote
Defined in: src/types/subscription.ts:66
Fields relating to voting for a protocol upgrade.