miden_client/sync/
mod.rs

1//! Provides the client APIs for synchronizing the client's local state with the Miden
2//! network. It ensures that the client maintains a valid, up-to-date view of the chain.
3//!
4//! ## Overview
5//!
6//! This module handles the synchronization process between the local client and the Miden network.
7//! The sync operation involves:
8//!
9//! - Querying the Miden node for state updates using tracked account IDs, note tags, and nullifier
10//!   prefixes.
11//! - Processing the received data to update note inclusion proofs, reconcile note state (new,
12//!   committed, or consumed), and update account states.
13//! - Incorporating new block headers and updating the local Merkle Mountain Range (MMR) with new
14//!   peaks and authentication nodes.
15//! - Aggregating transaction updates to determine which transactions have been committed or
16//!   discarded.
17//!
18//! The result of the synchronization process is captured in a [`SyncSummary`], which provides
19//! a summary of the new block number along with lists of received, committed, and consumed note
20//! IDs, updated account IDs, locked accounts, and committed transaction IDs.
21//!
22//! Once the data is requested and retrieved, updates are persisted in the client's store.
23//!
24//! ## Examples
25//!
26//! The following example shows how to initiate a state sync and handle the resulting summary:
27//!
28//! ```rust
29//! # use miden_client::auth::TransactionAuthenticator;
30//! # use miden_client::sync::SyncSummary;
31//! # use miden_client::{Client, ClientError};
32//! # use miden_objects::{block::BlockHeader, Felt, Word, StarkField};
33//! # use miden_objects::crypto::rand::FeltRng;
34//! # async fn run_sync<AUTH: TransactionAuthenticator + Sync + 'static>(client: &mut Client<AUTH>) -> Result<(), ClientError> {
35//! // Attempt to synchronize the client's state with the Miden network.
36//! // The requested data is based on the client's state: it gets updates for accounts, relevant
37//! // notes, etc. For more information on the data that gets requested, see the doc comments for
38//! // `sync_state()`.
39//! let sync_summary: SyncSummary = client.sync_state().await?;
40//!
41//! println!("Synced up to block number: {}", sync_summary.block_num);
42//! println!("Committed notes: {}", sync_summary.committed_notes.len());
43//! println!("Consumed notes: {}", sync_summary.consumed_notes.len());
44//! println!("Updated accounts: {}", sync_summary.updated_accounts.len());
45//! println!("Locked accounts: {}", sync_summary.locked_accounts.len());
46//! println!("Committed transactions: {}", sync_summary.committed_transactions.len());
47//!
48//! Ok(())
49//! # }
50//! ```
51//!
52//! The `sync_state` method loops internally until the client is fully synced to the network tip.
53//!
54//! For more advanced usage, refer to the individual functions (such as
55//! `committed_note_updates` and `consumed_note_updates`) to understand how the sync data is
56//! processed and applied to the local store.
57
58use alloc::collections::BTreeSet;
59use alloc::sync::Arc;
60use alloc::vec::Vec;
61use core::cmp::max;
62
63use miden_objects::account::AccountId;
64use miden_objects::block::BlockNumber;
65use miden_objects::note::{NoteId, NoteTag};
66use miden_objects::transaction::TransactionId;
67use miden_tx::auth::TransactionAuthenticator;
68use miden_tx::utils::{Deserializable, DeserializationError, Serializable};
69use tracing::{debug, info};
70
71use crate::note::NoteScreener;
72use crate::store::{NoteFilter, TransactionFilter};
73use crate::{Client, ClientError};
74mod block_header;
75
76mod tag;
77pub use tag::{NoteTagRecord, NoteTagSource};
78
79mod state_sync;
80pub use state_sync::{NoteUpdateAction, OnNoteReceived, StateSync};
81
82mod state_sync_update;
83pub use state_sync_update::{
84    AccountUpdates,
85    BlockUpdates,
86    StateSyncUpdate,
87    TransactionUpdateTracker,
88};
89
90/// Client synchronization methods.
91impl<AUTH> Client<AUTH>
92where
93    AUTH: TransactionAuthenticator + Sync + 'static,
94{
95    // SYNC STATE
96    // --------------------------------------------------------------------------------------------
97
98    /// Returns the block number of the last state sync block.
99    pub async fn get_sync_height(&self) -> Result<BlockNumber, ClientError> {
100        self.store.get_sync_height().await.map_err(Into::into)
101    }
102
103    /// Syncs the client's state with the current state of the Miden network and returns a
104    /// [`SyncSummary`] corresponding to the local state update.
105    ///
106    /// The sync process is done in multiple steps:
107    /// 1. A request is sent to the node to get the state updates. This request includes tracked
108    ///    account IDs and the tags of notes that might have changed or that might be of interest to
109    ///    the client.
110    /// 2. A response is received with the current state of the network. The response includes
111    ///    information about new/committed/consumed notes, updated accounts, and committed
112    ///    transactions.
113    /// 3. Tracked notes are updated with their new states.
114    /// 4. New notes are checked, and only relevant ones are stored. Relevant notes are those that
115    ///    can be consumed by accounts the client is tracking (this is checked by the
116    ///    [`crate::note::NoteScreener`])
117    /// 5. Transactions are updated with their new states.
118    /// 6. Tracked public accounts are updated and private accounts are validated against the node
119    ///    state.
120    /// 7. The MMR is updated with the new peaks and authentication nodes.
121    /// 8. All updates are applied to the store to be persisted.
122    pub async fn sync_state(&mut self) -> Result<SyncSummary, ClientError> {
123        _ = self.ensure_genesis_in_place().await?;
124
125        let note_screener = NoteScreener::new(self.store.clone(), self.authenticator.clone());
126        let state_sync =
127            StateSync::new(self.rpc_api.clone(), Arc::new(note_screener), self.tx_graceful_blocks);
128
129        // Get current state of the client
130        let accounts = self
131            .store
132            .get_account_headers()
133            .await?
134            .into_iter()
135            .map(|(acc_header, _)| acc_header)
136            .collect();
137
138        let note_tags: BTreeSet<NoteTag> = self.store.get_unique_note_tags().await?;
139
140        let unspent_input_notes = self.store.get_input_notes(NoteFilter::Unspent).await?;
141        let unspent_output_notes = self.store.get_output_notes(NoteFilter::Unspent).await?;
142
143        let uncommitted_transactions =
144            self.store.get_transactions(TransactionFilter::Uncommitted).await?;
145
146        // Build current partial MMR
147        let current_partial_mmr = self.store.get_current_partial_mmr().await?;
148
149        // Get the sync update from the network
150        let state_sync_update: StateSyncUpdate = state_sync
151            .sync_state(
152                current_partial_mmr,
153                accounts,
154                note_tags.clone(),
155                unspent_input_notes,
156                unspent_output_notes,
157                uncommitted_transactions,
158            )
159            .await?;
160
161        // Note Transport update
162        // TODO We can run both sync_state, fetch_notes futures in parallel
163        let note_transport_update = if self.is_note_transport_enabled() {
164            let cursor = self.store.get_note_transport_cursor().await?;
165            Some(self.fetch_note_transport_update(cursor, note_tags).await?)
166        } else {
167            None
168        };
169
170        let sync_summary: SyncSummary = (&state_sync_update).into();
171        debug!(sync_summary = ?sync_summary, "Sync summary computed");
172        info!("Applying changes to the store.");
173
174        // Apply received and computed updates to the store
175        self.store
176            .apply_state_sync(state_sync_update)
177            .await
178            .map_err(ClientError::StoreError)?;
179
180        if let Some(note_transport_update) = note_transport_update {
181            self.store
182                .apply_note_transport_update(note_transport_update)
183                .await
184                .map_err(ClientError::StoreError)?;
185        }
186
187        // Remove irrelevant block headers
188        self.store.prune_irrelevant_blocks().await?;
189
190        Ok(sync_summary)
191    }
192
193    /// Applies the state sync update to the store.
194    ///
195    /// See [`crate::Store::apply_state_sync()`] for what the update implies.
196    pub async fn apply_state_sync(&mut self, update: StateSyncUpdate) -> Result<(), ClientError> {
197        self.store.apply_state_sync(update).await.map_err(ClientError::StoreError)?;
198
199        // Remove irrelevant block headers
200        self.store.prune_irrelevant_blocks().await.map_err(ClientError::StoreError)
201    }
202}
203
204// SYNC SUMMARY
205// ================================================================================================
206
207/// Contains stats about the sync operation.
208#[derive(Debug, PartialEq)]
209pub struct SyncSummary {
210    /// Block number up to which the client has been synced.
211    pub block_num: BlockNumber,
212    /// IDs of new public notes that the client has received.
213    pub new_public_notes: Vec<NoteId>,
214    /// IDs of tracked notes that have been committed.
215    pub committed_notes: Vec<NoteId>,
216    /// IDs of notes that have been consumed.
217    pub consumed_notes: Vec<NoteId>,
218    /// IDs of on-chain accounts that have been updated.
219    pub updated_accounts: Vec<AccountId>,
220    /// IDs of private accounts that have been locked.
221    pub locked_accounts: Vec<AccountId>,
222    /// IDs of committed transactions.
223    pub committed_transactions: Vec<TransactionId>,
224}
225
226impl SyncSummary {
227    pub fn new(
228        block_num: BlockNumber,
229        new_public_notes: Vec<NoteId>,
230        committed_notes: Vec<NoteId>,
231        consumed_notes: Vec<NoteId>,
232        updated_accounts: Vec<AccountId>,
233        locked_accounts: Vec<AccountId>,
234        committed_transactions: Vec<TransactionId>,
235    ) -> Self {
236        Self {
237            block_num,
238            new_public_notes,
239            committed_notes,
240            consumed_notes,
241            updated_accounts,
242            locked_accounts,
243            committed_transactions,
244        }
245    }
246
247    pub fn new_empty(block_num: BlockNumber) -> Self {
248        Self {
249            block_num,
250            new_public_notes: vec![],
251            committed_notes: vec![],
252            consumed_notes: vec![],
253            updated_accounts: vec![],
254            locked_accounts: vec![],
255            committed_transactions: vec![],
256        }
257    }
258
259    pub fn is_empty(&self) -> bool {
260        self.new_public_notes.is_empty()
261            && self.committed_notes.is_empty()
262            && self.consumed_notes.is_empty()
263            && self.updated_accounts.is_empty()
264            && self.locked_accounts.is_empty()
265            && self.committed_transactions.is_empty()
266    }
267
268    pub fn combine_with(&mut self, mut other: Self) {
269        self.block_num = max(self.block_num, other.block_num);
270        self.new_public_notes.append(&mut other.new_public_notes);
271        self.committed_notes.append(&mut other.committed_notes);
272        self.consumed_notes.append(&mut other.consumed_notes);
273        self.updated_accounts.append(&mut other.updated_accounts);
274        self.locked_accounts.append(&mut other.locked_accounts);
275        self.committed_transactions.append(&mut other.committed_transactions);
276    }
277}
278
279impl Serializable for SyncSummary {
280    fn write_into<W: miden_tx::utils::ByteWriter>(&self, target: &mut W) {
281        self.block_num.write_into(target);
282        self.new_public_notes.write_into(target);
283        self.committed_notes.write_into(target);
284        self.consumed_notes.write_into(target);
285        self.updated_accounts.write_into(target);
286        self.locked_accounts.write_into(target);
287        self.committed_transactions.write_into(target);
288    }
289}
290
291impl Deserializable for SyncSummary {
292    fn read_from<R: miden_tx::utils::ByteReader>(
293        source: &mut R,
294    ) -> Result<Self, DeserializationError> {
295        let block_num = BlockNumber::read_from(source)?;
296        let new_public_notes = Vec::<NoteId>::read_from(source)?;
297        let committed_notes = Vec::<NoteId>::read_from(source)?;
298        let consumed_notes = Vec::<NoteId>::read_from(source)?;
299        let updated_accounts = Vec::<AccountId>::read_from(source)?;
300        let locked_accounts = Vec::<AccountId>::read_from(source)?;
301        let committed_transactions = Vec::<TransactionId>::read_from(source)?;
302
303        Ok(Self {
304            block_num,
305            new_public_notes,
306            committed_notes,
307            consumed_notes,
308            updated_accounts,
309            locked_accounts,
310            committed_transactions,
311        })
312    }
313}
miden_client/sync/mod.rs

miden_client/sync/
mod.rs
