header

Aug 7, 2024

Changes in this version

+ var ErrHeightZero = errors.New("height is equal to 0")

Oct 16, 2023

Changes in this version

+ var MetricsEnabled = false

type API

+ func (api *API) GetRangeByHeight(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

type Module

+ GetRangeByHeight func(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

type Service

+ func (s *Service) GetRangeByHeight(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

May 22, 2023

Changes in this version

type API

+ func (api *API) WaitForHeight(ctx context.Context, u uint64) (*header.ExtendedHeader, error)

type Module

+ WaitForHeight func(context.Context, uint64) (*header.ExtendedHeader, error)

type Service

+ func (s *Service) WaitForHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)

Mar 28, 2023

Changes in this version

type API

+ func (api *API) Subscribe(ctx context.Context) (<-chan *header.ExtendedHeader, error)

type Module

+ Subscribe func(ctx context.Context) (<-chan *header.ExtendedHeader, error)

type Service

+ func (s *Service) Subscribe(ctx context.Context) (<-chan *header.ExtendedHeader, error)

Mar 14, 2023

Changes in this version

+ func WithMetrics(ex libhead.Exchange[*header.ExtendedHeader]) error

type API

+ func (api *API) GetByHash(ctx context.Context, hash libhead.Hash) (*header.ExtendedHeader, error)

+ func (api *API) GetVerifiedRangeByHeight(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

+ func (api *API) LocalHead(ctx context.Context) (*header.ExtendedHeader, error)

+ func (api *API) NetworkHead(ctx context.Context) (*header.ExtendedHeader, error)

+ func (api *API) SyncState(ctx context.Context) (sync.State, error)

+ func (api *API) SyncWait(ctx context.Context) error

type Module

+ GetByHash func(ctx context.Context, hash libhead.Hash) (*header.ExtendedHeader, error)

+ GetVerifiedRangeByHeight func(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

+ LocalHead func(context.Context) (*header.ExtendedHeader, error)

+ NetworkHead func(ctx context.Context) (*header.ExtendedHeader, error)

+ SyncState func(context.Context) (sync.State, error)

+ SyncWait func(ctx context.Context) error

type Service

+ func (s *Service) GetByHash(ctx context.Context, hash libhead.Hash) (*header.ExtendedHeader, error)

+ func (s *Service) GetVerifiedRangeByHeight(ctx context.Context, from *header.ExtendedHeader, to uint64) ([]*header.ExtendedHeader, error)

+ func (s *Service) LocalHead(ctx context.Context) (*header.ExtendedHeader, error)

+ func (s *Service) NetworkHead(ctx context.Context) (*header.ExtendedHeader, error)

+ func (s *Service) SyncState(context.Context) (sync.State, error)

+ func (s *Service) SyncWait(ctx context.Context) error

Jan 18, 2023

Changes in this version

type Config

+ Syncer sync.Parameters

+ type InitStore header.Store

Dec 13, 2022

Changes in this version

+ type API struct

+ Internal struct{ ... }

+ func (api *API) GetByHeight(ctx context.Context, u uint64) (*header.ExtendedHeader, error)

+ func (api *API) Head(ctx context.Context) (*header.ExtendedHeader, error)

+ func (api *API) IsSyncing(ctx context.Context) bool

type Config

+ Client *p2p_exchange.ClientParameters

+ Server *p2p_exchange.ServerParameters

+ Store *store.Parameters

+ type Service struct

+ func (s *Service) GetByHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)

+ func (s *Service) Head(ctx context.Context) (*header.ExtendedHeader, error)

+ func (s *Service) IsSyncing(context.Context) bool

Oct 17, 2022

Changes in this version

+ func ConstructModule(tp node.Type, cfg *Config) fx.Option

+ func Flags() *flag.FlagSet

+ func ParseFlags(cmd *cobra.Command, cfg *Config) error

+ func ParseTrustedHashFlags(cmd *cobra.Command, cfg *Config) error

+ func ParseTrustedPeerFlags(cmd *cobra.Command, cfg *Config) error

+ func TrustedHashFlags() *flag.FlagSet

+ func TrustedPeersFlags() *flag.FlagSet

+ type Config struct

+ TrustedHash string

+ TrustedPeers []string

+ func DefaultConfig() Config

+ func (cfg *Config) Validate() error

+ type Module interface

+ GetByHeight func(context.Context, uint64) (*header.ExtendedHeader, error)

+ Head func(context.Context) (*header.ExtendedHeader, error)

+ IsSyncing func() bool

+ func NewHeaderService(syncer *sync.Syncer, sub header.Subscriber, p2pServer *p2p.ExchangeServer, ...) Module