Struct BlockSync

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

A struct that keeps track of the current block sync state.

State

• When a request is inserted, the requests map and request_timestamps map insert an entry for the request height.
• When a response is inserted, the responses map inserts the entry for the request height.
• When a request is completed, the requests map still has the entry, but its sync_ips is empty; the request_timestamps map remains unchanged.
• When a response is removed/completed, the requests map and request_timestamps map also remove the entry for the request height.
• When a request is timed out, the requests, request_timestamps, and responses map remove the entry for the request height.

Implementations

impl<N: Network> BlockSync<N>

pub fn new( mode: BlockSyncMode, ledger: Arc<dyn LedgerService<N>>, tcp: Tcp, ) -> Self

Initializes a new block sync module.

pub const fn mode(&self) -> BlockSyncMode

Returns the block sync mode.

pub fn is_block_synced(&self) -> bool

Returns true if the node is synced up to the latest block (within the given tolerance).

pub fn num_blocks_behind(&self) -> u32

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

impl<N: Network> BlockSync<N>

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

Returns the block locators.

pub async fn try_block_sync<C: CommunicationService>(&self, communication: &C)

Performs one iteration of the block sync.

pub fn process_block_response( &self, peer_ip: SocketAddr, blocks: Vec<Block<N>>, ) -> Result<()>

Processes the block response from the given peer IP.

pub fn peek_next_block(&self, next_height: u32) -> Option<Block<N>>

Returns the next block for the given next_height if the request is complete, or None otherwise. This does not remove the block from the responses map.

pub fn advance_with_sync_blocks( &self, peer_ip: SocketAddr, blocks: Vec<Block<N>>, ) -> Result<()>

Attempts to advance with blocks from the sync pool.

impl<N: Network> BlockSync<N>

pub fn find_sync_peers(&self) -> Option<(IndexMap<SocketAddr, u32>, u32)>

Returns the sync peers with their latest heights, and their minimum common ancestor, if the node can sync. This function returns peers that are consistent with each other, and have a block height that is greater than the ledger height of this node.

pub fn update_peer_locators( &self, peer_ip: SocketAddr, locators: BlockLocators<N>, ) -> Result<()>

Updates the block locators and common ancestors for the given peer IP.

This function does not need to check that the block locators are well-formed, because that is already done in BlockLocators::new(), as noted in BlockLocators.

This function does not check that the block locators are consistent with the peer’s previous block locators or other peers’ block locators.

pub fn remove_peer(&self, peer_ip: &SocketAddr)

TODO (howardwu): Remove the common_ancestor entry. But check that this is safe (that we don’t rely upon it for safety when we re-connect with the same peer). Removes the peer from the sync pool, if they exist.

impl<N: Network> BlockSync<N>

pub fn remove_block_response(&self, height: u32)

Removes the block response for the given height This may only be called after peek_next_block, which checked if the request for the given height was complete.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Network> Debug for BlockSync<N>

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

Formats the value using the given formatter.