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 enable_rest_api: bool,
    pub rest: Option<Config>,
    pub metrics_address: SocketAddr,
    pub admin_interface_address: SocketAddr,
    pub consensus_config: Option<ConsensusConfig>,
    pub enable_index_processing: bool,
    pub remove_deprecated_tables: bool,
    pub jsonrpc_server_type: Option<ServerType>,
    pub grpc_load_shed: Option<bool>,
    pub grpc_concurrency_limit: Option<usize>,
    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 db_checkpoint_config: DBCheckpointConfig,
    pub expensive_safety_check_config: ExpensiveSafetyCheckConfig,
    pub transaction_deny_config: TransactionDenyConfig,
    pub certificate_deny_config: CertificateDenyConfig,
    pub state_debug_dump_config: StateDebugDumpConfig,
    pub state_archive_write_config: StateArchiveConfig,
    pub state_archive_read_config: Vec<StateArchiveConfig>,
    pub state_snapshot_write_config: StateSnapshotConfig,
    pub indexer_max_subscriptions: Option<usize>,
    pub transaction_kv_store_read_config: TransactionKeyValueStoreReadConfig,
    pub transaction_kv_store_write_config: Option<TransactionKeyValueStoreWriteConfig>,
    pub jwk_fetch_interval_seconds: u64,
    pub zklogin_oauth_providers: BTreeMap<Chain, BTreeSet<String>>,
    pub authority_overload_config: AuthorityOverloadConfig,
    pub run_with_range: Option<RunWithRange>,
    pub policy_config: Option<PolicyConfig>,
    pub firewall_config: Option<RemoteFirewallConfig>,
    pub execution_cache: ExecutionCacheType,
    pub execution_cache_config: ExecutionCacheConfig,
    pub enable_validator_tx_finalizer: 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>,
}

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

enable_rest_api: bool

Flag to enable the REST API under /api/v1 endpoint on the same interface as json rpc server.

rest: Option<Config>

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_index_processing: bool

Flag to enable index processing for a full node.

If set to true, node creates IndexStore for transaction data including ownership and balance information.

remove_deprecated_tables: bool

jsonrpc_server_type: Option<ServerType>

Determines the jsonrpc server type as either:

• ‘websocket’ for a websocket based service (deprecated)
• ‘http’ for an http based service
• ‘both’ for both a websocket and http based service (deprecated)

grpc_load_shed: Option<bool>

Flag to enable gRPC load shedding to manage and mitigate overload conditions by shedding excess load with LoadShedLayer middleware.

grpc_concurrency_limit: Option<usize>

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.

db_checkpoint_config: DBCheckpointConfig

Configuration to manage database checkpoints, including whether to perform checkpoints at the end of an epoch, the path for storing checkpoints, and other related settings.

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.

state_archive_write_config: StateArchiveConfig

Configuration for writing state archive. If ObjectStorage config is provided, ArchiveWriter will be created for checkpoints archival.

state_archive_read_config: Vec<StateArchiveConfig>

state_snapshot_write_config: StateSnapshotConfig

Determines if snapshot should be uploaded to the remote storage.

indexer_max_subscriptions: Option<usize>

transaction_kv_store_read_config: TransactionKeyValueStoreReadConfig

transaction_kv_store_write_config: Option<TransactionKeyValueStoreWriteConfig>

jwk_fetch_interval_seconds: u64

zklogin_oauth_providers: BTreeMap<Chain, BTreeSet<String>>

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>

firewall_config: Option<RemoteFirewallConfig>

execution_cache: ExecutionCacheType

execution_cache_config: ExecutionCacheConfig

enable_validator_tx_finalizer: bool

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>

Implementations

impl NodeConfig

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 db_checkpoint_path(&self) -> PathBuf

pub fn archive_path(&self) -> PathBuf

pub fn snapshot_path(&self) -> PathBuf

pub fn network_address(&self) -> &Multiaddr

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

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

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

pub fn iota_address(&self) -> IotaAddress

pub fn archive_reader_config(&self) -> Vec<ArchiveReaderConfig>

pub fn jsonrpc_server_type(&self) -> ServerType

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy 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.