Implement EIP 7002 (exits)

packages/block/src/block.ts

@@ -5,6 +5,7 @@
 import {
   BIGINT_0,
   Deposit,
+  Exit,
   KECCAK256_RLP,
   Withdrawal,
   bigIntToHex,
@@ -41,7 +42,7 @@
   TxOptions,
   TypedTransaction,
 } from '@ethereumjs/tx'
-import type { DepositBytes, EthersProvider, WithdrawalBytes } from '@ethereumjs/util'
+import type { DepositBytes, EthersProvider, ExitBytes, WithdrawalBytes } from '@ethereumjs/util'
 
 /**
  * An object that represents the block.
@@ -52,6 +53,7 @@
   public readonly uncleHeaders: BlockHeader[] = []
   public readonly withdrawals?: Withdrawal[]
   public readonly deposits?: Deposit[]
+  public readonly exits?: Exit[]
   public readonly common: Common
   protected keccakFunction: (msg: Uint8Array) => Uint8Array
 
@@ -112,6 +114,7 @@
       transactions: txsData,
       uncleHeaders: uhsData,
       withdrawals: withdrawalsData,
+      exits: exitData,
       executionWitness: executionWitnessData,
       deposits: depositData,
     } = blockData
@@ -151,6 +154,7 @@
     // The witness data is planned to come in rlp serialized bytes so leave this
     // stub till that time
     const executionWitness = executionWitnessData
+    const exits = exitData?.map(Exit.fromExitData)
 
     const deposits = depositData?.map(Deposit.fromDepositData)
 
@@ -161,7 +165,8 @@
       withdrawals,
       opts,
       executionWitness,
-      deposits
+      deposits,
+      exits
     )
   }
 
@@ -196,8 +201,15 @@
 
     // First try to load header so that we can use its common (in case of setHardfork being activated)
     // to correctly make checks on the hardforks
-    const [headerData, txsData, uhsData, withdrawalBytes, depositBytes, executionWitnessBytes] =
-      values
+    const [
+      headerData,
+      txsData,
+      uhsData,
+      withdrawalBytes,
+      depositBytes,
+      exitBytes,
+      executionWitnessBytes,
+    ] = values
     const header = BlockHeader.fromValuesArray(headerData, opts)
 
     if (
@@ -217,6 +229,14 @@
         'Invalid serialized block input: EIP-6110 is active, and no deposits were provided as array'
       )
     }
+    if (
+      header.common.isActivatedEIP(7002) &&
+      (exitBytes === undefined || !Array.isArray(exitBytes))
+    ) {
+      throw new Error(
+        'Invalid serialized block input: EIP-7002 is active, and no exits were provided as array'
+      )
+    }
 
     // parse transactions
     const transactions = []
@@ -267,6 +287,16 @@
           }))
           ?.map(Deposit.fromDepositData)
       : undefined
+    // TODO fix my type, also figure out why we cannot parse this the same as WithdrawalBytes
+    // @ts-ignore
+    const exits = header.common.isActivatedEIP(7002)
+      ? (exitBytes as ExitBytes[])
+          ?.map(([address, validatorPubkey]) => ({
+            address,
+            validatorPubkey,
+          }))
+          ?.map(Exit.fromExitData)
+      : undefined
 
     // executionWitness are not part of the EL fetched blocks via eth_ bodies method
     // they are currently only available via the engine api constructed blocks
@@ -290,7 +320,8 @@
       withdrawals,
       opts,
       executionWitness,
-      deposits
+      deposits,
+      exits
     )
   }
 
@@ -464,7 +495,8 @@
     withdrawals?: Withdrawal[],
     opts: BlockOptions = {},
     executionWitness?: VerkleExecutionWitness | null,
-    deposits?: Deposit[]
+    deposits?: Deposit[],
+    exits?: Exit[]
   ) {
     this.header = header ?? BlockHeader.fromHeaderData({}, opts)
     this.common = this.header.common
@@ -473,6 +505,7 @@
     this.transactions = transactions
     this.withdrawals = withdrawals ?? (this.common.isActivatedEIP(4895) ? [] : undefined)
     this.deposits = deposits ?? (this.common.isActivatedEIP(6110) ? [] : undefined)
+    this.exits = exits ?? (this.common.isActivatedEIP(7002) ? [] : undefined)
     this.executionWitness = executionWitness
     // null indicates an intentional absence of value or unavailability
     // undefined indicates that the executionWitness should be initialized with the default state
@@ -526,6 +559,10 @@
       throw new Error(`Cannot have executionWitness field if EIP 6800 is not active `)
     }
 
+    if (!this.common.isActivatedEIP(7002) && exits !== undefined && exits !== null) {
+      throw new Error(`Cannot have exits field if EIP 7002 is not active`)
+    }
+
     const freeze = opts?.freeze ?? true
     if (freeze) {
       Object.freeze(this)
@@ -551,6 +588,10 @@
     if (depositsRaw) {
       bytesArray.push(depositsRaw)
     }
+    const exitsRaw = this.exits?.map((ex) => ex.raw())
+    if (exitsRaw) {
+      bytesArray.push(exitsRaw)
+    }
     if (this.executionWitness !== undefined && this.executionWitness !== null) {
       const executionWitnessBytes = RLP.encode(JSON.stringify(this.executionWitness))
       bytesArray.push(executionWitnessBytes as any)
@@ -724,6 +765,12 @@
         throw new Error(`Invalid block: ethereumjs stateless client needs executionWitness`)
       }
     }
+
+    if (this.common.isActivatedEIP(7002)) {
+      if (this.exits === undefined || this.exits === null) {
+        throw new Error('Invalid block: missing exits')
+      }
+    }
   }
 
   /**
@@ -873,12 +920,18 @@
           deposits: this.deposits.map((deposit) => deposit.toJSON()),
         }
       : {}
+    const exitsAttr = this.exits
+      ? {
+          exits: this.exits.map((exit) => exit.toJSON()),
+        }
+      : {}
     return {
       header: this.header.toJSON(),
       transactions: this.transactions.map((tx) => tx.toJSON()),
       uncleHeaders: this.uncleHeaders.map((uh) => uh.toJSON()),
       ...withdrawalsAttr,
       ...depositsAttr,
+      ...exitsAttr,
     }
   }
 

packages/block/src/from-rpc.ts

@@ -55,7 +55,14 @@ export function blockFromRpc(
   const uncleHeaders = uncles.map((uh) => blockHeaderFromRpc(uh, options))
 
   return Block.fromBlockData(
-    { header, transactions, uncleHeaders, withdrawals: blockParams.withdrawals },
+    {
+      header,
+      transactions,
+      uncleHeaders,
+      withdrawals: blockParams.withdrawals,
+      deposits: blockParams.deposits,
+      exits: blockParams.exits,
+    },
     options
   )
 }

packages/block/src/header.ts

@@ -64,6 +64,7 @@
   public readonly blobGasUsed?: bigint
   public readonly excessBlobGas?: bigint
   public readonly parentBeaconBlockRoot?: Uint8Array
+  public readonly exitsRoot?: Uint8Array
 
   public readonly common: Common
 
@@ -118,7 +119,8 @@
    */
   public static fromValuesArray(values: BlockHeaderBytes, opts: BlockOptions = {}) {
     const headerData = valuesArrayToHeaderData(values)
-    const { number, baseFeePerGas, excessBlobGas, blobGasUsed, parentBeaconBlockRoot } = headerData
+    const { number, baseFeePerGas, excessBlobGas, blobGasUsed, parentBeaconBlockRoot, exitsRoot } =
+      headerData
     const header = BlockHeader.fromHeaderData(headerData, opts)
     // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
     if (header.common.isActivatedEIP(1559) && baseFeePerGas === undefined) {
@@ -139,6 +141,9 @@
     if (header.common.isActivatedEIP(4788) && parentBeaconBlockRoot === undefined) {
       throw new Error('invalid header. parentBeaconBlockRoot should be provided')
     }
+    if (header.common.isActivatedEIP(7002) && exitsRoot === undefined) {
+      throw new Error('invalid header. exitsRoot should be provided')
+    }
     return header
   }
   /**
@@ -224,6 +229,7 @@
       blobGasUsed: this.common.isActivatedEIP(4844) ? BIGINT_0 : undefined,
       excessBlobGas: this.common.isActivatedEIP(4844) ? BIGINT_0 : undefined,
       parentBeaconBlockRoot: this.common.isActivatedEIP(4788) ? zeros(32) : undefined,
+      exitsRoot: this.common.isActivatedEIP(7002) ? zeros(32) : undefined,
     }
 
     const baseFeePerGas =
@@ -239,6 +245,8 @@
     const parentBeaconBlockRoot =
       toType(headerData.parentBeaconBlockRoot, TypeOutput.Uint8Array) ??
       hardforkDefaults.parentBeaconBlockRoot
+    const exitsRoot =
+      toType(headerData.exitsRoot, TypeOutput.Uint8Array) ?? hardforkDefaults.exitsRoot
 
     if (!this.common.isActivatedEIP(1559) && baseFeePerGas !== undefined) {
       throw new Error('A base fee for a block can only be set with EIP1559 being activated')
@@ -272,6 +280,10 @@
       )
     }
 
+    if (!this.common.isActivatedEIP(7200) && exitsRoot !== undefined) {
+      throw new Error('A exitsRoot for a header can only be provided with EIP7002 being activated')
+    }
+
     this.parentHash = parentHash
     this.uncleHash = uncleHash
     this.coinbase = coinbase
@@ -293,6 +305,7 @@
     this.blobGasUsed = blobGasUsed
     this.excessBlobGas = excessBlobGas
     this.parentBeaconBlockRoot = parentBeaconBlockRoot
+    this.exitsRoot = exitsRoot
     this._genericFormatValidation()
     this._validateDAOExtraData()
 
@@ -431,6 +444,19 @@
         throw new Error(msg)
       }
     }
+
+    if (this.common.isActivatedEIP(7002) === true) {
+      if (this.exitsRoot === undefined) {
+        const msg = this._errorMsg('EIP7002 has no exitsRoot field')
+        throw new Error(msg)
+      }
+      if (this.exitsRoot.length !== 32) {
+        const msg = this._errorMsg(
+          `exitsRoot must be 32 bytes, received ${this.exitsRoot.length} bytes`
+        )
+        throw new Error(msg)
+      }
+    }
   }
 
   /**
@@ -721,6 +747,9 @@
     if (this.common.isActivatedEIP(4788) === true) {
       rawItems.push(this.parentBeaconBlockRoot!)
     }
+    if (this.common.isActivatedEIP(7002)) {
+      rawItems.push(this.exitsRoot!)
+    }
 
     return rawItems
   }
@@ -990,6 +1019,9 @@
     if (this.common.isActivatedEIP(4788) === true) {
       jsonDict.parentBeaconBlockRoot = bytesToHex(this.parentBeaconBlockRoot!)
     }
+    if (this.common.isActivatedEIP(7002)) {
+      jsonDict.exitsRoot = bytesToHex(this.exitsRoot!)
+    }
     return jsonDict
   }
 

packages/block/src/types.ts

@@ -7,7 +7,10 @@ import type {
   BytesLike,
   DepositBytes,
   DepositData,
+  ExitBytes,
+  ExitData,
   JsonRpcDeposit,
+  JsonRpcExit,
   JsonRpcWithdrawal,
   PrefixedHexString,
   WithdrawalBytes,
@@ -140,6 +143,7 @@ export interface HeaderData {
   blobGasUsed?: BigIntLike
   excessBlobGas?: BigIntLike
   parentBeaconBlockRoot?: BytesLike
+  exitsRoot?: BytesLike
 }
 
 /**
@@ -161,10 +165,15 @@ export interface BlockData {
    * EIP-6100: Deposits in EL (experimental)
    */
   deposits?: Array<DepositData>
+  /**
+   * EIP-7002: Exits in EL (experimental)
+   */
+  exits?: Array<ExitData>
 }
 
 export type WithdrawalsBytes = WithdrawalBytes[]
 export type DepositsBytes = DepositBytes[]
+export type ExitsBytes = ExitBytes[]
 export type ExecutionWitnessBytes = Uint8Array
 
 export type BlockBytes =
@@ -175,16 +184,26 @@ export type BlockBytes =
       TransactionsBytes,
       UncleHeadersBytes,
       WithdrawalsBytes,
-      ExecutionWitnessBytes
+      DepositsBytes,
+      ExitsBytes
+      // The type here is the BlockBytes without 6800, but with 6110 + 7002
     ]
-  | [BlockHeaderBytes, TransactionsBytes, UncleHeadersBytes, WithdrawalsBytes, DepositsBytes]
   | [
       BlockHeaderBytes,
       TransactionsBytes,
       UncleHeadersBytes,
       WithdrawalsBytes,
       DepositsBytes,
-      ExecutionWitnessBytes
+      ExitBytes,
+      ExecutionWitnessBytes // This includes 6800 with 6110 + 7002
+    ]
+  | [BlockHeaderBytes, TransactionsBytes, UncleHeadersBytes, WithdrawalsBytes, DepositsBytes]
+  | [
+      BlockHeaderBytes,
+      TransactionsBytes,
+      UncleHeadersBytes,
+      WithdrawalsBytes,
+      ExecutionWitnessBytes // This only includes 6800 sso without 6110 + 7002
     ]
 
 /**
@@ -215,6 +234,7 @@ export interface JsonBlock {
   uncleHeaders?: JsonHeader[]
   withdrawals?: JsonRpcWithdrawal[]
   deposits?: JsonRpcDeposit[]
+  exits?: JsonRpcExit[]
   executionWitness?: VerkleExecutionWitness | null
 }
 
@@ -243,6 +263,7 @@ export interface JsonHeader {
   blobGasUsed?: string
   excessBlobGas?: string
   parentBeaconBlockRoot?: string
+  exitsRoot?: string
 }
 
 /*
@@ -274,6 +295,8 @@ export interface JsonRpcBlock {
   withdrawalsRoot?: string // If EIP-4895 is enabled for this block, the root of the withdrawal trie of the block.
   deposits?: Array<JsonRpcDeposit> // If EIP-6110 is enabled for this block, array of deposits
   depositsRoot?: string // If EIP-6110 is enabled for this block, the root of the deposit trie of the block.
+  exits?: Array<JsonRpcExit> // If EIP-7002 is enabled for this block, array of exits
+  exitsRoot?: string // If EIP-7002 is enabled for this block, the root of the exits trie of the block.
   blobGasUsed?: string // If EIP-4844 is enabled for this block, returns the blob gas used for the block
   excessBlobGas?: string // If EIP-4844 is enabled for this block, returns the excess blob gas for the block
   parentBeaconBlockRoot?: string // If EIP-4788 is enabled for this block, returns parent beacon block root