model

type Block ¶

type Block struct {
	View        uint64
	BlockID     flow.Identifier
	ProposerID  flow.Identifier
	QC          *flow.QuorumCertificate
	PayloadHash flow.Identifier
	Timestamp   time.Time
}

Block is the HotStuff algorithm's concept of a block, which - in the bigger picture - corresponds to the block header.

func BlockFromFlow(header *flow.Header, parentView uint64) *Block

func GenesisBlockFromFlow(header *flow.Header) *Block

type ByzantineThresholdExceededError ¶

type ByzantineThresholdExceededError struct {
	Evidence string
}

ByzantineThresholdExceededError is raised if HotStuff detects malicious conditions which prove a Byzantine threshold of consensus replicas has been exceeded. Per definition, the byzantine threshold is exceeded is there are byzantine consensus replicas with _at least_ 1/3 stake.

func (e ByzantineThresholdExceededError) Error() string

type ConfigurationError ¶

type ConfigurationError struct {
	Msg string
}

func (e ConfigurationError) Error() string

type InvalidBlockError ¶

type InvalidBlockError struct {
	BlockID flow.Identifier
	View    uint64
	Err     error
}

func (e InvalidBlockError) Error() string

func (e InvalidBlockError) Unwrap() error

type InvalidVoteError ¶

type InvalidVoteError struct {
	VoteID flow.Identifier
	View   uint64
	Err    error
}

func (e InvalidVoteError) Error() string

func (e InvalidVoteError) Unwrap() error

type MissingBlockError ¶

type MissingBlockError struct {
	View    uint64
	BlockID flow.Identifier
}

func (e MissingBlockError) Error() string

type NewViewEvent ¶

type NewViewEvent struct {
	View uint64
}

NewViewEvent is the new view event that contains the new view.

type NoVoteError ¶

type NoVoteError struct {
	Msg string
}

NoVoteError contains the reason of why the voter didn't vote for a block proposal.

func (e NoVoteError) Error() string

type Proposal ¶

type Proposal struct {
	Block   *Block
	SigData []byte
}

Proposal represent a new proposed block within HotStuff (and thus a a header in the bigger picture), signed by the proposer.

func ProposalFromFlow(header *flow.Header, parentView uint64) *Proposal

func (p *Proposal) ProposerVote() *Vote

type TimeoutMode ¶

type TimeoutMode int

TimeoutMode enum type

const (
	// ReplicaTimeout represents the time period that the replica is waiting for the block for the current view.
	ReplicaTimeout TimeoutMode = iota
	// VoteCollectionTimeout represents the time period that the leader is waiting for votes in order to build
	// the next block.
	VoteCollectionTimeout
)

func (m TimeoutMode) String() string

type TimerInfo ¶

type TimerInfo struct {
	Mode      TimeoutMode
	View      uint64
	StartTime time.Time
	Duration  time.Duration
}

TimerInfo represents a time period that pacemaker is waiting for a specific event. The end of the time period is the timeout that will trigger pacemaker's view change.

type Vote ¶

type Vote struct {
	View     uint64
	BlockID  flow.Identifier
	SignerID flow.Identifier
	SigData  []byte
}

Vote is the HotStuff algorithm's concept of a vote for a block proposal.

func VoteFromFlow(signerID flow.Identifier, blockID flow.Identifier, view uint64, sig crypto.Signature) *Vote

func (uv *Vote) ID() flow.Identifier