github.com/annchain/OG@v0.0.9/consensus/bft/message.go

// Copyright © 2019 Annchain Authors <EMAIL ADDRESS>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bft

import (
	"crypto/sha256"
	"fmt"
	"github.com/annchain/OG/arefactor/og/types"
	"github.com/annchain/OG/common/byteutil"
	"github.com/annchain/OG/common/hexutil"
	"github.com/tinylib/msgp/msgp"
)

//go:generate msgp

type Signable interface {
	SignatureTargets() []byte
}

// OgMessage is the message that can be convert to BinaryMessage
type BftMessage interface {
	Signable
	GetType() BftMessageType
	ProvideHeight() uint64
	String() string
}

// HeightRound is the current progress of the consensus.
// Height is the block height, round is the sub-progress if no consensus can be easily reached
//msgp:tuple HeightRound
type HeightRound struct {
	Height uint64
	Round  int
}

func (h *HeightRound) String() string {
	return fmt.Sprintf("[%d-%d]", h.Height, h.Round)
}

// IsAfter judges whether self is a higher HeightRound
func (h *HeightRound) IsAfter(o HeightRound) bool {
	return h.Height > o.Height ||
		(h.Height == o.Height && h.Round > o.Round)
}

// IsAfterOrEqual judges whether self is a higher or equal HeightRound
func (h *HeightRound) IsAfterOrEqual(o HeightRound) bool {
	return h.Height > o.Height ||
		(h.Height == o.Height && h.Round >= o.Round)
}

// IsAfterOrEqual judges whether self is a lower HeightRound
func (h *HeightRound) IsBefore(o HeightRound) bool {
	return h.Height < o.Height ||
		(h.Height == o.Height && h.Round < o.Round)
}

type BftMessageType uint16

func (m BftMessageType) String() string {
	switch m {
	case BftMessageTypeProposal:
		return "BFTProposal"
	case BftMessageTypePreVote:
		return "BFTPreVote"
	case BftMessageTypePreCommit:
		return "BFTPreCommit"
	default:
		return "BFTUnknown"
	}
}

const (
	BftMessageTypeProposal BftMessageType = iota + 100
	BftMessageTypePreVote
	BftMessageTypePreCommit
)

//msgp:tuple BftBasicInfo
type BftBasicInfo struct {
	SourceId       uint16
	HeightRound    HeightRound
	PublicKeyBytes hexutil.Bytes
}

func (b *BftBasicInfo) ProvideHeight() uint64 {
	return b.HeightRound.Height
}

//msgp:tuple BftMessageProposal
type BftMessageProposal struct {
	BftBasicInfo
	Value      Proposal //TODO
	ValidRound int
}

func (m *BftMessageProposal) GetType() BftMessageType {
	return BftMessageTypeProposal
}

func (m *BftMessageProposal) PublicKey() []byte {
	return m.PublicKeyBytes
}

//msgp:tuple BftMessagePreVote
type BftMessagePreVote struct {
	BftBasicInfo
	Idv *types.Hash // ID of the proposal, usually be the hash of the proposal
}

func (z *BftMessagePreVote) GetType() BftMessageType {
	return BftMessageTypePreVote
}

func (z *BftMessagePreVote) PublicKey() []byte {
	return z.PublicKeyBytes
}

//msgp:tuple BftMessagePreCommit
type BftMessagePreCommit struct {
	BftBasicInfo
	Idv          *types.Hash // ID of the proposal, usually be the hash of the proposal
	BlsSignature hexutil.Bytes
}

func (z *BftMessagePreCommit) PublicKey() []byte {
	return z.PublicKeyBytes
}

func (z *BftMessagePreCommit) GetType() BftMessageType {
	return BftMessageTypePreCommit
}

func (m BftBasicInfo) String() string {
	return fmt.Sprintf("SourceId:%d, hr:%d", m.SourceId, m.HeightRound)
}

func (m BftMessageProposal) String() string {
	return fmt.Sprintf("bm %s, value %s", m.BftBasicInfo, m.Value)
}

func (m BftMessagePreVote) String() string {
	return fmt.Sprintf("bm %s, idv %s", m.BftBasicInfo, m.Idv)
}

func (m BftMessagePreCommit) String() string {
	return fmt.Sprintf("bm %s, idv %s", m.BftBasicInfo, m.Idv)
}

func (m *BftMessagePreVote) SignatureTargets() []byte {
	w := byteutil.NewBinaryWriter()
	if m.Idv != nil {
		w.Write(m.Idv.Bytes)
	}
	w.Write(m.HeightRound.Height, uint64(m.HeightRound.Round), m.SourceId)
	return w.Bytes()
}

func (m *BftMessagePreCommit) SignatureTargets() []byte {
	w := byteutil.NewBinaryWriter()
	w.Write(m.BlsSignature)
	return w.Bytes()
}

func (m *BftMessagePreCommit) BlsSignatureTargets() []byte {
	w := byteutil.NewBinaryWriter()
	if m.Idv != nil {
		w.Write(m.Idv.Bytes)
	}
	w.Write(m.HeightRound.Height, uint64(m.HeightRound.Round), m.SourceId)
	return w.Bytes()
}

func (m *BftMessageProposal) SignatureTargets() []byte {
	w := byteutil.NewBinaryWriter()
	if idv := m.Value.GetId(); idv != nil {
		w.Write(idv.Bytes)
	}
	//w.Write(m.HeightRound.Height, uint64(m.HeightRound.Round), m.SourceId, uint64(m.ValidRound))
	w.Write(m.HeightRound.Height, uint64(m.HeightRound.Round), m.SourceId)
	return w.Bytes()
}

type MsgpEnabled interface {
	msgp.MarshalSizer
	msgp.Unmarshaler
	msgp.Decodable
	msgp.Encodable
}
type Proposal interface {
	MsgpEnabled
	Equal(Proposal) bool
	GetId() *types.Hash
	String() string
	Copy() Proposal
}

//StringProposal is for test
//msgp:tuple StringProposal
type StringProposal struct {
	Content string
}

func (s StringProposal) Equal(o Proposal) bool {
	v, ok := o.(*StringProposal)
	if !ok || v == nil {
		return false
	}
	return s.Content == v.Content
}

func (s StringProposal) Copy() Proposal {
	var r StringProposal
	r.Content = s.Content
	return &r
}

func (s StringProposal) GetId() *types.Hash {
	h := sha256.New()
	h.Write([]byte(s.Content))
	sum := h.Sum(nil)
	hash := types.Hash{}
	hash.MustSetBytes(sum, types.PaddingNone)
	return &hash
}

func (s StringProposal) String() string {
	return s.Content
}

type ConsensusDecision Proposal