permissionless 0.2.49 → 0.2.50

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # permissionless
 
+## 0.2.50
+
+### Patch Changes
+
+- ba0e2bd161d5ee4bbd975a28f9f36ff520aca8f7: Added estimateErc20PaymasterCost
+
 ## 0.2.49
 
 ### Patch Changes

package/README.md

@@ -71,7 +71,7 @@ const account = toSimpleSmartAccount<entryPointVersion>({
 // Create the required clients.
 const bundlerClient = createSmartAccountClient({
   account,
-  paymaster: 
+  paymaster, 
   chain: sepolia,
   bundlerTransport: http(
     `https://api.pimlico.io/v2/sepolia/rpc?apikey=${pimlicoApiKey}`,

package/_cjs/actions/pimlico/estimateErc20PaymasterCost.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.estimateErc20PaymasterCost = void 0;
+const viem_1 = require("viem");
+const utils_1 = require("viem/utils");
+const getRequiredPrefund_js_1 = require("../../utils/getRequiredPrefund.js");
+const getTokenQuotes_js_1 = require("./getTokenQuotes.js");
+const estimateErc20PaymasterCost = async (client, args) => {
+    const chain = args.chain ?? client.chain;
+    if (!chain) {
+        throw new viem_1.ChainNotFoundError();
+    }
+    const { entryPoint, userOperation, token } = args;
+    const quotes = await (0, utils_1.getAction)(client, getTokenQuotes_js_1.getTokenQuotes, "getTokenQuotes")({
+        tokens: [token],
+        entryPointAddress: entryPoint.address,
+        chain
+    });
+    const postOpGas = quotes[0].postOpGas;
+    const exchangeRate = quotes[0].exchangeRate;
+    const exchangeRateNativeToUsd = quotes[0].exchangeRateNativeToUsd;
+    const userOperationMaxCost = (0, getRequiredPrefund_js_1.getRequiredPrefund)({
+        userOperation,
+        entryPointVersion: entryPoint.version
+    });
+    const maxCostInWei = userOperationMaxCost + postOpGas * userOperation.maxFeePerGas;
+    const costInToken = (maxCostInWei * exchangeRate) / BigInt(1e18);
+    const costInUsd = (maxCostInWei * exchangeRateNativeToUsd) / 10n ** 18n;
+    return {
+        costInToken,
+        costInUsd
+    };
+};
+exports.estimateErc20PaymasterCost = estimateErc20PaymasterCost;
+//# sourceMappingURL=estimateErc20PaymasterCost.js.map

package/_cjs/actions/pimlico/estimateErc20PaymasterCost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"estimateErc20PaymasterCost.js","sourceRoot":"","sources":["../../../actions/pimlico/estimateErc20PaymasterCost.ts"],"names":[],"mappings":";;;AAAA,+BAQa;AAEb,sCAAsC;AAEtC,6EAAsE;AACtE,2DAAoD;AA8B7C,MAAM,0BAA0B,GAAG,KAAK,EAK3C,MAKC,EACD,IAIC,EAC4C,EAAE;IAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAA;IAExC,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,IAAI,yBAAkB,EAAE,CAAA;IAClC,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAEjD,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAS,EAC1B,MAAM,EACN,kCAAc,EACd,gBAAgB,CACnB,CAAC;QACE,MAAM,EAAE,CAAC,KAAK,CAAC;QACf,iBAAiB,EAAE,UAAU,CAAC,OAAO;QACrC,KAAK;KACR,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACrC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAA;IAC3C,MAAM,uBAAuB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAA;IAEjE,MAAM,oBAAoB,GAAG,IAAA,0CAAkB,EAAC;QAC5C,aAAa;QACb,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC,CAAA;IAGF,MAAM,YAAY,GACd,oBAAoB,GAAG,SAAS,GAAG,aAAa,CAAC,YAAY,CAAA;IAGjE,MAAM,WAAW,GAAG,CAAC,YAAY,GAAG,YAAY,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAGhE,MAAM,SAAS,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC,GAAG,GAAG,IAAI,GAAG,CAAA;IAEvE,OAAO;QACH,WAAW;QACX,SAAS;KACZ,CAAA;AACL,CAAC,CAAA;AA1DY,QAAA,0BAA0B,8BA0DtC"}

package/_cjs/clients/decorators/pimlico.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pimlicoActions = void 0;
 const pimlico_js_1 = require("../../actions/pimlico.js");
+const estimateErc20PaymasterCost_js_1 = require("../../actions/pimlico/estimateErc20PaymasterCost.js");
 const getUserOperationGasPrice_js_1 = require("../../actions/pimlico/getUserOperationGasPrice.js");
 const getUserOperationStatus_js_1 = require("../../actions/pimlico/getUserOperationStatus.js");
 const sponsorUserOperation_js_1 = require("../../actions/pimlico/sponsorUserOperation.js");
@@ -24,6 +25,11 @@ const pimlicoActions = ({ entryPoint }) => (client) => ({
         ...args,
         chain: args.chain,
         entryPointAddress: entryPoint.address
+    }),
+    estimateErc20PaymasterCost: async (args) => (0, estimateErc20PaymasterCost_js_1.estimateErc20PaymasterCost)(client, {
+        ...args,
+        entryPoint,
+        chain: args.chain
     })
 });
 exports.pimlicoActions = pimlicoActions;

package/_cjs/clients/decorators/pimlico.js.map

@@ -1 +1 @@
-{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":";;;AAEA,yDASiC;AACjC,mGAG0D;AAC1D,+FAIwD;AACxD,2FAIsD;AAuG/C,MAAM,cAAc,GACvB,CAA8C,EAC1C,UAAU,EAGb,EAAE,EAAE,CACL,CAII,MAAkC,EACO,EAAE,CAAC,CAAC;IAC7C,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,IAAA,sDAAwB,EAAC,MAAM,CAAC;IACtE,sBAAsB,EAAE,KAAK,EACzB,IAAsC,EACxC,EAAE,CAAC,IAAA,kDAAsB,EAAC,MAAM,EAAE,IAAI,CAAC;IACzC,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,IAAA,wCAA2B,EAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,oBAAoB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACjC,IAAA,8CAAoB,EAAC,MAAM,EAAE;QACzB,GAAG,IAAI;QACP,UAAU;KACb,CAAC;IACN,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,IAAA,wCAA2B,EAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3B,IAAA,2BAAc,EAAC,MAAM,EAAE;QACnB,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;CACT,CAAC,CAAA;AArCO,QAAA,cAAc,kBAqCrB"}
+{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":";;;AAEA,yDASiC;AACjC,uGAI4D;AAC5D,mGAG0D;AAC1D,+FAIwD;AACxD,2FAIsD;AAmH/C,MAAM,cAAc,GACvB,CAA8C,EAC1C,UAAU,EAGb,EAAE,EAAE,CACL,CAII,MAAkC,EACO,EAAE,CAAC,CAAC;IAC7C,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,IAAA,sDAAwB,EAAC,MAAM,CAAC;IACtE,sBAAsB,EAAE,KAAK,EACzB,IAAsC,EACxC,EAAE,CAAC,IAAA,kDAAsB,EAAC,MAAM,EAAE,IAAI,CAAC;IACzC,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,IAAA,wCAA2B,EAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,oBAAoB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACjC,IAAA,8CAAoB,EAAC,MAAM,EAAE;QACzB,GAAG,IAAI;QACP,UAAU;KACb,CAAC;IACN,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,IAAA,wCAA2B,EAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3B,IAAA,2BAAc,EAAC,MAAM,EAAE;QACnB,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,0BAA0B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACvC,IAAA,0DAA0B,EAAC,MAAM,EAAE;QAC/B,GAAG,IAAI;QACP,UAAU;QACV,KAAK,EAAE,IAAI,CAAC,KAAK;KACpB,CAAC;CACT,CAAC,CAAA;AA3CO,QAAA,cAAc,kBA2CrB"}

package/_esm/actions/pimlico/estimateErc20PaymasterCost.js

@@ -0,0 +1,43 @@
+import { ChainNotFoundError } from "viem";
+import { getAction } from "viem/utils";
+import { getRequiredPrefund } from "../../utils/getRequiredPrefund.js";
+import { getTokenQuotes } from "./getTokenQuotes.js";
+/**
+ * Returns all related fields to calculate the potential cost of a userOperation in ERC-20 tokens.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/EstimateErc20PaymasterCost
+ *
+ * @param client that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @returns quotes, see {@link EstimateErc20PaymasterCostReturnType}
+ *
+ */
+export const estimateErc20PaymasterCost = async (client, args) => {
+    const chain = args.chain ?? client.chain;
+    if (!chain) {
+        throw new ChainNotFoundError();
+    }
+    const { entryPoint, userOperation, token } = args;
+    const quotes = await getAction(client, getTokenQuotes, "getTokenQuotes")({
+        tokens: [token],
+        entryPointAddress: entryPoint.address,
+        chain
+    });
+    const postOpGas = quotes[0].postOpGas;
+    const exchangeRate = quotes[0].exchangeRate;
+    const exchangeRateNativeToUsd = quotes[0].exchangeRateNativeToUsd;
+    const userOperationMaxCost = getRequiredPrefund({
+        userOperation,
+        entryPointVersion: entryPoint.version
+    });
+    // represents the userOperation's max cost in denomination of wei
+    const maxCostInWei = userOperationMaxCost + postOpGas * userOperation.maxFeePerGas;
+    // represents the userOperation's max cost in token denomination (wei)
+    const costInToken = (maxCostInWei * exchangeRate) / BigInt(1e18);
+    // represents the userOperation's max cost in usd (with 6 decimals of precision)
+    const costInUsd = (maxCostInWei * exchangeRateNativeToUsd) / 10n ** 18n;
+    return {
+        costInToken,
+        costInUsd
+    };
+};
+//# sourceMappingURL=estimateErc20PaymasterCost.js.map

package/_esm/actions/pimlico/estimateErc20PaymasterCost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"estimateErc20PaymasterCost.js","sourceRoot":"","sources":["../../../actions/pimlico/estimateErc20PaymasterCost.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,kBAAkB,EAIrB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAqBpD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAK3C,MAKC,EACD,IAIC,EAC4C,EAAE;IAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAA;IAExC,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,IAAI,kBAAkB,EAAE,CAAA;IAClC,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAEjD,MAAM,MAAM,GAAG,MAAM,SAAS,CAC1B,MAAM,EACN,cAAc,EACd,gBAAgB,CACnB,CAAC;QACE,MAAM,EAAE,CAAC,KAAK,CAAC;QACf,iBAAiB,EAAE,UAAU,CAAC,OAAO;QACrC,KAAK;KACR,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACrC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAA;IAC3C,MAAM,uBAAuB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAA;IAEjE,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;QAC5C,aAAa;QACb,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC,CAAA;IAEF,iEAAiE;IACjE,MAAM,YAAY,GACd,oBAAoB,GAAG,SAAS,GAAG,aAAa,CAAC,YAAY,CAAA;IAEjE,sEAAsE;IACtE,MAAM,WAAW,GAAG,CAAC,YAAY,GAAG,YAAY,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAEhE,gFAAgF;IAChF,MAAM,SAAS,GAAG,CAAC,YAAY,GAAG,uBAAuB,CAAC,GAAG,GAAG,IAAI,GAAG,CAAA;IAEvE,OAAO;QACH,WAAW;QACX,SAAS;KACZ,CAAA;AACL,CAAC,CAAA"}

package/_esm/clients/decorators/pimlico.js

@@ -1,4 +1,5 @@
 import { getTokenQuotes, sendCompressedUserOperation, validateSponsorshipPolicies } from "../../actions/pimlico.js";
+import { estimateErc20PaymasterCost } from "../../actions/pimlico/estimateErc20PaymasterCost.js";
 import { getUserOperationGasPrice } from "../../actions/pimlico/getUserOperationGasPrice.js";
 import { getUserOperationStatus } from "../../actions/pimlico/getUserOperationStatus.js";
 import { sponsorUserOperation } from "../../actions/pimlico/sponsorUserOperation.js";
@@ -21,6 +22,11 @@ export const pimlicoActions = ({ entryPoint }) => (client) => ({
         ...args,
         chain: args.chain,
         entryPointAddress: entryPoint.address
+    }),
+    estimateErc20PaymasterCost: async (args) => estimateErc20PaymasterCost(client, {
+        ...args,
+        entryPoint,
+        chain: args.chain
     })
 });
 //# sourceMappingURL=pimlico.js.map

package/_esm/clients/decorators/pimlico.js.map

@@ -1 +1 @@
-{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":"AAEA,OAAO,EAMH,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC9B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAEH,wBAAwB,EAC3B,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EAGH,sBAAsB,EACzB,MAAM,iDAAiD,CAAA;AACxD,OAAO,EAGH,oBAAoB,EACvB,MAAM,+CAA+C,CAAA;AAuGtD,MAAM,CAAC,MAAM,cAAc,GACvB,CAA8C,EAC1C,UAAU,EAGb,EAAE,EAAE,CACL,CAII,MAAkC,EACO,EAAE,CAAC,CAAC;IAC7C,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC;IACtE,sBAAsB,EAAE,KAAK,EACzB,IAAsC,EACxC,EAAE,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC;IACzC,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,2BAA2B,CAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,oBAAoB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACjC,oBAAoB,CAAC,MAAM,EAAE;QACzB,GAAG,IAAI;QACP,UAAU;KACb,CAAC;IACN,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,2BAA2B,CAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3B,cAAc,CAAC,MAAM,EAAE;QACnB,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;CACT,CAAC,CAAA"}
+{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":"AAEA,OAAO,EAMH,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC9B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAGH,0BAA0B,EAC7B,MAAM,qDAAqD,CAAA;AAC5D,OAAO,EAEH,wBAAwB,EAC3B,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EAGH,sBAAsB,EACzB,MAAM,iDAAiD,CAAA;AACxD,OAAO,EAGH,oBAAoB,EACvB,MAAM,+CAA+C,CAAA;AAmHtD,MAAM,CAAC,MAAM,cAAc,GACvB,CAA8C,EAC1C,UAAU,EAGb,EAAE,EAAE,CACL,CAII,MAAkC,EACO,EAAE,CAAC,CAAC;IAC7C,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC;IACtE,sBAAsB,EAAE,KAAK,EACzB,IAAsC,EACxC,EAAE,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC;IACzC,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,2BAA2B,CAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,oBAAoB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACjC,oBAAoB,CAAC,MAAM,EAAE;QACzB,GAAG,IAAI;QACP,UAAU;KACb,CAAC;IACN,2BAA2B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACxC,2BAA2B,CAAC,MAAM,EAAE;QAChC,GAAG,IAAI;QACP,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAC3B,cAAc,CAAC,MAAM,EAAE;QACnB,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,iBAAiB,EAAE,UAAU,CAAC,OAAO;KACxC,CAAC;IACN,0BAA0B,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACvC,0BAA0B,CAAC,MAAM,EAAE;QAC/B,GAAG,IAAI;QACP,UAAU;QACV,KAAK,EAAE,IAAI,CAAC,KAAK;KACpB,CAAC;CACT,CAAC,CAAA"}

package/_types/actions/pimlico/estimateErc20PaymasterCost.d.ts

@@ -0,0 +1,30 @@
+import { type Account, type Address, type Chain, type Client, type GetChainParameter, type Transport } from "viem";
+import type { EntryPointVersion, UserOperation } from "viem/account-abstraction";
+import type { PimlicoRpcSchema } from "../../types/pimlico.js";
+/**
+ * @costInToken represents the max amount of token that will be charged for this user operation in token decimals
+ * @costInUsd represents the max amount of USD value of the token in 10^6 decimals
+ */
+export type EstimateErc20PaymasterCostReturnType = {
+    costInToken: bigint;
+    costInUsd: bigint;
+};
+export type EstimateErc20PaymasterCostParameters<entryPointVersion extends EntryPointVersion, TChain extends Chain | undefined, TChainOverride extends Chain | undefined = Chain | undefined> = {
+    entryPoint: {
+        version: entryPointVersion;
+        address: Address;
+    };
+    userOperation: UserOperation<entryPointVersion>;
+    token: Address;
+} & GetChainParameter<TChain, TChainOverride>;
+/**
+ * Returns all related fields to calculate the potential cost of a userOperation in ERC-20 tokens.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/EstimateErc20PaymasterCost
+ *
+ * @param client that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @returns quotes, see {@link EstimateErc20PaymasterCostReturnType}
+ *
+ */
+export declare const estimateErc20PaymasterCost: <entryPointVersion extends EntryPointVersion, TChain extends Chain | undefined, TChainOverride extends Chain | undefined = Chain | undefined>(client: Client<Transport, TChain, Account | undefined, PimlicoRpcSchema<entryPointVersion>>, args: EstimateErc20PaymasterCostParameters<entryPointVersion, TChain, TChainOverride>) => Promise<EstimateErc20PaymasterCostReturnType>;
+//# sourceMappingURL=estimateErc20PaymasterCost.d.ts.map

package/_types/actions/pimlico/estimateErc20PaymasterCost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"estimateErc20PaymasterCost.d.ts","sourceRoot":"","sources":["../../../actions/pimlico/estimateErc20PaymasterCost.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,KAAK,EAEV,KAAK,MAAM,EACX,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACjB,MAAM,MAAM,CAAA;AACb,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAEhF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAI9D;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG;IAC/C,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,oCAAoC,CAC5C,iBAAiB,SAAS,iBAAiB,EAC3C,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IAC5D;IACA,UAAU,EAAE;QAAE,OAAO,EAAE,iBAAiB,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;IAC5D,aAAa,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAA;IAC/C,KAAK,EAAE,OAAO,CAAA;CACjB,GAAG,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAE7C;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GACnC,iBAAiB,SAAS,iBAAiB,EAC3C,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAE5D,QAAQ,MAAM,CACV,SAAS,EACT,MAAM,EACN,OAAO,GAAG,SAAS,EACnB,gBAAgB,CAAC,iBAAiB,CAAC,CACtC,EACD,MAAM,oCAAoC,CACtC,iBAAiB,EACjB,MAAM,EACN,cAAc,CACjB,KACF,OAAO,CAAC,oCAAoC,CA0C9C,CAAA"}

package/_types/clients/decorators/pimlico.d.ts

@@ -1,6 +1,7 @@
 import type { Address, Chain, Client, Hash, Prettify, Transport } from "viem";
 import type { EntryPointVersion } from "viem/account-abstraction";
 import { type GetTokenQuotesParameters, type GetTokenQuotesReturnType, type SendCompressedUserOperationParameters, type ValidateSponsorshipPolicies, type ValidateSponsorshipPoliciesParameters } from "../../actions/pimlico.js";
+import { type EstimateErc20PaymasterCostParameters, type EstimateErc20PaymasterCostReturnType } from "../../actions/pimlico/estimateErc20PaymasterCost.js";
 import { type GetUserOperationGasPriceReturnType } from "../../actions/pimlico/getUserOperationGasPrice.js";
 import { type GetUserOperationStatusParameters, type GetUserOperationStatusReturnType } from "../../actions/pimlico/getUserOperationStatus.js";
 import { type PimlicoSponsorUserOperationParameters, type SponsorUserOperationReturnType } from "../../actions/pimlico/sponsorUserOperation.js";
@@ -74,6 +75,7 @@ export type PimlicoActions<TChain extends Chain | undefined, entryPointVersion e
     sponsorUserOperation: (args: Omit<PimlicoSponsorUserOperationParameters<entryPointVersion>, "entryPoint">) => Promise<Prettify<SponsorUserOperationReturnType<entryPointVersion>>>;
     validateSponsorshipPolicies: (args: Prettify<Omit<ValidateSponsorshipPoliciesParameters, "entryPointAddress">>) => Promise<Prettify<ValidateSponsorshipPolicies>[]>;
     getTokenQuotes: <TChainOverride extends Chain | undefined = Chain | undefined>(args: Prettify<Omit<GetTokenQuotesParameters<TChain, TChainOverride>, "entryPointAddress">>) => Promise<Prettify<GetTokenQuotesReturnType>>;
+    estimateErc20PaymasterCost: <TChainOverride extends Chain | undefined = Chain | undefined>(args: Omit<EstimateErc20PaymasterCostParameters<entryPointVersion, TChain, TChainOverride>, "entryPoint">) => Promise<Prettify<EstimateErc20PaymasterCostReturnType>>;
 };
 export declare const pimlicoActions: <entryPointVersion extends EntryPointVersion>({ entryPoint }: {
     entryPoint: {

package/_types/clients/decorators/pimlico.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EACH,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,qCAAqC,EAI7C,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACH,KAAK,kCAAkC,EAE1C,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EACH,KAAK,gCAAgC,EACrC,KAAK,gCAAgC,EAExC,MAAM,iDAAiD,CAAA;AACxD,OAAO,EACH,KAAK,qCAAqC,EAC1C,KAAK,8BAA8B,EAEtC,MAAM,+CAA+C,CAAA;AAEtD,MAAM,MAAM,cAAc,CACtB,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,iBAAiB,SAAS,iBAAiB,GAAG,iBAAiB,IAC/D;IACA;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,EAAE,MAAM,OAAO,CACnC,QAAQ,CAAC,kCAAkC,CAAC,CAC/C,CAAA;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,sBAAsB,EAAE,CACpB,IAAI,EAAE,QAAQ,CAAC,gCAAgC,CAAC,KAC/C,OAAO,CAAC,QAAQ,CAAC,gCAAgC,CAAC,CAAC,CAAA;IACxD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,2BAA2B,EAAE,CACzB,IAAI,EAAE,QAAQ,CACV,IAAI,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,CACnE,KACA,OAAO,CAAC,IAAI,CAAC,CAAA;IAClB,oBAAoB,EAAE,CAClB,IAAI,EAAE,IAAI,CACN,qCAAqC,CAAC,iBAAiB,CAAC,EACxD,YAAY,CACf,KACA,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;IACzE,2BAA2B,EAAE,CACzB,IAAI,EAAE,QAAQ,CACV,IAAI,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,CACnE,KACA,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAA;IACrD,cAAc,EAAE,CACZ,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAE5D,IAAI,EAAE,QAAQ,CACV,IAAI,CACA,wBAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,EAChD,mBAAmB,CACtB,CACJ,KACA,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAA;CACnD,CAAA;AAED,eAAO,MAAM,cAAc,GACtB,iBAAiB,SAAS,iBAAiB,EAAE,gBAE3C;IACC,UAAU,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAA;CAC/D,MAEG,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAEpD,QAAQ,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KACnC,cAAc,CAAC,MAAM,EAAE,iBAAiB,CA0BzC,CAAA"}
+{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../../clients/decorators/pimlico.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EACH,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,qCAAqC,EAC1C,KAAK,2BAA2B,EAChC,KAAK,qCAAqC,EAI7C,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACH,KAAK,oCAAoC,EACzC,KAAK,oCAAoC,EAE5C,MAAM,qDAAqD,CAAA;AAC5D,OAAO,EACH,KAAK,kCAAkC,EAE1C,MAAM,mDAAmD,CAAA;AAC1D,OAAO,EACH,KAAK,gCAAgC,EACrC,KAAK,gCAAgC,EAExC,MAAM,iDAAiD,CAAA;AACxD,OAAO,EACH,KAAK,qCAAqC,EAC1C,KAAK,8BAA8B,EAEtC,MAAM,+CAA+C,CAAA;AAEtD,MAAM,MAAM,cAAc,CACtB,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,iBAAiB,SAAS,iBAAiB,GAAG,iBAAiB,IAC/D;IACA;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,EAAE,MAAM,OAAO,CACnC,QAAQ,CAAC,kCAAkC,CAAC,CAC/C,CAAA;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,sBAAsB,EAAE,CACpB,IAAI,EAAE,QAAQ,CAAC,gCAAgC,CAAC,KAC/C,OAAO,CAAC,QAAQ,CAAC,gCAAgC,CAAC,CAAC,CAAA;IACxD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,2BAA2B,EAAE,CACzB,IAAI,EAAE,QAAQ,CACV,IAAI,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,CACnE,KACA,OAAO,CAAC,IAAI,CAAC,CAAA;IAClB,oBAAoB,EAAE,CAClB,IAAI,EAAE,IAAI,CACN,qCAAqC,CAAC,iBAAiB,CAAC,EACxD,YAAY,CACf,KACA,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;IACzE,2BAA2B,EAAE,CACzB,IAAI,EAAE,QAAQ,CACV,IAAI,CAAC,qCAAqC,EAAE,mBAAmB,CAAC,CACnE,KACA,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAA;IACrD,cAAc,EAAE,CACZ,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAE5D,IAAI,EAAE,QAAQ,CACV,IAAI,CACA,wBAAwB,CAAC,MAAM,EAAE,cAAc,CAAC,EAChD,mBAAmB,CACtB,CACJ,KACA,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAA;IAChD,0BAA0B,EAAE,CACxB,cAAc,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAE5D,IAAI,EAAE,IAAI,CACN,oCAAoC,CAChC,iBAAiB,EACjB,MAAM,EACN,cAAc,CACjB,EACD,YAAY,CACf,KACA,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAAC,CAAC,CAAA;CAC/D,CAAA;AAED,eAAO,MAAM,cAAc,GACtB,iBAAiB,SAAS,iBAAiB,EAAE,gBAE3C;IACC,UAAU,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,CAAA;CAC/D,MAEG,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAEpD,QAAQ,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KACnC,cAAc,CAAC,MAAM,EAAE,iBAAiB,CAgCzC,CAAA"}

package/actions/pimlico/estimateErc20PaymasterCost.ts

@@ -0,0 +1,102 @@
+import {
+    type Account,
+    type Address,
+    type Chain,
+    ChainNotFoundError,
+    type Client,
+    type GetChainParameter,
+    type Transport
+} from "viem"
+import type { EntryPointVersion, UserOperation } from "viem/account-abstraction"
+import { getAction } from "viem/utils"
+import type { PimlicoRpcSchema } from "../../types/pimlico.js"
+import { getRequiredPrefund } from "../../utils/getRequiredPrefund.js"
+import { getTokenQuotes } from "./getTokenQuotes.js"
+
+/**
+ * @costInToken represents the max amount of token that will be charged for this user operation in token decimals
+ * @costInUsd represents the max amount of USD value of the token in 10^6 decimals
+ */
+export type EstimateErc20PaymasterCostReturnType = {
+    costInToken: bigint
+    costInUsd: bigint
+}
+
+export type EstimateErc20PaymasterCostParameters<
+    entryPointVersion extends EntryPointVersion,
+    TChain extends Chain | undefined,
+    TChainOverride extends Chain | undefined = Chain | undefined
+> = {
+    entryPoint: { version: entryPointVersion; address: Address }
+    userOperation: UserOperation<entryPointVersion>
+    token: Address
+} & GetChainParameter<TChain, TChainOverride>
+
+/**
+ * Returns all related fields to calculate the potential cost of a userOperation in ERC-20 tokens.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/EstimateErc20PaymasterCost
+ *
+ * @param client that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @returns quotes, see {@link EstimateErc20PaymasterCostReturnType}
+ *
+ */
+export const estimateErc20PaymasterCost = async <
+    entryPointVersion extends EntryPointVersion,
+    TChain extends Chain | undefined,
+    TChainOverride extends Chain | undefined = Chain | undefined
+>(
+    client: Client<
+        Transport,
+        TChain,
+        Account | undefined,
+        PimlicoRpcSchema<entryPointVersion>
+    >,
+    args: EstimateErc20PaymasterCostParameters<
+        entryPointVersion,
+        TChain,
+        TChainOverride
+    >
+): Promise<EstimateErc20PaymasterCostReturnType> => {
+    const chain = args.chain ?? client.chain
+
+    if (!chain) {
+        throw new ChainNotFoundError()
+    }
+
+    const { entryPoint, userOperation, token } = args
+
+    const quotes = await getAction(
+        client,
+        getTokenQuotes,
+        "getTokenQuotes"
+    )({
+        tokens: [token],
+        entryPointAddress: entryPoint.address,
+        chain
+    })
+
+    const postOpGas = quotes[0].postOpGas
+    const exchangeRate = quotes[0].exchangeRate
+    const exchangeRateNativeToUsd = quotes[0].exchangeRateNativeToUsd
+
+    const userOperationMaxCost = getRequiredPrefund({
+        userOperation,
+        entryPointVersion: entryPoint.version
+    })
+
+    // represents the userOperation's max cost in denomination of wei
+    const maxCostInWei =
+        userOperationMaxCost + postOpGas * userOperation.maxFeePerGas
+
+    // represents the userOperation's max cost in token denomination (wei)
+    const costInToken = (maxCostInWei * exchangeRate) / BigInt(1e18)
+
+    // represents the userOperation's max cost in usd (with 6 decimals of precision)
+    const costInUsd = (maxCostInWei * exchangeRateNativeToUsd) / 10n ** 18n
+
+    return {
+        costInToken,
+        costInUsd
+    }
+}

package/clients/decorators/pimlico.ts

@@ -10,6 +10,11 @@ import {
     sendCompressedUserOperation,
     validateSponsorshipPolicies
 } from "../../actions/pimlico.js"
+import {
+    type EstimateErc20PaymasterCostParameters,
+    type EstimateErc20PaymasterCostReturnType,
+    estimateErc20PaymasterCost
+} from "../../actions/pimlico/estimateErc20PaymasterCost.js"
 import {
     type GetUserOperationGasPriceReturnType,
     getUserOperationGasPrice
@@ -124,6 +129,18 @@ export type PimlicoActions<
             >
         >
     ) => Promise<Prettify<GetTokenQuotesReturnType>>
+    estimateErc20PaymasterCost: <
+        TChainOverride extends Chain | undefined = Chain | undefined
+    >(
+        args: Omit<
+            EstimateErc20PaymasterCostParameters<
+                entryPointVersion,
+                TChain,
+                TChainOverride
+            >,
+            "entryPoint"
+        >
+    ) => Promise<Prettify<EstimateErc20PaymasterCostReturnType>>
 }
 
 export const pimlicoActions =
@@ -162,5 +179,11 @@ export const pimlicoActions =
                 ...args,
                 chain: args.chain,
                 entryPointAddress: entryPoint.address
+            }),
+        estimateErc20PaymasterCost: async (args) =>
+            estimateErc20PaymasterCost(client, {
+                ...args,
+                entryPoint,
+                chain: args.chain
             })
     })

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.2.49",
+    "version": "0.2.50",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",