Struct Sync

pub struct Sync<N: Network> { /* private fields */ }

Block synchronization logic for validators.

Synchronization works differently for nodes that act as validators in AleoBFT; In the common case, validators generate blocks after receiving an anchor block that has been accepted by a supermajority of the committee instead of fetching entire blocks from other nodes. However, if a validator does not have an up-to-date DAG, it might still fetch entire blocks from other nodes.

This struct also manages fetching certificates from other validators during normal operation, and blocks when falling behind.

Finally, Sync handles synchronization of blocks with the validator’s local storage: it loads blocks from the storage on startup and writes new blocks to the storage after discovering them.

Implementations

impl<N: Network> Sync<N>

pub fn new( gateway: Gateway<N>, storage: Storage<N>, ledger: Arc<dyn LedgerService<N>>, block_sync: Arc<BlockSync<N>>, ) -> Self

Initializes a new sync instance.

pub async fn initialize(&self, bft_sender: Option<BFTSender<N>>) -> Result<()>

Initializes the sync module and sync the storage with the ledger at bootup.

pub async fn run( &self, ping: Option<Arc<Ping<N>>>, sync_receiver: SyncReceiver<N>, ) -> Result<()>

Starts the sync module.

When this function returns successfully, the sync module will have spawned background tasks that fetch blocks from other validators.

impl<N: Network> Sync<N>

pub fn is_synced(&self) -> bool

Returns true if the node is synced and has connected peers.

pub fn num_blocks_behind(&self) -> Option<u32>

Returns the number of blocks the node is behind the greatest peer height.

pub fn get_block_locators(&self) -> Result<BlockLocators<N>>

Returns the current block locators of the node.

impl<N: Network> Sync<N>

pub async fn send_certificate_request( &self, peer_ip: SocketAddr, certificate_id: Field<N>, ) -> Result<BatchCertificate<N>>

Sends a certificate request to the specified peer.

impl<N: Network> Sync<N>

pub async fn shut_down(&self)

Shuts down the primary.

Trait Implementations

impl<N: Clone + Network> Clone for Sync<N>

fn clone(&self) -> Sync<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.