feat: contract based binary search for call gas limit estimate (#214) (#217)

Co-authored-by: nikhilkumar1612 <[email protected]>

Author: 0xSulpiride

lerna.json

@@ -3,7 +3,7 @@
     "packages/*"
   ],
   "npmClient": "yarn",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "stream": "true",
   "command": {
     "version": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "root",
   "private": true,
-  "version": "2.0.6",
+  "version": "2.0.7",
   "engines": {
     "node": ">=18.0.0"
   },

packages/api/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The API module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -34,10 +34,10 @@
   "dependencies": {
     "@fastify/cors": "9.0.1",
     "@fastify/websocket": "10.0.1",
-    "@skandha/executor": "^2.0.6",
-    "@skandha/monitoring": "^2.0.6",
-    "@skandha/types": "^2.0.6",
-    "@skandha/utils": "^2.0.6",
+    "@skandha/executor": "^2.0.7",
+    "@skandha/monitoring": "^2.0.7",
+    "@skandha/types": "^2.0.7",
+    "@skandha/utils": "^2.0.7",
     "class-transformer": "0.5.1",
     "class-validator": "0.14.1",
     "ethers": "5.7.2",

packages/cli/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "> TODO: description",
   "author": "zincoshine <[email protected]>",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -40,12 +40,12 @@
     "@libp2p/peer-id-factory": "2.0.1",
     "@libp2p/prometheus-metrics": "1.1.3",
     "@multiformats/multiaddr": "12.1.3",
-    "@skandha/api": "^2.0.6",
-    "@skandha/db": "^2.0.6",
-    "@skandha/executor": "^2.0.6",
-    "@skandha/monitoring": "^2.0.6",
-    "@skandha/node": "^2.0.6",
-    "@skandha/types": "^2.0.6",
+    "@skandha/api": "^2.0.7",
+    "@skandha/db": "^2.0.7",
+    "@skandha/executor": "^2.0.7",
+    "@skandha/monitoring": "^2.0.7",
+    "@skandha/node": "^2.0.7",
+    "@skandha/types": "^2.0.7",
     "find-up": "5.0.0",
     "got": "12.5.3",
     "js-yaml": "4.1.0",

packages/db/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The DB module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://github.com/etherspot/etherspot-bundler#readme",
@@ -34,7 +34,7 @@
   "dependencies": {
     "@chainsafe/ssz": "0.10.1",
     "@farcaster/rocksdb": "5.5.0",
-    "@skandha/types": "^2.0.6"
+    "@skandha/types": "^2.0.7"
   },
   "devDependencies": {
     "@types/rocksdb": "3.0.1",

packages/executor/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The Relayer module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -35,10 +35,10 @@
   },
   "dependencies": {
     "@flashbots/ethers-provider-bundle": "0.6.2",
-    "@skandha/monitoring": "^2.0.6",
-    "@skandha/params": "^2.0.6",
-    "@skandha/types": "^2.0.6",
-    "@skandha/utils": "^2.0.6",
+    "@skandha/monitoring": "^2.0.7",
+    "@skandha/params": "^2.0.7",
+    "@skandha/types": "^2.0.7",
+    "@skandha/utils": "^2.0.7",
     "async-mutex": "0.4.0",
     "ethers": "5.7.2",
     "strict-event-emitter-types": "2.0.0",

packages/executor/src/interfaces.ts

@@ -253,3 +253,8 @@ export interface KnownEntities {
   accounts: string[];
   otherEntities: string[];
 }
+
+export interface ExecutionResultAndCallGasLimit {
+  returnInfo: ExecutionResult;
+  callGasLimit: BigNumber;
+}

packages/executor/src/modules/eth.ts

@@ -177,13 +177,15 @@ export class Eth {
       userOp.signature = ECDSA_DUMMY_SIGNATURE;
     }
 
-    const returnInfo = await this.userOpValidationService.validateForEstimation(
-      userOp,
-      entryPoint
-    );
+    // eslint-disable-next-line prefer-const
+    let { returnInfo, callGasLimit } =
+      await this.userOpValidationService.validateForEstimation(
+        userOp,
+        entryPoint
+      );
 
     // eslint-disable-next-line prefer-const
-    let { preOpGas, validAfter, validUntil, paid } = returnInfo;
+    let { preOpGas, validAfter, validUntil } = returnInfo;
 
     const verificationGasLimit = BigNumber.from(preOpGas)
       .sub(userOp.preVerificationGas)
@@ -194,9 +196,7 @@ export class Eth {
 
     // calculate callGasLimit based on paid fee
     const { cglMarkup } = this.config;
-    const totalGas: BigNumber = BigNumber.from(paid).div(userOp.maxFeePerGas);
-    let callGasLimit = totalGas
-      .sub(preOpGas)
+    callGasLimit = callGasLimit
       .mul(10000 + this.config.cglMarkupPercent)
       .div(10000) // % markup
       .add(cglMarkup || 0);

packages/executor/src/services/EntryPointService/constants.ts

@@ -7,3 +7,5 @@ export const DefaultGasOverheads = {
   bundleSize: 1,
   sigSize: 65,
 };
+
+export const IMPLEMENTATION_ADDRESS_MARKER = "0xA13dB4eCfbce0586E57D1AeE224FbE64706E8cd3";

packages/executor/src/services/EntryPointService/utils/decodeRevertReason.ts

@@ -63,6 +63,23 @@ export function decodeRevertReason(
   }
 }
 
+export function decodeTargetData(data: string) {
+  try {
+    const methodSig = data.slice(0, 10);
+    const dataParams = "0x" + data.slice(10);
+    if(methodSig === "0x8c83589a") {
+      const res = ethers.utils.defaultAbiCoder.decode(
+        ["uint256", "uint256"],
+        dataParams
+      );
+      return res;
+    }
+    throw Error("Error decoding target data");
+  } catch (error) {
+    throw error;
+  }
+}
+
 // not sure why ethers fail to decode revert reasons, not even "Error()" (and obviously, not custom errors)
 export function rethrowWithRevertReason(e: Error): never {
   throw new Error(decodeRevertReason(e, false) as any);

packages/executor/src/services/EntryPointService/versions/0.0.7.ts

@@ -23,6 +23,11 @@ import {
   UserOperationByHashResponse,
 } from "@skandha/types/lib/api/interfaces";
 import { deepHexlify } from "@skandha/utils/lib/hexlify";
+import {
+  CallGasEstimationProxy__factory,
+  _deployedBytecode as _callGasEstimationProxyDeployedBytecode,
+} from "@skandha/types/lib/contracts/EPv7/factories/core/CallGasEstimationProxy__factory";
+import { CallGasEstimationProxy } from "@skandha/types/lib/contracts/EPv7/core/CallGasEstimationProxy";
 import {
   encodeUserOp,
   mergeValidationDataValues,
@@ -35,13 +40,20 @@ import {
   StakeInfo,
   UserOpValidationResult,
 } from "../../../interfaces";
-import { DefaultGasOverheads } from "../constants";
+import {
+  DefaultGasOverheads,
+  IMPLEMENTATION_ADDRESS_MARKER,
+} from "../constants";
 import { StateOverrides } from "../interfaces";
-import { decodeRevertReason } from "../utils/decodeRevertReason";
+import {
+  decodeRevertReason,
+  decodeTargetData,
+} from "../utils/decodeRevertReason";
 import { getUserOpGasLimit } from "../../BundlingService/utils";
 import { IEntryPointService } from "./base";
 
 const entryPointSimulations = IEntryPointSimulations__factory.createInterface();
+const callGasEstimateProxy = CallGasEstimationProxy__factory.createInterface();
 
 export class EntryPointV7Service implements IEntryPointService {
   contract: EntryPoint;
@@ -71,10 +83,21 @@ export class EntryPointV7Service implements IEntryPointService {
         )
       : undefined;
 
-    const [data, stateOverrides] = this.encodeSimulateHandleOp(
+    const estimateCallGasArgs: CallGasEstimationProxy.EstimateCallGasArgsStruct =
+      {
+        userOp: packUserOp(userOp),
+        isContinuation: true,
+        maxGas: "20000000",
+        minGas: "21000",
+        rounding: "500",
+      };
+
+    const [data] = this.encodeSimulateHandleOp(
       userOp,
-      AddressZero,
-      BytesZero
+      this.address,
+      callGasEstimateProxy.encodeFunctionData("estimateCallGas", [
+        estimateCallGasArgs,
+      ])
     );
 
     const tx: providers.TransactionRequest = {
@@ -83,6 +106,15 @@ export class EntryPointV7Service implements IEntryPointService {
       gasLimit,
     };
 
+    const stateOverrides: StateOverrides = {
+      [this.address]: {
+        code: _callGasEstimationProxyDeployedBytecode,
+      },
+      [IMPLEMENTATION_ADDRESS_MARKER]: {
+        code: _deployedBytecode,
+      },
+    };
+
     try {
       const simulationResult = await this.provider.send("eth_call", [
         tx,
@@ -93,7 +125,8 @@ export class EntryPointV7Service implements IEntryPointService {
         "simulateHandleOp",
         simulationResult
       );
-      return res[0];
+      const [callGasLimit] = decodeTargetData(res[0].targetResult);
+      return { returnInfo: res[0], callGasLimit: callGasLimit };
     } catch (error: any) {
       console.log(error);
       const err = decodeRevertReason(error);

packages/executor/src/services/UserOpValidation/service.ts

@@ -6,6 +6,7 @@ import { UserOperation } from "@skandha/types/lib/contracts/UserOperation";
 import { Config } from "../../config";
 import {
   ExecutionResult,
+  ExecutionResultAndCallGasLimit,
   NetworkConfig,
   UserOpValidationResult,
 } from "../../interfaces";
@@ -62,7 +63,7 @@ export class UserOpValidationService {
   async validateForEstimation(
     userOp: UserOperation,
     entryPoint: string
-  ): Promise<ExecutionResult> {
+  ): Promise<ExecutionResultAndCallGasLimit> {
     return await this.estimationService.estimateUserOp(userOp, entryPoint);
   }
 

packages/executor/src/services/UserOpValidation/validators/estimation.ts

@@ -1,7 +1,7 @@
 import { providers } from "ethers";
 import { Logger } from "@skandha/types/lib";
 import { UserOperation } from "@skandha/types/lib/contracts/UserOperation";
-import { ExecutionResult } from "../../../interfaces";
+import { ExecutionResultAndCallGasLimit } from "../../../interfaces";
 import { EntryPointService } from "../../EntryPointService";
 import { mergeValidationDataValues } from "../../EntryPointService/utils";
 
@@ -15,22 +15,23 @@ export class EstimationService {
   async estimateUserOp(
     userOp: UserOperation,
     entryPoint: string
-  ): Promise<ExecutionResult> {
-    const returnInfo = await this.entryPointService.simulateHandleOp(
-      entryPoint,
-      userOp
-    );
+  ): Promise<ExecutionResultAndCallGasLimit> {
+    const { returnInfo, callGasLimit } =
+      await this.entryPointService.simulateHandleOp(entryPoint, userOp);
     const { validAfter, validUntil } = mergeValidationDataValues(
       returnInfo.accountValidationData,
       returnInfo.paymasterValidationData
     );
     return {
-      preOpGas: returnInfo.preOpGas,
-      paid: returnInfo.paid,
-      validAfter: validAfter,
-      validUntil: validUntil,
-      targetSuccess: returnInfo.targetSuccess,
-      targetResult: returnInfo.targetResult,
+      returnInfo: {
+        preOpGas: returnInfo.preOpGas,
+        paid: returnInfo.paid,
+        validAfter: validAfter,
+        validUntil: validUntil,
+        targetSuccess: returnInfo.targetSuccess,
+        targetResult: returnInfo.targetResult,
+      },
+      callGasLimit,
     };
   }
 }

packages/monitoring/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The Monitoring module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://github.com/etherspot/etherspot-bundler#readme",
@@ -32,7 +32,7 @@
     "check-readme": "typescript-docs-verifier"
   },
   "dependencies": {
-    "@skandha/types": "^2.0.6",
+    "@skandha/types": "^2.0.7",
     "prom-client": "15.1.0"
   }
 }

packages/node/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The bundler node module of Etherspot bundler client",
   "author": "Etherspot",
   "homepage": "https://https://github.com/etherspot/skandha#readme",
@@ -56,13 +56,13 @@
     "@libp2p/prometheus-metrics": "1.1.3",
     "@libp2p/tcp": "6.1.0",
     "@multiformats/multiaddr": "11.4.0",
-    "@skandha/api": "^2.0.6",
-    "@skandha/db": "^2.0.6",
-    "@skandha/executor": "^2.0.6",
-    "@skandha/monitoring": "^2.0.6",
-    "@skandha/params": "^2.0.6",
-    "@skandha/types": "^2.0.6",
-    "@skandha/utils": "^2.0.6",
+    "@skandha/api": "^2.0.7",
+    "@skandha/db": "^2.0.7",
+    "@skandha/executor": "^2.0.7",
+    "@skandha/monitoring": "^2.0.7",
+    "@skandha/params": "^2.0.7",
+    "@skandha/types": "^2.0.7",
+    "@skandha/utils": "^2.0.7",
     "abstract-leveldown": "7.2.0",
     "datastore-core": "8.0.1",
     "ethers": "5.7.2",

packages/params/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "Various bundler parameters",
   "author": "Etherspot",
   "homepage": "https://github.com/etherspot/skandha#readme",
@@ -28,8 +28,8 @@
     "@arbitrum/sdk": "3.1.4",
     "@chainsafe/ssz": "0.10.1",
     "@mantleio/sdk": "0.2.1",
-    "@skandha/types": "^2.0.6",
-    "@skandha/utils": "^2.0.6",
+    "@skandha/types": "^2.0.7",
+    "@skandha/utils": "^2.0.7",
     "ethers": "5.7.2"
   },
   "scripts": {