ibft

Documentation

Index

• type CommitReaderOptions
• type DecidedReaderOptions
• type IncomingMsgsReaderOptions
• type Migrator
  • func GetMainMigrator() Migrator
• type Reader
  • func NewCommitReader(opts CommitReaderOptions) Reader
  • func NewDecidedReader(o DecidedReaderOptions) Reader
  • func NewNetworkReader(o IncomingMsgsReaderOptions) Reader
• type ShareHolder

Types

type CommitReaderOptions

type CommitReaderOptions struct {
	Logger           *zap.Logger
	Network          network.Network
	ValidatorStorage validatorstorage.ICollection
	IbftStorage      collections.Iibft
	Out              *event.Feed
}

CommitReaderOptions defines the required parameters to create an instance

type DecidedReaderOptions

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

	Out *event.Feed
}

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 Migrator

type Migrator interface {
	Migrate(r Reader) error
}

Migrator is an interface for migrating messages

func GetMainMigrator

func GetMainMigrator() Migrator

GetMainMigrator returns the instance of migrator

type Reader

type Reader interface {
	Start() error
}

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

func NewCommitReader

func NewCommitReader(opts CommitReaderOptions) Reader

NewCommitReader creates new instance

func NewDecidedReader

func NewDecidedReader(o DecidedReaderOptions) Reader

NewDecidedReader factory to create decided readers

func NewNetworkReader

func NewNetworkReader(o IncomingMsgsReaderOptions) Reader

NewNetworkReader factory to create network readers

type ShareHolder

type ShareHolder interface {
	Share() *storage.Share
}

ShareHolder is an interface for components that hold a share