permissionless 0.0.11 → 0.0.13

package/clients/{bundler.ts → createBundlerClient.ts}

@@ -1,9 +1,17 @@
-import type { Account, Chain, Client, PublicClientConfig, Transport } from "viem"
+import type {
+    Account,
+    Chain,
+    Client,
+    PublicClientConfig,
+    Transport
+} from "viem"
 import { createClient } from "viem"
 import type { BundlerRpcSchema } from "../types/bundler.js"
 import { type BundlerActions, bundlerActions } from "./decorators/bundler.js"
 
-export type BundlerClient<TChain extends Chain | undefined = Chain | undefined> = Client<
+export type BundlerClient<
+    TChain extends Chain | undefined = Chain | undefined
+> = Client<
     Transport,
     TChain,
     Account | undefined,
@@ -29,7 +37,10 @@ export type BundlerClient<TChain extends Chain | undefined = Chain | undefined>
  *   transport: http(BUNDLER_URL),
  * })
  */
-export const createBundlerClient = <transport extends Transport, chain extends Chain | undefined = undefined>(
+export const createBundlerClient = <
+    transport extends Transport,
+    chain extends Chain | undefined = undefined
+>(
     parameters: PublicClientConfig<transport, chain>
 ): BundlerClient => {
     const { key = "public", name = "Bundler Client" } = parameters

package/clients/createSmartAccountClient.ts

@@ -0,0 +1,95 @@
+import type {
+    Chain,
+    Client,
+    ClientConfig,
+    ParseAccount,
+    Transport,
+    WalletClientConfig
+} from "viem"
+import { createClient } from "viem"
+import { type SmartAccount } from "../accounts/types.js"
+import { type SponsorUserOperationMiddleware } from "../actions/smartAccount/prepareUserOperationRequest.js"
+import { type BundlerRpcSchema } from "../types/bundler.js"
+import type { Prettify } from "../types/index.js"
+import {
+    type SmartAccountActions,
+    smartAccountActions
+} from "./decorators/smartAccount.js"
+
+export type SmartAccountClient<
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends SmartAccount | undefined = SmartAccount | undefined
+> = Prettify<
+    Client<
+        transport,
+        chain,
+        account,
+        BundlerRpcSchema,
+        SmartAccountActions<chain, account>
+    >
+>
+
+export type SmartAccountClientConfig<
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    TAccount extends SmartAccount | undefined = SmartAccount | undefined
+> = Prettify<
+    Pick<
+        ClientConfig<transport, chain, TAccount>,
+        | "account"
+        | "cacheTime"
+        | "chain"
+        | "key"
+        | "name"
+        | "pollingInterval"
+        | "transport"
+    >
+>
+
+/**
+ * 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: https://docs.pimlico.io/permissionless/reference/clients/smartAccountClient
+ *
+ * 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 WalletClientConfig}
+ * @returns A Bundler Client. {@link SmartAccountClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const smartAccountClient = createSmartAccountClient({
+ *   chain: mainnet,
+ *   transport: http(BUNDLER_URL),
+ * })
+ */
+export const createSmartAccountClient = <
+    TTransport extends Transport,
+    TChain extends Chain | undefined = undefined,
+    TSmartAccount extends SmartAccount | undefined = undefined
+>(
+    parameters: SmartAccountClientConfig<TTransport, TChain, TSmartAccount> &
+        SponsorUserOperationMiddleware
+): SmartAccountClient<TTransport, TChain, ParseAccount<TSmartAccount>> => {
+    const {
+        key = "Account",
+        name = "Smart Account Client",
+        transport
+    } = parameters
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        transport: (opts) => transport({ ...opts, retryCount: 0 }),
+        type: "smartAccountClient"
+    })
+
+    return client.extend(
+        smartAccountActions({
+            sponsorUserOperation: parameters.sponsorUserOperation
+        })
+    )
+}

package/clients/decorators/bundler.ts

@@ -16,13 +16,16 @@ import {
     type GetUserOperationReceiptReturnType,
     getUserOperationReceipt
 } from "../../actions/bundler/getUserOperationReceipt.js"
-import { type SendUserOperationParameters, sendUserOperation } from "../../actions/bundler/sendUserOperation.js"
+import {
+    type SendUserOperationParameters,
+    sendUserOperation
+} from "../../actions/bundler/sendUserOperation.js"
 import { supportedEntryPoints } from "../../actions/bundler/supportedEntryPoints.js"
 import {
     type WaitForUserOperationReceiptParameters,
     waitForUserOperationReceipt
 } from "../../actions/bundler/waitForUserOperationReceipt.js"
-import type { BundlerClient } from "../bundler.js"
+import type { BundlerClient } from "../createBundlerClient.js"
 
 export type BundlerActions = {
     /**
@@ -40,7 +43,7 @@ export type BundlerActions = {
      *
      * const bundlerClient = createClient({
      *      chain: goerli,
-     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     *      transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE")
      * }).extend(bundlerActions)
      *
      * const userOpHash = await bundlerClient.sendUserOperation({
@@ -76,7 +79,9 @@ export type BundlerActions = {
      *
      * // Return {preVerificationGas: 43492n, verificationGasLimit: 59436n, callGasLimit: 9000n}
      */
-    estimateUserOperationGas: (args: EstimateUserOperationGasParameters) => Promise<EstimateUserOperationGasReturnType>
+    estimateUserOperationGas: (
+        args: EstimateUserOperationGasParameters
+    ) => Promise<EstimateUserOperationGasReturnType>
     /**
      *
      * Returns the supported entrypoints by the bundler service
@@ -141,7 +146,9 @@ export type BundlerActions = {
      * await bundlerClient.getUserOperationByHash(userOpHash)
      *
      */
-    getUserOperationByHash: (args: GetUserOperationByHashParameters) => Promise<GetUserOperationByHashReturnType>
+    getUserOperationByHash: (
+        args: GetUserOperationByHashParameters
+    ) => Promise<GetUserOperationByHashReturnType>
     /**
      *
      * Returns the user operation receipt from userOpHash
@@ -194,18 +201,21 @@ export type BundlerActions = {
 }
 
 const bundlerActions = (client: Client): BundlerActions => ({
-    sendUserOperation: async (args: SendUserOperationParameters): Promise<Hash> =>
-        sendUserOperation(client as BundlerClient, args),
+    sendUserOperation: async (
+        args: SendUserOperationParameters
+    ): Promise<Hash> => sendUserOperation(client as BundlerClient, args),
     estimateUserOperationGas: (args: EstimateUserOperationGasParameters) =>
         estimateUserOperationGas(client as BundlerClient, args),
-    supportedEntryPoints: (): Promise<Address[]> => supportedEntryPoints(client as BundlerClient),
+    supportedEntryPoints: (): Promise<Address[]> =>
+        supportedEntryPoints(client as BundlerClient),
     chainId: () => chainId(client as BundlerClient),
     getUserOperationByHash: (args: GetUserOperationByHashParameters) =>
         getUserOperationByHash(client as BundlerClient, args),
     getUserOperationReceipt: (args: GetUserOperationReceiptParameters) =>
         getUserOperationReceipt(client as BundlerClient, args),
-    waitForUserOperationReceipt: (args: WaitForUserOperationReceiptParameters) =>
-        waitForUserOperationReceipt(client as BundlerClient, args)
+    waitForUserOperationReceipt: (
+        args: WaitForUserOperationReceiptParameters
+    ) => waitForUserOperationReceipt(client as BundlerClient, args)
 })
 
 export { bundlerActions }

package/clients/decorators/pimlico.ts

@@ -13,7 +13,10 @@ import {
     type SponsorUserOperationReturnType,
     sponsorUserOperation
 } from "../../actions/pimlico/sponsorUserOperation.js"
-import type { PimlicoBundlerClient, PimlicoPaymasterClient } from "../pimlico.js"
+import type {
+    PimlicoBundlerClient,
+    PimlicoPaymasterClient
+} from "../pimlico.js"
 
 export type PimlicoBundlerActions = {
     /**
@@ -30,7 +33,7 @@ export type PimlicoBundlerActions = {
      *
      * const bundlerClient = createClient({
      *      chain: goerli,
-     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     *      transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE")
      * }).extend(pimlicoBundlerActions)
      *
      * await bundlerClient.getUserOperationGasPrice()
@@ -50,16 +53,21 @@ export type PimlicoBundlerActions = {
      *
      * const bundlerClient = createClient({
      *      chain: goerli,
-     *      transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE")
+     *      transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE")
      * }).extend(pimlicoBundlerActions)
      *
      * await bundlerClient.getUserOperationStatus({ hash: userOpHash })
      */
-    getUserOperationStatus: (args: GetUserOperationStatusParameters) => Promise<GetUserOperationStatusReturnType>
+    getUserOperationStatus: (
+        args: GetUserOperationStatusParameters
+    ) => Promise<GetUserOperationStatusReturnType>
 }
 
-export const pimlicoBundlerActions = (client: Client): PimlicoBundlerActions => ({
-    getUserOperationGasPrice: async () => getUserOperationGasPrice(client as PimlicoBundlerClient),
+export const pimlicoBundlerActions = (
+    client: Client
+): PimlicoBundlerActions => ({
+    getUserOperationGasPrice: async () =>
+        getUserOperationGasPrice(client as PimlicoBundlerClient),
     getUserOperationStatus: async (args: GetUserOperationStatusParameters) =>
         getUserOperationStatus(client as PimlicoBundlerClient, args)
 })
@@ -88,16 +96,20 @@ export type PimlicoPaymasterClientActions = {
      * }})
      *
      */
-    sponsorUserOperation: (args: SponsorUserOperationParameters) => Promise<SponsorUserOperationReturnType>
+    sponsorUserOperation: (
+        args: SponsorUserOperationParameters
+    ) => Promise<SponsorUserOperationReturnType>
 }
 
-export const pimlicoPaymasterActions = (client: Client): PimlicoPaymasterClientActions => ({
+export const pimlicoPaymasterActions = (
+    client: Client
+): PimlicoPaymasterClientActions => ({
     sponsorUserOperation: async (args: SponsorUserOperationParameters) =>
         sponsorUserOperation(client as PimlicoPaymasterClient, args)
 })
 
 /**
- * TODO: Add support for pimlicoActions after we support all the actions of v1 in v2 of the Pimlico API.
+ * TODO: Add support for pimlicoActions after we support all the actions of v2 of the Pimlico API.
  */
 // export const pimlicoActions = (client: Client) => {
 //     return {