Change Custody Count to Uint8 (#14386)

* Add Changes for Uint8 Csc * Fix Build * Fix Build for Sync * Fix Discovery Test
prysmaticlabs · Aug 28, 2024 · bd7ec3f · bd7ec3f
1 parent ef86a0e
commit bd7ec3f
Show file tree

Hide file tree

Showing 15 changed files with 90 additions and 67 deletions.
diff --git a/beacon-chain/core/peerdas/helpers.go b/beacon-chain/core/peerdas/helpers.go
@@ -33,7 +33,7 @@ const (
 )
 
 // https://github.com/ethereum/consensus-specs/blob/dev/specs/_features/eip7594/p2p-interface.md#the-discovery-domain-discv5
-type Csc uint64
+type Csc uint8
 
 func (Csc) ENRKey() string { return CustodySubnetCountEnrKey }
 

diff --git a/beacon-chain/p2p/custody.go b/beacon-chain/p2p/custody.go
@@ -86,7 +86,7 @@ func (s *Service) CustodyCountFromRemotePeer(pid peer.ID) uint64 {
 	if metadata != nil {
 		custodyCount := metadata.CustodySubnetCount()
 		if custodyCount > 0 {
-			return custodyCount
+			return uint64(custodyCount)
 		}
 	}
 

diff --git a/beacon-chain/p2p/custody_test.go b/beacon-chain/p2p/custody_test.go
@@ -121,12 +121,12 @@ func TestCustodyCountFromRemotePeer(t *testing.T) {
 
 	// Define a metadata with zero custody.
 	zeroMetadata := wrapper.WrappedMetadataV2(&pb.MetaDataV2{
-		CustodySubnetCount: 0,
+		CustodySubnetCount: []byte{0},
 	})
 
 	// Define a nominal metadata.
 	nominalMetadata := wrapper.WrappedMetadataV2(&pb.MetaDataV2{
-		CustodySubnetCount: expectedMetadata,
+		CustodySubnetCount: []byte{uint8(expectedMetadata)},
 	})
 
 	testCases := []struct {

diff --git a/beacon-chain/p2p/discovery.go b/beacon-chain/p2p/discovery.go
@@ -175,7 +175,7 @@ func (s *Service) RefreshPersistentSubnets() {
 	// Get the custody subnet count in our metadata.
 	inMetadataCustodySubnetCount := s.Metadata().CustodySubnetCount()
 
-	isCustodySubnetCountUpToDate := (custodySubnetCount == inRecordCustodySubnetCount && custodySubnetCount == inMetadataCustodySubnetCount)
+	isCustodySubnetCountUpToDate := custodySubnetCount == inRecordCustodySubnetCount && custodySubnetCount == uint64(inMetadataCustodySubnetCount)
 
 	if isBitVUpToDate && isBitSUpToDate && isCustodySubnetCountUpToDate {
 		// Nothing to do, return early.

diff --git a/beacon-chain/p2p/discovery_test.go b/beacon-chain/p2p/discovery_test.go
@@ -473,7 +473,7 @@ type check struct {
 	metadataSequenceNumber uint64
 	attestationSubnets     []uint64
 	syncSubnets            []uint64
-	custodySubnetCount     *uint64
+	custodySubnetCount     *uint8
 }
 
 func checkPingCountCacheMetadataRecord(
@@ -542,7 +542,7 @@ func checkPingCountCacheMetadataRecord(
 
 	if expected.custodySubnetCount != nil {
 		// Check custody subnet count in ENR.
-		var actualCustodySubnetCount uint64
+		var actualCustodySubnetCount uint8
 		err := service.dv5Listener.LocalNode().Node().Record().Load(enr.WithEntry(peerdas.CustodySubnetCountEnrKey, &actualCustodySubnetCount))
 		require.NoError(t, err)
 		require.Equal(t, *expected.custodySubnetCount, actualCustodySubnetCount)
@@ -565,7 +565,7 @@ func TestRefreshPersistentSubnets(t *testing.T) {
 		eip7594ForkEpoch = 10
 	)
 
-	custodySubnetCount := params.BeaconConfig().CustodyRequirement
+	custodySubnetCount := uint8(params.BeaconConfig().CustodyRequirement)
 
 	// Set up epochs.
 	defaultCfg := params.BeaconConfig()

diff --git a/beacon-chain/p2p/subnets.go b/beacon-chain/p2p/subnets.go
@@ -239,12 +239,13 @@ func (s *Service) updateSubnetRecordWithMetadataV3(
 	localNode.Set(custodySubnetCountEntry)
 
 	newSeqNumber := s.metaData.SequenceNumber() + 1
+	cscBytes := []byte{uint8(custodySubnetCount)}
 
 	s.metaData = wrapper.WrappedMetadataV2(&pb.MetaDataV2{
 		SeqNumber:          newSeqNumber,
 		Attnets:            bitVAtt,
 		Syncnets:           bitVSync,
-		CustodySubnetCount: custodySubnetCount,
+		CustodySubnetCount: cscBytes,
 	})
 }
 

diff --git a/beacon-chain/sync/rpc_metadata.go b/beacon-chain/sync/rpc_metadata.go
@@ -104,15 +104,15 @@ func (s *Service) metaDataHandler(_ context.Context, _ interface{}, stream libp2
 					Attnets:            metadata.AttnetsBitfield(),
 					SeqNumber:          metadata.SequenceNumber(),
 					Syncnets:           bitfield.Bitvector4{byte(0x00)},
-					CustodySubnetCount: 0,
+					CustodySubnetCount: []byte{0},
 				})
 		case version.Altair:
 			metadata = wrapper.WrappedMetadataV2(
 				&pb.MetaDataV2{
 					Attnets:            metadata.AttnetsBitfield(),
 					SeqNumber:          metadata.SequenceNumber(),
 					Syncnets:           metadata.SyncnetsBitfield(),
-					CustodySubnetCount: 0,
+					CustodySubnetCount: []byte{0},
 				})
 		}
 	}

diff --git a/beacon-chain/sync/rpc_metadata_test.go b/beacon-chain/sync/rpc_metadata_test.go
@@ -153,7 +153,7 @@ func TestMetadataRPCHandler_SendMetadataRequest(t *testing.T) {
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           syncnets,
-				CustodySubnetCount: custodySubnetCount,
+				CustodySubnetCount: []byte{custodySubnetCount},
 			}),
 			expected: wrapper.WrappedMetadataV0(&pb.MetaDataV0{
 				SeqNumber: seqNumber,
@@ -200,7 +200,7 @@ func TestMetadataRPCHandler_SendMetadataRequest(t *testing.T) {
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           syncnets,
-				CustodySubnetCount: custodySubnetCount,
+				CustodySubnetCount: []byte{custodySubnetCount},
 			}),
 			expected: wrapper.WrappedMetadataV1(&pb.MetaDataV1{
 				SeqNumber: seqNumber,
@@ -221,7 +221,7 @@ func TestMetadataRPCHandler_SendMetadataRequest(t *testing.T) {
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           bitfield.Bitvector4{byte(0x00)},
-				CustodySubnetCount: 0,
+				CustodySubnetCount: []byte{0},
 			}),
 		},
 		{
@@ -238,7 +238,7 @@ func TestMetadataRPCHandler_SendMetadataRequest(t *testing.T) {
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           syncnets,
-				CustodySubnetCount: 0,
+				CustodySubnetCount: []byte{0},
 			}),
 		},
 		{
@@ -250,13 +250,13 @@ func TestMetadataRPCHandler_SendMetadataRequest(t *testing.T) {
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           syncnets,
-				CustodySubnetCount: custodySubnetCount,
+				CustodySubnetCount: []byte{custodySubnetCount},
 			}),
 			expected: wrapper.WrappedMetadataV2(&pb.MetaDataV2{
 				SeqNumber:          seqNumber,
 				Attnets:            attnets,
 				Syncnets:           syncnets,
-				CustodySubnetCount: custodySubnetCount,
+				CustodySubnetCount: []byte{custodySubnetCount},
 			}),
 		},
 	}

diff --git a/consensus-types/wrapper/BUILD.bazel b/consensus-types/wrapper/BUILD.bazel
@@ -6,6 +6,7 @@ go_library(
     importpath = "github.com/prysmaticlabs/prysm/v5/consensus-types/wrapper",
     visibility = ["//visibility:public"],
     deps = [
+        "//encoding/bytesutil:go_default_library",
         "//proto/prysm/v1alpha1:go_default_library",
         "//proto/prysm/v1alpha1/metadata:go_default_library",
         "//runtime/version:go_default_library",

diff --git a/consensus-types/wrapper/metadata.go b/consensus-types/wrapper/metadata.go
@@ -2,6 +2,7 @@ package wrapper
 
 import (
 	"github.com/prysmaticlabs/go-bitfield"
+	"github.com/prysmaticlabs/prysm/v5/encoding/bytesutil"
 	pb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
 	"github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1/metadata"
 	"github.com/prysmaticlabs/prysm/v5/runtime/version"
@@ -37,7 +38,7 @@ func (m MetadataV0) SyncnetsBitfield() bitfield.Bitvector4 {
 }
 
 // CustodySubnetCount returns custody subnet count from the metadata.
-func (m MetadataV0) CustodySubnetCount() uint64 {
+func (m MetadataV0) CustodySubnetCount() uint8 {
 	return 0
 }
 
@@ -131,7 +132,7 @@ func (m MetadataV1) SyncnetsBitfield() bitfield.Bitvector4 {
 }
 
 // CustodySubnetCount returns custody subnet count from the metadata.
-func (m MetadataV1) CustodySubnetCount() uint64 {
+func (m MetadataV1) CustodySubnetCount() uint8 {
 	return 0
 }
 
@@ -225,8 +226,8 @@ func (m MetadataV2) SyncnetsBitfield() bitfield.Bitvector4 {
 }
 
 // CustodySubnetCount returns custody subnet count from the metadata.
-func (m MetadataV2) CustodySubnetCount() uint64 {
-	return m.md.CustodySubnetCount
+func (m MetadataV2) CustodySubnetCount() uint8 {
+	return bytesutil.FromBytes1(m.md.CustodySubnetCount)
 }
 
 // InnerObject returns the underlying metadata protobuf structure.

diff --git a/encoding/bytesutil/integers.go b/encoding/bytesutil/integers.go
@@ -66,6 +66,14 @@ func Bytes32(x uint64) []byte {
 	return bytes
 }
 
+// FromBytes1 returns an integer from a byte slice with a size of 1.
+func FromBytes1(x []byte) uint8 {
+	if len(x) < 1 {
+		return 0
+	}
+	return x[0]
+}
+
 // FromBytes2 returns an integer which is stored in the little-endian format(2, 'little')
 // from a byte array.
 func FromBytes2(x []byte) uint16 {

diff --git a/proto/prysm/v1alpha1/metadata/metadata_interfaces.go b/proto/prysm/v1alpha1/metadata/metadata_interfaces.go
@@ -11,7 +11,7 @@ type Metadata interface {
 	SequenceNumber() uint64
 	AttnetsBitfield() bitfield.Bitvector64
 	SyncnetsBitfield() bitfield.Bitvector4
-	CustodySubnetCount() uint64
+	CustodySubnetCount() uint8
 	InnerObject() interface{}
 	IsNil() bool
 	Copy() Metadata

diff --git a/proto/prysm/v1alpha1/non-core.ssz.go b/proto/prysm/v1alpha1/non-core.ssz.go
diff --git a/proto/prysm/v1alpha1/p2p_messages.pb.go b/proto/prysm/v1alpha1/p2p_messages.pb.go