mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-07 13:55:17 +00:00
0aa3b0b6fc
This pull request merges in the changes for implementing Proposer-based timestamps into `master`. The power was primarily being done in the `wb/proposer-based-timestamps` branch, with changes being merged into that branch during development. This pull request represents an amalgamation of the changes made into that development branch. All of the changes that were placed into that branch have been cleanly rebased on top of the latest `master`. The changes compile and the tests pass insofar as our tests in general pass. ### Note To Reviewers These changes have been extensively reviewed during development. There is not much new here. In the interest of making effective use of time, I would recommend against trying to perform a complete audit of the changes presented and instead examine for mistakes that may have occurred during the process of rebasing the changes. I gave the complete change set a first pass for any issues, but additional eyes would be very appreciated. In sum, this change set does the following: closes #6942 merges in #6849
74 lines
2.3 KiB
Go
74 lines
2.3 KiB
Go
package types
|
|
|
|
import (
|
|
"time"
|
|
|
|
tmtime "github.com/tendermint/tendermint/libs/time"
|
|
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
|
|
)
|
|
|
|
// Canonical* wraps the structs in types for amino encoding them for use in SignBytes / the Signable interface.
|
|
|
|
// TimeFormat is used for generating the sigs
|
|
const TimeFormat = time.RFC3339Nano
|
|
|
|
//-----------------------------------
|
|
// Canonicalize the structs
|
|
|
|
func CanonicalizeBlockID(bid tmproto.BlockID) *tmproto.CanonicalBlockID {
|
|
rbid, err := BlockIDFromProto(&bid)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
var cbid *tmproto.CanonicalBlockID
|
|
if rbid == nil || rbid.IsNil() {
|
|
cbid = nil
|
|
} else {
|
|
cbid = &tmproto.CanonicalBlockID{
|
|
Hash: bid.Hash,
|
|
PartSetHeader: CanonicalizePartSetHeader(bid.PartSetHeader),
|
|
}
|
|
}
|
|
|
|
return cbid
|
|
}
|
|
|
|
// CanonicalizeVote transforms the given PartSetHeader to a CanonicalPartSetHeader.
|
|
func CanonicalizePartSetHeader(psh tmproto.PartSetHeader) tmproto.CanonicalPartSetHeader {
|
|
return tmproto.CanonicalPartSetHeader(psh)
|
|
}
|
|
|
|
// CanonicalizeVote transforms the given Proposal to a CanonicalProposal.
|
|
func CanonicalizeProposal(chainID string, proposal *tmproto.Proposal) tmproto.CanonicalProposal {
|
|
return tmproto.CanonicalProposal{
|
|
Type: tmproto.ProposalType,
|
|
Height: proposal.Height, // encoded as sfixed64
|
|
Round: int64(proposal.Round), // encoded as sfixed64
|
|
POLRound: int64(proposal.PolRound),
|
|
BlockID: CanonicalizeBlockID(proposal.BlockID),
|
|
Timestamp: proposal.Timestamp,
|
|
ChainID: chainID,
|
|
}
|
|
}
|
|
|
|
// CanonicalizeVote transforms the given Vote to a CanonicalVote, which does
|
|
// not contain ValidatorIndex and ValidatorAddress fields.
|
|
func CanonicalizeVote(chainID string, vote *tmproto.Vote) tmproto.CanonicalVote {
|
|
return tmproto.CanonicalVote{
|
|
Type: vote.Type,
|
|
Height: vote.Height, // encoded as sfixed64
|
|
Round: int64(vote.Round), // encoded as sfixed64
|
|
BlockID: CanonicalizeBlockID(vote.BlockID),
|
|
Timestamp: vote.Timestamp,
|
|
ChainID: chainID,
|
|
}
|
|
}
|
|
|
|
// CanonicalTime can be used to stringify time in a canonical way.
|
|
func CanonicalTime(t time.Time) string {
|
|
// Note that sending time over amino resets it to
|
|
// local time, we need to force UTC here, so the
|
|
// signatures match
|
|
return tmtime.Canonical(t).Format(TimeFormat)
|
|
}
|