Merge pull request #227 from bcnmy/fix/bundler_dummy_op

fix userOp estimate gas overrides

packages/account/src/BiconomySmartAccount.ts

@@ -255,9 +255,18 @@ export class BiconomySmartAccount extends SmartAccount implements IBiconomySmart
     return executeBatchCallData
   }
 
+  getDummySignature(): string {
+    return '0x73c3ac716c487ca34bb858247b5ccf1dc354fbaabdd089af3b2ac8e78ba85a4959a2d76250325bd67c11771c31fccda87c33ceec17cc0de912690521bb95ffcb1b'
+  }
+
+  getDummyPaymasterData(): string {
+    return '0x'
+  }
+
   async buildUserOp(
     transactions: Transaction[],
-    overrides?: Overrides
+    overrides?: Overrides,
+    skipBundlerGasEstimation?: boolean
   ): Promise<Partial<UserOperation>> {
     this.isInitialized()
     // TODO: validate to, value and data fields
@@ -286,7 +295,10 @@ export class BiconomySmartAccount extends SmartAccount implements IBiconomySmart
       callData: callData
     }
 
-    userOp = await this.estimateUserOpGas(userOp, overrides)
+    // for this Smart Account dummy ECDSA signature will be used to estimate gas
+    userOp.signature = this.getDummySignature()
+
+    userOp = await this.estimateUserOpGas(userOp, overrides, skipBundlerGasEstimation)
     Logger.log('userOp after estimation ', userOp)
 
     // Do not populate paymasterAndData as part of buildUserOp as it may not have all necessary details

packages/account/src/SmartAccount.ts

@@ -63,68 +63,57 @@ export abstract class SmartAccount implements ISmartAccount {
     return true
   }
 
+  abstract getDummySignature(): string
+
+  async calculateUserOpGasValues(userOp: Partial<UserOperation>): Promise<Partial<UserOperation>> {
+    if (!this.provider) throw new Error('Provider is not present for making rpc calls')
+    const feeData = await this.provider.getFeeData()
+    userOp.maxFeePerGas =
+      userOp.maxFeePerGas ??
+      feeData.maxFeePerGas ??
+      feeData.gasPrice ??
+      (await this.provider.getGasPrice())
+    userOp.maxPriorityFeePerGas =
+      userOp.maxPriorityFeePerGas ??
+      feeData.maxPriorityFeePerGas ??
+      feeData.gasPrice ??
+      (await this.provider.getGasPrice())
+    if (userOp.initCode)
+      userOp.verificationGasLimit =
+        userOp.verificationGasLimit ?? (await this.getVerificationGasLimit(userOp.initCode))
+    userOp.callGasLimit =
+      userOp.callGasLimit ??
+      (await this.provider.estimateGas({
+        from: this.smartAccountConfig.entryPointAddress,
+        to: userOp.sender,
+        data: userOp.callData
+      }))
+    userOp.preVerificationGas = userOp.preVerificationGas ?? this.getPreVerificationGas(userOp)
+    return userOp
+  }
+
   async estimateUserOpGas(
     userOp: Partial<UserOperation>,
-    overrides?: Overrides
+    overrides?: Overrides,
+    skipBundlerGasEstimation?: boolean
   ): Promise<Partial<UserOperation>> {
     const requiredFields: UserOperationKey[] = ['sender', 'nonce', 'initCode', 'callData']
     this.validateUserOp(userOp, requiredFields)
 
+    let finalUserOp = userOp
+    const skipBundlerCall = skipBundlerGasEstimation ?? false
     // Override gas values in userOp if provided in overrides params
     if (overrides) {
       userOp = { ...userOp, ...overrides }
     }
 
     Logger.log('userOp in estimation', userOp)
 
-    // Defining the keys that are related that can be overrides
-    const overrideGasFields: UserOperationKey[] = [
-      'maxFeePerGas',
-      'maxPriorityFeePerGas',
-      'verificationGasLimit',
-      'callGasLimit',
-      'preVerificationGas'
-    ]
-
-    // here we are verifying either all necessary gas properties are present in userOp.
-    let skipEstimations = true
-    for (const key of overrideGasFields) {
-      if (!userOp[key]) {
-        skipEstimations = false
-        break
-      }
-    }
-    // If all necessary properties are present in userOp. we will skip estimation and return userOp
-    if (skipEstimations) {
-      return userOp
-    }
-
-    if (!this.bundler) {
+    if (!this.bundler || skipBundlerCall) {
       if (!this.provider) throw new Error('Provider is not present for making rpc calls')
       // if no bundler url is provided run offchain logic to assign following values of UserOp
       // maxFeePerGas, maxPriorityFeePerGas, verificationGasLimit, callGasLimit, preVerificationGas
-      const feeData = await this.provider.getFeeData()
-      userOp.maxFeePerGas =
-        userOp.maxFeePerGas ??
-        feeData.maxFeePerGas ??
-        feeData.gasPrice ??
-        (await this.provider.getGasPrice())
-      userOp.maxPriorityFeePerGas =
-        userOp.maxPriorityFeePerGas ??
-        feeData.maxPriorityFeePerGas ??
-        feeData.gasPrice ??
-        (await this.provider.getGasPrice())
-      if (userOp.initCode)
-        userOp.verificationGasLimit =
-          userOp.verificationGasLimit ?? (await this.getVerificationGasLimit(userOp.initCode))
-      userOp.callGasLimit =
-        userOp.callGasLimit ??
-        (await this.provider.estimateGas({
-          from: this.smartAccountConfig.entryPointAddress,
-          to: userOp.sender,
-          data: userOp.callData
-        }))
-      userOp.preVerificationGas = userOp.preVerificationGas ?? this.getPreVerificationGas(userOp)
+      finalUserOp = await this.calculateUserOpGasValues(finalUserOp)
     } else {
       // Making call to bundler to get gas estimations for userOp
       const {
@@ -140,19 +129,19 @@ export abstract class SmartAccount implements ISmartAccount {
         (!maxFeePerGas || !maxPriorityFeePerGas)
       ) {
         const feeData = await this.provider.getFeeData()
-        userOp.maxFeePerGas =
+        finalUserOp.maxFeePerGas =
           feeData.maxFeePerGas ?? feeData.gasPrice ?? (await this.provider.getGasPrice())
-        userOp.maxPriorityFeePerGas =
+        finalUserOp.maxPriorityFeePerGas =
           feeData.maxPriorityFeePerGas ?? feeData.gasPrice ?? (await this.provider.getGasPrice())
       } else {
-        userOp.maxFeePerGas = userOp.maxFeePerGas ?? maxFeePerGas
-        userOp.maxPriorityFeePerGas = userOp.maxPriorityFeePerGas ?? maxPriorityFeePerGas
+        finalUserOp.maxFeePerGas = maxFeePerGas ?? userOp.maxFeePerGas
+        finalUserOp.maxPriorityFeePerGas = maxPriorityFeePerGas ?? userOp.maxPriorityFeePerGas
       }
-      userOp.verificationGasLimit = userOp.verificationGasLimit ?? verificationGasLimit
-      userOp.callGasLimit = userOp.callGasLimit ?? callGasLimit
-      userOp.preVerificationGas = userOp.preVerificationGas ?? preVerificationGas
+      finalUserOp.verificationGasLimit = verificationGasLimit ?? userOp.verificationGasLimit
+      finalUserOp.callGasLimit = callGasLimit ?? userOp.callGasLimit
+      finalUserOp.preVerificationGas = preVerificationGas ?? userOp.preVerificationGas
     }
-    return userOp
+    return finalUserOp
   }
 
   async isAccountDeployed(address: string): Promise<boolean> {

packages/bundler/src/Bundler.ts

@@ -49,20 +49,9 @@ export class Bundler implements IBundler {
    * @returns Promise<UserOpGasPricesResponse>
    */
   async estimateUserOpGas(userOp: UserOperation): Promise<UserOpGasResponse> {
-    // bundler requires these dummy values for estimation
-    // TODO: dapp/wallet devs need to take dummy signature as well that we will pass to bundler. as signature depends on smart account implementation
-    const dummpyUserop = {
-      callGasLimit: '90000',
-      verificationGasLimit: '3000000',
-      preVerificationGas: '46856',
-      maxFeePerGas: '0',
-      maxPriorityFeePerGas: '0',
-      paymasterAndData: '0x',
-      signature:
-        '0x73c3ac716c487ca34bb858247b5ccf1dc354fbaabdd089af3b2ac8e78ba85a4959a2d76250325bd67c11771c31fccda87c33ceec17cc0de912690521bb95ffcb1b'
-    }
-    const userOperation = { ...dummpyUserop, ...userOp }
-    userOp = transformUserOP(userOperation)
+    // expected dummySig and possibly dummmy paymasterAndData should be provided by the caller
+    // bundler doesn't know account and paymaster implementation
+    userOp = transformUserOP(userOp)
     Logger.log('userOp sending for fee estimate ', userOp)
 
     const bundlerUrl = this.getBundlerUrl()

packages/paymaster/src/BiconomyPaymaster.ts

@@ -358,4 +358,19 @@ export class BiconomyPaymaster implements IHybridPaymaster<SponsorUserOperationD
     }
     throw new Error('Error in generating paymasterAndData')
   }
+
+  /**
+   *
+   * @param userOp user operation
+   * @param paymasterServiceData optional extra information to be passed to paymaster service
+   * @returns paymasterAndData with valid length but mock signature
+   */
+  async getDummyPaymasterAndData(
+    userOp: Partial<UserOperation>,
+    paymasterServiceData?: SponsorUserOperationDto // mode is necessary. partial context of token paymaster or verifying
+  ): Promise<string> {
+    Logger.log('userOp is ', userOp)
+    Logger.log('paymasterServiceData is ', paymasterServiceData)
+    return '0x'
+  }
 }

packages/paymaster/src/interfaces/IHybridPaymaster.ts

@@ -14,6 +14,10 @@ export interface IHybridPaymaster<T> extends IPaymaster {
     userOp: Partial<UserOperation>,
     paymasterServiceData?: T
   ): Promise<PaymasterAndDataResponse>
+  getDummyPaymasterAndData(
+    userOp: Partial<UserOperation>,
+    paymasterServiceData?: T
+  ): Promise<string>
   buildTokenApprovalTransaction(
     tokenPaymasterRequest: BiconomyTokenPaymasterRequest,
     provider: Provider

packages/paymaster/src/interfaces/IPaymaster.ts

@@ -4,4 +4,5 @@ import { PaymasterAndDataResponse } from '../utils/Types'
 export interface IPaymaster {
   // Implementing class may add extra parameter (for example paymasterServiceData with it's own type) in below function signature
   getPaymasterAndData(userOp: Partial<UserOperation>): Promise<PaymasterAndDataResponse>
+  getDummyPaymasterAndData(userOp: Partial<UserOperation>): Promise<string>
 }