@zerodev/sdk 5.2.16 → 5.2.18-alpha-0

package/accounts/kernel/utils/account/ep0_7/encodeCallData.ts

@@ -1,4 +1,4 @@
-import type { EntryPoint } from "permissionless/types/entrypoint.js"
+import type { EntryPoint } from "permissionless/types"
 import { EXEC_TYPE } from "../../../../../constants.js"
 import type { KernelSmartAccount } from "../../../createKernelAccount.js"
 import { encodeExecuteBatchCall } from "../../ep0_7/encodeExecuteBatchCall.js"
@@ -8,23 +8,32 @@ import { encodeExecuteSingleCall } from "../../ep0_7/encodeExecuteSingleCall.js"
 export const encodeCallData = async <
     entryPoint extends EntryPoint = EntryPoint
 >(
-    tx: Parameters<KernelSmartAccount<entryPoint>["encodeCallData"]>[0]
+    tx: Parameters<KernelSmartAccount<entryPoint>["encodeCallData"]>[0],
+    includeHooks?: boolean
 ) => {
     if (Array.isArray(tx)) {
         if (tx.some((t) => t.callType === "delegatecall")) {
             throw new Error("Cannot batch delegatecall")
         }
         // Encode a batched call
-        return encodeExecuteBatchCall(tx, {
-            execType: EXEC_TYPE.DEFAULT
-        })
+        return encodeExecuteBatchCall(
+            tx,
+            {
+                execType: EXEC_TYPE.DEFAULT
+            },
+            includeHooks
+        )
     }
 
     // Default to `call`
     if (!tx.callType || tx.callType === "call") {
-        return encodeExecuteSingleCall(tx, {
-            execType: EXEC_TYPE.DEFAULT
-        })
+        return encodeExecuteSingleCall(
+            tx,
+            {
+                execType: EXEC_TYPE.DEFAULT
+            },
+            includeHooks
+        )
     }
 
     if (tx.callType === "delegatecall") {
@@ -32,7 +41,8 @@ export const encodeCallData = async <
             { to: tx.to, data: tx.data },
             {
                 execType: EXEC_TYPE.DEFAULT
-            }
+            },
+            includeHooks
         )
     }
 

package/accounts/kernel/utils/ep0_7/encodeExecuteBatchCall.ts

@@ -8,7 +8,8 @@ import {
 
 export const encodeExecuteBatchCall = (
     args: CallArgs[],
-    options: Omit<EncodeExecuteOptions, "callType">
+    options: Omit<EncodeExecuteOptions, "callType">,
+    includeHooks?: boolean
 ) => {
     const calldata = encodeAbiParameters(
         [
@@ -46,6 +47,7 @@ export const encodeExecuteBatchCall = (
         {
             callType: CALL_TYPE.BATCH,
             execType: options.execType
-        }
+        },
+        includeHooks
     )
 }

package/accounts/kernel/utils/ep0_7/encodeExecuteCall.ts

@@ -1,4 +1,11 @@
-import { type Hex, concatHex, encodeFunctionData, toHex } from "viem"
+import {
+    type Hex,
+    concatHex,
+    encodeFunctionData,
+    getAbiItem,
+    toFunctionSelector,
+    toHex
+} from "viem"
 import { CALL_TYPE } from "../../../../constants.js"
 import { getExecMode } from "../../../../utils.js"
 import { KernelV3ExecuteAbi } from "../../abi/kernel_v_3_0_0/KernelAccountAbi.js"
@@ -16,7 +23,8 @@ type EncodeExecuteCallArgs<TOptions> =
 
 export const encodeExecuteCall = <TOptions extends EncodeExecuteOptions>(
     args: EncodeExecuteCallArgs<TOptions>,
-    options: TOptions
+    options: TOptions,
+    includeHooks = false
 ) => {
     let calldata: Hex
     if ("calldata" in args) {
@@ -30,6 +38,26 @@ export const encodeExecuteCall = <TOptions extends EncodeExecuteOptions>(
             args.data
         ])
     }
+
+    const executeUserOpSig = toFunctionSelector(
+        getAbiItem({ abi: KernelV3ExecuteAbi, name: "executeUserOp" })
+    )
+
+    // The calldata using hook plugin should be as follows:
+    // [0:4] - `executeUserOp` function signature
+    // [4:8] - `execute` function signature
+    // [8:] - `execute` function arguments
+    if (includeHooks) {
+        return concatHex([
+            executeUserOpSig,
+            encodeFunctionData({
+                abi: KernelV3ExecuteAbi,
+                functionName: "execute",
+                args: [getExecMode(options), calldata]
+            })
+        ])
+    }
+
     return encodeFunctionData({
         abi: KernelV3ExecuteAbi,
         functionName: "execute",

package/accounts/kernel/utils/ep0_7/encodeExecuteDelegateCall.ts

@@ -7,10 +7,15 @@ import {
 
 export const encodeExecuteDelegateCall = (
     args: DelegateCallArgs,
-    options: Omit<EncodeExecuteOptions, "callType">
+    options: Omit<EncodeExecuteOptions, "callType">,
+    includeHooks?: boolean
 ) => {
-    return encodeExecuteCall(args, {
-        callType: CALL_TYPE.DELEGATE_CALL,
-        execType: options.execType
-    })
+    return encodeExecuteCall(
+        args,
+        {
+            callType: CALL_TYPE.DELEGATE_CALL,
+            execType: options.execType
+        },
+        includeHooks
+    )
 }

package/accounts/kernel/utils/ep0_7/encodeExecuteSingleCall.ts

@@ -7,10 +7,15 @@ import {
 
 export const encodeExecuteSingleCall = (
     args: CallArgs,
-    options: Omit<EncodeExecuteOptions, "callType">
+    options: Omit<EncodeExecuteOptions, "callType">,
+    includeHooks?: boolean
 ) => {
-    return encodeExecuteCall(args, {
-        callType: CALL_TYPE.SINGLE,
-        execType: options.execType
-    })
+    return encodeExecuteCall(
+        args,
+        {
+            callType: CALL_TYPE.SINGLE,
+            execType: options.execType
+        },
+        includeHooks
+    )
 }

package/accounts/kernel/utils/plugins/ep0_7/getEncodedPluginsData.ts

@@ -6,28 +6,33 @@ import {
     zeroAddress
 } from "viem"
 import { CALL_TYPE } from "../../../../../constants.js"
-import type { Action } from "../../../../../types/kernel.js"
+import type {
+    Action,
+    KernelValidatorHook
+} from "../../../../../types/kernel.js"
 
 export const getEncodedPluginsData = async ({
     enableSignature,
     userOpSignature,
     action,
-    enableData
+    enableData,
+    hook
 }: {
     enableSignature: Hex
     userOpSignature: Hex
     action: Action
     enableData: Hex
+    hook?: KernelValidatorHook
 }) => {
     return concat([
-        zeroAddress, // hook address 20 bytes
+        hook?.getIdentifier() ?? zeroAddress, // hook address 20 bytes
         encodeAbiParameters(
             parseAbiParameters(
                 "bytes validatorData, bytes hookData, bytes selectorData, bytes enableSig, bytes userOpSig"
             ),
             [
                 enableData,
-                "0x",
+                (await hook?.getEnableData()) ?? "0x",
                 concat([
                     action.selector,
                     action.address,

package/accounts/kernel/utils/plugins/ep0_7/getPluginsEnableTypedData.ts

@@ -12,6 +12,7 @@ import {
     zeroAddress
 } from "viem"
 import { CALL_TYPE, VALIDATOR_TYPE } from "../../../../../constants.js"
+import type { KernelValidatorHook } from "../../../../../types/kernel.js"
 import type { Kernel2_0_plugins } from "../ep0_6/getPluginsEnableTypedData.js"
 
 export const getPluginsEnableTypedData = async <
@@ -21,6 +22,7 @@ export const getPluginsEnableTypedData = async <
     chainId,
     kernelVersion,
     action,
+    hook,
     validator,
     validatorNonce
 }: {
@@ -28,6 +30,7 @@ export const getPluginsEnableTypedData = async <
     chainId: number
     kernelVersion: string
     validatorNonce: number
+    hook?: KernelValidatorHook
 } & Kernel2_0_plugins<entryPoint>): Promise<
     Parameters<CustomSource["signTypedData"]>[0]
 > => {
@@ -54,9 +57,9 @@ export const getPluginsEnableTypedData = async <
                 pad(validator.getIdentifier(), { size: 20, dir: "right" })
             ]),
             nonce: validatorNonce,
-            hook: zeroAddress,
+            hook: hook?.getIdentifier() ?? zeroAddress,
             validatorData: await validator.getEnableData(accountAddress),
-            hookData: "0x",
+            hookData: (await hook?.getEnableData(accountAddress)) ?? "0x",
             selectorData: concat([
                 action.selector,
                 action.address,

package/accounts/utils/toKernelPluginManager.ts

@@ -51,6 +51,7 @@ export async function toKernelPluginManager<
     {
         sudo,
         regular,
+        hook,
         pluginEnableSignature,
         validatorInitData,
         action,
@@ -99,8 +100,9 @@ export async function toKernelPluginManager<
                     return ValidatorMode.plugin
                 }
 
-                const enableSignature =
-                    await getPluginEnableSignature(accountAddress)
+                const enableSignature = await getPluginEnableSignature(
+                    accountAddress
+                )
                 if (!enableSignature) {
                     throw new Error("Enable signature not set")
                 }
@@ -124,13 +126,15 @@ export async function toKernelPluginManager<
             if (await isPluginEnabled(accountAddress, action.selector)) {
                 return userOpSignature
             }
-            const enableSignature =
-                await getPluginEnableSignature(accountAddress)
+            const enableSignature = await getPluginEnableSignature(
+                accountAddress
+            )
             return getEncodedPluginsDataV2({
                 enableSignature,
                 userOpSignature,
                 action,
-                enableData: await regular.getEnableData(accountAddress)
+                enableData: await regular.getEnableData(accountAddress),
+                hook
             })
         } else if (sudo) {
             return userOpSignature
@@ -190,10 +194,12 @@ export async function toKernelPluginManager<
             chainId,
             kernelVersion: version,
             action,
+            hook,
             validator: regular,
             validatorNonce
         })
         ownerSig = await sudo.signTypedData(typedData)
+        pluginEnableSignature = ownerSig
 
         return ownerSig
     }
@@ -238,6 +244,7 @@ export async function toKernelPluginManager<
     return {
         sudoValidator: sudo,
         ...activeValidator,
+        hook,
         getIdentifier,
         encodeModuleInstallCallData: async (accountAddress: Address) => {
             if (!action) {
@@ -258,8 +265,9 @@ export async function toKernelPluginManager<
             throw new Error("EntryPoint v0.7 not supported yet")
         },
         signUserOperation: async (userOperation) => {
-            const userOpSig =
-                await activeValidator.signUserOperation(userOperation)
+            const userOpSig = await activeValidator.signUserOperation(
+                userOperation
+            )
             if (entryPointVersion === "v0.6") {
                 return concatHex([
                     await getSignatureData(
@@ -286,8 +294,9 @@ export async function toKernelPluginManager<
             validUntil
         }),
         getDummySignature: async (userOperation) => {
-            const userOpSig =
-                await activeValidator.getDummySignature(userOperation)
+            const userOpSig = await activeValidator.getDummySignature(
+                userOperation
+            )
             if (entryPointVersion === "v0.6") {
                 return concatHex([
                     await getSignatureData(

package/index.ts

@@ -30,6 +30,7 @@ export {
 export { createFallbackKernelAccountClient } from "./clients/fallbackKernelAccountClient.js"
 export {
     type KernelValidator,
+    type KernelValidatorHook,
     type ZeroDevPaymasterRpcSchema,
     type KernelPluginManager,
     type Action

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/sdk",
-    "version": "5.2.16",
+    "version": "5.2.18-alpha-0",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -9,7 +9,13 @@
     "type": "module",
     "sideEffects": false,
     "description": "A utility library for working with ERC-4337",
-    "keywords": ["ethereum", "erc-4337", "eip-4337", "paymaster", "bundler"],
+    "keywords": [
+        "ethereum",
+        "erc-4337",
+        "eip-4337",
+        "paymaster",
+        "bundler"
+    ],
     "license": "MIT",
     "files": [
         "_esm",
@@ -85,14 +91,30 @@
     },
     "typesVersions": {
         "*": {
-            "accounts": ["./_types/accounts/index.d.ts"],
-            "plugins": ["./_types/plugins/index.d.ts"],
-            "actions": ["./_types/actions/index.d.ts"],
-            "types": ["./_types/types/index.d.ts"],
-            "actions/kernel": ["./_types/actions/kernel/index.d.ts"],
-            "clients": ["./_types/clients/index.d.ts"],
-            "clients/kernel": ["./_types/clients/kernel/index.d.ts"],
-            "providers": ["./_types/providers/index.d.ts"]
+            "accounts": [
+                "./_types/accounts/index.d.ts"
+            ],
+            "plugins": [
+                "./_types/plugins/index.d.ts"
+            ],
+            "actions": [
+                "./_types/actions/index.d.ts"
+            ],
+            "types": [
+                "./_types/types/index.d.ts"
+            ],
+            "actions/kernel": [
+                "./_types/actions/kernel/index.d.ts"
+            ],
+            "clients": [
+                "./_types/clients/index.d.ts"
+            ],
+            "clients/kernel": [
+                "./_types/clients/kernel/index.d.ts"
+            ],
+            "providers": [
+                "./_types/providers/index.d.ts"
+            ]
         }
     },
     "peerDependencies": {

package/types/kernel.ts

@@ -143,6 +143,11 @@ export type KernelValidator<
     getIdentifier: () => Hex
 }
 
+export type KernelValidatorHook = {
+    getEnableData(accountAddress?: Address): Promise<Hex>
+    getIdentifier: () => Hex
+}
+
 export type ValidatorInitData = {
     validatorAddress: Address
     enableData: Hex
@@ -152,6 +157,7 @@ export type ValidatorInitData = {
 export type KernelPluginManager<entryPoint extends EntryPoint> =
     KernelValidator<entryPoint> & {
         sudoValidator?: KernelValidator<entryPoint>
+        hook?: KernelValidatorHook
         getPluginEnableSignature(accountAddress: Address): Promise<Hex>
         getValidatorInitData(): Promise<ValidatorInitData>
         getAction(): Action
@@ -182,6 +188,7 @@ export type PluginInstallData<entryPoint extends EntryPoint> =
 export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
     sudo?: KernelValidator<entryPoint>
     regular?: KernelValidator<entryPoint>
+    hook?: KernelValidatorHook
     pluginEnableSignature?: Hex
     validatorInitData?: ValidatorInitData
     action?: Action