rolldpos

Documentation

Index

• Variables
• type Builder
  • func NewRollDPoSBuilder() *Builder
  • func (b *Builder) Build() (*RollDPoS, error)
  • func (b *Builder) RegisterProtocol(rp *rolldpos.Protocol) *Builder
  • func (b *Builder) SetActPool(actPool actpool.ActPool) *Builder
  • func (b *Builder) SetAddr(encodedAddr string) *Builder
  • func (b *Builder) SetBlockchain(chain blockchain.Blockchain) *Builder
  • func (b *Builder) SetBroadcast(broadcastHandler scheme.Broadcast) *Builder
  • func (b *Builder) SetCandidatesByHeightFunc(candidatesByHeightFunc CandidatesByHeightFunc) *Builder
  • func (b *Builder) SetClock(clock clock.Clock) *Builder
  • func (b *Builder) SetConfig(cfg config.Config) *Builder
  • func (b *Builder) SetPriKey(priKey keypair.PrivateKey) *Builder
  • func (b *Builder) SetRootChainAPI(api explorer.Explorer) *Builder
• type CandidatesByHeightFunc
• type RollDPoS
  • func (r *RollDPoS) Calibrate(height uint64)
  • func (r *RollDPoS) CurrentState() fsm.State
  • func (r *RollDPoS) HandleConsensusMsg(msg *iotexrpc.Consensus) error
  • func (r *RollDPoS) Metrics() (scheme.ConsensusMetrics, error)
  • func (r *RollDPoS) NumPendingEvts() int
  • func (r *RollDPoS) Start(ctx context.Context) error
  • func (r *RollDPoS) Stop(ctx context.Context) error
  • func (r *RollDPoS) ValidateBlockFooter(blk *block.Block) error

Variables

var (
	// ErrNewRollDPoS indicates the error of constructing RollDPoS
	ErrNewRollDPoS = errors.New("error when constructing RollDPoS")
	// ErrZeroDelegate indicates seeing 0 delegates in the network
	ErrZeroDelegate = errors.New("zero delegates in the network")
)

var (
	// ErrNotEnoughCandidates indicates there are not enough candidates from the candidate pool
	ErrNotEnoughCandidates = errors.New("Candidate pool does not have enough candidates")
)

Types

type Builder

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

Builder is the builder for RollDPoS

func NewRollDPoSBuilder

func NewRollDPoSBuilder() *Builder

NewRollDPoSBuilder instantiates a Builder instance

func (*Builder) Build

func (b *Builder) Build() (*RollDPoS, error)

Build builds a RollDPoS consensus module

func (*Builder) RegisterProtocol

func (b *Builder) RegisterProtocol(rp *rolldpos.Protocol) *Builder

RegisterProtocol sets the rolldpos protocol

func (*Builder) SetActPool

func (b *Builder) SetActPool(actPool actpool.ActPool) *Builder

SetActPool sets the action pool APIs

func (*Builder) SetAddr

func (b *Builder) SetAddr(encodedAddr string) *Builder

SetAddr sets the address and key pair for signature

func (*Builder) SetBlockchain

func (b *Builder) SetBlockchain(chain blockchain.Blockchain) *Builder

SetBlockchain sets the blockchain APIs

func (*Builder) SetBroadcast

func (b *Builder) SetBroadcast(broadcastHandler scheme.Broadcast) *Builder

SetBroadcast sets the broadcast callback

func (*Builder) SetCandidatesByHeightFunc

func (b *Builder) SetCandidatesByHeightFunc(
	candidatesByHeightFunc CandidatesByHeightFunc,
) *Builder

SetCandidatesByHeightFunc sets candidatesByHeightFunc

func (*Builder) SetClock

func (b *Builder) SetClock(clock clock.Clock) *Builder

SetClock sets the clock

func (*Builder) SetConfig

func (b *Builder) SetConfig(cfg config.Config) *Builder

SetConfig sets config

func (*Builder) SetPriKey

func (b *Builder) SetPriKey(priKey keypair.PrivateKey) *Builder

SetPriKey sets the private key

func (*Builder) SetRootChainAPI

func (b *Builder) SetRootChainAPI(api explorer.Explorer) *Builder

SetRootChainAPI sets root chain API

type CandidatesByHeightFunc

type CandidatesByHeightFunc func(uint64) ([]*state.Candidate, error)

CandidatesByHeightFunc defines a function to overwrite candidates

type RollDPoS

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

RollDPoS is Roll-DPoS consensus main entrance

func (*RollDPoS) Calibrate

func (r *RollDPoS) Calibrate(height uint64)

Calibrate called on receive a new block not via consensus

func (*RollDPoS) CurrentState

func (r *RollDPoS) CurrentState() fsm.State

CurrentState returns the current state

func (*RollDPoS) HandleConsensusMsg

func (r *RollDPoS) HandleConsensusMsg(msg *iotexrpc.Consensus) error

HandleConsensusMsg handles incoming consensus message

func (*RollDPoS) Metrics

func (r *RollDPoS) Metrics() (scheme.ConsensusMetrics, error)

Metrics returns RollDPoS consensus metrics

func (*RollDPoS) NumPendingEvts

func (r *RollDPoS) NumPendingEvts() int

NumPendingEvts returns the number of pending events

func (*RollDPoS) Start

func (r *RollDPoS) Start(ctx context.Context) error

Start starts RollDPoS consensus

func (*RollDPoS) Stop

func (r *RollDPoS) Stop(ctx context.Context) error

Stop stops RollDPoS consensus

func (*RollDPoS) ValidateBlockFooter

func (r *RollDPoS) ValidateBlockFooter(blk *block.Block) error

ValidateBlockFooter validates the signatures in the block footer