Replace ethers with viem in vm examples/tests (#4006)

* replace ethers with viem in vm examples/tests

* spellcheck

* chore: upgrade viem

---------

Co-authored-by: Holger Drewes <Holger.Drewes@gmail.com>
Co-authored-by: Gabriel Rocheleau <contact@rockwaterweb.com>
Co-authored-by: Gabriel Rocheleau <18757482+gabrocheleau@users.noreply.github.com>

Author: 3 people

config/cspell-ts.json

@@ -24,6 +24,7 @@
     }
   ],
   "words": [
+    "viem",
     "immediates",
     "unerasable",
     "bytelist",

package-lock.json

@@ -1,37 +1,5 @@
-import { AbiCoder, Interface } from 'ethers' // cspell:disable-line
-
 import type { LegacyTxData } from '@ethereumjs/tx'
 
-export const encodeFunction = (
-  method: string,
-  params?: {
-    types: any[]
-    values: unknown[]
-  },
-): string => {
-  const parameters = params?.types ?? []
-  const methodWithParameters = `function ${method}(${parameters.join(',')})`
-  const signatureHash = new Interface([methodWithParameters]).getFunction(method)?.selector
-  const encodedArgs = new AbiCoder().encode(parameters, params?.values ?? [])
-
-  return signatureHash + encodedArgs.slice(2)
-}
-
-export const encodeDeployment = (
-  bytecode: string,
-  params?: {
-    types: any[]
-    values: unknown[]
-  },
-) => {
-  const deploymentData = '0x' + bytecode
-  if (params) {
-    const argumentsEncoded = new AbiCoder().encode(params.types, params.values)
-    return deploymentData + argumentsEncoded.slice(2)
-  }
-  return deploymentData
-}
-
 export const buildTransaction = (data: Partial<LegacyTxData>): LegacyTxData => {
   const defaultData: Partial<LegacyTxData> = {
     nonce: BigInt(0),

packages/vm/examples/helpers/tx-builder.ts

@@ -6,11 +6,11 @@ import { Common, Hardfork, Mainnet } from '@ethereumjs/common'
 import { createLegacyTx } from '@ethereumjs/tx'
 import { bytesToHex, createAddressFromPrivateKey, hexToBytes } from '@ethereumjs/util'
 import { createVM, runTx } from '@ethereumjs/vm'
-import { AbiCoder, Interface } from 'ethers'
 import solc from 'solc'
+import { decodeAbiParameters, encodeAbiParameters, encodeFunctionData } from 'viem'
 
 import { getAccountNonce, insertAccount } from './helpers/account-utils.ts'
-import { buildTransaction, encodeDeployment, encodeFunction } from './helpers/tx-builder.ts'
+import { buildTransaction } from './helpers/tx-builder.ts'
 
 import type { Address, PrefixedHexString } from '@ethereumjs/util'
 import type { VM } from '@ethereumjs/vm'
@@ -100,10 +100,8 @@ async function deployContract(
   // Contracts are deployed by sending their deployment bytecode to the address 0
   // The contract params should be abi-encoded and appended to the deployment bytecode.
 
-  const data = encodeDeployment(deploymentBytecode, {
-    types: ['string'],
-    values: [greeting],
-  })
+  const data =
+    '0x' + deploymentBytecode + encodeAbiParameters([{ type: 'string' }], [greeting]).slice(2)
   const txData = {
     data,
     nonce: await getAccountNonce(vm, senderPrivateKey),
@@ -126,9 +124,18 @@ async function setGreeting(
   contractAddress: Address,
   greeting: string,
 ) {
-  const data = encodeFunction('setGreeting', {
-    types: ['string'],
-    values: [greeting],
+  const data = encodeFunctionData({
+    abi: [
+      {
+        type: 'function',
+        name: 'setGreeting',
+        inputs: [{ type: 'string' }],
+        outputs: [],
+        stateMutability: 'nonpayable',
+      },
+    ],
+    functionName: 'setGreeting',
+    args: [greeting],
   })
 
   const txData = {
@@ -147,8 +154,18 @@ async function setGreeting(
 }
 
 async function getGreeting(vm: VM, contractAddress: Address, caller: Address) {
-  const sigHash = new Interface(['function greet()']).getFunction('greet')!
-    .selector as PrefixedHexString
+  const sigHash = encodeFunctionData({
+    abi: [
+      {
+        type: 'function',
+        name: 'greet',
+        inputs: [],
+        outputs: [{ type: 'string' }],
+        stateMutability: 'view',
+      },
+    ],
+    functionName: 'greet',
+  })
 
   const greetResult = await vm.evm.runCall({
     to: contractAddress,
@@ -162,7 +179,7 @@ async function getGreeting(vm: VM, contractAddress: Address, caller: Address) {
     throw greetResult.execResult.exceptionError
   }
 
-  const results = new AbiCoder().decode(['string'], greetResult.execResult.returnValue)
+  const results = decodeAbiParameters([{ type: 'string' }], greetResult.execResult.returnValue)
 
   return results[0]
 }

packages/vm/examples/run-solidity-contract.ts

@@ -88,14 +88,14 @@
     "@types/minimist": "^1.2.5",
     "@types/node-dir": "^0.0.37",
     "benchmark": "^2.1.4",
-    "ethers": "^6.13.5",
     "mcl-wasm": "^1.8.0",
     "micro-eth-signer": "^0.15.0",
     "minimist": "^1.2.8",
     "node-dir": "^0.1.17",
     "nyc": "^17.1.0",
     "solc": "^0.8.28",
     "tape": "^5.9.0",
+    "viem": "^2.38.6",
     "yargs": "^17.7.2"
   },
   "engines": {

packages/vm/package.json

@@ -9,7 +9,7 @@ import {
   createAddressFromString,
   hexToBytes,
 } from '@ethereumjs/util'
-import { Interface } from 'ethers'
+import { encodeFunctionData } from 'viem'
 import { assert, describe, it } from 'vitest'
 
 import { createVM, runTx } from '../../src/index.ts'
@@ -96,7 +96,12 @@ describe('VM initialized with custom state', () => {
     common.setHardfork(Hardfork.London)
     const vm = await createVM({ blockchain, common })
     await vm.stateManager.generateCanonicalGenesis!(genesisState)
-    const calldata = new Interface(['function retrieve()']).getFunction('retrieve')!.selector
+    const calldata = encodeFunctionData({
+      abi: [
+        { type: 'function', name: 'retrieve', inputs: [], outputs: [], stateMutability: 'view' },
+      ],
+      functionName: 'retrieve',
+    })
 
     const callResult = await vm.evm.runCall({
       to: createAddressFromString(contractAddress),