core

Documentation

Overview

Package core implements the core functionality of Istanbul consensus engine. The package defines `core` struct which stores all current consensus status such as validator set and round status. It also has accompanying methods to handle and broadcast messages between nodes.

In Istanbul consensus, there are 3 phases including Preprepare, Prepare and Commit. Each phase has its own message and by handling these messages the consensus can be made.

When a consensus is made for a given block, core communicates with the Istanbul backend to proceed.

Source Files

Core package is composed of following files

• `backlog.go`: Implements core methods handling future messages. The future message is a message which has future timestamp or in a different phase
• `commit.go`: Implements core methods which send, receive, handle, verify and accept commit messages
• `core.go`: Defines core struct and its methods related to timer setup, start new round and round state update
• `errors.go`: Defines consensus message related errors
• `events.go`: Defines backlog event and timeout event
• `final_committed.go`: Start a new round when a final committed proposal is stored
• `handler.go`: Implements core.Engine.Start and Stop. Provides event and message hendlers
• `message_set.go`: Defines messageSet struct which has a validator set and messages from other nodes
• `prepare.go`: Implements core methods which send, receive, handle, verify and accept prepare phase messages
• `preprepare.go`: Implements core methods which send, handle and accept preprepare messages
• `request.go`: Implements core methods which handle, check, store and process preprepare messages
• `roundchange.go`: Implement core methods receiving and handling roundchange messages
• `roundstate.go`: Defines roundState struct which has messages of each phase for a round
• `types.go`: Defines Engine interface and message, State type

Index

• func Encode(val interface{}) ([]byte, error)
• func PrepareCommittedSeal(hash common.Hash) []byte
• func RequiredMessageCount(valSet istanbul.ValidatorSet) int
• type Engine
  • func New(backend istanbul.Backend, config *istanbul.Config) Engine
• type State
  • func (s State) Cmp(y State) int
  • func (s State) String() string
• type Vrank
  • func NewVrank(view istanbul.View, committee istanbul.Validators) *Vrank
  • func (v *Vrank) AddCommit(msg *istanbul.Subject, src istanbul.Validator)
  • func (v *Vrank) Bitmap() string
  • func (v *Vrank) HandleCommitted(blockNum *big.Int)
  • func (v *Vrank) LateCommits() []time.Duration
  • func (v *Vrank) Log()
  • func (v *Vrank) TimeSinceStart() time.Duration

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

func RequiredMessageCount

func RequiredMessageCount(valSet istanbul.ValidatorSet) int

Minimum required number of consensus messages to proceed

Types

type Engine

type Engine interface {
	Start() error
	Stop() error
}

func New

func New(backend istanbul.Backend, config *istanbul.Config) Engine

New creates an Istanbul consensus core

type State

type State uint64

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

func (State) String

func (s State) String() string

type Vrank

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

func NewVrank

func NewVrank(view istanbul.View, committee istanbul.Validators) *Vrank

func (*Vrank) AddCommit

func (v *Vrank) AddCommit(msg *istanbul.Subject, src istanbul.Validator)

func (*Vrank) Bitmap

func (v *Vrank) Bitmap() string

func (*Vrank) HandleCommitted

func (v *Vrank) HandleCommitted(blockNum *big.Int)

func (*Vrank) LateCommits

func (v *Vrank) LateCommits() []time.Duration

func (*Vrank) Log

func (v *Vrank) Log()

Log logs accumulated data in a compressed form

func (*Vrank) TimeSinceStart

func (v *Vrank) TimeSinceStart() time.Duration