Struct TestClusterBuilder 

pub struct TestClusterBuilder { /* private fields */ }

Implementations

impl TestClusterBuilder

pub fn new() -> Self

pub fn with_state_sync_config(self, config: StateSyncConfig) -> Self

pub fn with_peer_deny_sync_config_per_validator( self, f: PeerDenySyncConfigCallback, ) -> Self

Per-validator hook for peer_deny_sync_config. The closure receives this validator’s authority name and the slice of all genesis-committee authority names, so callers can compute an allowlist that references peers (e.g. “trust everyone but myself”).

pub fn with_execution_time_observer_config( self, config: ExecutionTimeObserverConfig, ) -> Self

pub fn with_validator_observer_config( self, c: ValidatorObserverConfigCallback, ) -> Self

pub fn with_observer_fullnode(self) -> Self

Adds a fullnode to the cluster that syncs as a consensus observer, subscribed to the first validator. Unless a validator observer config is provided, the first validator gets its observer server enabled. The observer is available via TestCluster::observer_node().

The first validator must end up with its observer server enabled, which build() validates: a callback passed to with_validator_observer_config must return Some(_) for index 0, and a prebuilt network config passed to set_network_config must already enable the observer server on the first validator (the callback is not applied to prebuilt network configs).

pub fn with_fullnode_run_with_range( self, run_with_range: Option<RunWithRange>, ) -> Self

pub fn with_fullnode_rpc_port(self, rpc_port: u16) -> Self

pub fn set_genesis_config(self, genesis_config: GenesisConfig) -> Self

pub fn set_network_config(self, network_config: NetworkConfig) -> Self

pub fn with_objects<I: IntoIterator<Item = Object>>(self, objects: I) -> Self

pub fn with_num_validators(self, num: usize) -> Self

Set the number of default validators to spawn. Can be overridden by with_validators, if you need to provide more specific genesis configs for each validator.

pub fn with_validators(self, validators: Vec<ValidatorGenesisConfig>) -> Self

Provide validator genesis configs, overrides the num_validators setting.

pub fn enable_fullnode_events(self) -> Self

pub fn disable_fullnode_pruning(self) -> Self

pub fn with_enable_db_checkpoints_validators(self) -> Self

pub fn with_enable_db_checkpoints_fullnodes(self) -> Self

pub fn with_epoch_duration_ms(self, epoch_duration_ms: u64) -> Self

pub fn with_stake_subsidy_start_epoch( self, stake_subsidy_start_epoch: u64, ) -> Self

pub fn with_supported_protocol_versions( self, c: SupportedProtocolVersions, ) -> Self

pub fn with_jwk_fetch_interval(self, i: Duration) -> Self

pub fn with_fullnode_supported_protocol_versions_config( self, c: SupportedProtocolVersions, ) -> Self

pub fn with_protocol_version(self, v: ProtocolVersion) -> Self

pub fn with_supported_protocol_version_callback( self, func: SupportedProtocolVersionsCallback, ) -> Self

pub fn with_global_state_hash_v2_enabled_callback( self, func: GlobalStateHashV2EnabledCallback, ) -> Self

pub fn with_validator_candidates( self, addresses: impl IntoIterator<Item = SuiAddress>, ) -> Self

pub fn with_num_unpruned_validators(self, n: usize) -> Self

pub fn with_accounts(self, accounts: Vec<AccountConfig>) -> Self

pub fn with_additional_accounts(self, accounts: Vec<AccountConfig>) -> Self

pub fn with_config_dir(self, config_dir: PathBuf) -> Self

pub fn with_default_jwks(self) -> Self

pub fn with_authority_overload_config( self, config: AuthorityOverloadConfig, ) -> Self

pub fn with_consensus_transaction_pool_config( self, config: ConsensusTransactionPoolConfig, ) -> Self

pub fn with_execution_cache_config(self, config: ExecutionCacheConfig) -> Self

pub fn with_data_ingestion_dir(self, path: PathBuf) -> Self

pub fn with_rpc_config(self, config: RpcConfig) -> Self

pub fn with_chain_override(self, chain: Chain) -> Self

pub async fn build(self) -> TestCluster

Trait Implementations

impl Default for TestClusterBuilder

fn default() -> Self

Returns the “default value” for a type.