consensus

Documentation

Index

• func Hash(content []byte) string
• type MsgLogs
• type MsgType
• type PBFT
• type PrePrepareMsg
• type ReplyMsg
• type RequestMsg
• type Stage
• type State
  • func CreateState(viewID int64, lastSequenceID int64) *State
  • func (state *State) Commit(commitMsg *VoteMsg) (*ReplyMsg, *RequestMsg, error)
  • func (state *State) PrePrepare(prePrepareMsg *PrePrepareMsg) (*VoteMsg, error)
  • func (state *State) Prepare(prepareMsg *VoteMsg) (*VoteMsg, error)
  • func (state *State) StartConsensus(request *RequestMsg) (*PrePrepareMsg, error)
• type VoteMsg

Functions

func Hash

func Hash(content []byte) string

Types

type MsgLogs

type MsgLogs struct {
	ReqMsg      *RequestMsg
	PrepareMsgs map[string]*VoteMsg
	CommitMsgs  map[string]*VoteMsg
}

type MsgType

type MsgType int

const (
	PrepareMsg MsgType = iota
	CommitMsg
)

type PBFT

type PBFT interface {
	StartConsensus(request *RequestMsg) (*PrePrepareMsg, error)
	PrePrepare(prePrepareMsg *PrePrepareMsg) (*VoteMsg, error)
	Prepare(prepareMsg *VoteMsg) (*VoteMsg, error)
	Commit(commitMsg *VoteMsg) (*ReplyMsg, *RequestMsg, error)
}

type PrePrepareMsg

type PrePrepareMsg struct {
	ViewID     int64       `json:"viewID"`
	SequenceID int64       `json:"sequenceID"`
	Digest     string      `json:"digest"`
	RequestMsg *RequestMsg `json:"requestMsg"`
}

type ReplyMsg

type ReplyMsg struct {
	ViewID    int64  `json:"viewID"`
	Timestamp int64  `json:"timestamp"`
	ClientID  string `json:"clientID"`
	NodeID    string `json:"nodeID"`
	Result    string `json:"result"`
}

type RequestMsg

type RequestMsg struct {
	Timestamp  int64  `json:"timestamp"`
	ClinetID   string `json:"clientID"`
	Operation  string `json:"operation"`
	SequenceID int64  `json:"sequenceID"`
}

type Stage

type Stage int

const (
	Idle        Stage = iota // Node is created successfully, but the consensus process is not started yet.
	PrePrepared              // The ReqMsgs is processed successfully. The node is ready to head to the Prepare stage.
	Prepared                 // Same with `prepared` stage explained in the original paper.
	Committed                // Same with `committed-local` stage explained in the original paper.
)

type State

type State struct {
	ViewID         int64
	MsgLogs        *MsgLogs
	LastSequenceID int64
	CurrentStage   Stage
}

func CreateState

func CreateState(viewID int64, lastSequenceID int64) *State

func (*State) Commit

func (state *State) Commit(commitMsg *VoteMsg) (*ReplyMsg, *RequestMsg, error)

func (*State) PrePrepare

func (state *State) PrePrepare(prePrepareMsg *PrePrepareMsg) (*VoteMsg, error)

func (*State) Prepare

func (state *State) Prepare(prepareMsg *VoteMsg) (*VoteMsg, error)

func (*State) StartConsensus

func (state *State) StartConsensus(request *RequestMsg) (*PrePrepareMsg, error)

type VoteMsg

type VoteMsg struct {
	ViewID     int64  `json:"viewID"`
	SequenceID int64  `json:"sequenceID"`
	Digest     string `json:"digest"`
	NodeID     string `json:"nodeID"`
	MsgType    `json:"msgType"`
}