algokit-subscriber-ts

@algorandfoundation/algokit-subscriber / types/subscription / BlockMetadata

Interface: BlockMetadata

types/subscription.BlockMetadata

Metadata about a block that was retrieved from algod.

Table of contents

Properties

Properties

fullTransactionCount

fullTransactionCount: number

Full count of transactions and inner transactions (recursively) in this block.

Defined in

src/types/subscription.ts:53


genesisHash

genesisHash: string

The base64 genesis hash of the chain.

Defined in

src/types/subscription.ts:43


genesisId

genesisId: string

The genesis ID of the chain.

Defined in

src/types/subscription.ts:41


hash

Optional hash: string

The base64 block hash.

Defined in

src/types/subscription.ts:35


parentTransactionCount

parentTransactionCount: number

Count of parent transactions in this block

Defined in

src/types/subscription.ts:51


participationUpdates

Optional participationUpdates: ParticipationUpdates

Participation account data that needs to be checked/acted on by the network.

Defined in

src/types/subscription.ts:68


previousBlockHash

Optional previousBlockHash: string

The base64 previous block hash.

Defined in

src/types/subscription.ts:45


proposer

Optional proposer: string

Address of the proposer of this block

Defined in

src/types/subscription.ts:70


rewards

Optional rewards: BlockRewards

Fields relating to rewards

Defined in

src/types/subscription.ts:49


round

round: bigint

The round of the block.

Defined in

src/types/subscription.ts:37


seed

seed: string

The base64 seed of the block.

Defined in

src/types/subscription.ts:47


stateProofTracking

Optional stateProofTracking: BlockStateProofTracking[]

Tracks the status of state proofs.

Defined in

src/types/subscription.ts:64


timestamp

timestamp: number

Block creation timestamp in seconds since epoch

Defined in

src/types/subscription.ts:39


transactionsRoot

transactionsRoot: string

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}=)?$”

Defined in

src/types/subscription.ts:58


transactionsRootSha256

transactionsRootSha256: string

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.

Defined in

src/types/subscription.ts:60


txnCounter

txnCounter: bigint

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).

Defined in

src/types/subscription.ts:55


upgradeState

Optional upgradeState: BlockUpgradeState

Fields relating to a protocol upgrade.

Defined in

src/types/subscription.ts:62


upgradeVote

Optional upgradeVote: BlockUpgradeVote

Fields relating to voting for a protocol upgrade.

Defined in

src/types/subscription.ts:66