consensus

README

consensus

Src of consensus algorithm, obviously.

Documentation

Index

• Constants
• type BaseEvent
  • func (e *BaseEvent) Data() interface{}
  • func (e *BaseEvent) EventType() EventType
• type Consensus
• type Event
  • func NewBaseEvent(t EventType, data interface{}) Event
• type EventType
• type State
• type States

Constants

const (
	NetMessageEvent = "event.netmessage"
	NewBlockEvent   = "event.newblock"
	CanMiningEvent  = "event.canmining"
)

EventType list

Types

type BaseEvent

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

BaseEvent is a kind of event structure

func (*BaseEvent) Data

func (e *BaseEvent) Data() interface{}

Data of an event instance

func (*BaseEvent) EventType

func (e *BaseEvent) EventType() EventType

EventType of an event instance

type Consensus

type Consensus interface {
	Start()
	Stop()

	CanMining() bool
	SetCanMining(bool)

	TransitByKey(from, to string, data interface{})
	Transit(from, to State, data interface{})

	VerifyBlock(*core.Block) error
}

Consensus interface of consensus algorithm.

type Event

type Event interface {
	EventType() EventType
	Data() interface{}
}

Event in Consensus State-Machine

func NewBaseEvent

func NewBaseEvent(t EventType, data interface{}) Event

NewBaseEvent creates an event

type EventType

type EventType string

EventType of Events in Consensus State-Machine

type State

type State interface {
	Event(e Event) (bool, State)
	Enter(data interface{})
	Leave(data interface{})
}

State in Consensus State-Machine

type States

type States map[string]State

States contains all possible states in Consensus State-Machine