Struct narwhal_config::Parameters

pub struct Parameters {
    pub header_size: usize,
    pub max_header_delay: Duration,
    pub gc_depth: u64,
    pub sync_retry_delay: Duration,
    pub sync_retry_nodes: usize,
    pub batch_size: usize,
    pub max_batch_delay: Duration,
    pub block_synchronizer: BlockSynchronizerParameters,
    pub consensus_api_grpc: ConsensusAPIGrpcParameters,
    pub max_concurrent_requests: usize,
    pub prometheus_metrics: PrometheusMetricsParameters,
}

Holds all the node properties. An example is provided to showcase the usage and deserialization from a json file. To define a Duration on the property file can use either milliseconds or seconds (e.x 5s, 10ms , 2000ms).

Fields

header_size: usize

The preferred header size. The primary creates a new header when it has enough parents and enough batches’ digests to reach header_size. Denominated in bytes.

max_header_delay: Duration

The maximum delay that the primary waits between generating two headers, even if the header did not reach max_header_size.

gc_depth: u64

The depth of the garbage collection (Denominated in number of rounds).

sync_retry_delay: Duration

The delay after which the synchronizer retries to send sync requests. Denominated in ms.

sync_retry_nodes: usize

Determine with how many nodes to sync when re-trying to send sync-request. These nodes are picked at random from the committee.

batch_size: usize

The preferred batch size. The workers seal a batch of transactions when it reaches this size. Denominated in bytes.

max_batch_delay: Duration

The delay after which the workers seal a batch of transactions, even if max_batch_size is not reached.

block_synchronizer: BlockSynchronizerParameters

The parameters for the block synchronizer

consensus_api_grpc: ConsensusAPIGrpcParameters

The parameters for the Consensus API gRPC server

max_concurrent_requests: usize

The maximum number of concurrent requests for messages accepted from an un-trusted entity

prometheus_metrics: PrometheusMetricsParameters

Properties for the prometheus metrics

Implementations

impl Parameters

pub fn tracing(&self)

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameters

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

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Parameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Parameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.