electra engine api support (#13978)

* electra engine api support * add marshaling support for ExecutionPayloadElectra * add receipts to json tests * deep source * simplify slice handling * deep source lint about type/method order --------- Co-authored-by: Kasey Kirkham <kasey@users.noreply.github.com>
prysmaticlabs · Jun 19, 2024 · 2125d5e · 2125d5e
1 parent de86cc9
commit 2125d5e
Show file tree

Hide file tree

Showing 6 changed files with 1,330 additions and 670 deletions.
diff --git a/beacon-chain/execution/engine_client.go b/beacon-chain/execution/engine_client.go
@@ -49,6 +49,8 @@ const (
 	// NewPayloadMethodV2 v2 request string for JSON-RPC.
 	NewPayloadMethodV2 = "engine_newPayloadV2"
 	NewPayloadMethodV3 = "engine_newPayloadV3"
+	// NewPayloadMethodV4 is the engine_newPayloadVX method added at Electra.
+	NewPayloadMethodV4 = "engine_newPayloadV4"
 	// ForkchoiceUpdatedMethod v1 request string for JSON-RPC.
 	ForkchoiceUpdatedMethod = "engine_forkchoiceUpdatedV1"
 	// ForkchoiceUpdatedMethodV2 v2 request string for JSON-RPC.
@@ -59,7 +61,10 @@ const (
 	GetPayloadMethod = "engine_getPayloadV1"
 	// GetPayloadMethodV2 v2 request string for JSON-RPC.
 	GetPayloadMethodV2 = "engine_getPayloadV2"
+	// GetPayloadMethodV3 is the get payload method added for deneb
 	GetPayloadMethodV3 = "engine_getPayloadV3"
+	// GetPayloadMethodV4 is the get payload method added for electra
+	GetPayloadMethodV4 = "engine_getPayloadV3"
 	// BlockByHashMethod request string for JSON-RPC.
 	BlockByHashMethod = "eth_getBlockByHash"
 	// BlockByNumberMethod request string for JSON-RPC.
@@ -82,7 +87,7 @@ type ForkchoiceUpdatedResponse struct {
 	ValidationError string             `json:"validationError"`
 }
 
-// ExecutionPayloadReconstructor defines a service that can reconstruct a full beacon
+// PayloadReconstructor defines a service that can reconstruct a full beacon
 // block with an execution payload from a signed beacon block and a connection
 // to an execution client's engine API.
 type PayloadReconstructor interface {
@@ -150,6 +155,15 @@ func (s *Service) NewPayload(ctx context.Context, payload interfaces.ExecutionDa
 		if err != nil {
 			return nil, handleRPCError(err)
 		}
+	case *pb.ExecutionPayloadElectra:
+		payloadPb, ok := payload.Proto().(*pb.ExecutionPayloadElectra)
+		if !ok {
+			return nil, errors.New("execution data must be a Deneb execution payload")
+		}
+		err := s.rpcClient.CallContext(ctx, result, NewPayloadMethodV4, payloadPb, versionedHashes, parentBlockRoot)
+		if err != nil {
+			return nil, handleRPCError(err)
+		}
 	default:
 		return nil, errors.New("unknown execution data type")
 	}
@@ -254,6 +268,19 @@ func (s *Service) GetPayload(ctx context.Context, payloadId [8]byte, slot primit
 	ctx, cancel := context.WithDeadline(ctx, d)
 	defer cancel()
 
+	if slots.ToEpoch(slot) >= params.BeaconConfig().ElectraForkEpoch {
+		result := &pb.ExecutionPayloadElectraWithValueAndBlobsBundle{}
+		err := s.rpcClient.CallContext(ctx, result, GetPayloadMethodV4, pb.PayloadIDBytes(payloadId))
+		if err != nil {
+			return nil, nil, false, handleRPCError(err)
+		}
+		ed, err := blocks.WrappedExecutionPayloadElectra(result.Payload, blocks.PayloadValueToWei(result.Value))
+		if err != nil {
+			return nil, nil, false, err
+		}
+		return ed, result.BlobsBundle, result.ShouldOverrideBuilder, nil
+	}
+
 	if slots.ToEpoch(slot) >= params.BeaconConfig().DenebForkEpoch {
 		result := &pb.ExecutionPayloadDenebWithValueAndBlobsBundle{}
 		err := s.rpcClient.CallContext(ctx, result, GetPayloadMethodV3, pb.PayloadIDBytes(payloadId))
@@ -682,31 +709,14 @@ func (s *Service) retrievePayloadsFromExecutionHashes(
 	return fullBlocks, nil
 }
 
-func fullPayloadFromExecutionBlock(
-	blockVersion int, header interfaces.ExecutionData, block *pb.ExecutionBlock,
+func fullPayloadFromPayloadBody(
+	header interfaces.ExecutionData, body *pb.ExecutionPayloadBodyV1, bVersion int,
 ) (interfaces.ExecutionData, error) {
-	if header.IsNil() || block == nil {
+	if header.IsNil() || body == nil {
 		return nil, errors.New("execution block and header cannot be nil")
 	}
-	blockHash := block.Hash
-	if !bytes.Equal(header.BlockHash(), blockHash[:]) {
-		return nil, fmt.Errorf(
-			"block hash field in execution header %#x does not match execution block hash %#x",
-			header.BlockHash(),
-			blockHash,
-		)
-	}
-	blockTransactions := block.Transactions
-	txs := make([][]byte, len(blockTransactions))
-	for i, tx := range blockTransactions {
-		txBin, err := tx.MarshalBinary()
-		if err != nil {
-			return nil, err
-		}
-		txs[i] = txBin
-	}
 
-	switch blockVersion {
+	switch bVersion {
 	case version.Bellatrix:
 		return blocks.WrappedExecutionPayload(&pb.ExecutionPayload{
 			ParentHash:    header.ParentHash(),
@@ -721,8 +731,8 @@ func fullPayloadFromExecutionBlock(
 			Timestamp:     header.Timestamp(),
 			ExtraData:     header.ExtraData(),
 			BaseFeePerGas: header.BaseFeePerGas(),
-			BlockHash:     blockHash[:],
-			Transactions:  txs,
+			BlockHash:     header.BlockHash(),
+			Transactions:  body.Transactions,
 		})
 	case version.Capella:
 		return blocks.WrappedExecutionPayloadCapella(&pb.ExecutionPayloadCapella{
@@ -738,9 +748,9 @@ func fullPayloadFromExecutionBlock(
 			Timestamp:     header.Timestamp(),
 			ExtraData:     header.ExtraData(),
 			BaseFeePerGas: header.BaseFeePerGas(),
-			BlockHash:     blockHash[:],
-			Transactions:  txs,
-			Withdrawals:   block.Withdrawals,
+			BlockHash:     header.BlockHash(),
+			Transactions:  body.Transactions,
+			Withdrawals:   body.Withdrawals,
 		}, big.NewInt(0)) // We can't get the block value and don't care about the block value for this instance
 	case version.Deneb:
 		ebg, err := header.ExcessBlobGas()
@@ -765,61 +775,13 @@ func fullPayloadFromExecutionBlock(
 				Timestamp:     header.Timestamp(),
 				ExtraData:     header.ExtraData(),
 				BaseFeePerGas: header.BaseFeePerGas(),
-				BlockHash:     blockHash[:],
-				Transactions:  txs,
-				Withdrawals:   block.Withdrawals,
-				BlobGasUsed:   bgu,
+				BlockHash:     header.BlockHash(),
+				Transactions:  body.Transactions,
+				Withdrawals:   body.Withdrawals,
 				ExcessBlobGas: ebg,
+				BlobGasUsed:   bgu,
 			}, big.NewInt(0)) // We can't get the block value and don't care about the block value for this instance
-	default:
-		return nil, fmt.Errorf("unknown execution block version %d", block.Version)
-	}
-}
-
-func fullPayloadFromPayloadBody(
-	header interfaces.ExecutionData, body *pb.ExecutionPayloadBodyV1, bVersion int,
-) (interfaces.ExecutionData, error) {
-	if header.IsNil() || body == nil {
-		return nil, errors.New("execution block and header cannot be nil")
-	}
-
-	switch bVersion {
-	case version.Bellatrix:
-		return blocks.WrappedExecutionPayload(&pb.ExecutionPayload{
-			ParentHash:    header.ParentHash(),
-			FeeRecipient:  header.FeeRecipient(),
-			StateRoot:     header.StateRoot(),
-			ReceiptsRoot:  header.ReceiptsRoot(),
-			LogsBloom:     header.LogsBloom(),
-			PrevRandao:    header.PrevRandao(),
-			BlockNumber:   header.BlockNumber(),
-			GasLimit:      header.GasLimit(),
-			GasUsed:       header.GasUsed(),
-			Timestamp:     header.Timestamp(),
-			ExtraData:     header.ExtraData(),
-			BaseFeePerGas: header.BaseFeePerGas(),
-			BlockHash:     header.BlockHash(),
-			Transactions:  body.Transactions,
-		})
-	case version.Capella:
-		return blocks.WrappedExecutionPayloadCapella(&pb.ExecutionPayloadCapella{
-			ParentHash:    header.ParentHash(),
-			FeeRecipient:  header.FeeRecipient(),
-			StateRoot:     header.StateRoot(),
-			ReceiptsRoot:  header.ReceiptsRoot(),
-			LogsBloom:     header.LogsBloom(),
-			PrevRandao:    header.PrevRandao(),
-			BlockNumber:   header.BlockNumber(),
-			GasLimit:      header.GasLimit(),
-			GasUsed:       header.GasUsed(),
-			Timestamp:     header.Timestamp(),
-			ExtraData:     header.ExtraData(),
-			BaseFeePerGas: header.BaseFeePerGas(),
-			BlockHash:     header.BlockHash(),
-			Transactions:  body.Transactions,
-			Withdrawals:   body.Withdrawals,
-		}, big.NewInt(0)) // We can't get the block value and don't care about the block value for this instance
-	case version.Deneb:
+	case version.Electra:
 		ebg, err := header.ExcessBlobGas()
 		if err != nil {
 			return nil, errors.Wrap(err, "unable to extract ExcessBlobGas attribute from execution payload header")
@@ -828,8 +790,8 @@ func fullPayloadFromPayloadBody(
 		if err != nil {
 			return nil, errors.Wrap(err, "unable to extract BlobGasUsed attribute from execution payload header")
 		}
-		return blocks.WrappedExecutionPayloadDeneb(
-			&pb.ExecutionPayloadDeneb{
+		return blocks.WrappedExecutionPayloadElectra(
+			&pb.ExecutionPayloadElectra{
 				ParentHash:    header.ParentHash(),
 				FeeRecipient:  header.FeeRecipient(),
 				StateRoot:     header.StateRoot(),