Back to

Package rolldpos

Latest Go to latest

The highest tagged major version is .

Published: Apr 21, 2019 | License: Apache-2.0 | Module:



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")
	// ErrNotEnoughCandidates indicates there are not enough candidates from the candidate pool
	ErrNotEnoughCandidates = errors.New("Candidate pool does not have enough candidates")
var (
	// ErrExpiredEndorsement indicates that the endorsement is expired
	ErrExpiredEndorsement = errors.New("the endorsement has been replaced or expired")
var ErrInsufficientEndorsements = errors.New("Insufficient endorsements")

ErrInsufficientEndorsements represents the error that not enough endorsements

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 ConsensusVote

type ConsensusVote struct {
	// contains filtered or unexported fields

ConsensusVote is a vote on a given topic for a block on a specific height

func NewConsensusVote

func NewConsensusVote(
	blkHash []byte,
	topic ConsensusVoteTopic,
) *ConsensusVote

NewConsensusVote creates a consensus vote

func (*ConsensusVote) BlockHash

func (v *ConsensusVote) BlockHash() []byte

BlockHash returns the block hash of the consensus vote

func (*ConsensusVote) Hash

func (v *ConsensusVote) Hash() ([]byte, error)

Hash returns the hash of this vote

func (*ConsensusVote) LoadProto

func (v *ConsensusVote) LoadProto(msg *iotextypes.ConsensusVote) error

LoadProto loads from a protobuf message

func (*ConsensusVote) Proto

func (v *ConsensusVote) Proto() (*iotextypes.ConsensusVote, error)

Proto converts to a protobuf message

func (*ConsensusVote) Topic

func (v *ConsensusVote) Topic() ConsensusVoteTopic

Topic returns the topic of the consensus vote

type ConsensusVoteTopic

type ConsensusVoteTopic uint8

ConsensusVoteTopic defines the topic of an consensus vote

const (
	// PROPOSAL stands for an consensus vote to endorse a block proposal
	PROPOSAL ConsensusVoteTopic = 0
	// LOCK stands for an consensus vote to endorse a lock on a proposed block
	LOCK ConsensusVoteTopic = 1
	// COMMIT stands for an consensus vote to endorse a block commit
	COMMIT ConsensusVoteTopic = 2

type EndorsedConsensusMessage

type EndorsedConsensusMessage struct {
	// contains filtered or unexported fields

EndorsedConsensusMessage is an endorsement on document

func NewEndorsedConsensusMessage

func NewEndorsedConsensusMessage(
	height uint64,
	message endorsement.Document,
	endorsement *endorsement.Endorsement,
) *EndorsedConsensusMessage

NewEndorsedConsensusMessage creates an EndorsedConsensusMessage for an consensus vote

func (*EndorsedConsensusMessage) Document

func (ecm *EndorsedConsensusMessage) Document() endorsement.Document

Document returns the endorsed consensus message

func (*EndorsedConsensusMessage) Endorsement

func (ecm *EndorsedConsensusMessage) Endorsement() *endorsement.Endorsement

Endorsement returns the endorsement

func (*EndorsedConsensusMessage) Height

func (ecm *EndorsedConsensusMessage) Height() uint64

Height returns the height of this message

func (*EndorsedConsensusMessage) LoadProto

func (ecm *EndorsedConsensusMessage) LoadProto(msg *iotextypes.ConsensusMessage) error

LoadProto creates an endorsement message from protobuf message

func (*EndorsedConsensusMessage) Proto

func (ecm *EndorsedConsensusMessage) Proto() (*iotextypes.ConsensusMessage, error)

Proto converts an endorsement to endorse proto

type RollDPoS

type RollDPoS struct {
	// contains filtered or unexported fields

RollDPoS is Roll-DPoS consensus main entrance

func (*RollDPoS) Activate

func (r *RollDPoS) Activate(active bool)

Activate activates or pauses the roll-DPoS consensus. When it is deactivated, the node will finish the current consensus round if it is doing the work and then return the the initial state

func (*RollDPoS) Active

func (r *RollDPoS) Active() bool

Active is true if the roll-DPoS consensus is active, or false if it is stand-by

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 *iotextypes.ConsensusMessage) 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

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier