Optimise binary search for verificationGasLimit (#270)

Author: hazim-j

e2e/config.ts

@@ -4,6 +4,7 @@ interface IConfig {
   bundlerUrl: string;
   testERC20Token: string;
   testGas: string;
+  testAccount: string;
 }
 
 const config: IConfig = {
@@ -12,9 +13,11 @@ const config: IConfig = {
     "c6cbc5ffad570fdad0544d1b5358a36edeb98d163b6567912ac4754e144d4edb",
   nodeUrl: "http://localhost:8545",
   bundlerUrl: "http://localhost:4337",
+
+  // https://github.com/stackup-wallet/contracts/blob/main/contracts/test
   testERC20Token: "0x3870419Ba2BBf0127060bCB37f69A1b1C090992B",
-  // https://github.com/stackup-wallet/contracts/blob/main/contracts/test/TestGas.sol
   testGas: "0xc2e76Ee793a194Dd930C18c4cDeC93E7C75d567C",
+  testAccount: "0x3dFD39F2c17625b301ae0EF72B411D1de5211325",
 };
 
 export default config;

e2e/jest.config.ts

@@ -4,6 +4,7 @@ const config: Config = {
   verbose: true,
   preset: "ts-jest",
   testEnvironment: "node",
+  globalSetup: "./setup.ts",
 };
 
 export default config;

e2e/package.json

@@ -9,11 +9,11 @@
     "lint:fix": "eslint . --fix",
     "prettier": "prettier --check --ignore-path ./.eslintignore '**'",
     "prettier:fix": "prettier --write --ignore-path ./.eslintignore '**'",
-    "test": "jest"
+    "test": "jest --runInBand"
   },
   "dependencies": {
     "ethers": "^5.7.2",
-    "userop": "^0.3.0"
+    "userop": "^0.3.3"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",

e2e/setup.ts

@@ -0,0 +1,23 @@
+import { ethers } from "ethers";
+import { Presets } from "userop";
+import { erc20ABI } from "./src/abi";
+import { fundIfRequired } from "./src/helpers";
+import config from "./config";
+
+export default async function () {
+  const provider = new ethers.providers.JsonRpcProvider(config.nodeUrl);
+  const signer = new ethers.Wallet(config.signingKey);
+  const testToken = new ethers.Contract(
+    config.testERC20Token,
+    erc20ABI,
+    provider
+  );
+  const acc = await Presets.Builder.SimpleAccount.init(signer, config.nodeUrl);
+  await fundIfRequired(
+    provider,
+    testToken,
+    await signer.getAddress(),
+    acc.getSender(),
+    config.testAccount
+  );
+}

e2e/src/abi.ts

@@ -184,3 +184,166 @@ export const testGasABI = [
     type: "function",
   },
 ];
+
+export const testAccountABI = [
+  {
+    stateMutability: "payable",
+    type: "fallback",
+  },
+  {
+    inputs: [],
+    name: "offset",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "uint256",
+        name: "depth",
+        type: "uint256",
+      },
+      {
+        internalType: "uint256",
+        name: "width",
+        type: "uint256",
+      },
+      {
+        internalType: "uint256",
+        name: "discount",
+        type: "uint256",
+      },
+      {
+        internalType: "uint256",
+        name: "count",
+        type: "uint256",
+      },
+    ],
+    name: "recursiveCall",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    name: "store",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: "address",
+            name: "sender",
+            type: "address",
+          },
+          {
+            internalType: "uint256",
+            name: "nonce",
+            type: "uint256",
+          },
+          {
+            internalType: "bytes",
+            name: "initCode",
+            type: "bytes",
+          },
+          {
+            internalType: "bytes",
+            name: "callData",
+            type: "bytes",
+          },
+          {
+            internalType: "uint256",
+            name: "callGasLimit",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "verificationGasLimit",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "preVerificationGas",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "maxFeePerGas",
+            type: "uint256",
+          },
+          {
+            internalType: "uint256",
+            name: "maxPriorityFeePerGas",
+            type: "uint256",
+          },
+          {
+            internalType: "bytes",
+            name: "paymasterAndData",
+            type: "bytes",
+          },
+          {
+            internalType: "bytes",
+            name: "signature",
+            type: "bytes",
+          },
+        ],
+        internalType: "struct UserOperation",
+        name: "userOp",
+        type: "tuple",
+      },
+      {
+        internalType: "bytes32",
+        name: "",
+        type: "bytes32",
+      },
+      {
+        internalType: "uint256",
+        name: "missingAccountFunds",
+        type: "uint256",
+      },
+    ],
+    name: "validateUserOp",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "validationData",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    stateMutability: "payable",
+    type: "receive",
+  },
+];

e2e/src/helpers.ts

@@ -5,15 +5,21 @@ export const fundIfRequired = async (
   provider: ethers.providers.JsonRpcProvider,
   token: ethers.Contract,
   bundler: string,
-  account: string
+  account: string,
+  testAccount: string
 ) => {
   const signer = provider.getSigner(0);
-  const [bundlerBalance, accountBalance, accountTokenBalance] =
-    await Promise.all([
-      provider.getBalance(bundler),
-      provider.getBalance(account),
-      token.balanceOf(account) as ethers.BigNumber,
-    ]);
+  const [
+    bundlerBalance,
+    accountBalance,
+    testAccountBalance,
+    accountTokenBalance,
+  ] = await Promise.all([
+    provider.getBalance(bundler),
+    provider.getBalance(account),
+    provider.getBalance(testAccount),
+    token.balanceOf(account) as ethers.BigNumber,
+  ]);
 
   if (bundlerBalance.eq(0)) {
     const response = await signer.sendTransaction({
@@ -33,6 +39,15 @@ export const fundIfRequired = async (
     console.log("Funded Account with 2 ETH...");
   }
 
+  if (testAccountBalance.eq(0)) {
+    const response = await signer.sendTransaction({
+      to: testAccount,
+      value: ethers.constants.WeiPerEther.mul(2),
+    });
+    await response.wait();
+    console.log("Funded Test Account with 2 ETH...");
+  }
+
   if (accountTokenBalance.eq(0)) {
     const response = await signer.sendTransaction({
       to: token.address,

e2e/src/testAccount.ts

@@ -0,0 +1,67 @@
+import { ethers } from "ethers";
+import {
+  Constants,
+  Presets,
+  UserOperationBuilder,
+  BundlerJsonRpcProvider,
+  IPresetBuilderOpts,
+  UserOperationMiddlewareFn,
+} from "userop";
+import { EntryPoint, EntryPoint__factory } from "userop/dist/typechain";
+import { testAccountABI } from "./abi";
+
+const RECURSIVE_CALL_MODE = "0x0001";
+
+export class TestAccount extends UserOperationBuilder {
+  private provider: ethers.providers.JsonRpcProvider;
+  private entryPoint: EntryPoint;
+  private account: ethers.Contract;
+
+  private constructor(
+    address: string,
+    rpcUrl: string,
+    opts?: IPresetBuilderOpts
+  ) {
+    super();
+    this.provider = new BundlerJsonRpcProvider(rpcUrl).setBundlerRpc(
+      opts?.overrideBundlerRpc
+    );
+    this.entryPoint = EntryPoint__factory.connect(
+      opts?.entryPoint || Constants.ERC4337.EntryPoint,
+      this.provider
+    );
+    this.account = new ethers.Contract(address, testAccountABI, this.provider);
+  }
+
+  private resolveAccount: UserOperationMiddlewareFn = async (ctx) => {
+    ctx.op.nonce = await this.entryPoint.getNonce(ctx.op.sender, 0);
+  };
+
+  public static async init(
+    address: string,
+    rpcUrl: string,
+    opts?: IPresetBuilderOpts
+  ): Promise<TestAccount> {
+    const instance = new TestAccount(address, rpcUrl, opts);
+
+    const base = instance
+      .useDefaults({ sender: instance.account.address })
+      .useMiddleware(instance.resolveAccount)
+      .useMiddleware(Presets.Middleware.getGasPrice(instance.provider));
+
+    return opts?.paymasterMiddleware
+      ? base.useMiddleware(opts.paymasterMiddleware)
+      : base.useMiddleware(
+          Presets.Middleware.estimateUserOperationGas(instance.provider)
+        );
+  }
+
+  recursiveCall(depth: number, width: number, discount: number) {
+    return this.setCallData(
+      ethers.utils.defaultAbiCoder.encode(
+        ["uint256", "uint256", "uint256"],
+        [depth, width, discount]
+      )
+    ).setSignature(RECURSIVE_CALL_MODE);
+  }
+}

e2e/test/withoutPaymaster.test.ts renamed to e2e/test/execution.test.ts

@@ -1,6 +1,6 @@
 import { ethers } from "ethers";
 import { Presets, Client, ISendUserOperationOpts } from "userop";
-import { fundIfRequired, getCallGasLimitBenchmark } from "../src/helpers";
+import { getCallGasLimitBenchmark } from "../src/helpers";
 import { erc20ABI, testGasABI } from "../src/abi";
 import { errorCodes } from "../src/errors";
 import config from "../config";
@@ -28,7 +28,7 @@ const opCheckDeep = (benchmark: number): ISendUserOperationOpts => ({
   },
 });
 
-describe("Without Paymaster", () => {
+describe("During the execution phase", () => {
   const provider = new ethers.providers.JsonRpcProvider(config.nodeUrl);
   const signer = new ethers.Wallet(config.signingKey);
   const testToken = new ethers.Contract(
@@ -48,12 +48,6 @@ describe("Without Paymaster", () => {
     acc = await Presets.Builder.SimpleAccount.init(signer, config.nodeUrl, {
       overrideBundlerRpc: config.bundlerUrl,
     });
-    await fundIfRequired(
-      provider,
-      testToken,
-      await signer.getAddress(),
-      acc.getSender()
-    );
   });
 
   test("Sender can transfer 0 ETH", async () => {