@zerodev/sdk 5.1.13 → 5.2.0-alpha-0

package/actions/paymaster/sponsorUserOperation.ts

@@ -1,36 +1,65 @@
+import type {
+    ENTRYPOINT_ADDRESS_V06_TYPE,
+    EntryPoint,
+    GetEntryPointVersion
+} from "permissionless/types/entrypoint"
 import type {
     UserOperation,
     UserOperationWithBigIntAsHex
 } from "permissionless/types/userOperation.js"
-import { deepHexlify } from "permissionless/utils"
+import { ENTRYPOINT_ADDRESS_V06, deepHexlify } from "permissionless/utils"
 import type { Address, Hex } from "viem"
 import type { PartialBy } from "viem/types/utils"
 import { KERNEL_ADDRESSES } from "../../accounts/index.js"
 import type { ZeroDevPaymasterClient } from "../../clients/paymasterClient.js"
 
-export type SponsorUserOperationParameters = {
-    userOperation: PartialBy<
-        UserOperation,
-        | "callGasLimit"
-        | "preVerificationGas"
-        | "verificationGasLimit"
-        | "paymasterAndData"
-    >
-    entryPoint?: Address
+export type SponsorUserOperationParameters<entryPoint extends EntryPoint> = {
+    userOperation: entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
+        ? PartialBy<
+              UserOperation<"v0.6">,
+              "callGasLimit" | "preVerificationGas" | "verificationGasLimit"
+          >
+        : PartialBy<
+              UserOperation<"v0.7">,
+              | "callGasLimit"
+              | "preVerificationGas"
+              | "verificationGasLimit"
+              | "paymasterVerificationGasLimit"
+              | "paymasterPostOpGasLimit"
+          >
+    entryPoint: entryPoint
     gasToken?: Hex
     shouldOverrideFee?: boolean
     shouldConsume?: boolean
 }
 
-export type SponsorUserOperationReturnType = UserOperation
+export type SponsorUserOperationReturnType<entryPoint extends EntryPoint> =
+    entryPoint extends ENTRYPOINT_ADDRESS_V06_TYPE
+        ? Pick<
+              UserOperation<"v0.6">,
+              | "callGasLimit"
+              | "verificationGasLimit"
+              | "preVerificationGas"
+              | "paymasterAndData"
+          >
+        : Pick<
+              UserOperation<"v0.7">,
+              | "callGasLimit"
+              | "verificationGasLimit"
+              | "preVerificationGas"
+              | "paymaster"
+              | "paymasterVerificationGasLimit"
+              | "paymasterPostOpGasLimit"
+              | "paymasterData"
+          >
 
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
  */
-export const sponsorUserOperation = async (
-    client: ZeroDevPaymasterClient,
-    args: SponsorUserOperationParameters
-): Promise<SponsorUserOperationReturnType> => {
+export const sponsorUserOperation = async <entryPoint extends EntryPoint>(
+    client: ZeroDevPaymasterClient<entryPoint>,
+    args: SponsorUserOperationParameters<entryPoint>
+): Promise<SponsorUserOperationReturnType<entryPoint>> => {
     const response = await client.request({
         method: "zd_sponsorUserOperation",
         params: [
@@ -38,7 +67,9 @@ export const sponsorUserOperation = async (
                 chainId: client.chain?.id as number,
                 userOp: deepHexlify(
                     args.userOperation
-                ) as UserOperationWithBigIntAsHex,
+                ) as UserOperationWithBigIntAsHex<
+                    GetEntryPointVersion<entryPoint>
+                >,
                 entryPointAddress:
                     args.entryPoint ?? KERNEL_ADDRESSES.ENTRYPOINT_V0_6,
                 gasTokenData: args.gasToken && {
@@ -49,23 +80,64 @@ export const sponsorUserOperation = async (
             }
         ]
     })
-    let result: UserOperation = {
-        ...args.userOperation,
-        paymasterAndData: response.paymasterAndData,
-        preVerificationGas: BigInt(response.preVerificationGas),
-        verificationGasLimit: BigInt(response.verificationGasLimit),
-        callGasLimit: BigInt(response.callGasLimit)
-    }
-    if (
-        response.maxFeePerGas !== undefined &&
-        response.maxPriorityFeePerGas !== undefined
-    ) {
-        result = {
-            ...result,
-            maxFeePerGas: BigInt(response.maxFeePerGas),
-            maxPriorityFeePerGas: BigInt(response.maxPriorityFeePerGas)
+    if (args.entryPoint === ENTRYPOINT_ADDRESS_V06) {
+        const responseV06 = response as {
+            paymasterAndData: Hex
+            preVerificationGas: Hex
+            verificationGasLimit: Hex
+            callGasLimit: Hex
+            paymaster?: never
+            paymasterVerificationGasLimit?: never
+            paymasterPostOpGasLimit?: never
+            paymasterData?: never
         }
+        return {
+            paymasterAndData: responseV06.paymasterAndData,
+            preVerificationGas: BigInt(responseV06.preVerificationGas),
+            verificationGasLimit: BigInt(responseV06.verificationGasLimit),
+            callGasLimit: BigInt(responseV06.callGasLimit)
+        } as SponsorUserOperationReturnType<entryPoint>
     }
+    const responseV07 = response as {
+        preVerificationGas: Hex
+        verificationGasLimit: Hex
+        callGasLimit: Hex
+        paymaster: Address
+        paymasterVerificationGasLimit: Hex
+        paymasterPostOpGasLimit: Hex
+        paymasterData: Hex
+        paymasterAndData?: never
+    }
+
+    return {
+        callGasLimit: BigInt(responseV07.callGasLimit),
+        verificationGasLimit: BigInt(responseV07.verificationGasLimit),
+        preVerificationGas: BigInt(responseV07.preVerificationGas),
+        paymaster: responseV07.paymaster,
+        paymasterVerificationGasLimit: BigInt(
+            responseV07.paymasterVerificationGasLimit
+        ),
+        paymasterPostOpGasLimit: BigInt(responseV07.paymasterPostOpGasLimit),
+        paymasterData: responseV07.paymasterData
+    } as SponsorUserOperationReturnType<entryPoint>
+    // [TODO] Add gas price params in the response in permissionless
+    // let result: UserOperation<"v0.6"> = {
+    //     ...args.userOperation,
+    //     paymasterAndData: response.paymasterAndData,
+    //     preVerificationGas: BigInt(response.preVerificationGas),
+    //     verificationGasLimit: BigInt(response.verificationGasLimit),
+    //     callGasLimit: BigInt(response.callGasLimit)
+    // }
+    // if (
+    //     response.maxFeePerGas !== undefined &&
+    //     response.maxPriorityFeePerGas !== undefined
+    // ) {
+    //     result = {
+    //         ...result,
+    //         maxFeePerGas: BigInt(response.maxFeePerGas),
+    //         maxPriorityFeePerGas: BigInt(response.maxPriorityFeePerGas)
+    //     }
+    // }
 
-    return result
+    // return result
 }

package/clients/decorators/kernel.ts

@@ -1,6 +1,7 @@
 import { type SmartAccountActions, smartAccountActions } from "permissionless"
 import type { SmartAccount } from "permissionless/accounts/types"
-import type { SponsorUserOperationMiddleware } from "permissionless/actions/smartAccount"
+import { type Middleware } from "permissionless/actions/smartAccount"
+import type { EntryPoint } from "permissionless/types"
 import type { Chain, Client, Transport } from "viem"
 import type {
     SignUserOperationParameters,
@@ -19,42 +20,42 @@ import {
 } from "../../actions/paymaster/sponsorUserOperation.js"
 import type { ZeroDevPaymasterClient } from "../paymasterClient.js"
 
-export type ZeroDevPaymasterClientActions = {
+export type ZeroDevPaymasterClientActions<entryPoint extends EntryPoint> = {
     /**
      * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
      */
     sponsorUserOperation: (
-        args: SponsorUserOperationParameters
-    ) => Promise<SponsorUserOperationReturnType>
+        args: SponsorUserOperationParameters<entryPoint>
+    ) => Promise<SponsorUserOperationReturnType<entryPoint>>
     estimateGasInERC20: (
         args: EstimateGasInERC20Parameters
     ) => Promise<EstimateGasInERC20ReturnType>
 }
 
-export const zerodevPaymasterActions = (
-    client: Client
-): ZeroDevPaymasterClientActions => ({
-    sponsorUserOperation: async (args: SponsorUserOperationParameters) =>
-        sponsorUserOperation(client as ZeroDevPaymasterClient, args),
-    estimateGasInERC20: async (args: EstimateGasInERC20Parameters) =>
-        estimateGasInERC20(client as ZeroDevPaymasterClient, args)
-})
-
-// export type KernelAccountClientActions<
-//     TChain extends Chain | undefined = Chain | undefined,
-//     TSmartAccount extends SmartAccount | undefined = SmartAccount | undefined
-// > = {
-//     signUserOperation: <TTransport extends Transport>(
-//         args: Parameters<
-//             typeof signUserOperation<TTransport, TChain, TSmartAccount>
-//         >[1]
-//     ) => Promise<SignUserOperationReturnType>
-// }
+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 | undefined = SmartAccount | undefined
-> = SmartAccountActions<TChain, TSmartAccount> & {
+    TSmartAccount extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
+> = SmartAccountActions<entryPoint, TChain, TSmartAccount> & {
     /**
      * Signs a user operation with the given transport, chain, and smart account.
      *
@@ -63,26 +64,34 @@ export type KernelAccountClientActions<
      */
     signUserOperation: <TTransport extends Transport>(
         args: Parameters<
-            typeof signUserOperation<TTransport, TChain, TSmartAccount>
+            typeof signUserOperation<
+                entryPoint,
+                TTransport,
+                TChain,
+                TSmartAccount
+            >
         >[1]
     ) => Promise<SignUserOperationReturnType>
 }
 
 export const kernelAccountClientActions =
-    ({ sponsorUserOperation }: SponsorUserOperationMiddleware) =>
+    <entryPoint extends EntryPoint>({ middleware }: Middleware<entryPoint>) =>
     <
         TTransport extends Transport,
         TChain extends Chain | undefined = Chain | undefined,
-        TSmartAccount extends SmartAccount | undefined =
-            | SmartAccount
+        TSmartAccount extends SmartAccount<entryPoint> | undefined =
+            | SmartAccount<entryPoint>
             | undefined
     >(
         client: Client<TTransport, TChain, TSmartAccount>
-    ): KernelAccountClientActions<TChain, TSmartAccount> => ({
-        ...smartAccountActions({ sponsorUserOperation })(client),
+    ): KernelAccountClientActions<entryPoint, TChain, TSmartAccount> => ({
+        ...smartAccountActions({ middleware })(client),
         signUserOperation: (args) =>
-            signUserOperation(client, {
-                ...args,
-                sponsorUserOperation
-            } as SignUserOperationParameters<TSmartAccount>)
+            signUserOperation<entryPoint, TTransport, TChain, TSmartAccount>(
+                client,
+                {
+                    ...args,
+                    middleware
+                } as SignUserOperationParameters<entryPoint, TSmartAccount>
+            )
     })

package/clients/kernelAccountClient.ts

@@ -1,12 +1,11 @@
 import type { SmartAccount } from "permissionless/accounts/types"
-import type { SponsorUserOperationMiddleware } from "permissionless/actions/smartAccount"
-import type { Prettify } from "permissionless/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 ParseAccount,
     type Transport,
     createClient
 } from "viem"
@@ -17,62 +16,72 @@ import {
 } from "./decorators/kernel.js"
 
 export type KernelAccountClient<
+    entryPoint extends EntryPoint,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
-    account extends KernelSmartAccount | undefined =
-        | KernelSmartAccount
+    account extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
         | undefined
 > = Prettify<
     Client<
         transport,
         chain,
         account,
-        BundlerRpcSchema,
-        KernelAccountClientActions<chain, account>
+        BundlerRpcSchema<entryPoint>,
+        KernelAccountClientActions<entryPoint, chain, account>
     >
 >
 
 export type SmartAccountClientConfig<
+    entryPoint extends EntryPoint,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
-    TAccount extends SmartAccount | undefined = SmartAccount | undefined
+    account extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
 > = Prettify<
     Pick<
-        ClientConfig<transport, chain, TAccount>,
-        | "account"
-        | "cacheTime"
-        | "chain"
-        | "key"
-        | "name"
-        | "pollingInterval"
-        | "transport"
-    >
+        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 | undefined = undefined
+    TSmartAccount extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined
 >(
-    parameters: SmartAccountClientConfig<TTransport, TChain, TSmartAccount> &
-        SponsorUserOperationMiddleware
-): KernelAccountClient<TTransport, TChain, ParseAccount<TSmartAccount>> => {
+    parameters: SmartAccountClientConfig<
+        entryPoint,
+        TTransport,
+        TChain,
+        TSmartAccount
+    >
+): KernelAccountClient<entryPoint, TTransport, TChain, TSmartAccount> => {
     const {
         key = "Account",
         name = "Kernel Account Client",
-        transport
+        bundlerTransport
     } = parameters
     const client = createClient({
         ...parameters,
         key,
         name,
-        transport: (opts) => transport({ ...opts, retryCount: 0 }),
+        transport: (opts) => bundlerTransport({ ...opts, retryCount: 0 }),
         type: "kernelAccountClient"
     })
 
     return client.extend(
         kernelAccountClientActions({
-            sponsorUserOperation: parameters.sponsorUserOperation
+            middleware: parameters.middleware
         })
-    )
+    ) as KernelAccountClient<entryPoint, TTransport, TChain, TSmartAccount>
 }

package/clients/paymasterClient.ts

@@ -1,3 +1,4 @@
+import type { EntryPoint } from "permissionless/types/entrypoint"
 import {
     type Account,
     type Chain,
@@ -12,12 +13,12 @@ import {
     zerodevPaymasterActions
 } from "./decorators/kernel.js"
 
-export type ZeroDevPaymasterClient = Client<
+export type ZeroDevPaymasterClient<entryPoint extends EntryPoint> = Client<
     Transport,
     Chain | undefined,
     Account | undefined,
-    ZeroDevPaymasterRpcSchema,
-    ZeroDevPaymasterClientActions
+    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).
@@ -37,11 +38,14 @@ export type ZeroDevPaymasterClient = Client<
  * })
  */
 export const createZeroDevPaymasterClient = <
+    entryPoint extends EntryPoint,
     transport extends Transport,
     chain extends Chain | undefined = undefined
 >(
-    parameters: PublicClientConfig<transport, chain>
-): ZeroDevPaymasterClient => {
+    parameters: PublicClientConfig<transport, chain> & {
+        entryPoint: entryPoint
+    }
+): ZeroDevPaymasterClient<entryPoint> => {
     const { key = "public", name = "ZeroDev Paymaster Client" } = parameters
     const client = createClient({
         ...parameters,
@@ -49,5 +53,5 @@ export const createZeroDevPaymasterClient = <
         name,
         type: "zerodevPaymasterClient"
     })
-    return client.extend(zerodevPaymasterActions)
+    return client.extend(zerodevPaymasterActions(parameters.entryPoint))
 }

package/constants.ts

@@ -1,3 +1,4 @@
+import type { EntryPointVersion } from "permissionless/types/entrypoint"
 import { type Address } from "viem"
 
 export const DUMMY_ECDSA_SIG =
@@ -8,8 +9,30 @@ export const KernelImplToVersionMap: { [key: Address]: string } = {
     "0x0DA6a956B9488eD4dd761E59f52FDc6c8068E6B5": "0.2.2",
     "0xD3F582F6B4814E989Ee8E96bc3175320B5A540ab": "0.2.3",
     "0x5FC0236D6c88a65beD32EECDC5D60a5CAb377717": "0.2.3",
-    "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4"
+    "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4",
+    "0x079D5D8A3275A230AF743cB59c341Ff74B82488D": "0.3.0-beta"
 }
 export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
 export const KERNEL_NAME = "Kernel"
-export const LATEST_KERNEL_VERSION = "0.2.4"
+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"
+}

package/index.ts

@@ -32,6 +32,11 @@ export {
 } from "./types/kernel.js"
 export { KernelAccountAbi } from "./accounts/kernel/abi/KernelAccountAbi.js"
 export { KernelFactoryAbi } from "./accounts/kernel/abi/KernelFactoryAbi.js"
+export {
+    KernelV3AccountAbi,
+    KernelV3ExecuteAbi,
+    KernelV3InitAbi
+} from "./accounts/kernel/abi/kernel_v_3_0_0/KernelAccountAbi.js"
 export { TokenActionsAbi } from "./accounts/kernel/abi/TokenActionsAbi.js"
 export * as constants from "./constants.js"
 export * from "./utils.js"