consensus

Documentation

Index

• func GetAddr(cfg *config.Config) *iotxaddress.Address
• type Consensus
  • func NewConsensus(cfg *config.Config, bc blockchain.Blockchain, ap actpool.ActPool, ...) Consensus
• type IotxConsensus
  • func (c *IotxConsensus) HandleBlockPropose(propose *iproto.ProposePb) error
  • func (c *IotxConsensus) HandleEndorse(endorse *iproto.EndorsePb) 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
• type Option
  • func WithRootChainAPI(exp explorerapi.Explorer) Option

Functions

func GetAddr

func GetAddr(cfg *config.Config) *iotxaddress.Address

GetAddr returns the iotex address

Types

type Consensus

type Consensus interface {
	lifecycle.StartStopper

	HandleBlockPropose(*iproto.ProposePb) error
	HandleEndorse(*iproto.EndorsePb) 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,
	opts ...Option,
) 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(propose *iproto.ProposePb) error

HandleBlockPropose handles a proposed block

func (*IotxConsensus) HandleEndorse

func (c *IotxConsensus) HandleEndorse(endorse *iproto.EndorsePb) error

HandleEndorse handle an endorse

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

type Option

type Option func(op *optionParams) error

Option sets Consensus construction parameter.

func WithRootChainAPI

func WithRootChainAPI(exp explorerapi.Explorer) Option

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