permissionless 0.0.1 → 0.0.3

package/_esm/actions/pimlico.js

@@ -0,0 +1,127 @@
+import { deepHexlify } from "./utils";
+/**
+ * Returns the live gas prices that you can use to send a user operation.
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * @param client {@link PimlicoBundlerClient} that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @returns slow, standard & fast values for maxFeePerGas & maxPriorityFeePerGas
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { getUserOperationGasPrice } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+ * })
+ *
+ * await getUserOperationGasPrice(bundlerClient)
+ *
+ */
+export const getUserOperationGasPrice = async (client) => {
+    const gasPrices = await client.request({
+        method: "pimlico_getUserOperationGasPrice",
+        params: []
+    });
+    return {
+        slow: {
+            maxFeePerGas: BigInt(gasPrices.slow.maxFeePerGas),
+            maxPriorityFeePerGas: BigInt(gasPrices.slow.maxPriorityFeePerGas)
+        },
+        standard: {
+            maxFeePerGas: BigInt(gasPrices.standard.maxFeePerGas),
+            maxPriorityFeePerGas: BigInt(gasPrices.standard.maxPriorityFeePerGas)
+        },
+        fast: {
+            maxFeePerGas: BigInt(gasPrices.fast.maxFeePerGas),
+            maxPriorityFeePerGas: BigInt(gasPrices.fast.maxPriorityFeePerGas)
+        }
+    };
+};
+/**
+ * Returns the status of the userOperation that is pending in the mempool.
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * @param client {@link PimlicoBundlerClient} that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @param hash {@link Hash} UserOpHash that you must have received from sendUserOperation.
+ * @returns status & transaction hash if included {@link GetUserOperationStatusReturnType}
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { getUserOperationStatus } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+ * })
+ *
+ * await getUserOperationStatus(bundlerClient, { hash: userOpHash })
+ *
+ */
+export const getUserOperationStatus = async (client, { hash }) => {
+    return client.request({
+        method: "pimlico_getUserOperationStatus",
+        params: [hash]
+    });
+};
+export const pimlicoBundlerActions = (client) => ({
+    getUserOperationGasPrice: async () => getUserOperationGasPrice(client),
+    getUserOperationStatus: async (args) => getUserOperationStatus(client, args)
+});
+/**
+ * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * @param client {@link PimlicoBundlerClient} that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
+ * @param args {@link sponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
+ * @returns paymasterAndData & updated gas parameters, see {@link SponsorUserOperationReturnType}
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { sponsorUserOperation } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+ * })
+ *
+ * await sponsorUserOperation(bundlerClient, {
+ *      userOperation: userOperationWithDummySignature,
+ *      entryPoint: entryPoint
+ * }})
+ *
+ */
+export const sponsorUserOperation = async (client, args) => {
+    const response = await client.request({
+        method: "pm_sponsorUserOperation",
+        params: [deepHexlify(args.userOperation), args.entryPoint]
+    });
+    return {
+        paymasterAndData: response.paymasterAndData,
+        preVerificationGas: BigInt(response.preVerificationGas),
+        verificationGasLimit: BigInt(response.verificationGasLimit),
+        callGasLimit: BigInt(response.callGasLimit)
+    };
+};
+export const pimlicoPaymasterActions = (client) => ({
+    sponsorUserOperation: async (args) => sponsorUserOperation(client, args)
+});
+/**
+ * TODO: Add support for pimlicoActions after we support all the actions of v1 in v2 of the Pimlico API.
+ */
+// export const pimlicoActions = (client: Client) => {
+//     return {
+//         ...pimlicoBundlerActions(client),
+//         ...pimlicoPaymasterActions(client)
+//     }
+// }
+//# sourceMappingURL=pimlico.js.map

package/_esm/actions/pimlico.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../actions/pimlico.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAsCrC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EACzC,MAA4B,EACe,EAAE;IAC7C,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,kCAAkC;QAC1C,MAAM,EAAE,EAAE;KACb,CAAC,CAAA;IAEF,OAAO;QACH,IAAI,EAAE;YACF,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;YACjD,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC;SACpE;QACD,QAAQ,EAAE;YACN,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrD,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC;SACxE;QACD,IAAI,EAAE;YACF,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;YACjD,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC;SACpE;KACJ,CAAA;AACL,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EACvC,MAA4B,EAC5B,EAAE,IAAI,EAAoC,EACD,EAAE;IAC3C,OAAO,MAAM,CAAC,OAAO,CAAC;QAClB,MAAM,EAAE,gCAAgC;QACxC,MAAM,EAAE,CAAC,IAAI,CAAC;KACjB,CAAC,CAAA;AACN,CAAC,CAAA;AA+CD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAyB,EAAE,CAAC,CAAC;IAC7E,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAA8B,CAAC;IAC9F,sBAAsB,EAAE,KAAK,EAAE,IAAsC,EAAE,EAAE,CACrE,sBAAsB,CAAC,MAA8B,EAAE,IAAI,CAAC;CACnE,CAAC,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACrC,MAA8B,EAC9B,IAAoC,EACG,EAAE;IACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAClC,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,CAAiC,EAAE,IAAI,CAAC,UAAU,CAAC;KAC7F,CAAC,CAAA;IAEF,OAAO;QACH,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;QAC3C,kBAAkB,EAAE,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC;QACvD,oBAAoB,EAAE,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC;QAC3D,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC;KAC9C,CAAA;AACL,CAAC,CAAA;AA8BD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAc,EAAiC,EAAE,CAAC,CAAC;IACvF,oBAAoB,EAAE,KAAK,EAAE,IAAoC,EAAE,EAAE,CACjE,oBAAoB,CAAC,MAAgC,EAAE,IAAI,CAAC;CACnE,CAAC,CAAA;AAEF;;GAEG;AACH,sDAAsD;AACtD,eAAe;AACf,4CAA4C;AAC5C,6CAA6C;AAC7C,QAAQ;AACR,IAAI"}

package/_esm/actions/utils.js

@@ -0,0 +1,28 @@
+import { toHex } from "viem";
+export const transactionReceiptStatus = {
+    "0x0": "reverted",
+    "0x1": "success"
+};
+// biome-ignore lint/suspicious/noExplicitAny: it's a recursive function, so it's hard to type
+export function deepHexlify(obj) {
+    if (typeof obj === "function") {
+        return undefined;
+    }
+    if (obj == null || typeof obj === "string" || typeof obj === "boolean") {
+        return obj;
+    }
+    else if (typeof obj === "bigint") {
+        return toHex(obj);
+    }
+    else if (obj._isBigNumber != null || typeof obj !== "object") {
+        return toHex(obj).replace(/^0x0/, "0x");
+    }
+    if (Array.isArray(obj)) {
+        return obj.map((member) => deepHexlify(member));
+    }
+    return Object.keys(obj).reduce((set, key) => ({
+        ...set,
+        [key]: deepHexlify(obj[key])
+    }), {});
+}
+//# sourceMappingURL=utils.js.map

package/_esm/actions/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../actions/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAA;AAE5B,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACpC,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,SAAS;CACV,CAAA;AAEV,8FAA8F;AAC9F,MAAM,UAAU,WAAW,CAAC,GAAQ;IAChC,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;QAC3B,OAAO,SAAS,CAAA;KACnB;IACD,IAAI,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE;QACpE,OAAO,GAAG,CAAA;KACb;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;KACpB;SAAM,IAAI,GAAG,CAAC,YAAY,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC5D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;KAC1C;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACpB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;KAClD;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAC1B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACX,GAAG,GAAG;QACN,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KAC/B,CAAC,EACF,EAAE,CACL,CAAA;AACL,CAAC"}

package/_esm/clients/bundler.js

@@ -0,0 +1,33 @@
+import { createClient } from "viem";
+import { bundlerActions } from "../actions";
+/**
+ * Creates a EIP-4337 compliant Bundler Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * A Bundler Client is an interface to "erc 4337" [JSON-RPC API](https://eips.ethereum.org/EIPS/eip-4337#rpc-methods-eth-namespace) methods such as sending user operation, estimating gas for a user operation, get user operation receipt, etc through [Bundler Actions](TODO://Add bundler action documentation link).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Bundler Client. {@link BundlerClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const bundlerClient = createBundlerClient({
+ *   chain: mainnet,
+ *   transport: http(BUNDLER_URL),
+ * })
+ */
+export const createBundlerClient = (parameters) => {
+    const { key = "public", name = "Bundler Client" } = parameters;
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        type: "bundlerClient"
+    });
+    return client.extend(bundlerActions);
+};
+//# sourceMappingURL=bundler.js.map

package/_esm/clients/bundler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundler.js","sourceRoot":"","sources":["../../clients/bundler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAK3C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAC/B,UAAgD,EACnC,EAAE;IACf,MAAM,EAAE,GAAG,GAAG,QAAQ,EAAE,IAAI,GAAG,gBAAgB,EAAE,GAAG,UAAU,CAAA;IAC9D,MAAM,MAAM,GAAG,YAAY,CAAC;QACxB,GAAG,UAAU;QACb,GAAG;QACH,IAAI;QACJ,IAAI,EAAE,eAAe;KACxB,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;AACxC,CAAC,CAAA"}

package/_esm/clients/index.js

@@ -0,0 +1,3 @@
+import { createBundlerClient } from "./bundler";
+export { createBundlerClient };
+//# sourceMappingURL=index.js.map

package/_esm/clients/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../clients/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,mBAAmB,EAAsB,CAAA"}

package/_esm/clients/pimlico.js

@@ -0,0 +1,64 @@
+import { createClient } from "viem";
+import { bundlerActions } from "../actions";
+import { pimlicoBundlerActions, pimlicoPaymasterActions } from "../actions/pimlico";
+/**
+ * Creates a pimlico specific Bundler Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * A Pimlico Client is an interface to "pimlico endpoints" [JSON-RPC API](https://docs.pimlico.io/reference/bundler/endpoints) methods such as getting current blockchain gas prices, getting user operation status, etc through [Pimlico Bundler Actions](TODO://Add bundler action documentation link).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Pimlico Bundler Client. {@link PimlicoBundlerClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const pimlicoBundlerClient = createPimlicoBundlerClient({
+ *   chain: mainnet,
+ *   transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE"),
+ * })
+ */
+export const createPimlicoBundlerClient = (parameters) => {
+    const { key = "public", name = "Pimlico Bundler Client" } = parameters;
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        type: "pimlicoBundlerClient"
+    });
+    return client.extend(bundlerActions).extend(pimlicoBundlerActions);
+};
+/**
+ * Creates a pimlico specific Paymaster Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * A Pimlico Paymaster Client is an interface to "pimlico paymaster endpoints" [JSON-RPC API](https://docs.pimlico.io/reference/verifying-paymaster/endpoints) methods such as sponsoring user operation, etc through [Pimlico Paymaster Actions](TODO://Add bundler action documentation link).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Pimlico Paymaster Client. {@link PimlicoPaymasterClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const pimlicoPaymasterClient = createPimlicoPaymasterClient({
+ *   chain: mainnet,
+ *   transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE"),
+ * })
+ */
+export const createPimlicoPaymasterClient = (parameters) => {
+    const { key = "public", name = "Pimlico Paymaster Client" } = parameters;
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        type: "pimlicoPaymasterClient"
+    });
+    return client.extend(pimlicoPaymasterActions);
+};
+//# sourceMappingURL=pimlico.js.map

package/_esm/clients/pimlico.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../clients/pimlico.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,OAAO,EAGH,qBAAqB,EACrB,uBAAuB,EAC1B,MAAM,oBAAoB,CAAA;AAmB3B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACtC,UAAgD,EAC5B,EAAE;IACtB,MAAM,EAAE,GAAG,GAAG,QAAQ,EAAE,IAAI,GAAG,wBAAwB,EAAE,GAAG,UAAU,CAAA;IACtE,MAAM,MAAM,GAAG,YAAY,CAAC;QACxB,GAAG,UAAU;QACb,GAAG;QACH,IAAI;QACJ,IAAI,EAAE,sBAAsB;KAC/B,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAA;AACtE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CACxC,UAAgD,EAC1B,EAAE;IACxB,MAAM,EAAE,GAAG,GAAG,QAAQ,EAAE,IAAI,GAAG,0BAA0B,EAAE,GAAG,UAAU,CAAA;IACxE,MAAM,MAAM,GAAG,YAAY,CAAC;QACxB,GAAG,UAAU;QACb,GAAG;QACH,IAAI;QACJ,IAAI,EAAE,wBAAwB;KACjC,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAA;AACjD,CAAC,CAAA"}

package/_esm/index.js

@@ -0,0 +1,4 @@
+export * from "./actions";
+export * from "./clients";
+export * from "./types";
+//# sourceMappingURL=index.js.map

package/_esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/_esm/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}

package/_esm/types/bundler.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bundler.js.map

package/_esm/types/bundler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundler.js","sourceRoot":"","sources":["../../types/bundler.ts"],"names":[],"mappings":""}

package/_esm/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/_esm/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":""}

package/_esm/types/pimlico.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pimlico.js.map

package/_esm/types/pimlico.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.js","sourceRoot":"","sources":["../../types/pimlico.ts"],"names":[],"mappings":""}

package/_esm/types/userOperation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=userOperation.js.map

package/_esm/types/userOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userOperation.js","sourceRoot":"","sources":["../../types/userOperation.ts"],"names":[],"mappings":""}