Add packfile library design doc#633
Open
tamirms wants to merge 3 commits intofeature/full-historyfrom
Open
Conversation
Design document describing the packfile and intpack packages for storing and reading large collections of immutable, ordinal-indexed items (events, bitmaps, ledgers) with O(1) random access and minimal I/O overhead. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a design document proposing a “packfile” immutable, ordinal-indexed file format and Go library API intended as a building block for Stellar RPC v2 full-history storage (compact storage with O(1) random access and minimal I/O).
Changes:
- Introduces the packfile/intpack concepts, goals/non-goals, and usage examples.
- Specifies the on-disk layout (records, index, trailer) plus integrity/content-hash model.
- Documents proposed Go APIs for writer/reader, concurrency behavior, and error surface.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- Clarify trailer flag descriptions: Bit 0 means not zstd-compressed (not implying CRC is always present), and document the Bit 0 + Bit 2 combination as the Raw format - Fix ErrIndexRange message from "record index" to "item index" to match the public API contract Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
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
Note: This PR targets
mainfor now but will be retargeted to the full history RPC / v2 branch once we align on that before merging.Further reading
packfile,intpack🤖 Generated with Claude Code