@zerodev/sdk 5.3.26 → 5.4.0-beta.1

package/clients/kernelAccountClient.ts

@@ -1,139 +1,177 @@
-import { getEntryPointVersion } from "permissionless"
-import type { SmartAccount } from "permissionless/accounts"
-import type { Middleware } from "permissionless/actions/smartAccount"
-import type { EntryPoint, Prettify } from "permissionless/types"
-import type { BundlerRpcSchema } from "permissionless/types/bundler"
 import {
-    http,
+    type BundlerRpcSchema,
     type Chain,
     type Client,
     type ClientConfig,
+    type EstimateFeesPerGasReturnType,
+    type Prettify,
+    type RpcSchema,
     type Transport,
     createClient
 } from "viem"
-import type { KernelSmartAccount } from "../accounts/index.js"
-import { getUserOperationGasPrice } from "../actions/account-client/getUserOperationGasPrice.js"
+import {
+    type BundlerActions,
+    type BundlerClientConfig,
+    type PaymasterActions,
+    type PrepareUserOperationParameters,
+    type SmartAccount,
+    type UserOperationRequest,
+    bundlerActions,
+    type prepareUserOperation as viemPrepareUserOperation
+} from "viem/account-abstraction"
 import {
     type KernelAccountClientActions,
     kernelAccountClientActions
 } from "./decorators/kernel.js"
-import { isProviderSet, setPimlicoAsProvider } from "./utils.js"
 
 export type KernelAccountClient<
-    entryPoint extends EntryPoint,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
-    account extends
-        | KernelSmartAccount<entryPoint, transport, chain>
-        | undefined =
-        | KernelSmartAccount<entryPoint, transport, chain>
-        | undefined
-> = Client<
-    transport,
-    chain,
-    account,
-    BundlerRpcSchema<entryPoint>,
-    KernelAccountClientActions<entryPoint, transport, chain, account>
->
+    account extends SmartAccount | undefined = SmartAccount | undefined,
+    client extends Client | undefined = Client | undefined,
+    rpcSchema extends RpcSchema | undefined = undefined
+> = Prettify<
+    Client<
+        transport,
+        chain extends Chain
+            ? chain
+            : // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+              client extends Client<any, infer chain>
+              ? chain
+              : undefined,
+        account,
+        rpcSchema extends RpcSchema
+            ? [...BundlerRpcSchema, ...rpcSchema]
+            : BundlerRpcSchema,
+        BundlerActions<account> & KernelAccountClientActions<chain, account>
+    >
+> & {
+    client: client
+    paymaster: BundlerClientConfig["paymaster"] | undefined
+    paymasterContext: BundlerClientConfig["paymasterContext"] | undefined
+    userOperation: BundlerClientConfig["userOperation"] | undefined
+}
 
 export type SmartAccountClientConfig<
-    entryPoint extends EntryPoint,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
-    account extends
-        | SmartAccount<entryPoint, string, transport, chain>
-        | undefined =
-        | SmartAccount<entryPoint, string, transport, chain>
-        | undefined
+    account extends SmartAccount | undefined = SmartAccount | undefined,
+    client extends Client | undefined = Client | undefined,
+    rpcSchema extends RpcSchema | undefined = undefined
 > = Prettify<
     Pick<
-        ClientConfig<transport, chain, account>,
-        "cacheTime" | "chain" | "key" | "name" | "pollingInterval"
-    > & {
-        account?: account
-        bundlerTransport: Transport
-    } & Middleware<entryPoint> & {
-            entryPoint: entryPoint
-        }
->
-
-export const createKernelAccountClient = <
-    TTransport extends Transport,
-    TChain extends Chain | undefined,
-    TEntryPoint extends EntryPoint,
-    TSmartAccount extends
-        | KernelSmartAccount<TEntryPoint, TTransport, TChain>
-        | undefined =
-        | KernelSmartAccount<TEntryPoint, TTransport, TChain>
+        ClientConfig<transport, chain, account, rpcSchema>,
+        | "account"
+        | "cacheTime"
+        | "chain"
+        | "key"
+        | "name"
+        | "pollingInterval"
+        | "rpcSchema"
+    >
+> & {
+    bundlerTransport: transport
+    /** Client that points to an Execution RPC URL. */
+    client?: client | Client | undefined
+    /** Paymaster configuration. */
+    paymaster?:
+        | true
+        | {
+              /** Retrieves paymaster-related User Operation properties to be used for sending the User Operation. */
+              getPaymasterData?:
+                  | PaymasterActions["getPaymasterData"]
+                  | undefined
+              /** Retrieves paymaster-related User Operation properties to be used for gas estimation. */
+              getPaymasterStubData?:
+                  | PaymasterActions["getPaymasterStubData"]
+                  | undefined
+          }
+        | undefined
+    /** Paymaster context to pass to `getPaymasterData` and `getPaymasterStubData` calls. */
+    paymasterContext?: unknown
+    /** User Operation configuration. */
+    userOperation?:
+        | {
+              /** Prepares fee properties for the User Operation request. */
+              estimateFeesPerGas?:
+                  | ((parameters: {
+                        account: account | SmartAccount
+                        bundlerClient: Client
+                        userOperation: UserOperationRequest
+                    }) => Promise<EstimateFeesPerGasReturnType<"eip1559">>)
+                  | undefined
+              /** Prepare User Operation configuration. */
+              prepareUserOperation?: typeof viemPrepareUserOperation | undefined
+          }
         | undefined
+}
+
+export function createKernelAccountClient<
+    transport extends Transport,
+    chain extends Chain | undefined = undefined,
+    account extends SmartAccount | undefined = undefined,
+    client extends Client | undefined = undefined,
+    rpcSchema extends RpcSchema | undefined = undefined
 >(
     parameters: SmartAccountClientConfig<
-        TEntryPoint,
-        TTransport,
-        TChain,
-        TSmartAccount
+        transport,
+        chain,
+        account,
+        client,
+        rpcSchema
     >
-): KernelAccountClient<TEntryPoint, TTransport, TChain, TSmartAccount> => {
+): KernelAccountClient<transport, chain, account, client, rpcSchema>
+
+export function createKernelAccountClient(
+    parameters: SmartAccountClientConfig
+): KernelAccountClient {
     const {
+        client: client_,
         key = "Account",
         name = "Kernel Account Client",
+        paymaster,
+        paymasterContext,
         bundlerTransport,
-        entryPoint
+        userOperation
     } = parameters
-    const entryPointVersion = getEntryPointVersion(entryPoint)
-    const shouldIncludePimlicoProvider =
-        bundlerTransport({}).config.key === "http" &&
-        entryPointVersion === "v0.7"
 
-    const client = createClient({
-        ...parameters,
-        key,
-        name,
-        transport: (opts) => {
-            let _bundlerTransport = bundlerTransport({
-                ...opts,
-                timeout: bundlerTransport({}).config.timeout,
-                retryCount: 0
-            })
-            if (
-                !shouldIncludePimlicoProvider ||
-                isProviderSet(_bundlerTransport.value?.url, "ALCHEMY") ||
-                isProviderSet(_bundlerTransport.value?.url, "ZERODEV") ||
-                isProviderSet(_bundlerTransport.value?.url, "THIRDWEB") ||
-                isProviderSet(_bundlerTransport.value?.url, "CONDUIT")
-            )
-                return _bundlerTransport
-            _bundlerTransport = http(
-                setPimlicoAsProvider(_bundlerTransport.value?.url)
-            )({
-                ...opts,
-                timeout: bundlerTransport({}).config.timeout,
-                retryCount: 0
-            })
-            return _bundlerTransport
-        },
-        type: "kernelAccountClient"
-    })
+    const client = Object.assign(
+        createClient({
+            ...parameters,
+            chain: parameters.chain ?? client_?.chain,
+            transport: bundlerTransport,
+            key,
+            name,
+            type: "kernelAccountClient"
+        }),
+        { client: client_, paymaster, paymasterContext, userOperation }
+    )
 
-    let middleware = parameters.middleware
+    if (parameters.userOperation?.prepareUserOperation) {
+        const customPrepareUserOp =
+            parameters.userOperation.prepareUserOperation
 
-    if (
-        (!middleware ||
-            (typeof middleware !== "function" && !middleware.gasPrice)) &&
-        client.transport?.url &&
-        (isProviderSet(client.transport.url, "PIMLICO") ||
-            isProviderSet(client.transport.url, "THIRDWEB") ||
-            isProviderSet(client.transport.url, "CONDUIT"))
-    ) {
-        const gasPrice = () => getUserOperationGasPrice(client)
-        middleware = {
-            ...middleware,
-            gasPrice
-        }
+        return client
+            .extend(bundlerActions)
+            .extend((client) => ({
+                prepareUserOperation: (
+                    args: PrepareUserOperationParameters
+                ) => {
+                    return customPrepareUserOp(client, args)
+                }
+            }))
+            .extend(bundlerActions)
+            .extend((client) => ({
+                prepareUserOperation: (
+                    args: PrepareUserOperationParameters
+                ) => {
+                    return customPrepareUserOp(client, args)
+                }
+            }))
+            .extend(kernelAccountClientActions()) as KernelAccountClient
     }
-    return client.extend(
-        kernelAccountClientActions({
-            middleware
-        })
-    ) as KernelAccountClient<TEntryPoint, TTransport, TChain, TSmartAccount>
+
+    return client
+        .extend(bundlerActions)
+        .extend(kernelAccountClientActions()) as KernelAccountClient
 }

package/clients/paymasterClient.ts

@@ -1,28 +1,71 @@
-import { getEntryPointVersion } from "permissionless"
-import type { EntryPoint } from "permissionless/types/entrypoint"
 import {
-    http,
-    type Account,
+    type Address,
     type Chain,
     type Client,
+    type ClientConfig,
+    type Prettify,
     type PublicClientConfig,
+    type RpcSchema,
     type Transport,
     createClient
 } from "viem"
-import type { ZeroDevPaymasterRpcSchema } from "../types/kernel.js"
 import {
-    type ZeroDevPaymasterClientActions,
-    zerodevPaymasterActions
-} from "./decorators/kernel.js"
-import { isProviderSet, setPimlicoAsProvider } from "./utils.js"
+    type PaymasterActions,
+    type SmartAccount,
+    entryPoint07Address,
+    paymasterActions
+} from "viem/account-abstraction"
+import type { ZeroDevPaymasterRpcSchema } from "../types/kernel.js"
+import { zerodevPaymasterActions } from "./decorators/kernel.js"
 
-export type ZeroDevPaymasterClient<entryPoint extends EntryPoint> = Client<
-    Transport,
-    Chain | undefined,
-    Account | undefined,
-    ZeroDevPaymasterRpcSchema<entryPoint>,
-    ZeroDevPaymasterClientActions<entryPoint>
+export type ZeroDevPaymasterClient<
+    entryPointVersion extends "0.6" | "0.7" = "0.7",
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends SmartAccount | undefined = SmartAccount | undefined,
+    client extends Client | undefined = Client | undefined,
+    rpcSchema extends RpcSchema | undefined = undefined
+> = Prettify<
+    Client<
+        transport,
+        chain extends Chain
+            ? chain
+            : // biome-ignore lint/suspicious/noExplicitAny: We need any to infer the chain type
+              client extends Client<any, infer chain>
+              ? chain
+              : undefined,
+        account,
+        rpcSchema extends RpcSchema
+            ? [...ZeroDevPaymasterRpcSchema<entryPointVersion>, ...rpcSchema]
+            : ZeroDevPaymasterRpcSchema<entryPointVersion>,
+        PaymasterActions
+    >
 >
+
+export type ZeroDevPaymasterClientConfig<
+    entryPointVersion extends "0.6" | "0.7" = "0.7" | "0.6",
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends SmartAccount | undefined = SmartAccount | undefined,
+    rpcSchema extends RpcSchema | undefined = undefined
+> = Prettify<
+    Pick<
+        ClientConfig<transport, chain, account, rpcSchema>,
+        | "account"
+        | "cacheTime"
+        | "chain"
+        | "key"
+        | "name"
+        | "pollingInterval"
+        | "rpcSchema"
+        | "transport"
+    >
+> & {
+    entryPoint?: {
+        address: Address
+        version: entryPointVersion
+    }
+}
 /**
  * Creates a ZeroDev-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).
  *
@@ -40,48 +83,31 @@ export type ZeroDevPaymasterClient<entryPoint extends EntryPoint> = Client<
  *   transport: http(`https://rpc.zerodev.app/api/v2/paymaster/${projectId}`),
  * })
  */
-export const createZeroDevPaymasterClient = <
-    entryPoint extends EntryPoint,
-    transport extends Transport,
-    chain extends Chain | undefined = undefined
->(
-    parameters: PublicClientConfig<transport, chain> & {
-        entryPoint: entryPoint
-    }
-): ZeroDevPaymasterClient<entryPoint> => {
+export const createZeroDevPaymasterClient = (
+    parameters: ZeroDevPaymasterClientConfig
+): ZeroDevPaymasterClient => {
     const {
         key = "public",
         name = "ZeroDev Paymaster Client",
-        entryPoint: entryPointAddress,
+        entryPoint,
         transport
     } = parameters
-    const entryPointVersion = getEntryPointVersion(entryPointAddress)
-    const shouldIncludePimlicoProvider =
-        transport({}).config.key === "http" && entryPointVersion === "v0.7"
     const client = createClient({
         ...parameters,
         transport: (opts) => {
-            let _transport = transport({
-                ...opts,
-                retryCount: 0
-            })
-            if (
-                !shouldIncludePimlicoProvider ||
-                isProviderSet(_transport.value?.url, "ALCHEMY") ||
-                isProviderSet(_transport.value?.url, "ZERODEV") ||
-                isProviderSet(_transport.value?.url, "THIRDWEB") ||
-                isProviderSet(_transport.value?.url, "CONDUIT")
-            )
-                return _transport
-            _transport = http(setPimlicoAsProvider(_transport.value?.url))({
+            return transport({
                 ...opts,
                 retryCount: 0
             })
-            return _transport
         },
         key,
         name,
         type: "zerodevPaymasterClient"
     })
-    return client.extend(zerodevPaymasterActions(parameters.entryPoint))
+    return client.extend(paymasterActions).extend(
+        zerodevPaymasterActions({
+            address: entryPoint?.address ?? entryPoint07Address,
+            version: entryPoint?.version ?? "0.7"
+        })
+    )
 }

package/errors/index.ts

@@ -0,0 +1,25 @@
+import { BaseError } from "viem"
+
+export class AccountNotFoundError extends BaseError {
+    constructor({ docsPath }: { docsPath?: string | undefined } = {}) {
+        super(
+            [
+                "Could not find an Account to execute with this Action.",
+                "Please provide an Account with the `account` argument on the Action, or by supplying an `account` to the Client."
+            ].join("\n"),
+            {
+                docsPath,
+                docsSlug: "account",
+                name: "AccountNotFoundError"
+            }
+        )
+    }
+}
+
+export class SignTransactionNotSupportedBySmartAccountError extends BaseError {
+    constructor() {
+        super("Smart account signer doesn't need to sign transactions", {
+            name: "SignTransactionNotSupportedError"
+        })
+    }
+}

package/gasTokenAddresses.ts

@@ -306,7 +306,7 @@ export type TokenSymbolsMap = {
     84532: "6TEST"
     421613: "USDC" | "6TEST"
     421614: "6TEST"
-    11155111: "6TEST"
+    11155111: "6TEST" | "USDC"
     11155420: "6TEST"
 }
 
@@ -662,7 +662,8 @@ export const gasTokenAddresses: {
         "6TEST": "0x3870419Ba2BBf0127060bCB37f69A1b1C090992B"
     },
     11155111: {
-        "6TEST": "0x3870419Ba2BBf0127060bCB37f69A1b1C090992B"
+        "6TEST": "0x3870419Ba2BBf0127060bCB37f69A1b1C090992B",
+        USDC: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238"
     },
     11155420: {
         "6TEST": "0x3870419Ba2BBf0127060bCB37f69A1b1C090992B"

package/index.ts

@@ -2,8 +2,11 @@ export {
     createKernelAccount,
     createKernelAccountV0_2,
     createKernelAccountV1,
-    type KernelSmartAccountV1,
-    type KernelSmartAccount,
+    type CreateKernelAccountParameters,
+    type CreateKernelAccountReturnType,
+    type CreateKernelAccountV1ReturnType,
+    type KernelSmartAccountImplementation,
+    type KernelSmartAccountV1Implementation,
     KERNEL_ADDRESSES,
     addressToEmptyAccount,
     EIP1271Abi,
@@ -63,3 +66,4 @@ export { getEncodedPluginsData } from "./accounts/kernel/utils/plugins/ep0_7/get
 export { isProviderSet, setPimlicoAsProvider } from "./clients/utils.js"
 export { getUserOperationGasPrice } from "./actions/account-client/getUserOperationGasPrice.js"
 export { isPluginInitialized } from "./accounts/kernel/utils/plugins/ep0_7/isPluginInitialized.js"
+export * from "./errors/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/sdk",
-    "version": "5.3.26",
+    "version": "5.4.0-beta.1",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -9,13 +9,7 @@
     "type": "module",
     "sideEffects": false,
     "description": "A utility library for working with ERC-4337",
-    "keywords": [
-        "ethereum",
-        "erc-4337",
-        "eip-4337",
-        "paymaster",
-        "bundler"
-    ],
+    "keywords": ["ethereum", "erc-4337", "eip-4337", "paymaster", "bundler"],
     "license": "MIT",
     "files": [
         "_esm",
@@ -96,35 +90,18 @@
     },
     "typesVersions": {
         "*": {
-            "accounts": [
-                "./_types/accounts/index.d.ts"
-            ],
-            "plugins": [
-                "./_types/plugins/index.d.ts"
-            ],
-            "actions": [
-                "./_types/actions/index.d.ts"
-            ],
-            "types": [
-                "./_types/types/index.d.ts"
-            ],
-            "actions/kernel": [
-                "./_types/actions/kernel/index.d.ts"
-            ],
-            "clients": [
-                "./_types/clients/index.d.ts"
-            ],
-            "clients/kernel": [
-                "./_types/clients/kernel/index.d.ts"
-            ],
-            "providers": [
-                "./_types/providers/index.d.ts"
-            ]
+            "accounts": ["./_types/accounts/index.d.ts"],
+            "plugins": ["./_types/plugins/index.d.ts"],
+            "actions": ["./_types/actions/index.d.ts"],
+            "types": ["./_types/types/index.d.ts"],
+            "actions/kernel": ["./_types/actions/kernel/index.d.ts"],
+            "clients": ["./_types/clients/index.d.ts"],
+            "clients/kernel": ["./_types/clients/kernel/index.d.ts"],
+            "providers": ["./_types/providers/index.d.ts"]
         }
     },
     "peerDependencies": {
-        "viem": ">=2.16.3 <2.18.0",
-        "permissionless": ">=0.1.44 <=0.1.45"
+        "viem": "^2.21.40"
     },
     "dependencies": {
         "semver": "^7.6.0"

package/providers/KernelEIP1193Provider.ts

@@ -1,19 +1,16 @@
 import { EventEmitter } from "events"
-import type { KernelAccountClient } from "@zerodev/sdk"
-import type { EntryPoint } from "permissionless/types"
 import type {
     EIP1193Parameters,
     EIP1193RequestFn,
     Hash,
     SendTransactionParameters
 } from "viem"
+import type { KernelAccountClient } from "../clients/kernelAccountClient.js"
 
-export class KernelEIP1193Provider<
-    entryPoint extends EntryPoint
-> extends EventEmitter {
-    private kernelClient: KernelAccountClient<entryPoint>
+export class KernelEIP1193Provider extends EventEmitter {
+    private kernelClient: KernelAccountClient
 
-    constructor(kernelClient: KernelAccountClient<entryPoint>) {
+    constructor(kernelClient: KernelAccountClient) {
         super()
         this.kernelClient = kernelClient
     }

package/types/index.ts

@@ -12,9 +12,12 @@ export type {
     KERNEL_V2_VERSION_TYPE,
     KERNEL_V3_VERSION_TYPE,
     KERNEL_VERSION_TYPE,
-    GetKernelVersion
+    GetKernelVersion,
+    GetEntryPointAbi
 } from "./kernel.js"
 
 export { ValidatorMode } from "./kernel.js"
 
 export type WithRequired<T, K extends keyof T> = Required<Pick<T, K>>
+
+export type PartialPick<T, K extends keyof T> = Partial<Pick<T, K>>