feat: miden client service #1434
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
igamigo
force-pushed
the
igamigo-client-service
branch
from
4791fda to
6e77927
Compare
mmagician
reviewed
Dec 18, 2025
Comment on lines
-103
to
-121
| /// Syncs the client's state with the current state of the Miden network and returns a | ||
| /// [`SyncSummary`] corresponding to the local state update. | ||
| /// Performs a sync against the network and returns the raw [`StateSyncUpdate`]. | ||
| /// | ||
| /// The sync process is done in multiple steps: | ||
| /// 1. A request is sent to the node to get the state updates. This request includes tracked | ||
| /// account IDs and the tags of notes that might have changed or that might be of interest to | ||
| /// the client. | ||
| /// 2. A response is received with the current state of the network. The response includes | ||
| /// information about new/committed/consumed notes, updated accounts, and committed | ||
| /// transactions. | ||
| /// 3. Tracked notes are updated with their new states. | ||
| /// 4. New notes are checked, and only relevant ones are stored. Relevant notes are those that | ||
| /// can be consumed by accounts the client is tracking (this is checked by the | ||
| /// [`crate::note::NoteScreener`]) | ||
| /// 5. Transactions are updated with their new states. | ||
| /// 6. Tracked public accounts are updated and private accounts are validated against the node | ||
| /// state. | ||
| /// 7. The MMR is updated with the new peaks and authentication nodes. | ||
| /// 8. All updates are applied to the store to be persisted. |
Contributor
There was a problem hiding this comment.
Would be good to keep the detailed description somewhere
Comment on lines
+3
to
+12
| /// Configuration for the background client service. | ||
| #[derive(Debug, Clone)] | ||
| pub struct ServiceConfig { | ||
| /// Interval at which the client should attempt to sync with the chain. | ||
| pub sync_interval: Duration, | ||
| /// Whether the service should automatically sync on the configured interval. | ||
| pub auto_sync: bool, | ||
| /// Capacity for the internal command channel. | ||
| pub command_buffer: usize, | ||
| } |
| .map_err(|_| ServiceError::ChannelClosed) | ||
| } | ||
|
|
||
| /// Runs a one-shot function with mutalbe access to the client. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// Runs a one-shot function with mutalbe access to the client. | |
| /// Runs a one-shot function with mutable access to the client. |
| /// }).await?; | ||
| /// # Ok(()) } | ||
| /// ``` | ||
| pub async fn run_with_client<F, Fut>(&self, f: F) -> Result<(), ServiceError> |
Contributor
There was a problem hiding this comment.
a handle always "runs with client", right? Maybe a rename to just run would be cleaner
| } | ||
| } | ||
|
|
||
| // TODO: Run these in parallel? |
Contributor
There was a problem hiding this comment.
IIUC, the tasks will go in the background, it's just the spawning itself which is done sequentially?
If so, then I think the sync work done inside this loop is minimal enough.
Comment on lines
+313
to
+323
| Command::SubmitTransaction { account_id, tx_request, resp_tx } => { | ||
| let result = self | ||
| .client | ||
| .submit_new_transaction(account_id, tx_request) | ||
| .await | ||
| .map_err(ServiceError::from); | ||
| let _ = resp_tx.send(result); | ||
| }, | ||
| Command::AddBlockingHandler(handler) => self.registered_blocking_handlers.push(handler), | ||
| Command::AddAsyncHandler(handler) => self.registered_async_handlers.push(handler), | ||
| Command::RunWithClient { mut f, resp_tx } => { |
Contributor
There was a problem hiding this comment.
ATM the commands are mixing client functionality (submit tx) with runtime functionality (add handler / stop). Is there a way to de-couple these?
(I'm not sure decoupling is a net positive, just curious)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.