Skip to content
celestiaorgPublic

About

Go library with all the services needed to request, sync and store blockchain headers.

Resources

Contributing

Security policy

Stars

21 stars

Watchers

10 watching

Forks

Repository files navigation

Go Header

Go Reference GitHub release (latest by date including pre-releases) Go Report Card codecov

Go Header contains all services related to generating, requesting, syncing and storing Headers.

There are 4 main components in the header package:

  1. p2p.Subscriber listens for new Headers from the P2P network (via the HeaderSub)
  2. p2p.Exchange request Headers from other nodes
  3. Syncer manages syncing of historical and new Headers from the P2P network
  4. Store manages storing Headers and making them available for access by other dependent services.

Table of Contents

Minimum requirements

Requirement Notes
Go version 1.20 or higher

Installation

go get -u https://github.com/celestiaorg/go-header.git

For more information, go visit our docs at https://pkg.go.dev/github.com/celestiaorg/go-header.

Package-specific documentation

Contributing

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.

Code of Conduct

See our Code of Conduct here.

About

Go library with all the services needed to request, sync and store blockchain headers.

Resources

Contributing

Security policy

Stars

21 stars

Watchers

10 watching

Forks

Releases

Packages

Used by

Contributors

Languages