Merge branch 'devnet4-contracts' into 7702-devnet-4-plus-t8ntool

Author: jochem-brouwer

packages/block/src/block/block.ts

@@ -519,6 +519,7 @@ export class Block {
       transactions,
       ...withdrawalsArr,
       parentBeaconBlockRoot: header.parentBeaconBlockRoot,
+      requestsHash: header.requestsHash,
       executionWitness: this.executionWitness,
     }
 

packages/block/src/from-beacon-payload.ts

@@ -31,6 +31,7 @@ export type BeaconPayloadJSON = {
   blob_gas_used?: NumericString
   excess_blob_gas?: NumericString
   parent_beacon_block_root?: PrefixedHexString
+  requests_hash?: PrefixedHexString
   // the casing of VerkleExecutionWitness remains same camel case for now
   execution_witness?: VerkleExecutionWitness
 }
@@ -131,6 +132,9 @@ export function executionPayloadFromBeaconPayload(payload: BeaconPayloadJSON): E
   if (payload.parent_beacon_block_root !== undefined && payload.parent_beacon_block_root !== null) {
     executionPayload.parentBeaconBlockRoot = payload.parent_beacon_block_root
   }
+  if (payload.requests_hash !== undefined && payload.requests_hash !== null) {
+    executionPayload.requestsHash = payload.requests_hash
+  }
 
   if (payload.execution_witness !== undefined && payload.execution_witness !== null) {
     // the casing structure in payload could be camel case or snake depending upon the CL

packages/block/src/types.ts

@@ -255,6 +255,7 @@ export type ExecutionPayload = {
   blobGasUsed?: PrefixedHexString // QUANTITY, 64 Bits
   excessBlobGas?: PrefixedHexString // QUANTITY, 64 Bits
   parentBeaconBlockRoot?: PrefixedHexString // QUANTITY, 64 Bits
+  requestsHash?: PrefixedHexString
   // VerkleExecutionWitness is already a hex serialized object
   executionWitness?: VerkleExecutionWitness | null // QUANTITY, 64 Bits, null implies not available
 }

packages/client/src/rpc/modules/engine/engine.ts

@@ -38,7 +38,6 @@ import {
   executionPayloadV1FieldValidators,
   executionPayloadV2FieldValidators,
   executionPayloadV3FieldValidators,
-  executionPayloadV4FieldValidators,
   forkchoiceFieldValidators,
   payloadAttributesFieldValidatorsV1,
   payloadAttributesFieldValidatorsV2,
@@ -58,7 +57,6 @@ import type {
   ExecutionPayloadV1,
   ExecutionPayloadV2,
   ExecutionPayloadV3,
-  ExecutionPayloadV4,
   ForkchoiceResponseV1,
   ForkchoiceStateV1,
   PayloadAttributes,
@@ -206,9 +204,9 @@ export class Engine {
     this.newPayloadV4 = cmMiddleware(
       middleware(
         callWithStackTrace(this.newPayloadV4.bind(this), this._rpcDebug),
-        3,
+        4,
         [
-          [validators.object(executionPayloadV4FieldValidators)],
+          [validators.object(executionPayloadV3FieldValidators)],
           [validators.array(validators.bytes32)],
           [validators.bytes32],
           [validators.array(validators.hex)],
@@ -369,12 +367,9 @@ export class Engine {
      */
     // newpayloadv3 comes with parentBeaconBlockRoot out of the payload
     const { block: headBlock, error } = await assembleBlock(
+      payload,
       {
-        ...payload,
-        // ExecutionPayload only handles undefined
         parentBeaconBlockRoot: parentBeaconBlockRoot ?? undefined,
-      },
-      {
         blobVersionedHashes: blobVersionedHashes ?? undefined,
         executionRequests: executionRequests ?? undefined,
       },
@@ -826,7 +821,9 @@ export class Engine {
     return newPayloadRes
   }
 
-  async newPayloadV4(params: [ExecutionPayloadV4, Bytes32[], Bytes32]): Promise<PayloadStatusV1> {
+  async newPayloadV4(
+    params: [ExecutionPayloadV3, Bytes32[], Bytes32, Bytes32[]],
+  ): Promise<PayloadStatusV1> {
     const pragueTimestamp = this.chain.config.chainCommon.hardforkTimestamp(Hardfork.Prague)
     const ts = parseInt(params[0].timestamp)
     if (pragueTimestamp === null || ts < pragueTimestamp) {

packages/client/src/rpc/modules/engine/types.ts

@@ -2,12 +2,7 @@ import { UNKNOWN_PAYLOAD } from '../../error-code.js'
 
 import type { Skeleton } from '../../../service/index.js'
 import type { Block, ExecutionPayload } from '@ethereumjs/block'
-import type {
-  ConsolidationRequestV1,
-  DepositRequestV1,
-  PrefixedHexString,
-  WithdrawalRequestV1,
-} from '@ethereumjs/util'
+import type { PrefixedHexString } from '@ethereumjs/util'
 
 export enum Status {
   ACCEPTED = 'ACCEPTED',
@@ -32,11 +27,6 @@ export type ExecutionPayloadV1 = ExecutionPayload
 export type ExecutionPayloadV2 = ExecutionPayloadV1 & { withdrawals: WithdrawalV1[] }
 // parentBeaconBlockRoot comes separate in new payloads and needs to be added to payload data
 export type ExecutionPayloadV3 = ExecutionPayloadV2 & { excessBlobGas: Uint64; blobGasUsed: Uint64 }
-export type ExecutionPayloadV4 = ExecutionPayloadV3 & {
-  depositRequests: DepositRequestV1[]
-  withdrawalRequests: WithdrawalRequestV1[]
-  consolidationRequests: ConsolidationRequestV1[]
-}
 
 export type ForkchoiceStateV1 = {
   headBlockHash: Bytes32

packages/client/src/rpc/modules/engine/util/newPayload.ts

@@ -1,6 +1,12 @@
 import { createBlockFromExecutionPayload, genRequestsRoot } from '@ethereumjs/block'
 import { Blob4844Tx } from '@ethereumjs/tx'
-import { bytesToHex, createCLRequest, equalsBytes, hexToBytes } from '@ethereumjs/util'
+import {
+  ConsolidationRequest,
+  DepositRequest,
+  WithdrawalRequest,
+  bytesToHex,
+  hexToBytes,
+} from '@ethereumjs/util'
 import { sha256 } from 'ethereum-cryptography/sha256'
 
 import { short } from '../../../../util/index.js'
@@ -11,9 +17,11 @@ import { validHash } from './generic.js'
 import type { Chain } from '../../../../blockchain/index.js'
 import type { ChainCache, PayloadStatusV1 } from '../types.js'
 import type { Block, ExecutionPayload } from '@ethereumjs/block'
-import type { PrefixedHexString } from '@ethereumjs/util'
+import type { Common } from '@ethereumjs/common'
+import type { CLRequest, CLRequestType, PrefixedHexString } from '@ethereumjs/util'
 
-type CLValidationData = {
+type CLData = {
+  parentBeaconBlockRoot?: PrefixedHexString
   blobVersionedHashes?: PrefixedHexString[]
   executionRequests?: PrefixedHexString[]
 }
@@ -23,26 +31,35 @@ type CLValidationData = {
  * If errors, returns {@link PayloadStatusV1}
  */
 export const assembleBlock = async (
-  payload: ExecutionPayload,
-  clValidationData: CLValidationData,
+  payload: Omit<ExecutionPayload, 'requestsHash' | 'parentBeaconBlockRoot'>,
+  clValidationData: CLData,
   chain: Chain,
   chainCache: ChainCache,
 ): Promise<{ block?: Block; error?: PayloadStatusV1 }> => {
   const { blockNumber, timestamp } = payload
   const { config } = chain
   const common = config.chainCommon.copy()
-
   common.setHardforkBy({ blockNumber, timestamp })
 
   try {
-    const block = await createBlockFromExecutionPayload(payload, { common })
+    // Validate CL data to see if it matches with the assembled block
+    const { blobVersionedHashes, executionRequests, parentBeaconBlockRoot } = clValidationData
+
+    let requestsHash
+    if (executionRequests !== undefined) {
+      requestsHash = validateAndGen7685RequestsHash(common, executionRequests)
+    } else if (common.isActivatedEIP(7685)) {
+      throw `Invalid executionRequests=undefined for EIP-7685 activated block`
+    }
+
+    const block = await createBlockFromExecutionPayload(
+      { ...payload, parentBeaconBlockRoot, requestsHash },
+      { common },
+    )
     // TODO: validateData is also called in applyBlock while runBlock, may be it can be optimized
     // by removing/skipping block data validation from there
     await block.validateData()
 
-    // Validate CL data to see if it matches with the assembled block
-    const { blobVersionedHashes, executionRequests } = clValidationData
-
     /**
      * Validate blob versioned hashes in the context of EIP-4844 blob transactions
      */
@@ -63,23 +80,6 @@ export const assembleBlock = async (
       throw validationError
     }
 
-    if (block.common.isActivatedEIP(7685)) {
-      let validationError: string | null = null
-      if (executionRequests === undefined) {
-        validationError = `Error verifying executionRequests: received none`
-      } else {
-        validationError = validate7685ExecutionRequests(block, executionRequests)
-      }
-
-      // if there was a validation error return invalid
-      if (validationError !== null) {
-        throw validationError
-      }
-    } else if (executionRequests !== undefined) {
-      const validationError = `Invalid executionRequests before EIP-7685 is activated`
-      throw validationError
-    }
-
     return { block }
   } catch (error) {
     const validationError = `Error assembling block from payload: ${error}`
@@ -131,21 +131,34 @@ export const validate4844BlobVersionedHashes = (
   return validationError
 }
 
-export const validate7685ExecutionRequests = (
-  headBlock: Block,
+export const validateAndGen7685RequestsHash = (
+  common: Common,
   executionRequests: PrefixedHexString[],
-): string | null => {
+): PrefixedHexString => {
   let validationError: string | null = null
 
-  // Collect versioned hashes in the flat array `txVersionedHashes` to match with received
-  const requests = executionRequests.map((req) => createCLRequest(hexToBytes(req)))
-  const sha256Function = headBlock.common.customCrypto.sha256 ?? sha256
-  const requestsHash = genRequestsRoot(requests, sha256Function)
+  const requests: CLRequest<CLRequestType>[] = []
+  let requestIndex = 0
+  if (common.isActivatedEIP(6110)) {
+    requests.push(new DepositRequest(hexToBytes(executionRequests[requestIndex])))
+    requestIndex++
+  }
+  if (common.isActivatedEIP(7002)) {
+    requests.push(new WithdrawalRequest(hexToBytes(executionRequests[requestIndex])))
+    requestIndex++
+  }
+  if (common.isActivatedEIP(7251)) {
+    requests.push(new ConsolidationRequest(hexToBytes(executionRequests[requestIndex])))
+    requestIndex++
+  }
 
-  if (!equalsBytes(requestsHash, headBlock.header.requestsHash!)) {
-    validationError = `Invalid requestsHash received=${bytesToHex(
-      headBlock.header.requestsHash!,
-    )} expected=${bytesToHex(requestsHash)}`
+  if (requestIndex !== executionRequests.length) {
+    validationError = `Invalid executionRequests=${executionRequests.length} expected=${requestIndex}`
+    throw validationError
   }
-  return validationError
+
+  const sha256Function = common.customCrypto.sha256 ?? sha256
+  const requestsHash = genRequestsRoot(requests, sha256Function)
+
+  return bytesToHex(requestsHash)
 }

packages/client/src/rpc/modules/engine/validators.ts

@@ -26,13 +26,6 @@ export const executionPayloadV3FieldValidators = {
   excessBlobGas: validators.uint64,
 }
 
-export const executionPayloadV4FieldValidators = {
-  ...executionPayloadV3FieldValidators,
-  depositRequests: validators.array(validators.depositRequest()),
-  withdrawalRequests: validators.array(validators.withdrawalRequest()),
-  consolidationRequests: validators.array(validators.consolidationRequest()),
-}
-
 export const forkchoiceFieldValidators = {
   headBlockHash: validators.blockHash,
   safeBlockHash: validators.blockHash,

packages/client/test/rpc/engine/newPayloadV4.spec.ts

@@ -12,9 +12,9 @@ const [blockData] = beaconData
 
 const parentBeaconBlockRoot = '0x42942949c4ed512cd85c2cb54ca88591338cbb0564d3a2bea7961a639ef29d64'
 const validForkChoiceState = {
-  headBlockHash: '0xdc1727ee420fead1d6a8dfe548758e5a5a48eed888b162278534b105b9909cf9',
-  safeBlockHash: '0xdc1727ee420fead1d6a8dfe548758e5a5a48eed888b162278534b105b9909cf9',
-  finalizedBlockHash: '0xdc1727ee420fead1d6a8dfe548758e5a5a48eed888b162278534b105b9909cf9',
+  headBlockHash: '0x6abe4c2777a6a1e994d83920cfb95229b071174b95c89343f54b926f733789f2',
+  safeBlockHash: '0x6abe4c2777a6a1e994d83920cfb95229b071174b95c89343f54b926f733789f2',
+  finalizedBlockHash: '0x6abe4c2777a6a1e994d83920cfb95229b071174b95c89343f54b926f733789f2',
 }
 const validPayloadAttributes = {
   timestamp: '0x64ba84fd',
@@ -44,13 +44,13 @@ const electraGenesisContracts = {
   '0x00706203067988Ab3E2A2ab626EdCD6f28bDBbbb': {
     balance: '0',
     nonce: '1',
-    code: '0x3373fffffffffffffffffffffffffffffffffffffffe1460a8573615156028575f545f5260205ff35b36606014156101555760115f54600182026001905f5b5f82111560595781019083028483029004916001019190603e565b90939004341061015557600154600101600155600354806004026004013381556001015f358155600101602035815560010160403590553360601b5f5260605f60143760745fa0600101600355005b6003546002548082038060011160bc575060015b5f5b8181146101025780607402838201600402600401805490600101805490600101805490600101549260601b84529083601401528260340152906054015260010160be565b9101809214610114579060025561011f565b90505f6002555f6003555b5f548061049d141561012e57505f5b6001546001828201116101435750505f610149565b01600190035b5f555f6001556074025ff35b5f5ffd',
+    code: '0x3373fffffffffffffffffffffffffffffffffffffffe1460cf573615156028575f545f5260205ff35b366060141561019a5760115f54807fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1461019a57600182026001905f5b5f821115608057810190830284830290049160010191906065565b90939004341061019a57600154600101600155600354806004026004013381556001015f358155600101602035815560010160403590553360601b5f5260605f60143760745fa0600101600355005b6003546002548082038060011160e3575060015b5f5b8181146101295780607402838201600402600401805490600101805490600101805490600101549260601b84529083601401528260340152906054015260010160e5565b910180921461013b5790600255610146565b90505f6002555f6003555b5f54807fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff141561017357505f5b6001546001828201116101885750505f61018e565b01600190035b5f555f6001556074025ff35b5f5ffd',
   },
   // withdrawals request contract
   '0x05F27129610CB42103b665629CB5c8C00296AaAa': {
     balance: '0',
     nonce: '1',
-    code: '0x3373fffffffffffffffffffffffffffffffffffffffe1460a0573615156028575f545f5260205ff35b366038141561013f5760115f54600182026001905f5b5f82111560595781019083028483029004916001019190603e565b90939004341061013f57600154600101600155600354806003026004013381556001015f35815560010160203590553360601b5f5260385f601437604c5fa0600101600355005b6003546002548082038060101160b4575060105b5f5b81811460ed5780604c02838201600302600401805490600101805490600101549160601b83528260140152906034015260010160b6565b910180921460fe5790600255610109565b90505f6002555f6003555b5f548061049d141561011857505f5b60015460028282011161012d5750505f610133565b01600290035b5f555f600155604c025ff35b5f5ffd',
+    code: '0x3373fffffffffffffffffffffffffffffffffffffffe1460c7573615156028575f545f5260205ff35b36603814156101f05760115f54807fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff146101f057600182026001905f5b5f821115608057810190830284830290049160010191906065565b9093900434106101f057600154600101600155600354806003026004013381556001015f35815560010160203590553360601b5f5260385f601437604c5fa0600101600355005b6003546002548082038060101160db575060105b5f5b81811461017f5780604c02838201600302600401805490600101805490600101549160601b83528260140152807fffffffffffffffffffffffffffffffff0000000000000000000000000000000016826034015260401c906044018160381c81600701538160301c81600601538160281c81600501538160201c81600401538160181c81600301538160101c81600201538160081c81600101535360010160dd565b9101809214610191579060025561019c565b90505f6002555f6003555b5f54807fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff14156101c957505f5b6001546002828201116101de5750505f6101e4565b01600290035b5f555f600155604c025ff35b5f5ffd',
     storage: {
       '0x0000000000000000000000000000000000000000000000000000000000000000':
         '0x000000000000000000000000000000000000000000000000000000000000049d',
@@ -160,12 +160,9 @@ describe(`${method}: call with executionPayloadV4`, () => {
       withdrawals: [],
       blobGasUsed: '0x0',
       excessBlobGas: '0x0',
-      depositRequests: [],
-      withdrawalRequests: [],
-      consolidationRequests: [],
-      parentHash: '0xdc1727ee420fead1d6a8dfe548758e5a5a48eed888b162278534b105b9909cf9',
-      stateRoot: '0x42a2ea499b9805a99881ebb8057b7b336082a4890aac29f346064ca7a4777b82',
-      blockHash: '0xb8dd5003e1390c64eda06c87b931ede724905d4a33b77aba58c865bd2055c142',
+      parentHash: '0x6abe4c2777a6a1e994d83920cfb95229b071174b95c89343f54b926f733789f2',
+      stateRoot: '0x7aa6e46df1f78988a3141b5e7da8abee78d1daca175f43fe8866b2d1bf8d8ef8',
+      blockHash: '0x9a5903d803e6e7c3631cd76cb7279f93d7facc995c53eaffadf4e225504b18eb',
     }
 
     const oldMethods = ['engine_newPayloadV1', 'engine_newPayloadV2', 'engine_newPayloadV3']
@@ -183,7 +180,7 @@ describe(`${method}: call with executionPayloadV4`, () => {
       assert.ok(res.error.message.includes(expectedError))
     }
 
-    res = await rpc.request(method, [validBlock, [], parentBeaconBlockRoot])
+    res = await rpc.request(method, [validBlock, [], parentBeaconBlockRoot, ['0x', '0x', '0x']])
     assert.equal(res.result.status, 'VALID')
 
     res = await rpc.request('engine_forkchoiceUpdatedV3', validPayload)
@@ -203,21 +200,18 @@ describe(`${method}: call with executionPayloadV4`, () => {
     await service.txPool.add(depositTx, true)
 
     res = await rpc.request('engine_getPayloadV4', [payloadId])
-    const { executionPayload } = res.result
+    const { executionPayload, executionRequests } = res.result
     assert.ok(
-      executionPayload.depositRequests?.length === 1,
-      'depositRequests should have 1 deposit request',
-    )
-    assert.ok(
-      executionPayload.withdrawalRequests !== undefined,
-      'depositRequests field should be received',
-    )
-    assert.ok(
-      executionPayload.consolidationRequests !== undefined,
-      'consolidationRequests field should be received',
+      executionRequests?.length === 3,
+      'executionRequests should have 3 entries for each request type',
     )
 
-    res = await rpc.request(method, [executionPayload, [], parentBeaconBlockRoot])
+    res = await rpc.request(method, [
+      executionPayload,
+      [],
+      parentBeaconBlockRoot,
+      executionRequests,
+    ])
     assert.equal(res.result.status, 'VALID')
 
     const newBlockHashHex = executionPayload.blockHash