@zerodev/sdk 4.7.3 → 5.0.0-alpha-0

package/index.ts

@@ -0,0 +1,45 @@
+export {
+    createKernelAccount,
+    createKernelV1Account,
+    type KernelSmartAccount,
+    KERNEL_ADDRESSES,
+    addressToEmptyAccount,
+    EIP1271ABI
+} from "./accounts/index.js"
+export {
+    sponsorUserOperation,
+    type SponsorUserOperationParameters,
+    type SponsorUserOperationReturnType
+} from "./actions/paymaster/sponsorUserOperation.js"
+export {
+    zerodevPaymasterActions,
+    type ZeroDevPaymasterClientActions,
+    kernelAccountClientActions,
+    type KernelAccountClientActions
+} from "./clients/decorators/kernel.js"
+export {
+    createZeroDevPaymasterClient,
+    type ZeroDevPaymasterClient
+} from "./clients/paymasterClient.js"
+export {
+    createKernelAccountClient,
+    type KernelAccountClient
+} from "./clients/kernelAccountClient.js"
+export {
+    type KernelValidator,
+    type ZeroDevPaymasterRpcSchema,
+    type KernelPluginManager
+} 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"
+export { gasTokenAddresses, type TokenSymbolsMap } from "./gasTokenAddresses.js"
+export { verifyEIP6492Signature } from "./accounts/utils/index.js"
+export { KernelEIP1193Provider } from "./providers/index.js"

package/package.json

@@ -1,75 +1,99 @@
 {
-  "name": "@zerodev/sdk",
-  "version": "4.7.3",
-  "description": "A collection of ERC-4337 compliant smart contract account interfaces",
-  "author": "ZeroDev",
-  "license": "MIT",
-  "private": false,
-  "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "typings": "./dist/types/index.d.ts",
-  "sideEffects": false,
-  "files": [
-    "passkey",
-    "dist",
-    "src/**/*.ts",
-    "!dist/**/*.tsbuildinfo",
-    "!vitest.config.ts",
-    "!.env",
-    "!src/**/*.test.ts",
-    "!src/__tests__/**/*"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
+    "name": "@zerodev/sdk",
+    "version": "5.0.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"
     },
-    "./passkey": {
-      "import": "./dist/esm/kernel-zerodev/owner/passkey/index.js",
-      "default": "./dist/cjs/kernel-zerodev/owner/passkey/index.js",
-      "types": "./dist/types/kernel-zerodev/owner/passkey/index.d.ts"
+    "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"
+        }
     },
-    "./package.json": "./package.json"
-  },
-  "scripts": {
-    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
-    "build:cjs": "tsc --project tsconfig.build-cjs.json && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
-    "build:esm": "tsc --project tsconfig.build.json && echo > ./dist/esm/package.json '{\"type\":\"module\"}'",
-    "build:types": "tsc --project tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
-    "clean": "rm -rf ./dist",
-    "test": "vitest",
-    "test:run": "vitest run"
-  },
-  "devDependencies": {
-    "@turnkey/api-key-stamper": "^0.1.1",
-    "@turnkey/http": "^1.2.0",
-    "@turnkey/viem": "^0.2.4",
-    "typescript": "^5.0.4",
-    "typescript-template": "*",
-    "vitest": "^0.31.0"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zerodevapp/sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/zerodevapp/sdk/issues"
-  },
-  "homepage": "https://github.com/zerodevapp/sdk/blob/main/README.md#readme",
-  "gitHead": "19ba05a77e4f7a0e04f44f34eaecf675fe2c12f2",
-  "dependencies": {
-    "@alchemy/aa-core": "0.1.0-alpha.23",
-    "@alchemy/aa-ethers": "0.1.0-alpha.23",
-    "@openzeppelin/merkle-tree": "^1.0.5",
-    "axios": "^1.4.0",
-    "merkletreejs": "^0.3.10",
-    "viem": "^1.5.3"
-  }
+    "peerDependencies": {
+        "viem": "^2.0.0"
+    },
+    "dependencies": {
+        "semver": "^7.6.0",
+        "permissionless": "^0.1.4"
+    }
 }

package/providers/KernelEIP1193Provider.ts

@@ -0,0 +1,79 @@
+import { EventEmitter } from "events"
+import { type KernelAccountClient } from "@zerodev/sdk"
+import type { EntryPoint } from "permissionless/types"
+import {
+    type EIP1193Parameters,
+    type EIP1193RequestFn,
+    type Hash,
+    type SendTransactionParameters
+} from "viem"
+
+export class KernelEIP1193Provider<
+    entryPoint extends EntryPoint
+> extends EventEmitter {
+    private kernelClient: KernelAccountClient<entryPoint>
+
+    constructor(kernelClient: KernelAccountClient<entryPoint>) {
+        super()
+        this.kernelClient = kernelClient
+    }
+
+    async request({
+        method,
+        params = []
+    }: EIP1193Parameters): ReturnType<EIP1193RequestFn> {
+        switch (method) {
+            case "eth_requestAccounts":
+                return this.handleEthRequestAccounts()
+            case "eth_accounts":
+                return this.handleEthAccounts()
+            case "eth_sendTransaction":
+                return this.handleEthSendTransaction(params)
+            case "personal_sign":
+                return this.handlePersonalSign(params as [string, string])
+            default:
+                return this.kernelClient.transport.request({ method, params })
+        }
+    }
+
+    private async handleEthRequestAccounts(): Promise<string[]> {
+        if (!this.kernelClient.account) {
+            return []
+        }
+        return [this.kernelClient.account.address]
+    }
+
+    private async handleEthAccounts(): Promise<string[]> {
+        if (!this.kernelClient.account) {
+            return []
+        }
+        return [this.kernelClient.account.address]
+    }
+
+    private async handleEthSendTransaction(params: unknown): Promise<Hash> {
+        const [tx] = params as [SendTransactionParameters]
+        return this.kernelClient.sendTransaction(tx)
+    }
+
+    private async handlePersonalSign(
+        params: [string, string]
+    ): Promise<string> {
+        if (!this.kernelClient?.account) {
+            throw new Error("account not connected!")
+        }
+        const [message, address] = params
+        if (
+            address.toLowerCase() !==
+            this.kernelClient.account.address.toLowerCase()
+        ) {
+            throw new Error(
+                "cannot sign for address that is not the current account"
+            )
+        }
+
+        return this.kernelClient.signMessage({
+            message,
+            account: this.kernelClient.account
+        })
+    }
+}

package/providers/index.ts

@@ -0,0 +1 @@
+export { KernelEIP1193Provider } from "./KernelEIP1193Provider.js"

package/types/index.ts

@@ -0,0 +1,12 @@
+export type {
+    KernelValidator,
+    ZeroDevPaymasterRpcSchema,
+    ExecutorData,
+    KernelPluginManager,
+    ValidatorInitData,
+    CallType,
+    KernelEncodeCallDataArgs,
+    PluginValidityData
+} from "./kernel.js"
+
+export { ValidatorMode } from "./kernel.js"

package/types/kernel.ts

@@ -0,0 +1,186 @@
+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"
+import { VALIDATOR_TYPE } from "../constants.js"
+export type ZeroDevPaymasterRpcSchema<entryPoint extends EntryPoint> = [
+    {
+        Method: "zd_sponsorUserOperation"
+        Parameters: [
+            {
+                chainId: number
+                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
+                }
+                shouldOverrideFee?: boolean
+                manualGasEstimation?: boolean
+                shouldConsume?: boolean
+            }
+        ]
+        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"
+        Parameters: [
+            {
+                chainId: number
+                entryPointAddress: Address
+            }
+        ]
+        ReturnType: Address[]
+    },
+    {
+        Method: "stackup_getERC20TokenQuotes"
+        Parameters: [
+            {
+                chainId: number
+                userOp: UserOperationWithBigIntAsHex<"v0.6">
+                entryPointAddress: Address
+                tokenAddress: Address
+            }
+        ]
+        ReturnType: {
+            maxGasCostToken: string
+            tokenDecimals: string
+        }
+    }
+]
+
+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<entryPoint extends EntryPoint> =
+    KernelValidator<entryPoint> & {
+        getPluginEnableSignature(accountAddress: Address): Promise<Hex>
+        getValidatorInitData(): Promise<ValidatorInitData>
+        getExecutorData(): ExecutorData
+        getValidityData(): PluginValidityData
+    }
+
+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 = {
+    executor: Address
+    selector: Hex
+}
+
+export type PluginValidityData = {
+    validUntil: number
+    validAfter: number
+}
+
+export enum ValidatorMode {
+    sudo = "0x00000000",
+    plugin = "0x00000001",
+    enable = "0x00000002"
+}
+
+export type CallType = "call" | "delegatecall"
+
+export type KernelEncodeCallDataArgs =
+    | {
+          to: Address
+          value: bigint
+          data: Hex
+          callType: CallType | undefined
+      }
+    | {
+          to: Address
+          value: bigint
+          data: Hex
+          callType: CallType | undefined
+      }[]
+
+export type Execution = {
+    target: Address
+    value: bigint
+    callData: Hex
+}

package/utils.ts

@@ -0,0 +1,114 @@
+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 {
+    CALL_TYPE,
+    EXEC_TYPE,
+    KernelImplToVersionMap,
+    LATEST_KERNEL_VERSION
+} from "./constants.js"
+
+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<EntryPoint>,
+    {
+        gasToken,
+        approveAmount
+    }: {
+        gasToken: Address
+        approveAmount: bigint
+    }
+): Promise<{ to: Address; value: bigint; data: Hex }> => {
+    const response = await client.request({
+        method: "zd_pm_accounts",
+        params: [
+            {
+                chainId: client.chain?.id as number,
+                entryPointAddress: KERNEL_ADDRESSES.ENTRYPOINT_V0_6
+            }
+        ]
+    })
+    return {
+        to: gasToken,
+        data: encodeFunctionData({
+            abi: erc20Abi,
+            functionName: "approve",
+            args: [response[0], approveAmount]
+        }),
+        value: 0n
+    }
+}
+
+export const fixSignedData = (sig: Hex): Hex => {
+    let signature = sig
+    if (!isHex(signature)) {
+        signature = `0x${signature}`
+        if (!isHex(signature)) {
+            throw new Error(`Invalid signed data ${sig}`)
+        }
+    }
+
+    let { r, s, v } = hexToSignature(signature)
+    if (v === 0n || v === 1n) v += 27n
+    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 })
+    ])
+}

package/README.md

@@ -1,5 +0,0 @@
-# ZeroDev SDK
-
-SDK for [ZeroDev](https://docs.zerodev.app/), based on [Kernel](https://github.com/zerodevapp/kernel).
-
-Documentation available [here](https://github.com/zerodevapp/sdk#zerodev-sdk).

package/dist/cjs/index.d.ts

@@ -1,22 +0,0 @@
-export * from "./kernel-zerodev/abis/index.js";
-export { ValidatorMode, KernelBaseValidator, } from "./kernel-zerodev/validator/base.js";
-export * from "./kernel-zerodev/validator/index.js";
-export type * from "./kernel-zerodev/validator/types.js";
-export type { KernelBaseValidatorParams } from "./kernel-zerodev/validator/base.js";
-export { ParamOperator, ParamOperator as ParamCondition, getAbiItem, getPermissionFromABI, } from "./kernel-zerodev/validator/session-key-validator.js";
-export { ValidatorProvider } from "./kernel-zerodev/validator-provider/base.js";
-export type { ValidatorProviderParams, ValidatorProviderParamsOpts, ExtendedValidatorProviderParams, } from "./kernel-zerodev/validator-provider/base.js";
-export type * from "./kernel-zerodev/validator-provider/types.js";
-export * from "./kernel-zerodev/validator-provider/index.js";
-export { ECDSAProvider as SimpleProvider } from "./kernel-zerodev/validator-provider/index.js";
-export type * from "./kernel-zerodev/paymaster/types.js";
-export { KernelSmartContractAccount } from "./kernel-zerodev/account.js";
-export type { KernelSmartAccountParams } from "./kernel-zerodev/account.js";
-export { ZeroDevProvider, Operation } from "./kernel-zerodev/provider.js";
-export * from "./kernel-zerodev/utils.js";
-export { getChainId } from "./kernel-zerodev/api/index.js";
-export { ZeroDevEthersProvider } from "./kernel-zerodev/ethers-provider/ethers-provider.js";
-export { ZeroDevAccountSigner } from "./kernel-zerodev/ethers-provider/account-signer.js";
-export { EmptyAccountSigner } from "./kernel-zerodev/signer/empty-account.js";
-export * as constants from "./kernel-zerodev/constants.js";
-export * from "./kernel-zerodev/owner/index.js";