Skip to content

docs(diff-api): add checkpoint tuning guidance #21

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
tiljrd wants to merge 1 commit into
base: til/forking
Choose a base branch
from
Open

docs(diff-api): add checkpoint tuning guidance #21

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
5 changes: 5 additions & 0 deletions docs/diff-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ Behavior
- Sharding: server transparently reads flat and sharded layouts; you can enable sharding when generating diffs in the future without breaking compatibility.
- Gzip: responses are compressed when the client requests it (and ENABLE_GZIP=1).

Checkpoint tuning
- Smaller intervals (e.g., 100–1,000): fastest /diffs/since responses; higher CPU/disk/inodes to build/keep checkpoints.
- Larger intervals (e.g., 5,000–10,000): lower overhead; slower /diffs/since for large height jumps.
- Choose based on latency vs. resource trade-off. Typical defaults: 1,000 for low latency; 5,000 if conserving resources.

Applying patches to base genesis efficiently
- The KV patch represents final values per (store,key) after folding from (base, H]. For O(1)-ish apply over a large base file:
- Recommended: build a KV index representation of the base state once (keyed by (store,key)), then stream-apply the patch to that index and re-materialize JSON if required.
Expand Down