permissionless 0.0.3 → 0.0.5

package/_types/actions/index.d.ts

@@ -1,5 +1,7 @@
 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 };
+import { bundlerActions, chainId, estimateUserOperationGas, getUserOperationByHash, getUserOperationReceipt, sendUserOperation, supportedEntryPoints } from "./bundler";
+import type { GetSenderAddressParams } from "./public";
+import { getSenderAddress } from "./public";
+export type { SendUserOperationParameters, EstimateUserOperationGasParameters, EstimateUserOperationGasReturnType, GetUserOperationByHashParameters, GetUserOperationByHashReturnType, GetUserOperationReceiptParameters, GetUserOperationReceiptReturnType, GetSenderAddressParams };
+export { bundlerActions, sendUserOperation, estimateUserOperationGas, supportedEntryPoints, chainId, getUserOperationByHash, getUserOperationReceipt, getSenderAddress };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"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,EACH,cAAc,EACd,OAAO,EACP,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACvB,MAAM,WAAW,CAAA;AAElB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAE3C,YAAY,EACR,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,gCAAgC,EAChC,gCAAgC,EAChC,iCAAiC,EACjC,iCAAiC,EACjC,sBAAsB,EACzB,CAAA;AAED,OAAO,EACH,cAAc,EACd,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,OAAO,EACP,sBAAsB,EACtB,uBAAuB,EACvB,gBAAgB,EACnB,CAAA"}

package/_types/actions/pimlico.d.ts

@@ -34,8 +34,7 @@ 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationGasPrice
  *
  * @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
@@ -57,8 +56,7 @@ export declare const getUserOperationGasPrice: (client: PimlicoBundlerClient) =>
 /**
  * Returns the status of the userOperation that is pending in the mempool.
  *
- * - Docs: [TODO://add link]
- * - Example: [TODO://add link]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationStatus
  *
  * @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.
@@ -82,8 +80,7 @@ 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]
+     * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationGasPrice
      *
      * @returns slow, standard & fast values for maxFeePerGas & maxPriorityFeePerGas {@link GetUserOperationGasPriceReturnType}
      *
@@ -103,8 +100,7 @@ export type PimlicoBundlerActions = {
     /**
      * Returns the status of the userOperation that is pending in the mempool.
      *
-     * - Docs: [TODO://add link]
-     * - Example: [TODO://add link]
+     * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationStatus
      *
      * @param hash {@link Hash} UserOpHash that you must have received from sendUserOperation.
      * @returns status & transaction hash if included {@link GetUserOperationStatusReturnType}
@@ -126,8 +122,7 @@ export declare const pimlicoBundlerActions: (client: Client) => PimlicoBundlerAc
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
  *
- * - Docs: [TODO://add link]
- * - Example: [TODO://add link]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
  *
  * @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.
@@ -154,8 +149,7 @@ export type PimlicoPaymasterClientActions = {
     /**
      * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
      *
-     * - Docs: [TODO://add link]
-     * - Example: [TODO://add link]
+     * https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
      *
      * @param args {@link SponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
      * @returns paymasterAndData & updated gas parameters, see {@link SponsorUserOperationReturnType}

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,wBAAwB,WACzB,oBAAoB,KAC7B,QAAQ,kCAAkC,CAoB5C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,sBAAsB,WACvB,oBAAoB,YAClB,gCAAgC,KAC3C,QAAQ,gCAAgC,CAK1C,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,EAAE,MAAM,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,oBAAoB,WACrB,sBAAsB,QACxB,8BAA8B,KACrC,QAAQ,8BAA8B,CAYxC,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IACxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;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/public.d.ts

@@ -0,0 +1,41 @@
+import type { Address, Hex, PublicClient } from "viem";
+import { BaseError } from "viem";
+export type GetSenderAddressParams = {
+    initCode: Hex;
+    entryPoint: Address;
+};
+export declare class InvalidEntryPointError extends BaseError {
+    name: string;
+    constructor({ cause, entryPoint }?: {
+        cause?: BaseError;
+        entryPoint?: Address;
+    });
+}
+/**
+ * Returns the address of the account that will be deployed with the given init code.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/public-actions/getSenderAddress
+ *
+ *
+ * @param publicClient {@link PublicClient} that you created using viem's createPublicClient.
+ * @param args {@link GetSenderAddressParams}
+ * @returns Address
+ *
+ * @example
+ * import { createPublicClient } from "viem"
+ * import { getSenderAddress } from "permissionless/actions"
+ *
+ * const publicClient = createPublicClient({
+ *      chain: goerli,
+ *      transport: http("https://goerli.infura.io/v3/your-infura-key")
+ * })
+ *
+ * const senderAddress = await getSenderAddress(publicClient, {
+ *      initCode,
+ *      entryPoint
+ * })
+ *
+ * // Return '0x7a88a206ba40b37a8c07a2b5688cf8b287318b63'
+ */
+export declare const getSenderAddress: (publicClient: PublicClient, { initCode, entryPoint }: GetSenderAddressParams) => Promise<Address>;
+//# sourceMappingURL=public.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../actions/public.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,OAAO,EAGP,GAAG,EACH,YAAY,EACf,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEhC,MAAM,MAAM,sBAAsB,GAAG;IAAE,QAAQ,EAAE,GAAG,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE,CAAA;AAE3E,qBAAa,sBAAuB,SAAQ,SAAS;IACxC,IAAI,SAA2B;gBAE5B,EAAE,KAAK,EAAE,UAAU,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,SAAS,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO;CAUtF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,gBAAgB,iBACX,YAAY,4BACA,sBAAsB,KACjD,QAAQ,OAAO,CAgDjB,CAAA"}

package/_types/clients/bundler.d.ts

@@ -5,10 +5,9 @@ export type BundlerClient = Client<Transport, Chain | undefined, Account | undef
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/bundlerClient
  *
- * 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).
+ * 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.
  *
  * @param config - {@link PublicClientConfig}
  * @returns A Bundler Client. {@link BundlerClient}
@@ -23,10 +22,6 @@ export type BundlerClient = Client<Transport, Chain | undefined, Account | undef
  * })
  */
 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;
@@ -34,6 +29,10 @@ export declare const createBundlerClient: <transport extends Transport, chain ex
         } | undefined;
     } | undefined;
     cacheTime?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
     transport: transport;
 }) => BundlerClient;
 //# sourceMappingURL=bundler.d.ts.map

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;MAE7B,aASF,CAAA"}

package/_types/clients/pimlico.d.ts

@@ -7,8 +7,7 @@ export type PimlicoPaymasterClient = Client<Transport, Chain | undefined, Accoun
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/pimlicoBundlerClient
  *
  * 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).
  *
@@ -25,10 +24,6 @@ export type PimlicoPaymasterClient = Client<Transport, Chain | undefined, Accoun
  * })
  */
 export declare const createPimlicoBundlerClient: <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;
@@ -36,15 +31,18 @@ export declare const createPimlicoBundlerClient: <transport extends Transport, c
         } | undefined;
     } | undefined;
     cacheTime?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
     transport: transport;
 }) => PimlicoBundlerClient;
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/pimlicoPaymasterClient
  *
- * 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).
+ * 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.
  *
  * @param config - {@link PublicClientConfig}
  * @returns A Pimlico Paymaster Client. {@link PimlicoPaymasterClient}
@@ -59,10 +57,6 @@ export declare const createPimlicoBundlerClient: <transport extends Transport, c
  * })
  */
 export declare const createPimlicoPaymasterClient: <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;
@@ -70,6 +64,10 @@ export declare const createPimlicoPaymasterClient: <transport extends Transport,
         } | undefined;
     } | undefined;
     cacheTime?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
     transport: transport;
 }) => PimlicoPaymasterClient;
 //# sourceMappingURL=pimlico.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../clients/pimlico.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,EACH,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAGrC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AAE1F,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACrC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,uBAAuB,EACvB,qBAAqB,GAAG,cAAc,CACzC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACvC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,yBAAyB,EACzB,6BAA6B,CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;MAEpC,oBASF,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;MAEtC,sBASF,CAAA"}
+{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../clients/pimlico.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,EACH,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAGrC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AAE1F,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACrC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,uBAAuB,EACvB,qBAAqB,GAAG,cAAc,CACzC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACvC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,yBAAyB,EACzB,6BAA6B,CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;MAEpC,oBASF,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;MAEtC,sBASF,CAAA"}

package/_types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./actions";
 export * from "./clients";
 export * from "./types";
+export * from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/_types/index.d.ts.map

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

package/_types/utils/index.d.ts

@@ -0,0 +1,31 @@
+import type { Address, Hash } from "viem";
+import type { UserOperation } from "../types";
+export type GetUserOperationHashParams = {
+    userOperation: UserOperation;
+    entryPoint: Address;
+    chainId: number;
+};
+/**
+ *
+ * Returns user operation hash that is a unique identifier of the user operation.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/utils/getUserOperationHash
+ *
+ * @param args: userOperation, entryPoint, chainId as {@link GetUserOperationHashParams}
+ * @returns userOperationHash as {@link Hash}
+ *
+ * @example
+ * import { getUserOperationHash } from "permissionless/utils"
+ *
+ * const userOperationHash = getUserOperationHash({
+ *      userOperation,
+ *      entryPoint,
+ *      chainId
+ * })
+ *
+ * // Returns "0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34"
+ *
+ */
+declare const getUserOperationHash: ({ userOperation, entryPoint, chainId }: GetUserOperationHashParams) => Hash;
+export { getUserOperationHash };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAO,MAAM,MAAM,CAAA;AAE9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAmC7C,MAAM,MAAM,0BAA0B,GAAG;IAAE,aAAa,EAAE,aAAa,CAAC;IAAC,UAAU,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE/G;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,oBAAoB,2CAA4C,0BAA0B,KAAG,IAOlG,CAAA;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAA"}

package/actions/bundler.ts

@@ -204,7 +204,7 @@ export const supportedEntryPoints = async (client: BundlerClient): Promise<Addre
  *
  */
 export const chainId = async (client: BundlerClient) => {
-    return BigInt(
+    return Number(
         await client.request({
             method: "eth_chainId",
             params: []
@@ -435,7 +435,7 @@ export type BundlerActions = {
      * const chainId = await bundlerClient.chainId()
      * // Return 5n for Goerli
      */
-    chainId: () => Promise<bigint>
+    chainId: () => Promise<number>
     /**
      *
      * Returns the user operation from userOpHash
@@ -495,4 +495,4 @@ const bundlerActions = (client: Client): BundlerActions => ({
         getUserOperationReceipt(client as BundlerClient, args)
 })
 
-export default bundlerActions
+export { bundlerActions }

package/actions/index.ts

@@ -8,7 +8,8 @@ import type {
     SendUserOperationParameters
 } from "./bundler"
 
-import bundlerActions, {
+import {
+    bundlerActions,
     chainId,
     estimateUserOperationGas,
     getUserOperationByHash,
@@ -17,6 +18,10 @@ import bundlerActions, {
     supportedEntryPoints
 } from "./bundler"
 
+import type { GetSenderAddressParams } from "./public"
+
+import { getSenderAddress } from "./public"
+
 export type {
     SendUserOperationParameters,
     EstimateUserOperationGasParameters,
@@ -24,7 +29,8 @@ export type {
     GetUserOperationByHashParameters,
     GetUserOperationByHashReturnType,
     GetUserOperationReceiptParameters,
-    GetUserOperationReceiptReturnType
+    GetUserOperationReceiptReturnType,
+    GetSenderAddressParams
 }
 
 export {
@@ -34,5 +40,6 @@ export {
     supportedEntryPoints,
     chainId,
     getUserOperationByHash,
-    getUserOperationReceipt
+    getUserOperationReceipt,
+    getSenderAddress
 }

package/actions/pimlico.ts

@@ -44,8 +44,7 @@ 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationGasPrice
  *
  * @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
@@ -90,8 +89,7 @@ export const getUserOperationGasPrice = async (
 /**
  * Returns the status of the userOperation that is pending in the mempool.
  *
- * - Docs: [TODO://add link]
- * - Example: [TODO://add link]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationStatus
  *
  * @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.
@@ -124,8 +122,7 @@ 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]
+     * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationGasPrice
      *
      * @returns slow, standard & fast values for maxFeePerGas & maxPriorityFeePerGas {@link GetUserOperationGasPriceReturnType}
      *
@@ -145,8 +142,7 @@ export type PimlicoBundlerActions = {
     /**
      * Returns the status of the userOperation that is pending in the mempool.
      *
-     * - Docs: [TODO://add link]
-     * - Example: [TODO://add link]
+     * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-bundler-actions/getUserOperationStatus
      *
      * @param hash {@link Hash} UserOpHash that you must have received from sendUserOperation.
      * @returns status & transaction hash if included {@link GetUserOperationStatusReturnType}
@@ -174,8 +170,7 @@ export const pimlicoBundlerActions = (client: Client): PimlicoBundlerActions =>
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
  *
- * - Docs: [TODO://add link]
- * - Example: [TODO://add link]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
  *
  * @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.
@@ -218,8 +213,7 @@ export type PimlicoPaymasterClientActions = {
     /**
      * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
      *
-     * - Docs: [TODO://add link]
-     * - Example: [TODO://add link]
+     * https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
      *
      * @param args {@link SponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
      * @returns paymasterAndData & updated gas parameters, see {@link SponsorUserOperationReturnType}

package/actions/public.ts

@@ -0,0 +1,104 @@
+import type {
+    Address,
+    ContractFunctionExecutionErrorType,
+    ContractFunctionRevertedErrorType,
+    Hex,
+    PublicClient
+} from "viem"
+import { BaseError } from "viem"
+
+export type GetSenderAddressParams = { initCode: Hex; entryPoint: Address }
+
+export class InvalidEntryPointError extends BaseError {
+    override name = "InvalidEntryPointError"
+
+    constructor({ cause, entryPoint }: { cause?: BaseError; entryPoint?: Address } = {}) {
+        super(
+            `The entry point address (\`entryPoint\`${
+                entryPoint ? ` = ${entryPoint}` : ""
+            }) is not a valid entry point. getSenderAddress did not revert with a SenderAddressResult error.`,
+            {
+                cause
+            }
+        )
+    }
+}
+
+/**
+ * Returns the address of the account that will be deployed with the given init code.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/public-actions/getSenderAddress
+ *
+ *
+ * @param publicClient {@link PublicClient} that you created using viem's createPublicClient.
+ * @param args {@link GetSenderAddressParams}
+ * @returns Address
+ *
+ * @example
+ * import { createPublicClient } from "viem"
+ * import { getSenderAddress } from "permissionless/actions"
+ *
+ * const publicClient = createPublicClient({
+ *      chain: goerli,
+ *      transport: http("https://goerli.infura.io/v3/your-infura-key")
+ * })
+ *
+ * const senderAddress = await getSenderAddress(publicClient, {
+ *      initCode,
+ *      entryPoint
+ * })
+ *
+ * // Return '0x7a88a206ba40b37a8c07a2b5688cf8b287318b63'
+ */
+export const getSenderAddress = async (
+    publicClient: PublicClient,
+    { initCode, entryPoint }: GetSenderAddressParams
+): Promise<Address> => {
+    try {
+        await publicClient.simulateContract({
+            address: entryPoint,
+            abi: [
+                {
+                    inputs: [
+                        {
+                            internalType: "address",
+                            name: "sender",
+                            type: "address"
+                        }
+                    ],
+                    name: "SenderAddressResult",
+                    type: "error"
+                },
+                {
+                    inputs: [
+                        {
+                            internalType: "bytes",
+                            name: "initCode",
+                            type: "bytes"
+                        }
+                    ],
+                    name: "getSenderAddress",
+                    outputs: [],
+                    stateMutability: "nonpayable",
+                    type: "function"
+                }
+            ],
+            functionName: "getSenderAddress",
+            args: [initCode]
+        })
+    } catch (e) {
+        const err = e as ContractFunctionExecutionErrorType
+
+        if (err.cause.name === "ContractFunctionRevertedError") {
+            const revertError = err.cause as ContractFunctionRevertedErrorType
+            const errorName = revertError.data?.errorName ?? ""
+            if (errorName === "SenderAddressResult" && revertError.data?.args && revertError.data?.args[0]) {
+                return revertError.data?.args[0] as Address
+            }
+        }
+
+        throw e
+    }
+
+    throw new InvalidEntryPointError({ entryPoint })
+}

package/clients/bundler.ts

@@ -8,10 +8,9 @@ export type BundlerClient = Client<Transport, Chain | undefined, Account | undef
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/bundlerClient
  *
- * 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).
+ * 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.
  *
  * @param config - {@link PublicClientConfig}
  * @returns A Bundler Client. {@link BundlerClient}

package/clients/pimlico.ts

@@ -29,8 +29,7 @@ export type PimlicoPaymasterClient = Client<
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/pimlicoBundlerClient
  *
  * 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).
  *
@@ -62,10 +61,9 @@ export const createPimlicoBundlerClient = <transport extends Transport, chain ex
 /**
  * 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]
+ * - Docs: https://docs.pimlico.io/permissionless/reference/clients/pimlicoPaymasterClient
  *
- * 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).
+ * 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.
  *
  * @param config - {@link PublicClientConfig}
  * @returns A Pimlico Paymaster Client. {@link PimlicoPaymasterClient}

package/index.ts

@@ -1,3 +1,4 @@
 export * from "./actions"
 export * from "./clients"
 export * from "./types"
+export * from "./utils"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "author": "Pimlico",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -42,9 +42,14 @@
             "types": "./_types/clients/pimlico.d.ts",
             "import": "./_esm/clients/pimlico.js",
             "default": "./_cjs/clients/pimlico.js"
+        },
+        "./utils": {
+            "types": "./_types/utils/index.d.ts",
+            "import": "./_esm/utils/index.js",
+            "default": "./_cjs/utils/index.js"
         }
     },
     "peerDependencies": {
-        "viem": "^1.10.10"
+        "viem": "^1.14.0"
     }
 }