header

Sep 13, 2022

Changes in this version

type Service

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

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

Feb 25, 2022

Changes in this version

+ var DefaultWriteBatchSize = 2048

+ var ErrNonAdjacent = fmt.Errorf("header/store: non-adjacent")

+ var TrustingPeriod = 168 * time.Hour

+ func InitStore(ctx context.Context, store Store, ex Exchange, hash tmbytes.HexBytes) error

+ type CoreListener struct

+ func NewCoreListener(bcast Broadcaster, fetcher *core.BlockFetcher, dag format.DAGService) *CoreListener

+ func (cl *CoreListener) Start(ctx context.Context) error

+ func (cl *CoreListener) Stop(ctx context.Context) error

+ type DummySubscriber struct

+ Headers []*ExtendedHeader

+ func (mhs *DummySubscriber) AddValidator(Validator) error

+ func (mhs *DummySubscriber) Cancel()

+ func (mhs *DummySubscriber) NextHeader(ctx context.Context) (*ExtendedHeader, error)

+ func (mhs *DummySubscriber) Subscribe() (Subscription, error)

type ExtendedHeader

+ func MakeExtendedHeader(ctx context.Context, b *core.Block, comm *core.Commit, vals *core.ValidatorSet, ...) (*ExtendedHeader, error)

+ func (eh *ExtendedHeader) IsExpired() bool

+ func (eh *ExtendedHeader) VerifyAdjacent(untrst *ExtendedHeader) error

+ func (eh *ExtendedHeader) VerifyNonAdjacent(untrst *ExtendedHeader) error

+ type P2PExchangeServer struct

+ func NewP2PExchangeServer(host host.Host, store Store) *P2PExchangeServer

+ func (serv *P2PExchangeServer) Start(context.Context) error

+ func (serv *P2PExchangeServer) Stop(context.Context) error

+ type P2PSubscriber struct

+ func NewP2PSubscriber(ps *pubsub.PubSub) *P2PSubscriber

+ func (p *P2PSubscriber) AddValidator(val Validator) error

+ func (p *P2PSubscriber) Broadcast(ctx context.Context, header *ExtendedHeader) error

+ func (p *P2PSubscriber) Start(context.Context) (err error)

+ func (p *P2PSubscriber) Stop(context.Context) error

+ func (p *P2PSubscriber) Subscribe() (Subscription, error)

type Service

+ func (s *Service) IsSyncing() bool

type Store

+ func NewTestStore(ctx context.Context, t *testing.T, head *ExtendedHeader) Store

+ Height func() uint64

+ Init func(context.Context, *ExtendedHeader) error

+ Start func(context.Context) error

+ Stop func(context.Context) error

type Subscriber

+ AddValidator func(Validator) error

+ type SyncState struct

+ End time.Time

+ Error error

+ FromHash tmbytes.HexBytes

+ FromHeight uint64

+ Height uint64

+ ID uint64

+ Start time.Time

+ ToHash tmbytes.HexBytes

+ ToHeight uint64

+ func (s SyncState) Finished() bool

type Syncer

+ func (s *Syncer) Start(context.Context) error

+ func (s *Syncer) State() SyncState

+ func (s *Syncer) Stop(context.Context) error

+ func (s *Syncer) WaitSync(ctx context.Context) error

+ type Validator = func(context.Context, *ExtendedHeader) pubsub.ValidationResult

+ type VerifyError struct

+ Reason error

+ func (vr *VerifyError) Error() string

Dec 6, 2021

Changes in this version

+ const PubSubTopic

+ var DefaultIndexCacheSize = 256

+ var DefaultStoreCacheSize = 1024

+ var EmptyDAH = da.MinDataAvailabilityHeader

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

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

+ func ExtendedHeaderToProto(eh *ExtendedHeader) (*header_pb.ExtendedHeader, error)

+ func MarshalExtendedHeader(in *ExtendedHeader) (_ []byte, err error)

+ func MarshalExtendedHeaderRequest(in *ExtendedHeaderRequest) ([]byte, error)

+ func RandBlockID(t *testing.T) types.BlockID

+ func VerifyAdjacent(trusted, untrusted *ExtendedHeader) error

+ type Broadcaster interface

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

+ type CoreExchange struct

+ func NewCoreExchange(fetcher *core.BlockFetcher, dag format.DAGService) *CoreExchange

+ func (ce *CoreExchange) RequestByHash(ctx context.Context, hash tmbytes.HexBytes) (*ExtendedHeader, error)

+ func (ce *CoreExchange) RequestHead(ctx context.Context) (*ExtendedHeader, error)

+ func (ce *CoreExchange) RequestHeader(ctx context.Context, height uint64) (*ExtendedHeader, error)

+ func (ce *CoreExchange) RequestHeaders(ctx context.Context, from, amount uint64) ([]*ExtendedHeader, error)

+ type DataAvailabilityHeader = da.DataAvailabilityHeader

+ func DataAvailabilityHeaderFromExtendedData(data *rsmt2d.ExtendedDataSquare) (DataAvailabilityHeader, error)

+ type Exchange interface

+ RequestByHash func(ctx context.Context, hash tmbytes.HexBytes) (*ExtendedHeader, error)

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

+ RequestHeader func(ctx context.Context, height uint64) (*ExtendedHeader, error)

+ RequestHeaders func(ctx context.Context, origin, amount uint64) ([]*ExtendedHeader, error)

+ func NewLocalExchange(store Store) Exchange

+ type ExtendedHeader struct

+ Commit *core.Commit

+ DAH *DataAvailabilityHeader

+ ValidatorSet *core.ValidatorSet

+ func ProtoToExtendedHeader(pb *header_pb.ExtendedHeader) (*ExtendedHeader, error)

+ func RandExtendedHeader(t *testing.T) *ExtendedHeader

+ func UnmarshalExtendedHeader(data []byte) (*ExtendedHeader, error)

+ func (eh *ExtendedHeader) Hash() bts.HexBytes

+ func (eh *ExtendedHeader) LastHeader() bts.HexBytes

+ func (eh *ExtendedHeader) MarshalBinary() ([]byte, error)

+ func (eh *ExtendedHeader) UnmarshalBinary(data []byte) error

+ func (eh *ExtendedHeader) ValidateBasic() error

+ type ExtendedHeaderRequest struct

+ Amount uint64

+ Origin uint64

+ func UnmarshalExtendedHeaderRequest(data []byte) (*ExtendedHeaderRequest, error)

+ func (ehr *ExtendedHeaderRequest) MarshalBinary() ([]byte, error)

+ func (ehr *ExtendedHeaderRequest) ToProto() *header_pb.ExtendedHeaderRequest

+ func (ehr *ExtendedHeaderRequest) UnmarshalBinary(data []byte) error

+ type LocalExchange struct

+ func (l *LocalExchange) RequestByHash(ctx context.Context, hash bytes.HexBytes) (*ExtendedHeader, error)

+ func (l *LocalExchange) RequestHead(ctx context.Context) (*ExtendedHeader, error)

+ func (l *LocalExchange) RequestHeader(ctx context.Context, height uint64) (*ExtendedHeader, error)

+ func (l *LocalExchange) RequestHeaders(ctx context.Context, origin, amount uint64) ([]*ExtendedHeader, error)

+ func (l *LocalExchange) Start(context.Context) error

+ func (l *LocalExchange) Stop(context.Context) error

+ type P2PExchange struct

+ func NewP2PExchange(host host.Host, peer *peer.AddrInfo, store Store) *P2PExchange

+ func (ex *P2PExchange) Connected(_ network.Network, conn network.Conn)

+ func (ex *P2PExchange) RequestByHash(ctx context.Context, hash tmbytes.HexBytes) (*ExtendedHeader, error)

+ func (ex *P2PExchange) RequestHead(ctx context.Context) (*ExtendedHeader, error)

+ func (ex *P2PExchange) RequestHeader(ctx context.Context, height uint64) (*ExtendedHeader, error)

+ func (ex *P2PExchange) RequestHeaders(ctx context.Context, from, amount uint64) ([]*ExtendedHeader, error)

+ func (ex *P2PExchange) Start(ctx context.Context) error

+ func (ex *P2PExchange) Stop(context.Context) error

+ type RawHeader = core.Header

+ func RandRawHeader(t *testing.T) *RawHeader

+ type Service struct

+ func NewHeaderService(syncer *Syncer, pubsub *pubsub.PubSub) *Service

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

+ func (s *Service) Start(context.Context) error

+ func (s *Service) Stop(context.Context) error

+ func (s *Service) Subscribe() (Subscription, error)

+ type Store interface

+ Append func(context.Context, ...*ExtendedHeader) error

+ Get func(context.Context, tmbytes.HexBytes) (*ExtendedHeader, error)

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

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

+ Has func(context.Context, tmbytes.HexBytes) (bool, error)

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

+ func NewStore(ds datastore.Batching) (Store, error)

+ func NewStoreWithHead(ds datastore.Batching, head *ExtendedHeader) (Store, error)

+ type Subscriber interface

+ Subscribe func() (Subscription, error)

+ type Subscription interface

+ Cancel func()

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

+ type Syncer struct

+ func NewSyncer(exchange Exchange, store Store, trusted tmbytes.HexBytes) *Syncer

+ func (s *Syncer) Sync(ctx context.Context)

+ func (s *Syncer) Validate(ctx context.Context, p peer.ID, msg *pubsub.Message) pubsub.ValidationResult

+ type TestSuite struct

+ func NewTestSuite(t *testing.T, num int) *TestSuite

+ func (s *TestSuite) Commit(h *RawHeader) *types.Commit

+ func (s *TestSuite) GenExtendedHeader() *ExtendedHeader

+ func (s *TestSuite) GenExtendedHeaders(num int) []*ExtendedHeader

+ func (s *TestSuite) GenRawHeader(height int64, lastHeader, lastCommit, dataHash bytes.HexBytes) *RawHeader

+ func (s *TestSuite) Head() *ExtendedHeader