impl ssz receipts and dev modify the receipts rooting work

Author: g11tech

package-lock.json

@@ -1,6 +1,7 @@
 import { Tree, hasher } from '@chainsafe/persistent-merkle-tree'
 import {
   BitArray,
+  BooleanType,
   ByteListType,
   ByteVectorType,
   ContainerType,
@@ -24,6 +25,8 @@ export const MAX_TRANSACTION_PAYLOAD_FIELDS = 32
 export const MAX_TRANSACTION_SIGNATURE_FIELDS = 16
 export const MAX_BLOB_COMMITMENTS_PER_BLOCK = 4096
 
+export const Boolean = new BooleanType()
+
 export const Uint8 = new UintBigintType(1)
 export const Uint64 = new UintBigintType(8)
 export const Uint256 = new UintBigintType(32)
@@ -393,6 +396,37 @@ export type TransactionV1 = {
   signature: ExecutionSignatureV1
 }
 
+const MAX_TOPICS_PER_LOG = 4
+const MAX_LOG_DATA_SIZE = 16_777_216
+const MAX_RECEIPT_FIELDS = 32
+const MAX_LOGS_PER_RECEIPT = 2_097_152
+
+export const LogTopics = new ListCompositeType(Bytes32, MAX_TOPICS_PER_LOG)
+export const Log = new ContainerType(
+  {
+    address: ExecutionAddress,
+    topics: LogTopics,
+    data: new ByteListType(MAX_LOG_DATA_SIZE),
+  },
+  { typeName: 'Log', jsonCase: 'eth2' },
+)
+export const LogList = new ListCompositeType(Log, MAX_LOGS_PER_RECEIPT)
+export const AuthoritiesList = new ListCompositeType(ExecutionAddress, MAX_AUTHORIZATION_LIST_SIZE)
+
+export const Receipt = new StableContainerType(
+  {
+    root: new OptionalType(Bytes32),
+    gasUsed: new OptionalType(Uint64),
+    contractAddress: new OptionalType(ExecutionAddress),
+    logs: new OptionalType(LogList),
+    status: new OptionalType(Boolean),
+    authorities: new OptionalType(AuthoritiesList),
+  },
+  MAX_RECEIPT_FIELDS,
+  { typeName: 'Receipt', jsonCase: 'eth2' },
+)
+export const Receipts = new ListCompositeType(Receipt, MAX_TRANSACTIONS_PER_PAYLOAD)
+
 export const MAX_BLOCKHEADER_FIELDS = 64
 const MAX_EXTRA_DATA_BYTES = 32
 

packages/util/src/ssz.ts

@@ -64,6 +64,7 @@
     "tsc": "../../config/cli/ts-compile.sh"
   },
   "dependencies": {
+    "@chainsafe/ssz": "https://github.com/ChainSafe/ssz/raw/cayman/stable-container/packages/ssz/package.tgz",
     "@ethereumjs/block": "^5.3.0",
     "@ethereumjs/common": "^4.4.0",
     "@ethereumjs/evm": "^3.1.0",

packages/vm/package.json

@@ -17,10 +17,10 @@ import {
   BIGINT_1,
   BIGINT_2,
   GWEI_TO_WEI,
-  KECCAK256_RLP,
   TypeOutput,
   createWithdrawal,
   createZeroAddress,
+  ssz,
   toBytes,
   toType,
 } from '@ethereumjs/util'
@@ -32,11 +32,13 @@ import {
   accumulateParentBlockHash,
   calculateMinerReward,
   encodeReceipt,
+  encodeSszReceipt,
   rewardAccount,
 } from './runBlock.js'
 
 import { runTx } from './index.js'
 
+import type { SSZReceiptType } from './runBlock.js'
 import type { BuildBlockOpts, BuilderOpts, RunTxResult, SealBlockOpts } from './types.js'
 import type { VM } from './vm.js'
 import type { Block, HeaderData } from '@ethereumjs/block'
@@ -147,7 +149,10 @@ export class BlockBuilder {
   public async transactionsTrie() {
     return this.vm.common.isActivatedEIP(6493)
       ? genTransactionsSszRoot(this.transactions)
-      : genTransactionsTrieRoot(this.transactions, new MerklePatriciaTrie({ common: this.vm.common }))
+      : genTransactionsTrieRoot(
+          this.transactions,
+          new MerklePatriciaTrie({ common: this.vm.common }),
+        )
   }
 
   public async withdrawalsTrie() {
@@ -176,16 +181,22 @@ export class BlockBuilder {
    * Calculates and returns the receiptTrie for the block.
    */
   public async receiptTrie() {
-    if (this.transactionResults.length === 0) {
-      return KECCAK256_RLP
-    }
-    const receiptTrie = new MerklePatriciaTrie({ common: this.vm.common })
-    for (const [i, txResult] of this.transactionResults.entries()) {
-      const tx = this.transactions[i]
-      const encodedReceipt = encodeReceipt(txResult.receipt, tx.type)
-      await receiptTrie.put(RLP.encode(i), encodedReceipt)
+    if (this.vm.common.isActivatedEIP(6493)) {
+      const sszReceipts: SSZReceiptType[] = []
+      for (const [i, txResult] of this.transactionResults.entries()) {
+        const tx = this.transactions[i]
+        sszReceipts.push(encodeSszReceipt(txResult.receipt, tx.type))
+      }
+      return ssz.Receipts.hashTreeRoot(sszReceipts)
+    } else {
+      const receiptTrie = new MerklePatriciaTrie({ common: this.vm.common })
+      for (const [i, txResult] of this.transactionResults.entries()) {
+        const tx = this.transactions[i]
+        const encodedReceipt = encodeReceipt(txResult.receipt, tx.type)
+        await receiptTrie.put(RLP.encode(i), encodedReceipt)
+      }
+      return receiptTrie.root()
     }
-    return receiptTrie.root()
   }
 
   /**

packages/vm/src/buildBlock.ts

@@ -23,6 +23,7 @@ import {
   intToBytes,
   setLengthLeft,
   short,
+  ssz,
   unprefixedHexToBytes,
 } from '@ethereumjs/util'
 import debugDefault from 'debug'
@@ -44,11 +45,14 @@ import type {
   TxReceipt,
 } from './types.js'
 import type { VM } from './vm.js'
+import type { ValueOf } from '@chainsafe/ssz'
 import type { Block } from '@ethereumjs/block'
 import type { Common } from '@ethereumjs/common'
 import type { EVM, EVMInterface } from '@ethereumjs/evm'
 import type { CLRequest, CLRequestType, PrefixedHexString } from '@ethereumjs/util'
 
+export type SSZReceiptType = ValueOf<typeof ssz.Receipt>
+
 const debug = debugDefault('vm:block')
 
 const parentBeaconBlockRootAddress = createAddressFromString(
@@ -583,11 +587,6 @@ async function applyTransactions(vm: VM, block: Block, opts: RunBlockOpts) {
   // the total amount of gas used processing these transactions
   let gasUsed = BIGINT_0
 
-  let receiptTrie: MerklePatriciaTrie | undefined = undefined
-  if (block.transactions.length !== 0) {
-    receiptTrie = new MerklePatriciaTrie({ common: vm.common })
-  }
-
   const receipts: TxReceipt[] = []
   const txResults: RunTxResult[] = []
 
@@ -637,16 +636,30 @@ async function applyTransactions(vm: VM, block: Block, opts: RunBlockOpts) {
 
     // Add receipt to trie to later calculate receipt root
     receipts.push(txRes.receipt)
-    const encodedReceipt = encodeReceipt(txRes.receipt, tx.type)
-    await receiptTrie!.put(RLP.encode(txIdx), encodedReceipt)
   }
 
   if (enableProfiler) {
     // eslint-disable-next-line no-console
     console.timeEnd(processTxsLabel)
   }
 
-  const receiptsRoot = receiptTrie !== undefined ? receiptTrie.root() : KECCAK256_RLP
+  let receiptsRoot
+  if (vm.common.isActivatedEIP(6493)) {
+    const sszReceipts: SSZReceiptType[] = []
+    for (const [i, txReceipt] of receipts.entries()) {
+      const tx = block.transactions[i]
+      sszReceipts.push(encodeSszReceipt(txReceipt, tx.type))
+    }
+    receiptsRoot = ssz.Receipts.hashTreeRoot(sszReceipts)
+  } else {
+    const receiptTrie = new MerklePatriciaTrie({ common: vm.common })
+    for (const [i, txReceipt] of receipts.entries()) {
+      const tx = block.transactions[i]
+      const encodedReceipt = encodeReceipt(txReceipt, tx.type)
+      await receiptTrie!.put(RLP.encode(i), encodedReceipt)
+    }
+    receiptsRoot = receiptTrie.root()
+  }
 
   return {
     bloom,
@@ -761,6 +774,28 @@ export function encodeReceipt(receipt: TxReceipt, txType: TransactionType) {
   return concatBytes(intToBytes(txType), encoded)
 }
 
+export function encodeSszReceipt(receipt: TxReceipt, _txType: TransactionType) {
+  const sszRaw: SSZReceiptType = {
+    root: (receipt as PreByzantiumTxReceipt).stateRoot ?? null,
+    gasUsed: receipt.cumulativeBlockGasUsed,
+    contractAddress: receipt.contractAddress?.bytes ?? null,
+    logs: receipt.logs.map((log) => ({
+      address: log[0],
+      topics: log[1],
+      data: log[2],
+    })),
+    status:
+      (receipt as PostByzantiumTxReceipt).status !== undefined
+        ? (receipt as PostByzantiumTxReceipt).status === 0
+          ? false
+          : true
+        : null,
+    authorities: receipt.authorities?.map((auth) => auth.bytes) ?? null,
+  }
+
+  return sszRaw
+}
+
 /**
  * Apply the DAO fork changes to the VM
  */

packages/vm/src/runBlock.ts

@@ -808,6 +808,8 @@ export async function generateTxReceipt(
     cumulativeBlockGasUsed: cumulativeGasUsed,
     bitvector: txResult.bloom.bitvector,
     logs: txResult.execResult.logs ?? [],
+    contractAddress: txResult.createdAddress,
+    authorities: txResult.authorities,
   }
 
   let receipt

packages/vm/src/runTx.ts

@@ -10,6 +10,7 @@ import type {
 } from '@ethereumjs/evm'
 import type { AccessList, TypedTransaction } from '@ethereumjs/tx'
 import type {
+  Address,
   BigIntLike,
   CLRequest,
   CLRequestType,
@@ -34,6 +35,8 @@ export interface BaseTxReceipt {
    * Logs emitted
    */
   logs: Log[]
+  contractAddress?: Address
+  authorities?: Address[]
 }
 
 /**
@@ -488,6 +491,8 @@ export interface RunTxResult extends EVMResult {
    * This is the blob gas units times the fee per blob gas for 4844 transactions
    */
   blobGasUsed?: bigint
+
+  authorities?: Address[]
 }
 
 export interface AfterTxEvent extends RunTxResult {