protocol

type Message struct {
	Code          uint64                `json:"code"`                     // 消息类型
	Msg           []byte                `json:"msg"`                      // 消息内容
	Validator     string                `json:"validator"`                // 验证者（peerId）
	Signature     *signature.SignResult `json:"signature" rlp:"nil"`      // 签名内容
	CommittedSeal *signature.SignResult `json:"committed_seal" rlp:"nil"` // 被提交的seal
}

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

type PBFTBackend interface {
	ID() string                                      // 当前Validator的ID
	Validators(proposal Proposal) ValidatorSet       // validator的集合
	ParentValidators(proposal Proposal) ValidatorSet // 获取给定的提议父区块获取validator集合

	Verify(proposal Proposal) error                                // 验证提议
	Commit(proposal Proposal, seals []*signature.SignResult) error // 提交已批准的提议，提议将会写入区块链

	Sign(data []byte) (*signature.SignResult, error)                               // 使用私钥进行签名数据
	CheckSignature(data []byte, validator string, sig *signature.SignResult) error // 判断签名是否为给定的validator签署的

	LastProposal() (Proposal, string)                // 获取最新的proposal提议，及proposer提议者的地址
	HasProposal(hash types.Hash, height uint64) bool // 检查给定Hash和高度是否有匹配的提议
	GetProposer(height uint64) string                // 根据区块高度获取提议者地址
}

type PBFTConfig struct {
	Epoch          uint64          `json:"epoch" mapstructure:"epoch"`           // 期数
	RequestTimeout uint64          `json:"timeout" mapstructure:"timeout"`       // round 超时时间， 在BlockPeriod不为0时有效
	BlockPeriod    uint64          `json:"period" mapstructure:"period"`         // 区块产生间隔(毫秒)
	ProposerPolicy ProposerPolicy  `json:"policy" mapstructure:"policy"`         // Proposer 策略
	Managers       []types.Address `json:"managers" mapstructure:"managers"`     // 创世管理员地址
	Validators     []string        `json:"validators" mapstructure:"validators"` // 创世验证者地址
}

type PBFTEngine interface {
	Start() error
	Stop() error
	Request(*Request) error
	RequestTimeout()
	NewChainHead() error
}

type PrePrepare struct {
	View     *View
	Proposal Proposal
}

type Proposal interface {
	Height() uint64    // 返回提议的序列号
	Hash() types.Hash  // 返回提议的hash
	Timestamp() uint64 // 返回提议时间戳
}

type ProposalSelector func(ValidatorSet, string, uint64) Validator

type ProposerPolicy uint64

type Request struct {
	Proposal Proposal
}

type State uint64

type Subject struct {
	View   *View      // 视图
	Digest types.Hash // 摘要（使用的区块hash）
}

type Validator interface {
	ID() string     // ID 返回PBFT节点标识
	String() string // 校验者字符串
}

type ValidatorSet interface {
	CalcProposer(lastProposer string, round uint64) // 根据Proposer计算下一个Proposer, 并记录到ValidatorSet, 通过GetProposer查询
	GetProposer() Validator                         // 返回当前proposer
	IsProposer(id string) bool                      // 查询指定的id是否为proposer
	Policy() ProposerPolicy                         // 提议选举策略

	GetByIndex(index uint64) Validator                  // 通过索引查找validator
	GetById(id string) (index int, validator Validator) // 通过ID查找validator, 并返回其索引
	AddValidator(id string) bool                        // 添加validator
	RemoveValidator(id string) bool                     // 删除validator
	List() []Validator                                  // 返回 validator 数组
	Size() int                                          // 返回验证者集合的长度

	Copy() ValidatorSet    // 复制
	FaultTolerantNum() int // 容错节点数
}

type Validators []Validator

type View struct {
	Sequence *big.Int // 提议的区块高度。每个周期都有一个高度。周期为prePrepare, prepare and commit
	Round    *big.Int // 轮询次数。如果给定的区块未被验证器接受，将发生新一轮更改，并且Round=Round+1
}