chainedhotstuff

Documentation

Overview

Package chainedhotstuff implements the pipelined three-chain version of the HotStuff protocol.

Index

• func New() consensus.Rules
• type ChainedHotStuff
  • func (hs *ChainedHotStuff) CommitRule(block *consensus.Block) *consensus.Block
  • func (hs *ChainedHotStuff) InitConsensusModule(mods *consensus.Modules, _ *consensus.OptionsBuilder)
  • func (hs *ChainedHotStuff) VoteRule(proposal consensus.ProposeMsg) bool

Functions

func New

func New() consensus.Rules

New returns a new chainedhotstuff instance.

Types

type ChainedHotStuff

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

ChainedHotStuff implements the pipelined three-phase HotStuff protocol.

func (*ChainedHotStuff) CommitRule

func (hs *ChainedHotStuff) CommitRule(block *consensus.Block) *consensus.Block

CommitRule decides whether an ancestor of the block should be committed.

func (*ChainedHotStuff) InitConsensusModule

func (hs *ChainedHotStuff) InitConsensusModule(mods *consensus.Modules, _ *consensus.OptionsBuilder)

InitConsensusModule gives the module a reference to the Modules object. It also allows the module to set module options using the OptionsBuilder.

func (*ChainedHotStuff) VoteRule

func (hs *ChainedHotStuff) VoteRule(proposal consensus.ProposeMsg) bool

VoteRule decides whether to vote for the proposal or not.