ibft

Documentation

Index

• type DecidedReaderOptions
• type IncomingMsgsReaderOptions
• type Reader
  • func NewNetworkReader(o IncomingMsgsReaderOptions) Reader
• type SyncRead
  • func NewDecidedReader(o DecidedReaderOptions) SyncRead
• type Syncer

Types

type DecidedReaderOptions

type DecidedReaderOptions struct {
	Logger         *zap.Logger
	Storage        collections.Iibft
	Network        network.Network
	Config         *proto.InstanceConfig
	ValidatorShare *storage.Share
}

DecidedReaderOptions defines the required parameters to create an instance

type IncomingMsgsReaderOptions

type IncomingMsgsReaderOptions struct {
	Logger  *zap.Logger
	Network network.Network
	Config  *proto.InstanceConfig
	PK      *bls.PublicKey
}

IncomingMsgsReaderOptions defines the required parameters to create an instance

type Reader

type Reader interface {
	Start() error
}

Reader is an interface for ibft in the context of an exporter

func NewNetworkReader

func NewNetworkReader(o IncomingMsgsReaderOptions) Reader

NewNetworkReader factory to create network readers

type SyncRead

type SyncRead interface {
	Reader
	Syncer
}

SyncRead reads and sync data

func NewDecidedReader

func NewDecidedReader(o DecidedReaderOptions) SyncRead

NewDecidedReader factory to create decided readers

type Syncer

type Syncer interface {
	Sync() error
}

Syncer is an interface for syncing data