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::in_test_configuration;
18use prometheus::Registry;
19use std::collections::{BTreeSet, HashMap, HashSet};
20use std::fmt;
21use std::future::Future;
22use std::path::PathBuf;
23use std::str::FromStr;
24#[cfg(msim)]
25use std::sync::atomic::Ordering;
26use std::sync::{Arc, Weak};
27use std::time::Duration;
28use sui_core::admission_queue::{
29 AdmissionQueueContext, AdmissionQueueManager, AdmissionQueueMetrics,
30};
31use sui_core::authority::ExecutionEnv;
32use sui_core::authority::RandomnessRoundReceiver;
33use sui_core::authority::authority_store_tables::AuthorityPerpetualTablesOptions;
34use sui_core::authority::backpressure::BackpressureManager;
35use sui_core::authority::epoch_start_configuration::EpochFlag;
36use sui_core::authority::execution_time_estimator::ExecutionTimeObserver;
37use sui_core::consensus_adapter::ConsensusClient;
38use sui_core::consensus_manager::UpdatableConsensusClient;
39use sui_core::epoch::randomness::RandomnessManager;
40use sui_core::execution_cache::build_execution_cache;
41use sui_network::endpoint_manager::{AddressSource, EndpointId};
42use sui_network::validator::server::SUI_TLS_SERVER_NAME;
43use sui_types::full_checkpoint_content::Checkpoint;
44use sui_types::node_role::NodeRole;
45
46use sui_core::global_state_hasher::GlobalStateHashMetrics;
47use sui_core::storage::RestReadStore;
48use sui_json_rpc::bridge_api::BridgeReadApi;
49use sui_json_rpc_api::JsonRpcMetrics;
50use sui_network::randomness;
51use sui_rpc_api::RpcMetrics;
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::oneshot;
63use tokio::sync::{Mutex, broadcast, mpsc};
64use tokio::task::JoinHandle;
65use tower::ServiceBuilder;
66use tracing::{Instrument, error_span, info};
67use tracing::{debug, error, warn};
68
69macro_rules! jwk_log {
73 ($($arg:tt)+) => {
74 if in_test_configuration() {
75 debug!($($arg)+);
76 } else {
77 info!($($arg)+);
78 }
79 };
80}
81
82use fastcrypto_zkp::bn254::zk_login::JWK;
83pub use handle::SuiNodeHandle;
84use mysten_metrics::{RegistryService, spawn_monitored_task};
85use mysten_service::server_timing::server_timing_middleware;
86use sui_config::node::{DBCheckpointConfig, RunWithRange};
87use sui_config::node::{ForkCrashBehavior, ForkRecoveryConfig};
88use sui_config::node_config_metrics::NodeConfigMetrics;
89use sui_config::{ConsensusConfig, NodeConfig};
90use sui_core::authority::authority_per_epoch_store::AuthorityPerEpochStore;
91use sui_core::authority::authority_store_tables::AuthorityPerpetualTables;
92use sui_core::authority::epoch_start_configuration::EpochStartConfigTrait;
93use sui_core::authority::epoch_start_configuration::EpochStartConfiguration;
94use sui_core::authority::submitted_transaction_cache::SubmittedTransactionCacheMetrics;
95use sui_core::authority_aggregator::AuthorityAggregator;
96use sui_core::authority_server::{ValidatorService, ValidatorServiceMetrics};
97use sui_core::checkpoints::checkpoint_executor::metrics::CheckpointExecutorMetrics;
98use sui_core::checkpoints::checkpoint_executor::{CheckpointExecutor, StopReason};
99use sui_core::checkpoints::{
100 CheckpointMetrics, CheckpointOutput, CheckpointService, CheckpointStore, LogCheckpointOutput,
101 SendCheckpointToStateSync, SubmitCheckpointToConsensus,
102};
103use sui_core::consensus_adapter::{ConsensusAdapter, ConsensusAdapterMetrics};
104use sui_core::consensus_manager::ConsensusManager;
105use sui_core::consensus_throughput_calculator::ConsensusThroughputCalculator;
106use sui_core::consensus_validator::{SuiTxValidator, SuiTxValidatorMetrics};
107use sui_core::db_checkpoint_handler::DBCheckpointHandler;
108use sui_core::epoch::committee_store::CommitteeStore;
109use sui_core::epoch::consensus_store_pruner::ConsensusStorePruner;
110use sui_core::epoch::epoch_metrics::EpochMetrics;
111use sui_core::epoch::reconfiguration::ReconfigurationInitiator;
112use sui_core::global_state_hasher::GlobalStateHasher;
113use sui_core::jsonrpc_index::IndexStore;
114use sui_core::module_cache_metrics::ResolverMetrics;
115use sui_core::overload_monitor::overload_monitor;
116use sui_core::rpc_index::RpcIndexStore;
117use sui_core::signature_verifier::SignatureVerifierMetrics;
118use sui_core::storage::RocksDbStore;
119use sui_core::transaction_orchestrator::TransactionOrchestrator;
120use sui_core::{
121 authority::{AuthorityState, AuthorityStore},
122 authority_client::NetworkAuthorityClient,
123};
124use sui_json_rpc::JsonRpcServerBuilder;
125use sui_json_rpc::coin_api::CoinReadApi;
126use sui_json_rpc::governance_api::GovernanceReadApi;
127use sui_json_rpc::indexer_api::IndexerApi;
128use sui_json_rpc::move_utils::MoveUtils;
129use sui_json_rpc::read_api::ReadApi;
130use sui_json_rpc::transaction_builder_api::TransactionBuilderApi;
131use sui_json_rpc::transaction_execution_api::TransactionExecutionApi;
132use sui_macros::fail_point;
133use sui_macros::{fail_point_async, replay_log};
134use sui_network::api::ValidatorServer;
135use sui_network::discovery;
136use sui_network::endpoint_manager::EndpointManager;
137use sui_network::state_sync;
138use sui_network::validator::server::ServerBuilder;
139use sui_protocol_config::{Chain, ProtocolConfig, ProtocolVersion};
140use sui_snapshot::uploader::StateSnapshotUploader;
141use sui_storage::{
142 http_key_value_store::HttpKVStore,
143 key_value_store::{FallbackTransactionKVStore, TransactionKeyValueStore},
144 key_value_store_metrics::KeyValueStoreMetrics,
145};
146use sui_types::base_types::{AuthorityName, EpochId};
147use sui_types::committee::Committee;
148use sui_types::crypto::KeypairTraits;
149use sui_types::error::{SuiError, SuiResult};
150use sui_types::messages_consensus::{ConsensusTransaction, check_total_jwk_size};
151use sui_types::sui_system_state::SuiSystemStateTrait;
152use sui_types::sui_system_state::epoch_start_sui_system_state::EpochStartSystemState;
153use sui_types::sui_system_state::epoch_start_sui_system_state::EpochStartSystemStateTrait;
154use sui_types::supported_protocol_versions::SupportedProtocolVersions;
155use typed_store::DBMetrics;
156use typed_store::rocks::default_db_options;
157
158use crate::metrics::{GrpcMetrics, SuiNodeMetrics};
159
160pub mod admin;
161mod handle;
162pub mod metrics;
163
164pub struct ValidatorComponents {
165 validator_server_handle: Option<SpawnOnce>,
166 validator_overload_monitor_handle: Option<JoinHandle<()>>,
167 consensus_manager: Arc<ConsensusManager>,
168 consensus_store_pruner: ConsensusStorePruner,
169 consensus_adapter: Arc<ConsensusAdapter>,
170 checkpoint_metrics: Arc<CheckpointMetrics>,
171 sui_tx_validator_metrics: Arc<SuiTxValidatorMetrics>,
172 admission_queue: Option<AdmissionQueueContext>,
173}
174pub struct P2pComponents {
175 p2p_network: Network,
176 known_peers: HashMap<PeerId, String>,
177 discovery_handle: discovery::Handle,
178 state_sync_handle: state_sync::Handle,
179 randomness_handle: randomness::Handle,
180 endpoint_manager: EndpointManager,
181}
182
183#[cfg(msim)]
184mod simulator {
185 use std::sync::atomic::AtomicBool;
186 use sui_types::error::SuiErrorKind;
187
188 use super::*;
189 pub(super) struct SimState {
190 pub sim_node: sui_simulator::runtime::NodeHandle,
191 pub sim_safe_mode_expected: AtomicBool,
192 _leak_detector: sui_simulator::NodeLeakDetector,
193 }
194
195 impl Default for SimState {
196 fn default() -> Self {
197 Self {
198 sim_node: sui_simulator::runtime::NodeHandle::current(),
199 sim_safe_mode_expected: AtomicBool::new(false),
200 _leak_detector: sui_simulator::NodeLeakDetector::new(),
201 }
202 }
203 }
204
205 type JwkInjector = dyn Fn(AuthorityName, &OIDCProvider) -> SuiResult<Vec<(JwkId, JWK)>>
206 + Send
207 + Sync
208 + 'static;
209
210 fn default_fetch_jwks(
211 _authority: AuthorityName,
212 _provider: &OIDCProvider,
213 ) -> SuiResult<Vec<(JwkId, JWK)>> {
214 use fastcrypto_zkp::bn254::zk_login::parse_jwks;
215 parse_jwks(
217 sui_types::zk_login_util::DEFAULT_JWK_BYTES,
218 &OIDCProvider::Twitch,
219 true,
220 )
221 .map_err(|_| SuiErrorKind::JWKRetrievalError.into())
222 }
223
224 thread_local! {
225 static JWK_INJECTOR: std::cell::RefCell<Arc<JwkInjector>> = std::cell::RefCell::new(Arc::new(default_fetch_jwks));
226 }
227
228 pub(super) fn get_jwk_injector() -> Arc<JwkInjector> {
229 JWK_INJECTOR.with(|injector| injector.borrow().clone())
230 }
231
232 pub fn set_jwk_injector(injector: Arc<JwkInjector>) {
233 JWK_INJECTOR.with(|cell| *cell.borrow_mut() = injector);
234 }
235}
236
237#[cfg(msim)]
238pub use simulator::set_jwk_injector;
239#[cfg(msim)]
240use simulator::*;
241use sui_core::authority::authority_store_pruner::PrunerWatermarks;
242use sui_core::{
243 consensus_handler::ConsensusHandlerInitializer, safe_client::SafeClientMetricsBase,
244};
245
246const DEFAULT_GRPC_CONNECT_TIMEOUT: Duration = Duration::from_secs(60);
247
248pub struct SuiNode {
249 config: NodeConfig,
250 validator_components: Mutex<Option<ValidatorComponents>>,
251
252 #[allow(unused)]
254 http_servers: HttpServers,
255
256 state: Arc<AuthorityState>,
257 transaction_orchestrator: Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>>,
258 registry_service: RegistryService,
259 metrics: Arc<SuiNodeMetrics>,
260 checkpoint_metrics: Arc<CheckpointMetrics>,
261
262 _discovery: discovery::Handle,
263 _connection_monitor_handle: mysten_network::anemo_connection_monitor::ConnectionMonitorHandle,
264 state_sync_handle: state_sync::Handle,
265 randomness_handle: randomness::Handle,
266 checkpoint_store: Arc<CheckpointStore>,
267 global_state_hasher: Mutex<Option<Arc<GlobalStateHasher>>>,
268
269 end_of_epoch_channel: broadcast::Sender<SuiSystemState>,
271
272 endpoint_manager: EndpointManager,
274
275 backpressure_manager: Arc<BackpressureManager>,
276
277 _db_checkpoint_handle: Option<tokio::sync::broadcast::Sender<()>>,
278
279 #[cfg(msim)]
280 sim_state: SimState,
281
282 _state_snapshot_uploader_handle: Option<broadcast::Sender<()>>,
283 shutdown_channel_tx: broadcast::Sender<Option<RunWithRange>>,
285
286 auth_agg: Arc<ArcSwap<AuthorityAggregator<NetworkAuthorityClient>>>,
291
292 subscription_service_checkpoint_sender: Option<tokio::sync::mpsc::Sender<Checkpoint>>,
293}
294
295impl fmt::Debug for SuiNode {
296 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
297 f.debug_struct("SuiNode")
298 .field("name", &self.state.name.concise())
299 .finish()
300 }
301}
302
303static MAX_JWK_KEYS_PER_FETCH: usize = 100;
304
305impl SuiNode {
306 pub async fn start(
307 config: NodeConfig,
308 registry_service: RegistryService,
309 ) -> Result<Arc<SuiNode>> {
310 Self::start_async(
311 config,
312 registry_service,
313 ServerVersion::new("sui-node", "unknown"),
314 )
315 .await
316 }
317
318 fn start_jwk_updater(
319 config: &NodeConfig,
320 metrics: Arc<SuiNodeMetrics>,
321 authority: AuthorityName,
322 epoch_store: Arc<AuthorityPerEpochStore>,
323 consensus_adapter: Arc<ConsensusAdapter>,
324 ) {
325 let epoch = epoch_store.epoch();
326
327 let supported_providers = config
328 .zklogin_oauth_providers
329 .get(&epoch_store.get_chain_identifier().chain())
330 .unwrap_or(&BTreeSet::new())
331 .iter()
332 .map(|s| OIDCProvider::from_str(s).expect("Invalid provider string"))
333 .collect::<Vec<_>>();
334
335 let fetch_interval = Duration::from_secs(config.jwk_fetch_interval_seconds);
336
337 info!(
338 ?fetch_interval,
339 "Starting JWK updater tasks with supported providers: {:?}", supported_providers
340 );
341
342 fn validate_jwk(
343 metrics: &Arc<SuiNodeMetrics>,
344 provider: &OIDCProvider,
345 id: &JwkId,
346 jwk: &JWK,
347 ) -> bool {
348 let Ok(iss_provider) = OIDCProvider::from_iss(&id.iss) else {
349 warn!(
350 "JWK iss {:?} (retrieved from {:?}) is not a valid provider",
351 id.iss, provider
352 );
353 metrics
354 .invalid_jwks
355 .with_label_values(&[&provider.to_string()])
356 .inc();
357 return false;
358 };
359
360 if iss_provider != *provider {
361 warn!(
362 "JWK iss {:?} (retrieved from {:?}) does not match provider {:?}",
363 id.iss, provider, iss_provider
364 );
365 metrics
366 .invalid_jwks
367 .with_label_values(&[&provider.to_string()])
368 .inc();
369 return false;
370 }
371
372 if !check_total_jwk_size(id, jwk) {
373 warn!("JWK {:?} (retrieved from {:?}) is too large", id, provider);
374 metrics
375 .invalid_jwks
376 .with_label_values(&[&provider.to_string()])
377 .inc();
378 return false;
379 }
380
381 true
382 }
383
384 for p in supported_providers.into_iter() {
393 let provider_str = p.to_string();
394 let epoch_store = epoch_store.clone();
395 let consensus_adapter = consensus_adapter.clone();
396 let metrics = metrics.clone();
397 spawn_monitored_task!(epoch_store.clone().within_alive_epoch(
398 async move {
399 let mut seen = HashSet::new();
402 loop {
403 jwk_log!("fetching JWK for provider {:?}", p);
404 metrics.jwk_requests.with_label_values(&[&provider_str]).inc();
405 match Self::fetch_jwks(authority, &p).await {
406 Err(e) => {
407 metrics.jwk_request_errors.with_label_values(&[&provider_str]).inc();
408 warn!("Error when fetching JWK for provider {:?} {:?}", p, e);
409 tokio::time::sleep(Duration::from_secs(30)).await;
411 continue;
412 }
413 Ok(mut keys) => {
414 metrics.total_jwks
415 .with_label_values(&[&provider_str])
416 .inc_by(keys.len() as u64);
417
418 keys.retain(|(id, jwk)| {
419 validate_jwk(&metrics, &p, id, jwk) &&
420 !epoch_store.jwk_active_in_current_epoch(id, jwk) &&
421 seen.insert((id.clone(), jwk.clone()))
422 });
423
424 metrics.unique_jwks
425 .with_label_values(&[&provider_str])
426 .inc_by(keys.len() as u64);
427
428 if keys.len() > MAX_JWK_KEYS_PER_FETCH {
431 warn!("Provider {:?} sent too many JWKs, only the first {} will be used", p, MAX_JWK_KEYS_PER_FETCH);
432 keys.truncate(MAX_JWK_KEYS_PER_FETCH);
433 }
434
435 for (id, jwk) in keys.into_iter() {
436 jwk_log!("Submitting JWK to consensus: {:?}", id);
437
438 let txn = ConsensusTransaction::new_jwk_fetched(authority, id, jwk);
439 consensus_adapter.submit(txn, None, &epoch_store, None, None)
440 .tap_err(|e| warn!("Error when submitting JWKs to consensus {:?}", e))
441 .ok();
442 }
443 }
444 }
445 tokio::time::sleep(fetch_interval).await;
446 }
447 }
448 .instrument(error_span!("jwk_updater_task", epoch)),
449 ));
450 }
451 }
452
453 pub async fn start_async(
454 config: NodeConfig,
455 registry_service: RegistryService,
456 server_version: ServerVersion,
457 ) -> Result<Arc<SuiNode>> {
458 NodeConfigMetrics::new(®istry_service.default_registry()).record_metrics(&config);
459 let mut config = config.clone();
460 if config.supported_protocol_versions.is_none() {
461 info!(
462 "populating config.supported_protocol_versions with default {:?}",
463 SupportedProtocolVersions::SYSTEM_DEFAULT
464 );
465 config.supported_protocol_versions = Some(SupportedProtocolVersions::SYSTEM_DEFAULT);
466 }
467
468 let run_with_range = config.run_with_range;
469 let prometheus_registry = registry_service.default_registry();
470 let node_role = config.intended_node_role();
471
472 info!(node =? config.protocol_public_key(),
473 "Initializing sui-node listening on {} with role {:?}", config.network_address, node_role
474 );
475
476 DBMetrics::init(registry_service.clone());
478
479 typed_store::init_write_sync(config.enable_db_sync_to_disk);
481
482 mysten_metrics::init_metrics(&prometheus_registry);
484 #[cfg(not(msim))]
486 mysten_metrics::thread_stall_monitor::start_thread_stall_monitor();
487
488 let genesis = config.genesis()?.clone();
489
490 let secret = Arc::pin(config.protocol_key_pair().copy());
491 let genesis_committee = genesis.committee();
492 let committee_store = Arc::new(CommitteeStore::new(
493 config.db_path().join("epochs"),
494 &genesis_committee,
495 None,
496 ));
497
498 let pruner_watermarks = Arc::new(PrunerWatermarks::default());
499 let checkpoint_store = CheckpointStore::new(
500 &config.db_path().join("checkpoints"),
501 pruner_watermarks.clone(),
502 );
503 let checkpoint_metrics = CheckpointMetrics::new(®istry_service.default_registry());
504
505 if node_role.runs_consensus() {
506 Self::check_and_recover_forks(
507 &checkpoint_store,
508 &checkpoint_metrics,
509 config.fork_recovery.as_ref(),
510 )
511 .await?;
512 }
513
514 let enable_write_stall = config
516 .enable_db_write_stall
517 .unwrap_or(node_role.runs_consensus());
518 let perpetual_tables_options = AuthorityPerpetualTablesOptions {
519 enable_write_stall,
520 is_validator: node_role.is_validator(),
521 };
522 let perpetual_tables = Arc::new(AuthorityPerpetualTables::open(
523 &config.db_store_path(),
524 Some(perpetual_tables_options),
525 Some(pruner_watermarks.epoch_id.clone()),
526 ));
527 let is_genesis = perpetual_tables
528 .database_is_empty()
529 .expect("Database read should not fail at init.");
530
531 let backpressure_manager =
532 BackpressureManager::new_from_checkpoint_store(&checkpoint_store);
533
534 let store =
535 AuthorityStore::open(perpetual_tables, &genesis, &config, &prometheus_registry).await?;
536
537 let cur_epoch = store.get_recovery_epoch_at_restart()?;
538 let committee = committee_store
539 .get_committee(&cur_epoch)?
540 .expect("Committee of the current epoch must exist");
541 let epoch_start_configuration = store
542 .get_epoch_start_configuration()?
543 .expect("EpochStartConfiguration of the current epoch must exist");
544 let cache_metrics = Arc::new(ResolverMetrics::new(&prometheus_registry));
545 let signature_verifier_metrics = SignatureVerifierMetrics::new(&prometheus_registry);
546
547 let cache_traits = build_execution_cache(
548 &config.execution_cache,
549 &prometheus_registry,
550 &store,
551 backpressure_manager.clone(),
552 );
553
554 let auth_agg = {
555 let safe_client_metrics_base = SafeClientMetricsBase::new(&prometheus_registry);
556 Arc::new(ArcSwap::new(Arc::new(
557 AuthorityAggregator::new_from_epoch_start_state(
558 epoch_start_configuration.epoch_start_state(),
559 &committee_store,
560 safe_client_metrics_base,
561 ),
562 )))
563 };
564
565 let chain_id = ChainIdentifier::from(*genesis.checkpoint().digest());
566 let chain = match config.chain_override_for_testing {
567 Some(chain) => chain,
568 None => ChainIdentifier::from(*genesis.checkpoint().digest()).chain(),
569 };
570
571 let highest_executed_checkpoint = checkpoint_store
572 .get_highest_executed_checkpoint_seq_number()
573 .expect("checkpoint store read cannot fail")
574 .unwrap_or(0);
575
576 let previous_epoch_last_checkpoint = if cur_epoch == 0 {
577 0
578 } else {
579 checkpoint_store
580 .get_epoch_last_checkpoint_seq_number(cur_epoch - 1)
581 .expect("checkpoint store read cannot fail")
582 .unwrap_or(highest_executed_checkpoint)
583 };
584
585 let epoch_options = default_db_options().optimize_db_for_write_throughput(4, false);
586 let epoch_store = AuthorityPerEpochStore::new(
587 config.protocol_public_key(),
588 committee.clone(),
589 &config.db_store_path(),
590 Some(epoch_options.options),
591 EpochMetrics::new(®istry_service.default_registry()),
592 epoch_start_configuration,
593 cache_traits.backing_package_store.clone(),
594 cache_traits.object_store.clone(),
595 cache_metrics,
596 signature_verifier_metrics,
597 &config.expensive_safety_check_config,
598 (chain_id, chain),
599 highest_executed_checkpoint,
600 previous_epoch_last_checkpoint,
601 Arc::new(SubmittedTransactionCacheMetrics::new(
602 ®istry_service.default_registry(),
603 )),
604 config.fullnode_sync_mode,
605 )?;
606
607 info!("created epoch store");
608
609 replay_log!(
610 "Beginning replay run. Epoch: {:?}, Protocol config: {:?}",
611 epoch_store.epoch(),
612 epoch_store.protocol_config()
613 );
614
615 if is_genesis {
617 info!("checking SUI conservation at genesis");
618 cache_traits
623 .reconfig_api
624 .expensive_check_sui_conservation(&epoch_store)
625 .expect("SUI conservation check cannot fail at genesis");
626 }
627
628 let effective_buffer_stake = epoch_store.get_effective_buffer_stake_bps();
629 let default_buffer_stake = epoch_store
630 .protocol_config()
631 .buffer_stake_for_protocol_upgrade_bps();
632 if effective_buffer_stake != default_buffer_stake {
633 warn!(
634 ?effective_buffer_stake,
635 ?default_buffer_stake,
636 "buffer_stake_for_protocol_upgrade_bps is currently overridden"
637 );
638 }
639
640 checkpoint_store.insert_genesis_checkpoint(
641 genesis.checkpoint(),
642 genesis.checkpoint_contents().clone(),
643 &epoch_store,
644 );
645
646 info!("creating state sync store");
647 let state_sync_store = RocksDbStore::new(
648 cache_traits.clone(),
649 committee_store.clone(),
650 checkpoint_store.clone(),
651 );
652
653 let index_store =
654 if node_role.should_enable_index_processing() && config.enable_index_processing {
655 info!("creating jsonrpc index store");
656 Some(Arc::new(IndexStore::new(
657 config.db_path().join("indexes"),
658 &prometheus_registry,
659 epoch_store
660 .protocol_config()
661 .max_move_identifier_len_as_option(),
662 config.remove_deprecated_tables,
663 )))
664 } else {
665 None
666 };
667
668 let rpc_index = if node_role.should_enable_index_processing()
669 && config.rpc().is_some_and(|rpc| rpc.enable_indexing())
670 {
671 info!("creating rpc index store");
672 Some(Arc::new(
673 RpcIndexStore::new(
674 &config.db_path(),
675 &store,
676 &checkpoint_store,
677 &epoch_store,
678 &cache_traits.backing_package_store,
679 pruner_watermarks.checkpoint_id.clone(),
680 config.rpc().cloned().unwrap_or_default(),
681 )
682 .await,
683 ))
684 } else {
685 None
686 };
687
688 let chain_identifier = epoch_store.get_chain_identifier();
689
690 info!("creating archive reader");
691 let (randomness_tx, randomness_rx) = mpsc::channel(
693 config
694 .p2p_config
695 .randomness
696 .clone()
697 .unwrap_or_default()
698 .mailbox_capacity(),
699 );
700 let P2pComponents {
701 p2p_network,
702 known_peers,
703 discovery_handle,
704 state_sync_handle,
705 randomness_handle,
706 endpoint_manager,
707 } = Self::create_p2p_network(
708 &config,
709 state_sync_store.clone(),
710 chain_identifier,
711 randomness_tx,
712 &prometheus_registry,
713 )?;
714
715 for peer in &config.p2p_config.peer_address_overrides {
717 endpoint_manager
718 .update_endpoint(
719 EndpointId::P2p(peer.peer_id),
720 AddressSource::Config,
721 peer.addresses.clone(),
722 )
723 .expect("Updating peer address overrides should not fail");
724 }
725
726 update_peer_addresses(&config, &endpoint_manager, epoch_store.epoch_start_state());
728
729 info!("start snapshot upload");
730 let state_snapshot_handle = Self::start_state_snapshot(
732 &config,
733 &prometheus_registry,
734 checkpoint_store.clone(),
735 chain_identifier,
736 )?;
737
738 info!("start db checkpoint");
740 let (db_checkpoint_config, db_checkpoint_handle) = Self::start_db_checkpoint(
741 &config,
742 &prometheus_registry,
743 state_snapshot_handle.is_some(),
744 )?;
745
746 if !epoch_store
747 .protocol_config()
748 .simplified_unwrap_then_delete()
749 {
750 config
752 .authority_store_pruning_config
753 .set_killswitch_tombstone_pruning(true);
754 }
755
756 let authority_name = config.protocol_public_key();
757
758 info!("create authority state");
759 let state = AuthorityState::new(
760 authority_name,
761 secret,
762 config.supported_protocol_versions.unwrap(),
763 store.clone(),
764 cache_traits.clone(),
765 epoch_store.clone(),
766 committee_store.clone(),
767 index_store.clone(),
768 rpc_index,
769 checkpoint_store.clone(),
770 &prometheus_registry,
771 genesis.objects(),
772 &db_checkpoint_config,
773 config.clone(),
774 chain_identifier,
775 config.policy_config.clone(),
776 config.firewall_config.clone(),
777 pruner_watermarks,
778 )
779 .await;
780 if epoch_store.epoch() == 0 {
782 let txn = &genesis.transaction();
783 let span = error_span!("genesis_txn", tx_digest = ?txn.digest());
784 let transaction =
785 sui_types::executable_transaction::VerifiedExecutableTransaction::new_unchecked(
786 sui_types::executable_transaction::ExecutableTransaction::new_from_data_and_sig(
787 genesis.transaction().data().clone(),
788 sui_types::executable_transaction::CertificateProof::Checkpoint(0, 0),
789 ),
790 );
791 state
792 .try_execute_immediately(&transaction, ExecutionEnv::new(), &epoch_store)
793 .instrument(span)
794 .await
795 .unwrap();
796 }
797
798 RandomnessRoundReceiver::spawn(state.clone(), randomness_rx);
800
801 let (end_of_epoch_channel, end_of_epoch_receiver) =
802 broadcast::channel(config.end_of_epoch_broadcast_channel_capacity);
803
804 let transaction_orchestrator = if node_role.is_fullnode() && run_with_range.is_none() {
805 Some(Arc::new(TransactionOrchestrator::new_with_auth_aggregator(
806 auth_agg.load_full(),
807 state.clone(),
808 end_of_epoch_receiver,
809 &config.db_path(),
810 &prometheus_registry,
811 &config,
812 )))
813 } else {
814 None
815 };
816
817 let (http_servers, subscription_service_checkpoint_sender) = build_http_servers(
818 state.clone(),
819 state_sync_store,
820 &transaction_orchestrator.clone(),
821 &config,
822 &prometheus_registry,
823 server_version,
824 node_role,
825 )
826 .await?;
827
828 let global_state_hasher = Arc::new(GlobalStateHasher::new(
829 cache_traits.global_state_hash_store.clone(),
830 GlobalStateHashMetrics::new(&prometheus_registry),
831 ));
832
833 let network_connection_metrics = mysten_network::quinn_metrics::QuinnConnectionMetrics::new(
834 "sui",
835 ®istry_service.default_registry(),
836 );
837
838 let connection_monitor_handle =
839 mysten_network::anemo_connection_monitor::AnemoConnectionMonitor::spawn(
840 p2p_network.downgrade(),
841 Arc::new(network_connection_metrics),
842 known_peers,
843 );
844
845 let sui_node_metrics = Arc::new(SuiNodeMetrics::new(®istry_service.default_registry()));
846
847 sui_node_metrics
848 .binary_max_protocol_version
849 .set(ProtocolVersion::MAX.as_u64() as i64);
850 sui_node_metrics
851 .configured_max_protocol_version
852 .set(config.supported_protocol_versions.unwrap().max.as_u64() as i64);
853
854 let node_role = epoch_store.node_role();
855 let validator_components = if node_role.runs_consensus() {
856 let mut components = Self::construct_validator_components(
857 config.clone(),
858 state.clone(),
859 committee,
860 epoch_store.clone(),
861 checkpoint_store.clone(),
862 state_sync_handle.clone(),
863 randomness_handle.clone(),
864 Arc::downgrade(&global_state_hasher),
865 backpressure_manager.clone(),
866 ®istry_service,
867 sui_node_metrics.clone(),
868 checkpoint_metrics.clone(),
869 node_role,
870 )
871 .await?;
872
873 if node_role.is_validator() {
874 components
875 .consensus_adapter
876 .recover_end_of_publish(&epoch_store);
877
878 components.validator_server_handle = Some(
880 components
881 .validator_server_handle
882 .take()
883 .unwrap()
884 .start()
885 .await,
886 );
887
888 endpoint_manager
890 .set_consensus_address_updater(components.consensus_manager.clone());
891 } else {
892 info!("Starting node as Observer — connecting to configured peers");
893 }
894
895 Some(components)
896 } else {
897 None
898 };
899
900 let (shutdown_channel, _) = broadcast::channel::<Option<RunWithRange>>(1);
902
903 let node = Self {
904 config,
905 validator_components: Mutex::new(validator_components),
906 http_servers,
907 state,
908 transaction_orchestrator,
909 registry_service,
910 metrics: sui_node_metrics,
911 checkpoint_metrics,
912
913 _discovery: discovery_handle,
914 _connection_monitor_handle: connection_monitor_handle,
915 state_sync_handle,
916 randomness_handle,
917 checkpoint_store,
918 global_state_hasher: Mutex::new(Some(global_state_hasher)),
919 end_of_epoch_channel,
920 endpoint_manager,
921 backpressure_manager,
922
923 _db_checkpoint_handle: db_checkpoint_handle,
924
925 #[cfg(msim)]
926 sim_state: Default::default(),
927
928 _state_snapshot_uploader_handle: state_snapshot_handle,
929 shutdown_channel_tx: shutdown_channel,
930
931 auth_agg,
932 subscription_service_checkpoint_sender,
933 };
934
935 info!("SuiNode started!");
936 let node = Arc::new(node);
937 let node_copy = node.clone();
938 spawn_monitored_task!(async move {
939 let result = Self::monitor_reconfiguration(node_copy, epoch_store).await;
940 if let Err(error) = result {
941 warn!("Reconfiguration finished with error {:?}", error);
942 }
943 });
944
945 Ok(node)
946 }
947
948 pub fn subscribe_to_epoch_change(&self) -> broadcast::Receiver<SuiSystemState> {
949 self.end_of_epoch_channel.subscribe()
950 }
951
952 pub fn subscribe_to_shutdown_channel(&self) -> broadcast::Receiver<Option<RunWithRange>> {
953 self.shutdown_channel_tx.subscribe()
954 }
955
956 pub fn current_epoch_for_testing(&self) -> EpochId {
957 self.state.current_epoch_for_testing()
958 }
959
960 pub fn db_checkpoint_path(&self) -> PathBuf {
961 self.config.db_checkpoint_path()
962 }
963
964 pub async fn close_epoch(&self, epoch_store: &Arc<AuthorityPerEpochStore>) -> SuiResult {
966 info!("close_epoch (current epoch = {})", epoch_store.epoch());
967 self.validator_components
968 .lock()
969 .await
970 .as_ref()
971 .ok_or_else(|| SuiError::from("Node is not a validator"))?
972 .consensus_adapter
973 .close_epoch(epoch_store);
974 Ok(())
975 }
976
977 pub fn clear_override_protocol_upgrade_buffer_stake(&self, epoch: EpochId) -> SuiResult {
978 self.state
979 .clear_override_protocol_upgrade_buffer_stake(epoch)
980 }
981
982 pub fn set_override_protocol_upgrade_buffer_stake(
983 &self,
984 epoch: EpochId,
985 buffer_stake_bps: u64,
986 ) -> SuiResult {
987 self.state
988 .set_override_protocol_upgrade_buffer_stake(epoch, buffer_stake_bps)
989 }
990
991 pub async fn close_epoch_for_testing(&self) -> SuiResult {
994 let epoch_store = self.state.epoch_store_for_testing();
995 self.close_epoch(&epoch_store).await
996 }
997
998 fn start_state_snapshot(
999 config: &NodeConfig,
1000 prometheus_registry: &Registry,
1001 checkpoint_store: Arc<CheckpointStore>,
1002 chain_identifier: ChainIdentifier,
1003 ) -> Result<Option<tokio::sync::broadcast::Sender<()>>> {
1004 if let Some(remote_store_config) = &config.state_snapshot_write_config.object_store_config {
1005 let snapshot_uploader = StateSnapshotUploader::new(
1006 &config.db_checkpoint_path(),
1007 &config.snapshot_path(),
1008 remote_store_config.clone(),
1009 60,
1010 prometheus_registry,
1011 checkpoint_store,
1012 chain_identifier,
1013 config.state_snapshot_write_config.archive_interval_epochs,
1014 )?;
1015 Ok(Some(snapshot_uploader.start()))
1016 } else {
1017 Ok(None)
1018 }
1019 }
1020
1021 fn start_db_checkpoint(
1022 config: &NodeConfig,
1023 prometheus_registry: &Registry,
1024 state_snapshot_enabled: bool,
1025 ) -> Result<(
1026 DBCheckpointConfig,
1027 Option<tokio::sync::broadcast::Sender<()>>,
1028 )> {
1029 let checkpoint_path = Some(
1030 config
1031 .db_checkpoint_config
1032 .checkpoint_path
1033 .clone()
1034 .unwrap_or_else(|| config.db_checkpoint_path()),
1035 );
1036 let db_checkpoint_config = if config.db_checkpoint_config.checkpoint_path.is_none() {
1037 DBCheckpointConfig {
1038 checkpoint_path,
1039 perform_db_checkpoints_at_epoch_end: if state_snapshot_enabled {
1040 true
1041 } else {
1042 config
1043 .db_checkpoint_config
1044 .perform_db_checkpoints_at_epoch_end
1045 },
1046 ..config.db_checkpoint_config.clone()
1047 }
1048 } else {
1049 config.db_checkpoint_config.clone()
1050 };
1051
1052 match (
1053 db_checkpoint_config.object_store_config.as_ref(),
1054 state_snapshot_enabled,
1055 ) {
1056 (None, false) => Ok((db_checkpoint_config, None)),
1061 (_, _) => {
1062 let handler = DBCheckpointHandler::new(
1063 &db_checkpoint_config.checkpoint_path.clone().unwrap(),
1064 db_checkpoint_config.object_store_config.as_ref(),
1065 60,
1066 db_checkpoint_config
1067 .prune_and_compact_before_upload
1068 .unwrap_or(true),
1069 config.authority_store_pruning_config.clone(),
1070 prometheus_registry,
1071 state_snapshot_enabled,
1072 )?;
1073 Ok((
1074 db_checkpoint_config,
1075 Some(DBCheckpointHandler::start(handler)),
1076 ))
1077 }
1078 }
1079 }
1080
1081 fn create_p2p_network(
1082 config: &NodeConfig,
1083 state_sync_store: RocksDbStore,
1084 chain_identifier: ChainIdentifier,
1085 randomness_tx: mpsc::Sender<(EpochId, RandomnessRound, Vec<u8>)>,
1086 prometheus_registry: &Registry,
1087 ) -> Result<P2pComponents> {
1088 let mut p2p_config = config.p2p_config.clone();
1089 {
1090 let disc = p2p_config.discovery.get_or_insert_with(Default::default);
1091 if disc.peer_addr_store_path.is_none() {
1092 disc.peer_addr_store_path =
1093 Some(config.db_path().join("discovery_peer_cache.yaml"));
1094 }
1095 }
1096 let mut discovery_builder = discovery::Builder::new().config(p2p_config.clone());
1097 if let Some(consensus_config) = &config.consensus_config {
1098 let effective_addr = consensus_config
1099 .external_address
1100 .as_ref()
1101 .or(consensus_config.listen_address.as_ref());
1102 if let Some(addr) = effective_addr {
1103 discovery_builder = discovery_builder.consensus_external_address(addr.clone());
1104 }
1105 }
1106 let (discovery, discovery_server, endpoint_manager) = discovery_builder.build();
1107 let discovery_sender = discovery.sender();
1108
1109 let (state_sync, state_sync_router) = state_sync::Builder::new()
1110 .config(config.p2p_config.state_sync.clone().unwrap_or_default())
1111 .store(state_sync_store)
1112 .archive_config(config.archive_reader_config())
1113 .discovery_sender(discovery_sender)
1114 .with_metrics(prometheus_registry)
1115 .build();
1116
1117 let discovery_config = config.p2p_config.discovery.clone().unwrap_or_default();
1118 let known_peers: HashMap<PeerId, String> = discovery_config
1119 .allowlisted_peers
1120 .clone()
1121 .into_iter()
1122 .map(|ap| (ap.peer_id, "allowlisted_peer".to_string()))
1123 .chain(config.p2p_config.seed_peers.iter().filter_map(|peer| {
1124 peer.peer_id
1125 .map(|peer_id| (peer_id, "seed_peer".to_string()))
1126 }))
1127 .collect();
1128
1129 let (randomness, randomness_router) =
1130 randomness::Builder::new(config.protocol_public_key(), randomness_tx)
1131 .config(config.p2p_config.randomness.clone().unwrap_or_default())
1132 .with_metrics(prometheus_registry)
1133 .build();
1134
1135 let p2p_network = {
1136 let routes = anemo::Router::new()
1137 .add_rpc_service(discovery_server)
1138 .merge(state_sync_router);
1139 let routes = routes.merge(randomness_router);
1140
1141 let inbound_network_metrics =
1142 mysten_network::metrics::NetworkMetrics::new("sui", "inbound", prometheus_registry);
1143 let outbound_network_metrics = mysten_network::metrics::NetworkMetrics::new(
1144 "sui",
1145 "outbound",
1146 prometheus_registry,
1147 );
1148
1149 let service = ServiceBuilder::new()
1150 .layer(
1151 TraceLayer::new_for_server_errors()
1152 .make_span_with(DefaultMakeSpan::new().level(tracing::Level::INFO))
1153 .on_failure(DefaultOnFailure::new().level(tracing::Level::WARN)),
1154 )
1155 .layer(CallbackLayer::new(
1156 mysten_network::metrics::MetricsMakeCallbackHandler::new(
1157 Arc::new(inbound_network_metrics),
1158 config.p2p_config.excessive_message_size(),
1159 ),
1160 ))
1161 .service(routes);
1162
1163 let outbound_layer = ServiceBuilder::new()
1164 .layer(
1165 TraceLayer::new_for_client_and_server_errors()
1166 .make_span_with(DefaultMakeSpan::new().level(tracing::Level::INFO))
1167 .on_failure(DefaultOnFailure::new().level(tracing::Level::WARN)),
1168 )
1169 .layer(CallbackLayer::new(
1170 mysten_network::metrics::MetricsMakeCallbackHandler::new(
1171 Arc::new(outbound_network_metrics),
1172 config.p2p_config.excessive_message_size(),
1173 ),
1174 ))
1175 .into_inner();
1176
1177 let mut anemo_config = config.p2p_config.anemo_config.clone().unwrap_or_default();
1178 anemo_config.max_request_frame_size = Some(1 << 20);
1181 anemo_config.max_response_frame_size = Some(128 << 20);
1184
1185 let mut quic_config = anemo_config.quic.unwrap_or_default();
1188 if quic_config.socket_send_buffer_size.is_none() {
1189 quic_config.socket_send_buffer_size = Some(20 << 20);
1190 }
1191 if quic_config.socket_receive_buffer_size.is_none() {
1192 quic_config.socket_receive_buffer_size = Some(20 << 20);
1193 }
1194 quic_config.allow_failed_socket_buffer_size_setting = true;
1195
1196 if quic_config.max_concurrent_bidi_streams.is_none() {
1199 quic_config.max_concurrent_bidi_streams = Some(500);
1200 }
1201 if quic_config.max_concurrent_uni_streams.is_none() {
1202 quic_config.max_concurrent_uni_streams = Some(500);
1203 }
1204 if quic_config.stream_receive_window.is_none() {
1205 quic_config.stream_receive_window = Some(100 << 20);
1206 }
1207 if quic_config.receive_window.is_none() {
1208 quic_config.receive_window = Some(200 << 20);
1209 }
1210 if quic_config.send_window.is_none() {
1211 quic_config.send_window = Some(200 << 20);
1212 }
1213 if quic_config.crypto_buffer_size.is_none() {
1214 quic_config.crypto_buffer_size = Some(1 << 20);
1215 }
1216 if quic_config.max_idle_timeout_ms.is_none() {
1217 quic_config.max_idle_timeout_ms = Some(10_000);
1218 }
1219 if quic_config.keep_alive_interval_ms.is_none() {
1220 quic_config.keep_alive_interval_ms = Some(5_000);
1221 }
1222 anemo_config.quic = Some(quic_config);
1223
1224 let server_name = format!("sui-{}", chain_identifier);
1225 let network = Network::bind(config.p2p_config.listen_address)
1226 .server_name(&server_name)
1227 .private_key(config.network_key_pair().copy().private().0.to_bytes())
1228 .config(anemo_config)
1229 .outbound_request_layer(outbound_layer)
1230 .start(service)?;
1231 info!(
1232 server_name = server_name,
1233 "P2p network started on {}",
1234 network.local_addr()
1235 );
1236
1237 network
1238 };
1239
1240 let discovery_handle =
1241 discovery.start(p2p_network.clone(), config.network_key_pair().copy());
1242 let state_sync_handle = state_sync.start(p2p_network.clone());
1243 let randomness_handle = randomness.start(p2p_network.clone());
1244
1245 Ok(P2pComponents {
1246 p2p_network,
1247 known_peers,
1248 discovery_handle,
1249 state_sync_handle,
1250 randomness_handle,
1251 endpoint_manager,
1252 })
1253 }
1254
1255 async fn construct_validator_components(
1256 config: NodeConfig,
1257 state: Arc<AuthorityState>,
1258 committee: Arc<Committee>,
1259 epoch_store: Arc<AuthorityPerEpochStore>,
1260 checkpoint_store: Arc<CheckpointStore>,
1261 state_sync_handle: state_sync::Handle,
1262 randomness_handle: randomness::Handle,
1263 global_state_hasher: Weak<GlobalStateHasher>,
1264 backpressure_manager: Arc<BackpressureManager>,
1265 registry_service: &RegistryService,
1266 sui_node_metrics: Arc<SuiNodeMetrics>,
1267 checkpoint_metrics: Arc<CheckpointMetrics>,
1268 node_role: NodeRole,
1269 ) -> Result<ValidatorComponents> {
1270 let mut config_clone = config.clone();
1271 let consensus_config = config_clone
1272 .consensus_config
1273 .as_mut()
1274 .ok_or_else(|| anyhow!("Node is missing consensus config"))?;
1275
1276 let client = Arc::new(UpdatableConsensusClient::new());
1277 let inflight_slot_freed_notify = Arc::new(tokio::sync::Notify::new());
1278 let consensus_adapter = Arc::new(Self::construct_consensus_adapter(
1279 &committee,
1280 consensus_config,
1281 state.name,
1282 ®istry_service.default_registry(),
1283 client.clone(),
1284 checkpoint_store.clone(),
1285 inflight_slot_freed_notify.clone(),
1286 ));
1287
1288 let consensus_manager = Arc::new(ConsensusManager::new(
1289 &config,
1290 consensus_config,
1291 registry_service,
1292 client,
1293 node_role,
1294 ));
1295
1296 let consensus_store_pruner = ConsensusStorePruner::new(
1298 consensus_manager.get_storage_base_path(),
1299 consensus_config.db_retention_epochs(),
1300 consensus_config.db_pruner_period(),
1301 ®istry_service.default_registry(),
1302 );
1303
1304 let sui_tx_validator_metrics =
1305 SuiTxValidatorMetrics::new(®istry_service.default_registry());
1306
1307 let (validator_server_handle, admission_queue) = if node_role.is_validator() {
1308 let (handle, queue) = Self::start_grpc_validator_service(
1309 &config,
1310 state.clone(),
1311 consensus_adapter.clone(),
1312 epoch_store.clone(),
1313 ®istry_service.default_registry(),
1314 inflight_slot_freed_notify,
1315 )
1316 .await?;
1317 (Some(handle), queue)
1318 } else {
1319 (None, None)
1320 };
1321
1322 let validator_overload_monitor_handle = if node_role.is_validator()
1325 && config
1326 .authority_overload_config
1327 .max_load_shedding_percentage
1328 > 0
1329 {
1330 let authority_state = Arc::downgrade(&state);
1331 let overload_config = config.authority_overload_config.clone();
1332 fail_point!("starting_overload_monitor");
1333 Some(spawn_monitored_task!(overload_monitor(
1334 authority_state,
1335 overload_config,
1336 )))
1337 } else {
1338 None
1339 };
1340
1341 Self::start_epoch_specific_validator_components(
1342 &config,
1343 state.clone(),
1344 consensus_adapter,
1345 checkpoint_store,
1346 epoch_store,
1347 state_sync_handle,
1348 randomness_handle,
1349 consensus_manager,
1350 consensus_store_pruner,
1351 global_state_hasher,
1352 backpressure_manager,
1353 validator_server_handle,
1354 validator_overload_monitor_handle,
1355 checkpoint_metrics,
1356 sui_node_metrics,
1357 sui_tx_validator_metrics,
1358 admission_queue,
1359 node_role,
1360 )
1361 .await
1362 }
1363
1364 async fn start_epoch_specific_validator_components(
1365 config: &NodeConfig,
1366 state: Arc<AuthorityState>,
1367 consensus_adapter: Arc<ConsensusAdapter>,
1368 checkpoint_store: Arc<CheckpointStore>,
1369 epoch_store: Arc<AuthorityPerEpochStore>,
1370 state_sync_handle: state_sync::Handle,
1371 randomness_handle: randomness::Handle,
1372 consensus_manager: Arc<ConsensusManager>,
1373 consensus_store_pruner: ConsensusStorePruner,
1374 state_hasher: Weak<GlobalStateHasher>,
1375 backpressure_manager: Arc<BackpressureManager>,
1376 validator_server_handle: Option<SpawnOnce>,
1377 validator_overload_monitor_handle: Option<JoinHandle<()>>,
1378 checkpoint_metrics: Arc<CheckpointMetrics>,
1379 sui_node_metrics: Arc<SuiNodeMetrics>,
1380 sui_tx_validator_metrics: Arc<SuiTxValidatorMetrics>,
1381 admission_queue: Option<AdmissionQueueContext>,
1382 node_role: NodeRole,
1383 ) -> Result<ValidatorComponents> {
1384 let checkpoint_service = Self::build_checkpoint_service(
1385 config,
1386 consensus_adapter.clone(),
1387 checkpoint_store.clone(),
1388 epoch_store.clone(),
1389 state.clone(),
1390 state_sync_handle,
1391 state_hasher,
1392 checkpoint_metrics.clone(),
1393 node_role,
1394 );
1395
1396 if node_role.runs_consensus() && epoch_store.randomness_state_enabled() {
1397 let randomness_manager = RandomnessManager::try_new(
1398 Arc::downgrade(&epoch_store),
1399 Box::new(consensus_adapter.clone()),
1400 randomness_handle,
1401 config.protocol_key_pair(),
1402 )
1403 .await;
1404 if let Some(randomness_manager) = randomness_manager {
1405 epoch_store
1406 .set_randomness_manager(randomness_manager)
1407 .await?;
1408 }
1409 }
1410
1411 if node_role.is_validator() {
1412 ExecutionTimeObserver::spawn(
1413 epoch_store.clone(),
1414 Box::new(consensus_adapter.clone()),
1415 config
1416 .execution_time_observer_config
1417 .clone()
1418 .unwrap_or_default(),
1419 );
1420 }
1421
1422 let throughput_calculator = Arc::new(ConsensusThroughputCalculator::new(
1423 None,
1424 state.metrics.clone(),
1425 ));
1426
1427 let consensus_handler_initializer = ConsensusHandlerInitializer::new(
1428 state.clone(),
1429 checkpoint_service.clone(),
1430 epoch_store.clone(),
1431 consensus_adapter.clone(),
1432 throughput_calculator,
1433 backpressure_manager,
1434 config.congestion_log.clone(),
1435 );
1436
1437 info!("Starting consensus manager asynchronously");
1438
1439 tokio::spawn({
1441 let config = config.clone();
1442 let epoch_store = epoch_store.clone();
1443 let sui_tx_validator = SuiTxValidator::new(
1444 state.clone(),
1445 epoch_store.clone(),
1446 checkpoint_service.clone(),
1447 sui_tx_validator_metrics.clone(),
1448 );
1449 let consensus_manager = consensus_manager.clone();
1450 async move {
1451 consensus_manager
1452 .start(
1453 &config,
1454 epoch_store,
1455 consensus_handler_initializer,
1456 sui_tx_validator,
1457 )
1458 .await;
1459 }
1460 });
1461 let replay_waiter = consensus_manager.replay_waiter();
1462
1463 info!("Spawning checkpoint service");
1464 let replay_waiter = if std::env::var("DISABLE_REPLAY_WAITER").is_ok() {
1465 None
1466 } else {
1467 Some(replay_waiter)
1468 };
1469 checkpoint_service
1470 .spawn(epoch_store.clone(), replay_waiter)
1471 .await;
1472
1473 if node_role.is_validator() && epoch_store.authenticator_state_enabled() {
1474 Self::start_jwk_updater(
1475 config,
1476 sui_node_metrics,
1477 state.name,
1478 epoch_store.clone(),
1479 consensus_adapter.clone(),
1480 );
1481 }
1482
1483 if let Some(ctx) = &admission_queue {
1484 ctx.rotate_for_epoch(epoch_store);
1485 }
1486
1487 Ok(ValidatorComponents {
1488 validator_server_handle,
1489 validator_overload_monitor_handle,
1490 consensus_manager,
1491 consensus_store_pruner,
1492 consensus_adapter,
1493 checkpoint_metrics,
1494 sui_tx_validator_metrics,
1495 admission_queue,
1496 })
1497 }
1498
1499 fn build_checkpoint_service(
1500 config: &NodeConfig,
1501 consensus_adapter: Arc<ConsensusAdapter>,
1502 checkpoint_store: Arc<CheckpointStore>,
1503 epoch_store: Arc<AuthorityPerEpochStore>,
1504 state: Arc<AuthorityState>,
1505 state_sync_handle: state_sync::Handle,
1506 state_hasher: Weak<GlobalStateHasher>,
1507 checkpoint_metrics: Arc<CheckpointMetrics>,
1508 node_role: NodeRole,
1509 ) -> Arc<CheckpointService> {
1510 let epoch_start_timestamp_ms = epoch_store.epoch_start_state().epoch_start_timestamp_ms();
1511 let epoch_duration_ms = epoch_store.epoch_start_state().epoch_duration_ms();
1512
1513 debug!(
1514 "Starting checkpoint service with epoch start timestamp {}
1515 and epoch duration {}",
1516 epoch_start_timestamp_ms, epoch_duration_ms
1517 );
1518
1519 let checkpoint_output: Box<dyn CheckpointOutput> = if node_role.is_validator() {
1520 Box::new(SubmitCheckpointToConsensus {
1521 sender: consensus_adapter,
1522 signer: state.secret.clone(),
1523 authority: config.protocol_public_key(),
1524 next_reconfiguration_timestamp_ms: epoch_start_timestamp_ms
1525 .checked_add(epoch_duration_ms)
1526 .expect("Overflow calculating next_reconfiguration_timestamp_ms"),
1527 metrics: checkpoint_metrics.clone(),
1528 })
1529 } else {
1530 LogCheckpointOutput::boxed()
1531 };
1532
1533 let certified_checkpoint_output = SendCheckpointToStateSync::new(state_sync_handle);
1534 let max_tx_per_checkpoint = max_tx_per_checkpoint(epoch_store.protocol_config());
1535 let max_checkpoint_size_bytes =
1536 epoch_store.protocol_config().max_checkpoint_size_bytes() as usize;
1537
1538 CheckpointService::build(
1539 state.clone(),
1540 checkpoint_store,
1541 epoch_store,
1542 state.get_transaction_cache_reader().clone(),
1543 state_hasher,
1544 checkpoint_output,
1545 Box::new(certified_checkpoint_output),
1546 checkpoint_metrics,
1547 max_tx_per_checkpoint,
1548 max_checkpoint_size_bytes,
1549 )
1550 }
1551
1552 fn construct_consensus_adapter(
1553 committee: &Committee,
1554 consensus_config: &ConsensusConfig,
1555 authority: AuthorityName,
1556 prometheus_registry: &Registry,
1557 consensus_client: Arc<dyn ConsensusClient>,
1558 checkpoint_store: Arc<CheckpointStore>,
1559 inflight_slot_freed_notify: Arc<tokio::sync::Notify>,
1560 ) -> ConsensusAdapter {
1561 let ca_metrics = ConsensusAdapterMetrics::new(prometheus_registry);
1562 ConsensusAdapter::new(
1565 consensus_client,
1566 checkpoint_store,
1567 authority,
1568 consensus_config.max_pending_transactions(),
1569 consensus_config.max_pending_transactions() * 2 / committee.num_members(),
1570 ca_metrics,
1571 inflight_slot_freed_notify,
1572 )
1573 }
1574
1575 async fn start_grpc_validator_service(
1576 config: &NodeConfig,
1577 state: Arc<AuthorityState>,
1578 consensus_adapter: Arc<ConsensusAdapter>,
1579 epoch_store: Arc<AuthorityPerEpochStore>,
1580 prometheus_registry: &Registry,
1581 inflight_slot_freed_notify: Arc<tokio::sync::Notify>,
1582 ) -> Result<(SpawnOnce, Option<AdmissionQueueContext>)> {
1583 let overload_config = &config.authority_overload_config;
1584 let admission_queue = overload_config.admission_queue_enabled.then(|| {
1585 let manager = Arc::new(AdmissionQueueManager::new(
1586 consensus_adapter.clone(),
1587 Arc::new(AdmissionQueueMetrics::new(prometheus_registry)),
1588 overload_config.admission_queue_capacity_fraction,
1589 overload_config.admission_queue_bypass_fraction,
1590 overload_config.admission_queue_failover_timeout,
1591 inflight_slot_freed_notify,
1592 ));
1593 AdmissionQueueContext::spawn(manager, epoch_store)
1594 });
1595 let validator_service = ValidatorService::new(
1596 state.clone(),
1597 consensus_adapter,
1598 Arc::new(ValidatorServiceMetrics::new(prometheus_registry)),
1599 config.policy_config.clone().map(|p| p.client_id_source),
1600 admission_queue.clone(),
1601 );
1602
1603 let mut server_conf = mysten_network::config::Config::new();
1604 server_conf.connect_timeout = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1605 server_conf.http2_keepalive_interval = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1606 server_conf.http2_keepalive_timeout = Some(DEFAULT_GRPC_CONNECT_TIMEOUT);
1607 server_conf.global_concurrency_limit = config.grpc_concurrency_limit;
1608 server_conf.load_shed = config.grpc_load_shed;
1609 let mut server_builder =
1610 ServerBuilder::from_config(&server_conf, GrpcMetrics::new(prometheus_registry));
1611
1612 server_builder = server_builder.add_service(ValidatorServer::new(validator_service));
1613
1614 let tls_config = sui_tls::create_rustls_server_config(
1615 config.network_key_pair().copy().private(),
1616 SUI_TLS_SERVER_NAME.to_string(),
1617 );
1618
1619 let network_address = config.network_address().clone();
1620
1621 let (ready_tx, ready_rx) = oneshot::channel();
1622
1623 let spawn_once = SpawnOnce::new(ready_rx, async move {
1624 let server = server_builder
1625 .bind(&network_address, Some(tls_config))
1626 .await
1627 .unwrap_or_else(|err| panic!("Failed to bind to {network_address}: {err}"));
1628 let local_addr = server.local_addr();
1629 info!("Listening to traffic on {local_addr}");
1630 ready_tx.send(()).unwrap();
1631 if let Err(err) = server.serve().await {
1632 info!("Server stopped: {err}");
1633 }
1634 info!("Server stopped");
1635 });
1636 Ok((spawn_once, admission_queue))
1637 }
1638
1639 pub fn state(&self) -> Arc<AuthorityState> {
1640 self.state.clone()
1641 }
1642
1643 pub fn node_role(&self) -> NodeRole {
1644 self.state.load_epoch_store_one_call_per_task().node_role()
1645 }
1646
1647 pub fn reference_gas_price_for_testing(&self) -> Result<u64, anyhow::Error> {
1649 self.state.reference_gas_price_for_testing()
1650 }
1651
1652 pub fn clone_committee_store(&self) -> Arc<CommitteeStore> {
1653 self.state.committee_store().clone()
1654 }
1655
1656 pub fn clone_authority_aggregator(
1667 &self,
1668 ) -> Option<Arc<AuthorityAggregator<NetworkAuthorityClient>>> {
1669 self.transaction_orchestrator
1670 .as_ref()
1671 .map(|to| to.clone_authority_aggregator())
1672 }
1673
1674 pub fn transaction_orchestrator(
1675 &self,
1676 ) -> Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>> {
1677 self.transaction_orchestrator.clone()
1678 }
1679
1680 pub async fn monitor_reconfiguration(
1683 self: Arc<Self>,
1684 mut epoch_store: Arc<AuthorityPerEpochStore>,
1685 ) -> Result<()> {
1686 let checkpoint_executor_metrics =
1687 CheckpointExecutorMetrics::new(&self.registry_service.default_registry());
1688
1689 loop {
1690 let mut hasher_guard = self.global_state_hasher.lock().await;
1691 let hasher = hasher_guard.take().unwrap();
1692 info!(
1693 "Creating checkpoint executor for epoch {}",
1694 epoch_store.epoch()
1695 );
1696 let checkpoint_executor = CheckpointExecutor::new(
1697 epoch_store.clone(),
1698 self.checkpoint_store.clone(),
1699 self.state.clone(),
1700 hasher.clone(),
1701 self.backpressure_manager.clone(),
1702 self.config.checkpoint_executor_config.clone(),
1703 checkpoint_executor_metrics.clone(),
1704 self.subscription_service_checkpoint_sender.clone(),
1705 );
1706
1707 let run_with_range = self.config.run_with_range;
1708
1709 let cur_epoch_store = self.state.load_epoch_store_one_call_per_task();
1710
1711 self.metrics
1713 .current_protocol_version
1714 .set(cur_epoch_store.protocol_config().version.as_u64() as i64);
1715
1716 if let Some(components) = &*self.validator_components.lock().await
1719 && cur_epoch_store.is_validator()
1720 {
1721 tokio::time::sleep(Duration::from_millis(1)).await;
1723
1724 let config = cur_epoch_store.protocol_config();
1725 let mut supported_protocol_versions = self
1726 .config
1727 .supported_protocol_versions
1728 .expect("Supported versions should be populated")
1729 .truncate_below(config.version);
1731
1732 while supported_protocol_versions.max > config.version {
1733 let proposed_protocol_config = ProtocolConfig::get_for_version(
1734 supported_protocol_versions.max,
1735 cur_epoch_store.get_chain(),
1736 );
1737
1738 if proposed_protocol_config.enable_accumulators()
1739 && !epoch_store.accumulator_root_exists()
1740 {
1741 error!(
1742 "cannot upgrade to protocol version {:?} because accumulator root does not exist",
1743 supported_protocol_versions.max
1744 );
1745 supported_protocol_versions.max = supported_protocol_versions.max.prev();
1746 } else {
1747 break;
1748 }
1749 }
1750
1751 let binary_config = config.binary_config(None);
1752 let transaction = ConsensusTransaction::new_capability_notification_v2(
1753 AuthorityCapabilitiesV2::new(
1754 self.state.name,
1755 cur_epoch_store.get_chain_identifier().chain(),
1756 supported_protocol_versions,
1757 self.state
1758 .get_available_system_packages(&binary_config)
1759 .await,
1760 ),
1761 );
1762 info!(?transaction, "submitting capabilities to consensus");
1763 components.consensus_adapter.submit(
1764 transaction,
1765 None,
1766 &cur_epoch_store,
1767 None,
1768 None,
1769 )?;
1770 }
1771
1772 let stop_condition = checkpoint_executor.run_epoch(run_with_range).await;
1773
1774 if stop_condition == StopReason::RunWithRangeCondition {
1775 SuiNode::shutdown(&self).await;
1776 self.shutdown_channel_tx
1777 .send(run_with_range)
1778 .expect("RunWithRangeCondition met but failed to send shutdown message");
1779 return Ok(());
1780 }
1781
1782 let latest_system_state = self
1784 .state
1785 .get_object_cache_reader()
1786 .get_sui_system_state_object_unsafe()
1787 .expect("Read Sui System State object cannot fail");
1788
1789 #[cfg(msim)]
1790 if !self
1791 .sim_state
1792 .sim_safe_mode_expected
1793 .load(Ordering::Relaxed)
1794 {
1795 debug_assert!(!latest_system_state.safe_mode());
1796 }
1797
1798 #[cfg(not(msim))]
1799 debug_assert!(!latest_system_state.safe_mode());
1800
1801 if let Err(err) = self.end_of_epoch_channel.send(latest_system_state.clone())
1802 && self.state.is_fullnode(&cur_epoch_store)
1803 {
1804 warn!(
1805 "Failed to send end of epoch notification to subscriber: {:?}",
1806 err
1807 );
1808 }
1809
1810 cur_epoch_store.record_is_safe_mode_metric(latest_system_state.safe_mode());
1811 let new_epoch_start_state = latest_system_state.into_epoch_start_state();
1812
1813 self.auth_agg.store(Arc::new(
1814 self.auth_agg
1815 .load()
1816 .recreate_with_new_epoch_start_state(&new_epoch_start_state),
1817 ));
1818
1819 let next_epoch_committee = new_epoch_start_state.get_sui_committee();
1820 let next_epoch = next_epoch_committee.epoch();
1821 assert_eq!(cur_epoch_store.epoch() + 1, next_epoch);
1822
1823 info!(
1824 next_epoch,
1825 "Finished executing all checkpoints in epoch. About to reconfigure the system."
1826 );
1827
1828 fail_point_async!("reconfig_delay");
1829
1830 cur_epoch_store.record_epoch_reconfig_start_time_metric();
1831
1832 update_peer_addresses(&self.config, &self.endpoint_manager, &new_epoch_start_state);
1833
1834 let mut validator_components_lock_guard = self.validator_components.lock().await;
1835
1836 let new_epoch_store = self
1840 .reconfigure_state(
1841 &self.state,
1842 &cur_epoch_store,
1843 next_epoch_committee.clone(),
1844 new_epoch_start_state,
1845 hasher.clone(),
1846 )
1847 .await;
1848
1849 let new_role = new_epoch_store.node_role();
1850
1851 let new_validator_components = if let Some(ValidatorComponents {
1852 validator_server_handle,
1853 validator_overload_monitor_handle,
1854 consensus_manager,
1855 consensus_store_pruner,
1856 consensus_adapter,
1857 checkpoint_metrics,
1858 sui_tx_validator_metrics,
1859 admission_queue,
1860 }) = validator_components_lock_guard.take()
1861 {
1862 info!("Reconfiguring node (was running consensus).");
1863
1864 consensus_manager.shutdown().await;
1865 info!("Consensus has shut down.");
1866
1867 info!("Epoch store finished reconfiguration.");
1868
1869 let global_state_hasher_metrics = Arc::into_inner(hasher)
1872 .expect("Object state hasher should have no other references at this point")
1873 .metrics();
1874 let new_hasher = Arc::new(GlobalStateHasher::new(
1875 self.state.get_global_state_hash_store().clone(),
1876 global_state_hasher_metrics,
1877 ));
1878 let weak_hasher = Arc::downgrade(&new_hasher);
1879 *hasher_guard = Some(new_hasher);
1880
1881 consensus_store_pruner.prune(next_epoch).await;
1882
1883 if new_role.runs_consensus() {
1884 info!("Restarting consensus as {new_role}");
1885 Some(
1886 Self::start_epoch_specific_validator_components(
1887 &self.config,
1888 self.state.clone(),
1889 consensus_adapter,
1890 self.checkpoint_store.clone(),
1891 new_epoch_store.clone(),
1892 self.state_sync_handle.clone(),
1893 self.randomness_handle.clone(),
1894 consensus_manager,
1895 consensus_store_pruner,
1896 weak_hasher,
1897 self.backpressure_manager.clone(),
1898 validator_server_handle,
1899 validator_overload_monitor_handle,
1900 checkpoint_metrics,
1901 self.metrics.clone(),
1902 sui_tx_validator_metrics,
1903 admission_queue,
1904 new_role,
1905 )
1906 .await?,
1907 )
1908 } else {
1909 info!(
1910 "This node has new role {new_role} and no longer runs consensus after reconfiguration"
1911 );
1912 None
1913 }
1914 } else {
1915 let global_state_hasher_metrics = Arc::into_inner(hasher)
1918 .expect("Object state hasher should have no other references at this point")
1919 .metrics();
1920 let new_hasher = Arc::new(GlobalStateHasher::new(
1921 self.state.get_global_state_hash_store().clone(),
1922 global_state_hasher_metrics,
1923 ));
1924 let weak_hasher = Arc::downgrade(&new_hasher);
1925 *hasher_guard = Some(new_hasher);
1926
1927 if new_role.runs_consensus() {
1928 info!("Promoting node to {new_role}, starting consensus components");
1929
1930 let mut components = Self::construct_validator_components(
1931 self.config.clone(),
1932 self.state.clone(),
1933 Arc::new(next_epoch_committee.clone()),
1934 new_epoch_store.clone(),
1935 self.checkpoint_store.clone(),
1936 self.state_sync_handle.clone(),
1937 self.randomness_handle.clone(),
1938 weak_hasher,
1939 self.backpressure_manager.clone(),
1940 &self.registry_service,
1941 self.metrics.clone(),
1942 self.checkpoint_metrics.clone(),
1943 new_role,
1944 )
1945 .await?;
1946
1947 if new_role.is_validator() {
1948 components.validator_server_handle = Some(
1949 components
1950 .validator_server_handle
1951 .take()
1952 .unwrap()
1953 .start()
1954 .await,
1955 );
1956
1957 self.endpoint_manager
1958 .set_consensus_address_updater(components.consensus_manager.clone());
1959 }
1960
1961 Some(components)
1962 } else {
1963 None
1964 }
1965 };
1966 *validator_components_lock_guard = new_validator_components;
1967
1968 cur_epoch_store.release_db_handles();
1971
1972 if cfg!(msim)
1973 && !matches!(
1974 self.config
1975 .authority_store_pruning_config
1976 .num_epochs_to_retain_for_checkpoints(),
1977 None | Some(u64::MAX) | Some(0)
1978 )
1979 {
1980 self.state
1981 .prune_checkpoints_for_eligible_epochs_for_testing(
1982 self.config.clone(),
1983 sui_core::authority::authority_store_pruner::AuthorityStorePruningMetrics::new_for_test(),
1984 )
1985 .await?;
1986 }
1987
1988 epoch_store = new_epoch_store;
1989 info!("Reconfiguration finished");
1990 }
1991 }
1992
1993 async fn shutdown(&self) {
1994 if let Some(validator_components) = &*self.validator_components.lock().await {
1995 validator_components.consensus_manager.shutdown().await;
1996 }
1997 }
1998
1999 async fn reconfigure_state(
2000 &self,
2001 state: &Arc<AuthorityState>,
2002 cur_epoch_store: &AuthorityPerEpochStore,
2003 next_epoch_committee: Committee,
2004 next_epoch_start_system_state: EpochStartSystemState,
2005 global_state_hasher: Arc<GlobalStateHasher>,
2006 ) -> Arc<AuthorityPerEpochStore> {
2007 let next_epoch = next_epoch_committee.epoch();
2008
2009 let last_checkpoint = self
2010 .checkpoint_store
2011 .get_epoch_last_checkpoint(cur_epoch_store.epoch())
2012 .expect("Error loading last checkpoint for current epoch")
2013 .expect("Could not load last checkpoint for current epoch");
2014
2015 let last_checkpoint_seq = *last_checkpoint.sequence_number();
2016
2017 assert_eq!(
2018 Some(last_checkpoint_seq),
2019 self.checkpoint_store
2020 .get_highest_executed_checkpoint_seq_number()
2021 .expect("Error loading highest executed checkpoint sequence number")
2022 );
2023
2024 let epoch_start_configuration = EpochStartConfiguration::new(
2025 next_epoch_start_system_state,
2026 *last_checkpoint.digest(),
2027 state.get_object_store().as_ref(),
2028 EpochFlag::default_flags_for_new_epoch(&state.config),
2029 )
2030 .expect("EpochStartConfiguration construction cannot fail");
2031
2032 let new_epoch_store = self
2033 .state
2034 .reconfigure(
2035 cur_epoch_store,
2036 self.config.supported_protocol_versions.unwrap(),
2037 next_epoch_committee,
2038 epoch_start_configuration,
2039 global_state_hasher,
2040 &self.config.expensive_safety_check_config,
2041 last_checkpoint_seq,
2042 )
2043 .await
2044 .expect("Reconfigure authority state cannot fail");
2045 info!(next_epoch, "Node State has been reconfigured");
2046 assert_eq!(next_epoch, new_epoch_store.epoch());
2047 self.state.get_reconfig_api().update_epoch_flags_metrics(
2048 cur_epoch_store.epoch_start_config().flags(),
2049 new_epoch_store.epoch_start_config().flags(),
2050 );
2051
2052 new_epoch_store
2053 }
2054
2055 pub fn get_config(&self) -> &NodeConfig {
2056 &self.config
2057 }
2058
2059 pub fn randomness_handle(&self) -> randomness::Handle {
2060 self.randomness_handle.clone()
2061 }
2062
2063 pub fn state_sync_handle(&self) -> state_sync::Handle {
2064 self.state_sync_handle.clone()
2065 }
2066
2067 pub fn endpoint_manager(&self) -> &EndpointManager {
2068 &self.endpoint_manager
2069 }
2070
2071 fn get_digest_prefix(digest: impl std::fmt::Display) -> String {
2073 let digest_str = digest.to_string();
2074 if digest_str.len() >= 8 {
2075 digest_str[0..8].to_string()
2076 } else {
2077 digest_str
2078 }
2079 }
2080
2081 async fn check_and_recover_forks(
2085 checkpoint_store: &CheckpointStore,
2086 checkpoint_metrics: &CheckpointMetrics,
2087 fork_recovery: Option<&ForkRecoveryConfig>,
2088 ) -> Result<()> {
2089 if let Some(recovery) = fork_recovery {
2091 Self::try_recover_checkpoint_fork(checkpoint_store, recovery)?;
2092 Self::try_recover_transaction_fork(checkpoint_store, recovery)?;
2093 }
2094
2095 if let Some((checkpoint_seq, checkpoint_digest)) = checkpoint_store
2096 .get_checkpoint_fork_detected()
2097 .map_err(|e| {
2098 error!("Failed to check for checkpoint fork: {:?}", e);
2099 e
2100 })?
2101 {
2102 Self::handle_checkpoint_fork(
2103 checkpoint_seq,
2104 checkpoint_digest,
2105 checkpoint_metrics,
2106 fork_recovery,
2107 )
2108 .await?;
2109 }
2110 if let Some((tx_digest, expected_effects, actual_effects)) = checkpoint_store
2111 .get_transaction_fork_detected()
2112 .map_err(|e| {
2113 error!("Failed to check for transaction fork: {:?}", e);
2114 e
2115 })?
2116 {
2117 Self::handle_transaction_fork(
2118 tx_digest,
2119 expected_effects,
2120 actual_effects,
2121 checkpoint_metrics,
2122 fork_recovery,
2123 )
2124 .await?;
2125 }
2126
2127 Ok(())
2128 }
2129
2130 fn try_recover_checkpoint_fork(
2131 checkpoint_store: &CheckpointStore,
2132 recovery: &ForkRecoveryConfig,
2133 ) -> Result<()> {
2134 for (seq, expected_digest_str) in &recovery.checkpoint_overrides {
2137 let Ok(expected_digest) = CheckpointDigest::from_str(expected_digest_str) else {
2138 anyhow::bail!(
2139 "Invalid checkpoint digest override for seq {}: {}",
2140 seq,
2141 expected_digest_str
2142 );
2143 };
2144
2145 if let Some(local_summary) = checkpoint_store.get_locally_computed_checkpoint(*seq)? {
2146 let local_digest = sui_types::message_envelope::Message::digest(&local_summary);
2147 if local_digest != expected_digest {
2148 info!(
2149 seq,
2150 local = %Self::get_digest_prefix(local_digest),
2151 expected = %Self::get_digest_prefix(expected_digest),
2152 "Fork recovery: clearing locally_computed_checkpoints from {} due to digest mismatch",
2153 seq
2154 );
2155 checkpoint_store
2156 .clear_locally_computed_checkpoints_from(*seq)
2157 .context(
2158 "Failed to clear locally computed checkpoints from override seq",
2159 )?;
2160 }
2161 }
2162 }
2163
2164 if let Some((checkpoint_seq, checkpoint_digest)) =
2165 checkpoint_store.get_checkpoint_fork_detected()?
2166 && recovery.checkpoint_overrides.contains_key(&checkpoint_seq)
2167 {
2168 info!(
2169 "Fork recovery enabled: clearing checkpoint fork at seq {} with digest {:?}",
2170 checkpoint_seq, checkpoint_digest
2171 );
2172 checkpoint_store
2173 .clear_checkpoint_fork_detected()
2174 .expect("Failed to clear checkpoint fork detected marker");
2175 }
2176 Ok(())
2177 }
2178
2179 fn try_recover_transaction_fork(
2180 checkpoint_store: &CheckpointStore,
2181 recovery: &ForkRecoveryConfig,
2182 ) -> Result<()> {
2183 if recovery.transaction_overrides.is_empty() {
2184 return Ok(());
2185 }
2186
2187 if let Some((tx_digest, _, _)) = checkpoint_store.get_transaction_fork_detected()?
2188 && recovery
2189 .transaction_overrides
2190 .contains_key(&tx_digest.to_string())
2191 {
2192 info!(
2193 "Fork recovery enabled: clearing transaction fork for tx {:?}",
2194 tx_digest
2195 );
2196 checkpoint_store
2197 .clear_transaction_fork_detected()
2198 .expect("Failed to clear transaction fork detected marker");
2199 }
2200 Ok(())
2201 }
2202
2203 fn get_current_timestamp() -> u64 {
2204 std::time::SystemTime::now()
2205 .duration_since(std::time::SystemTime::UNIX_EPOCH)
2206 .unwrap()
2207 .as_secs()
2208 }
2209
2210 async fn handle_checkpoint_fork(
2211 checkpoint_seq: u64,
2212 checkpoint_digest: CheckpointDigest,
2213 checkpoint_metrics: &CheckpointMetrics,
2214 fork_recovery: Option<&ForkRecoveryConfig>,
2215 ) -> Result<()> {
2216 checkpoint_metrics
2217 .checkpoint_fork_crash_mode
2218 .with_label_values(&[
2219 &checkpoint_seq.to_string(),
2220 &Self::get_digest_prefix(checkpoint_digest),
2221 &Self::get_current_timestamp().to_string(),
2222 ])
2223 .set(1);
2224
2225 let behavior = fork_recovery
2226 .map(|fr| fr.fork_crash_behavior)
2227 .unwrap_or_default();
2228
2229 match behavior {
2230 ForkCrashBehavior::AwaitForkRecovery => {
2231 error!(
2232 checkpoint_seq = checkpoint_seq,
2233 checkpoint_digest = ?checkpoint_digest,
2234 "Checkpoint fork detected! Node startup halted. Sleeping indefinitely."
2235 );
2236 futures::future::pending::<()>().await;
2237 unreachable!("pending() should never return");
2238 }
2239 ForkCrashBehavior::ReturnError => {
2240 error!(
2241 checkpoint_seq = checkpoint_seq,
2242 checkpoint_digest = ?checkpoint_digest,
2243 "Checkpoint fork detected! Returning error."
2244 );
2245 Err(anyhow::anyhow!(
2246 "Checkpoint fork detected! checkpoint_seq: {}, checkpoint_digest: {:?}",
2247 checkpoint_seq,
2248 checkpoint_digest
2249 ))
2250 }
2251 }
2252 }
2253
2254 async fn handle_transaction_fork(
2255 tx_digest: TransactionDigest,
2256 expected_effects_digest: TransactionEffectsDigest,
2257 actual_effects_digest: TransactionEffectsDigest,
2258 checkpoint_metrics: &CheckpointMetrics,
2259 fork_recovery: Option<&ForkRecoveryConfig>,
2260 ) -> Result<()> {
2261 checkpoint_metrics
2262 .transaction_fork_crash_mode
2263 .with_label_values(&[
2264 &Self::get_digest_prefix(tx_digest),
2265 &Self::get_digest_prefix(expected_effects_digest),
2266 &Self::get_digest_prefix(actual_effects_digest),
2267 &Self::get_current_timestamp().to_string(),
2268 ])
2269 .set(1);
2270
2271 let behavior = fork_recovery
2272 .map(|fr| fr.fork_crash_behavior)
2273 .unwrap_or_default();
2274
2275 match behavior {
2276 ForkCrashBehavior::AwaitForkRecovery => {
2277 error!(
2278 tx_digest = ?tx_digest,
2279 expected_effects_digest = ?expected_effects_digest,
2280 actual_effects_digest = ?actual_effects_digest,
2281 "Transaction fork detected! Node startup halted. Sleeping indefinitely."
2282 );
2283 futures::future::pending::<()>().await;
2284 unreachable!("pending() should never return");
2285 }
2286 ForkCrashBehavior::ReturnError => {
2287 error!(
2288 tx_digest = ?tx_digest,
2289 expected_effects_digest = ?expected_effects_digest,
2290 actual_effects_digest = ?actual_effects_digest,
2291 "Transaction fork detected! Returning error."
2292 );
2293 Err(anyhow::anyhow!(
2294 "Transaction fork detected! tx_digest: {:?}, expected_effects: {:?}, actual_effects: {:?}",
2295 tx_digest,
2296 expected_effects_digest,
2297 actual_effects_digest
2298 ))
2299 }
2300 }
2301 }
2302}
2303
2304#[cfg(not(msim))]
2305impl SuiNode {
2306 async fn fetch_jwks(
2307 _authority: AuthorityName,
2308 provider: &OIDCProvider,
2309 ) -> SuiResult<Vec<(JwkId, JWK)>> {
2310 use fastcrypto_zkp::bn254::zk_login::fetch_jwks;
2311 use sui_types::error::SuiErrorKind;
2312 let client = reqwest::Client::new();
2313 fetch_jwks(provider, &client, true)
2314 .await
2315 .map_err(|_| SuiErrorKind::JWKRetrievalError.into())
2316 }
2317}
2318
2319#[cfg(msim)]
2320impl SuiNode {
2321 pub fn get_sim_node_id(&self) -> sui_simulator::task::NodeId {
2322 self.sim_state.sim_node.id()
2323 }
2324
2325 pub fn set_safe_mode_expected(&self, new_value: bool) {
2326 info!("Setting safe mode expected to {}", new_value);
2327 self.sim_state
2328 .sim_safe_mode_expected
2329 .store(new_value, Ordering::Relaxed);
2330 }
2331
2332 #[allow(unused_variables)]
2333 async fn fetch_jwks(
2334 authority: AuthorityName,
2335 provider: &OIDCProvider,
2336 ) -> SuiResult<Vec<(JwkId, JWK)>> {
2337 get_jwk_injector()(authority, provider)
2338 }
2339}
2340
2341enum SpawnOnce {
2342 Unstarted(oneshot::Receiver<()>, Mutex<BoxFuture<'static, ()>>),
2344 #[allow(unused)]
2345 Started(JoinHandle<()>),
2346}
2347
2348impl SpawnOnce {
2349 pub fn new(
2350 ready_rx: oneshot::Receiver<()>,
2351 future: impl Future<Output = ()> + Send + 'static,
2352 ) -> Self {
2353 Self::Unstarted(ready_rx, Mutex::new(Box::pin(future)))
2354 }
2355
2356 pub async fn start(self) -> Self {
2357 match self {
2358 Self::Unstarted(ready_rx, future) => {
2359 let future = future.into_inner();
2360 let handle = tokio::spawn(future);
2361 ready_rx.await.unwrap();
2362 Self::Started(handle)
2363 }
2364 Self::Started(_) => self,
2365 }
2366 }
2367}
2368
2369fn update_peer_addresses(
2371 config: &NodeConfig,
2372 endpoint_manager: &EndpointManager,
2373 epoch_start_state: &EpochStartSystemState,
2374) {
2375 for (peer_id, address) in
2376 epoch_start_state.get_validator_as_p2p_peers(config.protocol_public_key())
2377 {
2378 endpoint_manager
2379 .update_endpoint(
2380 EndpointId::P2p(peer_id),
2381 AddressSource::Chain,
2382 vec![address],
2383 )
2384 .expect("Updating peer addresses should not fail");
2385 }
2386}
2387
2388fn build_kv_store(
2389 state: &Arc<AuthorityState>,
2390 config: &NodeConfig,
2391 registry: &Registry,
2392) -> Result<Arc<TransactionKeyValueStore>> {
2393 let metrics = KeyValueStoreMetrics::new(registry);
2394 let db_store = TransactionKeyValueStore::new("rocksdb", metrics.clone(), state.clone());
2395
2396 let base_url = &config.transaction_kv_store_read_config.base_url;
2397
2398 if base_url.is_empty() {
2399 info!("no http kv store url provided, using local db only");
2400 return Ok(Arc::new(db_store));
2401 }
2402
2403 let base_url: url::Url = base_url.parse().tap_err(|e| {
2404 error!(
2405 "failed to parse config.transaction_kv_store_config.base_url ({:?}) as url: {}",
2406 base_url, e
2407 )
2408 })?;
2409
2410 let network_str = match state.get_chain_identifier().chain() {
2411 Chain::Mainnet => "/mainnet",
2412 _ => {
2413 info!("using local db only for kv store");
2414 return Ok(Arc::new(db_store));
2415 }
2416 };
2417
2418 let base_url = base_url.join(network_str)?.to_string();
2419 let http_store = HttpKVStore::new_kv(
2420 &base_url,
2421 config.transaction_kv_store_read_config.cache_size,
2422 metrics.clone(),
2423 )?;
2424 info!("using local key-value store with fallback to http key-value store");
2425 Ok(Arc::new(FallbackTransactionKVStore::new_kv(
2426 db_store,
2427 http_store,
2428 metrics,
2429 "json_rpc_fallback",
2430 )))
2431}
2432
2433async fn build_http_servers(
2434 state: Arc<AuthorityState>,
2435 store: RocksDbStore,
2436 transaction_orchestrator: &Option<Arc<TransactionOrchestrator<NetworkAuthorityClient>>>,
2437 config: &NodeConfig,
2438 prometheus_registry: &Registry,
2439 server_version: ServerVersion,
2440 node_role: NodeRole,
2441) -> Result<(HttpServers, Option<tokio::sync::mpsc::Sender<Checkpoint>>)> {
2442 if !node_role.should_run_rpc_servers() {
2444 return Ok((HttpServers::default(), None));
2445 }
2446
2447 info!("starting rpc service with config: {:?}", config.rpc);
2448
2449 let mut router = axum::Router::new();
2450
2451 let json_rpc_router = {
2452 let traffic_controller = state.traffic_controller.clone();
2453 let mut server = JsonRpcServerBuilder::new(
2454 env!("CARGO_PKG_VERSION"),
2455 prometheus_registry,
2456 traffic_controller,
2457 config.policy_config.clone(),
2458 );
2459
2460 let kv_store = build_kv_store(&state, config, prometheus_registry)?;
2461
2462 let metrics = Arc::new(JsonRpcMetrics::new(prometheus_registry));
2463 server.register_module(ReadApi::new(
2464 state.clone(),
2465 kv_store.clone(),
2466 metrics.clone(),
2467 ))?;
2468 server.register_module(CoinReadApi::new(
2469 state.clone(),
2470 kv_store.clone(),
2471 metrics.clone(),
2472 ))?;
2473
2474 if config.run_with_range.is_none() {
2477 server.register_module(TransactionBuilderApi::new(state.clone()))?;
2478 }
2479 server.register_module(GovernanceReadApi::new(state.clone(), metrics.clone()))?;
2480 server.register_module(BridgeReadApi::new(state.clone(), metrics.clone()))?;
2481
2482 if let Some(transaction_orchestrator) = transaction_orchestrator {
2483 server.register_module(TransactionExecutionApi::new(
2484 state.clone(),
2485 transaction_orchestrator.clone(),
2486 metrics.clone(),
2487 ))?;
2488 }
2489
2490 let name_service_config =
2491 if let (Some(package_address), Some(registry_id), Some(reverse_registry_id)) = (
2492 config.name_service_package_address,
2493 config.name_service_registry_id,
2494 config.name_service_reverse_registry_id,
2495 ) {
2496 sui_name_service::NameServiceConfig::new(
2497 package_address,
2498 registry_id,
2499 reverse_registry_id,
2500 )
2501 } else {
2502 match state.get_chain_identifier().chain() {
2503 Chain::Mainnet => sui_name_service::NameServiceConfig::mainnet(),
2504 Chain::Testnet => sui_name_service::NameServiceConfig::testnet(),
2505 Chain::Unknown => sui_name_service::NameServiceConfig::default(),
2506 }
2507 };
2508
2509 server.register_module(IndexerApi::new(
2510 state.clone(),
2511 ReadApi::new(state.clone(), kv_store.clone(), metrics.clone()),
2512 kv_store,
2513 name_service_config,
2514 metrics,
2515 config.indexer_max_subscriptions,
2516 ))?;
2517 server.register_module(MoveUtils::new(state.clone()))?;
2518
2519 let server_type = config.jsonrpc_server_type();
2520
2521 server.to_router(server_type).await?
2522 };
2523
2524 router = router.merge(json_rpc_router);
2525
2526 let (subscription_service_checkpoint_sender, subscription_service_handle) =
2527 SubscriptionService::build(prometheus_registry);
2528 let rpc_router = {
2529 let mut rpc_service =
2530 sui_rpc_api::RpcService::new(Arc::new(RestReadStore::new(state.clone(), store)));
2531 rpc_service.with_server_version(server_version);
2532
2533 if let Some(config) = config.rpc.clone() {
2534 rpc_service.with_config(config);
2535 }
2536
2537 rpc_service.with_metrics(RpcMetrics::new(prometheus_registry));
2538 rpc_service.with_subscription_service(subscription_service_handle);
2539
2540 if let Some(transaction_orchestrator) = transaction_orchestrator {
2541 rpc_service.with_executor(transaction_orchestrator.clone())
2542 }
2543
2544 rpc_service.into_router().await
2545 };
2546
2547 let layers = ServiceBuilder::new()
2548 .map_request(|mut request: axum::http::Request<_>| {
2549 if let Some(connect_info) = request.extensions().get::<sui_http::ConnectInfo>() {
2550 let axum_connect_info = axum::extract::ConnectInfo(connect_info.remote_addr);
2551 request.extensions_mut().insert(axum_connect_info);
2552 }
2553 request
2554 })
2555 .layer(axum::middleware::from_fn(server_timing_middleware))
2556 .layer(
2558 tower_http::cors::CorsLayer::new()
2559 .allow_methods([http::Method::GET, http::Method::POST])
2560 .allow_origin(tower_http::cors::Any)
2561 .allow_headers(tower_http::cors::Any)
2562 .expose_headers(tower_http::cors::Any),
2563 );
2564
2565 router = router.merge(rpc_router).layer(layers);
2566
2567 let https = if let Some((tls_config, https_address)) = config
2568 .rpc()
2569 .and_then(|config| config.tls_config().map(|tls| (tls, config.https_address())))
2570 {
2571 let https = sui_http::Builder::new()
2572 .tls_single_cert(tls_config.cert(), tls_config.key())
2573 .and_then(|builder| builder.serve(https_address, router.clone()))
2574 .map_err(|e| anyhow::anyhow!(e))?;
2575
2576 info!(
2577 https_address =? https.local_addr(),
2578 "HTTPS rpc server listening on {}",
2579 https.local_addr()
2580 );
2581
2582 Some(https)
2583 } else {
2584 None
2585 };
2586
2587 let http = sui_http::Builder::new()
2588 .serve(&config.json_rpc_address, router)
2589 .map_err(|e| anyhow::anyhow!(e))?;
2590
2591 info!(
2592 http_address =? http.local_addr(),
2593 "HTTP rpc server listening on {}",
2594 http.local_addr()
2595 );
2596
2597 Ok((
2598 HttpServers {
2599 http: Some(http),
2600 https,
2601 },
2602 Some(subscription_service_checkpoint_sender),
2603 ))
2604}
2605
2606#[cfg(not(test))]
2607fn max_tx_per_checkpoint(protocol_config: &ProtocolConfig) -> usize {
2608 protocol_config.max_transactions_per_checkpoint() as usize
2609}
2610
2611#[cfg(test)]
2612fn max_tx_per_checkpoint(_: &ProtocolConfig) -> usize {
2613 2
2614}
2615
2616#[derive(Default)]
2617struct HttpServers {
2618 #[allow(unused)]
2619 http: Option<sui_http::ServerHandle>,
2620 #[allow(unused)]
2621 https: Option<sui_http::ServerHandle>,
2622}
2623
2624#[cfg(test)]
2625mod tests {
2626 use super::*;
2627 use prometheus::Registry;
2628 use std::collections::BTreeMap;
2629 use sui_config::node::{ForkCrashBehavior, ForkRecoveryConfig};
2630 use sui_core::checkpoints::{CheckpointMetrics, CheckpointStore};
2631 use sui_types::digests::{CheckpointDigest, TransactionDigest, TransactionEffectsDigest};
2632
2633 #[tokio::test]
2634 async fn test_fork_error_and_recovery_both_paths() {
2635 let checkpoint_store = CheckpointStore::new_for_tests();
2636 let checkpoint_metrics = CheckpointMetrics::new(&Registry::new());
2637
2638 let seq_num = 42;
2640 let digest = CheckpointDigest::random();
2641 checkpoint_store
2642 .record_checkpoint_fork_detected(seq_num, digest)
2643 .unwrap();
2644
2645 let fork_recovery = ForkRecoveryConfig {
2646 transaction_overrides: Default::default(),
2647 checkpoint_overrides: Default::default(),
2648 fork_crash_behavior: ForkCrashBehavior::ReturnError,
2649 };
2650
2651 let r = SuiNode::check_and_recover_forks(
2652 &checkpoint_store,
2653 &checkpoint_metrics,
2654 Some(&fork_recovery),
2655 )
2656 .await;
2657 assert!(r.is_err());
2658 assert!(
2659 r.unwrap_err()
2660 .to_string()
2661 .contains("Checkpoint fork detected")
2662 );
2663
2664 let mut checkpoint_overrides = BTreeMap::new();
2665 checkpoint_overrides.insert(seq_num, digest.to_string());
2666 let fork_recovery_with_override = ForkRecoveryConfig {
2667 transaction_overrides: Default::default(),
2668 checkpoint_overrides,
2669 fork_crash_behavior: ForkCrashBehavior::ReturnError,
2670 };
2671 let r = SuiNode::check_and_recover_forks(
2672 &checkpoint_store,
2673 &checkpoint_metrics,
2674 Some(&fork_recovery_with_override),
2675 )
2676 .await;
2677 assert!(r.is_ok());
2678 assert!(
2679 checkpoint_store
2680 .get_checkpoint_fork_detected()
2681 .unwrap()
2682 .is_none()
2683 );
2684
2685 let tx_digest = TransactionDigest::random();
2687 let expected_effects = TransactionEffectsDigest::random();
2688 let actual_effects = TransactionEffectsDigest::random();
2689 checkpoint_store
2690 .record_transaction_fork_detected(tx_digest, expected_effects, actual_effects)
2691 .unwrap();
2692
2693 let fork_recovery = ForkRecoveryConfig {
2694 transaction_overrides: Default::default(),
2695 checkpoint_overrides: Default::default(),
2696 fork_crash_behavior: ForkCrashBehavior::ReturnError,
2697 };
2698 let r = SuiNode::check_and_recover_forks(
2699 &checkpoint_store,
2700 &checkpoint_metrics,
2701 Some(&fork_recovery),
2702 )
2703 .await;
2704 assert!(r.is_err());
2705 assert!(
2706 r.unwrap_err()
2707 .to_string()
2708 .contains("Transaction fork detected")
2709 );
2710
2711 let mut transaction_overrides = BTreeMap::new();
2712 transaction_overrides.insert(tx_digest.to_string(), actual_effects.to_string());
2713 let fork_recovery_with_override = ForkRecoveryConfig {
2714 transaction_overrides,
2715 checkpoint_overrides: Default::default(),
2716 fork_crash_behavior: ForkCrashBehavior::ReturnError,
2717 };
2718 let r = SuiNode::check_and_recover_forks(
2719 &checkpoint_store,
2720 &checkpoint_metrics,
2721 Some(&fork_recovery_with_override),
2722 )
2723 .await;
2724 assert!(r.is_ok());
2725 assert!(
2726 checkpoint_store
2727 .get_transaction_fork_detected()
2728 .unwrap()
2729 .is_none()
2730 );
2731 }
2732}