Struct SyncState

pub struct SyncState(/* private fields */);

SyncState is a structure that holds the state of the syncing process.

The intended use case is to signalize to Web3 API whether the node is fully synced. Data inside is expected to be updated by both MainNodeFetcher (on last block available on the main node) and ExternalIO (on latest sealed L2 block).

This structure operates on L2 blocks rather than L1 batches, since this is the default unit used in the web3 API.

Implementations

impl SyncState

pub fn get_main_node_block(&self) -> L2BlockNumber

pub fn get_local_block(&self) -> L2BlockNumber

pub async fn wait_for_local_block(&self, want: L2BlockNumber)

pub async fn wait_for_main_node_block( &self, ctx: &Ctx, pred: impl Fn(BlockNumber) -> bool, ) -> OrCanceled<BlockNumber>

Waits until the main node block is greater or equal to the given block number. Returns the current main node block number.

pub fn set_main_node_block(&self, block: L2BlockNumber)

pub fn is_synced(&self) -> bool

pub async fn run_updater( self, connection_pool: ConnectionPool<Core>, main_node_client: Box<DynClient<L2>>, stop_receiver: Receiver<bool>, ) -> Result<()>

Trait Implementations

impl CheckHealth for SyncState

fn name(&self) -> &'static str

Unique name of the component.

fn check_health<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Health> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks health of the component.

impl Clone for SyncState

fn clone(&self) -> SyncState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncState

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

Formats the value using the given formatter.

impl Default for SyncState

fn default() -> Self

Returns the “default value” for a type.

impl StateKeeperOutputHandler for SyncState

fn initialize<'life0, 'life1, 'async_trait>( &'life0 mut self, cursor: &'life1 IoCursor, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Initializes this handler. This method will be called on state keeper initialization before any other calls. The default implementation does nothing.

fn handle_l2_block<'life0, 'life1, 'async_trait>( &'life0 mut self, updates_manager: &'life1 UpdatesManager, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handles an L2 block produced by the state keeper.

fn handle_l1_batch<'life0, 'async_trait>( &'life0 mut self, updates_manager: Arc<UpdatesManager>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles an L1 batch produced by the state keeper.