Struct NodeConfig 

pub struct NodeConfig {

    pub authority_key_pair: AuthorityKeyPairWithPath,
    pub protocol_key_pair: KeyPairWithPath,
    pub account_key_pair: KeyPairWithPath,
    pub network_key_pair: KeyPairWithPath,
    pub db_path: PathBuf,
    pub network_address: Multiaddr,
    pub json_rpc_address: SocketAddr,
    pub metrics_address: SocketAddr,
    pub admin_interface_address: SocketAddr,
    pub consensus_config: Option<ConsensusConfig>,
    pub enable_jsonrpc_api: bool,
    pub enable_index_processing: Option<bool>,
    pub grpc_load_shed: Option<bool>,
    pub grpc_concurrency_limit_per_core: NonZeroUsize,
    pub p2p_config: P2pConfig,
    pub genesis: Genesis,
    pub migration_tx_data_path: Option<PathBuf>,
    pub authority_store_pruning_config: AuthorityStorePruningConfig,
    pub end_of_epoch_broadcast_channel_capacity: usize,
    pub checkpoint_executor_config: CheckpointExecutorConfig,
    pub metrics: Option<MetricsConfig>,
    pub supported_protocol_versions: Option<SupportedProtocolVersions>,
    pub expensive_safety_check_config: ExpensiveSafetyCheckConfig,
    pub transaction_deny_config: TransactionDenyConfig,
    pub certificate_deny_config: CertificateDenyConfig,
    pub state_debug_dump_config: StateDebugDumpConfig,
    pub checkpoint_archive_config: Option<CheckpointArchiveConfig>,
    pub state_snapshot_write_config: StateSnapshotConfig,
    pub transaction_kv_store_read_config: TransactionKeyValueStoreReadConfig,
    pub transaction_kv_store_write_config: Option<TransactionKeyValueStoreWriteConfig>,
    pub authority_overload_config: AuthorityOverloadConfig,
    pub run_with_range: Option<RunWithRange>,
    pub policy_config: Option<PolicyConfig>,
    pub execution_cache_config: ExecutionCacheConfig,
    pub full_checkpoint_contents_cache_size_mb: usize,
    pub enable_validator_tx_finalizer: bool,
    pub enable_soft_locking: bool,
    pub verifier_signing_config: VerifierSigningConfig,
    pub enable_db_write_stall: Option<bool>,
    pub iota_names_config: Option<IotaNamesConfig>,
    pub enable_grpc_api: bool,
    pub grpc_api_config: Option<GrpcApiConfig>,
    pub chain_override_for_testing: Option<Chain>,
    pub validator_client_monitor_config: Option<ValidatorClientMonitorConfig>,
}

Fields

authority_key_pair: AuthorityKeyPairWithPath

The public key bytes corresponding to the private key that the validator holds to sign transactions.

protocol_key_pair: KeyPairWithPath

The public key bytes corresponding to the private key that the validator holds to sign consensus blocks.

account_key_pair: KeyPairWithPath

network_key_pair: KeyPairWithPath

The public key bytes corresponding to the private key that the validator uses to establish TLS connections.

db_path: PathBuf

network_address: Multiaddr

The network address for gRPC communication.

Can be overwritten with args listen-address parameters.

json_rpc_address: SocketAddr

metrics_address: SocketAddr

The address for Prometheus metrics.

admin_interface_address: SocketAddr

The address for the admin interface that is run in the metrics separate runtime and provides access to admin node commands such as logging and tracing options.

consensus_config: Option<ConsensusConfig>

Configuration struct for the consensus.

enable_jsonrpc_api: bool

Flag to enable the JSON-RPC API. Default: true. When false a full node serves only the /health endpoint on json_rpc_address.

enable_index_processing: Option<bool>

Renamed to enable_jsonrpc_api; see NodeConfig::check_renamed_keys for which configs that still set it are refused. Never set this. Removal is tracked in https://github.com/iotaledger/iota/issues/12885.

grpc_load_shed: Option<bool>

Flag to enable gRPC load shedding: requests over a service’s concurrency limit are rejected immediately with RESOURCE_EXHAUSTED instead of waiting for a slot.

grpc_concurrency_limit_per_core: NonZeroUsize

Maximum number of concurrent in-flight requests per CPU core, applied to each service of the validator gRPC server separately (Validator, ValidatorV2, ValidatorPeer), so a flood of client transaction submissions cannot crowd validator-peer RPCs out of admission slots. The effective per-service limit is this value multiplied by the CPU cores of the machine at server startup, so the same config file scales with the hardware.

Most request time is spent awaiting locks, I/O or consensus rather than on-CPU, so the default ceiling is generous: it bounds total in-flight work so a request flood cannot grow queues and memory without limit, it does not throttle normal load. Operators wanting hard load-shedding can lower it and set grpc_load_shed.

A value of zero is rejected at config load: it would not disable the limit, it would block every request.

p2p_config: P2pConfig

Configuration struct for P2P.

genesis: Genesis

Contains genesis location that might be InPlace for reading all genesis data to memory or InFile, and OnceCell pointer to a genesis struct.

migration_tx_data_path: Option<PathBuf>

Contains the path where to find the migration blob.

authority_store_pruning_config: AuthorityStorePruningConfig

Configuration for pruning of the authority store, to define when an old data is removed from the storage space.

end_of_epoch_broadcast_channel_capacity: usize

Size of the broadcast channel used for notifying other systems of end of epoch.

If unspecified, this will default to 128.

checkpoint_executor_config: CheckpointExecutorConfig

Configuration for the checkpoint executor for limiting the number of checkpoints to execute concurrently, and to allow for checkpoint post-processing.

metrics: Option<MetricsConfig>

supported_protocol_versions: Option<SupportedProtocolVersions>

In a iota-node binary, this is set to SupportedProtocolVersions::SYSTEM_DEFAULT in iota-node/src/main.rs. It is present in the config so that it can be changed by tests in order to test protocol upgrades.

expensive_safety_check_config: ExpensiveSafetyCheckConfig

Configuration for enabling/disabling expensive safety checks.

transaction_deny_config: TransactionDenyConfig

Configuration to specify rules for denying transactions based on objectsIDs, addresses, or enable/disable many features such as publishing new packages or using shared objects.

certificate_deny_config: CertificateDenyConfig

Config used to deny execution for certificate digests know for crashing or hanging validator nodes.

Should be used for a fast temporary fixes and removed once the issue is fixed.

state_debug_dump_config: StateDebugDumpConfig

Used to determine how state debug information is dumped when a node forks.

checkpoint_archive_config: Option<CheckpointArchiveConfig>

state_snapshot_write_config: StateSnapshotConfig

Determines if snapshot should be uploaded to the remote storage.

transaction_kv_store_read_config: TransactionKeyValueStoreReadConfig

transaction_kv_store_write_config: Option<TransactionKeyValueStoreWriteConfig>

authority_overload_config: AuthorityOverloadConfig

Configuration for defining thresholds and settings for managing system overload conditions in a node.

run_with_range: Option<RunWithRange>

Specifies the ending epoch for a node for debugging purposes.

Ignored if set by config, can be configured only by cli arguments.

policy_config: Option<PolicyConfig>

Traffic control policy. For killswitch use None.

With the key absent the default denial-of-service protection policy applies, an explicit null turns traffic control off, and a value configures it.

execution_cache_config: ExecutionCacheConfig

full_checkpoint_contents_cache_size_mb: usize

Memory budget in MiB for the in-memory cache of full checkpoint contents, which serves the checkpoint executor’s bulk transaction loads and checkpoint-contents requests from state-sync peers. When the budget is exceeded, the oldest checkpoints are evicted first. Set to 0 to disable the cache; consumers then fall back to reconstructing contents from the transaction and effects stores.

The budget is accounted in serialized (BCS) bytes; the resident memory of a full cache is somewhat higher than the configured value due to in-memory representation overhead.

enable_validator_tx_finalizer: bool

enable_soft_locking: bool

Enables the pre-consensus soft-locking mechanism used by the certificate-less (pcool) transaction flow (default: enabled).

When disabled, post-consensus validation alone resolves owned-object conflicts. Has no effect unless the pcool flow is enabled.

verifier_signing_config: VerifierSigningConfig

enable_db_write_stall: Option<bool>

If a value is set, it determines if writes to DB can stall, which can halt the whole process. By default, write stall is enabled on validators but not on fullnodes.

iota_names_config: Option<IotaNamesConfig>

enable_grpc_api: bool

Flag to enable the gRPC API.

grpc_api_config: Option<GrpcApiConfig>

Configuration of the gRPC API, read when enable_grpc_api is set.

With the key absent the default configuration applies, an explicit null leaves the API unconfigured — a node with enable-grpc-api set then fails to start — and a value configures it.

chain_override_for_testing: Option<Chain>

Allow overriding the chain for testing purposes. For instance, it allows you to create a test network that believes it is mainnet or testnet. Attempting to override this value on production networks will result in an error.

validator_client_monitor_config: Option<ValidatorClientMonitorConfig>

Configuration for the validator client monitor that tracks client-observed performance metrics for validators.

Implementations

impl NodeConfig

pub fn check_renamed_keys(&self) -> Result<()>

Fails if the config file still sets a key that has been renamed, unless the new key already does what the old value asked for; that case only logs a warning. Call this before doing any work.

enable-index-processing is accepted on a validator, which never built the JSON-RPC index whatever its value, and as true while enable-jsonrpc-api is on. false on a full node is refused: it served the JSON-RPC API without its index, which enable-jsonrpc-api cannot express.

pub fn authority_key_pair(&self) -> &AuthorityKeyPair

pub fn protocol_key_pair(&self) -> &NetworkKeyPair

pub fn network_key_pair(&self) -> &NetworkKeyPair

pub fn authority_public_key(&self) -> AuthorityPublicKeyBytes

pub fn db_path(&self) -> PathBuf

pub fn snapshot_path(&self) -> PathBuf

pub fn network_address(&self) -> &Multiaddr

pub fn consensus_config(&self) -> Option<&ConsensusConfig>

pub fn maintains_rpc_indexes(&self) -> bool

Whether this node builds the RPC indexes: only a fullnode with the JSON-RPC or gRPC API enabled does.

pub fn genesis(&self) -> Result<&Genesis>

pub fn load_migration_tx_data(&self) -> Result<MigrationTxData>

pub fn iota_address(&self) -> Address

pub fn checkpoint_archive_config(&self) -> Option<&CheckpointArchiveConfig>

pub fn is_validator(&self) -> bool

A config selects the validator role exactly when it has a consensus config.

pub fn validate(&self) -> Result<()>

Validate the node config. The checks reject a config a node could not start with. They also reject the known cases where a node would start and ignore part of the config.

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for NodeConfig

fn persisted(self, path: &Path) -> PersistedConfig<Self>

fn load<P: AsRef<Path>>(path: P) -> Result<Self, Error>

fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NodeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.