header

Oct 13, 2023

Changes in this version

type Store

+ GetRange func(context.Context, uint64, uint64) ([]H, error)

Aug 25, 2023

Changes in this version

+ const DefaultHeightThreshold

+ var ErrFromFuture = errors.New("header is from the future")

+ var ErrHeightFromFuture = errors.New("header height is far from future")

+ var ErrKnownHeader = errors.New("known header")

+ var ErrUnorderedTime = errors.New("unordered headers")

+ var ErrWrongChainID = errors.New("wrong chain id")

+ var ErrZeroHeader = errors.New("zero header")

+ func New() (h H)

+ func Verify(trstd, untrstd H, heightThreshold uint64) error

+ func WithTrustedHead(verified Header[H]) func(opts *HeadParams[H])

+ type HeadOption func(opts *HeadParams[H])

+ type HeadParams struct

+ TrustedHead Header[H]

type Subscriber

+ SetVerifier func(func(context.Context, H) error) error

type VerifyError

+ SoftFailure bool

+ func (vr *VerifyError) Unwrap() error

Mar 21, 2023

Changes in this version

+ const MaxRangeRequestSize

+ func WithMetrics(store Store[H]) error

type Header

+ Verify func(Header) error

type Store

+ HasAt func(context.Context, uint64) bool

Jan 21, 2023

retracted

Changes in this version

+ var ErrHeadersLimitExceeded = errors.New("header/p2p: header limit per 1 request exceeded")

+ var ErrNoHead = fmt.Errorf("header/store: no chain head")

+ var ErrNotFound = errors.New("header: not found")

+ type Broadcaster interface

+ Broadcast func(ctx context.Context, header H, opts ...pubsub.PubOpt) error

+ type ErrNonAdjacent struct

+ Attempted int64

+ Head int64

+ func (ena *ErrNonAdjacent) Error() string

+ type Exchange interface

+ type Getter interface

+ Get func(context.Context, Hash) (H, error)

+ GetByHeight func(context.Context, uint64) (H, error)

+ GetRangeByHeight func(ctx context.Context, from, amount uint64) ([]H, error)

+ GetVerifiedRange func(ctx context.Context, from H, amount uint64) ([]H, error)

+ type Hash []byte

+ func (h *Hash) UnmarshalJSON(data []byte) error

+ func (h Hash) MarshalJSON() ([]byte, error)

+ func (h Hash) String() string

+ type Head interface

+ Head func(context.Context) (H, error)

+ type Header interface

+ ChainID func() string

+ Hash func() Hash

+ Height func() int64

+ IsZero func() bool

+ LastHeader func() Hash

+ New func() Header

+ Time func() time.Time

+ Validate func() error

+ VerifyAdjacent func(Header) error

+ VerifyNonAdjacent func(Header) error

+ type Store interface

+ Append func(context.Context, ...H) (int, error)

+ Has func(context.Context, Hash) (bool, error)

+ Height func() uint64

+ Init func(context.Context, H) error

+ Start func(context.Context) error

+ Stop func(context.Context) error

+ type Subscriber interface

+ AddValidator func(func(context.Context, H) pubsub.ValidationResult) error

+ Subscribe func() (Subscription[H], error)

+ type Subscription interface

+ Cancel func()

+ NextHeader func(ctx context.Context) (H, error)

+ type VerifyError struct

+ Reason error

+ func (vr *VerifyError) Error() string