consensus

Documentation

Index

• type Consensus
  • func NewConsensus(cfg *config.Config, bc blockchain.Blockchain, ap actpool.ActPool, ...) Consensus
• type IotxConsensus
  • func (c *IotxConsensus) HandleBlockPropose(m proto.Message, done chan bool) error
  • func (c *IotxConsensus) HandleViewChange(m proto.Message, done chan bool) error
  • func (c *IotxConsensus) Metrics() (scheme.ConsensusMetrics, error)
  • func (c *IotxConsensus) Scheme() scheme.Scheme
  • func (c *IotxConsensus) Start(ctx context.Context) error
  • func (c *IotxConsensus) Stop(ctx context.Context) error

Types

type Consensus

type Consensus interface {
	lifecycle.StartStopper

	HandleViewChange(proto.Message, chan bool) error
	HandleBlockPropose(proto.Message, chan bool) error
	Metrics() (scheme.ConsensusMetrics, error)
}

Consensus is the interface for handling IotxConsensus view change.

func NewConsensus

func NewConsensus(
	cfg *config.Config,
	bc blockchain.Blockchain,
	ap actpool.ActPool,
	p2p network.Overlay,
) Consensus

NewConsensus creates a IotxConsensus struct.

type IotxConsensus

type IotxConsensus struct {
	// contains filtered or unexported fields
}

IotxConsensus implements Consensus

func (*IotxConsensus) HandleBlockPropose

func (c *IotxConsensus) HandleBlockPropose(m proto.Message, done chan bool) error

HandleBlockPropose handles a proposed block

func (*IotxConsensus) HandleViewChange

func (c *IotxConsensus) HandleViewChange(m proto.Message, done chan bool) error

HandleViewChange dispatches the call to different schemes

func (*IotxConsensus) Metrics

func (c *IotxConsensus) Metrics() (scheme.ConsensusMetrics, error)

Metrics returns consensus metrics

func (*IotxConsensus) Scheme

func (c *IotxConsensus) Scheme() scheme.Scheme

Scheme returns the scheme instance

func (*IotxConsensus) Start

func (c *IotxConsensus) Start(ctx context.Context) error

Start starts running the consensus algorithm

func (*IotxConsensus) Stop

func (c *IotxConsensus) Stop(ctx context.Context) error

Stop stops running the consensus algorithm