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