Struct zebra_rpc::sync::TrustedChainSync

struct TrustedChainSync {
    rpc_client: RpcRequestClient,
    db: ZebraDb,
    non_finalized_state: NonFinalizedState,
    chain_tip_sender: ChainTipSender,
    non_finalized_state_sender: Sender<NonFinalizedState>,
}

Syncs non-finalized blocks in the best chain from a trusted Zebra node’s RPC methods.

Fields

rpc_client: RpcRequestClient

RPC client for calling Zebra’s RPC methods.

db: ZebraDb

The read state service.

non_finalized_state: NonFinalizedState

The non-finalized state - currently only contains the best chain.

chain_tip_sender: ChainTipSender

The chain tip sender for updating LatestChainTip and ChainTipChange.

non_finalized_state_sender: Sender<NonFinalizedState>

The non-finalized state sender, for updating the ReadStateService when the non-finalized best chain changes.

Implementations

impl TrustedChainSync

pub async fn spawn( rpc_address: SocketAddr, db: ZebraDb, non_finalized_state_sender: Sender<NonFinalizedState>, ) -> (LatestChainTip, ChainTipChange, JoinHandle<()>)

Creates a new TrustedChainSync with a ChainTipSender, then spawns a task to sync blocks from the node’s non-finalized best chain.

Returns the LatestChainTip, ChainTipChange, and a [JoinHandle] for the sync task.

async fn sync(&mut self)

Starts syncing blocks from the node’s non-finalized best chain and checking for chain tip changes in the finalized state.

When the best chain tip in Zebra is not available in the finalized state or the local non-finalized state, gets any unavailable blocks in Zebra’s best chain from the RPC server, adds them to the local non-finalized state, then sends the updated chain tip block and non-finalized state to the ChainTipSender and non-finalized state sender.

async fn try_catch_up_with_primary(&self)

Tries to catch up to the primary db instance for an up-to-date view of finalized blocks.

async fn is_finalized_tip_change(&self, target_tip_hash: Hash) -> bool

If the non-finalized state is empty, tries to catch up to the primary db instance for an up-to-date view of finalized blocks.

Returns true if the non-finalized state is empty and the target hash is in the finalized state.

async fn next_block_height_and_prev_hash(&self) -> (Height, Hash)

Returns the current tip hash and the next height immediately after the current tip height.

async fn finalized_chain_tip_block(&self) -> Option<ChainTipBlock>

Reads the finalized tip block from the secondary db instance and converts it to a ChainTipBlock.

async fn wait_for_chain_tip_change( &self, last_chain_tip_hash: Hash, ) -> (Height, Hash)

Accepts a block hash.

Polls getbestblockheightandhash RPC method until it successfully returns a block hash that is different from the last chain tip hash.

Returns the node’s best block hash.

fn update_channels(&mut self, best_tip: impl Into<ChainTipBlock>)

Sends the new chain tip and non-finalized state to the latest chain channels.

Trait Implementations

impl Debug for TrustedChainSync

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

Formats the value using the given formatter.