Struct StateSync 

pub struct StateSync { /* private fields */ }

The state sync component encompasses the client’s sync logic. It is then used to request updates from the node and apply them to the relevant elements. The updates are then returned and can be applied to the store to persist the changes.

Implementations

impl StateSync

pub fn new( rpc_api: Arc<dyn NodeRpcClient>, note_screener: Arc<dyn OnNoteReceived>, tx_discard_delta: Option<u32>, ) -> StateSync

Creates a new instance of the state sync component.

The nullifiers sync is enabled by default. To disable it, see Self::disable_nullifier_sync.

Arguments

• rpc_api - The RPC client used to communicate with the node.
• note_screener - The note screener used to check the relevance of notes.
• tx_discard_delta - Number of blocks after which pending transactions are discarded.

pub fn disable_nullifier_sync(&mut self)

Disables the nullifier sync.

When disabled, the component will not query the node for new nullifiers after each sync step. This is useful for clients that don’t need to track note consumption, such as faucets.

pub fn enable_nullifier_sync(&mut self)

Enables the nullifier sync.

pub async fn sync_state( &self, current_partial_mmr: &mut PartialMmr, input: StateSyncInput, ) -> Result<StateSyncUpdate, ClientError>

Syncs the state of the client with the chain tip of the node, returning the updates that should be applied to the store.

Use Client::build_sync_input() to build the default input, or assemble it manually for custom sync. The current_partial_mmr is taken by mutable reference so callers can keep it in memory across syncs.

During the sync process, the following steps are performed:

1. Fetch sync data from the node (MMR delta, note inclusions, transactions).
2. Update account states (fetch updated public accounts, flag mismatched private ones).
3. Advance the partial MMR to the chain tip.
4. Screen note inclusions via the configured OnNoteReceived callback and track relevant blocks in the MMR.
5. Process transaction inclusions (commit local txs, record external consumers, discard stale/expired txs, commit output notes).
6. Detect consumed notes via nullifier sync (optional, see Self::disable_nullifier_sync).

Trait Implementations

impl Clone for StateSync

fn clone(&self) -> StateSync

Returns a duplicate of the value.

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

Performs copy-assignment from source.