Make block_to_lightclient_header_XXX functions private (#14502)

* make block to lightclient header functions private * changelog * fix `helpers.go` --------- Co-authored-by: Rupam Dey <117000803+rupam-04@users.noreply.github.com> Co-authored-by: rupam-04 <rpmdey2004@gmail.com>
2026-01-09 13:28:01 -05:00 · 2024-10-03 23:59:07 +02:00
parent 21ca4e008f
commit 3824e8a463
4 changed files with 34 additions and 29 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,7 +13,7 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
 - Light client support: Implement `ComputeFieldRootsForBlockBody`.
 - Light client support: Add light client database changes.
 - Light client support: Implement capella and deneb changes.
- Light client support: Implement `BlockToLightClientHeaderXXX` functions upto Deneb
+- Light client support: Implement `BlockToLightClientHeader` function.
 - GetBeaconStateV2: add Electra case.
 - Implement [consensus-specs/3875](https://github.com/ethereum/consensus-specs/pull/3875)
 - Tests to ensure sepolia config matches the official upstream yaml
--- a/beacon-chain/core/light-client/lightclient.go
+++ b/beacon-chain/core/light-client/lightclient.go
@@ -302,7 +302,7 @@ func ComputeWithdrawalsRoot(payload interfaces.ExecutionData) ([]byte, error) {
 func BlockToLightClientHeader(block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeaderContainer, error) {
 	switch block.Version() {
 	case version.Altair, version.Bellatrix:
-		altairHeader, err := BlockToLightClientHeaderAltair(block)
+		altairHeader, err := blockToLightClientHeaderAltair(block)
 		if err != nil {
 			return nil, errors.Wrap(err, "could not get header")
 		}
@@ -312,7 +312,7 @@ func BlockToLightClientHeader(block interfaces.ReadOnlySignedBeaconBlock) (*ethp
 			},
 		}, nil
 	case version.Capella:
-		capellaHeader, err := BlockToLightClientHeaderCapella(context.Background(), block)
+		capellaHeader, err := blockToLightClientHeaderCapella(context.Background(), block)
 		if err != nil {
 			return nil, errors.Wrap(err, "could not get capella header")
 		}
@@ -322,7 +322,7 @@ func BlockToLightClientHeader(block interfaces.ReadOnlySignedBeaconBlock) (*ethp
 			},
 		}, nil
 	case version.Deneb:
-		denebHeader, err := BlockToLightClientHeaderDeneb(context.Background(), block)
+		denebHeader, err := blockToLightClientHeaderDeneb(context.Background(), block)
 		if err != nil {
 			return nil, errors.Wrap(err, "could not get deneb header")
 		}
@@ -336,9 +336,7 @@ func BlockToLightClientHeader(block interfaces.ReadOnlySignedBeaconBlock) (*ethp
 	}
 }

-// TODO: make below functions private
-
-func BlockToLightClientHeaderAltair(block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeader, error) {
+func blockToLightClientHeaderAltair(block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeader, error) {
 	if block.Version() != version.Altair {
 		return nil, fmt.Errorf("block version is %s instead of Altair", version.String(block.Version()))
 	}
@@ -361,7 +359,7 @@ func BlockToLightClientHeaderAltair(block interfaces.ReadOnlySignedBeaconBlock)
 	}, nil
 }

-func BlockToLightClientHeaderCapella(ctx context.Context, block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeaderCapella, error) {
+func blockToLightClientHeaderCapella(ctx context.Context, block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeaderCapella, error) {
 	if block.Version() != version.Capella {
 		return nil, fmt.Errorf("block version is %s instead of Capella", version.String(block.Version()))
 	}
@@ -423,7 +421,7 @@ func BlockToLightClientHeaderCapella(ctx context.Context, block interfaces.ReadO
 	}, nil
 }

-func BlockToLightClientHeaderDeneb(ctx context.Context, block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeaderDeneb, error) {
+func blockToLightClientHeaderDeneb(ctx context.Context, block interfaces.ReadOnlySignedBeaconBlock) (*ethpbv2.LightClientHeaderDeneb, error) {
 	if block.Version() != version.Deneb {
 		return nil, fmt.Errorf("block version is %s instead of Deneb", version.String(block.Version()))
 	}
--- a/beacon-chain/core/light-client/lightclient_test.go
+++ b/beacon-chain/core/light-client/lightclient_test.go
@@ -5,13 +5,12 @@ import (

 	"github.com/pkg/errors"
 	fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
-	consensus_types "github.com/prysmaticlabs/prysm/v5/consensus-types"
+	consensustypes "github.com/prysmaticlabs/prysm/v5/consensus-types"
 	"github.com/prysmaticlabs/prysm/v5/consensus-types/blocks"
 	"github.com/prysmaticlabs/prysm/v5/encoding/ssz"
 	v11 "github.com/prysmaticlabs/prysm/v5/proto/engine/v1"

 	lightClient "github.com/prysmaticlabs/prysm/v5/beacon-chain/core/light-client"
-	light_client "github.com/prysmaticlabs/prysm/v5/beacon-chain/core/light-client"
 	"github.com/prysmaticlabs/prysm/v5/testing/require"
 	"github.com/prysmaticlabs/prysm/v5/testing/util"
 )
@@ -126,7 +125,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 			payloadInterface, err := l.FinalizedBlock.Block().Body().Execution()
 			require.NoError(t, err)
 			transactionsRoot, err := payloadInterface.TransactionsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				transactions, err := payloadInterface.Transactions()
 				require.NoError(t, err)
 				transactionsRootArray, err := ssz.TransactionsRoot(transactions)
@@ -136,7 +135,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 				require.NoError(t, err)
 			}
 			withdrawalsRoot, err := payloadInterface.WithdrawalsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				withdrawals, err := payloadInterface.Withdrawals()
 				require.NoError(t, err)
 				withdrawalsRootArray, err := ssz.WithdrawalSliceRoot(withdrawals, fieldparams.MaxWithdrawalsPerPayload)
@@ -231,7 +230,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 			payloadInterface, err := l.FinalizedBlock.Block().Body().Execution()
 			require.NoError(t, err)
 			transactionsRoot, err := payloadInterface.TransactionsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				transactions, err := payloadInterface.Transactions()
 				require.NoError(t, err)
 				transactionsRootArray, err := ssz.TransactionsRoot(transactions)
@@ -241,7 +240,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 				require.NoError(t, err)
 			}
 			withdrawalsRoot, err := payloadInterface.WithdrawalsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				withdrawals, err := payloadInterface.Withdrawals()
 				require.NoError(t, err)
 				withdrawalsRootArray, err := ssz.WithdrawalSliceRoot(withdrawals, fieldparams.MaxWithdrawalsPerPayload)
@@ -303,7 +302,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 			payloadInterface, err := l.FinalizedBlock.Block().Body().Execution()
 			require.NoError(t, err)
 			transactionsRoot, err := payloadInterface.TransactionsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				transactions, err := payloadInterface.Transactions()
 				require.NoError(t, err)
 				transactionsRootArray, err := ssz.TransactionsRoot(transactions)
@@ -313,7 +312,7 @@ func TestLightClient_NewLightClientFinalityUpdateFromBeaconState(t *testing.T) {
 				require.NoError(t, err)
 			}
 			withdrawalsRoot, err := payloadInterface.WithdrawalsRoot()
-			if errors.Is(err, consensus_types.ErrUnsupportedField) {
+			if errors.Is(err, consensustypes.ErrUnsupportedField) {
 				withdrawals, err := payloadInterface.Withdrawals()
 				require.NoError(t, err)
 				withdrawalsRootArray, err := ssz.WithdrawalSliceRoot(withdrawals, fieldparams.MaxWithdrawalsPerPayload)
@@ -348,8 +347,9 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 	t.Run("Altair", func(t *testing.T) {
 		l := util.NewTestLightClient(t).SetupTestAltair()

-		header, err := lightClient.BlockToLightClientHeaderAltair(l.Block)
+		container, err := lightClient.BlockToLightClientHeader(l.Block)
 		require.NoError(t, err)
+		header := container.GetHeaderAltair()
 		require.NotNil(t, header, "header is nil")

 		parentRoot := l.Block.Block().ParentRoot()
@@ -368,8 +368,9 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 		t.Run("Non-Blinded Beacon Block", func(t *testing.T) {
 			l := util.NewTestLightClient(t).SetupTestCapella(false)

-			header, err := lightClient.BlockToLightClientHeaderCapella(l.Ctx, l.Block)
+			container, err := lightClient.BlockToLightClientHeader(l.Block)
 			require.NoError(t, err)
+			header := container.GetHeaderCapella()
 			require.NotNil(t, header, "header is nil")

 			parentRoot := l.Block.Block().ParentRoot()
@@ -380,10 +381,10 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 			payload, err := l.Block.Block().Body().Execution()
 			require.NoError(t, err)

-			transactionsRoot, err := light_client.ComputeTransactionsRoot(payload)
+			transactionsRoot, err := lightClient.ComputeTransactionsRoot(payload)
 			require.NoError(t, err)

-			withdrawalsRoot, err := light_client.ComputeWithdrawalsRoot(payload)
+			withdrawalsRoot, err := lightClient.ComputeWithdrawalsRoot(payload)
 			require.NoError(t, err)

 			executionHeader := &v11.ExecutionPayloadHeaderCapella{
@@ -421,8 +422,9 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 		t.Run("Blinded Beacon Block", func(t *testing.T) {
 			l := util.NewTestLightClient(t).SetupTestCapella(true)

-			header, err := lightClient.BlockToLightClientHeaderCapella(l.Ctx, l.Block)
+			container, err := lightClient.BlockToLightClientHeader(l.Block)
 			require.NoError(t, err)
+			header := container.GetHeaderCapella()
 			require.NotNil(t, header, "header is nil")

 			parentRoot := l.Block.Block().ParentRoot()
@@ -476,8 +478,9 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 		t.Run("Non-Blinded Beacon Block", func(t *testing.T) {
 			l := util.NewTestLightClient(t).SetupTestDeneb(false)

-			header, err := lightClient.BlockToLightClientHeaderDeneb(l.Ctx, l.Block)
+			container, err := lightClient.BlockToLightClientHeader(l.Block)
 			require.NoError(t, err)
+			header := container.GetHeaderDeneb()
 			require.NotNil(t, header, "header is nil")

 			parentRoot := l.Block.Block().ParentRoot()
@@ -488,10 +491,10 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 			payload, err := l.Block.Block().Body().Execution()
 			require.NoError(t, err)

-			transactionsRoot, err := light_client.ComputeTransactionsRoot(payload)
+			transactionsRoot, err := lightClient.ComputeTransactionsRoot(payload)
 			require.NoError(t, err)

-			withdrawalsRoot, err := light_client.ComputeWithdrawalsRoot(payload)
+			withdrawalsRoot, err := lightClient.ComputeWithdrawalsRoot(payload)
 			require.NoError(t, err)

 			blobGasUsed, err := payload.BlobGasUsed()
@@ -537,8 +540,9 @@ func TestLightClient_BlockToLightClientHeader(t *testing.T) {
 		t.Run("Blinded Beacon Block", func(t *testing.T) {
 			l := util.NewTestLightClient(t).SetupTestDeneb(true)

-			header, err := lightClient.BlockToLightClientHeaderDeneb(l.Ctx, l.Block)
+			container, err := lightClient.BlockToLightClientHeader(l.Block)
 			require.NoError(t, err)
+			header := container.GetHeaderDeneb()
 			require.NotNil(t, header, "header is nil")

 			parentRoot := l.Block.Block().ParentRoot()
--- a/beacon-chain/rpc/eth/light-client/helpers.go
+++ b/beacon-chain/rpc/eth/light-client/helpers.go
@@ -68,10 +68,11 @@ func createLightClientBootstrapAltair(ctx context.Context, state state.BeaconSta
 		return nil, fmt.Errorf("latest block header root %#x not equal to block root %#x", latestBlockHeaderRoot, beaconBlockRoot)
 	}

-	lightClientHeader, err := lightclient.BlockToLightClientHeaderAltair(block)
+	lightClientHeaderContainer, err := lightclient.BlockToLightClientHeader(block)
 	if err != nil {
 		return nil, errors.Wrap(err, "could not convert block to light client header")
 	}
+	lightClientHeader := lightClientHeaderContainer.GetHeaderAltair()

 	apiLightClientHeader := &structs.LightClientHeader{
 		Beacon: structs.BeaconBlockHeaderFromConsensus(migration.V1HeaderToV1Alpha1(lightClientHeader.Beacon)),
@@ -135,10 +136,11 @@ func createLightClientBootstrapCapella(ctx context.Context, state state.BeaconSt
 		return nil, fmt.Errorf("latest block header root %#x not equal to block root %#x", latestBlockHeaderRoot, beaconBlockRoot)
 	}

-	lightClientHeader, err := lightclient.BlockToLightClientHeaderCapella(ctx, block)
+	lightClientHeaderContainer, err := lightclient.BlockToLightClientHeader(block)
 	if err != nil {
 		return nil, errors.Wrap(err, "could not convert block to light client header")
 	}
+	lightClientHeader := lightClientHeaderContainer.GetHeaderCapella()

 	apiLightClientHeader := &structs.LightClientHeader{
 		Beacon: structs.BeaconBlockHeaderFromConsensus(migration.V1HeaderToV1Alpha1(lightClientHeader.Beacon)),
@@ -202,10 +204,11 @@ func createLightClientBootstrapDeneb(ctx context.Context, state state.BeaconStat
 		return nil, fmt.Errorf("latest block header root %#x not equal to block root %#x", latestBlockHeaderRoot, beaconBlockRoot)
 	}

-	lightClientHeader, err := lightclient.BlockToLightClientHeaderDeneb(ctx, block)
+	lightClientHeaderContainer, err := lightclient.BlockToLightClientHeader(block)
 	if err != nil {
 		return nil, errors.Wrap(err, "could not convert block to light client header")
 	}
+	lightClientHeader := lightClientHeaderContainer.GetHeaderDeneb()

 	apiLightClientHeader := &structs.LightClientHeader{
 		Beacon: structs.BeaconBlockHeaderFromConsensus(migration.V1HeaderToV1Alpha1(lightClientHeader.Beacon)),