sui_node/
lib.rs

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