Struct Config

pub struct Config {

    pub params: Params,
    pub perf: PerfParams,
    pub process_genesis: bool,
    pub is_archival: bool,
    pub enable_sanity_checks: bool,
    pub utxoindex: bool,
    pub unsafe_rpc: bool,
    pub enable_unsynced_mining: bool,
    pub enable_mainnet_mining: bool,
    pub user_agent_comments: Vec<String>,
    pub p2p_listen_address: ContextualNetAddress,
    pub externalip: Option<NetAddress>,
    pub block_template_cache_lifetime: Option<u64>,
    pub disable_upnp: bool,
    pub ram_scale: f64,
}

Various consensus configurations all bundled up under a single struct. Use Config::new for directly building from a Params instance. For anything more complex it is recommended to use ConfigBuilder. NOTE: this struct can be implicitly de-refed into Params

Fields

params: Params

Consensus params

perf: PerfParams

Performance params

process_genesis: bool

is_archival: bool

Indicates whether this node is an archival node

enable_sanity_checks: bool

Enable various sanity checks which might be compute-intensive (mostly performed during pruning)

utxoindex: bool

Enable the UTXO index

unsafe_rpc: bool

Enable RPC commands which affect the state of the node

enable_unsynced_mining: bool

Allow the node to accept blocks from RPC while not synced (required when initiating a new network from genesis)

enable_mainnet_mining: bool

Allow mainnet mining. Until a stable Beta version we keep this option off by default

user_agent_comments: Vec<String>

p2p_listen_address: ContextualNetAddress

If undefined, sets it to 0.0.0.0

externalip: Option<NetAddress>

block_template_cache_lifetime: Option<u64>

disable_upnp: bool

ram_scale: f64

A scale factor to apply to memory allocation bounds

Implementations

impl Config

pub fn new(params: Params) -> Config

pub fn with_perf(params: Params, perf: PerfParams) -> Config

pub fn to_builder(&self) -> ConfigBuilder

Methods from Deref<Target = Params>

pub fn legacy_past_median_time_window_size(&self) -> usize

Returns the size of the full blocks window that is inspected to calculate the past median time (legacy)

pub fn sampled_past_median_time_window_size(&self) -> usize

Returns the size of the sampled blocks window that is inspected to calculate the past median time

pub fn past_median_time_window_size( &self, selected_parent_daa_score: u64, ) -> usize

Returns the size of the blocks window that is inspected to calculate the past median time, depending on a selected parent DAA score

pub fn timestamp_deviation_tolerance( &self, selected_parent_daa_score: u64, ) -> u64

Returns the timestamp deviation tolerance, depending on a selected parent DAA score

pub fn past_median_time_sample_rate( &self, selected_parent_daa_score: u64, ) -> u64

Returns the past median time sample rate, depending on a selected parent DAA score

pub fn difficulty_window_size(&self, selected_parent_daa_score: u64) -> usize

Returns the size of the blocks window that is inspected to calculate the difficulty, depending on a selected parent DAA score

pub fn difficulty_sample_rate(&self, selected_parent_daa_score: u64) -> u64

Returns the difficulty sample rate, depending on a selected parent DAA score

pub fn target_time_per_block(&self, _selected_parent_daa_score: u64) -> u64

Returns the target time per block, depending on a selected parent DAA score

pub fn bps(&self) -> u64

Returns the expected number of blocks per second

pub fn daa_window_duration_in_blocks( &self, selected_parent_daa_score: u64, ) -> u64

pub fn anticone_finalization_depth(&self) -> u64

Returns the depth at which the anticone of a chain block is final (i.e., is a permanently closed set). Based on the analysis at https://github.com/kaspanet/docs/blob/main/Reference/prunality/Prunality.pdf and on the decomposition of merge depth (rule R-I therein) from finality depth (φ)

pub fn is_nearly_synced(&self, sink_timestamp: u64, sink_daa_score: u64) -> bool

Returns whether the sink timestamp is recent enough and the node is considered synced or nearly synced.

pub fn network_name(&self) -> String

pub fn prefix(&self) -> Prefix

pub fn default_p2p_port(&self) -> u16

pub fn default_rpc_port(&self) -> u16

pub fn finality_duration(&self) -> u64

Trait Implementations

impl AsRef<Params> for Config

fn as_ref(&self) -> &Params

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Deref for Config

type Target = Params

The resulting type after dereferencing.

fn deref(&self) -> &<Config as Deref>::Target

Dereferences the value.