Skip to content

PoS Simplify PublicKey field names in P2P messages #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tholonious merged 1 commit into from
Jun 27, 2023
Merged

PoS Simplify PublicKey field names in P2P messages #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions lib/pos_network.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ type MsgDeSoValidatorVote struct {
// Given the validator's ECDSA public key, we can look up their Validator PKID
// and their stake in consensus. This allows us to verify that the vote message
// was sent by a registered validator.
ValidatorPublicKey *PublicKey
PublicKey *PublicKey
// The BLS voting public key for the validator who constructed this vote message.
// The BLS public key is included in the vote message because it allows us to
// easily verify if the BLS VotePartialSignature is correctly formed, without having
// to first look up the validator's BLS public key in consensus. It helps optimize
// vote validation.
ValidatorVotingPublicKey *bls.PublicKey
VotingPublicKey *bls.PublicKey

// The block hash corresponding to the block that this vote is for.
BlockHash *BlockHash
Expand Down Expand Up @@ -55,17 +55,17 @@ func (msg *MsgDeSoValidatorVote) ToBytes(bool) ([]byte, error) {
// MsgVersion
retBytes = append(retBytes, msg.MsgVersion)

// ValidatorPublicKey
if msg.ValidatorPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorVote.ToBytes: ValidatorPublicKey must not be nil")
// PublicKey
if msg.PublicKey == nil {
return nil, errors.New("MsgDeSoValidatorVote.ToBytes: PublicKey must not be nil")
}
retBytes = append(retBytes, msg.ValidatorPublicKey.ToBytes()...)
retBytes = append(retBytes, msg.PublicKey.ToBytes()...)

// ValidatorVotingPublicKey
if msg.ValidatorVotingPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorVote.ToBytes: ValidatorVotingPublicKey must not be nil")
// VotingPublicKey
if msg.VotingPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorVote.ToBytes: VotingPublicKey must not be nil")
}
retBytes = append(retBytes, EncodeBLSPublicKey(msg.ValidatorVotingPublicKey)...)
retBytes = append(retBytes, EncodeBLSPublicKey(msg.VotingPublicKey)...)

// BlockHash
if msg.BlockHash == nil {
Expand Down Expand Up @@ -98,16 +98,16 @@ func (msg *MsgDeSoValidatorVote) FromBytes(data []byte) error {
}
msg.MsgVersion = msgVersion

// ValidatorPublicKey
msg.ValidatorPublicKey, err = ReadPublicKey(rr)
// PublicKey
msg.PublicKey, err = ReadPublicKey(rr)
if err != nil {
return errors.Wrapf(err, "MsgDeSoValidatorVote.FromBytes: Error decoding ValidatorPublicKey")
return errors.Wrapf(err, "MsgDeSoValidatorVote.FromBytes: Error decoding PublicKey")
}

// ValidatorVotingPublicKey
msg.ValidatorVotingPublicKey, err = DecodeBLSPublicKey(rr)
// VotingPublicKey
msg.VotingPublicKey, err = DecodeBLSPublicKey(rr)
if err != nil {
return errors.Wrapf(err, "MsgDeSoValidatorVote.FromBytes: Error decoding ValidatorVotingPublicKey")
return errors.Wrapf(err, "MsgDeSoValidatorVote.FromBytes: Error decoding VotingPublicKey")
}

// BlockHash
Expand Down Expand Up @@ -141,13 +141,13 @@ type MsgDeSoValidatorTimeout struct {
// The ECDSA public key for the validator who constructed this timeout message.
// Given the validator's ECDSA public key, we can look up their Validator PKID.
// This allows us to verify that the timeout originated from a registered validator.
ValidatorPublicKey *PublicKey
PublicKey *PublicKey
// The BLS voting public key for the validator who constructed this timeout. The BLS
// public key is included in the timeout message because it allows us to easily
// verify that the BLS TimeoutPartialSignature is correctly formed, without having to
// first look up the validator's BLS public key in consensus. It helps optimize timeout
// message validation.
ValidatorVotingPublicKey *bls.PublicKey
VotingPublicKey *bls.PublicKey

// The view that the validator has timed out on.
TimedOutView uint64
Expand Down Expand Up @@ -178,17 +178,17 @@ func (msg *MsgDeSoValidatorTimeout) ToBytes(bool) ([]byte, error) {
// MsgVersion
retBytes = append(retBytes, msg.MsgVersion)

// ValidatorPublicKey
if msg.ValidatorPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorTimeout.ToBytes: ValidatorPublicKey must not be nil")
// PublicKey
if msg.PublicKey == nil {
return nil, errors.New("MsgDeSoValidatorTimeout.ToBytes: PublicKey must not be nil")
}
retBytes = append(retBytes, msg.ValidatorPublicKey.ToBytes()...)
retBytes = append(retBytes, msg.PublicKey.ToBytes()...)

// ValidatorVotingPublicKey
if msg.ValidatorVotingPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorTimeout.ToBytes: ValidatorVotingPublicKey must not be nil")
// VotingPublicKey
if msg.VotingPublicKey == nil {
return nil, errors.New("MsgDeSoValidatorTimeout.ToBytes: VotingPublicKey must not be nil")
}
retBytes = append(retBytes, EncodeBLSPublicKey(msg.ValidatorVotingPublicKey)...)
retBytes = append(retBytes, EncodeBLSPublicKey(msg.VotingPublicKey)...)

// TimeoutView
retBytes = append(retBytes, UintToBuf(msg.TimedOutView)...)
Expand Down Expand Up @@ -225,16 +225,16 @@ func (msg *MsgDeSoValidatorTimeout) FromBytes(data []byte) error {
}
msg.MsgVersion = msgVersion

// ValidatorPublicKey
msg.ValidatorPublicKey, err = ReadPublicKey(rr)
// PublicKey
msg.PublicKey, err = ReadPublicKey(rr)
if err != nil {
return errors.Wrapf(err, "MsgDeSoValidatorTimeout.FromBytes: Error decoding ValidatorPublicKey")
return errors.Wrapf(err, "MsgDeSoValidatorTimeout.FromBytes: Error decoding PublicKey")
}

// ValidatorVotingPublicKey
msg.ValidatorVotingPublicKey, err = DecodeBLSPublicKey(rr)
// VotingPublicKey
msg.VotingPublicKey, err = DecodeBLSPublicKey(rr)
if err != nil {
return errors.Wrapf(err, "MsgDeSoValidatorTimeout.FromBytes: Error decoding ValidatorVotingPublicKey")
return errors.Wrapf(err, "MsgDeSoValidatorTimeout.FromBytes: Error decoding VotingPublicKey")
}

// TimedOutView
Expand Down
28 changes: 14 additions & 14 deletions lib/pos_network_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ func TestValidatorVoteEncodeDecode(t *testing.T) {
validatorVotingPublicKey, votePartialSignature := _generateValidatorVotingPublicKeyAndSignature(t)

originalMsg := MsgDeSoValidatorVote{
MsgVersion: MsgValidatorVoteVersion0,
ValidatorPublicKey: &PublicKey{},
ValidatorVotingPublicKey: validatorVotingPublicKey,
BlockHash: &BlockHash{},
ProposedInView: 9910,
VotePartialSignature: votePartialSignature,
MsgVersion: MsgValidatorVoteVersion0,
PublicKey: &PublicKey{},
VotingPublicKey: validatorVotingPublicKey,
BlockHash: &BlockHash{},
ProposedInView: 9910,
VotePartialSignature: votePartialSignature,
}

// Encode the message and verify the length is correct.
Expand All @@ -34,8 +34,8 @@ func TestValidatorVoteEncodeDecode(t *testing.T) {

// Check that the message bodies are the same.
require.Equal(t, originalMsg.MsgVersion, decodedMsg.MsgVersion)
require.True(t, originalMsg.ValidatorPublicKey.Equal(*decodedMsg.ValidatorPublicKey))
require.True(t, originalMsg.ValidatorVotingPublicKey.Eq(decodedMsg.ValidatorVotingPublicKey))
require.True(t, originalMsg.PublicKey.Equal(*decodedMsg.PublicKey))
require.True(t, originalMsg.VotingPublicKey.Eq(decodedMsg.VotingPublicKey))
require.Equal(t, originalMsg.BlockHash, decodedMsg.BlockHash)
require.Equal(t, originalMsg.ProposedInView, decodedMsg.ProposedInView)
require.True(t, originalMsg.VotePartialSignature.Eq(decodedMsg.VotePartialSignature))
Expand All @@ -51,10 +51,10 @@ func TestValidatorTimeoutEncodeDecode(t *testing.T) {
require.NoError(t, err)

originalMsg := MsgDeSoValidatorTimeout{
MsgVersion: MsgValidatorTimeoutVersion0,
ValidatorPublicKey: &PublicKey{},
ValidatorVotingPublicKey: validatorVotingPublicKey,
TimedOutView: 999912,
MsgVersion: MsgValidatorTimeoutVersion0,
PublicKey: &PublicKey{},
VotingPublicKey: validatorVotingPublicKey,
TimedOutView: 999912,
HighQC: &QuorumCertificate{
BlockHash: &BlockHash{},
ProposedInView: 999910,
Expand All @@ -78,8 +78,8 @@ func TestValidatorTimeoutEncodeDecode(t *testing.T) {

// Check that the message bodies are the same.
require.Equal(t, originalMsg.MsgVersion, decodedMsg.MsgVersion)
require.True(t, originalMsg.ValidatorPublicKey.Equal(*decodedMsg.ValidatorPublicKey))
require.True(t, originalMsg.ValidatorVotingPublicKey.Eq(decodedMsg.ValidatorVotingPublicKey))
require.True(t, originalMsg.PublicKey.Equal(*decodedMsg.PublicKey))
require.True(t, originalMsg.VotingPublicKey.Eq(decodedMsg.VotingPublicKey))
require.Equal(t, originalMsg.TimedOutView, decodedMsg.TimedOutView)
require.True(t, originalMsg.TimeoutPartialSignature.Eq(decodedMsg.TimeoutPartialSignature))

Expand Down