Fix/improve-gas-estimates (#395)

* remove padding * run binary search with initialMinGas * remove console.log * increase initial min gas to 9000 * increase gasAllowance to 30M * set to 20M * continue to pad for v0.6 * set gas allowance to 30M * fix bug where reverts are not caught --------- Co-authored-by: mouseless <[email protected]>
pimlicolabs · Jan 9, 2025 · 4c8e46e · 4c8e46e
1 parent 1124a21
commit 4c8e46e
Show file tree

Hide file tree

Showing 7 changed files with 2,878 additions and 2,588 deletions.
diff --git a/src/cli/config/options.ts b/src/cli/config/options.ts
@@ -221,7 +221,7 @@ export const gasEstimationOptions: CliCommandOptions<IGasEstimationArgsInput> =
                 "Added to the initial minimum gas to determine the upper bound of the binary search",
             type: "string",
             require: false,
-            default: "1000000"
+            default: "30000000"
         },
         "call-gas-limit-multiplier": {
             description:

diff --git a/src/cli/deploySimulationsContract.ts b/src/cli/deploySimulationsContract.ts
@@ -1,7 +1,7 @@
 import {
     DETERMINISTIC_DEPLOYER_TRANSACTION,
-    ENTRY_POINT_SIMULATIONS_CREATECALL,
-    PimlicoEntryPointSimulationsDeployBytecode
+    pimlicoEntrypointSimulationsDeployBytecode,
+    pimlicoEntrypointSimulationsSalt
 } from "@alto/types"
 import {
     type Chain,
@@ -10,7 +10,8 @@ import {
     type Hex,
     http,
     type PublicClient,
-    type Transport
+    type Transport,
+    concat
 } from "viem"
 import type { CamelCasedProperties } from "./parseArgs"
 import type { IOptions } from "@alto/cli"
@@ -72,9 +73,9 @@ export const deploySimulationsContract = async ({
 
     const contractAddress = getContractAddress({
         opcode: "CREATE2",
-        bytecode: PimlicoEntryPointSimulationsDeployBytecode,
-        from: args.deterministicDeployerAddress,
-        salt: "0x3132333400000000000000000000000000000000000000000000000000000000" as Hex
+        bytecode: pimlicoEntrypointSimulationsDeployBytecode,
+        salt: pimlicoEntrypointSimulationsSalt,
+        from: args.deterministicDeployerAddress
     })
 
     if (await isContractDeployed({ publicClient, address: contractAddress })) {
@@ -84,7 +85,10 @@ export const deploySimulationsContract = async ({
     const deployHash = await walletClient.sendTransaction({
         chain: publicClient.chain,
         to: args.deterministicDeployerAddress,
-        data: ENTRY_POINT_SIMULATIONS_CREATECALL
+        data: concat([
+            pimlicoEntrypointSimulationsSalt,
+            pimlicoEntrypointSimulationsDeployBytecode
+        ])
     })
 
     await publicClient.waitForTransactionReceipt({

diff --git a/src/rpc/estimation/gasEstimationsV07.ts b/src/rpc/estimation/gasEstimationsV07.ts
@@ -159,7 +159,7 @@ export class GasEstimatorV07 {
         functionName:
             | "binarySearchPaymasterVerificationGasLimit"
             | "binarySearchVerificationGasLimit"
-            | "simulateCallData"
+            | "binarySearchCallGasLimit"
     }): Hex {
         const queuedOps = queuedUserOperations.map((op) => ({
             op: toPackedUserOperation(op),
@@ -215,7 +215,7 @@ export class GasEstimatorV07 {
         functionName:
             | "binarySearchPaymasterVerificationGasLimit"
             | "binarySearchVerificationGasLimit"
-            | "simulateCallData"
+            | "binarySearchCallGasLimit"
         stateOverrides?: StateOverrides | undefined
         authorizationList?: SignedAuthorizationList
     }): Promise<SimulateBinarySearchRetryResult> {
@@ -228,7 +228,7 @@ export class GasEstimatorV07 {
             // OptimalGas represents the current lowest gasLimit, so we set the gasAllowance to search range minGas <-> optimalGas
             const gasAllowance = currentOptimalGas - currentMinGas
 
-            const simulateCallData = this.encodeBinarySearchGasLimit({
+            const binarySearchCallGasLimit = this.encodeBinarySearchGasLimit({
                 entryPoint,
                 userOperation: targetOp,
                 target,
@@ -241,7 +241,7 @@ export class GasEstimatorV07 {
 
             let cause = await this.callPimlicoEntryPointSimulations({
                 entryPoint,
-                entryPointSimulationsCallData: [simulateCallData],
+                entryPointSimulationsCallData: [binarySearchCallGasLimit],
                 stateOverrides,
                 authorizationList
             })
@@ -258,26 +258,26 @@ export class GasEstimatorV07 {
                 return decodedDelegateAndError.args[1] as Hex
             })
 
-            const simulateCallDataResult = validateBinarySearchDataResult(
+            const callGasLimitResult = validateBinarySearchDataResult(
                 cause[0],
                 functionName
             )
 
-            if (simulateCallDataResult.result === "failed") {
-                return simulateCallDataResult
+            if (callGasLimitResult.result === "failed") {
+                return callGasLimitResult
             }
 
-            if (simulateCallDataResult.result === "retry") {
-                currentOptimalGas = simulateCallDataResult.optimalGas
-                currentMinGas = simulateCallDataResult.minGas
+            if (callGasLimitResult.result === "retry") {
+                currentOptimalGas = callGasLimitResult.optimalGas
+                currentMinGas = callGasLimitResult.minGas
                 retryCount++
                 continue
             }
 
             // If we reach here, it means we have a successful result
             return {
                 result: "success",
-                data: simulateCallDataResult.data
+                data: callGasLimitResult.data
             }
         }
 
@@ -310,6 +310,7 @@ export class GasEstimatorV07 {
 
         const binarySearchVerificationGasLimit =
             this.encodeBinarySearchGasLimit({
+                initialMinGas: 9_000n,
                 entryPoint,
                 userOperation,
                 queuedUserOperations,
@@ -321,6 +322,7 @@ export class GasEstimatorV07 {
         const binarySearchPaymasterVerificationGasLimit =
             userOperation.paymaster
                 ? this.encodeBinarySearchGasLimit({
+                      initialMinGas: 9_000n,
                       entryPoint,
                       userOperation,
                       queuedUserOperations,
@@ -330,7 +332,8 @@ export class GasEstimatorV07 {
                   })
                 : null
 
-        const simulateCallData = this.encodeBinarySearchGasLimit({
+        const binarySearchCallGasLimit = this.encodeBinarySearchGasLimit({
+            initialMinGas: 9_000n,
             entryPoint,
             userOperation,
             queuedUserOperations,
@@ -339,7 +342,7 @@ export class GasEstimatorV07 {
                 op: userOperation,
                 entryPoint
             }),
-            functionName: "simulateCallData"
+            functionName: "binarySearchCallGasLimit"
         })
 
         let cause: readonly [Hex, Hex, Hex | null, Hex]
@@ -350,7 +353,7 @@ export class GasEstimatorV07 {
                 simulateHandleOpLastCause,
                 binarySearchVerificationGasLimitCause,
                 binarySearchPaymasterVerificationGasLimitCause,
-                simulateCallDataCause
+                binarySearchCallGasLimitCause
             ] = await Promise.all([
                 this.callPimlicoEntryPointSimulations({
                     entryPoint,
@@ -378,7 +381,7 @@ export class GasEstimatorV07 {
                     : null,
                 this.callPimlicoEntryPointSimulations({
                     entryPoint,
-                    entryPointSimulationsCallData: [simulateCallData],
+                    entryPointSimulationsCallData: [binarySearchCallGasLimit],
                     stateOverrides,
                     authorizationList
                 })
@@ -388,7 +391,7 @@ export class GasEstimatorV07 {
                 simulateHandleOpLastCause[0],
                 binarySearchVerificationGasLimitCause[0],
                 binarySearchPaymasterVerificationGasLimitCause?.[0] ?? null,
-                simulateCallDataCause[0]
+                binarySearchCallGasLimitCause[0]
             ]
         } else {
             const [
@@ -417,7 +420,7 @@ export class GasEstimatorV07 {
                       }),
                 await this.callPimlicoEntryPointSimulations({
                     entryPoint,
-                    entryPointSimulationsCallData: [simulateCallData],
+                    entryPointSimulationsCallData: [binarySearchCallGasLimit],
                     stateOverrides,
                     authorizationList
                 })
@@ -456,7 +459,7 @@ export class GasEstimatorV07 {
             simulateHandleOpLastCause,
             binarySearchVerificationGasLimitCause,
             binarySearchPaymasterVerificationGasLimitCause,
-            simulateCallDataCause
+            binarySearchCallGasLimitCause
         ] = cause
 
         try {
@@ -468,26 +471,23 @@ export class GasEstimatorV07 {
                 return simulateHandleOpLastResult as SimulateHandleOpResult<"failed">
             }
 
-            const binarySearchVerificationGasLimitResult =
-                validateBinarySearchDataResult(
-                    binarySearchVerificationGasLimitCause,
-                    "binarySearchVerificationGasLimit"
-                )
+            const verificationGasLimitResult = validateBinarySearchDataResult(
+                binarySearchVerificationGasLimitCause,
+                "binarySearchVerificationGasLimit"
+            )
 
             let verificationGasLimit = 0n
 
-            if (binarySearchVerificationGasLimitResult.result === "success") {
-                verificationGasLimit =
-                    binarySearchVerificationGasLimitResult.data.gasUsed
+            if (verificationGasLimitResult.result === "success") {
+                verificationGasLimit = verificationGasLimitResult.data.gasUsed
             }
 
-            if (binarySearchVerificationGasLimitResult.result === "failed") {
-                return binarySearchVerificationGasLimitResult
+            if (verificationGasLimitResult.result === "failed") {
+                return verificationGasLimitResult
             }
 
-            if (binarySearchVerificationGasLimitResult.result === "retry") {
-                const { optimalGas, minGas } =
-                    binarySearchVerificationGasLimitResult
+            if (verificationGasLimitResult.result === "retry") {
+                const { optimalGas, minGas } = verificationGasLimitResult
                 const binarySearchResult = await this.retryBinarySearch({
                     entryPoint,
                     optimalGas,
@@ -509,7 +509,7 @@ export class GasEstimatorV07 {
                 ).data.gasUsed
             }
 
-            const binarySearchPaymasterVerificationGasLimitResult =
+            const paymasterVerificationGasLimitResult =
                 binarySearchPaymasterVerificationGasLimitCause
                     ? validateBinarySearchDataResult(
                           binarySearchPaymasterVerificationGasLimitCause,
@@ -526,27 +526,18 @@ export class GasEstimatorV07 {
 
             let paymasterVerificationGasLimit = 0n
 
-            if (
-                binarySearchPaymasterVerificationGasLimitResult.result ===
-                "success"
-            ) {
+            if (paymasterVerificationGasLimitResult.result === "success") {
                 paymasterVerificationGasLimit =
-                    binarySearchPaymasterVerificationGasLimitResult.data.gasUsed
+                    paymasterVerificationGasLimitResult.data.gasUsed
             }
 
-            if (
-                binarySearchPaymasterVerificationGasLimitResult.result ===
-                "failed"
-            ) {
-                return binarySearchPaymasterVerificationGasLimitResult
+            if (paymasterVerificationGasLimitResult.result === "failed") {
+                return paymasterVerificationGasLimitResult
             }
 
-            if (
-                binarySearchPaymasterVerificationGasLimitResult.result ===
-                "retry"
-            ) {
+            if (paymasterVerificationGasLimitResult.result === "retry") {
                 const { optimalGas, minGas } =
-                    binarySearchPaymasterVerificationGasLimitResult
+                    paymasterVerificationGasLimitResult
                 const binarySearchResult = await this.retryBinarySearch({
                     entryPoint,
                     optimalGas,
@@ -568,22 +559,22 @@ export class GasEstimatorV07 {
                 ).data.gasUsed
             }
 
-            const simulateCallDataResult = validateBinarySearchDataResult(
-                simulateCallDataCause,
-                "simulateCallData"
+            const callGasLimitResult = validateBinarySearchDataResult(
+                binarySearchCallGasLimitCause,
+                "binarySearchCallGasLimit"
             )
 
             let callGasLimit = 0n
 
-            if (simulateCallDataResult.result === "success") {
-                callGasLimit = simulateCallDataResult.data.gasUsed
+            if (callGasLimitResult.result === "success") {
+                callGasLimit = callGasLimitResult.data.gasUsed
             }
-            if (simulateCallDataResult.result === "failed") {
-                return simulateCallDataResult
+            if (callGasLimitResult.result === "failed") {
+                return callGasLimitResult
             }
 
-            if (simulateCallDataResult.result === "retry") {
-                const { optimalGas, minGas } = simulateCallDataResult
+            if (callGasLimitResult.result === "retry") {
+                const { optimalGas, minGas } = callGasLimitResult
                 const binarySearchResult = await this.retryBinarySearch({
                     entryPoint,
                     optimalGas,
@@ -594,7 +585,7 @@ export class GasEstimatorV07 {
                         op: userOperation,
                         entryPoint
                     }),
-                    functionName: "simulateCallData",
+                    functionName: "binarySearchCallGasLimit",
                     queuedOps: queuedUserOperations,
                     stateOverrides
                 })
@@ -814,7 +805,7 @@ export function getSimulateValidationResult(errorData: Hex): {
 function validateBinarySearchDataResult(
     data: Hex,
     fnName:
-        | "simulateCallData"
+        | "binarySearchCallGasLimit"
         | "binarySearchVerificationGasLimit"
         | "binarySearchPaymasterVerificationGasLimit"
 ):

diff --git a/src/rpc/rpcHandler.ts b/src/rpc/rpcHandler.ts
@@ -394,7 +394,7 @@ export class RpcHandler implements IRpcEndpoint {
         entryPoint: Address,
         stateOverrides?: StateOverrides
     ): Promise<EstimateUserOperationGasResponseResult> {
-        return await this.doEstimateGas({
+        return await this.estimateGas({
             apiVersion,
             userOperation,
             entryPoint,
@@ -799,7 +799,7 @@ export class RpcHandler implements IRpcEndpoint {
             )
         }
 
-        return await this.doEstimateGas({
+        return await this.estimateGas({
             apiVersion,
             userOperation,
             authorization,
@@ -1054,7 +1054,7 @@ export class RpcHandler implements IRpcEndpoint {
         return currentNonceValue
     }
 
-    async doEstimateGas({
+    async estimateGas({
         apiVersion,
         userOperation,
         entryPoint,