Skip to content

Commit

Permalink
chore: update doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasArrachea committed Feb 20, 2025
1 parent ff4343a commit f964017
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
16 changes: 8 additions & 8 deletions crates/proto/src/generated/rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -353,18 +353,18 @@ pub mod api_client {
self.inner.unary(req, path, codec).await
}
/// Returns info which can be used by the client to sync up to the latest state of the chain
/// for the objects (accounts, notes, nullifiers) the client is interested in.
/// for the objects (accounts and notes) the client is interested in.
///
/// This request returns a stream where multiple update responses will be pushed in order.
/// Client is expected to read the updates from the stream and apply them, and then it will be
/// fully synchronized with the chain.
///
/// Each update response also contains info about new notes, nullifiers etc. created. It also returns
/// Each update response also contains info about new notes, accounts etc. created. It also returns
/// Chain MMR delta that can be used to update the state of Chain MMR. This includes both chain
/// MMR peaks and chain MMR nodes.
///
/// For preserving some degree of privacy, note tags and nullifiers filters contain only high
/// part of hashes. Thus, returned data contains excessive notes and nullifiers, client can make
/// For preserving some degree of privacy, note tags contain only high
/// part of hashes. Thus, returned data contains excessive notes, client can make
/// additional filtering of that data on its side.
pub async fn sync_state(
&mut self,
Expand Down Expand Up @@ -512,18 +512,18 @@ pub mod api_server {
+ std::marker::Send
+ 'static;
/// Returns info which can be used by the client to sync up to the latest state of the chain
/// for the objects (accounts, notes, nullifiers) the client is interested in.
/// for the objects (accounts and notes) the client is interested in.
///
/// This request returns a stream where multiple update responses will be pushed in order.
/// Client is expected to read the updates from the stream and apply them, and then it will be
/// fully synchronized with the chain.
///
/// Each update response also contains info about new notes, nullifiers etc. created. It also returns
/// Each update response also contains info about new notes, accounts etc. created. It also returns
/// Chain MMR delta that can be used to update the state of Chain MMR. This includes both chain
/// MMR peaks and chain MMR nodes.
///
/// For preserving some degree of privacy, note tags and nullifiers filters contain only high
/// part of hashes. Thus, returned data contains excessive notes and nullifiers, client can make
/// For preserving some degree of privacy, note tags contain only high
/// part of hashes. Thus, returned data contains excessive notes, client can make
/// additional filtering of that data on its side.
async fn sync_state(
&self,
Expand Down
8 changes: 4 additions & 4 deletions crates/rpc-proto/proto/rpc.proto
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,18 @@ service Api {
rpc SyncNotes(requests.SyncNoteRequest) returns (responses.SyncNoteResponse) {}

// Returns info which can be used by the client to sync up to the latest state of the chain
// for the objects (accounts, notes, nullifiers) the client is interested in.
// for the objects (accounts and notes) the client is interested in.
//
// This request returns a stream where multiple update responses will be pushed in order.
// Client is expected to read the updates from the stream and apply them, and then it will be
// fully synchronized with the chain.
//
// Each update response also contains info about new notes, nullifiers etc. created. It also returns
// Each update response also contains info about new notes, accounts etc. created. It also returns
// Chain MMR delta that can be used to update the state of Chain MMR. This includes both chain
// MMR peaks and chain MMR nodes.
//
// For preserving some degree of privacy, note tags and nullifiers filters contain only high
// part of hashes. Thus, returned data contains excessive notes and nullifiers, client can make
// For preserving some degree of privacy, note tags contain only high
// part of hashes. Thus, returned data contains excessive notes, client can make
// additional filtering of that data on its side.
rpc SyncState(requests.SyncStateRequest) returns (stream responses.SyncStateResponse) {}
}
8 changes: 4 additions & 4 deletions proto/rpc.proto
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,18 @@ service Api {
rpc SyncNotes(requests.SyncNoteRequest) returns (responses.SyncNoteResponse) {}

// Returns info which can be used by the client to sync up to the latest state of the chain
// for the objects (accounts, notes, nullifiers) the client is interested in.
// for the objects (accounts and notes) the client is interested in.
//
// This request returns a stream where multiple update responses will be pushed in order.
// Client is expected to read the updates from the stream and apply them, and then it will be
// fully synchronized with the chain.
//
// Each update response also contains info about new notes, nullifiers etc. created. It also returns
// Each update response also contains info about new notes, accounts etc. created. It also returns
// Chain MMR delta that can be used to update the state of Chain MMR. This includes both chain
// MMR peaks and chain MMR nodes.
//
// For preserving some degree of privacy, note tags and nullifiers filters contain only high
// part of hashes. Thus, returned data contains excessive notes and nullifiers, client can make
// For preserving some degree of privacy, note tags contain only high
// part of hashes. Thus, returned data contains excessive notes, client can make
// additional filtering of that data on its side.
rpc SyncState(requests.SyncStateRequest) returns (stream responses.SyncStateResponse) {}
}

0 comments on commit f964017

Please sign in to comment.