Go Header contains all services related to generating, requesting, syncing and storing Headers.
There are 4 main components in the header package:
- p2p.Subscriber listens for new Headers from the P2P network (via the HeaderSub)
- p2p.Exchange request Headers from other nodes
- Syncer manages syncing of historical and new Headers from the P2P network
- Store manages storing Headers and making them available for access by other dependent services.
- Go Header
- Table of Contents
- Minimum requirements
- Installation
- Package-specific documentation
- Contributing
- Code of Conduct
| Requirement | Notes |
|---|---|
| Go version | 1.20 or higher |
go get -u https://github.com/celestiaorg/go-header.gitFor more information, go visit our docs at https://pkg.go.dev/github.com/celestiaorg/go-header.
PR titles follow conventional commits (e.g. fix:, feat:, chore:, ci:, docs:, refactor:, test:; add ! for breaking changes), and the subject must start with [high], [medium], or [low] to indicate the review thoroughness needed. For example: fix(sync): [high] prevent head regression or docs: [low] clarify setup instructions. Include the same tag in the PR description and explain why you chose it.
[high]: Deep review for header verification, sync and head selection, store, p2p exchange, security, or other changes with significant risk.[medium]: Standard review for code changes with limited impact and well-understood behavior.[low]: Focused review for straightforward docs, tests, or tooling changes with low risk.
Choose the higher level when unsure. A small diff can still need deep review. CI checks the title format; reviewers should confirm the chosen level. The required review policy documents how the tier sets the number of independent approvals.
See our Code of Conduct here.