sui_config::node

Struct NodeConfig

Source 
pub struct NodeConfig {
Show 51 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 rpc: Option<Config>,
    pub metrics_address: SocketAddr,
    pub admin_interface_port: u16,
    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 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 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>,
    pub execution_cache: ExecutionCacheConfig,
    pub state_accumulator_v2: bool,
    pub enable_soft_bundle: bool,
    pub enable_validator_tx_finalizer: bool,
    pub verifier_signing_config: VerifierSigningConfig,
    pub enable_db_write_stall: Option<bool>,
    pub execution_time_observer_config: Option<ExecutionTimeObserverConfig>,
    pub chain_override_for_testing: Option<Chain>,

}

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§rpc: Option<Config>§metrics_address: SocketAddr§admin_interface_port: u16§consensus_config: Option<ConsensusConfig>§enable_index_processing: bool§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>§grpc_concurrency_limit: Option<usize>§p2p_config: P2pConfig§genesis: Genesis§authority_store_pruning_config: AuthorityStorePruningConfig§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§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>>§authority_overload_config: AuthorityOverloadConfig§run_with_range: Option<RunWithRange>§policy_config: Option<PolicyConfig>§firewall_config: Option<RemoteFirewallConfig>§execution_cache: ExecutionCacheConfig§state_accumulator_v2: bool§enable_soft_bundle: bool§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.

§execution_time_observer_config: Option<ExecutionTimeObserverConfig>§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.

Implementations§

Source§

impl NodeConfig

Source

pub fn protocol_key_pair(&self) -> &AuthorityKeyPair

Source

pub fn worker_key_pair(&self) -> &NetworkKeyPair

Source

pub fn network_key_pair(&self) -> &NetworkKeyPair

Source

pub fn protocol_public_key(&self) -> AuthorityPublicKeyBytes

Source

pub fn db_path(&self) -> PathBuf

Source

pub fn db_checkpoint_path(&self) -> PathBuf

Source

pub fn archive_path(&self) -> PathBuf

Source

pub fn snapshot_path(&self) -> PathBuf

Source

pub fn network_address(&self) -> &Multiaddr

Source

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

Source

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

Source

pub fn sui_address(&self) -> SuiAddress

Source

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

Source

pub fn jsonrpc_server_type(&self) -> ServerType

Source

pub fn rpc(&self) -> Option<&Config>

Trait Implementations§

Source§

impl Clone for NodeConfig

Source§

fn clone(&self) -> NodeConfig

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Config for NodeConfig

Source§

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

Source§

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

Source§

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

Source§

impl Debug for NodeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for NodeConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for U

§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

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,

Causes self to use its Display implementation when Debug-formatted.
§

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,

Causes self to use its LowerHex implementation when Debug-formatted.
§

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,

Causes self to use its Pointer implementation when Debug-formatted.
§

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,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a Request
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where 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) -> R
where 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) -> R
where 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
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

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

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

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
where Self: BorrowMut<B>, B: ?Sized,

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
where Self: AsRef<R>, R: ?Sized,

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
where Self: AsMut<R>, R: ?Sized,

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
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T