core

Documentation

Overview

Package core implements core functionality of istanbul consensus engine.

Index

• func Encode(val interface{}) ([]byte, error)
• func PrepareCommittedSeal(hash common.Hash) []byte
• 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

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 {
	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