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