Module metrics

This module includes helper functions to get the blockchain synchronization status of the entity. The entity tracks on-chain transactions for many purposes (TxSender, FinalizedBlockFetcher, HCP) and takes action (header chain proving, payout, disprove, L2 state sync, etc.) SyncStatus tracks the latest processed block heights for each of these tasks.

Structs

EntitySyncStatusMetrics

The sync status metrics for an entity. This is used by the aggregator to publish external entity metrics. The scope will be set to the EntityId + “_l1_sync_status”, which will be displayed as Operator(abcdef123...)_l1_sync_status or Verifier(abcdef123...)_l1_sync_status where the XOnlyPublicKey’s first 10 characters are displayed, cf. crate::aggregator::OperatorId and crate::aggregator::VerifierId.

SyncStatus

A struct containing the current sync status of the entity.

SyncStatusMetrics

The sync status metrics for the currently running entity. (operator/verifier)

Constants

L1_SYNC_STATUS_SUB_REQUEST_METRICS_TIMEOUT 🔒

Statics

ENTITY_SYNC_STATUS

The sync status metrics static for the currently running entity. (operator/verifier)

Traits

SyncStatusProvider

Extension trait on named entities to retrieve their sync status (including both L1 and L2 data).

Functions

get_bitcoin_fee_rate

Get the current Bitcoin fee rate in sat/vB.

get_btc_syncer_consumer_last_processed_block_height

Get the last processed block height of the given consumer or None if no block was processed by the consumer.

get_btc_syncer_consumer_last_processed_finalized_block_height

Get the last processed finalized block height of the given consumer or None if no block was processed by the consumer.

get_btc_syncer_synced_height

Get the last processed block height of the Bitcoin Syncer or None if no block is present in the database.

get_hcp_last_proven_height

Get the last proven block height of the HCP or None if no block has been proven.

get_rpc_tip_height

Get the current height of the chain as seen by Bitcoin Core RPC.

get_state_manager_next_height

Get the next height of the State Manager or None if the State Manager status for the owner is missing or the next_height_to_process is NULL.

get_tx_sender_synced_height

Get the synced height of the Transaction Sender or None if the tx_sender_sync_state table is empty or missing.

get_wallet_balance

Get the current balance of the wallet.

log_errs_and_ok 🔒