feat paymaster call for buildUserOp

packages/account/src/BaseSmartAccount.ts

@@ -7,11 +7,12 @@ import { calcPreVerificationGas, DefaultGasLimits } from "./utils/Preverificaito
 import { NotPromise, packUserOp, Logger, RPC_PROVIDER_URLS } from "@biconomy/common";
 import { IBundler, UserOpResponse } from "@biconomy/bundler";
 import { IPaymaster, PaymasterAndDataResponse } from "@biconomy/paymaster";
+import { SponsorUserOperationDto, BiconomyPaymaster, PaymasterMode, IHybridPaymaster } from "@biconomy/paymaster";
 import { BaseSmartAccountConfig, Overrides, SendUserOpOptions, TransactionDetailsForUserOp } from "./utils/Types";
 import { GasOverheads } from "./utils/Preverificaiton";
 import { EntryPoint, EntryPoint__factory } from "@account-abstraction/contracts";
 import { DEFAULT_ENTRYPOINT_ADDRESS } from "./utils/Constants";
-import { LRUCache } from 'lru-cache'
+import { LRUCache } from "lru-cache";
 
 type UserOperationKey = keyof UserOperation;
 
@@ -71,7 +72,7 @@ export abstract class BaseSmartAccount implements IBaseSmartAccount {
   validateUserOp(userOp: Partial<UserOperation>, requiredFields: UserOperationKey[]): boolean {
     for (const field of requiredFields) {
       if (!userOp[field]) {
-        throw new Error(`${field} is missing`);
+        throw new Error(`${String(field)} is missing`);
       }
     }
     return true;
@@ -225,25 +226,50 @@ export abstract class BaseSmartAccount implements IBaseSmartAccount {
     userOp: Partial<UserOperation>,
     overrides?: Overrides,
     skipBundlerGasEstimation?: boolean,
+    paymasterServiceData?: SponsorUserOperationDto,
   ): Promise<Partial<UserOperation>> {
     const requiredFields: UserOperationKey[] = ["sender", "nonce", "initCode", "callData"];
     this.validateUserOp(userOp, requiredFields);
 
     let finalUserOp = userOp;
-    const skipBundlerCall = skipBundlerGasEstimation ?? false;
+    const skipBundlerCall = skipBundlerGasEstimation ?? true;
     // Override gas values in userOp if provided in overrides params
     if (overrides) {
       userOp = { ...userOp, ...overrides };
     }
 
     Logger.log("userOp in estimation", userOp);
 
-    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
-      finalUserOp = await this.calculateUserOpGasValues(userOp);
+    if (skipBundlerCall) {
+      // Review: instead of checking mode it could be assumed or just pass gasless flag and use it
+      // make pmService data locally and pass the object with default values
+      if (this.paymaster && this.paymaster instanceof BiconomyPaymaster && paymasterServiceData?.mode === PaymasterMode.SPONSORED) {
+        // TODO: delete these lines REVIEW
+        userOp.maxFeePerGas = userOp.maxFeePerGas ?? (await this.provider.getGasPrice());
+        userOp.maxPriorityFeePerGas = userOp.maxPriorityFeePerGas ?? (await this.provider.getGasPrice());
+
+        // TODO // Review and add try catch
+        // in try if gas values are undefined and pnd is 0x then estimate locally
+        // in catch make pnd 0x and calc values or just rethrow
+
+        // Making call to paymaster to get gas estimations for userOp
+        const { callGasLimit, verificationGasLimit, preVerificationGas, maxFeePerGas, maxPriorityFeePerGas, paymasterAndData } = await (
+          this.paymaster as IHybridPaymaster<SponsorUserOperationDto>
+        ).getPaymasterAndData(userOp, paymasterServiceData);
+        finalUserOp.verificationGasLimit = verificationGasLimit ?? userOp.verificationGasLimit;
+        finalUserOp.callGasLimit = callGasLimit ?? userOp.callGasLimit;
+        finalUserOp.preVerificationGas = preVerificationGas ?? userOp.preVerificationGas;
+        finalUserOp.maxFeePerGas = maxFeePerGas ?? userOp.maxFeePerGas;
+        finalUserOp.maxPriorityFeePerGas = maxPriorityFeePerGas ?? userOp.maxPriorityFeePerGas;
+        finalUserOp.paymasterAndData = paymasterAndData ?? userOp.paymasterAndData;
+      } else {
+        Logger.warn("Skipped paymaster call. If you are using paymasterAndData, generate data externally");
+        finalUserOp = await this.calculateUserOpGasValues(userOp);
+        finalUserOp.paymasterAndData = "0x";
+      }
     } else {
+      if (!this.bundler) throw new Error("Bundler is not provided");
+      // TODO: is this still needed to delete?
       delete userOp.maxFeePerGas;
       delete userOp.maxPriorityFeePerGas;
       // Making call to bundler to get gas estimations for userOp
@@ -261,6 +287,7 @@ export abstract class BaseSmartAccount implements IBaseSmartAccount {
       finalUserOp.verificationGasLimit = verificationGasLimit ?? userOp.verificationGasLimit;
       finalUserOp.callGasLimit = callGasLimit ?? userOp.callGasLimit;
       finalUserOp.preVerificationGas = preVerificationGas ?? userOp.preVerificationGas;
+      finalUserOp.paymasterAndData = "0x";
     }
     return finalUserOp;
   }

packages/account/src/BiconomySmartAccount.ts

@@ -256,7 +256,12 @@ export class BiconomySmartAccount extends SmartAccount implements IBiconomySmart
     return "0x";
   }
 
-  async buildUserOp(transactions: Transaction[], overrides?: Overrides, skipBundlerGasEstimation?: boolean): Promise<Partial<UserOperation>> {
+  async buildUserOp(
+    transactions: Transaction[],
+    overrides?: Overrides,
+    skipBundlerGasEstimation?: boolean,
+    paymasterServiceData?: SponsorUserOperationDto,
+  ): Promise<Partial<UserOperation>> {
     this.isInitialized();
     const to = transactions.map((element: Transaction) => element.to);
     const data = transactions.map((element: Transaction) => element.data ?? "0x");
@@ -291,11 +296,9 @@ export class BiconomySmartAccount extends SmartAccount implements IBiconomySmart
     // 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
-    userOp.paymasterAndData = "0x"; // await this.getPaymasterAndData(userOp)
+    // Note: Can change the default behaviour of calling estimations using bundler/local
+    userOp = await this.estimateUserOpGas(userOp, overrides, skipBundlerGasEstimation, paymasterServiceData);
+    Logger.log("UserOp after estimation ", userOp);
 
     return userOp;
   }
@@ -394,36 +397,11 @@ export class BiconomySmartAccount extends SmartAccount implements IBiconomySmart
 
           newCallData = this.getExecuteBatchCallData(batchTo, batchValue, batchData);
         }
-        let finalUserOp: Partial<UserOperation> = {
+        const finalUserOp: Partial<UserOperation> = {
           ...userOp,
           callData: newCallData,
         };
 
-        // Requesting to update gas limits again (especially callGasLimit needs to be re-calculated)
-        try {
-          delete finalUserOp.callGasLimit;
-          delete finalUserOp.verificationGasLimit;
-          delete finalUserOp.preVerificationGas;
-
-          // Maybe send paymasterAndData since we know it's for Token paymaster
-          /*finalUserOp.paymasterAndData =
-            '0x00000f7365ca6c59a2c93719ad53d567ed49c14c000000000000000000000000000000000000000000000000000000000064e3d3890000000000000000000000000000000000000000000000000000000064e3cc81000000000000000000000000af88d065e77c8cc2239327c5edb3a432268e583100000000000000000000000000000f7748595e46527413574a9327942e744e910000000000000000000000000000000000000000000000000000000063ac7f6c000000000000000000000000000000000000000000000000000000000010c8e07bf61410b71700f943499adfd23e50fb16040d587acb0a5e60ac8576cdbb4c8044f00579a1fc3f294e7dc4a5eb557a7193008343aa36225bddcfbd4fd15646031c'*/
-
-          // Review: and handle the case when mock pnd fails with AA31 during simulation.
-
-          finalUserOp = await this.estimateUserOpGas(finalUserOp);
-          const cgl = ethers.BigNumber.from(finalUserOp.callGasLimit);
-          if (finalUserOp.callGasLimit && cgl.lt(ethers.BigNumber.from("21000"))) {
-            return {
-              ...userOp,
-              callData: newCallData,
-            };
-          }
-          Logger.log("userOp after estimation ", finalUserOp);
-        } catch (error) {
-          Logger.error("Failed to estimate gas for userOp with updated callData ", error);
-          Logger.log("sending updated userOp. calculateGasLimit flag should be sent to the paymaster to be able to update callGasLimit");
-        }
         return finalUserOp;
       }
     } catch (error) {

packages/account/src/BiconomySmartAccountV2.ts

@@ -72,7 +72,6 @@ export class BiconomySmartAccountV2 extends BaseSmartAccount {
 
   public static async create(biconomySmartAccountConfig: BiconomySmartAccountV2Config): Promise<BiconomySmartAccountV2> {
     const instance = new BiconomySmartAccountV2(biconomySmartAccountConfig);
-    await instance.init();
     instance.factoryAddress = biconomySmartAccountConfig.factoryAddress ?? DEFAULT_BICONOMY_FACTORY_ADDRESS; // This would be fetched from V2
 
     const defaultFallbackHandlerAddress =
@@ -99,6 +98,8 @@ export class BiconomySmartAccountV2 extends BaseSmartAccount {
 
     instance.nodeClient = new NodeClient({ txServiceUrl: nodeClientUrl ?? NODE_CLIENT_URL });
 
+    await instance.init();
+
     return instance;
   }
 
@@ -362,12 +363,14 @@ export class BiconomySmartAccountV2 extends BaseSmartAccount {
     userOp.signature = await dummySignatureFetchPromise;
 
     // Note: Can change the default behaviour of calling estimations using bundler/local
-    userOp = await this.estimateUserOpGas(userOp, buildUseropDto?.overrides, buildUseropDto?.skipBundlerGasEstimation);
+    userOp = await this.estimateUserOpGas(
+      userOp,
+      buildUseropDto?.overrides,
+      buildUseropDto?.skipBundlerGasEstimation,
+      buildUseropDto?.paymasterServiceData,
+    );
     Logger.log("UserOp after estimation ", userOp);
 
-    // Do not populate paymasterAndData as part of buildUserOp as it may not have all necessary details
-    userOp.paymasterAndData = "0x"; // await this.getPaymasterAndData(userOp)
-
     return userOp;
   }
 
@@ -466,26 +469,11 @@ export class BiconomySmartAccountV2 extends BaseSmartAccount {
 
           newCallData = await this.encodeExecuteBatch(batchTo, batchValue, batchData);
         }
-        let finalUserOp: Partial<UserOperation> = {
+        const finalUserOp: Partial<UserOperation> = {
           ...userOp,
           callData: newCallData,
         };
 
-        // Requesting to update gas limits again (especially callGasLimit needs to be re-calculated)
-        try {
-          finalUserOp = await this.estimateUserOpGas(finalUserOp);
-          const callGasLimit = ethers.BigNumber.from(finalUserOp.callGasLimit);
-          if (finalUserOp.callGasLimit && callGasLimit.lt(ethers.BigNumber.from("21000"))) {
-            return {
-              ...userOp,
-              callData: newCallData,
-            };
-          }
-          Logger.log("UserOp after estimation ", finalUserOp);
-        } catch (error) {
-          Logger.error("Failed to estimate gas for userOp with updated callData ", error);
-          Logger.log("Sending updated userOp. calculateGasLimit flag should be sent to the paymaster to be able to update callGasLimit");
-        }
         return finalUserOp;
       }
     } catch (error) {

packages/account/src/SmartAccount.ts

@@ -10,6 +10,7 @@ import { IBundler, UserOpResponse } from "@biconomy/bundler";
 import { IPaymaster, PaymasterAndDataResponse } from "@biconomy/paymaster";
 import { Logger } from "@biconomy/common";
 import { IEntryPoint } from "@account-abstraction/contracts";
+import { SponsorUserOperationDto, BiconomyPaymaster, IHybridPaymaster, PaymasterMode } from "@biconomy/paymaster";
 import { SmartAccountConfig, Overrides, SendUserOpDto } from "./utils/Types";
 
 type UserOperationKey = keyof UserOperation;
@@ -48,7 +49,7 @@ export abstract class SmartAccount implements ISmartAccount {
   private validateUserOp(userOp: Partial<UserOperation>, requiredFields: UserOperationKey[]): boolean {
     for (const field of requiredFields) {
       if (!userOp[field]) {
-        throw new Error(`${field} is missing`);
+        throw new Error(`${String(field)} is missing`);
       }
     }
     return true;
@@ -102,30 +103,49 @@ export abstract class SmartAccount implements ISmartAccount {
     userOp: Partial<UserOperation>,
     overrides?: Overrides,
     skipBundlerGasEstimation?: boolean,
+    paymasterServiceData?: SponsorUserOperationDto,
   ): Promise<Partial<UserOperation>> {
     const requiredFields: UserOperationKey[] = ["sender", "nonce", "initCode", "callData"];
     this.validateUserOp(userOp, requiredFields);
 
     let finalUserOp = userOp;
-    const skipBundlerCall = skipBundlerGasEstimation ?? false;
+    const skipBundlerCall = skipBundlerGasEstimation ?? true;
     // Override gas values in userOp if provided in overrides params
     if (overrides) {
       userOp = { ...userOp, ...overrides };
     }
 
     Logger.log("userOp in estimation", userOp);
 
-    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
-      finalUserOp = await this.calculateUserOpGasValues(userOp);
+    if (skipBundlerCall) {
+      if (this.paymaster && this.paymaster instanceof BiconomyPaymaster && paymasterServiceData?.mode === PaymasterMode.SPONSORED) {
+        // TODO: delete these lines REVIEW
+        userOp.maxFeePerGas = userOp.maxFeePerGas ?? (await this.provider.getGasPrice());
+        userOp.maxPriorityFeePerGas = userOp.maxPriorityFeePerGas ?? (await this.provider.getGasPrice());
+        // Making call to paymaster to get gas estimations for userOp
+        const { callGasLimit, verificationGasLimit, preVerificationGas, maxFeePerGas, maxPriorityFeePerGas, paymasterAndData } = await (
+          this.paymaster as IHybridPaymaster<SponsorUserOperationDto>
+        ).getPaymasterAndData(userOp, paymasterServiceData);
+        finalUserOp.verificationGasLimit = verificationGasLimit ?? userOp.verificationGasLimit;
+        finalUserOp.callGasLimit = callGasLimit ?? userOp.callGasLimit;
+        finalUserOp.preVerificationGas = preVerificationGas ?? userOp.preVerificationGas;
+        finalUserOp.maxFeePerGas = maxFeePerGas ?? userOp.maxFeePerGas;
+        finalUserOp.maxPriorityFeePerGas = maxPriorityFeePerGas ?? userOp.maxPriorityFeePerGas;
+        finalUserOp.paymasterAndData = paymasterAndData ?? userOp.paymasterAndData;
+      } else {
+        Logger.warn("Skipped paymaster call. If you are using paymasterAndData, generate data externally");
+        finalUserOp = await this.calculateUserOpGasValues(userOp);
+        finalUserOp.paymasterAndData = "0x";
+      }
     } else {
+      if (!this.bundler) throw new Error("Bundler is not provided");
+      // TODO: is this still needed to delete?
       delete userOp.maxFeePerGas;
       delete userOp.maxPriorityFeePerGas;
       // Making call to bundler to get gas estimations for userOp
       const { callGasLimit, verificationGasLimit, preVerificationGas, maxFeePerGas, maxPriorityFeePerGas } =
         await this.bundler.estimateUserOpGas(userOp);
+      // if neither user sent gas fee nor the bundler, estimate gas from provider
       if (!userOp.maxFeePerGas && !userOp.maxPriorityFeePerGas && (!maxFeePerGas || !maxPriorityFeePerGas)) {
         const feeData = await this.provider.getFeeData();
         finalUserOp.maxFeePerGas = feeData.maxFeePerGas ?? feeData.gasPrice ?? (await this.provider.getGasPrice());
@@ -137,6 +157,7 @@ export abstract class SmartAccount implements ISmartAccount {
       finalUserOp.verificationGasLimit = verificationGasLimit ?? userOp.verificationGasLimit;
       finalUserOp.callGasLimit = callGasLimit ?? userOp.callGasLimit;
       finalUserOp.preVerificationGas = preVerificationGas ?? userOp.preVerificationGas;
+      finalUserOp.paymasterAndData = "0x";
     }
     return finalUserOp;
   }

packages/account/src/utils/Types.ts

@@ -2,7 +2,7 @@ import { Signer } from "ethers";
 import { ChainId } from "@biconomy/core-types";
 import { BigNumberish } from "ethers";
 import { IBundler } from "@biconomy/bundler";
-import { IPaymaster, PaymasterFeeQuote } from "@biconomy/paymaster";
+import { IPaymaster, PaymasterFeeQuote, SponsorUserOperationDto } from "@biconomy/paymaster";
 import { BaseValidationModule, ModuleInfo } from "@biconomy/modules";
 import { Provider } from "@ethersproject/providers";
 import { GasOverheads } from "./Preverificaiton";
@@ -80,6 +80,7 @@ export type BuildUserOpOptions = {
   params?: ModuleInfo;
   nonceOptions?: NonceOptions;
   forceEncodeForBatch?: boolean;
+  paymasterServiceData?: SponsorUserOperationDto;
 };
 
 export type NonceOptions = {

packages/account/tests/SmartAccountV2.local.spec.ts

@@ -79,11 +79,8 @@ describe("BiconomySmartAccountV2 API Specs", () => {
       activeValidationModule: module1,
     });
 
-    // console.log('account api provider ', accountAPI.provider)
+  // console.log('account api provider ', accountAPI.provider)
 
-    accountAPI = await accountAPI.init();
-
-    console.log("Account address ", accountAPI.accountAddress);
 
     const counterFactualAddress = await accountAPI.getAccountAddress();
     console.log("Counterfactual address ", counterFactualAddress);

packages/common/CHANGELOG.md

@@ -82,7 +82,7 @@ VERSION bump only
 * Type added for PaymasterServiceData + reordering of params ([fae8b3a](https://github.com/bcnmy/biconomy-client-sdk/commit/fae8b3a02a5e810a9a40674d27f389b89199bb62))
 * logic changed to accept paymasterServiceData ([6daaf37](https://github.com/bcnmy/biconomy-client-sdk/commit/6daaf37855a13fa6e12fdbab16a7e980b4631475))
 * UserOpGasFields for fetching gas and gas prices from bundler (https://github.com/bcnmy/biconomy-client-sdk/commit/a0c070b04bb6e249388a7d304dad7d08e97810e1)
-* skipEstimation added in dto update CreateUserPaidTransactionDto ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))
+* skipBundlerGasEstimation added in dto update CreateUserPaidTransactionDto ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))
 * fetching gas prices from bundler ([a0c070b](https://github.com/bcnmy/biconomy-client-sdk/commit/a0c070b04bb6e249388a7d304dad7d08e97810e1))
 
 

packages/core-types/CHANGELOG.md

@@ -67,7 +67,7 @@ VERSION bump only
 - Type added for PaymasterServiceData + reordering of params ([fae8b3a](https://github.com/bcnmy/biconomy-client-sdk/commit/fae8b3a02a5e810a9a40674d27f389b89199bb62))
 - logic changed to accept paymasterServiceData ([6daaf37](https://github.com/bcnmy/biconomy-client-sdk/commit/6daaf37855a13fa6e12fdbab16a7e980b4631475))
 - UserOpGasFields for fetching gas and gas prices from bundler (https://github.com/bcnmy/biconomy-client-sdk/commit/a0c070b04bb6e249388a7d304dad7d08e97810e1)
-- skipEstimation added in dto update CreateUserPaidTransactionDto ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))
+- skipBundlerGasEstimation added in dto update CreateUserPaidTransactionDto ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))
 - fetching gas prices from bundler ([a0c070b](https://github.com/bcnmy/biconomy-client-sdk/commit/a0c070b04bb6e249388a7d304dad7d08e97810e1))
 
 ## 2.0.0 (2023-04-07)

packages/node-client/CHANGELOG.md

@@ -37,7 +37,7 @@ Version Bump Only.
 
 ### Features
 
-* skipEstimation flag for gas ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))
+* skipBundlerGasEstimation flag for gas ([487f3ae](https://github.com/bcnmy/biconomy-client-sdk/commit/487f3aefe21b2dd4fd46e18bef7168eae3c1ecc1))