pub struct SyncableServer<S: ShardStore<H = MerkleHashVote, CheckpointId = u32>> { /* private fields */ }Expand description
A GenericTreeServer augmented with per-block leaf tracking for the
crate::sync_api::TreeSyncApi.
The sync protocol needs to know which leaves were appended in each block so
that clients can download compact-block diffs. That tracking is a sync
concern, not a tree concern, so it lives here rather than on
GenericTreeServer.
Use the MemoryTreeServer type alias for the common in-memory case.
Implementations§
Source§impl<S> SyncableServer<S>
impl<S> SyncableServer<S>
Sourcepub fn new(tree: GenericTreeServer<S>) -> Self
pub fn new(tree: GenericTreeServer<S>) -> Self
Wrap an existing GenericTreeServer with sync tracking.
Sourcepub fn append(&mut self, leaf: Fp) -> Result<u64, ShardTreeError<S::Error>>
pub fn append(&mut self, leaf: Fp) -> Result<u64, ShardTreeError<S::Error>>
Append a single leaf and record it in the pending block.
Sourcepub fn append_two(
&mut self,
first: Fp,
second: Fp,
) -> Result<u64, ShardTreeError<S::Error>>
pub fn append_two( &mut self, first: Fp, second: Fp, ) -> Result<u64, ShardTreeError<S::Error>>
Append two leaves (e.g. new VAN + VC from MsgCastVote).
Sourcepub fn checkpoint(
&mut self,
height: u32,
) -> Result<(), CheckpointError<S::Error>>
pub fn checkpoint( &mut self, height: u32, ) -> Result<(), CheckpointError<S::Error>>
Snapshot the current tree state and record block-level commitments.
§Errors
Returns CheckpointError::NotMonotonic if height is not strictly
greater than the previous checkpoint height.
Sourcepub fn root_at_height(&self, height: u32) -> Option<Fp>
pub fn root_at_height(&self, height: u32) -> Option<Fp>
Root at a specific checkpoint height.
Sourcepub fn path(&self, position: u64, anchor_height: u32) -> Option<MerklePath>
pub fn path(&self, position: u64, anchor_height: u32) -> Option<MerklePath>
Build a Merkle path for the leaf at position at anchor_height.
Sourcepub fn latest_checkpoint(&self) -> Option<u32>
pub fn latest_checkpoint(&self) -> Option<u32>
Latest checkpoint height.
Trait Implementations§
Source§impl<S> TreeSyncApi for SyncableServer<S>
impl<S> TreeSyncApi for SyncableServer<S>
Source§type Error = Infallible
type Error = Infallible
SyncableServer never fails when serving sync data — the blocks map
is an in-memory BTreeMap and all root lookups are infallible.
Source§fn get_block_commitments(
&self,
from_height: u32,
to_height: u32,
) -> Result<Vec<BlockCommitments>, Infallible>
fn get_block_commitments( &self, from_height: u32, to_height: u32, ) -> Result<Vec<BlockCommitments>, Infallible>
Source§fn get_root_at_height(&self, height: u32) -> Result<Option<Fp>, Infallible>
fn get_root_at_height(&self, height: u32) -> Result<Option<Fp>, Infallible>
Source§fn get_tree_state(&self) -> Result<TreeState, Infallible>
fn get_tree_state(&self) -> Result<TreeState, Infallible>
Auto Trait Implementations§
impl<S> Freeze for SyncableServer<S>where
S: Freeze,
impl<S> RefUnwindSafe for SyncableServer<S>where
S: RefUnwindSafe,
impl<S> Send for SyncableServer<S>where
S: Send,
impl<S> Sync for SyncableServer<S>where
S: Sync,
impl<S> Unpin for SyncableServer<S>where
S: Unpin,
impl<S> UnsafeUnpin for SyncableServer<S>where
S: UnsafeUnpin,
impl<S> UnwindSafe for SyncableServer<S>where
S: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.