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