core/types/vote: introduce RawVoteEnvelop (axieinfinity#308)

RawVoteEnvelop is the same as VoteEnvelop without cached hash

core/types/vote.go

@@ -1,9 +1,10 @@
 package types
 
 import (
-	"github.com/ethereum/go-ethereum/params"
 	"sync/atomic"
 
+	"github.com/ethereum/go-ethereum/params"
+
 	"github.com/ethereum/go-ethereum/crypto/bls"
 	"github.com/pkg/errors"
 
@@ -23,16 +24,25 @@ type VoteData struct {
 // Hash returns the hash of the vote data.
 func (d *VoteData) Hash() common.Hash { return rlpHash(d) }
 
-// VoteEnvelope represents the vote of a single validator.
-type VoteEnvelope struct {
+// RawVoteEnvelope is VoteEnvelop without cached hash
+type RawVoteEnvelope struct {
 	PublicKey BLSPublicKey // The BLS public key of the validator.
 	Signature BLSSignature // Validator's signature for the vote data.
 	Data      *VoteData    // The vote data for fast finality.
+}
+
+// VoteEnvelope represents the vote of a single validator.
+type VoteEnvelope struct {
+	RawVoteEnvelope
 
 	// caches
 	hash atomic.Value
 }
 
+func (v *VoteEnvelope) Raw() *RawVoteEnvelope {
+	return &v.RawVoteEnvelope
+}
+
 // Hash returns the vote's hash.
 func (v *VoteEnvelope) Hash() common.Hash {
 	if hash := v.hash.Load(); hash != nil {

core/vote/vote_manager.go

@@ -144,7 +144,9 @@ func (voteManager *VoteManager) loop() {
 				TargetHash:   curHead.Hash(),
 			}
 			voteMessage := &types.VoteEnvelope{
-				Data: vote,
+				RawVoteEnvelope: types.RawVoteEnvelope{
+					Data: vote,
+				},
 			}
 
 			// Put Vote into journal and VotesPool if we are active validator and allow to sign it.

core/vote/vote_pool_test.go

@@ -203,8 +203,10 @@ func testVotePool(t *testing.T, isValidRules bool) {
 
 	// Test invalid vote whose number larger than latestHeader + 13
 	invalidVote := &types.VoteEnvelope{
-		Data: &types.VoteData{
-			TargetNumber: 1000,
+		RawVoteEnvelope: types.RawVoteEnvelope{
+			Data: &types.VoteData{
+				TargetNumber: 1000,
+			},
 		},
 	}
 	voteManager.pool.PutVote(invalidVote)
@@ -220,8 +222,10 @@ func testVotePool(t *testing.T, isValidRules bool) {
 
 	// Test future votes scenario: votes number within latestBlockHeader ~ latestBlockHeader + 13
 	futureVote := &types.VoteEnvelope{
-		Data: &types.VoteData{
-			TargetNumber: 279,
+		RawVoteEnvelope: types.RawVoteEnvelope{
+			Data: &types.VoteData{
+				TargetNumber: 279,
+			},
 		},
 	}
 	if err := voteManager.signer.SignVote(futureVote); err != nil {
@@ -235,8 +239,10 @@ func testVotePool(t *testing.T, isValidRules bool) {
 
 	// Test duplicate vote case, shouldn'd be put into vote pool
 	duplicateVote := &types.VoteEnvelope{
-		Data: &types.VoteData{
-			TargetNumber: 279,
+		RawVoteEnvelope: types.RawVoteEnvelope{
+			Data: &types.VoteData{
+				TargetNumber: 279,
+			},
 		},
 	}
 	if err := voteManager.signer.SignVote(duplicateVote); err != nil {
@@ -250,9 +256,11 @@ func testVotePool(t *testing.T, isValidRules bool) {
 
 	// Test future votes larger than latestBlockNumber + 13 should be rejected
 	futureVote = &types.VoteEnvelope{
-		Data: &types.VoteData{
-			TargetNumber: 282,
-			TargetHash:   common.Hash{},
+		RawVoteEnvelope: types.RawVoteEnvelope{
+			Data: &types.VoteData{
+				TargetNumber: 282,
+				TargetHash:   common.Hash{},
+			},
 		},
 	}
 	voteManager.pool.PutVote(futureVote)