0xMiden / 0xMiden/note-transport-service

README and intro docs still describe fetch_notes pagination as timestamp-based

Đang mở Phù hợp với người mới
#155 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Rust
Star
3
Fork
10
Merge trung bình
2 giờ 23 phút
Pull request đã merge (30 ngày)
4

Mô tả

### Problem

Two documentation entries still describe `fetch_notes` pagination as timestamp-based, but the current implementation uses the server-assigned monotonic `seq` cursor.

File evidence:
- `docs/src/index.md` says the node labels notes with an increasing cursor that is "currently a timestamp".
- `crates/node/README.md` says `fetch_notes()` uses pagination based on a timestamp.

The current implementation and external docs describe `seq`-based pagination instead:
- `docs/external/src/design.md` documents `FetchNotes` as `seq > cursor` ordered by `seq`.
- `crates/node/src/database/sqlite/mod.rs` filters by the SQLite `seq` column and only treats very large timestamp-like cursors as legacy values.

### Why this matters

Clients should persist and resend the cursor returned by the server. Timestamp-based wording is stale after the `seq` cursor migration and can lead implementers to infer the wrong cursor semantics.

### Suggested fix

Update the README and intro docs to describe `fetch_notes` pagination as based on the server-assigned `seq` cursor, and mention the legacy timestamp reset only where relevant.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Issue này chỉ ra hai tệp: `docs/src/index.md` và `crates/node/README.md`. Đọc mô tả hiện tại về phân trang dựa trên `seq` trong `docs/external/src/design.md` và phần triển khai trong `crates/node/src/database/sqlite/mod.rs`. Cập nhật hai tệp tài liệu để phản ánh đúng ngữ nghĩa con trỏ, chỉ đề cập đến xử lý timestamp cũ ở những nơi thích hợp. Xác minh các thay đổi bằng cách kiểm tra tài liệu đã cập nhật cục bộ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
85/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.