rpc/store: align list-limit metadata and document query limits#1986
Open
namedfarouk wants to merge 6 commits into0xMiden:nextfrom
Open
rpc/store: align list-limit metadata and document query limits#1986namedfarouk wants to merge 6 commits into0xMiden:nextfrom
namedfarouk wants to merge 6 commits into0xMiden:nextfrom
Conversation
This was referenced Apr 22, 2026
Collaborator
SantiagoPittella
left a comment
SantiagoPittella
left a comment
There was a problem hiding this comment.
We need to update the documentation in crates/utils/src/limiter.rs too.
Comment on lines
+32
to
+46
| | Endpoint | Parameter | Limit | Rationale | | ||
| |---|---:|---:|---| | ||
| | `CheckNullifiers` | `nullifier` | `1000` | Bounds `IN`-style lookups and keeps responses under payload budget | | ||
| | `SyncNullifiers` | `nullifier_prefix` | `1000` | Bounds prefix-based nullifier scans | | ||
| | `SyncNotes` | `note_tag` | `1000` | Keeps note sync responses within payload budget | | ||
| | `GetNotesById` | `note_id` | `100` | Notes can be large (~32 KiB), so this is intentionally tighter | | ||
| | `SyncTransactions` | `account_id` | `1000` | Bounds account filter fan-out and response size | | ||
| | `GetAccount` | `storage_map_key` | `64` | SMT proof generation for storage map keys is comparatively expensive | | ||
|
|
||
| Additional internal-only limits in `miden_node_utils::limiter` (not surfaced by `GetLimits`) include: | ||
|
|
||
| | Parameter | Limit | Used by | | ||
| |---:|---:|---| | ||
| | `note_commitment` | `1000` | Internal note proof lookups | | ||
| | `block_header` | `1000` | Internal batch/block header operations | |
Collaborator
There was a problem hiding this comment.
nits:
- We don't use right-alignment in ours tables, lets remove that.
- convention in this repo is to pad table cells and use full-width --- separators so the markdown is readable in raw form too. You can take a look at docs/external/src/rpc.md:115 for comparison
Author
|
Addressed, thanks for the review. Updated in follow-up commit f475201: crates/utils/src/limiter.rs: Endpoint docs now reflect current limit usage (sync_nullifiers for nullifier_prefix, check_nullifiers for nullifier). docs/internal/src/rpc.md: Normalized table formatting to repo style (no right-alignment markers, padded cells, full-width separators). Validation rerun: cargo test -p miden-node-rpc get_limits_endpoint (pass). |
Comment on lines
+34
to
+39
| | `CheckNullifiers` | `nullifier` | `1000` | Bounds `IN`-style lookups and keeps responses under payload budget | | ||
| | `SyncNullifiers` | `nullifier_prefix` | `1000` | Bounds prefix-based nullifier scans | | ||
| | `SyncNotes` | `note_tag` | `1000` | Keeps note sync responses within payload budget | | ||
| | `GetNotesById` | `note_id` | `100` | Notes can be large (~32 KiB), so this is intentionally tighter | | ||
| | `SyncTransactions` | `account_id` | `1000` | Bounds account filter fan-out and response size | | ||
| | `GetAccount` | `storage_map_key` | `64` | SMT proof generation for storage map keys is comparatively expensive | |
Collaborator
There was a problem hiding this comment.
Let use alphabetical order
Updated CHANGELOG with recent changes and breaking updates.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
SyncNullifierslist-limit validation in RPC and store with the parameter semantics (nullifier_prefix)SyncNullifiersparameter key viaGetLimitsGetLimitstest coverage to assertSyncNullifiersandSyncNoteslimitsWhy
Issue #1080 asks to revisit/document list parameter limits.
This keeps limit handling consistent across:
GetLimitsresponse metadataValidation
cargo test -p miden-node-rpc get_limits_endpointcargo check -p miden-node-store -p miden-node-rpcPartially addresses #1080