permissionless 0.0.1 → 0.0.3

package/_types/actions/bundler.d.ts

@@ -0,0 +1,393 @@
+import type { Address } from "abitype";
+import type { Client, Hash, Hex } from "viem";
+import type { PartialBy } from "viem/types/utils";
+import type { BundlerClient } from "../clients/bundler";
+import type { UserOperation } from "../types";
+import type { TStatus } from "../types/userOperation";
+export type SendUserOperationParameters = {
+    userOperation: UserOperation;
+    entryPoint: Address;
+};
+export type EstimateUserOperationGasParameters = {
+    userOperation: PartialBy<UserOperation, "callGasLimit" | "preVerificationGas" | "verificationGasLimit">;
+    entryPoint: Address;
+};
+export type EstimateUserOperationGasReturnType = {
+    preVerificationGas: bigint;
+    verificationGasLimit: bigint;
+    callGasLimit: bigint;
+};
+export type GetUserOperationByHashParameters = {
+    hash: Hash;
+};
+export type GetUserOperationByHashReturnType = {
+    userOperation: UserOperation;
+    entryPoint: Address;
+    transactionHash: Hash;
+    blockHash: Hash;
+    blockNumber: bigint;
+} | null;
+export type GetUserOperationReceiptParameters = {
+    hash: Hash;
+};
+export type GetUserOperationReceiptReturnType = {
+    userOpHash: Hash;
+    sender: Address;
+    nonce: bigint;
+    actualGasUsed: bigint;
+    actualGasCost: bigint;
+    success: boolean;
+    receipt: {
+        transactionHash: Hex;
+        transactionIndex: bigint;
+        blockHash: Hash;
+        blockNumber: bigint;
+        from: Address;
+        to: Address | null;
+        cumulativeGasUsed: bigint;
+        status: TStatus;
+        gasUsed: bigint;
+        contractAddress: Address | null;
+        logsBloom: Hex;
+        effectiveGasPrice: bigint;
+    };
+    logs: {
+        data: Hex;
+        blockNumber: bigint;
+        blockHash: Hash;
+        transactionHash: Hash;
+        logIndex: bigint;
+        transactionIndex: bigint;
+        address: Address;
+        topics: Hex[];
+    }[];
+} | null;
+/**
+ * Sends user operation to the bundler
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/sendUserOperation
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @param args {@link SendUserOperationParameters}.
+ * @returns UserOpHash that you can use to track user operation as {@link Hash}.
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { sendUserOperation } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * const userOpHash = sendUserOperation(bundlerClient, {
+ *      userOperation: signedUserOperation,
+ *      entryPoint: entryPoint
+ * })
+ *
+ * // Return '0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34'
+ *
+ */
+export declare const sendUserOperation: (client: BundlerClient, args: SendUserOperationParameters) => Promise<Hash>;
+/**
+ * Estimates preVerificationGas, verificationGasLimit and callGasLimit for user operation
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/estimateUserOperationGas
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @param args {@link EstimateUserOperationGasParameters}
+ * @returns preVerificationGas, verificationGasLimit and callGasLimit as {@link EstimateUserOperationGasReturnType}
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { estimateUserOperationGas } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * const gasParameters = estimateUserOperationGas(bundlerClient, {
+ *      serOperation: signedUserOperation,
+ *      entryPoint: entryPoint
+ * })
+ *
+ * // Return {preVerificationGas: 43492n, verificationGasLimit: 59436n, callGasLimit: 9000n}
+ *
+ */
+export declare const estimateUserOperationGas: (client: BundlerClient, args: EstimateUserOperationGasParameters) => Promise<EstimateUserOperationGasReturnType>;
+/**
+ * Returns the supported entrypoints by the bundler service
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/supportedEntryPoints
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @returns Supported entryPoints
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { supportedEntryPoints } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * const entryPointsSupported = supportedEntryPoints(bundlerClient)
+ * // Return ['0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789']
+ *
+ */
+export declare const supportedEntryPoints: (client: BundlerClient) => Promise<Address[]>;
+/**
+ * Returns the supported chain id by the bundler service
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/chainId
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @returns Supported chain id
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { chainId } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * const bundlerChainId = chainId(bundlerClient)
+ * // Return 5n for Goerli
+ *
+ */
+export declare const chainId: (client: BundlerClient) => Promise<bigint>;
+/**
+ * Returns the user operation from userOpHash
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/getUserOperationByHash
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @param args {@link GetUserOperationByHashParameters} UserOpHash that was returned by {@link sendUserOperation}
+ * @returns userOperation along with entryPoint, transactionHash, blockHash, blockNumber if found or null
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { getUserOperationByHash } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * getUserOperationByHash(bundlerClient, {hash: userOpHash})
+ *
+ */
+export declare const getUserOperationByHash: (client: BundlerClient, { hash }: GetUserOperationByHashParameters) => Promise<{
+    userOperation: UserOperation;
+    entryPoint: Address;
+    transactionHash: Hash;
+    blockHash: Hash;
+    blockNumber: bigint;
+} | null>;
+/**
+ * Returns the user operation receipt from userOpHash
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/getUserOperationReceipt
+ *
+ * @param client {@link BundlerClient} that you created using viem's createClient and extended it with bundlerActions.
+ * @param args {@link GetUserOperationReceiptParameters} UserOpHash that was returned by {@link sendUserOperation}
+ * @returns user operation receipt {@link GetUserOperationReceiptReturnType} if found or null
+ *
+ *
+ * @example
+ * import { createClient } from "viem"
+ * import { getUserOperationReceipt } from "permissionless/actions"
+ *
+ * const bundlerClient = createClient({
+ *      chain: goerli,
+ *      transport: http(BUNDLER_URL)
+ * })
+ *
+ * getUserOperationReceipt(bundlerClient, {hash: userOpHash})
+ *
+ */
+export declare const getUserOperationReceipt: (client: BundlerClient, { hash }: GetUserOperationReceiptParameters) => Promise<{
+    userOpHash: Hash;
+    sender: Address;
+    nonce: bigint;
+    actualGasUsed: bigint;
+    actualGasCost: bigint;
+    success: boolean;
+    receipt: {
+        transactionHash: Hex;
+        transactionIndex: bigint;
+        blockHash: Hash;
+        blockNumber: bigint;
+        from: Address;
+        to: Address | null;
+        cumulativeGasUsed: bigint;
+        status: TStatus;
+        gasUsed: bigint;
+        contractAddress: Address | null;
+        logsBloom: Hex;
+        effectiveGasPrice: bigint;
+    };
+    logs: {
+        data: Hex;
+        blockNumber: bigint;
+        blockHash: Hash;
+        transactionHash: Hash;
+        logIndex: bigint;
+        transactionIndex: bigint;
+        address: Address;
+        topics: Hex[];
+    }[];
+} | null>;
+export type BundlerActions = {
+    /**
+     *
+     * Sends user operation to the bundler
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/sendUserOperation
+     *
+     * @param args {@link SendUserOperationParameters}.
+     * @returns UserOpHash that you can use to track user operation as {@link Hash}.
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     * }).extend(bundlerActions)
+     *
+     * const userOpHash = await bundlerClient.sendUserOperation({
+     *      userOperation: signedUserOperation,
+     *      entryPoint: entryPoint
+     * })
+     *
+     * // Return '0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34'
+     */
+    sendUserOperation: (args: SendUserOperationParameters) => Promise<Hash>;
+    /**
+     *
+     * Estimates preVerificationGas, verificationGasLimit and callGasLimit for user operation
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/estimateUserOperationGas
+     *
+     * @param args {@link EstimateUserOperationGasParameters}
+     * @returns preVerificationGas, verificationGasLimit and callGasLimit as {@link EstimateUserOperationGasReturnType}
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http(BUNDLER_URL)
+     * }).extend(bundlerActions)
+     *
+     * const gasParameters = await bundlerClient.estimateUserOperationGas({
+     *     userOperation: signedUserOperation,
+     *    entryPoint: entryPoint
+     * })
+     *
+     * // Return {preVerificationGas: 43492n, verificationGasLimit: 59436n, callGasLimit: 9000n}
+     */
+    estimateUserOperationGas: (args: EstimateUserOperationGasParameters) => Promise<EstimateUserOperationGasReturnType>;
+    /**
+     *
+     * Returns the supported entrypoints by the bundler service
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/supportedEntryPoints
+     *
+     * @returns Supported entryPoints
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http(BUNDLER_URL)
+     * }).extend(bundlerActions)
+     *
+     * const supportedEntryPoints = await bundlerClient.supportedEntryPoints()
+     *
+     * // Return ['0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789']
+     */
+    supportedEntryPoints: () => Promise<Address[]>;
+    /**
+     *
+     * Returns the supported chain id by the bundler service
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/chainId
+     *
+     * @returns Supported chain id
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http(BUNDLER_URL)
+     * }).extend(bundlerActions)
+     *
+     * const chainId = await bundlerClient.chainId()
+     * // Return 5n for Goerli
+     */
+    chainId: () => Promise<bigint>;
+    /**
+     *
+     * Returns the user operation from userOpHash
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/getUserOperationByHash
+     *
+     * @param args {@link GetUserOperationByHash} UserOpHash that was returned by {@link sendUserOperation}
+     * @returns userOperation along with entryPoint, transactionHash, blockHash, blockNumber if found or null
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http(BUNDLER_URL)
+     * }).extend(bundlerActions)
+     *
+     * await bundlerClient.getUserOperationByHash(userOpHash)
+     *
+     */
+    getUserOperationByHash: (args: GetUserOperationByHashParameters) => Promise<GetUserOperationByHashReturnType>;
+    /**
+     *
+     * Returns the user operation receipt from userOpHash
+     *
+     * - Docs: https://docs.pimlico.io/permissionless/reference/bundler-actions/getUserOperationReceipt
+     *
+     * @param args {@link GetUserOperationReceiptParameters} UserOpHash that was returned by {@link sendUserOperation}
+     * @returns user operation receipt {@link GetUserOperationReceiptReturnType} if found or null
+     *
+     * @example
+     * import { createClient } from "viem"
+     * import { bundlerActions } from "permissionless"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http(BUNDLER_URL)
+     * }).extend(bundlerActions)
+     *
+     * await bundlerClient.getUserOperationReceipt({hash: userOpHash})
+     *
+     */
+    getUserOperationReceipt: (args: GetUserOperationReceiptParameters) => Promise<GetUserOperationReceiptReturnType>;
+};
+declare const bundlerActions: (client: Client) => BundlerActions;
+export default bundlerActions;
+//# sourceMappingURL=bundler.d.ts.map

package/_types/actions/bundler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundler.d.ts","sourceRoot":"","sources":["../../actions/bundler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAgC,MAAM,wBAAwB,CAAA;AAGnF,MAAM,MAAM,2BAA2B,GAAG;IACtC,aAAa,EAAE,aAAa,CAAA;IAC5B,UAAU,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,kCAAkC,GAAG;IAC7C,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,CAAC,CAAA;IACvG,UAAU,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,kCAAkC,GAAG;IAC7C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC3C,IAAI,EAAE,IAAI,CAAA;CACb,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC3C,aAAa,EAAE,aAAa,CAAA;IAC5B,UAAU,EAAE,OAAO,CAAA;IACnB,eAAe,EAAE,IAAI,CAAA;IACrB,SAAS,EAAE,IAAI,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;CACtB,GAAG,IAAI,CAAA;AAER,MAAM,MAAM,iCAAiC,GAAG;IAC5C,IAAI,EAAE,IAAI,CAAA;CACb,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC5C,UAAU,EAAE,IAAI,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE;QACL,eAAe,EAAE,GAAG,CAAA;QACpB,gBAAgB,EAAE,MAAM,CAAA;QACxB,SAAS,EAAE,IAAI,CAAA;QACf,WAAW,EAAE,MAAM,CAAA;QACnB,IAAI,EAAE,OAAO,CAAA;QACb,EAAE,EAAE,OAAO,GAAG,IAAI,CAAA;QAClB,iBAAiB,EAAE,MAAM,CAAA;QACzB,MAAM,EAAE,OAAO,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;QACf,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;QAC/B,SAAS,EAAE,GAAG,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC5B,CAAA;IACD,IAAI,EAAE;QACF,IAAI,EAAE,GAAG,CAAA;QACT,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,IAAI,CAAA;QACf,eAAe,EAAE,IAAI,CAAA;QACrB,QAAQ,EAAE,MAAM,CAAA;QAChB,gBAAgB,EAAE,MAAM,CAAA;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,GAAG,EAAE,CAAA;KAChB,EAAE,CAAA;CACN,GAAG,IAAI,CAAA;AAER;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,iBAAiB,WAAkB,aAAa,QAAQ,2BAA2B,KAAG,QAAQ,IAAI,CAO9G,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,wBAAwB,WACzB,aAAa,QACf,kCAAkC,KACzC,QAAQ,kCAAkC,CAa5C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,oBAAoB,WAAkB,aAAa,KAAG,QAAQ,OAAO,EAAE,CAKnF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,OAAO,WAAkB,aAAa,oBAOlD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,sBAAsB,WACvB,aAAa,YACX,gCAAgC;mBAE3B,aAAa;gBAChB,OAAO;qBACF,IAAI;eACV,IAAI;iBACF,MAAM;SA4BtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,uBAAuB,WAAkB,aAAa,YAAY,iCAAiC;gBA/PhG,IAAI;YACR,OAAO;WACR,MAAM;mBACE,MAAM;mBACN,MAAM;aACZ,OAAO;aACP;QACL,eAAe,EAAE,GAAG,CAAA;QACpB,gBAAgB,EAAE,MAAM,CAAA;QACxB,SAAS,EAAE,IAAI,CAAA;QACf,WAAW,EAAE,MAAM,CAAA;QACnB,IAAI,EAAE,OAAO,CAAA;QACb,EAAE,EAAE,OAAO,GAAG,IAAI,CAAA;QAClB,iBAAiB,EAAE,MAAM,CAAA;QACzB,QAAQ,OAAO,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;QACf,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;QAC/B,SAAS,EAAE,GAAG,CAAA;QACd,iBAAiB,EAAE,MAAM,CAAA;KAC5B;UACK;QACF,IAAI,EAAE,GAAG,CAAA;QACT,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,IAAI,CAAA;QACf,eAAe,EAAE,IAAI,CAAA;QACrB,QAAQ,EAAE,MAAM,CAAA;QAChB,gBAAgB,EAAE,MAAM,CAAA;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,GAAG,EAAE,CAAA;KAChB,EAAE;SA8QN,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IACzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACvE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,wBAAwB,EAAE,CAAC,IAAI,EAAE,kCAAkC,KAAK,OAAO,CAAC,kCAAkC,CAAC,CAAA;IACnH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAAsB,EAAE,CAAC,IAAI,EAAE,gCAAgC,KAAK,OAAO,CAAC,gCAAgC,CAAC,CAAA;IAC7G;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,EAAE,CAAC,IAAI,EAAE,iCAAiC,KAAK,OAAO,CAAC,iCAAiC,CAAC,CAAA;CACnH,CAAA;AAED,QAAA,MAAM,cAAc,WAAY,MAAM,KAAG,cAWvC,CAAA;AAEF,eAAe,cAAc,CAAA"}

package/_types/actions/index.d.ts

@@ -0,0 +1,5 @@
+import type { EstimateUserOperationGasParameters, EstimateUserOperationGasReturnType, GetUserOperationByHashParameters, GetUserOperationByHashReturnType, GetUserOperationReceiptParameters, GetUserOperationReceiptReturnType, SendUserOperationParameters } from "./bundler";
+import bundlerActions, { chainId, estimateUserOperationGas, getUserOperationByHash, getUserOperationReceipt, sendUserOperation, supportedEntryPoints } from "./bundler";
+export type { SendUserOperationParameters, EstimateUserOperationGasParameters, EstimateUserOperationGasReturnType, GetUserOperationByHashParameters, GetUserOperationByHashReturnType, GetUserOperationReceiptParameters, GetUserOperationReceiptReturnType };
+export { bundlerActions, sendUserOperation, estimateUserOperationGas, supportedEntryPoints, chainId, getUserOperationByHash, getUserOperationReceipt };
+//# sourceMappingURL=index.d.ts.map

package/_types/actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../actions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kCAAkC,EAClC,kCAAkC,EAClC,gCAAgC,EAChC,gCAAgC,EAChC,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC9B,MAAM,WAAW,CAAA;AAElB,OAAO,cAAc,EAAE,EACnB,OAAO,EACP,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACvB,MAAM,WAAW,CAAA;AAElB,YAAY,EACR,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,gCAAgC,EAChC,gCAAgC,EAChC,iCAAiC,EACjC,iCAAiC,EACpC,CAAA;AAED,OAAO,EACH,cAAc,EACd,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,OAAO,EACP,sBAAsB,EACtB,uBAAuB,EAC1B,CAAA"}

package/_types/actions/pimlico.d.ts

@@ -0,0 +1,184 @@
+import type { Address, Client, Hash, Hex } from "viem";
+import type { PartialBy } from "viem/types/utils";
+import type { PimlicoBundlerClient, PimlicoPaymasterClient } from "../clients/pimlico";
+import type { PimlicoUserOperationStatus } from "../types/pimlico";
+import type { UserOperation } from "../types/userOperation";
+export type SponsorUserOperationParameters = {
+    userOperation: PartialBy<UserOperation, "callGasLimit" | "preVerificationGas" | "verificationGasLimit" | "paymasterAndData">;
+    entryPoint: Address;
+};
+export type SponsorUserOperationReturnType = {
+    paymasterAndData: Hex;
+    preVerificationGas: bigint;
+    verificationGasLimit: bigint;
+    callGasLimit: bigint;
+};
+export type GetUserOperationGasPriceReturnType = {
+    slow: {
+        maxFeePerGas: bigint;
+        maxPriorityFeePerGas: bigint;
+    };
+    standard: {
+        maxFeePerGas: bigint;
+        maxPriorityFeePerGas: bigint;
+    };
+    fast: {
+        maxFeePerGas: bigint;
+        maxPriorityFeePerGas: bigint;
+    };
+};
+export type GetUserOperationStatusParameters = {
+    hash: Hash;
+};
+export type GetUserOperationStatusReturnType = PimlicoUserOperationStatus;
+/**
+ * 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 declare const getUserOperationGasPrice: (client: PimlicoBundlerClient) => Promise<GetUserOperationGasPriceReturnType>;
+/**
+ * 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 declare const getUserOperationStatus: (client: PimlicoBundlerClient, { hash }: GetUserOperationStatusParameters) => Promise<GetUserOperationStatusReturnType>;
+export type PimlicoBundlerActions = {
+    /**
+     * Returns the live gas prices that you can use to send a user operation.
+     *
+     * - Docs: [TODO://add link]
+     * - Example: [TODO://add link]
+     *
+     * @returns slow, standard & fast values for maxFeePerGas & maxPriorityFeePerGas {@link GetUserOperationGasPriceReturnType}
+     *
+     * @example
+     *
+     * import { createClient } from "viem"
+     * import { pimlicoBundlerActions } from "permissionless/actions"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     * }).extend(pimlicoBundlerActions)
+     *
+     * await bundlerClient.getUserOperationGasPrice()
+     */
+    getUserOperationGasPrice: () => Promise<GetUserOperationGasPriceReturnType>;
+    /**
+     * Returns the status of the userOperation that is pending in the mempool.
+     *
+     * - Docs: [TODO://add link]
+     * - Example: [TODO://add link]
+     *
+     * @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 { pimlicoBundlerActions } from "permissionless/actions"
+     *
+     * const bundlerClient = createClient({
+     *      chain: goerli,
+     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     * }).extend(pimlicoBundlerActions)
+     *
+     * await bundlerClient.getUserOperationStatus({ hash: userOpHash })
+     */
+    getUserOperationStatus: (args: GetUserOperationStatusParameters) => Promise<GetUserOperationStatusReturnType>;
+};
+export declare const pimlicoBundlerActions: (client: Client) => PimlicoBundlerActions;
+/**
+ * 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 declare const sponsorUserOperation: (client: PimlicoPaymasterClient, args: SponsorUserOperationParameters) => Promise<SponsorUserOperationReturnType>;
+export type PimlicoPaymasterClientActions = {
+    /**
+     * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
+     *
+     * - Docs: [TODO://add link]
+     * - Example: [TODO://add link]
+     *
+     * @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")
+     * }).extend(pimlicoPaymasterActions)
+     *
+     * await bundlerClient.sponsorUserOperation(bundlerClient, {
+     *      userOperation: userOperationWithDummySignature,
+     *      entryPoint: entryPoint
+     * }})
+     *
+     */
+    sponsorUserOperation: (args: SponsorUserOperationParameters) => Promise<SponsorUserOperationReturnType>;
+};
+export declare const pimlicoPaymasterActions: (client: Client) => PimlicoPaymasterClientActions;
+/**
+ * TODO: Add support for pimlicoActions after we support all the actions of v1 in v2 of the Pimlico API.
+ */
+//# sourceMappingURL=pimlico.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../actions/pimlico.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AACtF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAgC,MAAM,wBAAwB,CAAA;AAGzF,MAAM,MAAM,8BAA8B,GAAG;IACzC,aAAa,EAAE,SAAS,CACpB,aAAa,EACb,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,kBAAkB,CACtF,CAAA;IACD,UAAU,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IACzC,gBAAgB,EAAE,GAAG,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,kCAAkC,GAAG;IAC7C,IAAI,EAAE;QACF,YAAY,EAAE,MAAM,CAAA;QACpB,oBAAoB,EAAE,MAAM,CAAA;KAC/B,CAAA;IACD,QAAQ,EAAE;QACN,YAAY,EAAE,MAAM,CAAA;QACpB,oBAAoB,EAAE,MAAM,CAAA;KAC/B,CAAA;IACD,IAAI,EAAE;QACF,YAAY,EAAE,MAAM,CAAA;QACpB,oBAAoB,EAAE,MAAM,CAAA;KAC/B,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC3C,IAAI,EAAE,IAAI,CAAA;CACb,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB,WACzB,oBAAoB,KAC7B,QAAQ,kCAAkC,CAoB5C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,sBAAsB,WACvB,oBAAoB,YAClB,gCAAgC,KAC3C,QAAQ,gCAAgC,CAK1C,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,EAAE,MAAM,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,sBAAsB,EAAE,CAAC,IAAI,EAAE,gCAAgC,KAAK,OAAO,CAAC,gCAAgC,CAAC,CAAA;CAChH,CAAA;AAED,eAAO,MAAM,qBAAqB,WAAY,MAAM,KAAG,qBAIrD,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,oBAAoB,WACrB,sBAAsB,QACxB,8BAA8B,KACrC,QAAQ,8BAA8B,CAYxC,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IACxC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,oBAAoB,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,OAAO,CAAC,8BAA8B,CAAC,CAAA;CAC1G,CAAA;AAED,eAAO,MAAM,uBAAuB,WAAY,MAAM,KAAG,6BAGvD,CAAA;AAEF;;GAEG"}

package/_types/actions/utils.d.ts

@@ -0,0 +1,6 @@
+export declare const transactionReceiptStatus: {
+    readonly "0x0": "reverted";
+    readonly "0x1": "success";
+};
+export declare function deepHexlify(obj: any): any;
+//# sourceMappingURL=utils.d.ts.map

package/_types/actions/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../actions/utils.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,wBAAwB;;;CAG3B,CAAA;AAGV,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAqBzC"}

package/_types/clients/bundler.d.ts

@@ -0,0 +1,39 @@
+import type { Account, Chain, Client, PublicClientConfig, Transport } from "viem";
+import type { BundlerActions } from "../actions/bundler";
+import type { BundlerRpcSchema } from "../types/bundler";
+export type BundlerClient = Client<Transport, Chain | undefined, Account | undefined, BundlerRpcSchema, BundlerActions>;
+/**
+ * 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 declare const createBundlerClient: <transport extends Transport, chain extends Chain | undefined = undefined>(parameters: {
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    batch?: {
+        multicall?: boolean | {
+            batchSize?: number | undefined;
+            wait?: number | undefined;
+        } | undefined;
+    } | undefined;
+    cacheTime?: number | undefined;
+    transport: transport;
+}) => BundlerClient;
+//# sourceMappingURL=bundler.d.ts.map

package/_types/clients/bundler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundler.d.ts","sourceRoot":"","sources":["../../clients/bundler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAGjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,GAAG,SAAS,EAAE,gBAAgB,EAAE,cAAc,CAAC,CAAA;AACvH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;MAE7B,aASF,CAAA"}

package/_types/clients/index.d.ts

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

package/_types/clients/index.d.ts.map

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