@zerodev/sdk 4.7.3 → 5.0.0-alpha-0

package/clients/decorators/kernel.ts

@@ -0,0 +1,97 @@
+import { type SmartAccountActions, smartAccountActions } from "permissionless"
+import type { SmartAccount } from "permissionless/accounts/types"
+import { type Middleware } from "permissionless/actions/smartAccount"
+import type { EntryPoint } from "permissionless/types"
+import type { Chain, Client, Transport } from "viem"
+import type {
+    SignUserOperationParameters,
+    SignUserOperationReturnType
+} from "../../actions/index.js"
+import { signUserOperation } from "../../actions/index.js"
+import {
+    type EstimateGasInERC20Parameters,
+    type EstimateGasInERC20ReturnType,
+    estimateGasInERC20
+} from "../../actions/paymaster/estimateGasInERC20.js"
+import {
+    type SponsorUserOperationParameters,
+    type SponsorUserOperationReturnType,
+    sponsorUserOperation
+} from "../../actions/paymaster/sponsorUserOperation.js"
+import type { ZeroDevPaymasterClient } from "../paymasterClient.js"
+
+export type ZeroDevPaymasterClientActions<entryPoint extends EntryPoint> = {
+    /**
+     * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
+     */
+    sponsorUserOperation: (
+        args: SponsorUserOperationParameters<entryPoint>
+    ) => Promise<SponsorUserOperationReturnType<entryPoint>>
+    estimateGasInERC20: (
+        args: EstimateGasInERC20Parameters
+    ) => Promise<EstimateGasInERC20ReturnType>
+}
+
+export const zerodevPaymasterActions =
+    <entryPoint extends EntryPoint>(entryPointAddress: entryPoint) =>
+    (client: Client): ZeroDevPaymasterClientActions<entryPoint> => ({
+        sponsorUserOperation: async (
+            args: Omit<SponsorUserOperationParameters<entryPoint>, "entryPoint">
+        ) =>
+            sponsorUserOperation(client as ZeroDevPaymasterClient<entryPoint>, {
+                ...args,
+                entryPoint: entryPointAddress
+            }),
+        estimateGasInERC20: async (args: EstimateGasInERC20Parameters) =>
+            estimateGasInERC20(
+                client as ZeroDevPaymasterClient<entryPoint>,
+                args
+            )
+    })
+
+export type KernelAccountClientActions<
+    entryPoint extends EntryPoint,
+    TChain extends Chain | undefined = Chain | undefined,
+    TSmartAccount extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
+> = SmartAccountActions<entryPoint, TChain, TSmartAccount> & {
+    /**
+     * Signs a user operation with the given transport, chain, and smart account.
+     *
+     * @param args - Parameters for the signUserOperation function
+     * @returns A promise that resolves to the result of the signUserOperation function
+     */
+    signUserOperation: <TTransport extends Transport>(
+        args: Parameters<
+            typeof signUserOperation<
+                entryPoint,
+                TTransport,
+                TChain,
+                TSmartAccount
+            >
+        >[1]
+    ) => Promise<SignUserOperationReturnType>
+}
+
+export const kernelAccountClientActions =
+    <entryPoint extends EntryPoint>({ middleware }: Middleware<entryPoint>) =>
+    <
+        TTransport extends Transport,
+        TChain extends Chain | undefined = Chain | undefined,
+        TSmartAccount extends SmartAccount<entryPoint> | undefined =
+            | SmartAccount<entryPoint>
+            | undefined
+    >(
+        client: Client<TTransport, TChain, TSmartAccount>
+    ): KernelAccountClientActions<entryPoint, TChain, TSmartAccount> => ({
+        ...smartAccountActions({ middleware })(client),
+        signUserOperation: (args) =>
+            signUserOperation<entryPoint, TTransport, TChain, TSmartAccount>(
+                client,
+                {
+                    ...args,
+                    middleware
+                } as SignUserOperationParameters<entryPoint, TSmartAccount>
+            )
+    })

package/clients/index.ts

@@ -0,0 +1,9 @@
+export {
+    createZeroDevPaymasterClient,
+    type ZeroDevPaymasterClient
+} from "./paymasterClient.js"
+
+export {
+    createKernelAccountClient,
+    type KernelAccountClient
+} from "./kernelAccountClient.js"

package/clients/kernelAccountClient.ts

@@ -0,0 +1,87 @@
+import type { SmartAccount } from "permissionless/accounts/types"
+import type { Middleware } from "permissionless/actions/smartAccount"
+import type { EntryPoint, Prettify } from "permissionless/types"
+import type { BundlerRpcSchema } from "permissionless/types/bundler"
+import {
+    type Chain,
+    type Client,
+    type ClientConfig,
+    type Transport,
+    createClient
+} from "viem"
+import { type KernelSmartAccount } from "../accounts/index.js"
+import {
+    type KernelAccountClientActions,
+    kernelAccountClientActions
+} from "./decorators/kernel.js"
+
+export type KernelAccountClient<
+    entryPoint extends EntryPoint,
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined
+> = Prettify<
+    Client<
+        transport,
+        chain,
+        account,
+        BundlerRpcSchema<entryPoint>,
+        KernelAccountClientActions<entryPoint, chain, account>
+    >
+>
+
+export type SmartAccountClientConfig<
+    entryPoint extends EntryPoint,
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
+> = Prettify<
+    Pick<
+        ClientConfig<transport, chain, account>,
+        "cacheTime" | "chain" | "key" | "name" | "pollingInterval"
+    > & {
+        account?: account
+        bundlerTransport: Transport
+    } & Middleware<entryPoint> & {
+            entryPoint: entryPoint
+        }
+>
+
+export const createKernelAccountClient = <
+    entryPoint extends EntryPoint,
+    TTransport extends Transport,
+    TChain extends Chain | undefined = undefined,
+    TSmartAccount extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined
+>(
+    parameters: SmartAccountClientConfig<
+        entryPoint,
+        TTransport,
+        TChain,
+        TSmartAccount
+    >
+): KernelAccountClient<entryPoint, TTransport, TChain, TSmartAccount> => {
+    const {
+        key = "Account",
+        name = "Kernel Account Client",
+        bundlerTransport
+    } = parameters
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        transport: (opts) => bundlerTransport({ ...opts, retryCount: 0 }),
+        type: "kernelAccountClient"
+    })
+
+    return client.extend(
+        kernelAccountClientActions({
+            middleware: parameters.middleware
+        })
+    ) as KernelAccountClient<entryPoint, TTransport, TChain, TSmartAccount>
+}

package/clients/paymasterClient.ts

@@ -0,0 +1,57 @@
+import type { EntryPoint } from "permissionless/types/entrypoint"
+import {
+    type Account,
+    type Chain,
+    type Client,
+    type PublicClientConfig,
+    type Transport,
+    createClient
+} from "viem"
+import type { ZeroDevPaymasterRpcSchema } from "../types/kernel.js"
+import {
+    type ZeroDevPaymasterClientActions,
+    zerodevPaymasterActions
+} from "./decorators/kernel.js"
+
+export type ZeroDevPaymasterClient<entryPoint extends EntryPoint> = Client<
+    Transport,
+    Chain | undefined,
+    Account | undefined,
+    ZeroDevPaymasterRpcSchema<entryPoint>,
+    ZeroDevPaymasterClientActions<entryPoint>
+>
+/**
+ * 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).
+ *
+ * - Docs: https://docs.zerodev.app/meta-infra/getting-started/intro
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A ZeroDev Paymaster Client. {@link ZeroDevPaymasterClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const zerodevPaymasterClient = createZeroDevPaymasterClient({
+ *   chain: mainnet,
+ *   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> => {
+    const { key = "public", name = "ZeroDev Paymaster Client" } = parameters
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        type: "zerodevPaymasterClient"
+    })
+    return client.extend(zerodevPaymasterActions(parameters.entryPoint))
+}

package/constants.ts

@@ -0,0 +1,38 @@
+import type { EntryPointVersion } from "permissionless/types/entrypoint"
+import { type Address } from "viem"
+
+export const DUMMY_ECDSA_SIG =
+    "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"
+
+export const KernelImplToVersionMap: { [key: Address]: string } = {
+    "0x8dD4DBB54d8A8Cf0DE6F9CCC4609470A30EfF18C": "0.2.2",
+    "0x0DA6a956B9488eD4dd761E59f52FDc6c8068E6B5": "0.2.2",
+    "0xD3F582F6B4814E989Ee8E96bc3175320B5A540ab": "0.2.3",
+    "0x5FC0236D6c88a65beD32EECDC5D60a5CAb377717": "0.2.3",
+    "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4",
+    "0x079D5D8A3275A230AF743cB59c341Ff74B82488D": "0.3.0-beta"
+}
+export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
+export const KERNEL_NAME = "Kernel"
+export const LATEST_KERNEL_VERSION: { [key in EntryPointVersion]: string } = {
+    "v0.6": "0.2.4",
+    "v0.7": "0.3.0-beta"
+}
+export const VALIDATOR_TYPE = {
+    SUDO: "0x00",
+    SECONDARY: "0x01",
+    PERMISSION: "0x02"
+} as const
+export enum VALIDATOR_MODE {
+    DEFAULT = "0x00",
+    ENABLE = "0x01"
+}
+export enum CALL_TYPE {
+    SINGLE = "0x00",
+    BATCH = "0x01",
+    DELEGATE_CALL = "0xFF"
+}
+export enum EXEC_TYPE {
+    DEFAULT = "0x00",
+    TRY_EXEC = "0x01"
+}