process

Mar 11, 2020

Changes in this version

type Resync

+ func (resync *Resync) UnmarshalBinary(data []byte) error

+ func (resync *Resync) UnmarshalJSON(data []byte) error

+ func (resync Resync) MarshalBinary() ([]byte, error)

+ func (resync Resync) MarshalJSON() ([]byte, error)

Oct 4, 2021

Changes in this version

type Process

+ func (p *Process) StartWithNewSignatories(f uint64, scheduler Scheduler)

Jun 15, 2021

Changes in this version

+ var DefaultHeight = Height(1)

+ var DefaultRound = Round(0)

type Process

+ func NewWithCurrentHeight(whoami id.Signatory, height Height, f int, timer Timer, scheduler Scheduler, ...) Process

Dec 11, 2020

Changes in this version

type MessageType

+ const MessageTypeTimeout

+ func (ty MessageType) String() string

Mar 25, 2020

Changes in this version

+ const ResyncMessageType

+ var ErrBlockHashNotProvided = errors.New("block hash not provided")

type Broadcaster

+ Cast func(id.Signatory, Message)

type Inbox

+ func (inbox *Inbox) Delete(height block.Height)

+ func (inbox *Inbox) Unmarshal(r io.Reader, m int) (int, error)

+ func (inbox Inbox) Marshal(w io.Writer, m int) (int, error)

+ func (inbox Inbox) SizeHint() int

type MessageType

+ func (mt *MessageType) Unmarshal(r io.Reader, m int) (int, error)

+ func (mt MessageType) Marshal(w io.Writer, m int) (int, error)

+ func (mt MessageType) SizeHint() int

type Process

+ func (p *Process) Restore()

+ func (p *Process) Save()

+ type Resync struct

+ func NewResync(height block.Height, round block.Round) *Resync

+ func (resync *Resync) BlockHash() id.Hash

+ func (resync *Resync) Height() block.Height

+ func (resync *Resync) Round() block.Round

+ func (resync *Resync) Sig() id.Signature

+ func (resync *Resync) SigHash() id.Hash

+ func (resync *Resync) Signatory() id.Signatory

+ func (resync *Resync) String() string

+ func (resync *Resync) Type() MessageType

+ func (resync *Resync) Unmarshal(r io.Reader, m int) (int, error)

+ func (resync Resync) Marshal(w io.Writer, m int) (int, error)

+ func (resync Resync) SizeHint() int

+ type Resyncs []Resync

+ type SaveRestorer interface

+ Restore func(*State)

+ Save func(*State)

type Step

+ func (Step) SizeHint() int

+ func (step *Step) Unmarshal(r io.Reader, m int) (int, error)

+ func (step Step) Marshal(w io.Writer, m int) (int, error)

Dec 10, 2020

Changes in this version

type Catcher

+ CatchOutOfTurnPropose func(Propose)

type MessageType

+ const MessageTypePrecommit

+ const MessageTypePrevote

+ const MessageTypePropose

type State

+ ProposeIsValid map[Round]bool

+ TraceLogs map[Round]map[id.Signatory]bool

+ func (state State) WithCurrentHeight(height Height) State

type Value

+ func (v *Value) UnmarshalJSON(data []byte) error

+ func (v Value) MarshalJSON() ([]byte, error)

+ func (v Value) String() string

Jul 1, 2020

Changes in this version

+ const InvalidRound

+ const OnceFlagPrecommitUponSufficientPrevotes

+ const OnceFlagTimeoutPrecommitUponSufficientPrecommits

+ const OnceFlagTimeoutPrevoteUponSufficientPrevotes

+ const Precommitting

+ const Prevoting

+ const Proposing

+ var NilValue = Value(id.Hash{})

+ func NewPrecommitHash(height Height, round Round, value Value) (id.Hash, error)

+ func NewPrecommitHashWithBuffer(height Height, round Round, value Value, buf *bytes.Buffer) (id.Hash, error)

+ func NewPrevoteHash(height Height, round Round, value Value) (id.Hash, error)

+ func NewPrevoteHashWithBuffer(height Height, round Round, value Value, buf *bytes.Buffer) (id.Hash, error)

+ func NewProposeHash(height Height, round Round, validRound Round, value Value) (id.Hash, error)

+ func NewProposeHashWithBuffer(height Height, round Round, validRound Round, value Value, buf *bytes.Buffer) (id.Hash, error)

type Broadcaster

+ BroadcastPrecommit func(Precommit)

+ BroadcastPrevote func(Prevote)

+ BroadcastPropose func(Propose)

+ type Catcher interface

+ CatchDoublePrecommit func(Precommit, Precommit)

+ CatchDoublePrevote func(Prevote, Prevote)

+ CatchDoublePropose func(Propose, Propose)

+ type Committer interface

+ Commit func(Height, Value)

+ type Height int64

+ type OnceFlag uint16

type Precommit

+ From id.Signatory

+ Signature id.Signature

+ Value Value

+ func (precommit *Precommit) Unmarshal(r io.Reader, m int) (int, error)

+ func (precommit Precommit) Equal(other *Precommit) bool

+ func (precommit Precommit) Marshal(w io.Writer, m int) (int, error)

+ func (precommit Precommit) SizeHint() int

type Prevote

+ From id.Signatory

+ Signature id.Signature

+ Value Value

+ func (prevote *Prevote) Unmarshal(r io.Reader, m int) (int, error)

+ func (prevote Prevote) Equal(other *Prevote) bool

+ func (prevote Prevote) Marshal(w io.Writer, m int) (int, error)

+ func (prevote Prevote) SizeHint() int

type Process

+ func (p *Process) OnTimeoutPrecommit(height Height, round Round)

+ func (p *Process) OnTimeoutPrevote(height Height, round Round)

+ func (p *Process) OnTimeoutPropose(height Height, round Round)

+ func (p *Process) Precommit(precommit Precommit)

+ func (p *Process) Prevote(prevote Prevote)

+ func (p *Process) Propose(propose Propose)

+ func (p *Process) Unmarshal(r io.Reader, m int) (int, error)

+ func (p Process) Marshal(w io.Writer, m int) (int, error)

+ func (p Process) SizeHint() int

type Propose

+ From id.Signatory

+ Signature id.Signature

+ Value Value

+ func (propose *Propose) Unmarshal(r io.Reader, m int) (int, error)

+ func (propose Propose) Equal(other *Propose) bool

+ func (propose Propose) Marshal(w io.Writer, m int) (int, error)

+ func (propose Propose) SizeHint() int

type Proposer

+ Propose func(Height, Round) Value

+ type Round int64

type State

+ LockedValue Value

+ OnceFlags map[Round]OnceFlag

+ PrecommitLogs map[Round]map[id.Signatory]Precommit

+ PrevoteLogs map[Round]map[id.Signatory]Prevote

+ ProposeLogs map[Round]Propose

+ ValidValue Value

+ func (state *State) Unmarshal(r io.Reader, m int) (int, error)

+ func (state State) Clone() State

+ func (state State) Marshal(w io.Writer, m int) (int, error)

+ func (state State) SizeHint() int

type Timer

+ TimeoutPrecommit func(Height, Round)

+ TimeoutPrevote func(Height, Round)

+ TimeoutPropose func(Height, Round)

type Validator

+ Valid func(Value) bool

+ type Value id.Hash

+ func (v *Value) Equal(other *Value) bool

Oct 23, 2019

Changes in this version

type Inbox

+ func (inbox *Inbox) QueryMessagesByHeightRound(height block.Height, round block.Round) []Message

+ func (inbox *Inbox) QueryMessagesByHeightWithHighestRound(height block.Height) []Message

+ type NilReasons map[string][]byte

+ func (nilReasons *NilReasons) UnmarshalBinary(data []byte) error

+ func (nilReasons NilReasons) MarshalBinary() ([]byte, error)

type Observer

+ DidReceiveSufficientNilPrevotes func(messages Messages, f int)

type Prevote

+ func (prevote *Prevote) NilReasons() NilReasons

Oct 1, 2019

Changes in this version

+ const NilMessageType

+ const PrecommitMessageType

+ const PrevoteMessageType

+ const ProposeMessageType

+ func Sign(m Message, privKey ecdsa.PrivateKey) error

+ func Verify(m Message) error

+ type Blockchain interface

+ BlockAtHeight func(block.Height) (block.Block, bool)

+ BlockExistsAtHeight func(block.Height) bool

+ InsertBlockAtHeight func(block.Height, block.Block)

+ type Broadcaster interface

+ Broadcast func(Message)

+ type Inbox struct

+ func NewInbox(f int, messageType MessageType) *Inbox

+ func (inbox *Inbox) F() int

+ func (inbox *Inbox) Insert(message Message) (n int, firstTime, firstTimeExceedingF, firstTimeExceeding2F, ... bool)

+ func (inbox *Inbox) MessageType() MessageType

+ func (inbox *Inbox) QueryByHeightRound(height block.Height, round block.Round) (n int)

+ func (inbox *Inbox) QueryByHeightRoundBlockHash(height block.Height, round block.Round, blockHash id.Hash) (n int)

+ func (inbox *Inbox) QueryByHeightRoundSignatory(height block.Height, round block.Round, sig id.Signatory) Message

+ func (inbox *Inbox) QueryMessagesByHeightWithHigestRound(height block.Height) []Message

+ func (inbox *Inbox) Reset(height block.Height)

+ func (inbox *Inbox) UnmarshalBinary(data []byte) error

+ func (inbox *Inbox) UnmarshalJSON(data []byte) error

+ func (inbox Inbox) MarshalBinary() ([]byte, error)

+ func (inbox Inbox) MarshalJSON() ([]byte, error)

+ type LatestCommit struct

+ Block block.Block

+ Precommits []Precommit

+ type Message interface

+ BlockHash func() id.Hash

+ Height func() block.Height

+ Round func() block.Round

+ Sig func() id.Signature

+ SigHash func() id.Hash

+ Signatory func() id.Signatory

+ Type func() MessageType

+ type MessageType uint64

+ type Messages []Message

+ type Observer interface

+ DidCommitBlock func(block.Height)

+ type Precommit struct

+ func NewPrecommit(height block.Height, round block.Round, blockHash id.Hash) *Precommit

+ func (precommit *Precommit) BlockHash() id.Hash

+ func (precommit *Precommit) Height() block.Height

+ func (precommit *Precommit) Round() block.Round

+ func (precommit *Precommit) Sig() id.Signature

+ func (precommit *Precommit) SigHash() id.Hash

+ func (precommit *Precommit) Signatory() id.Signatory

+ func (precommit *Precommit) String() string

+ func (precommit *Precommit) Type() MessageType

+ func (precommit *Precommit) UnmarshalBinary(data []byte) error

+ func (precommit *Precommit) UnmarshalJSON(data []byte) error

+ func (precommit Precommit) MarshalBinary() ([]byte, error)

+ func (precommit Precommit) MarshalJSON() ([]byte, error)

+ type Precommits []Precommit

+ type Prevote struct

+ func NewPrevote(height block.Height, round block.Round, blockHash id.Hash) *Prevote

+ func (prevote *Prevote) BlockHash() id.Hash

+ func (prevote *Prevote) Height() block.Height

+ func (prevote *Prevote) Round() block.Round

+ func (prevote *Prevote) Sig() id.Signature

+ func (prevote *Prevote) SigHash() id.Hash

+ func (prevote *Prevote) Signatory() id.Signatory

+ func (prevote *Prevote) String() string

+ func (prevote *Prevote) Type() MessageType

+ func (prevote *Prevote) UnmarshalBinary(data []byte) error

+ func (prevote *Prevote) UnmarshalJSON(data []byte) error

+ func (prevote Prevote) MarshalBinary() ([]byte, error)

+ func (prevote Prevote) MarshalJSON() ([]byte, error)

+ type Prevotes []Prevote

+ type Process struct

+ func New(logger logrus.FieldLogger, signatory id.Signatory, blockchain Blockchain, ...) *Process

+ func (p *Process) HandleMessage(m Message)

+ func (p *Process) Start()

+ func (p *Process) StartRound(round block.Round)

+ func (p *Process) UnmarshalBinary(data []byte) error

+ func (p *Process) UnmarshalJSON(data []byte) error

+ func (p Process) MarshalBinary() ([]byte, error)

+ func (p Process) MarshalJSON() ([]byte, error)

+ type Processes []Process

+ type Propose struct

+ func NewPropose(height block.Height, round block.Round, block block.Block, ...) *Propose

+ func (propose *Propose) Block() block.Block

+ func (propose *Propose) BlockHash() id.Hash

+ func (propose *Propose) Height() block.Height

+ func (propose *Propose) Round() block.Round

+ func (propose *Propose) Sig() id.Signature

+ func (propose *Propose) SigHash() id.Hash

+ func (propose *Propose) Signatory() id.Signatory

+ func (propose *Propose) String() string

+ func (propose *Propose) Type() MessageType

+ func (propose *Propose) UnmarshalBinary(data []byte) error

+ func (propose *Propose) UnmarshalJSON(data []byte) error

+ func (propose *Propose) ValidRound() block.Round

+ func (propose Propose) MarshalBinary() ([]byte, error)

+ func (propose Propose) MarshalJSON() ([]byte, error)

+ type Proposer interface

+ BlockProposal func(block.Height, block.Round) block.Block

+ type Proposes []Propose

+ type Scheduler interface

+ Schedule func(block.Height, block.Round) id.Signatory

+ type State struct

+ CurrentHeight block.Height

+ CurrentRound block.Round

+ CurrentStep Step

+ LockedBlock block.Block

+ LockedRound block.Round

+ Precommits *Inbox

+ Prevotes *Inbox

+ Proposals *Inbox

+ ValidBlock block.Block

+ ValidRound block.Round

+ func DefaultState(f int) State

+ func (state *State) Equal(other State) bool

+ func (state *State) Reset(height block.Height)

+ func (state *State) UnmarshalBinary(data []byte) error

+ func (state State) MarshalBinary() ([]byte, error)

+ type Step uint8

+ const StepNil

+ const StepPrecommit

+ const StepPrevote

+ const StepPropose

+ type Timer interface

+ Timeout func(step Step, round block.Round) time.Duration

+ type Validator interface

+ IsBlockValid func(block block.Block, checkHistory bool) error