Struct sui_config::p2p::StateSyncConfig

pub struct StateSyncConfig {

    pub pinned_checkpoints: Vec<(CheckpointSequenceNumber, CheckpointDigest)>,
    pub interval_period_ms: Option<u64>,
    pub mailbox_capacity: Option<usize>,
    pub synced_checkpoint_broadcast_channel_capacity: Option<usize>,
    pub checkpoint_header_download_concurrency: Option<usize>,
    pub checkpoint_content_download_concurrency: Option<usize>,
    pub checkpoint_content_download_tx_concurrency: Option<u64>,
    pub timeout_ms: Option<u64>,
    pub checkpoint_content_timeout_ms: Option<u64>,
    pub push_checkpoint_summary_rate_limit: Option<NonZeroU32>,
    pub get_checkpoint_summary_rate_limit: Option<NonZeroU32>,
    pub get_checkpoint_contents_rate_limit: Option<NonZeroU32>,
    pub get_checkpoint_contents_inflight_limit: Option<usize>,
    pub get_checkpoint_contents_per_checkpoint_limit: Option<usize>,
    pub wait_interval_when_no_peer_to_sync_content_ms: Option<u64>,
}

Fields

pinned_checkpoints: Vec<(CheckpointSequenceNumber, CheckpointDigest)>

List of “known-good” checkpoints that state sync will be forced to use. State sync will skip verification of pinned checkpoints, and reject checkpoints with digests that don’t match pinned values for a given sequence number.

This can be used:

• in case of a fork, to prevent the node from syncing to the wrong chain.
• in case of a network stall, to force the node to proceed with a manually-injected checkpoint.

interval_period_ms: Option<u64>

Query peers for their latest checkpoint every interval period.

If unspecified, this will default to 5,000 milliseconds.

mailbox_capacity: Option<usize>

Size of the StateSync actor’s mailbox.

If unspecified, this will default to 1,024.

synced_checkpoint_broadcast_channel_capacity: Option<usize>

Size of the broadcast channel use for notifying other systems of newly sync’ed checkpoints.

If unspecified, this will default to 1,024.

checkpoint_header_download_concurrency: Option<usize>

Set the upper bound on the number of checkpoint headers to be downloaded concurrently.

If unspecified, this will default to 400.

checkpoint_content_download_concurrency: Option<usize>

Set the upper bound on the number of checkpoint contents to be downloaded concurrently.

If unspecified, this will default to 400.

checkpoint_content_download_tx_concurrency: Option<u64>

Set the upper bound on the number of individual transactions contained in checkpoint contents to be downloaded concurrently. If both this value and checkpoint_content_download_concurrency are set, the lower of the two will apply.

If unspecified, this will default to 50,000.

timeout_ms: Option<u64>

Set the timeout that should be used when sending most state-sync RPC requests.

If unspecified, this will default to 10,000 milliseconds.

checkpoint_content_timeout_ms: Option<u64>

Set the timeout that should be used when sending RPC requests to sync checkpoint contents.

If unspecified, this will default to 10,000 milliseconds.

push_checkpoint_summary_rate_limit: Option<NonZeroU32>

Per-peer rate-limit (in requests/sec) for the PushCheckpointSummary RPC.

If unspecified, this will default to no limit.

get_checkpoint_summary_rate_limit: Option<NonZeroU32>

Per-peer rate-limit (in requests/sec) for the GetCheckpointSummary RPC.

If unspecified, this will default to no limit.

get_checkpoint_contents_rate_limit: Option<NonZeroU32>

Per-peer rate-limit (in requests/sec) for the GetCheckpointContents RPC.

If unspecified, this will default to no limit.

get_checkpoint_contents_inflight_limit: Option<usize>

Per-peer inflight limit for the GetCheckpointContents RPC.

If unspecified, this will default to no limit.

get_checkpoint_contents_per_checkpoint_limit: Option<usize>

Per-checkpoint inflight limit for the GetCheckpointContents RPC. This is enforced globally across all peers.

If unspecified, this will default to no limit.

wait_interval_when_no_peer_to_sync_content_ms: Option<u64>

The amount of time to wait before retry if there are no peers to sync content from. If unspecified, this will set to default value

Implementations

impl StateSyncConfig

pub fn interval_period(&self) -> Duration

pub fn mailbox_capacity(&self) -> usize

pub fn synced_checkpoint_broadcast_channel_capacity(&self) -> usize

pub fn checkpoint_header_download_concurrency(&self) -> usize

pub fn checkpoint_content_download_concurrency(&self) -> usize

pub fn checkpoint_content_download_tx_concurrency(&self) -> u64

pub fn timeout(&self) -> Duration

pub fn checkpoint_content_timeout(&self) -> Duration

pub fn wait_interval_when_no_peer_to_sync_content(&self) -> Duration

Trait Implementations

impl Clone for StateSyncConfig

fn clone(&self) -> StateSyncConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateSyncConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StateSyncConfig

fn default() -> StateSyncConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateSyncConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StateSyncConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.