PoS Add Bitset to messaging schema

lib/network_test.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/btcsuite/btcd/wire"
 	"github.com/bxcodec/faker"
+	"github.com/deso-protocol/core/utils/bitset"
 	merkletree "github.com/deso-protocol/go-merkle-tree"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -121,6 +122,7 @@ func createTestBlockHeaderVersion2(t *testing.T) *MsgDeSoHeader {
 		0x64, 0x65,
 	}
 
+	testBitset := bitset.NewBitset().Set(0, true).Set(3, true)
 	_, testBLSSignature := _generateValidatorVotingPublicKeyAndSignature(t)
 
 	return &MsgDeSoHeader{
@@ -137,7 +139,7 @@ func createTestBlockHeaderVersion2(t *testing.T) *MsgDeSoHeader {
 			BlockHash:      &testBlockHash,
 			ProposedInView: uint64(123456789123),
 			ValidatorsVoteAggregatedSignature: &AggregatedBLSSignature{
-				SignersList: []byte{1},
+				SignersList: testBitset,
 				Signature:   testBLSSignature,
 			},
 		},
@@ -147,13 +149,13 @@ func createTestBlockHeaderVersion2(t *testing.T) *MsgDeSoHeader {
 				BlockHash:      &testBlockHash,
 				ProposedInView: uint64(345678912345),
 				ValidatorsVoteAggregatedSignature: &AggregatedBLSSignature{
-					SignersList: []byte{2},
+					SignersList: testBitset,
 					Signature:   testBLSSignature,
 				},
 			},
 			ValidatorsTimeoutHighQCViews: []uint64{456789123456},
 			ValidatorsTimeoutAggregatedSignature: &AggregatedBLSSignature{
-				SignersList: []byte{3},
+				SignersList: testBitset,
 				Signature:   testBLSSignature,
 			},
 		},

lib/pos_network.go

@@ -6,6 +6,7 @@ import (
 	"io"
 
 	"github.com/deso-protocol/core/bls"
+	"github.com/deso-protocol/core/utils/bitset"
 	"github.com/pkg/errors"
 )
 
@@ -350,9 +351,7 @@ func DecodeQuorumCertificate(rr io.Reader) (*QuorumCertificate, error) {
 // present in the aggregated signature. The indices of all validators are expected
 // to be known by the caller.
 type AggregatedBLSSignature struct {
-	// TODO: Switch this to a bitlist, which will result in ~8x reduction in total
-	// size of this construct.
-	SignersList []byte
+	SignersList *bitset.Bitset
 	Signature   *bls.Signature
 }
 
@@ -365,15 +364,21 @@ func (sig *AggregatedBLSSignature) Eq(other *AggregatedBLSSignature) bool {
 		return false
 	}
 
-	return bytes.Equal(sig.SignersList, other.SignersList) &&
-		sig.Signature.Eq(other.Signature)
+	if !sig.Signature.Eq(other.Signature) {
+		return false
+	}
+
+	return bytes.Equal(sig.SignersList.ToBytes(), other.SignersList.ToBytes())
 }
 
 func (sig *AggregatedBLSSignature) ToBytes() ([]byte, error) {
 	retBytes := []byte{}
 
 	// SignersList
-	retBytes = append(retBytes, EncodeByteArray(sig.SignersList)...)
+	if sig.SignersList == nil {
+		return nil, errors.New("AggregatedBLSSignature.ToBytes: SignersList must not be nil")
+	}
+	retBytes = append(retBytes, EncodeBitset(sig.SignersList)...)
 
 	// Signature
 	if sig.Signature == nil {
@@ -387,7 +392,7 @@ func (sig *AggregatedBLSSignature) ToBytes() ([]byte, error) {
 func (sig *AggregatedBLSSignature) FromBytes(rr io.Reader) error {
 	var err error
 
-	sig.SignersList, err = DecodeByteArray(rr)
+	sig.SignersList, err = DecodeBitset(rr)
 	if err != nil {
 		return errors.Wrapf(err, "AggregatedBLSSignature.FromBytes: Error decoding SignersList")
 	}
@@ -531,3 +536,23 @@ func (aggQC *TimeoutAggregateQuorumCertificate) FromBytes(rr io.Reader) error {
 
 	return nil
 }
+
+// ==================================================================
+// Bitset Utils
+// ==================================================================
+
+func EncodeBitset(b *bitset.Bitset) []byte {
+	var encodedBytes []byte
+	if b != nil {
+		encodedBytes = b.ToBytes()
+	}
+	return EncodeByteArray(encodedBytes)
+}
+
+func DecodeBitset(rr io.Reader) (*bitset.Bitset, error) {
+	encodedBytes, err := DecodeByteArray(rr)
+	if err != nil {
+		return nil, errors.Wrapf(err, "DecodeBitset: Error decoding bitset")
+	}
+	return (bitset.NewBitset()).FromBytes(encodedBytes), nil
+}

lib/pos_network_test.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/deso-protocol/core/bls"
+	"github.com/deso-protocol/core/utils/bitset"
 	"github.com/stretchr/testify/require"
 )
 
@@ -58,7 +59,7 @@ func TestValidatorTimeoutEncodeDecode(t *testing.T) {
 			BlockHash:      &BlockHash{},
 			ProposedInView: 999910,
 			ValidatorsVoteAggregatedSignature: &AggregatedBLSSignature{
-				SignersList: []byte{1, 2},
+				SignersList: bitset.NewBitset().Set(0, true).Set(3, true),
 				Signature:   aggregateSignature,
 			},
 		},
@@ -68,7 +69,7 @@ func TestValidatorTimeoutEncodeDecode(t *testing.T) {
 	// Encode the message and verify the length is correct.
 	encodedMsgBytes, err := originalMsg.ToBytes(false)
 	require.NoError(t, err)
-	require.Equal(t, 270, len(encodedMsgBytes))
+	require.Equal(t, 269, len(encodedMsgBytes))
 
 	// Decode the message.
 	decodedMsg := &MsgDeSoValidatorTimeout{}

utils/bitset/bitset.go

@@ -61,9 +61,10 @@ func (b *Bitset) ToBytes() []byte {
 }
 
 // Populates the BitSet from a big-endian byte slice.
-func (b *Bitset) FromBytes(bytes []byte) {
+func (b *Bitset) FromBytes(bytes []byte) *Bitset {
 	if b.store == nil {
 		b.store = big.NewInt(0)
 	}
 	b.store.SetBytes(bytes)
+	return b
 }