Skip to content

fix: describe fetch_notes pagination as seq-based #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dumanoglu1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: describe fetch_notes pagination as seq-based #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Please see the `miden-note-transport-proto` crate for the employed Protobuf mess
Clients can interact with the server,
- `send_note()` receives an incoming note and stores it in the database. The note details can be
encrypted;
- `fetch_notes()` process a notes-request by note tag, with pagination based on a timestamp. The
node timestamps notes when it receives them (on `send_note()` requests);
- `fetch_notes()` processes a notes-request by note tag, with pagination based on the
server-assigned monotonic `seq` cursor returned by previous fetch responses;
- `stream_notes()` is a subscription mechanism by note tag for real-time note-fetching. Received notes by the
node are sent to subscribed client;
- `stats()` provides simple insights into database statistics.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ It is based on a client-node (or, client-server) architecture, where clients exc

The flow is as follows,
1. User sends a note to the node;
2. The note is stored for a retention period (default 30 days, configurable via the [`--retention-days`](https://github.com/0xMiden/note-transport-service/blob/main/bin/node/src/main.rs) CLI flag). The node also labels the note with an increasing-monotonic integer cursor (currently a timestamp);
3. The recipient fetches notes by note tag. To reduce the number of fetched notes (pagination), the user may employ the cursor (only notes after this value will be provided).
2. The note is stored for a retention period (default 30 days, configurable via the [`--retention-days`](https://github.com/0xMiden/note-transport-service/blob/main/bin/node/src/main.rs) CLI flag). The node also labels the note with a server-assigned monotonic `seq` cursor;
3. The recipient fetches notes by note tag. To reduce the number of fetched notes (pagination), the user may employ the cursor returned by the server (only notes with a higher `seq` value will be provided).

The node itself may also be referred to as the transport service.

Expand Down
Loading