56 lines
1.8 KiB
Go
56 lines
1.8 KiB
Go
package types
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/tendermint/go-crypto"
|
|
"github.com/tendermint/go-wire"
|
|
)
|
|
|
|
var (
|
|
ErrInvalidBlockPartSignature = errors.New("Error invalid block part signature")
|
|
ErrInvalidBlockPartHash = errors.New("Error invalid block part hash")
|
|
)
|
|
|
|
// Proposal defines a block proposal for the consensus.
|
|
// It refers to the block only by its PartSetHeader.
|
|
// It must be signed by the correct proposer for the given Height/Round
|
|
// to be considered valid. It may depend on votes from a previous round,
|
|
// a so-called Proof-of-Lock (POL) round, as noted in the POLRound and POLBlockID.
|
|
type Proposal struct {
|
|
Height int `json:"height"`
|
|
Round int `json:"round"`
|
|
BlockPartsHeader PartSetHeader `json:"block_parts_header"`
|
|
POLRound int `json:"pol_round"` // -1 if null.
|
|
POLBlockID BlockID `json:"pol_block_id"` // zero if null.
|
|
Signature crypto.Signature `json:"signature"`
|
|
}
|
|
|
|
// NewProposal returns a new Proposal.
|
|
// If there is no POLRound, polRound should be -1.
|
|
func NewProposal(height int, round int, blockPartsHeader PartSetHeader, polRound int, polBlockID BlockID) *Proposal {
|
|
return &Proposal{
|
|
Height: height,
|
|
Round: round,
|
|
BlockPartsHeader: blockPartsHeader,
|
|
POLRound: polRound,
|
|
POLBlockID: polBlockID,
|
|
}
|
|
}
|
|
|
|
// String returns a string representation of the Proposal.
|
|
func (p *Proposal) String() string {
|
|
return fmt.Sprintf("Proposal{%v/%v %v (%v,%v) %v}", p.Height, p.Round,
|
|
p.BlockPartsHeader, p.POLRound, p.POLBlockID, p.Signature)
|
|
}
|
|
|
|
// WriteSignBytes writes the Proposal bytes for signing
|
|
func (p *Proposal) WriteSignBytes(chainID string, w io.Writer, n *int, err *error) {
|
|
wire.WriteJSON(CanonicalJSONOnceProposal{
|
|
ChainID: chainID,
|
|
Proposal: CanonicalProposal(p),
|
|
}, w, n, err)
|
|
}
|