package
0.6.2
Repository: https://github.com/celestiaorg/go-header.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DefaultClientParameters returns the default params to configure the store.
DefaultServerParameters returns the default params to configure the store.
No description provided by the author
NewExchangeServer returns a new P2P server that handles inbound header-related requests.
NewSubscriber returns a Subscriber that manages the header Module's relationship with the "header-sub" gossipsub topic.
No description provided by the author
WithChainID is a functional option that configures the `chainID` parameter.
WithMaxHeadersPerRangeRequest is a functional option that configures the `MaxRangeRequestSize` parameter.
No description provided by the author
WithNetworkID is a functional option that configures the `networkID` parameter.
WithParams is a functional option that overrides Client/ServerParameters.
WithPeerIDStore is a functional option that sets a peerIDStore to be used inside the peerTracker.
WithRangeRequestTimeout is a functional option that configures the `RangeRequestTimeout` parameter.
WithReadDeadline is a functional option that configures the `WithReadDeadline` parameter.
WithSubscriberMetrics enables metrics collection for the Subscriber.
WithSubscriberNetworkID sets the network ID for the Subscriber.
WithWriteDeadline is a functional option that configures the `WriteDeadline` parameter.

# Variables

GossibSubScore provides a set of recommended parameters for header GossipSub topic, a.k.a HeaderSub.

# Structs

ClientParameters is the set of parameters that must be configured for the exchange.
Exchange enables sending outbound HeaderRequests to the network as well as handling inbound HeaderRequests from the network.
ExchangeServer represents the server-side component for responding to inbound header-related requests.
ServerParameters is the set of parameters that must be configured for the exchange.
Subscriber manages the lifecycle and relationship of header Module with the "header-sub" gossipsub topic.
SubscriberParams defines the parameters for the Subscriber configurable with SubscriberOption.

# Interfaces

PeerIDStore is a utility for persisting peer IDs of good peers to a datastore.

# Type aliases

Option is the functional option that is applied to the exchange instance to configure parameters.
SubscriberOption is a functional option for the Subscriber.