Skip to content

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

License

Notifications You must be signed in to change notification settings

celestiaorg/go-header

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

Code of Conduct

See our Code of Conduct here.