From 59eebc929c5d9f5cbcac0f7f4e229555f31549c6 Mon Sep 17 00:00:00 2001 From: dumanoglu1 <118473861+dumanoglu1@users.noreply.github.com> Date: Sat, 22 Aug 2026 12:30:04 +0300 Subject: [PATCH] fix: update fetch_notes cursor docs (#155) --- crates/node/README.md | 4 ++-- docs/src/index.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/node/README.md b/crates/node/README.md index a981c79..38b2b62 100644 --- a/crates/node/README.md +++ b/crates/node/README.md @@ -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. diff --git a/docs/src/index.md b/docs/src/index.md index 4983642..f4a02c1 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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.