Skip to main content

sui_node/
lib.rs

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