core

Documentation

Index

• Variables
• func Encode(val interface{}) ([]byte, error)
• func PrepareCommittedSeal(hash common.Hash) []byte
• type Engine
  • func NewCore(server bft.Server, config *bft.BFTConfig) Engine
• type State
  • func (s State) Cmp(y State) int

Variables

var (

	// ErrAddressUnauthorized is returned when given address cannot be found in
	// current validator set.
	ErrAddressUnauthorized = errors.New("unauthorized address")
	// ErrEngineStopped is returned if the engine is stopped
	ErrEngineStopped = errors.New("stopped engine")
	// ErrEngineStarted is returned if the engine is already started
	ErrEngineStarted = errors.New("started engine")
)

Functions

func Encode

func Encode(val interface{}) ([]byte, error)

func PrepareCommittedSeal

func PrepareCommittedSeal(hash common.Hash) []byte

PrepareCommittedSeal returns a committed seal for the given hash

Types

type Engine

type Engine interface {
	// begein to handle the roundchange/subscribeEvent/handleEvent
	Start() error
	// Stop the engine
	Stop() error
}

func NewCore

func NewCore(server bft.Server, config *bft.BFTConfig) Engine

NewCore initiate a new core

type State

type State uint64 // indicate state of

const (
	StateAcceptRequest State = iota
	StatePreprepared
	StatePrepared
	StateCommitted
)

func (State) Cmp

func (s State) Cmp(y State) int

Cmp compares s and y and returns:

-1 if s is the previous state of y
 0 if s and y are the same state
+1 if s is the next state of y