permissionless 0.0.3 → 0.0.4

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,

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/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.4",
     "author": "Pimlico",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -42,6 +42,11 @@
             "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": {