consensus

Documentation

Index

• Constants
• Variables
• func InitBlockInterval(blockIntervalSec int64)
• func Start(c Consensus)
• func Stop(c Consensus)
• type BlockFactory
• type ChainConsensus
• type ChainDB
• type Consensus
• type ConsensusAccessor
• type ConsensusType
• type Constructor
• type ErrorConsensus
  • func (e ErrorConsensus) Error() string
• type Info
  • func NewInfo(name string) *Info
  • func (i *Info) AsJSON() string

Constants

const DefaultBlockIntervalSec = int64(1)

DefaultBlockIntervalSec is the default block generation interval in seconds.

Variables

var (
	// BlockIntervalSec is the block genration interval in seconds.
	BlockIntervalSec = DefaultBlockIntervalSec

	// BlockInterval is the maximum block generation time limit.
	BlockInterval = time.Second * time.Duration(DefaultBlockIntervalSec)
)

var ConsensusName = []string{"dpos", "raft", "sbp"}

Functions

func InitBlockInterval

func InitBlockInterval(blockIntervalSec int64)

InitBlockInterval initializes block interval parameters.

func Start

func Start(c Consensus)

Start run a selected consesus service.

func Stop

func Stop(c Consensus)

Stop shutdown consensus service.

Types

type BlockFactory

type BlockFactory interface {
	Start()
	JobQueue() chan<- interface{}
}

BlockFactory is an interface for a block factory implementation.

type ChainConsensus

type ChainConsensus interface {
	GetType() ConsensusType
	IsTransactionValid(tx *types.Tx) bool
	VerifyTimestamp(block *types.Block) bool
	VerifySign(block *types.Block) error
	IsBlockValid(block *types.Block, bestBlock *types.Block) error
	Update(block *types.Block)
	Save(tx db.Transaction) error
	NeedReorganization(rootNo types.BlockNo) bool
	Info() string
}

ChainConsensus includes chainstatus and validation API.

type ChainDB

type ChainDB interface {
	GetBestBlock() (*types.Block, error)
	GetBlockByNo(blockNo types.BlockNo) (*types.Block, error)
	GetGenesisInfo() *types.Genesis
	Get(key []byte) []byte
	NewTx() db.Transaction
}

ChainDB is a reader interface for the ChainDB.

type Consensus

type Consensus interface {
	ChainConsensus
	ConsensusAccessor
	Ticker() *time.Ticker
	QueueJob(now time.Time, jq chan<- interface{})
	BlockFactory() BlockFactory
	QuitChan() chan interface{}
}

Consensus is an interface for a consensus implementation.

type ConsensusAccessor

type ConsensusAccessor interface {
	ConsensusInfo() *types.ConsensusInfo
}

type ConsensusType

type ConsensusType int

const (
	ConsensusDPOS ConsensusType = iota
	ConsensusRAFT
	ConsensusSBP
)

type Constructor

type Constructor func() (Consensus, error)

Constructor represents a function returning the Consensus interfactor for each implementation.

type ErrorConsensus

type ErrorConsensus struct {
	Msg string
	Err error
}

ErrorConsensus is a basic error struct for consensus modules.

func (ErrorConsensus) Error

func (e ErrorConsensus) Error() string

type Info

type Info struct {
	Type   string
	Status *json.RawMessage `json:",omitempty"`
}

Info represents an information for a consensus implementation.

func NewInfo

func NewInfo(name string) *Info

NewInfo returns a new Info with name.

func (*Info) AsJSON

func (i *Info) AsJSON() string

AsJSON() returns i as a JSON string