Enum SyncProtocol 

pub enum SyncProtocol {
    None,
    DeltaSync {
        missing_delta_ids: Vec<[u8; 32]>,
    },
    HashComparison {
        root_hash: [u8; 32],
        divergent_subtrees: Vec<[u8; 32]>,
    },
    Snapshot {
        compressed: bool,
        verified: bool,
    },
    BloomFilter {
        filter_size: u64,
        false_positive_rate: f64,
    },
    SubtreePrefetch {
        subtree_roots: Vec<[u8; 32]>,
    },
    LevelWise {
        max_depth: u32,
    },
}

Sync protocol selection for negotiation.

Each variant represents a different synchronization strategy with different trade-offs in terms of bandwidth, latency, and computational overhead.

See CIP §1 - Sync Protocol Types.

Variants

None

No sync needed - root hashes already match.

DeltaSync

Delta-based sync via DAG traversal.

Best for: Small gaps, real-time updates.

Fields

missing_delta_ids: Vec<[u8; 32]>

Delta IDs that the requester is missing.

HashComparison

Hash-based Merkle tree comparison.

Best for: General-purpose catch-up, 10-50% divergence.

Fields

root_hash: [u8; 32]

Root hash to compare against.

divergent_subtrees: Vec<[u8; 32]>

Subtree roots that differ (if known).

Snapshot

Full state snapshot transfer.

CRITICAL: Only valid for fresh nodes (Invariant I5). Initialized nodes MUST use state-based sync with CRDT merge instead.

Fields

compressed: bool

Whether the snapshot is compressed.

verified: bool

Whether the responder guarantees snapshot is verifiable.

BloomFilter

Bloom filter-based quick diff.

Best for: Large trees with small diff (<10% divergence).

Fields

filter_size: u64

Size of the bloom filter in bits.

false_positive_rate: f64

Expected false positive rate (0.0 to 1.0).

Note: Validation of bounds is performed when constructing the actual bloom filter, not at protocol negotiation time. Invalid values will cause filter construction to fail gracefully.

SubtreePrefetch

Subtree prefetch for deep localized changes.

Best for: Deep hierarchies with localized changes.

Fields

subtree_roots: Vec<[u8; 32]>

Root IDs of subtrees to prefetch.

LevelWise

Level-wise sync for wide shallow trees.

Best for: Trees with depth ≤ 2 and many children.

Fields

max_depth: u32

Maximum depth to sync.

Implementations

impl SyncProtocol

pub fn kind(&self) -> SyncProtocolKind

Returns the protocol kind (discriminant) for this protocol.

Useful for capability matching where the protocol-specific data is irrelevant.

Trait Implementations

impl BorshDeserialize for SyncProtocol

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for SyncProtocol

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for SyncProtocol

fn clone(&self) -> SyncProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncProtocol

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

Formats the value using the given formatter.

impl Default for SyncProtocol

fn default() -> Self

Returns the “default value” for a type.

impl EnumExt for SyncProtocol

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl From<&SyncProtocol> for SyncProtocolKind

fn from(protocol: &SyncProtocol) -> Self

Converts to this type from the input type.

impl PartialEq for SyncProtocol

fn eq(&self, other: &SyncProtocol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SyncProtocol