Struct sui_config::node::NodeConfig
source · pub struct NodeConfig {Show 44 fields
pub protocol_key_pair: AuthorityKeyPairWithPath,
pub worker_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_experimental_rest_api: bool,
pub metrics_address: SocketAddr,
pub admin_interface_port: u16,
pub consensus_config: Option<ConsensusConfig>,
pub enable_event_processing: bool,
pub enable_index_processing: bool,
pub websocket_only: bool,
pub grpc_load_shed: Option<bool>,
pub grpc_concurrency_limit: Option<usize>,
pub p2p_config: P2pConfig,
pub genesis: Genesis,
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 indirect_objects_threshold: usize,
pub expensive_safety_check_config: ExpensiveSafetyCheckConfig,
pub name_service_package_address: Option<SuiAddress>,
pub name_service_registry_id: Option<ObjectID>,
pub name_service_reverse_registry_id: Option<ObjectID>,
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>,
}
Fields§
§protocol_key_pair: AuthorityKeyPairWithPath
§worker_key_pair: KeyPairWithPath
§account_key_pair: KeyPairWithPath
§network_key_pair: KeyPairWithPath
§db_path: PathBuf
§network_address: Multiaddr
§json_rpc_address: SocketAddr
§enable_experimental_rest_api: bool
§metrics_address: SocketAddr
§admin_interface_port: u16
§consensus_config: Option<ConsensusConfig>
§enable_event_processing: bool
§enable_index_processing: bool
§websocket_only: bool
§grpc_load_shed: Option<bool>
§grpc_concurrency_limit: Option<usize>
§p2p_config: P2pConfig
§genesis: Genesis
§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
§metrics: Option<MetricsConfig>
§supported_protocol_versions: Option<SupportedProtocolVersions>
In a sui-node
binary, this is set to SupportedProtocolVersions::SYSTEM_DEFAULT
in sui-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
§indirect_objects_threshold: usize
§expensive_safety_check_config: ExpensiveSafetyCheckConfig
§name_service_package_address: Option<SuiAddress>
§name_service_registry_id: Option<ObjectID>
§name_service_reverse_registry_id: Option<ObjectID>
§transaction_deny_config: TransactionDenyConfig
§certificate_deny_config: CertificateDenyConfig
§state_debug_dump_config: StateDebugDumpConfig
§state_archive_write_config: StateArchiveConfig
§state_archive_read_config: Vec<StateArchiveConfig>
§state_snapshot_write_config: StateSnapshotConfig
§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>>
§run_with_range: Option<RunWithRange>
§policy_config: Option<PolicyConfig>
§firewall_config: Option<RemoteFirewallConfig>
Implementations§
source§impl NodeConfig
impl NodeConfig
pub fn protocol_key_pair(&self) -> &AuthorityKeyPair
pub fn worker_key_pair(&self) -> &NetworkKeyPair
pub fn network_key_pair(&self) -> &NetworkKeyPair
pub fn protocol_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 sui_address(&self) -> SuiAddress
pub fn archive_reader_config(&self) -> Vec<ArchiveReaderConfig>
Trait Implementations§
source§impl Clone for NodeConfig
impl Clone for NodeConfig
source§fn clone(&self) -> NodeConfig
fn clone(&self) -> NodeConfig
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Config for NodeConfig
impl Config for NodeConfig
source§impl Debug for NodeConfig
impl Debug for NodeConfig
source§impl<'de> Deserialize<'de> for NodeConfig
impl<'de> Deserialize<'de> for NodeConfig
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl RefUnwindSafe for NodeConfig
impl Send for NodeConfig
impl Sync for NodeConfig
impl Unpin for NodeConfig
impl UnwindSafe for NodeConfig
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a Request
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.