1use anemo::Network;
5use anemo::PeerId;
6use anemo_tower::callback::CallbackLayer;
7use anemo_tower::trace::DefaultMakeSpan;
8use anemo_tower::trace::DefaultOnFailure;
9use anemo_tower::trace::TraceLayer;
10use anyhow::Context;
11use anyhow::Result;
12use anyhow::anyhow;
13use arc_swap::ArcSwap;
14use fastcrypto_zkp::bn254::zk_login::JwkId;
15use fastcrypto_zkp::bn254::zk_login::OIDCProvider;
16use futures::future::BoxFuture;
17use mysten_common::debug_fatal;
18use mysten_common::in_test_configuration;
19use prometheus::Registry;
20use std::collections::{BTreeSet, HashMap, HashSet};
21use std::fmt;
22use std::future::Future;
23use std::path::Path;
24use std::path::PathBuf;
25use std::str::FromStr;
26#[cfg(msim)]
27use std::sync::atomic::Ordering;
28use std::sync::{Arc, OnceLock, Weak};
29use std::time::Duration;
30use sui_core::admission_queue::{
31 AdmissionQueueContext, AdmissionQueueManager, AdmissionQueueMetrics,
32};
33use sui_core::authority::ExecutionEnv;
34use sui_core::authority::authority_store_tables::AuthorityPerpetualTablesOptions;
35use sui_core::authority::backpressure::BackpressureManager;
36use sui_core::authority::epoch_start_configuration::EpochFlag;
37use sui_core::authority::execution_time_estimator::ExecutionTimeObserver;
38use sui_core::consensus_adapter::ConsensusClient;
39use sui_core::consensus_manager::UpdatableConsensusClient;
40use sui_core::consensus_transaction_pool::TransactionPoolContext;
41use sui_core::epoch::randomness::RandomnessManager;
42use sui_core::execution_cache::build_execution_cache;
43use sui_core::randomness_round_receiver::{RandomnessRoundReceiver, RandomnessRoundReceiverHandle};
44use sui_network::endpoint_manager::{AddressSource, EndpointId};
45use sui_network::validator::server::SUI_TLS_SERVER_NAME;
46use sui_types::full_checkpoint_content::Checkpoint;
47use sui_types::node_role::NodeRole;
48
49use sui_core::global_state_hasher::GlobalStateHashMetrics;
50use sui_core::storage::RestReadStore;
51use sui_network::randomness;
52use sui_rpc_api::ServerVersion;
53use sui_rpc_api::subscription::SubscriptionService;
54use sui_types::base_types::ConciseableName;
55use sui_types::crypto::RandomnessRound;
56use sui_types::digests::{
57 ChainIdentifier, CheckpointDigest, TransactionDigest, TransactionEffectsDigest,
58};
59use sui_types::messages_consensus::AuthorityCapabilitiesV2;
60use sui_types::sui_system_state::SuiSystemState;
61use tap::tap::TapFallible;
62use tokio::sync::{Mutex, broadcast, mpsc};
63use tokio::task::JoinHandle;
64use tower::ServiceBuilder;
65use tracing::{Instrument, error_span, info};
66use tracing::{debug, error, warn};
67
68macro_rules! jwk_log {
72 ($($arg:tt)+) => {
73 if in_test_configuration() {
74 debug!($($arg)+);
75 } else {
76 info!($($arg)+);
77 }
78 };
79}
80
81use fastcrypto_zkp::bn254::zk_login::JWK;
82pub use handle::SuiNodeHandle;
83use mysten_metrics::{RegistryService, spawn_monitored_task};
84use mysten_service::server_timing::server_timing_middleware;
85use sui_config::node::{DBCheckpointConfig, RunWithRange};
86use sui_config::node::{ForkCrashBehavior, ForkRecoveryConfig};
87use sui_config::transaction_deny_config::TransactionDenyRules;
88use sui_config::{ConsensusConfig, NodeConfig};
89use sui_core::authority::authority_per_epoch_store::AuthorityPerEpochStore;
90use sui_core::authority::authority_store_tables::AuthorityPerpetualTables;
91use sui_core::authority::epoch_start_configuration::EpochStartConfigTrait;
92use sui_core::authority::epoch_start_configuration::EpochStartConfiguration;
93use sui_core::authority::submitted_transaction_cache::SubmittedTransactionCacheMetrics;
94use sui_core::authority_aggregator::AuthorityAggregator;
95use sui_core::authority_server::{UserSubmissionPath, ValidatorService, ValidatorServiceMetrics};
96use sui_core::checkpoints::checkpoint_executor::metrics::CheckpointExecutorMetrics;
97use sui_core::checkpoints::checkpoint_executor::{CheckpointExecutor, StopReason};
98use sui_core::checkpoints::{
99 CheckpointMetrics, CheckpointOutput, CheckpointService, CheckpointStore, LogCheckpointOutput,
100 SendCheckpointToStateSync, SubmitCheckpointToConsensus,
101};
102use sui_core::consensus_adapter::{ConsensusAdapter, ConsensusAdapterMetrics};
103use sui_core::consensus_manager::ConsensusManager;
104use sui_core::consensus_throughput_calculator::ConsensusThroughputCalculator;
105use sui_core::consensus_validator::{SuiTxValidator, SuiTxValidatorMetrics};
106use sui_core::db_checkpoint_handler::DBCheckpointHandler;
107use sui_core::epoch::committee_store::CommitteeStore;
108use sui_core::epoch::consensus_store_pruner::ConsensusStorePruner;
109use sui_core::epoch::epoch_metrics::EpochMetrics;
110use sui_core::epoch::reconfiguration::ReconfigurationInitiator;
111use sui_core::global_state_hasher::GlobalStateHasher;
112use sui_core::module_cache_metrics::ResolverMetrics;
113use sui_core::overload_monitor::overload_monitor;
114use sui_core::rpc_store_embed::EmbeddedRpcStore;
115use sui_core::signature_verifier::SignatureVerifierMetrics;
116use sui_core::storage::RocksDbStore;
117use sui_core::storage::RpcStoreReadStore;
118use sui_core::transaction_orchestrator::TransactionOrchestrator;
119use sui_core::{
120 authority::{AuthorityState, AuthorityStore},
121 authority_client::NetworkAuthorityClient,
122};
123use sui_macros::fail_point;
124use sui_macros::{fail_point_arg, fail_point_async, replay_log};
125use sui_network::api::ValidatorServer;
126use sui_network::discovery;
127use sui_network::endpoint_manager::EndpointManager;
128use sui_network::state_sync;
129use sui_network::validator::server::ServerBuilder;
130use sui_protocol_config::{ProtocolConfig, ProtocolVersion};
131use sui_snapshot::uploader::StateSnapshotUploader;
132use sui_types::base_types::{AuthorityName, EpochId};
133use sui_types::committee::Committee;
134use sui_types::crypto::KeypairTraits;
135use sui_types::error::{SuiError, SuiResult};
136use sui_types::messages_consensus::{ConsensusTransaction, check_total_jwk_size};
137use sui_types::storage::RpcStateReader;
138use sui_types::sui_system_state::SuiSystemStateTrait;
139use sui_types::sui_system_state::epoch_start_sui_system_state::EpochStartSystemState;
140use sui_types::sui_system_state::epoch_start_sui_system_state::EpochStartSystemStateTrait;
141use sui_types::supported_protocol_versions::SupportedProtocolVersions;
142use typed_store::DBMetrics;
143use typed_store::rocks::default_db_options;
144
145use crate::metrics::{GrpcMetrics, SuiNodeMetrics};
146
147pub mod address_prober;
148pub mod admin;
149pub mod db_shell;
150mod handle;
151pub mod metrics;
152
153pub struct ValidatorComponents {
154 validator_server_handle: Option<ValidatorGrpcServer>,
155 validator_overload_monitor_handle: Option<JoinHandle<()>>,
156 consensus_manager: Arc<ConsensusManager>,
157 consensus_store_pruner: ConsensusStorePruner,
158 consensus_adapter: Arc<ConsensusAdapter>,
159 checkpoint_metrics: Arc<CheckpointMetrics>,
160 sui_tx_validator_metrics: Arc<SuiTxValidatorMetrics>,
161 admission_queue: Option<AdmissionQueueContext>,
162 transaction_pool_context: Option<Arc<TransactionPoolContext>>,
163}
164
165pub struct P2pComponents {
166 p2p_network: Network,
167 known_peers: HashMap<PeerId, String>,
168 discovery_handle: discovery::Handle,
169 state_sync_handle: state_sync::Handle,
170 randomness_handle: randomness::Handle,
171 endpoint_manager: EndpointManager,
172}
173
174#[cfg(msim)]
175mod simulator {
176 use std::sync::Mutex;
177 use std::sync::atomic::AtomicBool;
178 use sui_types::error::SuiErrorKind;
179
180 use super::*;
181 pub(super) struct SimState {
182 pub sim_node: sui_simulator::runtime::NodeHandle,
183 pub sim_safe_mode_expected: AtomicBool,
184 _leak_detector: sui_simulator::NodeLeakDetector,
185 }
186
187 impl Default for SimState {
188 fn default() -> Self {
189 Self {
190 sim_node: sui_simulator::runtime::NodeHandle::current(),
191 sim_safe_mode_expected: AtomicBool::new(false),
192 _leak_detector: sui_simulator::NodeLeakDetector::new(),
193 }
194 }
195 }
196
197 type JwkInjector = dyn Fn(AuthorityName, &OIDCProvider) -> SuiResult<Vec<(JwkId, JWK)>>
198 + Send
199 + Sync
200 + 'static;
201
202 fn default_fetch_jwks(
203 _authority: AuthorityName,
204 _provider: &OIDCProvider,
205 ) -> SuiResult<Vec<(JwkId, JWK)>> {
206 use fastcrypto_zkp::bn254::zk_login::parse_jwks;
207 parse_jwks(
209 sui_types::zk_login_util::DEFAULT_JWK_BYTES,
210 &OIDCProvider::Twitch,
211 true,
212 )
213 .map_err(|_| SuiErrorKind::JWKRetrievalError.into())
214 }
215
216 static JWK_INJECTOR: Mutex<Option<Arc<JwkInjector>>> = Mutex::new(None);
217
218 pub(super) fn get_jwk_injector() -> Arc<JwkInjector> {
219 JWK_INJECTOR
220 .lock()
221 .unwrap()
222 .clone()
223 .unwrap_or_else(|| Arc::new(default_fetch_jwks))
224 }
225
226 pub fn set_jwk_injector(injector: Arc<JwkInjector>) {
227 *JWK_INJECTOR.lock().unwrap() = Some(injector);
228 }
229}
230
231#[cfg(msim)]
232pub use simulator::set_jwk_injector;
233#[cfg(msim)]
234use simulator::*;
235use sui_core::authority::authority_store_pruner::PrunerWatermarks;
236use sui_core::{
237 consensus_handler::ConsensusHandlerInitializer, safe_client::SafeClientMetricsBase,
238};
239
240const DEFAULT_GRPC_CONNECT_TIMEOUT: Duration = Duration::from_secs(60);
241const VALIDATOR_GRPC_SERVER_SHUTDOWN_TIMEOUT: Duration = Duration::from_secs(30);
242
243fn epoch_store_release_grace_period() -> Duration {
248 if cfg!(msim) {
249 Duration::from_secs(15)
250 } else {
251 Duration::from_secs(60)
252 }
253}
254
255pub struct SuiNode {
256 config: NodeConfig,
257 validator_components: Mutex<Option<ValidatorComponents>>,
258
259 #[allow(unused)]
261 http_servers: HttpServers,
262
263 state: Arc<AuthorityState>,
264 transaction_orchestrator: Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>>,
265 registry_service: RegistryService,
266 metrics: Arc<SuiNodeMetrics>,
267 checkpoint_metrics: Arc<CheckpointMetrics>,
268
269 _discovery: discovery::Handle,
270 _connection_monitor_handle: mysten_network::anemo_connection_monitor::ConnectionMonitorHandle,
271 state_sync_handle: state_sync::Handle,
272 randomness_handle: randomness::Handle,
273 checkpoint_store: Arc<CheckpointStore>,
274 global_state_hasher: Mutex<Option<Arc<GlobalStateHasher>>>,
275
276 end_of_epoch_channel: broadcast::Sender<SuiSystemState>,
278
279 endpoint_manager: EndpointManager,
281
282 address_prober: Option<address_prober::Handle>,
284
285 backpressure_manager: Arc<BackpressureManager>,
286
287 _db_checkpoint_handle: Option<tokio::sync::broadcast::Sender<()>>,
288
289 #[cfg(msim)]
290 sim_state: SimState,
291
292 _state_snapshot_uploader_handle: Option<broadcast::Sender<()>>,
293 shutdown_channel_tx: broadcast::Sender<Option<RunWithRange>>,
295
296 randomness_receiver_handle: Arc<RandomnessRoundReceiverHandle>,
298
299 transaction_pool_context: Option<Arc<TransactionPoolContext>>,
302
303 consensus_adapter_metrics: OnceLock<ConsensusAdapterMetrics>,
304
305 auth_agg: Arc<ArcSwap<AuthorityAggregator<NetworkAuthorityClient>>>,
310
311 subscription_service_checkpoint_sender: Option<tokio::sync::broadcast::Sender<Arc<Checkpoint>>>,
312
313 embedded_rpc_store: Option<EmbeddedRpcStore>,
318}
319
320impl fmt::Debug for SuiNode {
321 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
322 f.debug_struct("SuiNode")
323 .field("name", &self.state.name.concise())
324 .finish()
325 }
326}
327
328static MAX_JWK_KEYS_PER_FETCH: usize = 100;
329
330impl SuiNode {
331 pub async fn start(
332 config: NodeConfig,
333 registry_service: RegistryService,
334 ) -> Result<Arc<SuiNode>> {
335 Self::start_async(
336 config,
337 registry_service,
338 ServerVersion::new("sui-node", "unknown"),
339 )
340 .await
341 }
342
343 fn start_jwk_updater(
344 config: &NodeConfig,
345 metrics: Arc<SuiNodeMetrics>,
346 authority: AuthorityName,
347 epoch_store: Arc<AuthorityPerEpochStore>,
348 consensus_adapter: Arc<ConsensusAdapter>,
349 ) {
350 let epoch = epoch_store.epoch();
351
352 let supported_providers = config
353 .zklogin_oauth_providers
354 .get(&epoch_store.get_chain_identifier().chain())
355 .unwrap_or(&BTreeSet::new())
356 .iter()
357 .map(|s| OIDCProvider::from_str(s).expect("Invalid provider string"))
358 .collect::<Vec<_>>();
359
360 let fetch_interval = Duration::from_secs(config.jwk_fetch_interval_seconds);
361
362 info!(
363 ?fetch_interval,
364 "Starting JWK updater tasks with supported providers: {:?}", supported_providers
365 );
366
367 fn validate_jwk(
368 metrics: &Arc<SuiNodeMetrics>,
369 provider: &OIDCProvider,
370 id: &JwkId,
371 jwk: &JWK,
372 ) -> bool {
373 let Ok(iss_provider) = OIDCProvider::from_iss(&id.iss) else {
374 warn!(
375 "JWK iss {:?} (retrieved from {:?}) is not a valid provider",
376 id.iss, provider
377 );
378 metrics
379 .invalid_jwks
380 .with_label_values(&[&provider.to_string()])
381 .inc();
382 return false;
383 };
384
385 if iss_provider != *provider {
386 warn!(
387 "JWK iss {:?} (retrieved from {:?}) does not match provider {:?}",
388 id.iss, provider, iss_provider
389 );
390 metrics
391 .invalid_jwks
392 .with_label_values(&[&provider.to_string()])
393 .inc();
394 return false;
395 }
396
397 if !check_total_jwk_size(id, jwk) {
398 warn!("JWK {:?} (retrieved from {:?}) is too large", id, provider);
399 metrics
400 .invalid_jwks
401 .with_label_values(&[&provider.to_string()])
402 .inc();
403 return false;
404 }
405
406 true
407 }
408
409 for p in supported_providers.into_iter() {
418 let provider_str = p.to_string();
419 let epoch_store = epoch_store.clone();
420 let consensus_adapter = consensus_adapter.clone();
421 let metrics = metrics.clone();
422 spawn_monitored_task!(epoch_store.clone().within_alive_epoch(
423 async move {
424 let mut seen = HashSet::new();
427 loop {
428 jwk_log!("fetching JWK for provider {:?}", p);
429 metrics.jwk_requests.with_label_values(&[&provider_str]).inc();
430 match Self::fetch_jwks(authority, &p).await {
431 Err(e) => {
432 metrics.jwk_request_errors.with_label_values(&[&provider_str]).inc();
433 warn!("Error when fetching JWK for provider {:?} {:?}", p, e);
434 tokio::time::sleep(Duration::from_secs(30)).await;
436 continue;
437 }
438 Ok(mut keys) => {
439 metrics.total_jwks
440 .with_label_values(&[&provider_str])
441 .inc_by(keys.len() as u64);
442
443 keys.retain(|(id, jwk)| {
444 validate_jwk(&metrics, &p, id, jwk) &&
445 !epoch_store.jwk_active_in_current_epoch(id, jwk) &&
446 seen.insert((id.clone(), jwk.clone()))
447 });
448
449 metrics.unique_jwks
450 .with_label_values(&[&provider_str])
451 .inc_by(keys.len() as u64);
452
453 if keys.len() > MAX_JWK_KEYS_PER_FETCH {
456 warn!("Provider {:?} sent too many JWKs, only the first {} will be used", p, MAX_JWK_KEYS_PER_FETCH);
457 keys.truncate(MAX_JWK_KEYS_PER_FETCH);
458 }
459
460 for (id, jwk) in keys.into_iter() {
461 jwk_log!("Submitting JWK to consensus: {:?}", id);
462
463 let txn = ConsensusTransaction::new_jwk_fetched(authority, id, jwk);
464 consensus_adapter.submit(txn, None, &epoch_store, None, None)
465 .tap_err(|e| warn!("Error when submitting JWKs to consensus {:?}", e))
466 .ok();
467 }
468 }
469 }
470 tokio::time::sleep(fetch_interval).await;
471 }
472 }
473 .instrument(error_span!("jwk_updater_task", epoch)),
474 ));
475 }
476 }
477
478 pub async fn start_async(
479 config: NodeConfig,
480 registry_service: RegistryService,
481 server_version: ServerVersion,
482 ) -> Result<Arc<SuiNode>> {
483 if let Some(prober_config) = &config.address_prober {
485 prober_config.validate()?;
486 }
487
488 let mut config = config.clone();
489 if config.supported_protocol_versions.is_none() {
490 info!(
491 "populating config.supported_protocol_versions with default {:?}",
492 SupportedProtocolVersions::SYSTEM_DEFAULT
493 );
494 config.supported_protocol_versions = Some(SupportedProtocolVersions::SYSTEM_DEFAULT);
495 }
496
497 let run_with_range = config.run_with_range;
498 let prometheus_registry = registry_service.default_registry();
499 let node_role = config.intended_node_role();
500
501 info!(node =? config.protocol_public_key(),
502 "Initializing sui-node listening on {} with role {:?}", config.network_address, node_role
503 );
504
505 DBMetrics::init(registry_service.clone());
507
508 fastcrypto::bulletproofs::initialize_generators();
511
512 typed_store::init_write_sync(config.enable_db_sync_to_disk);
514
515 mysten_metrics::init_metrics(&prometheus_registry);
517 #[cfg(not(msim))]
519 mysten_metrics::thread_stall_monitor::start_thread_stall_monitor();
520
521 let genesis = config.genesis()?.clone();
522
523 let secret = Arc::pin(config.protocol_key_pair().copy());
524 let genesis_committee = genesis.committee();
525 let committee_store = Arc::new(CommitteeStore::new(
526 config.db_path().join("epochs"),
527 &genesis_committee,
528 None,
529 ));
530
531 let pruner_watermarks = Arc::new(PrunerWatermarks::default());
532 let checkpoint_store = CheckpointStore::new(
533 &config.db_path().join("checkpoints"),
534 pruner_watermarks.clone(),
535 );
536 let checkpoint_metrics = CheckpointMetrics::new(®istry_service.default_registry());
537
538 #[allow(unused_mut)]
539 let mut build_version = server_version.version.to_string();
540 fail_point_arg!("override_binary_version", |version: std::sync::Arc<
541 std::sync::Mutex<String>,
542 >| {
543 #[cfg(msim)]
544 {
545 build_version = version.lock().unwrap().clone();
546 }
547 });
548 checkpoint_store.set_binary_version(&build_version);
551
552 if node_role.runs_consensus() {
553 Self::check_and_recover_forks(
554 &checkpoint_store,
555 &checkpoint_metrics,
556 config.fork_recovery.as_ref(),
557 &build_version,
558 )
559 .await?;
560 }
561
562 let enable_write_stall = config
564 .enable_db_write_stall
565 .unwrap_or(node_role.runs_consensus());
566 let enable_objects_compactor = node_role.is_validator()
573 || config.authority_store_pruning_config.num_epochs_to_retain == 0;
574 let perpetual_tables_options = AuthorityPerpetualTablesOptions {
575 enable_write_stall,
576 enable_objects_compactor,
577 };
578 let perpetual_tables = Arc::new(AuthorityPerpetualTables::open(
579 &config.db_store_path(),
580 Some(perpetual_tables_options),
581 Some(pruner_watermarks.epoch_id.clone()),
582 ));
583 let is_genesis = perpetual_tables
584 .database_is_empty()
585 .expect("Database read should not fail at init.");
586
587 let backpressure_manager =
588 BackpressureManager::new_from_checkpoint_store(&checkpoint_store);
589
590 let store =
591 AuthorityStore::open(perpetual_tables, &genesis, &config, &prometheus_registry).await?;
592
593 let cur_epoch = store.get_recovery_epoch_at_restart()?;
594 let committee = committee_store
595 .get_committee(&cur_epoch)?
596 .expect("Committee of the current epoch must exist");
597 let epoch_start_configuration = store
598 .get_epoch_start_configuration()?
599 .expect("EpochStartConfiguration of the current epoch must exist");
600 let cache_metrics = Arc::new(ResolverMetrics::new(&prometheus_registry));
601 let signature_verifier_metrics = SignatureVerifierMetrics::new(&prometheus_registry);
602
603 let cache_traits = build_execution_cache(
604 &config.execution_cache,
605 &prometheus_registry,
606 &store,
607 backpressure_manager.clone(),
608 );
609
610 let auth_agg = {
611 let safe_client_metrics_base = SafeClientMetricsBase::new(&prometheus_registry);
612 Arc::new(ArcSwap::new(Arc::new(
613 AuthorityAggregator::new_from_epoch_start_state(
614 epoch_start_configuration.epoch_start_state(),
615 &committee_store,
616 safe_client_metrics_base,
617 ),
618 )))
619 };
620
621 let chain_id = ChainIdentifier::from(*genesis.checkpoint().digest());
622 let chain = match config.chain_override_for_testing {
623 Some(chain) => chain,
624 None => ChainIdentifier::from(*genesis.checkpoint().digest()).chain(),
625 };
626
627 let highest_executed_checkpoint = checkpoint_store
628 .get_highest_executed_checkpoint_seq_number()
629 .expect("checkpoint store read cannot fail")
630 .unwrap_or(0);
631
632 let previous_epoch_last_checkpoint = if cur_epoch == 0 {
633 0
634 } else {
635 checkpoint_store
636 .get_epoch_last_checkpoint_seq_number(cur_epoch - 1)
637 .expect("checkpoint store read cannot fail")
638 .unwrap_or(highest_executed_checkpoint)
639 };
640
641 let epoch_options = default_db_options().optimize_db_for_write_throughput(4, false);
642 let epoch_store = AuthorityPerEpochStore::new(
643 config.protocol_public_key(),
644 committee.clone(),
645 &config.db_store_path(),
646 Some(epoch_options.options),
647 EpochMetrics::new(®istry_service.default_registry()),
648 epoch_start_configuration,
649 cache_traits.backing_package_store.clone(),
650 cache_traits.object_store.clone(),
651 cache_metrics,
652 signature_verifier_metrics,
653 &config.expensive_safety_check_config,
654 &config,
655 (chain_id, chain),
656 highest_executed_checkpoint,
657 previous_epoch_last_checkpoint,
658 Arc::new(SubmittedTransactionCacheMetrics::new(
659 ®istry_service.default_registry(),
660 )),
661 config.fullnode_sync_mode,
662 )?;
663
664 info!("created epoch store");
665
666 replay_log!(
667 "Beginning replay run. Epoch: {:?}, Protocol config: {:?}",
668 epoch_store.epoch(),
669 epoch_store.protocol_config()
670 );
671
672 if is_genesis {
674 info!("checking SUI conservation at genesis");
675 cache_traits
680 .reconfig_api
681 .expensive_check_sui_conservation(&epoch_store)
682 .expect("SUI conservation check cannot fail at genesis");
683 }
684
685 let effective_buffer_stake = epoch_store.get_effective_buffer_stake_bps();
686 let default_buffer_stake = epoch_store
687 .protocol_config()
688 .buffer_stake_for_protocol_upgrade_bps();
689 if effective_buffer_stake != default_buffer_stake {
690 warn!(
691 ?effective_buffer_stake,
692 ?default_buffer_stake,
693 "buffer_stake_for_protocol_upgrade_bps is currently overridden"
694 );
695 }
696
697 checkpoint_store.insert_genesis_checkpoint(
698 genesis.checkpoint(),
699 genesis.checkpoint_contents().clone(),
700 &epoch_store,
701 );
702
703 info!("creating state sync store");
704 let state_sync_store = RocksDbStore::new(
705 cache_traits.clone(),
706 committee_store.clone(),
707 checkpoint_store.clone(),
708 );
709
710 if node_role.is_fullnode() {
711 remove_legacy_index_stores(&config.db_path());
715 }
716
717 let chain_identifier = epoch_store.get_chain_identifier();
718
719 let mut embedded_rpc_store =
725 if node_role.is_fullnode() && config.rpc().is_some_and(|rpc| rpc.enable_indexing()) {
726 info!("creating embedded rpc-store");
727 let ingestion_source = RocksDbStore::new(
730 cache_traits.clone(),
731 committee_store.clone(),
732 checkpoint_store.clone(),
733 );
734 let embedded_rpc_store = EmbeddedRpcStore::bootstrap(
735 &config,
736 &store,
737 &checkpoint_store,
738 ingestion_source,
739 chain_identifier,
740 &prometheus_registry,
741 )
742 .await?;
743 Some(embedded_rpc_store)
744 } else {
745 None
746 };
747
748 info!("creating archive reader");
749 let (randomness_tx, randomness_rx) = mpsc::channel(
751 config
752 .p2p_config
753 .randomness
754 .clone()
755 .unwrap_or_default()
756 .mailbox_capacity(),
757 );
758 let P2pComponents {
759 p2p_network,
760 known_peers,
761 discovery_handle,
762 state_sync_handle,
763 randomness_handle,
764 endpoint_manager,
765 } = Self::create_p2p_network(
766 &config,
767 state_sync_store.clone(),
768 chain_identifier,
769 randomness_tx,
770 &prometheus_registry,
771 )?;
772
773 for peer in &config.p2p_config.peer_address_overrides {
775 endpoint_manager
776 .update_endpoint(
777 EndpointId::P2p(peer.peer_id),
778 AddressSource::Config,
779 peer.addresses.clone(),
780 )
781 .expect("Updating peer address overrides should not fail");
782 }
783
784 update_peer_addresses(
786 &config,
787 &endpoint_manager,
788 epoch_store.epoch_start_state(),
789 None,
790 );
791
792 info!("start snapshot upload");
793 let state_snapshot_handle = Self::start_state_snapshot(
795 &config,
796 &prometheus_registry,
797 checkpoint_store.clone(),
798 chain_identifier,
799 )?;
800
801 info!("start db checkpoint");
803 let (db_checkpoint_config, db_checkpoint_handle) = Self::start_db_checkpoint(
804 &config,
805 &prometheus_registry,
806 state_snapshot_handle.is_some(),
807 )?;
808
809 if !epoch_store
810 .protocol_config()
811 .simplified_unwrap_then_delete()
812 {
813 config
815 .authority_store_pruning_config
816 .set_killswitch_tombstone_pruning(true);
817 }
818
819 let authority_name = config.protocol_public_key();
820
821 info!("create authority state");
822 let state = AuthorityState::new(
823 authority_name,
824 secret,
825 config.supported_protocol_versions.unwrap(),
826 store.clone(),
827 cache_traits.clone(),
828 epoch_store.clone(),
829 committee_store.clone(),
830 embedded_rpc_store.as_ref().map(|embedded| embedded.store()),
831 checkpoint_store.clone(),
832 &prometheus_registry,
833 &db_checkpoint_config,
834 config.clone(),
835 chain_identifier,
836 config.policy_config.clone(),
837 config.firewall_config.clone(),
838 pruner_watermarks,
839 )
840 .await;
841 if epoch_store.epoch() == 0 {
843 let txn = &genesis.transaction();
844 let span = error_span!("genesis_txn", tx_digest = ?txn.digest());
845 let transaction =
846 sui_types::executable_transaction::VerifiedExecutableTransaction::new_unchecked(
847 sui_types::executable_transaction::ExecutableTransaction::new_from_data_and_sig(
848 genesis.transaction().data().clone(),
849 sui_types::executable_transaction::CertificateProof::Checkpoint(0, 0),
850 ),
851 );
852 let _enter = span.enter();
853 state
854 .try_execute_immediately(&transaction, ExecutionEnv::new(), &epoch_store)
855 .unwrap();
856 }
857
858 let randomness_receiver_handle =
861 RandomnessRoundReceiver::spawn(state.clone(), randomness_rx);
862
863 let (end_of_epoch_channel, end_of_epoch_receiver) =
864 broadcast::channel(config.end_of_epoch_broadcast_channel_capacity);
865
866 let transaction_orchestrator = if node_role.is_fullnode() && run_with_range.is_none() {
867 Some(Arc::new(TransactionOrchestrator::new_with_auth_aggregator(
868 auth_agg.load_full(),
869 state.clone(),
870 end_of_epoch_receiver,
871 &config.db_path(),
872 &prometheus_registry,
873 &config,
874 )))
875 } else {
876 None
877 };
878
879 let (http_servers, subscription_service_checkpoint_sender) = build_http_servers(
880 state.clone(),
881 state_sync_store,
882 &transaction_orchestrator.clone(),
883 &config,
884 &prometheus_registry,
885 server_version,
886 node_role,
887 embedded_rpc_store.as_ref(),
888 )
889 .await?;
890
891 if let Some(embedded) = embedded_rpc_store.as_mut() {
898 embedded.spawn_indexer(
899 subscription_service_checkpoint_sender.clone(),
900 prometheus_registry.clone(),
901 );
902 }
903
904 let global_state_hasher = Arc::new(GlobalStateHasher::new(
905 cache_traits.global_state_hash_store.clone(),
906 GlobalStateHashMetrics::new(&prometheus_registry),
907 ));
908
909 let network_connection_metrics = mysten_network::quinn_metrics::QuinnConnectionMetrics::new(
910 "sui",
911 ®istry_service.default_registry(),
912 );
913
914 let connection_monitor_handle =
915 mysten_network::anemo_connection_monitor::AnemoConnectionMonitor::spawn(
916 p2p_network.downgrade(),
917 Arc::new(network_connection_metrics),
918 known_peers,
919 );
920
921 let sui_node_metrics = Arc::new(SuiNodeMetrics::new(®istry_service.default_registry()));
922
923 sui_node_metrics
924 .binary_max_protocol_version
925 .set(ProtocolVersion::MAX.as_u64() as i64);
926 sui_node_metrics
927 .configured_max_protocol_version
928 .set(config.supported_protocol_versions.unwrap().max.as_u64() as i64);
929
930 let consensus_adapter_metrics = OnceLock::new();
931 let transaction_pool_context = config.consensus_transaction_pool.enabled.then(|| {
932 Arc::new(TransactionPoolContext::new(
933 Arc::new(AdmissionQueueMetrics::new(
934 ®istry_service.default_registry(),
935 )),
936 consensus_adapter_metrics
937 .get_or_init(|| {
938 ConsensusAdapterMetrics::new(®istry_service.default_registry())
939 })
940 .clone(),
941 state.get_cache_writer().clone(),
942 ))
943 });
944 let node_role = epoch_store.node_role();
945 if !node_role.is_validator()
946 && let Some(context) = &transaction_pool_context
947 {
948 context.set_unavailable(epoch_store.epoch());
949 }
950 let validator_components = if node_role.runs_consensus() {
951 let mut components = Self::construct_validator_components(
952 config.clone(),
953 state.clone(),
954 committee,
955 epoch_store.clone(),
956 checkpoint_store.clone(),
957 state_sync_handle.clone(),
958 randomness_handle.clone(),
959 Arc::downgrade(&global_state_hasher),
960 backpressure_manager.clone(),
961 ®istry_service,
962 transaction_pool_context.clone(),
963 &consensus_adapter_metrics,
964 sui_node_metrics.clone(),
965 checkpoint_metrics.clone(),
966 node_role,
967 randomness_receiver_handle.clone(),
968 )
969 .await?;
970
971 if node_role.is_validator() {
972 components
973 .consensus_adapter
974 .recover_end_of_publish(&epoch_store);
975
976 components.validator_server_handle = Some(
978 components
979 .validator_server_handle
980 .take()
981 .unwrap()
982 .start()
983 .await,
984 );
985
986 endpoint_manager
988 .set_consensus_address_updater(components.consensus_manager.clone());
989 } else {
990 info!("Starting node as Observer — connecting to configured peers");
991 }
992
993 Some(components)
994 } else {
995 None
996 };
997
998 let address_prober = if Self::address_prober_enabled(&config) {
999 let handle = address_prober::Builder::new()
1000 .config(config.address_prober.clone().unwrap_or_default())
1001 .with_metrics(&prometheus_registry)
1002 .build()
1003 .start(
1004 p2p_network.clone(),
1005 discovery_handle.sender(),
1006 consensus_config::NetworkKeyPair::new(config.network_key_pair().copy()),
1007 );
1008 if node_role.is_validator()
1010 && let Some(components) = &validator_components
1011 {
1012 handle.update_epoch(
1013 epoch_store.epoch(),
1014 epoch_store.epoch_start_state().get_consensus_committee(),
1015 components.consensus_manager.clone(),
1016 );
1017 }
1018 Some(handle)
1019 } else {
1020 None
1021 };
1022
1023 let (shutdown_channel, _) = broadcast::channel::<Option<RunWithRange>>(1);
1025
1026 let node = Self {
1027 config,
1028 validator_components: Mutex::new(validator_components),
1029 http_servers,
1030 state,
1031 transaction_orchestrator,
1032 registry_service,
1033 metrics: sui_node_metrics,
1034 checkpoint_metrics,
1035
1036 _discovery: discovery_handle,
1037 _connection_monitor_handle: connection_monitor_handle,
1038 state_sync_handle,
1039 randomness_handle,
1040 checkpoint_store,
1041 global_state_hasher: Mutex::new(Some(global_state_hasher)),
1042 end_of_epoch_channel,
1043 endpoint_manager,
1044 backpressure_manager,
1045 address_prober,
1046
1047 _db_checkpoint_handle: db_checkpoint_handle,
1048
1049 #[cfg(msim)]
1050 sim_state: Default::default(),
1051
1052 _state_snapshot_uploader_handle: state_snapshot_handle,
1053 shutdown_channel_tx: shutdown_channel,
1054 randomness_receiver_handle,
1055 transaction_pool_context,
1056 consensus_adapter_metrics,
1057
1058 auth_agg,
1059 subscription_service_checkpoint_sender,
1060 embedded_rpc_store,
1061 };
1062
1063 info!("SuiNode started!");
1064 let node = Arc::new(node);
1065 let node_copy = node.clone();
1066 spawn_monitored_task!(async move {
1067 let result = Self::monitor_reconfiguration(node_copy, epoch_store).await;
1068 if let Err(error) = result {
1069 warn!("Reconfiguration finished with error {:?}", error);
1070 }
1071 });
1072
1073 Ok(node)
1074 }
1075
1076 pub fn subscribe_to_epoch_change(&self) -> broadcast::Receiver<SuiSystemState> {
1077 self.end_of_epoch_channel.subscribe()
1078 }
1079
1080 pub fn subscribe_to_shutdown_channel(&self) -> broadcast::Receiver<Option<RunWithRange>> {
1081 self.shutdown_channel_tx.subscribe()
1082 }
1083
1084 pub fn current_epoch_for_testing(&self) -> EpochId {
1085 self.state.current_epoch_for_testing()
1086 }
1087
1088 pub fn db_checkpoint_path(&self) -> PathBuf {
1089 self.config.db_checkpoint_path()
1090 }
1091
1092 pub async fn close_epoch(&self, epoch_store: &Arc<AuthorityPerEpochStore>) -> SuiResult {
1094 info!("close_epoch (current epoch = {})", epoch_store.epoch());
1095 self.validator_components
1096 .lock()
1097 .await
1098 .as_ref()
1099 .ok_or_else(|| SuiError::from("Node is not a validator"))?
1100 .consensus_adapter
1101 .close_epoch(epoch_store);
1102 Ok(())
1103 }
1104
1105 pub fn clear_override_protocol_upgrade_buffer_stake(&self, epoch: EpochId) -> SuiResult {
1106 self.state
1107 .clear_override_protocol_upgrade_buffer_stake(epoch)
1108 }
1109
1110 pub fn set_override_protocol_upgrade_buffer_stake(
1111 &self,
1112 epoch: EpochId,
1113 buffer_stake_bps: u64,
1114 ) -> SuiResult {
1115 self.state
1116 .set_override_protocol_upgrade_buffer_stake(epoch, buffer_stake_bps)
1117 }
1118
1119 pub async fn close_epoch_for_testing(&self) -> SuiResult {
1122 let epoch_store = self.state.epoch_store_for_testing();
1123 self.close_epoch(&epoch_store).await
1124 }
1125
1126 fn start_state_snapshot(
1127 config: &NodeConfig,
1128 prometheus_registry: &Registry,
1129 checkpoint_store: Arc<CheckpointStore>,
1130 chain_identifier: ChainIdentifier,
1131 ) -> Result<Option<tokio::sync::broadcast::Sender<()>>> {
1132 if let Some(remote_store_config) = &config.state_snapshot_write_config.object_store_config {
1133 let snapshot_uploader = StateSnapshotUploader::new(
1134 &config.db_checkpoint_path(),
1135 &config.snapshot_path(),
1136 remote_store_config.clone(),
1137 60,
1138 prometheus_registry,
1139 checkpoint_store,
1140 chain_identifier,
1141 config.state_snapshot_write_config.archive_interval_epochs,
1142 )?;
1143 Ok(Some(snapshot_uploader.start()))
1144 } else {
1145 Ok(None)
1146 }
1147 }
1148
1149 fn start_db_checkpoint(
1150 config: &NodeConfig,
1151 prometheus_registry: &Registry,
1152 state_snapshot_enabled: bool,
1153 ) -> Result<(
1154 DBCheckpointConfig,
1155 Option<tokio::sync::broadcast::Sender<()>>,
1156 )> {
1157 let checkpoint_path = Some(
1158 config
1159 .db_checkpoint_config
1160 .checkpoint_path
1161 .clone()
1162 .unwrap_or_else(|| config.db_checkpoint_path()),
1163 );
1164 let db_checkpoint_config = if config.db_checkpoint_config.checkpoint_path.is_none() {
1165 DBCheckpointConfig {
1166 checkpoint_path,
1167 perform_db_checkpoints_at_epoch_end: if state_snapshot_enabled {
1168 true
1169 } else {
1170 config
1171 .db_checkpoint_config
1172 .perform_db_checkpoints_at_epoch_end
1173 },
1174 ..config.db_checkpoint_config.clone()
1175 }
1176 } else {
1177 config.db_checkpoint_config.clone()
1178 };
1179
1180 match (
1181 db_checkpoint_config.object_store_config.as_ref(),
1182 state_snapshot_enabled,
1183 ) {
1184 (None, false) => Ok((db_checkpoint_config, None)),
1189 (_, _) => {
1190 let handler = DBCheckpointHandler::new(
1191 &db_checkpoint_config.checkpoint_path.clone().unwrap(),
1192 db_checkpoint_config.object_store_config.as_ref(),
1193 60,
1194 db_checkpoint_config
1195 .prune_and_compact_before_upload
1196 .unwrap_or(true),
1197 config.authority_store_pruning_config.clone(),
1198 prometheus_registry,
1199 state_snapshot_enabled,
1200 )?;
1201 Ok((
1202 db_checkpoint_config,
1203 Some(DBCheckpointHandler::start(handler)),
1204 ))
1205 }
1206 }
1207 }
1208
1209 fn create_p2p_network(
1210 config: &NodeConfig,
1211 state_sync_store: RocksDbStore,
1212 chain_identifier: ChainIdentifier,
1213 randomness_tx: mpsc::Sender<(EpochId, RandomnessRound, Vec<u8>)>,
1214 prometheus_registry: &Registry,
1215 ) -> Result<P2pComponents> {
1216 let mut p2p_config = config.p2p_config.clone();
1217 {
1218 let disc = p2p_config.discovery.get_or_insert_with(Default::default);
1219 if disc.peer_addr_store_path.is_none() {
1220 disc.peer_addr_store_path =
1221 Some(config.db_path().join("discovery_peer_cache.yaml"));
1222 }
1223 }
1224 let mut discovery_builder = discovery::Builder::new().config(p2p_config.clone());
1225 if let Some(consensus_config) = &config.consensus_config {
1226 let effective_addr = consensus_config
1227 .external_address
1228 .as_ref()
1229 .or(consensus_config.listen_address.as_ref());
1230 if let Some(addr) = effective_addr {
1231 discovery_builder = discovery_builder.consensus_external_address(addr.clone());
1232 }
1233 }
1234 let (discovery, discovery_server, endpoint_manager) = discovery_builder.build();
1235 let discovery_sender = discovery.sender();
1236
1237 let (state_sync, state_sync_router) = state_sync::Builder::new()
1238 .config(config.p2p_config.state_sync.clone().unwrap_or_default())
1239 .store(state_sync_store)
1240 .archive_config(config.archive_reader_config())
1241 .discovery_sender(discovery_sender)
1242 .with_metrics(prometheus_registry)
1243 .build();
1244
1245 let discovery_config = config.p2p_config.discovery.clone().unwrap_or_default();
1246 let known_peers: HashMap<PeerId, String> = discovery_config
1247 .allowlisted_peers
1248 .clone()
1249 .into_iter()
1250 .map(|ap| (ap.peer_id, "allowlisted_peer".to_string()))
1251 .chain(config.p2p_config.seed_peers.iter().filter_map(|peer| {
1252 peer.peer_id
1253 .map(|peer_id| (peer_id, "seed_peer".to_string()))
1254 }))
1255 .collect();
1256
1257 let (randomness, randomness_router) =
1258 randomness::Builder::new(config.protocol_public_key(), randomness_tx)
1259 .config(config.p2p_config.randomness.clone().unwrap_or_default())
1260 .with_metrics(prometheus_registry)
1261 .build();
1262
1263 let p2p_network = {
1264 let routes = anemo::Router::new()
1265 .add_rpc_service(discovery_server)
1266 .merge(state_sync_router);
1267 let routes = routes.merge(randomness_router);
1268
1269 let inbound_network_metrics =
1270 mysten_network::metrics::NetworkMetrics::new("sui", "inbound", prometheus_registry);
1271 let outbound_network_metrics = mysten_network::metrics::NetworkMetrics::new(
1272 "sui",
1273 "outbound",
1274 prometheus_registry,
1275 );
1276
1277 let service = ServiceBuilder::new()
1278 .layer(
1279 TraceLayer::new_for_server_errors()
1280 .make_span_with(DefaultMakeSpan::new().level(tracing::Level::INFO))
1281 .on_failure(DefaultOnFailure::new().level(tracing::Level::WARN)),
1282 )
1283 .layer(CallbackLayer::new(
1284 mysten_network::metrics::MetricsMakeCallbackHandler::new(
1285 Arc::new(inbound_network_metrics),
1286 config.p2p_config.excessive_message_size(),
1287 ),
1288 ))
1289 .service(routes);
1290
1291 let outbound_layer = ServiceBuilder::new()
1292 .layer(
1293 TraceLayer::new_for_client_and_server_errors()
1294 .make_span_with(DefaultMakeSpan::new().level(tracing::Level::INFO))
1295 .on_failure(DefaultOnFailure::new().level(tracing::Level::WARN)),
1296 )
1297 .layer(CallbackLayer::new(
1298 mysten_network::metrics::MetricsMakeCallbackHandler::new(
1299 Arc::new(outbound_network_metrics),
1300 config.p2p_config.excessive_message_size(),
1301 ),
1302 ))
1303 .into_inner();
1304
1305 let mut anemo_config = config.p2p_config.anemo_config.clone().unwrap_or_default();
1306 anemo_config.max_request_frame_size = Some(1 << 20);
1309 anemo_config.max_response_frame_size = Some(128 << 20);
1312
1313 let mut quic_config = anemo_config.quic.unwrap_or_default();
1316 if quic_config.socket_send_buffer_size.is_none() {
1317 quic_config.socket_send_buffer_size = Some(20 << 20);
1318 }
1319 if quic_config.socket_receive_buffer_size.is_none() {
1320 quic_config.socket_receive_buffer_size = Some(20 << 20);
1321 }
1322 quic_config.allow_failed_socket_buffer_size_setting = true;
1323
1324 if quic_config.max_concurrent_bidi_streams.is_none() {
1327 quic_config.max_concurrent_bidi_streams = Some(500);
1328 }
1329 if quic_config.max_concurrent_uni_streams.is_none() {
1330 quic_config.max_concurrent_uni_streams = Some(500);
1331 }
1332 if quic_config.stream_receive_window.is_none() {
1333 quic_config.stream_receive_window = Some(100 << 20);
1334 }
1335 if quic_config.receive_window.is_none() {
1336 quic_config.receive_window = Some(200 << 20);
1337 }
1338 if quic_config.send_window.is_none() {
1339 quic_config.send_window = Some(200 << 20);
1340 }
1341 if quic_config.crypto_buffer_size.is_none() {
1342 quic_config.crypto_buffer_size = Some(1 << 20);
1343 }
1344 if quic_config.max_idle_timeout_ms.is_none() {
1345 quic_config.max_idle_timeout_ms = Some(10_000);
1346 }
1347 if quic_config.keep_alive_interval_ms.is_none() {
1348 quic_config.keep_alive_interval_ms = Some(5_000);
1349 }
1350 anemo_config.quic = Some(quic_config);
1351
1352 let server_name = format!("sui-{}", chain_identifier);
1353 let network = Network::bind(config.p2p_config.listen_address)
1354 .server_name(&server_name)
1355 .private_key(config.network_key_pair().copy().private().0.to_bytes())
1356 .config(anemo_config)
1357 .outbound_request_layer(outbound_layer)
1358 .start(service)?;
1359 info!(
1360 server_name = server_name,
1361 "P2p network started on {}",
1362 network.local_addr()
1363 );
1364
1365 network
1366 };
1367
1368 let discovery_handle =
1369 discovery.start(p2p_network.clone(), config.network_key_pair().copy());
1370 let state_sync_handle = state_sync.start(p2p_network.clone());
1371 let randomness_handle = randomness.start(p2p_network.clone());
1372
1373 Ok(P2pComponents {
1374 p2p_network,
1375 known_peers,
1376 discovery_handle,
1377 state_sync_handle,
1378 randomness_handle,
1379 endpoint_manager,
1380 })
1381 }
1382
1383 async fn construct_validator_components(
1384 config: NodeConfig,
1385 state: Arc<AuthorityState>,
1386 committee: Arc<Committee>,
1387 epoch_store: Arc<AuthorityPerEpochStore>,
1388 checkpoint_store: Arc<CheckpointStore>,
1389 state_sync_handle: state_sync::Handle,
1390 randomness_handle: randomness::Handle,
1391 global_state_hasher: Weak<GlobalStateHasher>,
1392 backpressure_manager: Arc<BackpressureManager>,
1393 registry_service: &RegistryService,
1394 transaction_pool_context: Option<Arc<TransactionPoolContext>>,
1395 consensus_adapter_metrics: &OnceLock<ConsensusAdapterMetrics>,
1396 sui_node_metrics: Arc<SuiNodeMetrics>,
1397 checkpoint_metrics: Arc<CheckpointMetrics>,
1398 node_role: NodeRole,
1399 randomness_receiver_handle: Arc<RandomnessRoundReceiverHandle>,
1400 ) -> Result<ValidatorComponents> {
1401 let mut config_clone = config.clone();
1402 let consensus_config = config_clone
1403 .consensus_config
1404 .as_mut()
1405 .ok_or_else(|| anyhow!("Node is missing consensus config"))?;
1406
1407 let client = Arc::new(UpdatableConsensusClient::new());
1408 let inflight_slot_freed_notify = Arc::new(tokio::sync::Notify::new());
1409 let consensus_adapter = Arc::new(Self::construct_consensus_adapter(
1410 &committee,
1411 consensus_config,
1412 state.name,
1413 consensus_adapter_metrics
1414 .get_or_init(|| ConsensusAdapterMetrics::new(®istry_service.default_registry()))
1415 .clone(),
1416 client.clone(),
1417 checkpoint_store.clone(),
1418 inflight_slot_freed_notify.clone(),
1419 ));
1420
1421 let consensus_manager = Arc::new(ConsensusManager::new(
1422 &config,
1423 consensus_config,
1424 registry_service,
1425 client,
1426 transaction_pool_context.clone(),
1427 node_role,
1428 ));
1429
1430 let consensus_store_pruner = ConsensusStorePruner::new(
1432 consensus_manager.get_storage_base_path(),
1433 consensus_config.db_retention_epochs(),
1434 consensus_config.db_pruner_period(),
1435 ®istry_service.default_registry(),
1436 );
1437
1438 let sui_tx_validator_metrics =
1439 SuiTxValidatorMetrics::new(®istry_service.default_registry());
1440
1441 let (validator_server_handle, admission_queue) = if node_role.is_validator() {
1442 let (handle, queue) = Self::start_grpc_validator_service(
1443 &config,
1444 state.clone(),
1445 consensus_adapter.clone(),
1446 epoch_store.clone(),
1447 ®istry_service.default_registry(),
1448 inflight_slot_freed_notify,
1449 transaction_pool_context.clone(),
1450 )
1451 .await?;
1452 (Some(handle), queue)
1453 } else {
1454 (None, None)
1455 };
1456
1457 let validator_overload_monitor_handle = if node_role.is_validator()
1460 && config
1461 .authority_overload_config
1462 .max_load_shedding_percentage
1463 > 0
1464 {
1465 let authority_state = Arc::downgrade(&state);
1466 let overload_config = config.authority_overload_config.clone();
1467 fail_point!("starting_overload_monitor");
1468 Some(spawn_monitored_task!(overload_monitor(
1469 authority_state,
1470 overload_config,
1471 )))
1472 } else {
1473 None
1474 };
1475
1476 Self::start_epoch_specific_validator_components(
1477 &config,
1478 state.clone(),
1479 consensus_adapter,
1480 checkpoint_store,
1481 epoch_store,
1482 state_sync_handle,
1483 randomness_handle,
1484 randomness_receiver_handle,
1485 consensus_manager,
1486 consensus_store_pruner,
1487 global_state_hasher,
1488 backpressure_manager,
1489 validator_server_handle,
1490 validator_overload_monitor_handle,
1491 checkpoint_metrics,
1492 sui_node_metrics,
1493 sui_tx_validator_metrics,
1494 admission_queue,
1495 transaction_pool_context,
1496 node_role,
1497 )
1498 .await
1499 }
1500
1501 fn address_prober_enabled(config: &NodeConfig) -> bool {
1502 let prober_enabled = config
1503 .address_prober
1504 .as_ref()
1505 .map(|c| c.enabled())
1506 .unwrap_or(true);
1507 let v3_enabled = config
1508 .p2p_config
1509 .discovery
1510 .as_ref()
1511 .is_some_and(|d| d.use_get_known_peers_v3());
1512 prober_enabled && v3_enabled
1513 }
1514
1515 fn update_address_prober_epoch(
1516 &self,
1517 epoch_store: &AuthorityPerEpochStore,
1518 consensus_manager: &Arc<ConsensusManager>,
1519 ) {
1520 if !epoch_store.is_validator() {
1521 return;
1522 }
1523 if let Some(handle) = &self.address_prober {
1524 handle.update_epoch(
1525 epoch_store.epoch(),
1526 epoch_store.epoch_start_state().get_consensus_committee(),
1527 consensus_manager.clone(),
1528 );
1529 }
1530 }
1531
1532 async fn start_epoch_specific_validator_components(
1533 config: &NodeConfig,
1534 state: Arc<AuthorityState>,
1535 consensus_adapter: Arc<ConsensusAdapter>,
1536 checkpoint_store: Arc<CheckpointStore>,
1537 epoch_store: Arc<AuthorityPerEpochStore>,
1538 state_sync_handle: state_sync::Handle,
1539 randomness_handle: randomness::Handle,
1540 randomness_receiver_handle: Arc<RandomnessRoundReceiverHandle>,
1541 consensus_manager: Arc<ConsensusManager>,
1542 consensus_store_pruner: ConsensusStorePruner,
1543 state_hasher: Weak<GlobalStateHasher>,
1544 backpressure_manager: Arc<BackpressureManager>,
1545 validator_server_handle: Option<ValidatorGrpcServer>,
1546 validator_overload_monitor_handle: Option<JoinHandle<()>>,
1547 checkpoint_metrics: Arc<CheckpointMetrics>,
1548 sui_node_metrics: Arc<SuiNodeMetrics>,
1549 sui_tx_validator_metrics: Arc<SuiTxValidatorMetrics>,
1550 admission_queue: Option<AdmissionQueueContext>,
1551 transaction_pool_context: Option<Arc<TransactionPoolContext>>,
1552 node_role: NodeRole,
1553 ) -> Result<ValidatorComponents> {
1554 let checkpoint_service = Self::build_checkpoint_service(
1555 config,
1556 consensus_adapter.clone(),
1557 checkpoint_store.clone(),
1558 epoch_store.clone(),
1559 state.clone(),
1560 state_sync_handle,
1561 state_hasher,
1562 checkpoint_metrics.clone(),
1563 node_role,
1564 );
1565
1566 randomness_receiver_handle.clear_public_key();
1569
1570 if node_role.runs_consensus() && epoch_store.randomness_state_enabled() {
1571 let authority_key_pair = if node_role.is_validator() {
1572 Some(config.protocol_key_pair())
1573 } else {
1574 None
1575 };
1576 let randomness_manager = RandomnessManager::try_new(
1577 Arc::downgrade(&epoch_store),
1578 Box::new(consensus_adapter.clone()),
1579 randomness_handle,
1580 authority_key_pair,
1581 randomness_receiver_handle.clone(),
1582 )
1583 .await;
1584 if let Some(randomness_manager) = randomness_manager {
1585 epoch_store
1586 .set_randomness_manager(randomness_manager)
1587 .await?;
1588 }
1589 }
1590
1591 if node_role.is_validator() {
1592 ExecutionTimeObserver::spawn(
1593 epoch_store.clone(),
1594 Box::new(consensus_adapter.clone()),
1595 config
1596 .execution_time_observer_config
1597 .clone()
1598 .unwrap_or_default(),
1599 );
1600 }
1601
1602 let throughput_calculator = Arc::new(ConsensusThroughputCalculator::new(
1603 None,
1604 state.metrics.clone(),
1605 ));
1606
1607 let consensus_handler_initializer = ConsensusHandlerInitializer::new(
1608 state.clone(),
1609 checkpoint_service.clone(),
1610 epoch_store.clone(),
1611 throughput_calculator,
1612 backpressure_manager,
1613 config.congestion_log.clone(),
1614 );
1615
1616 info!("Starting consensus manager asynchronously");
1617
1618 let replay_waiter = consensus_manager.replay_waiter();
1621
1622 tokio::spawn({
1624 let config = config.clone();
1625 let epoch_store = epoch_store.clone();
1626 let sui_tx_validator = SuiTxValidator::new(
1627 state.clone(),
1628 epoch_store.clone(),
1629 checkpoint_service.clone(),
1630 sui_tx_validator_metrics.clone(),
1631 );
1632 let consensus_manager = consensus_manager.clone();
1633 async move {
1634 consensus_manager
1635 .start(
1636 &config,
1637 epoch_store,
1638 consensus_handler_initializer,
1639 sui_tx_validator,
1640 Some(randomness_receiver_handle),
1641 )
1642 .await;
1643 }
1644 });
1645 info!("Spawning checkpoint service");
1646 let replay_waiter = if std::env::var("DISABLE_REPLAY_WAITER").is_ok() {
1647 None
1648 } else {
1649 Some(replay_waiter)
1650 };
1651 checkpoint_service
1652 .spawn(epoch_store.clone(), replay_waiter)
1653 .await;
1654
1655 if node_role.is_validator() && epoch_store.authenticator_state_enabled() {
1656 Self::start_jwk_updater(
1657 config,
1658 sui_node_metrics,
1659 state.name,
1660 epoch_store.clone(),
1661 consensus_adapter.clone(),
1662 );
1663 }
1664
1665 if let Some(ctx) = &admission_queue {
1666 ctx.rotate_for_epoch(epoch_store);
1667 }
1668
1669 Ok(ValidatorComponents {
1670 validator_server_handle,
1671 validator_overload_monitor_handle,
1672 consensus_manager,
1673 consensus_store_pruner,
1674 consensus_adapter,
1675 checkpoint_metrics,
1676 sui_tx_validator_metrics,
1677 admission_queue,
1678 transaction_pool_context,
1679 })
1680 }
1681
1682 fn build_checkpoint_service(
1683 config: &NodeConfig,
1684 consensus_adapter: Arc<ConsensusAdapter>,
1685 checkpoint_store: Arc<CheckpointStore>,
1686 epoch_store: Arc<AuthorityPerEpochStore>,
1687 state: Arc<AuthorityState>,
1688 state_sync_handle: state_sync::Handle,
1689 state_hasher: Weak<GlobalStateHasher>,
1690 checkpoint_metrics: Arc<CheckpointMetrics>,
1691 node_role: NodeRole,
1692 ) -> Arc<CheckpointService> {
1693 let checkpoint_output: Box<dyn CheckpointOutput> = if node_role.is_validator() {
1694 Box::new(SubmitCheckpointToConsensus::new(
1695 consensus_adapter,
1696 state.secret.clone(),
1697 config.protocol_public_key(),
1698 checkpoint_metrics.clone(),
1699 ))
1700 } else {
1701 Box::new(LogCheckpointOutput::new(checkpoint_metrics.clone()))
1702 };
1703
1704 let certified_checkpoint_output = SendCheckpointToStateSync::new(state_sync_handle);
1705
1706 CheckpointService::build(
1707 state.clone(),
1708 checkpoint_store,
1709 epoch_store,
1710 state.get_transaction_cache_reader().clone(),
1711 state_hasher,
1712 checkpoint_output,
1713 Box::new(certified_checkpoint_output),
1714 checkpoint_metrics,
1715 )
1716 }
1717
1718 fn construct_consensus_adapter(
1719 committee: &Committee,
1720 consensus_config: &ConsensusConfig,
1721 authority: AuthorityName,
1722 ca_metrics: ConsensusAdapterMetrics,
1723 consensus_client: Arc<dyn ConsensusClient>,
1724 checkpoint_store: Arc<CheckpointStore>,
1725 inflight_slot_freed_notify: Arc<tokio::sync::Notify>,
1726 ) -> ConsensusAdapter {
1727 ConsensusAdapter::new(
1729 consensus_client,
1730 checkpoint_store,
1731 authority,
1732 consensus_config.max_pending_transactions(),
1733 consensus_config.max_pending_transactions() * 2 / committee.num_members(),
1734 ca_metrics,
1735 inflight_slot_freed_notify,
1736 )
1737 }
1738
1739 async fn start_grpc_validator_service(
1740 config: &NodeConfig,
1741 state: Arc<AuthorityState>,
1742 consensus_adapter: Arc<ConsensusAdapter>,
1743 epoch_store: Arc<AuthorityPerEpochStore>,
1744 prometheus_registry: &Registry,
1745 inflight_slot_freed_notify: Arc<tokio::sync::Notify>,
1746 transaction_pool_context: Option<Arc<TransactionPoolContext>>,
1747 ) -> Result<(ValidatorGrpcServer, Option<AdmissionQueueContext>)> {
1748 let overload_config = &config.authority_overload_config;
1749 let admission_queue =
1750 if transaction_pool_context.is_none() && overload_config.admission_queue_enabled {
1751 let manager = Arc::new(AdmissionQueueManager::new(
1752 consensus_adapter.clone(),
1753 Arc::new(AdmissionQueueMetrics::new(prometheus_registry)),
1754 overload_config.admission_queue_capacity_fraction,
1755 overload_config.admission_queue_failover_timeout,
1756 inflight_slot_freed_notify,
1757 ));
1758 Some(AdmissionQueueContext::spawn(manager, epoch_store))
1759 } else {
1760 None
1761 };
1762 let user_submission_path = if let Some(context) = transaction_pool_context {
1763 UserSubmissionPath::Pool(context)
1764 } else if let Some(context) = admission_queue.clone() {
1765 UserSubmissionPath::AdmissionQueue(context)
1766 } else {
1767 UserSubmissionPath::Direct
1768 };
1769 let validator_service = ValidatorService::new(
1770 state.clone(),
1771 consensus_adapter,
1772 Arc::new(ValidatorServiceMetrics::new(prometheus_registry)),
1773 config.policy_config.clone().map(|p| p.client_id_source),
1774 user_submission_path,
1775 );
1776
1777 let mut server_conf = mysten_network::config::Config::new();
1778 server_conf.connect_timeout = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1779 server_conf.http2_keepalive_interval = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1780 server_conf.http2_keepalive_timeout = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1781 server_conf.global_concurrency_limit = config.grpc_concurrency_limit;
1782 server_conf.load_shed = config.grpc_load_shed;
1783 let mut server_builder =
1784 ServerBuilder::from_config(&server_conf, GrpcMetrics::new(prometheus_registry));
1785
1786 server_builder = server_builder.add_service(ValidatorServer::new(validator_service));
1787
1788 let tls_config = sui_tls::create_rustls_server_config(
1789 config.network_key_pair().copy().private(),
1790 SUI_TLS_SERVER_NAME.to_string(),
1791 );
1792
1793 let network_address = config.network_address().clone();
1794
1795 let server = ValidatorGrpcServer::new(async move {
1796 let server = server_builder
1797 .bind(&network_address, Some(tls_config))
1798 .await
1799 .unwrap_or_else(|err| panic!("Failed to bind to {network_address}: {err}"));
1800 info!("Listening to traffic on {}", server.local_addr());
1801 server.into_handle()
1802 });
1803 Ok((server, admission_queue))
1804 }
1805
1806 pub fn state(&self) -> Arc<AuthorityState> {
1807 self.state.clone()
1808 }
1809
1810 pub fn embedded_rpc_store(&self) -> Option<&EmbeddedRpcStore> {
1816 self.embedded_rpc_store.as_ref()
1817 }
1818
1819 #[cfg(any(test, msim))]
1820 pub fn connection_monitor_handle_for_testing(
1821 &self,
1822 ) -> &mysten_network::anemo_connection_monitor::ConnectionMonitorHandle {
1823 &self._connection_monitor_handle
1824 }
1825
1826 #[cfg(any(test, msim))]
1827 pub fn address_prober_metrics_for_testing(
1828 &self,
1829 ) -> std::sync::Arc<address_prober::AddressProberMetrics> {
1830 self.address_prober
1831 .as_ref()
1832 .expect("address prober should be running in tests")
1833 .metrics_for_testing()
1834 }
1835
1836 #[cfg(feature = "testing")]
1837 pub fn prometheus_metrics_for_testing(&self) -> Vec<prometheus::proto::MetricFamily> {
1838 self.registry_service.default_registry().gather()
1839 }
1840
1841 pub fn node_role(&self) -> NodeRole {
1842 self.state.load_epoch_store_one_call_per_task().node_role()
1843 }
1844
1845 pub async fn consensus_adapter(&self) -> Option<Arc<ConsensusAdapter>> {
1850 self.validator_components
1851 .lock()
1852 .await
1853 .as_ref()
1854 .map(|c| c.consensus_adapter.clone())
1855 }
1856
1857 pub fn reference_gas_price_for_testing(&self) -> Result<u64, anyhow::Error> {
1859 self.state.reference_gas_price_for_testing()
1860 }
1861
1862 pub fn clone_committee_store(&self) -> Arc<CommitteeStore> {
1863 self.state.committee_store().clone()
1864 }
1865
1866 pub fn clone_checkpoint_store(&self) -> Arc<CheckpointStore> {
1867 self.checkpoint_store.clone()
1868 }
1869
1870 pub fn clone_authority_store(&self) -> Arc<AuthorityStore> {
1871 self.state.authority_store()
1872 }
1873
1874 pub fn clone_consensus_store(
1875 &self,
1876 ) -> Option<Arc<consensus_core::storage::rocksdb_store::RocksDBStore>> {
1877 self.validator_components
1878 .try_lock()
1879 .ok()?
1880 .as_ref()?
1881 .consensus_manager
1882 .consensus_store()
1883 }
1884
1885 pub fn clone_authority_aggregator(
1890 &self,
1891 ) -> Option<Arc<AuthorityAggregator<NetworkAuthorityClient>>> {
1892 self.transaction_orchestrator
1893 .as_ref()
1894 .map(|to| to.clone_authority_aggregator())
1895 }
1896
1897 pub fn transaction_orchestrator(
1898 &self,
1899 ) -> Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>> {
1900 self.transaction_orchestrator.clone()
1901 }
1902
1903 pub async fn monitor_reconfiguration(
1906 self: Arc<Self>,
1907 mut epoch_store: Arc<AuthorityPerEpochStore>,
1908 ) -> Result<()> {
1909 let checkpoint_executor_metrics =
1910 CheckpointExecutorMetrics::new(&self.registry_service.default_registry());
1911
1912 let mut broadcast_on_startup: Option<bool> =
1916 Some(self.config.peer_deny_sync_config.broadcast_on_startup);
1917
1918 loop {
1919 let mut hasher_guard = self.global_state_hasher.lock().await;
1920 let hasher = hasher_guard.take().unwrap();
1921 info!(
1922 "Creating checkpoint executor for epoch {}",
1923 epoch_store.epoch()
1924 );
1925 let checkpoint_executor = CheckpointExecutor::new(
1926 epoch_store.clone(),
1927 self.checkpoint_store.clone(),
1928 self.state.clone(),
1929 hasher.clone(),
1930 self.backpressure_manager.clone(),
1931 self.config.checkpoint_executor_config.clone(),
1932 checkpoint_executor_metrics.clone(),
1933 self.subscription_service_checkpoint_sender.clone(),
1934 );
1935
1936 let run_with_range = self.config.run_with_range;
1937
1938 let cur_epoch_store = self.state.load_epoch_store_one_call_per_task();
1939
1940 self.metrics
1942 .current_protocol_version
1943 .set(cur_epoch_store.protocol_config().version.as_u64() as i64);
1944
1945 if let Some(components) = &*self.validator_components.lock().await
1948 && cur_epoch_store.is_validator()
1949 {
1950 tokio::time::sleep(Duration::from_millis(1)).await;
1952
1953 let config = cur_epoch_store.protocol_config();
1954 let mut supported_protocol_versions = self
1955 .config
1956 .supported_protocol_versions
1957 .expect("Supported versions should be populated")
1958 .truncate_below(config.version);
1960
1961 while supported_protocol_versions.max > config.version {
1962 let proposed_protocol_config = ProtocolConfig::get_for_version(
1963 supported_protocol_versions.max,
1964 cur_epoch_store.get_chain(),
1965 );
1966
1967 if proposed_protocol_config.enable_accumulators()
1968 && !epoch_store.accumulator_root_exists()
1969 {
1970 error!(
1971 "cannot upgrade to protocol version {:?} because accumulator root does not exist",
1972 supported_protocol_versions.max
1973 );
1974 supported_protocol_versions.max = supported_protocol_versions.max.prev();
1975 } else {
1976 break;
1977 }
1978 }
1979
1980 let binary_config = config.binary_config(None);
1981 let transaction = ConsensusTransaction::new_capability_notification_v2(
1982 AuthorityCapabilitiesV2::new(
1983 self.state.name,
1984 cur_epoch_store.get_chain_identifier().chain(),
1985 supported_protocol_versions,
1986 self.state
1987 .get_available_system_packages(&binary_config)
1988 .await,
1989 ),
1990 );
1991 info!(?transaction, "submitting capabilities to consensus");
1992 components.consensus_adapter.submit(
1993 transaction,
1994 None,
1995 &cur_epoch_store,
1996 None,
1997 None,
1998 )?;
1999
2000 if cur_epoch_store
2003 .protocol_config()
2004 .share_transaction_deny_config_in_consensus()
2005 {
2006 let sync_cfg = &self.config.peer_deny_sync_config;
2007 let is_startup = broadcast_on_startup.is_some();
2008 let should_broadcast = broadcast_on_startup
2009 .take()
2010 .unwrap_or(sync_cfg.broadcast_on_epoch_change);
2011 let manager = self.state.transaction_deny_config_manager();
2012 let publish = |rules: Option<TransactionDenyRules>| {
2013 if let Err(e) = manager.submit_broadcast(
2014 rules,
2015 &components.consensus_adapter,
2016 &cur_epoch_store,
2017 ) {
2018 warn!("Failed to broadcast transaction deny config: {e:?}");
2019 }
2020 };
2021 let action = deny_config_broadcast_payload(
2022 manager.local().rules(),
2023 should_broadcast,
2024 is_startup,
2025 manager.may_have_outstanding_broadcast(),
2026 );
2027 match action {
2028 DenyConfigBroadcastAction::Skip => {}
2029 DenyConfigBroadcastAction::Broadcast(rules) => publish(Some(rules)),
2030 DenyConfigBroadcastAction::Withdraw => publish(None),
2031 }
2032 }
2033 }
2034
2035 let stop_condition = checkpoint_executor.run_epoch(run_with_range).await;
2036
2037 if stop_condition == StopReason::RuntimeShutdown {
2038 return Ok(());
2039 }
2040
2041 if stop_condition == StopReason::RunWithRangeCondition {
2042 SuiNode::shutdown(&self).await;
2043 self.shutdown_channel_tx
2044 .send(run_with_range)
2045 .expect("RunWithRangeCondition met but failed to send shutdown message");
2046 return Ok(());
2047 }
2048
2049 let latest_system_state = self
2051 .state
2052 .get_object_cache_reader()
2053 .get_sui_system_state_object_unsafe()
2054 .expect("Read Sui System State object cannot fail");
2055
2056 #[cfg(msim)]
2057 if !self
2058 .sim_state
2059 .sim_safe_mode_expected
2060 .load(Ordering::Relaxed)
2061 {
2062 debug_assert!(!latest_system_state.safe_mode());
2063 }
2064
2065 #[cfg(not(msim))]
2066 debug_assert!(!latest_system_state.safe_mode());
2067
2068 if let Err(err) = self.end_of_epoch_channel.send(latest_system_state.clone())
2069 && self.state.is_fullnode(&cur_epoch_store)
2070 {
2071 warn!(
2072 "Failed to send end of epoch notification to subscriber: {:?}",
2073 err
2074 );
2075 }
2076
2077 cur_epoch_store.record_is_safe_mode_metric(latest_system_state.safe_mode());
2078 let new_epoch_start_state = latest_system_state.into_epoch_start_state();
2079
2080 self.auth_agg.store(Arc::new(
2081 self.auth_agg
2082 .load()
2083 .recreate_with_new_epoch_start_state(&new_epoch_start_state),
2084 ));
2085
2086 let next_epoch_committee = new_epoch_start_state.get_sui_committee();
2087 let next_epoch = next_epoch_committee.epoch();
2088 assert_eq!(cur_epoch_store.epoch() + 1, next_epoch);
2089
2090 info!(
2091 next_epoch,
2092 "Finished executing all checkpoints in epoch. About to reconfigure the system."
2093 );
2094
2095 fail_point_async!("reconfig_delay");
2096
2097 cur_epoch_store.record_epoch_reconfig_start_time_metric();
2098
2099 update_peer_addresses(
2100 &self.config,
2101 &self.endpoint_manager,
2102 &new_epoch_start_state,
2103 Some(cur_epoch_store.epoch_start_state()),
2104 );
2105
2106 let mut validator_components_lock_guard = self.validator_components.lock().await;
2107
2108 let new_epoch_store = self
2112 .reconfigure_state(
2113 &self.state,
2114 &cur_epoch_store,
2115 next_epoch_committee.clone(),
2116 new_epoch_start_state,
2117 hasher.clone(),
2118 )
2119 .await;
2120
2121 let new_role = new_epoch_store.node_role();
2122 if !new_role.is_validator()
2123 && let Some(context) = &self.transaction_pool_context
2124 {
2125 context.set_unavailable(next_epoch);
2126 }
2127
2128 let new_validator_components = if let Some(ValidatorComponents {
2129 validator_server_handle,
2130 validator_overload_monitor_handle,
2131 consensus_manager,
2132 consensus_store_pruner,
2133 consensus_adapter,
2134 checkpoint_metrics,
2135 sui_tx_validator_metrics,
2136 admission_queue,
2137 transaction_pool_context,
2138 }) = validator_components_lock_guard.take()
2139 {
2140 info!("Reconfiguring node (was running consensus).");
2141
2142 fail_point_async!("consensus_transaction_pool_reconfig_before_shutdown");
2143 consensus_manager.shutdown().await;
2144 info!("Consensus has shut down.");
2145
2146 let validator_server_handle = match validator_server_handle {
2150 Some(server) if !new_role.is_validator() => {
2151 info!("Node is no longer a validator, shutting down validator gRPC server");
2152 server.shutdown().await;
2153 None
2154 }
2155 other => other,
2156 };
2157
2158 if let Some(handle) = &self.address_prober {
2159 handle.leave_committee();
2160 }
2161
2162 info!("Epoch store finished reconfiguration.");
2163
2164 let global_state_hasher_metrics = Arc::into_inner(hasher)
2167 .expect("Object state hasher should have no other references at this point")
2168 .metrics();
2169 let new_hasher = Arc::new(GlobalStateHasher::new(
2170 self.state.get_global_state_hash_store().clone(),
2171 global_state_hasher_metrics,
2172 ));
2173 let weak_hasher = Arc::downgrade(&new_hasher);
2174 *hasher_guard = Some(new_hasher);
2175
2176 consensus_store_pruner.prune(next_epoch).await;
2177
2178 if new_role.runs_consensus() {
2179 info!("Restarting consensus as {new_role}");
2180 let components = Self::start_epoch_specific_validator_components(
2181 &self.config,
2182 self.state.clone(),
2183 consensus_adapter,
2184 self.checkpoint_store.clone(),
2185 new_epoch_store.clone(),
2186 self.state_sync_handle.clone(),
2187 self.randomness_handle.clone(),
2188 self.randomness_receiver_handle.clone(),
2189 consensus_manager,
2190 consensus_store_pruner,
2191 weak_hasher,
2192 self.backpressure_manager.clone(),
2193 validator_server_handle,
2194 validator_overload_monitor_handle,
2195 checkpoint_metrics,
2196 self.metrics.clone(),
2197 sui_tx_validator_metrics,
2198 admission_queue,
2199 transaction_pool_context.clone(),
2200 new_role,
2201 )
2202 .await?;
2203 self.update_address_prober_epoch(
2204 &new_epoch_store,
2205 &components.consensus_manager,
2206 );
2207 Some(components)
2208 } else {
2209 info!(
2210 "This node has new role {new_role} and no longer runs consensus after reconfiguration"
2211 );
2212 None
2213 }
2214 } else {
2215 let global_state_hasher_metrics = Arc::into_inner(hasher)
2218 .expect("Object state hasher should have no other references at this point")
2219 .metrics();
2220 let new_hasher = Arc::new(GlobalStateHasher::new(
2221 self.state.get_global_state_hash_store().clone(),
2222 global_state_hasher_metrics,
2223 ));
2224 let weak_hasher = Arc::downgrade(&new_hasher);
2225 *hasher_guard = Some(new_hasher);
2226
2227 if new_role.runs_consensus() {
2228 info!("Promoting node to {new_role}, starting consensus components");
2229
2230 let mut components = Self::construct_validator_components(
2231 self.config.clone(),
2232 self.state.clone(),
2233 Arc::new(next_epoch_committee.clone()),
2234 new_epoch_store.clone(),
2235 self.checkpoint_store.clone(),
2236 self.state_sync_handle.clone(),
2237 self.randomness_handle.clone(),
2238 weak_hasher,
2239 self.backpressure_manager.clone(),
2240 &self.registry_service,
2241 self.transaction_pool_context.clone(),
2242 &self.consensus_adapter_metrics,
2243 self.metrics.clone(),
2244 self.checkpoint_metrics.clone(),
2245 new_role,
2246 self.randomness_receiver_handle.clone(),
2247 )
2248 .await?;
2249
2250 if new_role.is_validator() {
2251 components.validator_server_handle = Some(
2252 components
2253 .validator_server_handle
2254 .take()
2255 .unwrap()
2256 .start()
2257 .await,
2258 );
2259
2260 self.endpoint_manager
2261 .set_consensus_address_updater(components.consensus_manager.clone());
2262 }
2263
2264 self.update_address_prober_epoch(
2265 &new_epoch_store,
2266 &components.consensus_manager,
2267 );
2268 Some(components)
2269 } else {
2270 None
2271 }
2272 };
2273 *validator_components_lock_guard = new_validator_components;
2274
2275 if cfg!(msim)
2276 && !matches!(
2277 self.config
2278 .authority_store_pruning_config
2279 .num_epochs_to_retain_for_checkpoints(),
2280 None | Some(u64::MAX) | Some(0)
2281 )
2282 {
2283 self.state
2284 .prune_checkpoints_for_eligible_epochs_for_testing(
2285 self.config.clone(),
2286 sui_core::authority::authority_store_pruner::AuthorityStorePruningMetrics::new_for_test(),
2287 )
2288 .await?;
2289 }
2290
2291 let prev_epoch = epoch_store.epoch();
2292 let prev_epoch_store = Arc::downgrade(&epoch_store);
2293 drop(cur_epoch_store);
2294 epoch_store = new_epoch_store;
2295 spawn_monitored_task!(Self::check_epoch_store_released(
2296 prev_epoch_store,
2297 prev_epoch
2298 ));
2299 info!("Reconfiguration finished");
2300 }
2301 }
2302
2303 async fn check_epoch_store_released(
2307 prev_epoch_store: Weak<AuthorityPerEpochStore>,
2308 prev_epoch: EpochId,
2309 ) {
2310 let grace_period = epoch_store_release_grace_period();
2311 tokio::time::sleep(grace_period).await;
2312 let strong_count = prev_epoch_store.strong_count();
2313 if strong_count > 0 {
2314 debug_fatal!(
2315 "AuthorityPerEpochStore for epoch {prev_epoch} still has {strong_count} strong \
2316 references {grace_period:?} after reconfiguration"
2317 );
2318 } else {
2319 info!(prev_epoch, "Previous epoch store released");
2320 }
2321 }
2322
2323 async fn shutdown(&self) {
2324 if let Some(validator_components) = &*self.validator_components.lock().await {
2325 validator_components.consensus_manager.shutdown().await;
2326 }
2327 if let Some(context) = &self.transaction_pool_context {
2328 context.set_unavailable(self.state.load_epoch_store_one_call_per_task().epoch());
2329 }
2330 }
2331
2332 async fn reconfigure_state(
2333 &self,
2334 state: &Arc<AuthorityState>,
2335 cur_epoch_store: &AuthorityPerEpochStore,
2336 next_epoch_committee: Committee,
2337 next_epoch_start_system_state: EpochStartSystemState,
2338 global_state_hasher: Arc<GlobalStateHasher>,
2339 ) -> Arc<AuthorityPerEpochStore> {
2340 let next_epoch = next_epoch_committee.epoch();
2341
2342 let last_checkpoint = self
2343 .checkpoint_store
2344 .get_epoch_last_checkpoint(cur_epoch_store.epoch())
2345 .expect("Error loading last checkpoint for current epoch")
2346 .expect("Could not load last checkpoint for current epoch");
2347
2348 let last_checkpoint_seq = *last_checkpoint.sequence_number();
2349
2350 assert_eq!(
2351 Some(last_checkpoint_seq),
2352 self.checkpoint_store
2353 .get_highest_executed_checkpoint_seq_number()
2354 .expect("Error loading highest executed checkpoint sequence number")
2355 );
2356
2357 let epoch_start_configuration = EpochStartConfiguration::new(
2358 next_epoch_start_system_state,
2359 *last_checkpoint.digest(),
2360 state.get_object_store().as_ref(),
2361 EpochFlag::default_flags_for_new_epoch(&state.config),
2362 )
2363 .expect("EpochStartConfiguration construction cannot fail");
2364
2365 let new_epoch_store = self
2366 .state
2367 .reconfigure(
2368 cur_epoch_store,
2369 self.config.supported_protocol_versions.unwrap(),
2370 next_epoch_committee,
2371 epoch_start_configuration,
2372 global_state_hasher,
2373 &self.config.expensive_safety_check_config,
2374 last_checkpoint_seq,
2375 )
2376 .await
2377 .expect("Reconfigure authority state cannot fail");
2378 info!(next_epoch, "Node State has been reconfigured");
2379 assert_eq!(next_epoch, new_epoch_store.epoch());
2380 self.state.get_reconfig_api().update_epoch_flags_metrics(
2381 cur_epoch_store.epoch_start_config().flags(),
2382 new_epoch_store.epoch_start_config().flags(),
2383 );
2384
2385 new_epoch_store
2386 }
2387
2388 pub fn get_config(&self) -> &NodeConfig {
2389 &self.config
2390 }
2391
2392 pub fn randomness_handle(&self) -> randomness::Handle {
2393 self.randomness_handle.clone()
2394 }
2395
2396 pub fn state_sync_handle(&self) -> state_sync::Handle {
2397 self.state_sync_handle.clone()
2398 }
2399
2400 pub fn endpoint_manager(&self) -> &EndpointManager {
2401 &self.endpoint_manager
2402 }
2403
2404 pub async fn address_prober_report(&self) -> Option<address_prober::ProbeReport> {
2405 match &self.address_prober {
2406 Some(handle) => handle.probe_report().await,
2407 None => None,
2408 }
2409 }
2410
2411 fn get_digest_prefix(digest: impl std::fmt::Display) -> String {
2413 let digest_str = digest.to_string();
2414 if digest_str.len() >= 8 {
2415 digest_str[0..8].to_string()
2416 } else {
2417 digest_str
2418 }
2419 }
2420
2421 async fn check_and_recover_forks(
2425 checkpoint_store: &CheckpointStore,
2426 checkpoint_metrics: &CheckpointMetrics,
2427 fork_recovery: Option<&ForkRecoveryConfig>,
2428 build_version: &str,
2429 ) -> Result<()> {
2430 if let Some(recovery) = fork_recovery {
2433 Self::try_recover_checkpoint_fork(checkpoint_store, recovery)?;
2434 Self::try_recover_transaction_fork(checkpoint_store, recovery)?;
2435 }
2436
2437 let behavior = fork_recovery
2438 .map(|fr| fr.fork_crash_behavior)
2439 .unwrap_or_default();
2440
2441 match behavior {
2442 ForkCrashBehavior::RecoverOncePerVersion => {
2443 Self::try_recover_forks(checkpoint_store, checkpoint_metrics, build_version)?;
2444 }
2445 ForkCrashBehavior::AwaitForkRecovery | ForkCrashBehavior::ReturnError => {}
2446 }
2447
2448 if let Some(fork_info) = checkpoint_store
2449 .get_checkpoint_fork_detected()
2450 .map_err(|e| {
2451 error!("Failed to check for checkpoint fork: {:?}", e);
2452 e
2453 })?
2454 {
2455 Self::handle_checkpoint_fork(
2456 fork_info.checkpoint_seq,
2457 fork_info.checkpoint_digest,
2458 checkpoint_metrics,
2459 fork_recovery,
2460 )
2461 .await?;
2462 }
2463 if let Some(fork_info) = checkpoint_store
2464 .get_transaction_fork_detected()
2465 .map_err(|e| {
2466 error!("Failed to check for transaction fork: {:?}", e);
2467 e
2468 })?
2469 {
2470 Self::handle_transaction_fork(
2471 fork_info.tx_digest,
2472 fork_info.expected_effects_digest,
2473 fork_info.actual_effects_digest,
2474 checkpoint_metrics,
2475 fork_recovery,
2476 )
2477 .await?;
2478 }
2479
2480 Ok(())
2481 }
2482
2483 fn try_recover_checkpoint_fork(
2487 checkpoint_store: &CheckpointStore,
2488 recovery: &ForkRecoveryConfig,
2489 ) -> Result<()> {
2490 if recovery.checkpoint_overrides.is_empty() {
2491 return Ok(());
2492 }
2493
2494 for (seq, expected_digest_str) in &recovery.checkpoint_overrides {
2495 let Ok(expected_digest) = CheckpointDigest::from_str(expected_digest_str) else {
2496 anyhow::bail!(
2497 "Invalid checkpoint digest override for seq {}: {}",
2498 seq,
2499 expected_digest_str
2500 );
2501 };
2502
2503 if let Some(local_summary) = checkpoint_store.get_locally_computed_checkpoint(*seq)? {
2504 let local_digest = sui_types::message_envelope::Message::digest(&local_summary);
2505 if local_digest != expected_digest {
2506 info!(
2507 seq,
2508 local = %Self::get_digest_prefix(local_digest),
2509 expected = %Self::get_digest_prefix(expected_digest),
2510 "Fork recovery: clearing locally_computed_checkpoints from {} due to digest mismatch",
2511 seq
2512 );
2513 checkpoint_store
2514 .clear_locally_computed_checkpoints_from(*seq)
2515 .context(
2516 "Failed to clear locally computed checkpoints from override seq",
2517 )?;
2518 }
2519 }
2520 }
2521
2522 if let Some(fork_info) = checkpoint_store.get_checkpoint_fork_detected()?
2523 && recovery
2524 .checkpoint_overrides
2525 .contains_key(&fork_info.checkpoint_seq)
2526 {
2527 info!(
2528 "Fork recovery enabled: clearing checkpoint fork at seq {} with digest {:?}",
2529 fork_info.checkpoint_seq, fork_info.checkpoint_digest
2530 );
2531 checkpoint_store
2532 .clear_checkpoint_fork_detected()
2533 .expect("Failed to clear checkpoint fork detected marker");
2534 }
2535 Ok(())
2536 }
2537
2538 fn try_recover_transaction_fork(
2541 checkpoint_store: &CheckpointStore,
2542 recovery: &ForkRecoveryConfig,
2543 ) -> Result<()> {
2544 if recovery.transaction_overrides.is_empty() {
2545 return Ok(());
2546 }
2547
2548 if let Some(fork_info) = checkpoint_store.get_transaction_fork_detected()?
2549 && recovery
2550 .transaction_overrides
2551 .contains_key(&fork_info.tx_digest.to_string())
2552 {
2553 info!(
2554 "Fork recovery enabled: clearing transaction fork for tx {:?}",
2555 fork_info.tx_digest
2556 );
2557 checkpoint_store
2558 .clear_transaction_fork_detected()
2559 .expect("Failed to clear transaction fork detected marker");
2560 }
2561 Ok(())
2562 }
2563
2564 fn try_recover_forks(
2582 checkpoint_store: &CheckpointStore,
2583 checkpoint_metrics: &CheckpointMetrics,
2584 build_version: &str,
2585 ) -> Result<()> {
2586 if let Some(fork_info) = checkpoint_store.get_checkpoint_fork_detected()? {
2587 if fork_info.binary_version == build_version {
2588 error!(
2589 checkpoint_seq = fork_info.checkpoint_seq,
2590 build_version,
2591 "Fork recovery blocked: this binary version produced the checkpoint fork and \
2592 would fork again. Halting; deploy a corrected binary to recover."
2593 );
2594 checkpoint_metrics
2595 .fork_auto_recovery_awaiting_new_binary
2596 .set(1);
2597 } else if fork_info.certified_checkpoint_digest.is_none() {
2598 error!(
2602 checkpoint_seq = fork_info.checkpoint_seq,
2603 checkpoint_digest = ?fork_info.checkpoint_digest,
2604 "Fork recovery blocked: the builder re-derived its own previous checkpoint \
2605 differently, so there is no certified checkpoint proving the canonical \
2606 outcome to converge toward. Halting awaiting operator intervention."
2607 );
2608 checkpoint_metrics
2609 .fork_auto_recovery_blocked_uncertified
2610 .set(1);
2611 } else {
2612 info!(
2613 checkpoint_seq = fork_info.checkpoint_seq,
2614 checkpoint_digest = ?fork_info.checkpoint_digest,
2615 forked_binary_version = ?fork_info.binary_version,
2616 build_version,
2617 "Fork recovery: clearing checkpoint fork and locally computed checkpoints \
2618 from the forked sequence so the builder rebuilds toward the certified \
2619 checkpoint"
2620 );
2621 checkpoint_store
2622 .clear_locally_computed_checkpoints_from(fork_info.checkpoint_seq)
2623 .context("Failed to clear locally computed checkpoints during fork recovery")?;
2624 checkpoint_store.clear_checkpoint_fork_detected()?;
2625 checkpoint_metrics.checkpoint_fork_auto_recovered.set(1);
2626 }
2627 }
2628
2629 if let Some(fork_info) = checkpoint_store.get_transaction_fork_detected()? {
2630 if fork_info.binary_version == build_version {
2631 error!(
2632 tx_digest = ?fork_info.tx_digest,
2633 build_version,
2634 "Fork recovery blocked: this binary version produced the transaction fork and \
2635 would fork again. Halting; deploy a corrected binary to recover."
2636 );
2637 checkpoint_metrics
2638 .fork_auto_recovery_awaiting_new_binary
2639 .set(1);
2640 } else if fork_info.certified_checkpoint_seq.is_none() {
2641 error!(
2642 tx_digest = ?fork_info.tx_digest,
2643 "Fork recovery blocked: the expected effects of the forked transaction did \
2644 not come from a certified checkpoint (they came from this validator's own \
2645 previously signed effects), so the network has not provably certified the \
2646 canonical outcome. Halting awaiting operator intervention."
2647 );
2648 checkpoint_metrics
2649 .fork_auto_recovery_blocked_uncertified
2650 .set(1);
2651 } else {
2652 info!(
2653 tx_digest = ?fork_info.tx_digest,
2654 expected_effects = ?fork_info.expected_effects_digest,
2655 actual_effects = ?fork_info.actual_effects_digest,
2656 certified_checkpoint_seq = ?fork_info.certified_checkpoint_seq,
2657 forked_binary_version = ?fork_info.binary_version,
2658 build_version,
2659 "Fork recovery: clearing transaction fork; re-execution will converge toward \
2660 the canonical certified effects"
2661 );
2662 checkpoint_store.clear_transaction_fork_detected()?;
2663 checkpoint_metrics.transaction_fork_auto_recovered.set(1);
2664 }
2665 }
2666
2667 Ok(())
2668 }
2669
2670 fn get_current_timestamp() -> u64 {
2671 std::time::SystemTime::now()
2672 .duration_since(std::time::SystemTime::UNIX_EPOCH)
2673 .unwrap()
2674 .as_secs()
2675 }
2676
2677 async fn handle_checkpoint_fork(
2678 checkpoint_seq: u64,
2679 checkpoint_digest: CheckpointDigest,
2680 checkpoint_metrics: &CheckpointMetrics,
2681 fork_recovery: Option<&ForkRecoveryConfig>,
2682 ) -> Result<()> {
2683 checkpoint_metrics
2684 .checkpoint_fork_crash_mode
2685 .with_label_values(&[
2686 &checkpoint_seq.to_string(),
2687 &Self::get_digest_prefix(checkpoint_digest),
2688 &Self::get_current_timestamp().to_string(),
2689 ])
2690 .set(1);
2691
2692 let behavior = fork_recovery
2693 .map(|fr| fr.fork_crash_behavior)
2694 .unwrap_or_default();
2695
2696 match behavior {
2697 ForkCrashBehavior::AwaitForkRecovery | ForkCrashBehavior::RecoverOncePerVersion => {
2698 error!(
2699 checkpoint_seq = checkpoint_seq,
2700 checkpoint_digest = ?checkpoint_digest,
2701 "Checkpoint fork detected! Node startup halted. Sleeping indefinitely."
2702 );
2703 futures::future::pending::<()>().await;
2704 unreachable!("pending() should never return");
2705 }
2706 ForkCrashBehavior::ReturnError => {
2707 error!(
2708 checkpoint_seq = checkpoint_seq,
2709 checkpoint_digest = ?checkpoint_digest,
2710 "Checkpoint fork detected! Returning error."
2711 );
2712 Err(anyhow::anyhow!(
2713 "Checkpoint fork detected! checkpoint_seq: {}, checkpoint_digest: {:?}",
2714 checkpoint_seq,
2715 checkpoint_digest
2716 ))
2717 }
2718 }
2719 }
2720
2721 async fn handle_transaction_fork(
2722 tx_digest: TransactionDigest,
2723 expected_effects_digest: TransactionEffectsDigest,
2724 actual_effects_digest: TransactionEffectsDigest,
2725 checkpoint_metrics: &CheckpointMetrics,
2726 fork_recovery: Option<&ForkRecoveryConfig>,
2727 ) -> Result<()> {
2728 checkpoint_metrics
2729 .transaction_fork_crash_mode
2730 .with_label_values(&[
2731 &Self::get_digest_prefix(tx_digest),
2732 &Self::get_digest_prefix(expected_effects_digest),
2733 &Self::get_digest_prefix(actual_effects_digest),
2734 &Self::get_current_timestamp().to_string(),
2735 ])
2736 .set(1);
2737
2738 let behavior = fork_recovery
2739 .map(|fr| fr.fork_crash_behavior)
2740 .unwrap_or_default();
2741
2742 match behavior {
2743 ForkCrashBehavior::AwaitForkRecovery | ForkCrashBehavior::RecoverOncePerVersion => {
2744 error!(
2745 tx_digest = ?tx_digest,
2746 expected_effects_digest = ?expected_effects_digest,
2747 actual_effects_digest = ?actual_effects_digest,
2748 "Transaction fork detected! Node startup halted. Sleeping indefinitely."
2749 );
2750 futures::future::pending::<()>().await;
2751 unreachable!("pending() should never return");
2752 }
2753 ForkCrashBehavior::ReturnError => {
2754 error!(
2755 tx_digest = ?tx_digest,
2756 expected_effects_digest = ?expected_effects_digest,
2757 actual_effects_digest = ?actual_effects_digest,
2758 "Transaction fork detected! Returning error."
2759 );
2760 Err(anyhow::anyhow!(
2761 "Transaction fork detected! tx_digest: {:?}, expected_effects: {:?}, actual_effects: {:?}",
2762 tx_digest,
2763 expected_effects_digest,
2764 actual_effects_digest
2765 ))
2766 }
2767 }
2768 }
2769}
2770
2771#[cfg(not(msim))]
2772impl SuiNode {
2773 async fn fetch_jwks(
2774 _authority: AuthorityName,
2775 provider: &OIDCProvider,
2776 ) -> SuiResult<Vec<(JwkId, JWK)>> {
2777 use fastcrypto_zkp::bn254::zk_login::fetch_jwks;
2778 use sui_types::error::SuiErrorKind;
2779 let client = reqwest::Client::new();
2780 fetch_jwks(provider, &client, true)
2781 .await
2782 .map_err(|_| SuiErrorKind::JWKRetrievalError.into())
2783 }
2784}
2785
2786#[cfg(msim)]
2787impl SuiNode {
2788 pub fn get_sim_node_id(&self) -> sui_simulator::task::NodeId {
2789 self.sim_state.sim_node.id()
2790 }
2791
2792 pub fn set_safe_mode_expected(&self, new_value: bool) {
2793 info!("Setting safe mode expected to {}", new_value);
2794 self.sim_state
2795 .sim_safe_mode_expected
2796 .store(new_value, Ordering::Relaxed);
2797 }
2798
2799 #[allow(unused_variables)]
2800 async fn fetch_jwks(
2801 authority: AuthorityName,
2802 provider: &OIDCProvider,
2803 ) -> SuiResult<Vec<(JwkId, JWK)>> {
2804 get_jwk_injector()(authority, provider)
2805 }
2806}
2807
2808enum ValidatorGrpcServer {
2811 Unstarted(Mutex<BoxFuture<'static, sui_http::ServerHandle>>),
2813 Started(sui_http::ServerHandle),
2814}
2815
2816impl ValidatorGrpcServer {
2817 pub fn new(bind: impl Future<Output = sui_http::ServerHandle> + Send + 'static) -> Self {
2818 Self::Unstarted(Mutex::new(Box::pin(bind)))
2819 }
2820
2821 pub async fn start(self) -> Self {
2822 match self {
2823 Self::Unstarted(bind) => Self::Started(bind.into_inner().await),
2824 Self::Started(_) => self,
2825 }
2826 }
2827
2828 pub async fn shutdown(self) {
2831 if let Self::Started(handle) = self {
2832 handle.trigger_shutdown();
2833 match tokio::time::timeout(
2834 VALIDATOR_GRPC_SERVER_SHUTDOWN_TIMEOUT,
2835 handle.wait_for_shutdown(),
2836 )
2837 .await
2838 {
2839 Ok(()) => info!("Validator gRPC server stopped"),
2840 Err(e) => warn!(
2842 error = ?e,
2843 "Validator gRPC server did not stop within {VALIDATOR_GRPC_SERVER_SHUTDOWN_TIMEOUT:?}"
2844 ),
2845 }
2846 }
2847 }
2848}
2849
2850fn update_peer_addresses(
2854 config: &NodeConfig,
2855 endpoint_manager: &EndpointManager,
2856 epoch_start_state: &EpochStartSystemState,
2857 prev_epoch_start_state: Option<&EpochStartSystemState>,
2858) {
2859 if config.consensus_config().is_none() {
2860 return;
2861 }
2862 let new_peers: HashSet<PeerId> = epoch_start_state
2863 .get_validator_as_p2p_peers(config.protocol_public_key())
2864 .into_iter()
2865 .map(|(peer_id, address)| {
2866 endpoint_manager
2867 .update_endpoint(
2868 EndpointId::P2p(peer_id),
2869 AddressSource::Chain,
2870 vec![address],
2871 )
2872 .expect("Updating peer addresses should not fail");
2873 peer_id
2874 })
2875 .collect();
2876
2877 if let Some(prev) = prev_epoch_start_state {
2879 for (peer_id, _) in prev.get_validator_as_p2p_peers(config.protocol_public_key()) {
2880 if !new_peers.contains(&peer_id) {
2881 endpoint_manager
2882 .update_endpoint(EndpointId::P2p(peer_id), AddressSource::Chain, vec![])
2883 .expect("Clearing peer addresses should not fail");
2884 }
2885 }
2886 }
2887}
2888
2889const LEGACY_INDEX_STORE_DIRS: [&str; 2] = ["rpc-index", "indexes"];
2893
2894fn remove_legacy_index_stores(db_path: &Path) {
2901 for dir in LEGACY_INDEX_STORE_DIRS {
2902 let legacy_dir = db_path.join(dir);
2903 match std::fs::remove_dir_all(&legacy_dir) {
2904 Ok(()) => info!("removed legacy {dir} directory {}", legacy_dir.display()),
2905 Err(e) if e.kind() == std::io::ErrorKind::NotFound => {}
2908 Err(e) => warn!(
2909 "failed to remove legacy {dir} directory {}: {e:?}",
2910 legacy_dir.display()
2911 ),
2912 }
2913 }
2914}
2915
2916async fn build_http_servers(
2917 state: Arc<AuthorityState>,
2918 store: RocksDbStore,
2919 transaction_orchestrator: &Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>>,
2920 config: &NodeConfig,
2921 prometheus_registry: &Registry,
2922 server_version: ServerVersion,
2923 node_role: NodeRole,
2924 embedded_rpc_store: Option<&EmbeddedRpcStore>,
2925) -> Result<(
2926 HttpServers,
2927 Option<tokio::sync::broadcast::Sender<Arc<Checkpoint>>>,
2928)> {
2929 if !node_role.is_fullnode() {
2931 return Ok((HttpServers::default(), None));
2932 }
2933
2934 info!("starting rpc service with config: {:?}", config.rpc);
2935
2936 let indexed_checkpoint = embedded_rpc_store.map(|embedded| embedded.indexed_checkpoint_fn());
2940 let subscription_watermark_interval = config
2941 .rpc
2942 .as_ref()
2943 .and_then(|rpc| rpc.subscription_watermark_interval);
2944 let subscription_max_subscribers = config
2945 .rpc
2946 .as_ref()
2947 .and_then(|rpc| rpc.subscription_max_subscribers);
2948 let subscription_shards = config.rpc.as_ref().and_then(|rpc| rpc.subscription_shards);
2949 let (subscription_service_checkpoint_sender, subscription_service_handle) =
2950 SubscriptionService::build(
2951 prometheus_registry,
2952 indexed_checkpoint,
2953 subscription_watermark_interval,
2954 subscription_max_subscribers,
2955 subscription_shards,
2956 );
2957 let rpc_router = {
2958 let reader: Arc<dyn RpcStateReader> = match embedded_rpc_store {
2962 Some(embedded) => Arc::new(RpcStoreReadStore::new(
2963 state.clone(),
2964 store,
2965 embedded.reader(),
2966 )),
2967 None => Arc::new(RestReadStore::new(state.clone(), store)),
2968 };
2969 let mut rpc_service = sui_rpc_api::RpcService::new(reader);
2970 rpc_service.with_server_version(server_version);
2971
2972 if let Some(config) = config.rpc.clone() {
2973 config.validate()?;
2974 rpc_service.with_config(config);
2975 }
2976
2977 rpc_service.with_metrics(prometheus_registry);
2978 rpc_service.with_subscription_service(subscription_service_handle);
2979
2980 if let Some(transaction_orchestrator) = transaction_orchestrator {
2981 rpc_service.with_executor(transaction_orchestrator.clone());
2982 if config.enable_simulate_allowed_proposers {
2986 rpc_service
2987 .with_proposer_selector(transaction_orchestrator.transaction_driver().clone());
2988 }
2989 }
2990
2991 rpc_service.into_router().await
2992 };
2993
2994 let layers = ServiceBuilder::new()
2995 .map_request(|mut request: axum::http::Request<_>| {
2996 if let Some(connect_info) = request.extensions().get::<sui_http::ConnectInfo>() {
2997 let axum_connect_info = axum::extract::ConnectInfo(connect_info.remote_addr);
2998 request.extensions_mut().insert(axum_connect_info);
2999 }
3000 request
3001 })
3002 .layer(axum::middleware::from_fn(server_timing_middleware))
3003 .layer(
3005 tower_http::cors::CorsLayer::new()
3006 .allow_methods([http::Method::GET, http::Method::POST])
3007 .allow_origin(tower_http::cors::Any)
3008 .allow_headers(tower_http::cors::Any)
3009 .expose_headers(tower_http::cors::Any),
3010 );
3011
3012 let router = rpc_router.layer(layers);
3013
3014 let server_config = {
3022 let rpc_config = config.rpc().cloned().unwrap_or_default();
3023 let mut server_config = sui_http::Config::default()
3024 .max_connection_age_grace(rpc_config.max_connection_age_grace());
3025 if let Some(age) = rpc_config.max_connection_age() {
3026 server_config = server_config.max_connection_age(age);
3027 }
3028 server_config
3029 };
3030
3031 let https = if let Some((tls_config, https_address)) = config
3032 .rpc()
3033 .and_then(|config| config.tls_config().map(|tls| (tls, config.https_address())))
3034 {
3035 let tls_server_config = https_rustls_config(tls_config.cert(), tls_config.key())?;
3036 let https = sui_http::Builder::new()
3037 .config(server_config.clone())
3038 .tls_config(tls_server_config)
3039 .serve(https_address, router.clone())
3040 .map_err(|e| anyhow::anyhow!(e))?;
3041
3042 info!(
3043 https_address =? https.local_addr(),
3044 "HTTPS rpc server listening on {}",
3045 https.local_addr()
3046 );
3047
3048 Some(https)
3049 } else {
3050 None
3051 };
3052
3053 let http = sui_http::Builder::new()
3054 .config(server_config)
3055 .serve(&config.json_rpc_address, router)
3056 .map_err(|e| anyhow::anyhow!(e))?;
3057
3058 info!(
3059 http_address =? http.local_addr(),
3060 "HTTP rpc server listening on {}",
3061 http.local_addr()
3062 );
3063
3064 Ok((
3065 HttpServers {
3066 http: Some(http),
3067 https,
3068 },
3069 Some(subscription_service_checkpoint_sender),
3070 ))
3071}
3072
3073#[derive(Debug, PartialEq, Eq)]
3080enum DenyConfigBroadcastAction {
3081 Skip,
3083 Broadcast(TransactionDenyRules),
3085 Withdraw,
3087}
3088
3089fn deny_config_broadcast_payload(
3090 local_rules: &TransactionDenyRules,
3091 broadcast: bool,
3092 is_startup: bool,
3093 may_have_prior_broadcast: bool,
3094) -> DenyConfigBroadcastAction {
3095 let shareable = local_rules.is_empty() || local_rules.check_share_limits().is_ok();
3096 if broadcast && shareable {
3097 if local_rules.is_empty() {
3099 DenyConfigBroadcastAction::Withdraw
3100 } else {
3101 DenyConfigBroadcastAction::Broadcast(local_rules.clone())
3102 }
3103 } else if is_startup && may_have_prior_broadcast {
3104 DenyConfigBroadcastAction::Withdraw
3105 } else {
3106 DenyConfigBroadcastAction::Skip
3107 }
3108}
3109
3110fn https_rustls_config(cert: &str, key: &str) -> Result<sui_http::rustls::ServerConfig> {
3119 use sui_http::rustls;
3120 use sui_http::rustls::pki_types::pem::PemObject;
3121
3122 let certs = rustls::pki_types::CertificateDer::pem_file_iter(cert)
3123 .with_context(|| format!("failed to read TLS certificate chain from {cert}"))?
3124 .collect::<Result<Vec<_>, _>>()
3125 .with_context(|| format!("failed to parse TLS certificate chain from {cert}"))?;
3126 let private_key = rustls::pki_types::PrivateKeyDer::from_pem_file(key)
3127 .with_context(|| format!("failed to read TLS private key from {key}"))?;
3128 let config = rustls::ServerConfig::builder_with_provider(Arc::new(
3129 rustls::crypto::ring::default_provider(),
3130 ))
3131 .with_protocol_versions(rustls::DEFAULT_VERSIONS)?
3132 .with_no_client_auth()
3133 .with_single_cert(certs, private_key)?;
3134 Ok(config)
3135}
3136
3137#[derive(Default)]
3138struct HttpServers {
3139 #[allow(unused)]
3140 http: Option<sui_http::ServerHandle>,
3141 #[allow(unused)]
3142 https: Option<sui_http::ServerHandle>,
3143}
3144
3145#[cfg(test)]
3146mod tests {
3147 use super::*;
3148 use prometheus::Registry;
3149 use std::collections::BTreeMap;
3150 use sui_config::node::{ForkCrashBehavior, ForkRecoveryConfig};
3151 use sui_core::checkpoints::{CheckpointMetrics, CheckpointStore};
3152 use sui_types::digests::{CheckpointDigest, TransactionDigest, TransactionEffectsDigest};
3153
3154 #[test]
3155 fn deny_config_broadcast_payload_decisions() {
3156 let empty = TransactionDenyRules::default();
3157 let populated = TransactionDenyRules {
3158 package_publish_disabled: true,
3159 ..Default::default()
3160 };
3161 let oversized = TransactionDenyRules {
3162 zklogin_disabled_providers: std::iter::once(
3163 "x".repeat(TransactionDenyRules::MAX_ZKLOGIN_PROVIDER_LENGTH + 1),
3164 )
3165 .collect(),
3166 ..Default::default()
3167 };
3168
3169 assert_eq!(
3171 deny_config_broadcast_payload(&populated, true, true, false),
3172 DenyConfigBroadcastAction::Broadcast(populated.clone()),
3173 );
3174 assert_eq!(
3176 deny_config_broadcast_payload(&empty, true, true, false),
3177 DenyConfigBroadcastAction::Withdraw,
3178 );
3179 assert_eq!(
3181 deny_config_broadcast_payload(&populated, false, true, true),
3182 DenyConfigBroadcastAction::Withdraw,
3183 );
3184 assert_eq!(
3186 deny_config_broadcast_payload(&populated, false, true, false),
3187 DenyConfigBroadcastAction::Skip,
3188 );
3189 assert_eq!(
3191 deny_config_broadcast_payload(&populated, false, false, true),
3192 DenyConfigBroadcastAction::Skip,
3193 );
3194 assert_eq!(
3197 deny_config_broadcast_payload(&oversized, true, true, true),
3198 DenyConfigBroadcastAction::Withdraw,
3199 );
3200 assert_eq!(
3201 deny_config_broadcast_payload(&oversized, true, true, false),
3202 DenyConfigBroadcastAction::Skip,
3203 );
3204 }
3205
3206 #[test]
3210 fn removes_only_the_legacy_index_directories() {
3211 let db = tempfile::tempdir().unwrap();
3212 let rpc_index = db.path().join("rpc-index");
3213 let indexes = db.path().join("indexes");
3214 let sibling = db.path().join("store");
3215 for dir in [&rpc_index, &indexes, &sibling] {
3216 std::fs::create_dir(dir).unwrap();
3217 std::fs::write(dir.join("CURRENT"), b"stale").unwrap();
3218 }
3219
3220 remove_legacy_index_stores(db.path());
3221 assert!(
3222 !rpc_index.exists(),
3223 "legacy rpc-index directory should be gone"
3224 );
3225 assert!(!indexes.exists(), "legacy indexes directory should be gone");
3226 assert!(sibling.exists(), "sibling stores must be left untouched");
3227
3228 remove_legacy_index_stores(db.path());
3231 assert!(!rpc_index.exists());
3232 assert!(!indexes.exists());
3233 assert!(sibling.exists());
3234 }
3235
3236 #[tokio::test]
3238 async fn test_return_error_does_not_recover() {
3239 let checkpoint_store = CheckpointStore::new_for_tests();
3240 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3241 let cfg = ForkRecoveryConfig {
3242 transaction_overrides: Default::default(),
3243 checkpoint_overrides: Default::default(),
3244 fork_crash_behavior: ForkCrashBehavior::ReturnError,
3245 };
3246
3247 checkpoint_store
3249 .record_checkpoint_fork_detected(
3250 42,
3251 CheckpointDigest::random(),
3252 Some(CheckpointDigest::random()),
3253 )
3254 .unwrap();
3255 let r = SuiNode::check_and_recover_forks(
3256 &checkpoint_store,
3257 &checkpoint_metrics,
3258 Some(&cfg),
3259 "v1",
3260 )
3261 .await;
3262 assert!(
3263 r.unwrap_err()
3264 .to_string()
3265 .contains("Checkpoint fork detected")
3266 );
3267 assert!(
3268 checkpoint_store
3269 .get_checkpoint_fork_detected()
3270 .unwrap()
3271 .is_some()
3272 );
3273 checkpoint_store.clear_checkpoint_fork_detected().unwrap();
3274
3275 checkpoint_store
3277 .record_transaction_fork_detected(
3278 TransactionDigest::random(),
3279 TransactionEffectsDigest::random(),
3280 TransactionEffectsDigest::random(),
3281 Some(1),
3282 )
3283 .unwrap();
3284 let r = SuiNode::check_and_recover_forks(
3285 &checkpoint_store,
3286 &checkpoint_metrics,
3287 Some(&cfg),
3288 "v1",
3289 )
3290 .await;
3291 assert!(
3292 r.unwrap_err()
3293 .to_string()
3294 .contains("Transaction fork detected")
3295 );
3296 }
3297
3298 #[tokio::test]
3302 async fn test_same_binary_version_does_not_recover() {
3303 let checkpoint_store = CheckpointStore::new_for_tests();
3304 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3305 let seq = 7;
3306 checkpoint_store.set_binary_version("v1");
3308 checkpoint_store
3309 .record_checkpoint_fork_detected(
3310 seq,
3311 CheckpointDigest::random(),
3312 Some(CheckpointDigest::random()),
3313 )
3314 .unwrap();
3315
3316 SuiNode::try_recover_forks(&checkpoint_store, &checkpoint_metrics, "v1").unwrap();
3318 assert!(
3319 checkpoint_store
3320 .get_checkpoint_fork_detected()
3321 .unwrap()
3322 .is_some()
3323 );
3324 assert_eq!(
3325 checkpoint_metrics
3326 .fork_auto_recovery_awaiting_new_binary
3327 .get(),
3328 1
3329 );
3330 assert_eq!(checkpoint_metrics.checkpoint_fork_auto_recovered.get(), 0);
3331
3332 SuiNode::try_recover_forks(&checkpoint_store, &checkpoint_metrics, "v2").unwrap();
3334 assert!(
3335 checkpoint_store
3336 .get_checkpoint_fork_detected()
3337 .unwrap()
3338 .is_none()
3339 );
3340 assert_eq!(checkpoint_metrics.checkpoint_fork_auto_recovered.get(), 1);
3341 }
3342
3343 #[tokio::test]
3345 async fn test_default_recovers() {
3346 let checkpoint_store = CheckpointStore::new_for_tests();
3347 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3348
3349 let tx_digest = TransactionDigest::random();
3350 checkpoint_store.set_binary_version("v1");
3353 checkpoint_store
3354 .record_transaction_fork_detected(
3355 tx_digest,
3356 TransactionEffectsDigest::random(),
3357 TransactionEffectsDigest::random(),
3358 Some(3),
3359 )
3360 .unwrap();
3361
3362 let r =
3363 SuiNode::check_and_recover_forks(&checkpoint_store, &checkpoint_metrics, None, "v2")
3364 .await;
3365 assert!(r.is_ok());
3366 assert!(
3367 checkpoint_store
3368 .get_transaction_fork_detected()
3369 .unwrap()
3370 .is_none()
3371 );
3372 assert_eq!(checkpoint_metrics.transaction_fork_auto_recovered.get(), 1);
3373 }
3374
3375 #[tokio::test]
3378 async fn test_checkpoint_overrides_clear_checkpoint_marker_only() {
3379 let checkpoint_store = CheckpointStore::new_for_tests();
3380 let seq = 9;
3381
3382 checkpoint_store
3383 .record_checkpoint_fork_detected(
3384 seq,
3385 CheckpointDigest::random(),
3386 Some(CheckpointDigest::random()),
3387 )
3388 .unwrap();
3389 checkpoint_store
3390 .record_transaction_fork_detected(
3391 TransactionDigest::random(),
3392 TransactionEffectsDigest::random(),
3393 TransactionEffectsDigest::random(),
3394 None,
3395 )
3396 .unwrap();
3397
3398 SuiNode::try_recover_checkpoint_fork(&checkpoint_store, &ForkRecoveryConfig::default())
3400 .unwrap();
3401 assert!(
3402 checkpoint_store
3403 .get_checkpoint_fork_detected()
3404 .unwrap()
3405 .is_some()
3406 );
3407 assert!(
3408 checkpoint_store
3409 .get_transaction_fork_detected()
3410 .unwrap()
3411 .is_some()
3412 );
3413
3414 let mut checkpoint_overrides = BTreeMap::new();
3416 checkpoint_overrides.insert(seq, CheckpointDigest::random().to_string());
3417 let cfg = ForkRecoveryConfig {
3418 transaction_overrides: Default::default(),
3419 checkpoint_overrides,
3420 fork_crash_behavior: ForkCrashBehavior::AwaitForkRecovery,
3421 };
3422 SuiNode::try_recover_checkpoint_fork(&checkpoint_store, &cfg).unwrap();
3423 assert!(
3424 checkpoint_store
3425 .get_checkpoint_fork_detected()
3426 .unwrap()
3427 .is_none()
3428 );
3429 assert!(
3430 checkpoint_store
3431 .get_transaction_fork_detected()
3432 .unwrap()
3433 .is_some(),
3434 "checkpoint_overrides must not touch the transaction fork marker"
3435 );
3436 }
3437
3438 #[tokio::test]
3440 async fn test_transaction_overrides_clear_transaction_marker() {
3441 let checkpoint_store = CheckpointStore::new_for_tests();
3442 let tx_digest = TransactionDigest::random();
3443 checkpoint_store
3444 .record_transaction_fork_detected(
3445 tx_digest,
3446 TransactionEffectsDigest::random(),
3447 TransactionEffectsDigest::random(),
3448 None,
3449 )
3450 .unwrap();
3451
3452 let mut transaction_overrides = BTreeMap::new();
3454 transaction_overrides.insert(TransactionDigest::random().to_string(), String::new());
3455 let cfg = ForkRecoveryConfig {
3456 transaction_overrides,
3457 checkpoint_overrides: Default::default(),
3458 fork_crash_behavior: ForkCrashBehavior::AwaitForkRecovery,
3459 };
3460 SuiNode::try_recover_transaction_fork(&checkpoint_store, &cfg).unwrap();
3461 assert!(
3462 checkpoint_store
3463 .get_transaction_fork_detected()
3464 .unwrap()
3465 .is_some()
3466 );
3467
3468 let mut transaction_overrides = BTreeMap::new();
3470 transaction_overrides.insert(tx_digest.to_string(), String::new());
3471 let cfg = ForkRecoveryConfig {
3472 transaction_overrides,
3473 checkpoint_overrides: Default::default(),
3474 fork_crash_behavior: ForkCrashBehavior::AwaitForkRecovery,
3475 };
3476 SuiNode::try_recover_transaction_fork(&checkpoint_store, &cfg).unwrap();
3477 assert!(
3478 checkpoint_store
3479 .get_transaction_fork_detected()
3480 .unwrap()
3481 .is_none()
3482 );
3483 }
3484
3485 #[tokio::test]
3489 async fn test_override_clears_fork_auto_recovery_refuses() {
3490 let checkpoint_store = CheckpointStore::new_for_tests();
3491 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3492 let seq = 5;
3493 checkpoint_store.set_binary_version("v1");
3494 checkpoint_store
3495 .record_checkpoint_fork_detected(
3496 seq,
3497 CheckpointDigest::random(),
3498 Some(CheckpointDigest::random()),
3499 )
3500 .unwrap();
3501
3502 let mut checkpoint_overrides = BTreeMap::new();
3503 checkpoint_overrides.insert(seq, CheckpointDigest::random().to_string());
3504 let cfg = ForkRecoveryConfig {
3505 transaction_overrides: Default::default(),
3506 checkpoint_overrides,
3507 fork_crash_behavior: ForkCrashBehavior::RecoverOncePerVersion,
3508 };
3509
3510 SuiNode::check_and_recover_forks(&checkpoint_store, &checkpoint_metrics, Some(&cfg), "v1")
3511 .await
3512 .unwrap();
3513
3514 assert!(
3515 checkpoint_store
3516 .get_checkpoint_fork_detected()
3517 .unwrap()
3518 .is_none()
3519 );
3520 }
3521
3522 #[tokio::test]
3527 async fn test_self_divergence_checkpoint_fork_blocks_recovery() {
3528 let checkpoint_store = CheckpointStore::new_for_tests();
3529 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3530 let seq = 17;
3531 checkpoint_store.set_binary_version("v1");
3532 checkpoint_store
3533 .record_checkpoint_fork_detected(seq, CheckpointDigest::random(), None)
3534 .unwrap();
3535
3536 SuiNode::try_recover_forks(&checkpoint_store, &checkpoint_metrics, "v2").unwrap();
3537
3538 assert!(
3539 checkpoint_store
3540 .get_checkpoint_fork_detected()
3541 .unwrap()
3542 .is_some()
3543 );
3544 assert_eq!(
3545 checkpoint_metrics
3546 .fork_auto_recovery_blocked_uncertified
3547 .get(),
3548 1
3549 );
3550 assert_eq!(checkpoint_metrics.checkpoint_fork_auto_recovered.get(), 0);
3551 }
3552
3553 #[tokio::test]
3557 async fn test_uncertified_transaction_fork_blocks_recovery() {
3558 let checkpoint_store = CheckpointStore::new_for_tests();
3559 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
3560 checkpoint_store.set_binary_version("v1");
3561 checkpoint_store
3562 .record_transaction_fork_detected(
3563 TransactionDigest::random(),
3564 TransactionEffectsDigest::random(),
3565 TransactionEffectsDigest::random(),
3566 None,
3567 )
3568 .unwrap();
3569
3570 SuiNode::try_recover_forks(&checkpoint_store, &checkpoint_metrics, "v2").unwrap();
3571 SuiNode::try_recover_forks(&checkpoint_store, &checkpoint_metrics, "v3").unwrap();
3572
3573 assert!(
3574 checkpoint_store
3575 .get_transaction_fork_detected()
3576 .unwrap()
3577 .is_some()
3578 );
3579 assert_eq!(
3580 checkpoint_metrics
3581 .fork_auto_recovery_blocked_uncertified
3582 .get(),
3583 1
3584 );
3585 }
3586}