scheme

Documentation

Index

• type BroadcastCB
• type ConsensusDoneCB
• type ConsensusMetrics
• type CreateBlockCB
• type Noop
  • func (n *Noop) Handle(message proto.Message) error
  • func (n *Noop) Metrics() (ConsensusMetrics, error)
  • func (n *Noop) SetDoneStream(done chan bool)
  • func (n *Noop) Start(_ context.Context) error
  • func (n *Noop) Stop(_ context.Context) error
• type Scheme
  • func NewNoop() Scheme
  • func NewStandalone(create CreateBlockCB, commit ConsensusDoneCB, pub BroadcastCB, ...) Scheme
• type Standalone
  • func (n *Standalone) Handle(message proto.Message) error
  • func (n *Standalone) Metrics() (ConsensusMetrics, error)
  • func (n *Standalone) SetDoneStream(done chan bool)
  • func (n *Standalone) Start(ctx context.Context) error
  • func (n *Standalone) Stop(ctx context.Context) error
• type TellPeerCB

Types

type BroadcastCB

type BroadcastCB func(*blockchain.Block) error

BroadcastCB defines the callback to publish the consensus result

type ConsensusDoneCB

type ConsensusDoneCB func(*blockchain.Block) error

ConsensusDoneCB defines the callback when consensus is reached

type ConsensusMetrics

type ConsensusMetrics struct {
	LatestEpoch         uint64
	LatestHeight        uint64
	LatestDelegates     []string
	LatestBlockProducer string
	Candidates          []string
}

ConsensusMetrics contains consensus metrics to expose

type CreateBlockCB

type CreateBlockCB func() (*blockchain.Block, error)

CreateBlockCB defines the callback to create a new block

type Noop

type Noop struct {
}

Noop is the consensus scheme that does NOT create blocks

func (*Noop) Handle

func (n *Noop) Handle(message proto.Message) error

Handle handles incoming requests

func (*Noop) Metrics

func (n *Noop) Metrics() (ConsensusMetrics, error)

Metrics is not implemented for standalone scheme

func (*Noop) SetDoneStream

func (n *Noop) SetDoneStream(done chan bool)

SetDoneStream does nothing for Noop (only used in simulator)

func (*Noop) Start

func (n *Noop) Start(_ context.Context) error

Start does nothing here

func (*Noop) Stop

func (n *Noop) Stop(_ context.Context) error

Stop does nothing here

type Scheme

type Scheme interface {
	lifecycle.StartStopper

	Handle(msg proto.Message) error
	SetDoneStream(chan bool)
	Metrics() (ConsensusMetrics, error)
}

Scheme is the interface that consensus schemes should implement

func NewNoop

func NewNoop() Scheme

NewNoop creates a Noop struct

func NewStandalone

func NewStandalone(create CreateBlockCB, commit ConsensusDoneCB, pub BroadcastCB, bc blockchain.Blockchain, interval time.Duration) Scheme

NewStandalone creates a Standalone struct.

type Standalone

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

Standalone is the consensus scheme that periodically create blocks

func (*Standalone) Handle

func (n *Standalone) Handle(message proto.Message) error

Handle handles incoming requests

func (*Standalone) Metrics

func (n *Standalone) Metrics() (ConsensusMetrics, error)

Metrics is not implemented for standalone scheme

func (*Standalone) SetDoneStream

func (n *Standalone) SetDoneStream(done chan bool)

SetDoneStream does nothing in Standalone (only used in simulator)

func (*Standalone) Start

func (n *Standalone) Start(ctx context.Context) error

Start starts the service for a standalone

func (*Standalone) Stop

func (n *Standalone) Stop(ctx context.Context) error

Stop stops the service for a standalone

type TellPeerCB

type TellPeerCB func(proto.Message) error

TellPeerCB defines the callback to tell (which is a unicast) message to peers on P2P network