all: implement eip-7002 EL triggered withdrawal requests

Author: lightclient

beacon/engine/gen_ed.go

@@ -60,25 +60,26 @@ type payloadAttributesMarshaling struct {
 
 // ExecutableData is the data necessary to execute an EL payload.
 type ExecutableData struct {
-	ParentHash       common.Hash             `json:"parentHash"    gencodec:"required"`
-	FeeRecipient     common.Address          `json:"feeRecipient"  gencodec:"required"`
-	StateRoot        common.Hash             `json:"stateRoot"     gencodec:"required"`
-	ReceiptsRoot     common.Hash             `json:"receiptsRoot"  gencodec:"required"`
-	LogsBloom        []byte                  `json:"logsBloom"     gencodec:"required"`
-	Random           common.Hash             `json:"prevRandao"    gencodec:"required"`
-	Number           uint64                  `json:"blockNumber"   gencodec:"required"`
-	GasLimit         uint64                  `json:"gasLimit"      gencodec:"required"`
-	GasUsed          uint64                  `json:"gasUsed"       gencodec:"required"`
-	Timestamp        uint64                  `json:"timestamp"     gencodec:"required"`
-	ExtraData        []byte                  `json:"extraData"     gencodec:"required"`
-	BaseFeePerGas    *big.Int                `json:"baseFeePerGas" gencodec:"required"`
-	BlockHash        common.Hash             `json:"blockHash"     gencodec:"required"`
-	Transactions     [][]byte                `json:"transactions"  gencodec:"required"`
-	Withdrawals      []*types.Withdrawal     `json:"withdrawals"`
-	BlobGasUsed      *uint64                 `json:"blobGasUsed"`
-	ExcessBlobGas    *uint64                 `json:"excessBlobGas"`
-	Deposits         types.Deposits          `json:"depositRequests"`
-	ExecutionWitness *types.ExecutionWitness `json:"executionWitness,omitempty"`
+	ParentHash         common.Hash              `json:"parentHash"    gencodec:"required"`
+	FeeRecipient       common.Address           `json:"feeRecipient"  gencodec:"required"`
+	StateRoot          common.Hash              `json:"stateRoot"     gencodec:"required"`
+	ReceiptsRoot       common.Hash              `json:"receiptsRoot"  gencodec:"required"`
+	LogsBloom          []byte                   `json:"logsBloom"     gencodec:"required"`
+	Random             common.Hash              `json:"prevRandao"    gencodec:"required"`
+	Number             uint64                   `json:"blockNumber"   gencodec:"required"`
+	GasLimit           uint64                   `json:"gasLimit"      gencodec:"required"`
+	GasUsed            uint64                   `json:"gasUsed"       gencodec:"required"`
+	Timestamp          uint64                   `json:"timestamp"     gencodec:"required"`
+	ExtraData          []byte                   `json:"extraData"     gencodec:"required"`
+	BaseFeePerGas      *big.Int                 `json:"baseFeePerGas" gencodec:"required"`
+	BlockHash          common.Hash              `json:"blockHash"     gencodec:"required"`
+	Transactions       [][]byte                 `json:"transactions"  gencodec:"required"`
+	Withdrawals        []*types.Withdrawal      `json:"withdrawals"`
+	BlobGasUsed        *uint64                  `json:"blobGasUsed"`
+	ExcessBlobGas      *uint64                  `json:"excessBlobGas"`
+	Deposits           types.Deposits           `json:"depositRequests"`
+	WithdrawalRequests types.WithdrawalRequests `json:"withdrawalRequests"`
+	ExecutionWitness   *types.ExecutionWitness  `json:"executionWitness,omitempty"`
 }
 
 // JSON type overrides for executableData.
@@ -233,7 +234,9 @@ func ExecutableDataToBlock(data ExecutableData, versionedHashes []common.Hash, b
 		h := types.DeriveSha(types.Withdrawals(data.Withdrawals), trie.NewStackTrie(nil))
 		withdrawalsRoot = &h
 	}
-	// Compute requestsHash if any requests are non-nil.
+	// Only set requestsHash if there exists requests in the ExecutableData. This
+	// allows CLs to continue using the data structure before requests are
+	// enabled.
 	var (
 		requestsHash *common.Hash
 		requests     types.Requests
@@ -243,9 +246,17 @@ func ExecutableDataToBlock(data ExecutableData, versionedHashes []common.Hash, b
 		for _, d := range data.Deposits {
 			requests = append(requests, types.NewRequest(d))
 		}
+	}
+	if data.WithdrawalRequests != nil {
+		for _, w := range data.WithdrawalRequests {
+			requests = append(requests, types.NewRequest(w))
+		}
+	}
+	if requests != nil {
 		h := types.DeriveSha(requests, trie.NewStackTrie(nil))
 		requestsHash = &h
 	}
+
 	header := &types.Header{
 		ParentHash:       data.ParentHash,
 		UncleHash:        types.EmptyUncleHash,
@@ -320,22 +331,27 @@ func BlockToExecutableData(block *types.Block, fees *big.Int, sidecars []*types.
 // assigns them to the associated fields in ExecutableData.
 func setRequests(requests types.Requests, data *ExecutableData) {
 	if requests != nil {
-		// If requests is non-nil, it means deposits are available in block and we
-		// should return an empty slice instead of nil if there are no deposits.
+		// If requests is non-nil, it means the requests are available in block and
+		// we should return an empty slice instead of nil.
 		data.Deposits = make(types.Deposits, 0)
+		data.WithdrawalRequests = make(types.WithdrawalRequests, 0)
 	}
 	for _, r := range requests {
-		if d, ok := r.Inner().(*types.Deposit); ok {
-			data.Deposits = append(data.Deposits, d)
+		switch v := r.Inner().(type) {
+		case *types.Deposit:
+			data.Deposits = append(data.Deposits, v)
+		case *types.WithdrawalRequest:
+			data.WithdrawalRequests = append(data.WithdrawalRequests, v)
 		}
 	}
 }
 
 // ExecutionPayloadBody is used in the response to GetPayloadBodiesByHash and GetPayloadBodiesByRange
 type ExecutionPayloadBody struct {
-	TransactionData []hexutil.Bytes     `json:"transactions"`
-	Withdrawals     []*types.Withdrawal `json:"withdrawals"`
-	Deposits        types.Deposits      `json:"depositRequests"`
+	TransactionData    []hexutil.Bytes          `json:"transactions"`
+	Withdrawals        []*types.Withdrawal      `json:"withdrawals"`
+	Deposits           types.Deposits           `json:"depositRequests"`
+	WithdrawalRequests types.WithdrawalRequests `json:"withdrawalRequests"`
 }
 
 // Client identifiers to support ClientVersionV1.