@zerodev/sdk 5.1.12 → 5.2.0-alpha-0

package/package.json

@@ -1,98 +1,99 @@
 {
-  "name": "@zerodev/sdk",
-  "version": "5.1.12",
-  "author": "ZeroDev",
-  "main": "./_cjs/index.js",
-  "module": "./_esm/index.js",
-  "types": "./_types/index.d.ts",
-  "typings": "./_types/index.d.ts",
-  "type": "module",
-  "sideEffects": false,
-  "description": "A utility library for working with ERC-4337",
-  "keywords": [
-    "ethereum",
-    "erc-4337",
-    "eip-4337",
-    "paymaster",
-    "bundler"
-  ],
-  "license": "MIT",
-  "files": [
-    "_esm",
-    "_cjs",
-    "_types",
-    "./**/*.ts",
-    "!_esm/**/*.tsbuildinfo",
-    "!_cjs/**/*.tsbuildinfo",
-    "!_types/**/*.tsbuildinfo",
-    "!.env",
-    "!./**/*.test.ts",
-    "!.changeset"
-  ],
-  "scripts": {
-    "build": "bun run clean && bun run build:cjs && bun run build:esm && bun run build:types",
-    "build:cjs": "tsc --project ./tsconfig.build.json --module commonjs --outDir ./_cjs --removeComments --verbatimModuleSyntax false && printf '{\"type\":\"commonjs\"}' > ./_cjs/package.json",
-    "build:esm": "tsc --project ./tsconfig.build.json --module es2015 --outDir ./_esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./_esm/package.json",
-    "build:types": "tsc --project ./tsconfig.build.json --module esnext --declarationDir ./_types --emitDeclarationOnly --declaration --declarationMap",
-    "clean": "rimraf _esm _cjs _types",
-    "changeset": "changeset",
-    "changeset:release": "bun run build && changeset publish",
-    "changeset:version": "changeset version && bun install --lockfile-only",
-    "format": "biome format . --write",
-    "lint": "biome check .",
-    "lint:fix": "bun run lint --apply"
-  },
-  "exports": {
-    ".": {
-      "types": "./_types/index.d.ts",
-      "import": "./_esm/index.js",
-      "default": "./_cjs/index.js"
+    "name": "@zerodev/sdk",
+    "version": "5.2.0-alpha-0",
+    "author": "ZeroDev",
+    "main": "./_cjs/index.js",
+    "module": "./_esm/index.js",
+    "types": "./_types/index.d.ts",
+    "typings": "./_types/index.d.ts",
+    "type": "module",
+    "sideEffects": false,
+    "description": "A utility library for working with ERC-4337",
+    "keywords": [
+        "ethereum",
+        "erc-4337",
+        "eip-4337",
+        "paymaster",
+        "bundler"
+    ],
+    "license": "MIT",
+    "files": [
+        "_esm",
+        "_cjs",
+        "_types",
+        "./**/*.ts",
+        "!_esm/**/*.tsbuildinfo",
+        "!_cjs/**/*.tsbuildinfo",
+        "!_types/**/*.tsbuildinfo",
+        "!.env",
+        "!./**/*.test.ts",
+        "!.changeset"
+    ],
+    "scripts": {
+        "build": "bun run clean && bun run build:cjs && bun run build:esm && bun run build:types",
+        "build:cjs": "tsc --project ./tsconfig.build.json --module commonjs --outDir ./_cjs --removeComments --verbatimModuleSyntax false && printf '{\"type\":\"commonjs\"}' > ./_cjs/package.json",
+        "build:esm": "tsc --project ./tsconfig.build.json --module es2015 --outDir ./_esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./_esm/package.json",
+        "build:types": "tsc --project ./tsconfig.build.json --module esnext --declarationDir ./_types --emitDeclarationOnly --declaration --declarationMap",
+        "clean": "rimraf _esm _cjs _types",
+        "changeset": "changeset",
+        "changeset:release": "bun run build && changeset publish",
+        "changeset:version": "changeset version && bun install --lockfile-only",
+        "format": "biome format . --write",
+        "lint": "biome check .",
+        "lint:fix": "bun run lint --apply"
     },
-    "./accounts": {
-      "types": "./_types/accounts/index.d.ts",
-      "import": "./_esm/accounts/index.js",
-      "default": "./_cjs/accounts/index.js"
+    "exports": {
+        ".": {
+            "types": "./_types/index.d.ts",
+            "import": "./_esm/index.js",
+            "default": "./_cjs/index.js"
+        },
+        "./accounts": {
+            "types": "./_types/accounts/index.d.ts",
+            "import": "./_esm/accounts/index.js",
+            "default": "./_cjs/accounts/index.js"
+        },
+        "./plugins": {
+            "types": "./_types/plugins/index.d.ts",
+            "import": "./_esm/plugins/index.js",
+            "default": "./_cjs/plugins/index.js"
+        },
+        "./actions": {
+            "types": "./_types/actions/index.d.ts",
+            "import": "./_esm/actions/index.js",
+            "default": "./_cjs/actions/index.js"
+        },
+        "./types": {
+            "types": "./_types/types/index.d.ts",
+            "import": "./_esm/types/index.js",
+            "default": "./_cjs/types/index.js"
+        },
+        "./actions/kernel": {
+            "types": "./_types/actions/kernel.d.ts",
+            "import": "./_esm/actions/kernel.js",
+            "default": "./_cjs/actions/kernel.js"
+        },
+        "./clients": {
+            "types": "./_types/clients/index.d.ts",
+            "import": "./_esm/clients/index.js",
+            "default": "./_cjs/clients/index.js"
+        },
+        "./clients/kernel": {
+            "types": "./_types/clients/kernel.d.ts",
+            "import": "./_esm/clients/kernel.js",
+            "default": "./_cjs/clients/kernel.js"
+        },
+        "./providers": {
+            "types": "./_types/providers/index.d.ts",
+            "import": "./_esm/providers/index.js",
+            "default": "./_cjs/providers/index.js"
+        }
     },
-    "./plugins": {
-      "types": "./_types/plugins/index.d.ts",
-      "import": "./_esm/plugins/index.js",
-      "default": "./_cjs/plugins/index.js"
+    "peerDependencies": {
+        "viem": "^2.0.0"
     },
-    "./actions": {
-      "types": "./_types/actions/index.d.ts",
-      "import": "./_esm/actions/index.js",
-      "default": "./_cjs/actions/index.js"
-    },
-    "./types": {
-      "types": "./_types/types/index.d.ts",
-      "import": "./_esm/types/index.js",
-      "default": "./_cjs/types/index.js"
-    },
-    "./actions/kernel": {
-      "types": "./_types/actions/kernel.d.ts",
-      "import": "./_esm/actions/kernel.js",
-      "default": "./_cjs/actions/kernel.js"
-    },
-    "./clients": {
-      "types": "./_types/clients/index.d.ts",
-      "import": "./_esm/clients/index.js",
-      "default": "./_cjs/clients/index.js"
-    },
-    "./clients/kernel": {
-      "types": "./_types/clients/kernel.d.ts",
-      "import": "./_esm/clients/kernel.js",
-      "default": "./_cjs/clients/kernel.js"
-    },
-    "./providers": {
-      "types": "./_types/providers/index.d.ts",
-      "import": "./_esm/providers/index.js",
-      "default": "./_cjs/providers/index.js"
+    "dependencies": {
+        "semver": "^7.6.0",
+        "permissionless": "^0.1.4"
     }
-  },
-  "peerDependencies": {
-    "viem": "^2.0.0"
-  },
-  "dependencies": {
-    "permissionless": "^0.0.34"
-  }
 }

package/providers/KernelEIP1193Provider.ts

@@ -1,5 +1,6 @@
 import { EventEmitter } from "events"
 import { type KernelAccountClient } from "@zerodev/sdk"
+import type { EntryPoint } from "permissionless/types"
 import {
     type EIP1193Parameters,
     type EIP1193RequestFn,
@@ -7,10 +8,12 @@ import {
     type SendTransactionParameters
 } from "viem"
 
-export class KernelEIP1193Provider extends EventEmitter {
-    private kernelClient: KernelAccountClient
+export class KernelEIP1193Provider<
+    entryPoint extends EntryPoint
+> extends EventEmitter {
+    private kernelClient: KernelAccountClient<entryPoint>
 
-    constructor(kernelClient: KernelAccountClient) {
+    constructor(kernelClient: KernelAccountClient<entryPoint>) {
         super()
         this.kernelClient = kernelClient
     }

package/types/kernel.ts

@@ -1,22 +1,33 @@
+import type { EntryPoint } from "permissionless/types"
+import type { GetEntryPointVersion } from "permissionless/types/entrypoint"
 import type {
     UserOperation,
     UserOperationWithBigIntAsHex
 } from "permissionless/types/userOperation"
 import { type Address, type Hex, type LocalAccount } from "viem"
 import type { PartialBy } from "viem/types/utils"
-export type ZeroDevPaymasterRpcSchema = [
+import { VALIDATOR_TYPE } from "../constants.js"
+export type ZeroDevPaymasterRpcSchema<entryPoint extends EntryPoint> = [
     {
         Method: "zd_sponsorUserOperation"
         Parameters: [
             {
                 chainId: number
-                userOp: PartialBy<
-                    UserOperationWithBigIntAsHex,
-                    | "callGasLimit"
-                    | "preVerificationGas"
-                    | "verificationGasLimit"
-                    | "paymasterAndData"
-                >
+                userOp: GetEntryPointVersion<entryPoint> extends "v0.6"
+                    ? PartialBy<
+                          UserOperationWithBigIntAsHex<"v0.6">,
+                          | "callGasLimit"
+                          | "preVerificationGas"
+                          | "verificationGasLimit"
+                      >
+                    : PartialBy<
+                          UserOperationWithBigIntAsHex<"v0.7">,
+                          | "callGasLimit"
+                          | "preVerificationGas"
+                          | "verificationGasLimit"
+                          | "paymasterVerificationGasLimit"
+                          | "paymasterPostOpGasLimit"
+                      >
                 entryPointAddress: Address
                 gasTokenData?: {
                     tokenAddress: Hex
@@ -26,14 +37,29 @@ export type ZeroDevPaymasterRpcSchema = [
                 shouldConsume?: boolean
             }
         ]
-        ReturnType: {
-            paymasterAndData: Hex
-            preVerificationGas: Hex
-            verificationGasLimit: Hex
-            callGasLimit: Hex
-            maxFeePerGas: Hex
-            maxPriorityFeePerGas: Hex
-        }
+        ReturnType: GetEntryPointVersion<entryPoint> extends "v0.6"
+            ? {
+                  paymasterAndData: Hex
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  maxFeePerGas: Hex
+                  maxPriorityFeePerGas: Hex
+                  paymaster?: never
+                  paymasterVerificationGasLimit?: never
+                  paymasterPostOpGasLimit?: never
+                  paymasterData?: never
+              }
+            : {
+                  preVerificationGas: Hex
+                  verificationGasLimit: Hex
+                  callGasLimit: Hex
+                  paymaster: Address
+                  paymasterVerificationGasLimit: Hex
+                  paymasterPostOpGasLimit: Hex
+                  paymasterData: Hex
+                  paymasterAndData?: never
+              }
     },
     {
         Method: "zd_pm_accounts"
@@ -50,7 +76,7 @@ export type ZeroDevPaymasterRpcSchema = [
         Parameters: [
             {
                 chainId: number
-                userOp: UserOperationWithBigIntAsHex
+                userOp: UserOperationWithBigIntAsHex<"v0.6">
                 entryPointAddress: Address
                 tokenAddress: Address
             }
@@ -62,39 +88,63 @@ export type ZeroDevPaymasterRpcSchema = [
     }
 ]
 
-export type KernelValidator<Name extends string = string> =
-    LocalAccount<Name> & {
-        getNonceKey: () => Promise<bigint>
-        getDummySignature(
-            userOperation: UserOperation,
-            pluginEnableSignature?: Hex
-        ): Promise<Hex>
-        signUserOperation: (
-            userOperation: UserOperation,
-            pluginEnableSignature?: Hex
-        ) => Promise<Hex>
-        getEnableData(accountAddress?: Address): Promise<Hex>
-        isEnabled(accountAddress: Address, selector: Hex): Promise<boolean>
-    }
+export type ValidatorType = keyof typeof VALIDATOR_TYPE
+
+export type KernelValidator<
+    entryPoint extends EntryPoint,
+    Name extends string = string,
+    type extends ValidatorType = "SUDO"
+> = type extends "PERMISSION"
+    ? LocalAccount<Name> & {
+          getNonceKey: (accountAddress?: Address) => Promise<bigint>
+          getDummySignature(
+              userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+              pluginEnableSignature?: Hex
+          ): Promise<Hex>
+          signUserOperation: (
+              userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+              pluginEnableSignature?: Hex
+          ) => Promise<Hex>
+          getEnableData(accountAddress?: Address): Promise<Hex>
+          isEnabled(accountAddress: Address, selector: Hex): Promise<boolean>
+          isPermissionValidator: boolean
+          getPermissionId: () => Hex
+      }
+    : LocalAccount<Name> & {
+          getNonceKey: (accountAddress?: Address) => Promise<bigint>
+          getDummySignature(
+              userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+              pluginEnableSignature?: Hex
+          ): Promise<Hex>
+          signUserOperation: (
+              userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+              pluginEnableSignature?: Hex
+          ) => Promise<Hex>
+          getEnableData(accountAddress?: Address): Promise<Hex>
+          isEnabled(accountAddress: Address, selector: Hex): Promise<boolean>
+          isPermissionValidator: boolean
+      }
 
 export type ValidatorInitData = {
     validatorAddress: Address
     enableData: Hex
 }
 
-export type KernelPluginManager = KernelValidator & {
-    getPluginEnableSignature(accountAddress: Address): Promise<Hex>
-    getValidatorInitData(): Promise<ValidatorInitData>
-    getExecutorData(): ExecutorData
-    getValidityData(): PluginValidityData
-}
+export type KernelPluginManager<entryPoint extends EntryPoint> =
+    KernelValidator<entryPoint> & {
+        getPluginEnableSignature(accountAddress: Address): Promise<Hex>
+        getValidatorInitData(): Promise<ValidatorInitData>
+        getExecutorData(): ExecutorData
+        getValidityData(): PluginValidityData
+    }
 
-export type KernelPluginManagerParams = {
-    sudo?: KernelValidator
-    regular?: KernelValidator
+export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
+    sudo?: KernelValidator<entryPoint>
+    regular?: KernelValidator<entryPoint>
     pluginEnableSignature?: Hex
     validatorInitData?: ValidatorInitData
     executorData?: ExecutorData
+    entryPoint: entryPoint
 } & Partial<PluginValidityData>
 
 export type ExecutorData = {
@@ -128,3 +178,9 @@ export type KernelEncodeCallDataArgs =
           data: Hex
           callType: CallType | undefined
       }[]
+
+export type Execution = {
+    target: Address
+    value: bigint
+    callData: Hex
+}

package/utils.ts

@@ -1,27 +1,65 @@
+import { getEntryPointVersion } from "permissionless"
+import type { EntryPoint } from "permissionless/types/entrypoint"
+import { satisfies } from "semver"
 import {
     type Address,
     type Hex,
+    concatHex,
     encodeFunctionData,
     erc20Abi,
     hexToSignature,
     isHex,
+    pad,
     signatureToHex,
     zeroAddress
 } from "viem"
 import { KERNEL_ADDRESSES } from "./accounts/index.js"
 import type { ZeroDevPaymasterClient } from "./clients/paymasterClient.js"
-import { KernelImplToVersionMap, LATEST_KERNEL_VERSION } from "./constants.js"
+import {
+    CALL_TYPE,
+    EXEC_TYPE,
+    KernelImplToVersionMap,
+    LATEST_KERNEL_VERSION
+} from "./constants.js"
 
-export const getKernelVersion = (kernelImpl?: Address): string => {
-    if (!kernelImpl || kernelImpl === zeroAddress) return LATEST_KERNEL_VERSION
+export const getKernelVersion = <entryPoint extends EntryPoint>(
+    entryPointAddress: entryPoint,
+    kernelImpl?: Address
+): string => {
+    const entryPointVersion = getEntryPointVersion(entryPointAddress)
+    if (!kernelImpl || kernelImpl === zeroAddress)
+        return LATEST_KERNEL_VERSION[entryPointVersion]
     for (const [addr, ver] of Object.entries(KernelImplToVersionMap)) {
         if (addr.toLowerCase() === kernelImpl.toLowerCase()) return ver
     }
     return "0.2.1"
 }
 
+export enum KERNEL_FEATURES {
+    ERC1271_SIG_WRAPPER = "ERC1271_SIG_WRAPPER",
+    ERC1271_WITH_VALIDATOR = "ERC1271_WITH_VALIDATOR",
+    ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH = "ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH"
+}
+
+const KERNEL_FEATURES_BY_VERSION: Record<KERNEL_FEATURES, string> = {
+    [KERNEL_FEATURES.ERC1271_SIG_WRAPPER]: ">=0.2.3 || >=0.3.0-beta",
+    [KERNEL_FEATURES.ERC1271_WITH_VALIDATOR]: ">=0.3.0-beta",
+    [KERNEL_FEATURES.ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH]: ">=0.3.0-beta"
+}
+
+export const hasKernelFeature = (
+    feature: KERNEL_FEATURES,
+    version: string
+): boolean => {
+    if (!(feature in KERNEL_FEATURES_BY_VERSION)) {
+        return false
+    }
+
+    return satisfies(version, KERNEL_FEATURES_BY_VERSION[feature])
+}
+
 export const getERC20PaymasterApproveCall = async (
-    client: ZeroDevPaymasterClient,
+    client: ZeroDevPaymasterClient<EntryPoint>,
     {
         gasToken,
         approveAmount
@@ -64,3 +102,13 @@ export const fixSignedData = (sig: Hex): Hex => {
     const joined = signatureToHex({ r, s, v })
     return joined
 }
+
+export const getExecMode = (callType: CALL_TYPE, execType: EXEC_TYPE): Hex => {
+    return concatHex([
+        callType, // 1 byte
+        execType, // 1 byte
+        "0x00000000", // 4 bytes
+        "0x00000000", // 4 bytes
+        pad("0x00000000", { size: 22 })
+    ])
+}