@zerodev/sdk 4.6.1 → 5.0.0

package/actions/index.ts

@@ -0,0 +1,11 @@
+export {
+    sponsorUserOperation,
+    type SponsorUserOperationParameters,
+    type SponsorUserOperationReturnType
+} from "./paymaster/sponsorUserOperation.js"
+
+export {
+    signUserOperation,
+    type SignUserOperationParameters,
+    type SignUserOperationReturnType
+} from "./account-client/signUserOperation.js"

package/actions/paymaster/sponsorUserOperation.ts

@@ -0,0 +1,85 @@
+import type {
+    UserOperation,
+    UserOperationWithBigIntAsHex
+} from "permissionless/types/userOperation.js"
+import { 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
+    gasTokenData?: {
+        tokenAddress: Hex
+        erc20UserOp: PartialBy<
+            UserOperation,
+            | "callGasLimit"
+            | "preVerificationGas"
+            | "verificationGasLimit"
+            | "paymasterAndData"
+        >
+        erc20CallData: Hex
+    }
+    shouldOverrideFee?: boolean
+    shouldConsume?: boolean
+}
+
+export type SponsorUserOperationReturnType = UserOperation
+
+/**
+ * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
+ */
+export const sponsorUserOperation = async (
+    client: ZeroDevPaymasterClient,
+    args: SponsorUserOperationParameters
+): Promise<SponsorUserOperationReturnType> => {
+    const response = await client.request({
+        method: "zd_sponsorUserOperation",
+        params: [
+            {
+                chainId: client.chain?.id as number,
+                userOp: deepHexlify(
+                    args.userOperation
+                ) as UserOperationWithBigIntAsHex,
+                entryPointAddress:
+                    args.entryPoint ?? KERNEL_ADDRESSES.ENTRYPOINT_V0_6,
+                gasTokenData: args.gasTokenData && {
+                    tokenAddress: args.gasTokenData.tokenAddress,
+                    erc20UserOp: deepHexlify(
+                        args.gasTokenData.erc20UserOp
+                    ) as UserOperationWithBigIntAsHex,
+                    erc20CallData: args.gasTokenData.erc20CallData
+                },
+                shouldOverrideFee: args.shouldOverrideFee ?? false,
+                shouldConsume: args.shouldConsume ?? true
+            }
+        ]
+    })
+    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)
+        }
+    }
+
+    return result
+}

package/clients/decorators/index.ts

@@ -0,0 +1,4 @@
+export {
+    zerodevPaymasterActions,
+    type ZeroDevPaymasterClientActions
+} from "./kernel.js"

package/clients/decorators/kernel.ts

@@ -0,0 +1,78 @@
+import { type SmartAccountActions, smartAccountActions } from "permissionless"
+import type { SmartAccount } from "permissionless/accounts/types"
+import type { SponsorUserOperationMiddleware } from "permissionless/actions/smartAccount"
+import type { Chain, Client, Transport } from "viem"
+import type {
+    SignUserOperationParameters,
+    SignUserOperationReturnType
+} from "../../actions/index.js"
+import { signUserOperation } from "../../actions/index.js"
+import {
+    type SponsorUserOperationParameters,
+    type SponsorUserOperationReturnType,
+    sponsorUserOperation
+} from "../../actions/paymaster/sponsorUserOperation.js"
+import type { ZeroDevPaymasterClient } from "../paymasterClient.js"
+
+export type ZeroDevPaymasterClientActions = {
+    /**
+     * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
+     */
+    sponsorUserOperation: (
+        args: SponsorUserOperationParameters
+    ) => Promise<SponsorUserOperationReturnType>
+}
+
+export const zerodevPaymasterActions = (
+    client: Client
+): ZeroDevPaymasterClientActions => ({
+    sponsorUserOperation: async (args: SponsorUserOperationParameters) =>
+        sponsorUserOperation(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 type KernelAccountClientActions<
+    TChain extends Chain | undefined = Chain | undefined,
+    TSmartAccount extends SmartAccount | undefined = SmartAccount | undefined
+> = SmartAccountActions<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<TTransport, TChain, TSmartAccount>
+        >[1]
+    ) => Promise<SignUserOperationReturnType>
+}
+
+export const kernelAccountClientActions =
+    ({ sponsorUserOperation }: SponsorUserOperationMiddleware) =>
+    <
+        TTransport extends Transport,
+        TChain extends Chain | undefined = Chain | undefined,
+        TSmartAccount extends SmartAccount | undefined =
+            | SmartAccount
+            | undefined
+    >(
+        client: Client<TTransport, TChain, TSmartAccount>
+    ): KernelAccountClientActions<TChain, TSmartAccount> => ({
+        ...smartAccountActions({ sponsorUserOperation })(client),
+        signUserOperation: (args) =>
+            signUserOperation(client, {
+                ...args,
+                sponsorUserOperation
+            } as SignUserOperationParameters<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,78 @@
+import type { SmartAccount } from "permissionless/accounts/types"
+import type { SponsorUserOperationMiddleware } from "permissionless/actions/smartAccount"
+import type { 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"
+import { type KernelSmartAccount } from "../accounts/index.js"
+import {
+    type KernelAccountClientActions,
+    kernelAccountClientActions
+} from "./decorators/kernel.js"
+
+export type KernelAccountClient<
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends KernelSmartAccount | undefined =
+        | KernelSmartAccount
+        | undefined
+> = Prettify<
+    Client<
+        transport,
+        chain,
+        account,
+        BundlerRpcSchema,
+        KernelAccountClientActions<chain, account>
+    >
+>
+
+export type SmartAccountClientConfig<
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    TAccount extends SmartAccount | undefined = SmartAccount | undefined
+> = Prettify<
+    Pick<
+        ClientConfig<transport, chain, TAccount>,
+        | "account"
+        | "cacheTime"
+        | "chain"
+        | "key"
+        | "name"
+        | "pollingInterval"
+        | "transport"
+    >
+>
+
+export const createKernelAccountClient = <
+    TTransport extends Transport,
+    TChain extends Chain | undefined = undefined,
+    TSmartAccount extends KernelSmartAccount | undefined = undefined
+>(
+    parameters: SmartAccountClientConfig<TTransport, TChain, TSmartAccount> &
+        SponsorUserOperationMiddleware
+): KernelAccountClient<TTransport, TChain, ParseAccount<TSmartAccount>> => {
+    const {
+        key = "Account",
+        name = "Kernel Account Client",
+        transport
+    } = parameters
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        transport: (opts) => transport({ ...opts, retryCount: 0 }),
+        type: "kernelAccountClient"
+    })
+
+    return client.extend(
+        kernelAccountClientActions({
+            sponsorUserOperation: parameters.sponsorUserOperation
+        })
+    )
+}

package/clients/paymasterClient.ts

@@ -0,0 +1,53 @@
+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 = Client<
+    Transport,
+    Chain | undefined,
+    Account | undefined,
+    ZeroDevPaymasterRpcSchema,
+    ZeroDevPaymasterClientActions
+>
+/**
+ * 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 = <
+    transport extends Transport,
+    chain extends Chain | undefined = undefined
+>(
+    parameters: PublicClientConfig<transport, chain>
+): ZeroDevPaymasterClient => {
+    const { key = "public", name = "ZeroDev Paymaster Client" } = parameters
+    const client = createClient({
+        ...parameters,
+        key,
+        name,
+        type: "zerodevPaymasterClient"
+    })
+    return client.extend(zerodevPaymasterActions)
+}

package/constants.ts

@@ -0,0 +1,12 @@
+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"
+}
+export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
+export const LATEST_KERNEL_VERSION = "0.2.3"

package/index.ts

@@ -0,0 +1,36 @@
+export {
+    createKernelAccount,
+    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 { TokenActionsAbi } from "./accounts/kernel/abi/TokenActionsAbi.js"
+export * as constants from "./constants.js"
+export * from "./utils.js"

package/package.json

@@ -1,75 +1,91 @@
 {
   "name": "@zerodev/sdk",
-  "version": "4.6.1",
-  "description": "A collection of ERC-4337 compliant smart contract account interfaces",
+  "version": "5.0.0",
   "author": "ZeroDev",
-  "license": "MIT",
-  "private": false,
+  "main": "./_cjs/index.js",
+  "module": "./_esm/index.js",
+  "types": "./_types/index.d.ts",
+  "typings": "./_types/index.d.ts",
   "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,
+  "description": "A utility library for working with ERC-4337",
+  "keywords": [
+    "ethereum",
+    "erc-4337",
+    "eip-4337",
+    "paymaster",
+    "bundler"
+  ],
+  "license": "MIT",
   "files": [
-    "passkey",
-    "dist",
-    "src/**/*.ts",
-    "!dist/**/*.tsbuildinfo",
-    "!vitest.config.ts",
+    "_esm",
+    "_cjs",
+    "_types",
+    "./**/*.ts",
+    "!_esm/**/*.tsbuildinfo",
+    "!_cjs/**/*.tsbuildinfo",
+    "!_types/**/*.tsbuildinfo",
     "!.env",
-    "!src/**/*.test.ts",
-    "!src/__tests__/**/*"
+    "!./**/*.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": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
+      "types": "./_types/index.d.ts",
+      "import": "./_esm/index.js",
+      "default": "./_cjs/index.js"
     },
-    "./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"
+    "./accounts": {
+      "types": "./_types/accounts/index.d.ts",
+      "import": "./_esm/accounts/index.js",
+      "default": "./_cjs/accounts/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"
+    "./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"
+    }
   },
-  "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",
+    "permissionless": "^0.0.30"
   }
 }

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,116 @@
+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 = [
+    {
+        Method: "zd_sponsorUserOperation"
+        Parameters: [
+            {
+                chainId: number
+                userOp: PartialBy<
+                    UserOperationWithBigIntAsHex,
+                    | "callGasLimit"
+                    | "preVerificationGas"
+                    | "verificationGasLimit"
+                    | "paymasterAndData"
+                >
+                entryPointAddress: Address
+                gasTokenData?: {
+                    tokenAddress: Hex
+                    erc20UserOp: PartialBy<
+                        UserOperationWithBigIntAsHex,
+                        | "callGasLimit"
+                        | "preVerificationGas"
+                        | "verificationGasLimit"
+                        | "paymasterAndData"
+                    >
+                    erc20CallData: Hex
+                }
+                shouldOverrideFee?: boolean
+                manualGasEstimation?: boolean
+                shouldConsume?: boolean
+            }
+        ]
+        ReturnType: {
+            paymasterAndData: Hex
+            preVerificationGas: Hex
+            verificationGasLimit: Hex
+            callGasLimit: Hex
+            maxFeePerGas: Hex
+            maxPriorityFeePerGas: Hex
+        }
+    }
+]
+
+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>
+        getValidatorMode(
+            accountAddress: Address,
+            selector: Hex
+        ): Promise<ValidatorMode>
+    }
+
+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 KernelPluginManagerParams = {
+    validator: KernelValidator
+    defaultValidator?: KernelValidator
+    pluginEnableSignature?: Hex
+    validatorInitData?: ValidatorInitData
+    executorData?: ExecutorData
+} & 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
+      }[]