Merge pull request #51 from etherspot/simulateHandleOp

0xSulpiride · web-flow · commit 01dd1ab90c30 · 2023-07-18T15:45:37.000+05:00
Simulate handle op
diff --git a/lerna.json b/lerna.json
@@ -4,7 +4,7 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.0.15",
+  "version": "0.0.16",
   "stream": "true",
   "command": {
     "version": {
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "root",
   "private": true,
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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.15",
+  "version": "0.0.16",
   "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.15",
+    "executor": "^0.0.16",
     "fastify": "4.14.1",
     "pino": "8.11.0",
     "pino-pretty": "10.0.0",
     "reflect-metadata": "0.1.13",
-    "types": "^0.0.15"
+    "types": "^0.0.16"
   },
   "devDependencies": {
     "@types/connect": "3.4.35"
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cli",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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.15",
-    "db": "^0.0.15",
-    "executor": "^0.0.15",
+    "api": "^0.0.16",
+    "db": "^0.0.16",
+    "executor": "^0.0.16",
     "find-up": "5.0.0",
     "got": "12.5.3",
     "js-yaml": "4.1.0",
-    "types": "^0.0.15",
+    "types": "^0.0.16",
     "yargs": "17.6.2"
   },
   "devDependencies": {
diff --git a/packages/cli/src/cmds/start/handler.ts b/packages/cli/src/cmds/start/handler.ts
@@ -10,7 +10,7 @@ import {
   RocksDbController,
   LocalDbController,
 } from "db/lib";
-import { ConfigOptions } from "executor/lib/config";
+import { ConfigOptions } from "executor/lib/interfaces";
 import { IDbController } from "types/lib";
 import { mkdir, readFile } from "../../util";
 import { IGlobalArgs } from "../../options";
diff --git a/packages/db/package.json b/packages/db/package.json
@@ -1,6 +1,6 @@
 {
   "name": "db",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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.15"
+    "types": "^0.0.16"
   }
 }
diff --git a/packages/executor/package.json b/packages/executor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "executor",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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.15",
-    "types": "^0.0.15"
+    "params": "^0.0.16",
+    "types": "^0.0.16"
   }
 }
diff --git a/packages/executor/src/config.ts b/packages/executor/src/config.ts
@@ -1,34 +1,12 @@
 // TODO: create a new package "config" instead of this file
 import { NetworkName } from "types/lib";
-import { BigNumberish, Wallet, providers, utils } from "ethers";
-
-export interface NetworkConfig {
-  entryPoints: string[];
-  relayer: string;
-  beneficiary: string;
-  name?: NetworkName;
-  rpcEndpoint: string;
-  minInclusionDenominator: number;
-  throttlingSlack: number;
-  banSlack: number;
-  minSignerBalance: BigNumberish;
-  multicall: string;
-}
-
-export type BundlerConfig = Omit<
+import { Wallet, providers, utils } from "ethers";
+import {
+  BundlerConfig,
+  ConfigOptions,
   NetworkConfig,
-  "entryPoints" | "rpcEndpoint" | "relayer" | "beneficiary"
->;
-
-export type Networks = {
-  [network in NetworkName]?: NetworkConfig;
-};
-
-export interface ConfigOptions {
-  networks: Networks;
-  testingMode?: boolean;
-  unsafeMode: boolean;
-}
+  Networks,
+} from "./interfaces";
 
 export class Config {
   supportedNetworks: NetworkName[];
@@ -131,6 +109,9 @@ const bundlerDefaultConfigs: BundlerConfig = {
   banSlack: 10,
   minSignerBalance: utils.parseEther("0.1"),
   multicall: "0xcA11bde05977b3631167028862bE2a173976CA11", // default multicall address
+  estimationBaseFeeDivisor: 25,
+  estimationStaticBuffer: 21000,
+  validationGasLimit: 10e6,
 };
 
 const RELAYER_ENV = (network: NetworkName): string | undefined =>
diff --git a/packages/executor/src/executor.ts b/packages/executor/src/executor.ts
@@ -2,7 +2,7 @@
 import { BigNumber, providers } from "ethers";
 import { NETWORK_NAME_TO_CHAIN_ID, NetworkName } from "types/lib";
 import { IDbController } from "types/lib";
-import { NetworkConfig } from "./config";
+import { NetworkConfig } from "./interfaces";
 import { Web3, Debug, Eth } from "./modules";
 import {
   MempoolService,
diff --git a/packages/executor/src/interfaces.ts b/packages/executor/src/interfaces.ts
@@ -1,4 +1,5 @@
 import { BigNumberish, BytesLike } from "ethers";
+import { NetworkName } from "types/lib";
 
 export interface Log {
   blockNumber: number;
@@ -85,3 +86,40 @@ export interface Logger {
   trace: LogFn;
   silent: LogFn;
 }
+
+export interface NetworkConfig {
+  entryPoints: string[];
+  relayer: string;
+  beneficiary: string;
+  name?: NetworkName;
+  rpcEndpoint: string;
+  minInclusionDenominator: number;
+  throttlingSlack: number;
+  banSlack: number;
+  minSignerBalance: BigNumberish;
+  multicall: string;
+  // reduces baseFee by a given number in % before dividing paid gas
+  // use this as a buffer to callGasLimit
+  // 25% by default
+  estimationBaseFeeDivisor: number;
+  // adds certain amount of gas to callGasLimit
+  // 21000 by default
+  estimationStaticBuffer: number;
+  // gas limit during simulateHandleOps and simulateValidation calls
+  validationGasLimit: number;
+}
+
+export type BundlerConfig = Omit<
+  NetworkConfig,
+  "entryPoints" | "rpcEndpoint" | "relayer" | "beneficiary"
+>;
+
+export type Networks = {
+  [network in NetworkName]?: NetworkConfig;
+};
+
+export interface ConfigOptions {
+  networks: Networks;
+  testingMode?: boolean;
+  unsafeMode: boolean;
+}
diff --git a/packages/executor/src/modules/eth.ts b/packages/executor/src/modules/eth.ts
@@ -16,8 +16,8 @@ import { EntryPoint__factory } from "types/lib/executor/contracts/factories";
 import { NetworkName } from "types/lib";
 import { IPVGEstimator } from "params/lib/types/IPVGEstimator";
 import { estimateOptimismPVG, estimateArbitrumPVG } from "params/lib";
-import { NetworkConfig } from "../config";
-import { deepHexlify, packUserOp } from "../utils";
+import { NetworkConfig } from "../interfaces";
+import { deepHexlify, getUserOpHash, packUserOp } from "../utils";
 import { UserOpValidationService, MempoolService } from "../services";
 import { Logger, Log } from "../interfaces";
 import {
@@ -94,6 +94,21 @@ export class Eth {
     if (!this.validateEntryPoint(entryPoint)) {
       throw new RpcError("Invalid Entrypoint", RpcErrorCodes.INVALID_REQUEST);
     }
+
+    //< checking for execution revert
+    await this.provider
+      .estimateGas({
+        from: entryPoint,
+        to: userOp.sender,
+        data: userOp.callData,
+      })
+      .catch((err) => {
+        const message =
+          err.message.match(/reason="(.*?)"/)?.at(1) ?? "execution reverted";
+        throw new RpcError(message, RpcErrorCodes.EXECUTION_REVERTED);
+      });
+    //>
+
     const userOpComplemented: UserOperationStruct = {
       paymasterAndData: userOp.paymasterAndData ?? "0x",
       verificationGasLimit: 10e6,
@@ -102,14 +117,21 @@ export class Eth {
       preVerificationGas: 0,
       ...userOp,
     };
+
+    if (userOpComplemented.signature === "0x") {
+      userOpComplemented.signature = await this.getDummySignature({
+        userOp: userOpComplemented,
+        entryPoint: args.entryPoint,
+      });
+    }
+
     let preVerificationGas: BigNumberish = this.calcPreVerificationGas(userOp);
     userOpComplemented.preVerificationGas = preVerificationGas;
 
-    const { returnInfo } =
-      await this.userOpValidationService.validateForEstimation(
-        userOpComplemented,
-        entryPoint
-      );
+    const returnInfo = await this.userOpValidationService.validateForEstimation(
+      userOpComplemented,
+      entryPoint
+    );
     if (this.pvgEstimator) {
       preVerificationGas = await this.pvgEstimator(
         entryPoint,
@@ -119,20 +141,29 @@ export class Eth {
     }
 
     // eslint-disable-next-line prefer-const
-    let { preOpGas, validAfter, validUntil } = returnInfo;
+    let { preOpGas, validAfter, validUntil, paid } = returnInfo;
 
-    const callGasLimit = await this.provider
-      .estimateGas({
-        from: entryPoint,
-        to: userOp.sender,
-        data: userOp.callData,
-      })
-      .then((b) => b.toNumber())
-      .catch((err) => {
-        const message =
-          err.message.match(/reason="(.*?)"/)?.at(1) ?? "execution reverted";
-        throw new RpcError(message, RpcErrorCodes.EXECUTION_REVERTED);
-      });
+    const block = await this.provider.getBlock("latest");
+
+    const { estimationBaseFeeDivisor, estimationStaticBuffer } = this.config;
+    const estimatedBaseFee = block.baseFeePerGas
+      ?.mul(100)
+      .div(100 + (estimationBaseFeeDivisor || 0));
+
+    let callGasLimit: BigNumber;
+    if (!estimatedBaseFee) {
+      callGasLimit = BigNumber.from(paid).div(userOpComplemented.maxFeePerGas);
+    } else {
+      const lhs = BigNumber.from(userOpComplemented.maxFeePerGas);
+      const rhs = estimatedBaseFee.add(userOpComplemented.maxPriorityFeePerGas);
+      const divisor = lhs.lt(rhs) ? lhs : rhs; // min(maxFeePerGas, base + priorityFee)
+      callGasLimit = BigNumber.from(paid).div(divisor);
+    }
+    callGasLimit = callGasLimit.sub(preOpGas).add(estimationStaticBuffer || 0);
+
+    if (callGasLimit.lt(0)) {
+      callGasLimit = BigNumber.from(estimationStaticBuffer || 0);
+    }
 
     const verificationGas = BigNumber.from(preOpGas).toNumber();
     validAfter = BigNumber.from(validAfter);
@@ -143,6 +174,7 @@ export class Eth {
     if (validAfter === BigNumber.from(0)) {
       validAfter = undefined;
     }
+
     return {
       preVerificationGas,
       verificationGas,
@@ -279,6 +311,15 @@ export class Eth {
     });
   }
 
+  async getDummySignature(args: SendUserOperationGasArgs): Promise<string> {
+    const randomWallet = ethers.Wallet.createRandom();
+    const chainId = await this.getChainId();
+    const dummySignature = randomWallet.signMessage(
+      getUserOpHash(args.userOp, args.entryPoint, chainId)
+    );
+    return dummySignature;
+  }
+
   /**
    * eth_chainId
    * @returns EIP-155 Chain ID.
diff --git a/packages/executor/src/services/UserOpValidation.ts b/packages/executor/src/services/UserOpValidation.ts
diff --git a/packages/params/package.json b/packages/params/package.json
diff --git a/packages/params/src/constants.ts b/packages/params/src/constants.ts
diff --git a/packages/params/src/index.ts b/packages/params/src/index.ts
diff --git a/packages/types/package.json b/packages/types/package.json

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.15",`
	`4`	`+ "version": "0.0.16",`
`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.15",`
	`3`	`+ "version": "0.0.16",`
`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.15"`
	`40`	`+ "types": "^0.0.16"`
`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.15",`
	`3`	`+ "version": "0.0.16",`
`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.15",`
`37`		`- "types": "^0.0.15"`
	`36`	`+ "params": "^0.0.16",`
	`37`	`+ "types": "^0.0.16"`
`38`	`38`	`}`
`39`	`39`	`}`