sui_core/authority/
test_authority_builder.rs

1// Copyright (c) Mysten Labs, Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4use super::ExecutionEnv;
5use super::backpressure::BackpressureManager;
6use super::epoch_start_configuration::EpochFlag;
7use crate::authority::authority_per_epoch_store::AuthorityPerEpochStore;
8use crate::authority::authority_store_pruner::PrunerWatermarks;
9use crate::authority::authority_store_tables::{
10    AuthorityPerpetualTables, AuthorityPerpetualTablesOptions,
11};
12use crate::authority::epoch_start_configuration::EpochStartConfiguration;
13use crate::authority::submitted_transaction_cache::SubmittedTransactionCacheMetrics;
14use crate::authority::{AuthorityState, AuthorityStore};
15use crate::checkpoints::CheckpointStore;
16use crate::epoch::committee_store::CommitteeStore;
17use crate::epoch::epoch_metrics::EpochMetrics;
18use crate::epoch::randomness::RandomnessManager;
19use crate::execution_cache::build_execution_cache;
20use crate::jsonrpc_index::IndexStore;
21use crate::mock_consensus::{ConsensusMode, MockConsensusClient};
22use crate::module_cache_metrics::ResolverMetrics;
23use crate::rpc_index::RpcIndexStore;
24use crate::signature_verifier::SignatureVerifierMetrics;
25use fastcrypto::traits::KeyPair;
26use prometheus::Registry;
27use std::path::PathBuf;
28use std::sync::Arc;
29use sui_config::ExecutionCacheConfig;
30use sui_config::certificate_deny_config::CertificateDenyConfig;
31use sui_config::genesis::Genesis;
32use sui_config::node::AuthorityOverloadConfig;
33use sui_config::node::{
34    AuthorityStorePruningConfig, DBCheckpointConfig, ExpensiveSafetyCheckConfig,
35};
36use sui_config::transaction_deny_config::TransactionDenyConfig;
37use sui_macros::nondeterministic;
38use sui_network::randomness;
39use sui_protocol_config::{Chain, ProtocolConfig};
40use sui_swarm_config::genesis_config::AccountConfig;
41use sui_swarm_config::network_config::NetworkConfig;
42use sui_types::base_types::{AuthorityName, ObjectID};
43use sui_types::crypto::AuthorityKeyPair;
44use sui_types::digests::ChainIdentifier;
45use sui_types::executable_transaction::VerifiedExecutableTransaction;
46use sui_types::object::Object;
47use sui_types::sui_system_state::SuiSystemStateTrait;
48use sui_types::supported_protocol_versions::SupportedProtocolVersions;
49use sui_types::transaction::VerifiedTransaction;
50
51#[derive(Default, Clone)]
52pub struct TestAuthorityBuilder<'a> {
53    store_base_path: Option<PathBuf>,
54    store: Option<Arc<AuthorityStore>>,
55    transaction_deny_config: Option<TransactionDenyConfig>,
56    certificate_deny_config: Option<CertificateDenyConfig>,
57    protocol_config: Option<ProtocolConfig>,
58    reference_gas_price: Option<u64>,
59    node_keypair: Option<&'a AuthorityKeyPair>,
60    genesis: Option<&'a Genesis>,
61    /// Pre-built network config to avoid rebuilding genesis
62    network_config: Option<&'a NetworkConfig>,
63    starting_objects: Option<&'a [Object]>,
64    expensive_safety_checks: Option<ExpensiveSafetyCheckConfig>,
65    disable_indexer: bool,
66    accounts: Vec<AccountConfig>,
67    /// By default, we don't insert the genesis checkpoint, which isn't needed by most tests.
68    insert_genesis_checkpoint: bool,
69    authority_overload_config: Option<AuthorityOverloadConfig>,
70    cache_config: Option<ExecutionCacheConfig>,
71    chain_override: Option<Chain>,
72    dev_inspect_disabled: bool,
73    /// Skip full RPC index initialization (use for tests that don't need RPC endpoints)
74    skip_rpc_index_init: bool,
75    /// Skip genesis owner/dynamic-field indexing (use for tests that don't query owned objects)
76    skip_genesis_owner_index: bool,
77}
78
79impl<'a> TestAuthorityBuilder<'a> {
80    pub fn new() -> Self {
81        Self::default()
82    }
83
84    pub fn with_store_base_path(mut self, path: PathBuf) -> Self {
85        assert!(self.store_base_path.replace(path).is_none());
86        self
87    }
88
89    pub fn with_starting_objects(mut self, objects: &'a [Object]) -> Self {
90        assert!(self.starting_objects.replace(objects).is_none());
91        self
92    }
93
94    pub fn with_store(mut self, store: Arc<AuthorityStore>) -> Self {
95        assert!(self.store.replace(store).is_none());
96        self
97    }
98
99    pub fn with_transaction_deny_config(mut self, config: TransactionDenyConfig) -> Self {
100        assert!(self.transaction_deny_config.replace(config).is_none());
101        self
102    }
103
104    pub fn with_dev_inspect_disabled(mut self) -> Self {
105        self.dev_inspect_disabled = true;
106        self
107    }
108
109    pub fn with_certificate_deny_config(mut self, config: CertificateDenyConfig) -> Self {
110        assert!(self.certificate_deny_config.replace(config).is_none());
111        self
112    }
113
114    pub fn with_protocol_config(mut self, config: ProtocolConfig) -> Self {
115        assert!(self.protocol_config.replace(config).is_none());
116        self
117    }
118
119    pub fn with_reference_gas_price(mut self, reference_gas_price: u64) -> Self {
120        // If genesis is already set then setting rgp is meaningless since it will be overwritten.
121        assert!(self.genesis.is_none());
122        assert!(
123            self.reference_gas_price
124                .replace(reference_gas_price)
125                .is_none()
126        );
127        self
128    }
129
130    pub fn with_genesis_and_keypair(
131        mut self,
132        genesis: &'a Genesis,
133        keypair: &'a AuthorityKeyPair,
134    ) -> Self {
135        assert!(self.genesis.replace(genesis).is_none());
136        assert!(self.node_keypair.replace(keypair).is_none());
137        self
138    }
139
140    pub fn with_keypair(mut self, keypair: &'a AuthorityKeyPair) -> Self {
141        assert!(self.node_keypair.replace(keypair).is_none());
142        self
143    }
144
145    /// When providing a network config, we will use the \node_idx validator's
146    /// key as the keypair for the new node.
147    pub fn with_network_config(self, config: &'a NetworkConfig, node_idx: usize) -> Self {
148        self.with_genesis_and_keypair(
149            &config.genesis,
150            config.validator_configs()[node_idx].protocol_key_pair(),
151        )
152    }
153
154    /// Provide a pre-built network config to avoid rebuilding genesis.
155    /// This is useful when creating multiple authorities that should share the same genesis.
156    pub fn with_shared_network_config(mut self, config: &'a NetworkConfig) -> Self {
157        assert!(self.network_config.replace(config).is_none());
158        self
159    }
160
161    pub fn disable_indexer(mut self) -> Self {
162        self.disable_indexer = true;
163        self
164    }
165
166    /// Skip full RPC index initialization. This is much faster for tests
167    /// that don't need RPC endpoint functionality.
168    pub fn skip_rpc_index_init(mut self) -> Self {
169        self.skip_rpc_index_init = true;
170        self
171    }
172
173    /// Skip genesis owner/dynamic-field indexing. This is much faster for tests
174    /// that don't query owned objects via RPC (e.g., get_owned_objects).
175    pub fn skip_genesis_owner_index(mut self) -> Self {
176        self.skip_genesis_owner_index = true;
177        self
178    }
179
180    pub fn insert_genesis_checkpoint(mut self) -> Self {
181        self.insert_genesis_checkpoint = true;
182        self
183    }
184
185    pub fn with_expensive_safety_checks(mut self, config: ExpensiveSafetyCheckConfig) -> Self {
186        assert!(self.expensive_safety_checks.replace(config).is_none());
187        self
188    }
189
190    pub fn with_accounts(mut self, accounts: Vec<AccountConfig>) -> Self {
191        self.accounts = accounts;
192        self
193    }
194
195    pub fn with_authority_overload_config(mut self, config: AuthorityOverloadConfig) -> Self {
196        assert!(self.authority_overload_config.replace(config).is_none());
197        self
198    }
199
200    pub fn with_cache_config(mut self, config: ExecutionCacheConfig) -> Self {
201        self.cache_config = Some(config);
202        self
203    }
204
205    pub fn with_chain_override(mut self, chain: Chain) -> Self {
206        self.chain_override = Some(chain);
207        self
208    }
209
210    pub async fn build(self) -> Arc<AuthorityState> {
211        // `_guard` must be declared here so it is not dropped before
212        // `AuthorityPerEpochStore::new` is called
213        //
214        // Only create a guard if an explicit protocol_config was provided.
215        let _guard = self
216            .protocol_config
217            .clone()
218            .map(|config| ProtocolConfig::apply_overrides_for_testing(move |_, _| config.clone()));
219
220        // Use pre-built network config if available, otherwise build one
221        let owned_network_config;
222        let local_network_config: &NetworkConfig = if let Some(config) = self.network_config {
223            config
224        } else {
225            let mut local_network_config_builder =
226                sui_swarm_config::network_config_builder::ConfigBuilder::new_with_temp_dir()
227                    .with_accounts(self.accounts)
228                    .with_reference_gas_price(self.reference_gas_price.unwrap_or(500));
229            if let Some(protocol_config) = &self.protocol_config {
230                local_network_config_builder =
231                    local_network_config_builder.with_protocol_version(protocol_config.version);
232            }
233            owned_network_config = local_network_config_builder.build();
234            &owned_network_config
235        };
236        let genesis = &self.genesis.unwrap_or(&local_network_config.genesis);
237        let genesis_committee = genesis.committee();
238        let path = self.store_base_path.unwrap_or_else(|| {
239            let dir = std::env::temp_dir();
240            let store_base_path =
241                dir.join(format!("DB_{:?}", nondeterministic!(ObjectID::random())));
242            std::fs::create_dir(&store_base_path).unwrap();
243            store_base_path
244        });
245        let mut config = local_network_config.validator_configs()[0].clone();
246        let registry = Registry::new();
247
248        let authority_store = match self.store {
249            Some(store) => store,
250            None => {
251                let perpetual_tables_options = AuthorityPerpetualTablesOptions::default();
252                let perpetual_tables = Arc::new(AuthorityPerpetualTables::open(
253                    &path.join("store"),
254                    Some(perpetual_tables_options),
255                    None,
256                ));
257                // unwrap ok - for testing only.
258                AuthorityStore::open_with_committee_for_testing(
259                    perpetual_tables,
260                    &genesis_committee,
261                    genesis,
262                )
263                .await
264                .unwrap()
265            }
266        };
267
268        if let Some(cache_config) = self.cache_config {
269            config.execution_cache = cache_config;
270        }
271
272        let keypair = if let Some(keypair) = self.node_keypair {
273            keypair
274        } else {
275            config.protocol_key_pair()
276        };
277
278        let secret = Arc::pin(keypair.copy());
279        let name: AuthorityName = secret.public().into();
280        let cache_metrics = Arc::new(ResolverMetrics::new(&registry));
281        let signature_verifier_metrics = SignatureVerifierMetrics::new(&registry);
282        let epoch_flags = EpochFlag::default_flags_for_new_epoch(&config);
283        let epoch_start_configuration = EpochStartConfiguration::new(
284            genesis.sui_system_object().into_epoch_start_state(),
285            *genesis.checkpoint().digest(),
286            &genesis.objects(),
287            epoch_flags,
288        )
289        .unwrap();
290        let expensive_safety_checks = self.expensive_safety_checks.unwrap_or_default();
291
292        let pruner_watermarks = Arc::new(PrunerWatermarks::default());
293        let checkpoint_store =
294            CheckpointStore::new(&path.join("checkpoints"), pruner_watermarks.clone());
295        let backpressure_manager =
296            BackpressureManager::new_from_checkpoint_store(&checkpoint_store);
297
298        let cache_traits = build_execution_cache(
299            &Default::default(),
300            &registry,
301            &authority_store,
302            backpressure_manager.clone(),
303        );
304
305        let chain_id = ChainIdentifier::from(*genesis.checkpoint().digest());
306        let chain = match self.chain_override {
307            Some(chain) => chain,
308            None => chain_id.chain(),
309        };
310
311        let epoch_store = AuthorityPerEpochStore::new(
312            name,
313            Arc::new(genesis_committee.clone()),
314            &path.join("store"),
315            None,
316            EpochMetrics::new(&registry),
317            epoch_start_configuration,
318            cache_traits.backing_package_store.clone(),
319            cache_traits.object_store.clone(),
320            cache_metrics,
321            signature_verifier_metrics,
322            &expensive_safety_checks,
323            (chain_id, chain),
324            checkpoint_store
325                .get_highest_executed_checkpoint_seq_number()
326                .unwrap()
327                .unwrap_or(0),
328            0,
329            Arc::new(SubmittedTransactionCacheMetrics::new(&registry)),
330        )
331        .expect("failed to create authority per epoch store");
332
333        let committee_store = Arc::new(CommitteeStore::new(
334            path.join("epochs"),
335            &genesis_committee,
336            None,
337        ));
338
339        if self.insert_genesis_checkpoint {
340            checkpoint_store.insert_genesis_checkpoint(
341                genesis.checkpoint(),
342                genesis.checkpoint_contents().clone(),
343                &epoch_store,
344            );
345        }
346        let index_store = if self.disable_indexer {
347            None
348        } else {
349            Some(Arc::new(IndexStore::new(
350                path.join("indexes"),
351                &registry,
352                epoch_store
353                    .protocol_config()
354                    .max_move_identifier_len_as_option(),
355                false,
356            )))
357        };
358
359        let rpc_index = if self.disable_indexer {
360            None
361        } else if self.skip_rpc_index_init {
362            Some(Arc::new(RpcIndexStore::new_without_init(&path)))
363        } else {
364            Some(Arc::new(
365                RpcIndexStore::new(
366                    &path,
367                    &authority_store,
368                    &checkpoint_store,
369                    &epoch_store,
370                    &cache_traits.backing_package_store,
371                    pruner_watermarks.checkpoint_id.clone(),
372                    sui_config::RpcConfig::default(),
373                )
374                .await,
375            ))
376        };
377
378        let transaction_deny_config = self.transaction_deny_config.unwrap_or_default();
379        let certificate_deny_config = self.certificate_deny_config.unwrap_or_default();
380        let authority_overload_config = self.authority_overload_config.unwrap_or_default();
381        let mut pruning_config = AuthorityStorePruningConfig::default();
382        if !epoch_store
383            .protocol_config()
384            .simplified_unwrap_then_delete()
385        {
386            // We cannot prune tombstones if simplified_unwrap_then_delete is not enabled.
387            pruning_config.set_killswitch_tombstone_pruning(true);
388        }
389
390        config.transaction_deny_config = transaction_deny_config;
391        config.certificate_deny_config = certificate_deny_config;
392        config.authority_overload_config = authority_overload_config;
393        config.authority_store_pruning_config = pruning_config;
394        config.dev_inspect_disabled = self.dev_inspect_disabled;
395
396        let chain_identifier = ChainIdentifier::from(*genesis.checkpoint().digest());
397        let policy_config = config.policy_config.clone();
398        let firewall_config = config.firewall_config.clone();
399
400        let genesis_objects_for_index = if self.skip_genesis_owner_index {
401            &[][..]
402        } else {
403            genesis.objects()
404        };
405        let state = AuthorityState::new(
406            name,
407            secret,
408            SupportedProtocolVersions::SYSTEM_DEFAULT,
409            authority_store,
410            cache_traits,
411            epoch_store.clone(),
412            committee_store,
413            index_store,
414            rpc_index,
415            checkpoint_store,
416            &registry,
417            genesis_objects_for_index,
418            &DBCheckpointConfig::default(),
419            config.clone(),
420            chain_identifier,
421            policy_config,
422            firewall_config,
423            Arc::new(PrunerWatermarks::default()),
424        )
425        .await;
426
427        // Set up randomness with no-op consensus (DKG will not complete).
428        if epoch_store.randomness_state_enabled() {
429            let consensus_client = Box::new(MockConsensusClient::new(
430                Arc::downgrade(&state),
431                ConsensusMode::Noop,
432            ));
433            let randomness_manager = RandomnessManager::try_new(
434                Arc::downgrade(&epoch_store),
435                consensus_client,
436                randomness::Handle::new_stub(),
437                config.protocol_key_pair(),
438            )
439            .await;
440            if let Some(randomness_manager) = randomness_manager {
441                // Randomness might fail if test configuration does not permit DKG init.
442                // In that case, skip setting it up.
443                epoch_store
444                    .set_randomness_manager(randomness_manager)
445                    .await
446                    .unwrap();
447            }
448        }
449
450        // For any type of local testing that does not actually spawn a node, the checkpoint executor
451        // won't be started, which means we won't actually execute the genesis transaction. In that case,
452        // the genesis objects (e.g. all the genesis test coins) won't be accessible. Executing it
453        // explicitly makes sure all genesis objects are ready for use.
454        state
455            .try_execute_immediately(
456                &VerifiedExecutableTransaction::new_from_checkpoint(
457                    VerifiedTransaction::new_unchecked(genesis.transaction().clone()),
458                    genesis.epoch(),
459                    genesis.checkpoint().sequence_number,
460                ),
461                ExecutionEnv::new(),
462                &state.epoch_store_for_testing(),
463            )
464            .await
465            .unwrap();
466
467        let batch = state
468            .get_cache_commit()
469            .build_db_batch(epoch_store.epoch(), &[*genesis.transaction().digest()]);
470
471        state.get_cache_commit().commit_transaction_outputs(
472            epoch_store.epoch(),
473            batch,
474            &[*genesis.transaction().digest()],
475        );
476
477        // We want to insert these objects directly instead of relying on genesis because
478        // genesis process would set the previous transaction field for these objects, which would
479        // change their object digest. This makes it difficult to write tests that want to use
480        // these objects directly.
481        // TODO: we should probably have a better way to do this.
482        if let Some(starting_objects) = self.starting_objects {
483            state
484                .insert_objects_unsafe_for_testing_only(starting_objects)
485                .await
486                .unwrap();
487        };
488
489        state
490    }
491}
sui_core/authority/test_authority_builder.rs

sui_core/authority/
test_authority_builder.rs
