@zerodev/sdk 5.2.0-alpha-4 → 5.2.0

package/clients/kernelAccountClient.ts

@@ -1,8 +1,10 @@
+import { getEntryPointVersion } from "permissionless"
 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 {
+    http,
     type Chain,
     type Client,
     type ClientConfig,
@@ -10,10 +12,12 @@ import {
     createClient
 } from "viem"
 import { type KernelSmartAccount } from "../accounts/index.js"
+import { getUserOperationGasPrice } from "../actions/account-client/getUserOperationGasPrice.js"
 import {
     type KernelAccountClientActions,
     kernelAccountClientActions
 } from "./decorators/kernel.js"
+import { hasPimlicoAsProvider, setPimlicoAsProvider } from "./utils.js"
 
 export type KernelAccountClient<
     entryPoint extends EntryPoint,
@@ -69,19 +73,48 @@ export const createKernelAccountClient = <
     const {
         key = "Account",
         name = "Kernel Account Client",
-        bundlerTransport
+        bundlerTransport,
+        entryPoint
     } = parameters
+    const entryPointVersion = getEntryPointVersion(entryPoint)
+    const shouldIncludePimlicoProvider =
+        bundlerTransport({}).config.key === "http" &&
+        entryPointVersion === "v0.7"
+
     const client = createClient({
         ...parameters,
         key,
         name,
-        transport: (opts) => bundlerTransport({ ...opts, retryCount: 0 }),
+        transport: (opts) => {
+            let _bundlerTransport = bundlerTransport({
+                ...opts,
+                retryCount: 0
+            })
+            if (!shouldIncludePimlicoProvider) return _bundlerTransport
+            _bundlerTransport = http(
+                setPimlicoAsProvider(_bundlerTransport.value?.url)
+            )({ ...opts, retryCount: 0 })
+            return _bundlerTransport
+        },
         type: "kernelAccountClient"
     })
 
+    let middleware = parameters.middleware
+    if (
+        (!middleware ||
+            (typeof middleware !== "function" && !middleware.gasPrice)) &&
+        client.transport?.url &&
+        hasPimlicoAsProvider(client.transport.url)
+    ) {
+        const gasPrice = () => getUserOperationGasPrice(client)
+        middleware = {
+            ...middleware,
+            gasPrice
+        }
+    }
     return client.extend(
         kernelAccountClientActions({
-            middleware: parameters.middleware
+            middleware
         })
     ) as KernelAccountClient<entryPoint, TTransport, TChain, TSmartAccount>
 }

package/clients/paymasterClient.ts

@@ -1,5 +1,7 @@
+import { getEntryPointVersion } from "permissionless"
 import type { EntryPoint } from "permissionless/types/entrypoint"
 import {
+    http,
     type Account,
     type Chain,
     type Client,
@@ -12,6 +14,7 @@ import {
     type ZeroDevPaymasterClientActions,
     zerodevPaymasterActions
 } from "./decorators/kernel.js"
+import { setPimlicoAsProvider } from "./utils.js"
 
 export type ZeroDevPaymasterClient<entryPoint extends EntryPoint> = Client<
     Transport,
@@ -46,9 +49,29 @@ export const createZeroDevPaymasterClient = <
         entryPoint: entryPoint
     }
 ): ZeroDevPaymasterClient<entryPoint> => {
-    const { key = "public", name = "ZeroDev Paymaster Client" } = parameters
+    const {
+        key = "public",
+        name = "ZeroDev Paymaster Client",
+        entryPoint: entryPointAddress,
+        transport
+    } = parameters
+    const entryPointVersion = getEntryPointVersion(entryPointAddress)
+    const shouldIncludePimlicoProvider =
+        transport({}).config.key === "http" && entryPointVersion === "v0.7"
     const client = createClient({
         ...parameters,
+        transport: (opts) => {
+            let _transport = transport({
+                ...opts,
+                retryCount: 0
+            })
+            if (!shouldIncludePimlicoProvider) return _transport
+            _transport = http(setPimlicoAsProvider(_transport.value?.url))({
+                ...opts,
+                retryCount: 0
+            })
+            return _transport
+        },
         key,
         name,
         type: "zerodevPaymasterClient"

package/clients/utils.ts

@@ -0,0 +1,28 @@
+export const setPimlicoAsProvider = (urlString: string): string => {
+    const url = new URL(urlString)
+
+    const params = url.searchParams
+
+    if (params.has("bundlerProvider")) {
+        params.set("bundlerProvider", "PIMLICO")
+    } else if (params.has("paymasterProvider")) {
+        params.set("paymasterProvider", "PIMLICO")
+    } else {
+        params.set("provider", "PIMLICO")
+    }
+
+    url.search = params.toString()
+
+    return url.toString()
+}
+
+export const hasPimlicoAsProvider = (urlString: string): boolean => {
+    const url = new URL(urlString)
+    const params = url.searchParams
+    const provider =
+        params.get("provider") ??
+        params.get("bundlerProvider") ??
+        params.get("paymasterProvider")
+    if (provider === "PIMLICO") return true
+    return false
+}

package/constants.ts

@@ -1,5 +1,5 @@
 import type { EntryPointVersion } from "permissionless/types/entrypoint"
-import { type Address } from "viem"
+import { type Address, type Hex } from "viem"
 
 export const DUMMY_ECDSA_SIG =
     "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"
@@ -10,7 +10,7 @@ export const KernelImplToVersionMap: { [key: Address]: string } = {
     "0xD3F582F6B4814E989Ee8E96bc3175320B5A540ab": "0.2.3",
     "0x5FC0236D6c88a65beD32EECDC5D60a5CAb377717": "0.2.3",
     "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4",
-    "0x079D5D8A3275A230AF743cB59c341Ff74B82488D": "0.3.0-beta"
+    "0x94F097E1ebEB4ecA3AAE54cabb08905B239A7D27": "0.3.0-beta"
 }
 export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
 export const KERNEL_NAME = "Kernel"
@@ -41,3 +41,7 @@ export enum EXEC_TYPE {
 // Address was found here: https://github.com/safe-global/safe-deployments/blob/926ec6bbe2ebcac3aa2c2c6c0aff74aa590cbc6a/src/assets/v1.4.1/create_call.json
 export const safeCreateCallAddress =
     "0x9b35Af71d77eaf8d7e40252370304687390A1A52"
+export const KernelFactoryToInitCodeHashMap: { [key: Address]: Hex } = {
+    "0x5de4839a76cf55d0c90e2061ef4386d962E15ae3":
+        "0xee9d8350bd899dd261db689aafd87eb8a30f085adbaff48152399438ff4eed73"
+}

package/index.ts

@@ -38,9 +38,14 @@ export {
     KernelV3ExecuteAbi,
     KernelV3InitAbi
 } from "./accounts/kernel/abi/kernel_v_3_0_0/KernelAccountAbi.js"
+export { KernelV3FactoryAbi } from "./accounts/kernel/abi/kernel_v_3_0_0/KernelFactoryAbi.js"
+export { KernelFactoryStakerAbi } from "./accounts/kernel/abi/kernel_v_3_0_0/KernelFactoryStakerAbi.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 {
+    verifyEIP6492Signature,
+    getCustomNonceKeyFromString
+} from "./accounts/utils/index.js"
 export { KernelEIP1193Provider } from "./providers/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/sdk",
-    "version": "5.2.0-alpha-4",
+    "version": "5.2.0",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -90,10 +90,10 @@
         }
     },
     "peerDependencies": {
-        "viem": "^2.0.0"
+        "viem": "^2.0.0",
+        "permissionless": "^0.1.16"
     },
     "dependencies": {
-        "semver": "^7.6.0",
-        "permissionless": "^0.1.4"
+        "semver": "^7.6.0"
     }
 }

package/providers/KernelEIP1193Provider.ts

@@ -29,8 +29,13 @@ export class KernelEIP1193Provider<
                 return this.handleEthAccounts()
             case "eth_sendTransaction":
                 return this.handleEthSendTransaction(params)
+            case "eth_sign":
+                return this.handleEthSign(params as [string, string])
             case "personal_sign":
                 return this.handlePersonalSign(params as [string, string])
+            case "eth_signTypedData":
+            case "eth_signTypedData_v4":
+                return this.handleEthSignTypedDataV4(params as [string, string])
             default:
                 return this.kernelClient.transport.request({ method, params })
         }
@@ -55,6 +60,26 @@ export class KernelEIP1193Provider<
         return this.kernelClient.sendTransaction(tx)
     }
 
+    private async handleEthSign(params: [string, string]): Promise<string> {
+        if (!this.kernelClient?.account) {
+            throw new Error("account not connected!")
+        }
+        const [address, message] = 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
+        })
+    }
+
     private async handlePersonalSign(
         params: [string, string]
     ): Promise<string> {
@@ -76,4 +101,30 @@ export class KernelEIP1193Provider<
             account: this.kernelClient.account
         })
     }
+
+    private async handleEthSignTypedDataV4(
+        params: [string, string]
+    ): Promise<string> {
+        if (!this.kernelClient?.account) {
+            throw new Error("account not connected!")
+        }
+        const [address, typedDataJSON] = params
+        const typedData = JSON.parse(typedDataJSON)
+        if (
+            address.toLowerCase() !==
+            this.kernelClient.account.address.toLowerCase()
+        ) {
+            throw new Error(
+                "cannot sign for address that is not the current account"
+            )
+        }
+
+        return this.kernelClient.signTypedData({
+            account: this.kernelClient.account,
+            domain: typedData.domain,
+            types: typedData.types,
+            message: typedData.message,
+            primaryType: typedData.primaryType
+        })
+    }
 }

package/types/index.ts

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

package/types/kernel.ts

@@ -88,55 +88,69 @@ export type ZeroDevPaymasterRpcSchema<entryPoint extends EntryPoint> = [
     }
 ]
 
-export type ValidatorType = keyof typeof VALIDATOR_TYPE
+export type ZeroDevUserOperationGasPriceWithBigIntAsHex = {
+    slow: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+    standard: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+    fast: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+}
+
+export type ZeroDevAccountClientRpcSchema = [
+    {
+        Method: "zd_getUserOperationGasPrice"
+        Parameters: []
+        ReturnType: ZeroDevUserOperationGasPriceWithBigIntAsHex
+    }
+]
+
+export type ValidatorType = Extract<
+    keyof typeof VALIDATOR_TYPE,
+    "PERMISSION" | "SECONDARY"
+>
 
 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
-      }
+    Name extends string = string
+> = LocalAccount<Name> & {
+    validatorType: ValidatorType
+    getNonceKey: (
+        accountAddress?: Address,
+        customNonceKey?: bigint
+    ) => 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>
+    getIdentifier: () => Hex
+}
 
 export type ValidatorInitData = {
     validatorAddress: Address
     enableData: Hex
+    identifier: Hex
 }
 
 export type KernelPluginManager<entryPoint extends EntryPoint> =
     KernelValidator<entryPoint> & {
         getPluginEnableSignature(accountAddress: Address): Promise<Hex>
         getValidatorInitData(): Promise<ValidatorInitData>
-        getExecutorData(): ExecutorData
+        getAction(): Action
         getValidityData(): PluginValidityData
-        getValidationId(isSudo?: boolean): Hex
+        getIdentifier(isSudo?: boolean): Hex
     }
 
 export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
@@ -144,13 +158,13 @@ export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
     regular?: KernelValidator<entryPoint>
     pluginEnableSignature?: Hex
     validatorInitData?: ValidatorInitData
-    executorData?: ExecutorData
+    action?: Action
     entryPoint: entryPoint
     kernelVersion?: string
 } & Partial<PluginValidityData>
 
-export type ExecutorData = {
-    executor: Address
+export type Action = {
+    address: Address
     selector: Hex
 }
 

package/utils.ts

@@ -1,4 +1,4 @@
-import { getEntryPointVersion } from "permissionless"
+import { ENTRYPOINT_ADDRESS_V06, getEntryPointVersion } from "permissionless"
 import type { EntryPoint } from "permissionless/types/entrypoint"
 import { satisfies } from "semver"
 import {
@@ -13,7 +13,6 @@ import {
     signatureToHex,
     zeroAddress
 } from "viem"
-import { KERNEL_ADDRESSES } from "./accounts/index.js"
 import type { ZeroDevPaymasterClient } from "./clients/paymasterClient.js"
 import {
     CALL_TYPE,
@@ -73,7 +72,7 @@ export const getERC20PaymasterApproveCall = async (
         params: [
             {
                 chainId: client.chain?.id as number,
-                entryPointAddress: KERNEL_ADDRESSES.ENTRYPOINT_V0_6
+                entryPointAddress: ENTRYPOINT_ADDRESS_V06
             }
         ]
     })