consensus

Documentation

Index

• func GetAddr(cfg config.Config) (keypair.PublicKey, keypair.PrivateKey, string)
• type Consensus
  • func NewConsensus(cfg config.Config, bc blockchain.Blockchain, ap actpool.ActPool, ...) (Consensus, error)
• type IotxConsensus
  • func (c *IotxConsensus) Calibrate(height uint64)
  • func (c *IotxConsensus) HandleConsensusMsg(propose *iproto.ConsensusPb) 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
  • func (c *IotxConsensus) ValidateBlockFooter(blk *block.Block) error
• type Option
  • func WithBroadcast(broadcastHandler scheme.Broadcast) Option
  • func WithRootChainAPI(exp explorerapi.Explorer) Option

Functions

func GetAddr

func GetAddr(cfg config.Config) (keypair.PublicKey, keypair.PrivateKey, string)

GetAddr returns the iotex address

Types

type Consensus

type Consensus interface {
	lifecycle.StartStopper

	HandleConsensusMsg(*iproto.ConsensusPb) error
	Calibrate(uint64)
	ValidateBlockFooter(*block.Block) 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,
	opts ...Option,
) (Consensus, error)

NewConsensus creates a IotxConsensus struct.

type IotxConsensus

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

IotxConsensus implements Consensus

func (*IotxConsensus) Calibrate

func (c *IotxConsensus) Calibrate(height uint64)

Calibrate triggers an event to calibrate consensus context

func (*IotxConsensus) HandleConsensusMsg

func (c *IotxConsensus) HandleConsensusMsg(propose *iproto.ConsensusPb) error

HandleConsensusMsg handles consensus messages

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

func (*IotxConsensus) ValidateBlockFooter

func (c *IotxConsensus) ValidateBlockFooter(blk *block.Block) error

ValidateBlockFooter validates the signatures in block footer

type Option

type Option func(op *optionParams) error

Option sets Consensus construction parameter.

func WithBroadcast

func WithBroadcast(broadcastHandler scheme.Broadcast) Option

WithBroadcast is an option to add broadcast callback to Consensus

func WithRootChainAPI

func WithRootChainAPI(exp explorerapi.Explorer) Option

WithRootChainAPI is an option to add a root chain api to Consensus.