Struct GasMetrics

pub struct GasMetrics {
    pub txs_count: u64,
    pub total_gas: Metrics,
    pub wasm_gas: Metrics,
    pub zk_circuits_gas: Metrics,
    pub signatures_gas: Metrics,
    pub deployments_gas: Metrics,
    pub timestamp: Timestamp,
}

Structure for managing gas metrics across all transactions in the store.

This struct maintains running totals, extrema, and transaction counts to efficiently calculate metrics without the need to iterate through previous transactions when new data is added. It is used to build a comprehensive view of gas metrics across the blockchain’s history, including total gas, WASM gas, ZK circuit gas, and signature gas. The structure allows for O(1) performance in calculating averages and updating min/max values.

Fields

txs_count: u64

Represents the total count of transactions tracked by the metrics store.

total_gas: Metrics

Overall gas consumed metrics across all transactions.

wasm_gas: Metrics

Gas used across all executed wasm transactions.

zk_circuits_gas: Metrics

Gas consumed across all zk circuit computations.

signatures_gas: Metrics

Gas used metrics related to signatures across transactions.

deployments_gas: Metrics

Gas consumed for deployments across transactions.

timestamp: Timestamp

The time the metrics was calculated

Implementations

impl GasMetrics

pub fn new( txs_count: u64, total_gas: Metrics, wasm_gas: Metrics, zk_circuit_gas: Metrics, signature_gas: Metrics, deployment_gas: Metrics, timestamp: Timestamp, ) -> Self

Creates a GasMetrics instance.

pub fn avg_total_gas_used(&self) -> u64

Provides the average of the total gas used.

pub fn avg_wasm_gas_used(&self) -> u64

Provides the average of the gas used across WASM transactions.

pub fn avg_zk_circuits_gas_used(&self) -> u64

Provides the average of the gas consumed across Zero-Knowledge Circuit computations.

pub fn avg_signatures_gas_used(&self) -> u64

Provides the average of the gas used to sign transactions.

pub fn avg_deployments_gas_used(&self) -> u64

Provides the average of the gas used for deployments.

pub fn add(&mut self, tx_gas_data: &[GasData])

Adds new [GasData] to the existing accumulated values.

This method updates running totals, transaction counts, and min/max values for various gas metric categories. It accumulates new data without reading existing averages, minimums, or maximums from the database to optimize performance.

Trait Implementations

impl AsyncDecodable for GasMetrics

where u64: AsyncDecodable, Metrics: AsyncDecodable, Timestamp: AsyncDecodable,

fn decode_async<'life0, 'async_trait, D>( d: &'life0 mut D, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where D: 'async_trait + AsyncRead + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait,

impl AsyncEncodable for GasMetrics

where u64: AsyncEncodable, Metrics: AsyncEncodable, Timestamp: AsyncEncodable,

fn encode_async<'life0, 'life1, 'async_trait, S>( &'life0 self, s: &'life1 mut S, ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>

where S: 'async_trait + AsyncWrite + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Asynchronously encode an object with a well-defined format. Should only ever error if the underlying AsyncWrite errors. Returns the number of bytes written on success.

impl Clone for GasMetrics

fn clone(&self) -> GasMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GasMetrics

Debug formatting support for GasMetrics instances to include averages.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for GasMetrics

where u64: Decodable, Metrics: Decodable, Timestamp: Decodable,

fn decode<D: Read>(d: &mut D) -> Result<Self, Error>

impl Default for GasMetrics

fn default() -> GasMetrics

Returns the “default value” for a type.

impl Encodable for GasMetrics

where u64: Encodable, Metrics: Encodable, Timestamp: Encodable,

fn encode<S: Write>(&self, s: &mut S) -> Result<usize, Error>

Encode an object with a well-defined format. Should only ever error if the underlying Write errors. Returns the number of bytes written on success.

impl PartialEq for GasMetrics

fn eq(&self, other: &GasMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GasMetrics

impl StructuralPartialEq for GasMetrics