Merge pull request #43 from etherspot/arbitrum

0xSulpiride · web-flow · commit c5cec0b4f6e6 · 2023-06-20T13:29:29.000+05:00
Fix issue with the tracer on arbitrum
diff --git a/lerna.json b/lerna.json
@@ -4,7 +4,7 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.0.8",
+  "version": "0.0.9",
   "stream": "true",
   "command": {
     "version": {
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "root",
   "private": true,
-  "version": "0.0.8",
+  "version": "0.0.9",
   "engines": {
       "node": ">=18.0.0"
     },
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "The API module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -35,12 +35,12 @@
     "class-transformer": "0.5.1",
     "class-validator": "0.14.0",
     "ethers": "5.7.2",
-    "executor": "^0.0.8",
+    "executor": "^0.0.9",
     "fastify": "4.14.1",
     "pino": "8.11.0",
     "pino-pretty": "10.0.0",
     "reflect-metadata": "0.1.13",
-    "types": "^0.0.8"
+    "types": "^0.0.9"
   },
   "devDependencies": {
     "@types/connect": "3.4.35"
diff --git a/packages/api/src/server.ts b/packages/api/src/server.ts
@@ -1,7 +1,7 @@
 import fastify, { FastifyInstance } from "fastify";
 import cors from "@fastify/cors";
 import RpcError from "types/lib/api/errors/rpc-error";
-import { ServerConfig } from "types/src/api/interfaces";
+import { ServerConfig } from "types/lib/api/interfaces";
 import logger from "./logger";
 
 export class Server {
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cli",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "> TODO: description",
   "author": "zincoshine <psramanuj@gmail.com>",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -31,13 +31,13 @@
     "url": "https://https://github.com/etherspot/skandha/issues"
   },
   "dependencies": {
-    "api": "^0.0.8",
-    "db": "^0.0.8",
-    "executor": "^0.0.8",
+    "api": "^0.0.9",
+    "db": "^0.0.9",
+    "executor": "^0.0.9",
     "find-up": "5.0.0",
     "got": "12.5.3",
     "js-yaml": "4.1.0",
-    "types": "^0.0.8",
+    "types": "^0.0.9",
     "yargs": "17.6.2"
   },
   "devDependencies": {
diff --git a/packages/db/package.json b/packages/db/package.json
@@ -1,6 +1,6 @@
 {
   "name": "db",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "The DB module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://github.com/etherspot/etherspot-bundler#readme",
@@ -37,6 +37,6 @@
   "devDependencies": {
     "@types/rocksdb": "3.0.1",
     "prettier": "^2.8.4",
-    "types": "^0.0.8"
+    "types": "^0.0.9"
   }
 }
diff --git a/packages/executor/customTracer.js b/packages/executor/customTracer.js
@@ -56,7 +56,9 @@ function tracer() {
       switch (opcode) {
         case 'SLOAD':
         case 'SSTORE':
-          this.pSloadStore(log);
+          if (log.getDepth() !== 1) {
+            this.pSloadStore(log);
+          }
           break;
         case 'REVERT':
         case 'RETURN':
@@ -73,7 +75,9 @@ function tracer() {
           }
           break;
         case 'KECCAK256':
-          this.pKeccak(log);
+          if (log.getDepth() !== 1) {
+            this.pKeccak(log);
+          }
           break;
         case 'NUMBER':
           if (log.getDepth() == 1) {
diff --git a/packages/executor/package.json b/packages/executor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "executor",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "The Relayer module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -33,7 +33,7 @@
   "dependencies": {
     "async-mutex": "0.4.0",
     "ethers": "5.7.2",
-    "params": "^0.0.8",
-    "types": "^0.0.8"
+    "params": "^0.0.9",
+    "types": "^0.0.9"
   }
 }
diff --git a/packages/executor/src/executor.ts b/packages/executor/src/executor.ts
@@ -92,6 +92,7 @@ export class Executor {
       this.reputationService
     );
     this.eth = new Eth(
+      this.network,
       this.provider,
       this.userOpValidationService,
       this.mempoolService,
diff --git a/packages/executor/src/modules/eth.ts b/packages/executor/src/modules/eth.ts
@@ -1,4 +1,4 @@
-import { BigNumber, ethers } from "ethers";
+import { BigNumber, BigNumberish, ethers } from "ethers";
 import { arrayify, hexlify } from "ethers/lib/utils";
 import RpcError from "types/lib/api/errors/rpc-error";
 import * as RpcErrorCodes from "types/lib/api/errors/rpc-error-codes";
@@ -13,6 +13,9 @@ import {
   UserOperationReceipt,
 } from "types/lib/api/interfaces";
 import { EntryPoint__factory } from "types/lib/executor/contracts/factories";
+import { NetworkName } from "types/lib";
+import { estimateArbitrumPVG } from "params/lib/gas-estimation/arbitrum";
+import { IPVGEstimator } from "params/lib/types/IPVGEstimator";
 import { NetworkConfig } from "../config";
 import { deepHexlify, packUserOp } from "../utils";
 import { UserOpValidationService, MempoolService } from "../services";
@@ -23,13 +26,22 @@ import {
 } from "./interfaces";
 
 export class Eth {
+  private pvgEstimator: IPVGEstimator | null = null;
+
   constructor(
+    private networkName: NetworkName,
     private provider: ethers.providers.JsonRpcProvider,
     private userOpValidationService: UserOpValidationService,
     private mempoolService: MempoolService,
     private config: NetworkConfig,
     private logger: Logger
-  ) {}
+  ) {
+    if (
+      ["arbitrum", "arbitrumNitro", "arbitrumNova"].includes(this.networkName)
+    ) {
+      this.pvgEstimator = estimateArbitrumPVG(this.provider);
+    }
+  }
 
   /**
    *
@@ -86,14 +98,21 @@ export class Eth {
       preVerificationGas: 0,
       ...userOp,
     };
-    const preVerificationGas = this.calcPreVerificationGas(userOp);
+    let preVerificationGas: BigNumberish = this.calcPreVerificationGas(userOp);
     userOpComplemented.preVerificationGas = preVerificationGas;
 
     const { returnInfo } =
       await this.userOpValidationService.validateForEstimation(
         userOpComplemented,
         entryPoint
       );
+    if (this.pvgEstimator) {
+      preVerificationGas = await this.pvgEstimator(
+        entryPoint,
+        userOpComplemented,
+        preVerificationGas
+      );
+    }
 
     // eslint-disable-next-line prefer-const
     let { preOpGas, validAfter, validUntil } = returnInfo;
@@ -110,7 +129,7 @@ export class Eth {
           err.message.match(/reason="(.*?)"/)?.at(1) ?? "execution reverted";
         throw new RpcError(message, RpcErrorCodes.EXECUTION_REVERTED);
       });
-    // const preVerificationGas = this.calcPreVerificationGas(userOp);
+
     const verificationGas = BigNumber.from(preOpGas).toNumber();
     validAfter = BigNumber.from(validAfter);
     validUntil = BigNumber.from(validUntil);
diff --git a/packages/executor/src/services/GethTracer.ts b/packages/executor/src/services/GethTracer.ts
@@ -11,6 +11,21 @@ if (tracer == null) {
 const regexp = /function \w+\s*\(\s*\)\s*{\s*return\s*(\{[\s\S]+\});?\s*\}\s*$/;
 const stringifiedTracer = tracer.match(regexp)![1];
 
+// UNCOMMENT FOR DEBUG PURPOSES
+// eslint-disable-next-line no-console
+// console.log(
+//   JSON.stringify(
+//     {
+//       tracer: stringifiedTracer.replace(
+//         /0xffffffffffffffffffffffffffffffffffffffff/g,
+//         "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789"
+//       ),
+//     },
+//     undefined,
+//     2
+//   )
+// );
+
 export class GethTracer {
   constructor(private provider: providers.JsonRpcProvider) {}
 
diff --git a/packages/params/package.json b/packages/params/package.json
@@ -1,6 +1,6 @@
 {
   "name": "params",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Various bundler parameters",
   "author": "Etherspot",
   "homepage": "https://github.com/etherspot/skandha#readme",
@@ -21,7 +21,9 @@
     "url": "https://github.com/etherspot/skandha/issues"
   },
   "dependencies": {
-    "types": "^0.0.8"
+    "types": "^0.0.9",
+    "ethers": "5.7.2",
+    "@arbitrum/sdk": "3.1.4"
   },
   "scripts": {
     "clean": "rm -rf lib && rm -f *.tsbuildinfo",
diff --git a/packages/params/src/eip1559.ts b/packages/params/src/eip1559.ts
@@ -5,4 +5,5 @@ export const chainsWithoutEIP1559: NetworkName[] = [
   "fuseSparknet",
   "bsc",
   "bscTest",
+  "polygonzkevm",
 ];
diff --git a/packages/params/src/gas-estimation/arbitrum.ts b/packages/params/src/gas-estimation/arbitrum.ts
@@ -0,0 +1,45 @@
+import { NodeInterface__factory } from "@arbitrum/sdk/dist/lib/abi/factories/NodeInterface__factory";
+import { NODE_INTERFACE_ADDRESS } from "@arbitrum/sdk/dist/lib/dataEntities/constants";
+import { UserOperationStruct } from "types/lib/executor/contracts/EntryPoint";
+import { BigNumber, BigNumberish, ethers } from "ethers";
+import { EntryPoint__factory } from "types/lib/executor/contracts";
+import { IPVGEstimator, IPVGEstimatorWrapper } from "../types/IPVGEstimator";
+
+export const estimateArbitrumPVG: IPVGEstimatorWrapper = (
+  provider
+): IPVGEstimator => {
+  const nodeInterface = NodeInterface__factory.connect(
+    NODE_INTERFACE_ADDRESS,
+    provider
+  );
+  const dummyWallet = ethers.Wallet.createRandom();
+  return async (
+    entryPointAddr: string,
+    userOp: UserOperationStruct,
+    initial: BigNumberish
+  ): Promise<BigNumber> => {
+    const entryPoint = EntryPoint__factory.connect(entryPointAddr, provider);
+    const handleOpsData = entryPoint.interface.encodeFunctionData("handleOps", [
+      [userOp],
+      dummyWallet.address,
+    ]);
+
+    const contractCreation = BigNumber.from(userOp.nonce).eq(0);
+    try {
+      const gasEstimateComponents =
+        await nodeInterface.callStatic.gasEstimateL1Component(
+          entryPoint.address,
+          contractCreation,
+          handleOpsData
+        );
+      const l1GasEstimated = gasEstimateComponents.gasEstimateForL1;
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      const baseFee = gasEstimateComponents.baseFee;
+      return l1GasEstimated.add(initial);
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.error("Error while estimating arbitrum PVG", err);
+      return BigNumber.from(initial);
+    }
+  };
+};
diff --git a/packages/params/src/types/IPVGEstimator.ts b/packages/params/src/types/IPVGEstimator.ts
@@ -0,0 +1,12 @@
+import { BigNumber, BigNumberish, providers } from "ethers";
+import { UserOperationStruct } from "types/lib/executor/contracts/EntryPoint";
+
+export type IPVGEstimatorWrapper = (
+  provider: providers.StaticJsonRpcProvider
+) => IPVGEstimator;
+
+export type IPVGEstimator = (
+  entryPointAddr: string,
+  userOp: UserOperationStruct,
+  initial: BigNumberish // initial amount of gas. It will be added to the estimated gas
+) => Promise<BigNumber>;
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "types",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "The types of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
diff --git a/packages/types/src/networks/networks.ts b/packages/types/src/networks/networks.ts
@@ -28,7 +28,8 @@ export type NetworkName =
   | "dev"
   | "baseGoerli"
   | "sepolia"
-  | "chiado";
+  | "chiado"
+  | "polygonzkevm";
 
 export const networkNames: NetworkName[] = [
   "mainnet",
@@ -61,6 +62,7 @@ export const networkNames: NetworkName[] = [
   "baseGoerli",
   "sepolia",
   "chiado",
+  "polygonzkevm",
 ];
 
 export const NETWORK_NAME_TO_CHAIN_ID: {
@@ -96,4 +98,5 @@ export const NETWORK_NAME_TO_CHAIN_ID: {
   baseGoerli: 84531,
   sepolia: 11155111,
   chiado: 10200,
+  polygonzkevm: 1442,
 };
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "root",`
`3`	`3`	`"private": true,`
`4`		`- "version": "0.0.8",`
	`4`	`+ "version": "0.0.9",`
`5`	`5`	`"engines": {`
`6`	`6`	`"node": ">=18.0.0"`
`7`	`7`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "db",`
`3`		`- "version": "0.0.8",`
	`3`	`+ "version": "0.0.9",`
`4`	`4`	`"description": "The DB module of Etherspot bundler client",`
`5`	`5`	`"author": "Etherspot",`
`6`	`6`	`"homepage": "https://github.com/etherspot/etherspot-bundler#readme",`
`@@ -37,6 +37,6 @@`
`37`	`37`	`"devDependencies": {`
`38`	`38`	`"@types/rocksdb": "3.0.1",`
`39`	`39`	`"prettier": "^2.8.4",`
`40`		`- "types": "^0.0.8"`
	`40`	`+ "types": "^0.0.9"`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "executor",`
`3`		`- "version": "0.0.8",`
	`3`	`+ "version": "0.0.9",`
`4`	`4`	`"description": "The Relayer module of Etherspot bundler client",`
`5`	`5`	`"author": "Etherspot",`
`6`	`6`	`"homepage": "https://https://github.com/etherspot/skandha#readme",`
`@@ -33,7 +33,7 @@`
`33`	`33`	`"dependencies": {`
`34`	`34`	`"async-mutex": "0.4.0",`
`35`	`35`	`"ethers": "5.7.2",`
`36`		`- "params": "^0.0.8",`
`37`		`- "types": "^0.0.8"`
	`36`	`+ "params": "^0.0.9",`
	`37`	`+ "types": "^0.0.9"`
`38`	`38`	`}`
`39`	`39`	`}`