@zerodev/sdk 5.3.0-alpha-0 → 5.3.1

package/accounts/kernel/createKernelAccount.ts

@@ -47,6 +47,7 @@ import {
 import { KernelInitAbi } from "./abi/KernelAccountAbi.js"
 import { KernelV3InitAbi } from "./abi/kernel_v_3_0_0/KernelAccountAbi.js"
 import { KernelFactoryStakerAbi } from "./abi/kernel_v_3_0_0/KernelFactoryStakerAbi.js"
+import { KernelV3_1AccountAbi } from "./abi/kernel_v_3_1/KernelAccountAbi.js"
 import { encodeCallData as encodeCallDataEpV06 } from "./utils/account/ep0_6/encodeCallData.js"
 import { encodeDeployCallData as encodeDeployCallDataV06 } from "./utils/account/ep0_6/encodeDeployCallData.js"
 import { encodeCallData as encodeCallDataEpV07 } from "./utils/account/ep0_7/encodeCallData.js"
@@ -137,11 +138,13 @@ export const KERNEL_ADDRESSES: {
 const getKernelInitData = async <entryPoint extends EntryPoint>({
     entryPoint: entryPointAddress,
     kernelPluginManager,
-    initHook
+    initHook,
+    kernelVersion
 }: {
     entryPoint: entryPoint
     kernelPluginManager: KernelPluginManager<entryPoint>
     initHook: boolean
+    kernelVersion: GetKernelVersion<entryPoint>
 }) => {
     const entryPointVersion = getEntryPointVersion(entryPointAddress)
     const { enableData, identifier, validatorAddress } =
@@ -155,8 +158,24 @@ const getKernelInitData = async <entryPoint extends EntryPoint>({
         })
     }
 
+    if (kernelVersion === "0.3.0") {
+        return encodeFunctionData({
+            abi: KernelV3InitAbi,
+            functionName: "initialize",
+            args: [
+                identifier,
+                initHook && kernelPluginManager.hook
+                    ? kernelPluginManager.hook?.getIdentifier()
+                    : zeroAddress,
+                enableData,
+                initHook && kernelPluginManager.hook
+                    ? await kernelPluginManager.hook?.getEnableData()
+                    : "0x"
+            ]
+        })
+    }
     return encodeFunctionData({
-        abi: KernelV3InitAbi,
+        abi: KernelV3_1AccountAbi,
         functionName: "initialize",
         args: [
             identifier,
@@ -166,7 +185,8 @@ const getKernelInitData = async <entryPoint extends EntryPoint>({
             enableData,
             initHook && kernelPluginManager.hook
                 ? await kernelPluginManager.hook?.getEnableData()
-                : "0x"
+                : "0x",
+            []
         ]
     })
 }
@@ -185,7 +205,8 @@ const getAccountInitCode = async <entryPoint extends EntryPoint>({
     metaFactoryAddress,
     entryPoint: entryPointAddress,
     kernelPluginManager,
-    initHook
+    initHook,
+    kernelVersion
 }: {
     index: bigint
     factoryAddress: Address
@@ -194,12 +215,14 @@ const getAccountInitCode = async <entryPoint extends EntryPoint>({
     entryPoint: entryPoint
     kernelPluginManager: KernelPluginManager<entryPoint>
     initHook: boolean
+    kernelVersion: GetKernelVersion<entryPoint>
 }): Promise<Hex> => {
     // Build the account initialization data
     const initialisationData = await getKernelInitData<entryPoint>({
         entryPoint: entryPointAddress,
         kernelPluginManager,
-        initHook
+        initHook,
+        kernelVersion
     })
     const entryPointVersion = getEntryPointVersion(entryPointAddress)
 
@@ -368,7 +391,8 @@ export async function createKernelAccount<
             metaFactoryAddress,
             entryPoint: entryPointAddress,
             kernelPluginManager,
-            initHook
+            initHook,
+            kernelVersion
         })
     }
 

package/accounts/kernel/utils/common/accountMetadata.ts

@@ -53,7 +53,7 @@ export const accountMetadata = async <
     } catch (error) {}
     return {
         name: KERNEL_NAME,
-        version: kernelVersion,
+        version: kernelVersion === "0.3.0" ? "0.3.0-beta" : kernelVersion,
         chainId: client.chain
             ? BigInt(client.chain.id)
             : BigInt(await client.extend(publicActions).getChainId())

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

@@ -37,7 +37,7 @@ export const getPluginsEnableTypedData = async <
     return {
         domain: {
             name: "Kernel",
-            version: kernelVersion,
+            version: kernelVersion === "0.3.0" ? "0.3.0-beta" : kernelVersion,
             chainId,
             verifyingContract: accountAddress
         },

package/accounts/kernel/v1/createKernelAccountV1.ts

@@ -100,11 +100,11 @@ export async function createKernelAccountV1<
     client: Client<TTransport, TChain, undefined>,
     {
         signer,
-        entrypoint: entryPointAddress,
+        entryPoint: entryPointAddress,
         index = 0n
     }: {
         signer: SmartAccountSigner<TSource, TAddress>
-        entrypoint: entryPoint
+        entryPoint: entryPoint
         index?: bigint
     }
 ): Promise<KernelSmartAccountV1<entryPoint, TTransport, TChain>> {

package/accounts/utils/toKernelPluginManager.ts

@@ -84,7 +84,8 @@ export async function toKernelPluginManager<
         entryPointVersion === "v0.7" &&
         (action.address.toLowerCase() !== zeroAddress.toLowerCase() ||
             action.selector.toLowerCase() !==
-                getActionSelector(entryPointVersion).toLowerCase())
+                getActionSelector(entryPointVersion).toLowerCase()) &&
+        kernelVersion === "0.3.0"
     ) {
         action.hook = {
             address: action.hook?.address ?? ONLY_ENTRYPOINT_HOOK_ADDRESS
@@ -185,7 +186,7 @@ export async function toKernelPluginManager<
             const typeData = await getPluginsEnableTypedDataV1({
                 accountAddress,
                 chainId,
-                kernelVersion: kernelVersion ?? version,
+                kernelVersion: version ?? kernelVersion,
                 action,
                 validator: regular,
                 validUntil,
@@ -206,6 +207,7 @@ export async function toKernelPluginManager<
             validatorNonce
         })
         ownerSig = await sudo.signTypedData(typedData)
+        pluginEnableSignature = ownerSig
 
         return ownerSig
     }

package/actions/account-client/uninstallPlugin.ts

@@ -0,0 +1,99 @@
+import {
+    type SendTransactionWithPaymasterParameters,
+    sendTransaction
+} from "permissionless/actions/smartAccount"
+import type { EntryPoint, Prettify } from "permissionless/types"
+import {
+    AccountOrClientNotFoundError,
+    parseAccount
+} from "permissionless/utils"
+import type { Chain, Client, Hash, Hex, Transport } from "viem"
+import { concatHex, encodeFunctionData, getAction, pad } from "viem/utils"
+import type { KernelSmartAccount } from "../../accounts/index.js"
+import { KernelV3AccountAbi } from "../../accounts/kernel/abi/kernel_v_3_0_0/KernelAccountAbi.js"
+import { VALIDATOR_TYPE } from "../../constants.js"
+import type {
+    KernelValidator,
+    KernelValidatorHook
+} from "../../types/kernel.js"
+
+export type UninstallPluginParameters<
+    entryPoint extends EntryPoint,
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined,
+    TChainOverride extends Chain | undefined = Chain | undefined
+> = Prettify<
+    SendTransactionWithPaymasterParameters<
+        entryPoint,
+        TChain,
+        TAccount,
+        TChainOverride
+    > & {
+        plugin: KernelValidator<entryPoint, string>
+        hook?: KernelValidatorHook
+    }
+>
+
+export async function uninstallPlugin<
+    entryPoint extends EntryPoint,
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined,
+    TChainOverride extends Chain | undefined = Chain | undefined
+>(
+    client: Client<TTransport, TChain, TAccount>,
+    args: Prettify<
+        UninstallPluginParameters<entryPoint, TChain, TAccount, TChainOverride>
+    >
+): Promise<Hash> {
+    const {
+        account: account_ = client.account,
+        middleware,
+        plugin,
+        hook
+    } = args
+    if (!account_) throw new AccountOrClientNotFoundError()
+
+    const account = parseAccount(account_) as KernelSmartAccount<entryPoint>
+
+    let validatorId: Hex
+    if (
+        [VALIDATOR_TYPE.PERMISSION, VALIDATOR_TYPE.SECONDARY].includes(
+            VALIDATOR_TYPE[plugin.validatorType]
+        )
+    ) {
+        validatorId = concatHex([
+            VALIDATOR_TYPE[plugin.validatorType],
+            pad(plugin.getIdentifier(), {
+                size: 20,
+                dir: "right"
+            })
+        ])
+    } else {
+        throw new Error(`Cannot uninstall ${plugin.validatorType} plugin`)
+    }
+
+    const validatorData = await plugin.getEnableData(account.address)
+
+    const hookData = (await hook?.getEnableData(account.address)) ?? "0x"
+    return await getAction(
+        client,
+        sendTransaction<TChain, TAccount, entryPoint, TChainOverride>,
+        "sendTransaction"
+    )({
+        ...args,
+        to: account.address,
+        data: encodeFunctionData({
+            abi: KernelV3AccountAbi,
+            functionName: "uninstallValidation",
+            args: [validatorId, validatorData, hookData]
+        }),
+        value: 0n,
+        account,
+        middleware
+    })
+}

package/actions/index.ts

@@ -15,6 +15,11 @@ export {
     type GetUserOperationGasPriceReturnType
 } from "./account-client/getUserOperationGasPrice.js"
 
+export {
+    uninstallPlugin,
+    type UninstallPluginParameters
+} from "./account-client/uninstallPlugin.js"
+
 export {
     estimateGasInERC20,
     type EstimateGasInERC20Parameters,

package/clients/decorators/kernel.ts

@@ -1,7 +1,7 @@
 import { type SmartAccountActions, smartAccountActions } from "permissionless"
 import type { Middleware } from "permissionless/actions/smartAccount"
 import type { EntryPoint, Prettify } from "permissionless/types"
-import type { Chain, Client, Transport } from "viem"
+import type { Chain, Client, Hash, Transport } from "viem"
 import type { KernelSmartAccount } from "../../accounts/index.js"
 import {
     type GetUserOperationGasPriceReturnType,
@@ -9,9 +9,10 @@ import {
 } from "../../actions/account-client/getUserOperationGasPrice.js"
 import type {
     SignUserOperationParameters,
-    SignUserOperationReturnType
+    SignUserOperationReturnType,
+    UninstallPluginParameters
 } from "../../actions/index.js"
-import { signUserOperation } from "../../actions/index.js"
+import { signUserOperation, uninstallPlugin } from "../../actions/index.js"
 import {
     type EstimateGasInERC20Parameters,
     type EstimateGasInERC20ReturnType,
@@ -87,6 +88,24 @@ export type KernelAccountClientActions<
     getUserOperationGasPrice: () => Promise<
         Prettify<GetUserOperationGasPriceReturnType>
     >
+    /**
+     * Creates, signs, and sends an uninstall kernel plugin transaction to the network.
+     * This function also allows you to sponsor this transaction if sender is a smartAccount
+     *
+     *
+     * @param args - {@link UninstallPermissionParameters}
+     * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
+     */
+    uninstallPlugin: <
+        TChainOverride extends Chain | undefined = Chain | undefined
+    >(
+        args: UninstallPluginParameters<
+            entryPoint,
+            TChain,
+            TSmartAccount,
+            TChainOverride
+        >
+    ) => Promise<Hash>
 }
 
 export function kernelAccountClientActions<entryPoint extends EntryPoint>({
@@ -110,6 +129,18 @@ export function kernelAccountClientActions<entryPoint extends EntryPoint>({
                     middleware
                 } as SignUserOperationParameters<entryPoint, TSmartAccount>
             ),
-        getUserOperationGasPrice: async () => getUserOperationGasPrice(client)
+        getUserOperationGasPrice: async () => getUserOperationGasPrice(client),
+        uninstallPlugin: async (args) =>
+            uninstallPlugin<entryPoint, TTransport, TChain, TSmartAccount>(
+                client,
+                {
+                    ...args,
+                    middleware
+                } as UninstallPluginParameters<
+                    entryPoint,
+                    TChain,
+                    TSmartAccount
+                >
+            )
     })
 }

package/constants.ts

@@ -1,6 +1,6 @@
-import type { EntryPointVersion } from "permissionless/types/entrypoint"
 import { type Address, type Hex, zeroAddress } from "viem"
 import type {
+    KERNEL_V2_VERSION_TYPE,
     KERNEL_V3_VERSION_TYPE,
     KERNEL_VERSION_TYPE
 } from "./types/kernel.js"
@@ -8,14 +8,14 @@ import type {
 export const DUMMY_ECDSA_SIG =
     "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"
 
-export const KernelImplToVersionMap: { [key: Address]: string } = {
-    "0x8dD4DBB54d8A8Cf0DE6F9CCC4609470A30EfF18C": "0.2.2",
-    "0x0DA6a956B9488eD4dd761E59f52FDc6c8068E6B5": "0.2.2",
-    "0xD3F582F6B4814E989Ee8E96bc3175320B5A540ab": "0.2.3",
-    "0x5FC0236D6c88a65beD32EECDC5D60a5CAb377717": "0.2.3",
-    "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4",
-    "0x94F097E1ebEB4ecA3AAE54cabb08905B239A7D27": "0.3.0-beta"
-}
+// export const KernelImplToVersionMap: { [key: Address]: string } = {
+//     "0x8dD4DBB54d8A8Cf0DE6F9CCC4609470A30EfF18C": "0.2.2",
+//     "0x0DA6a956B9488eD4dd761E59f52FDc6c8068E6B5": "0.2.2",
+//     "0xD3F582F6B4814E989Ee8E96bc3175320B5A540ab": "0.2.3",
+//     "0x5FC0236D6c88a65beD32EECDC5D60a5CAb377717": "0.2.3",
+//     "0xd3082872F8B06073A021b4602e022d5A070d7cfC": "0.2.4",
+//     "0x94F097E1ebEB4ecA3AAE54cabb08905B239A7D27": "0.3.0"
+// }
 
 export const FACTORY_ADDRESS_V0_6 = "0x5de4839a76cf55d0c90e2061ef4386d962E15ae3"
 export const FACTORY_ADDRESS_V0_6_INIT_CODE_HASH =
@@ -53,7 +53,7 @@ export const KernelVersionToAddressesMap: {
         factoryAddress: FACTORY_ADDRESS_V0_6,
         initCodeHash: FACTORY_ADDRESS_V0_6_INIT_CODE_HASH
     },
-    "0.3.0-beta": {
+    "0.3.0": {
         accountImplementationAddress:
             "0x94F097E1ebEB4ecA3AAE54cabb08905B239A7D27",
         factoryAddress: "0x6723b44Abeec4E71eBE3232BD5B455805baDD22f",
@@ -63,21 +63,26 @@ export const KernelVersionToAddressesMap: {
     },
     "0.3.1": {
         accountImplementationAddress:
-            "0x8549e78dF3C7850A7735f04ADbDC8A2962Db1EB8",
-        factoryAddress: "0x8ba061431fBAF2A766a773A9C044C92d13A07D7e",
+            "0xBAC849bB641841b44E965fB01A4Bf5F074f84b4D",
+        factoryAddress: "0xaac5D4240AF87249B3f71BC8E4A2cae074A3E419",
         metaFactoryAddress: "0xd703aaE79538628d27099B8c4f621bE4CCd142d5",
         initCodeHash:
-            "0xc5a51f3c59926dfa1c80e5918d287a4d56df9c48ec0e4c5be1a6ca2f6894a58c"
+            "0x85d96aa1c9a65886d094915d76ccae85f14027a02c1647dde659f869460f03e6"
     }
 }
+
+export const KERNEL_V0_2: KERNEL_V2_VERSION_TYPE = "0.0.2"
+export const KERNEL_V2_2: KERNEL_V2_VERSION_TYPE = "0.2.2"
+export const KERNEL_V2_3: KERNEL_V2_VERSION_TYPE = "0.2.3"
+export const KERNEL_V2_4: KERNEL_V2_VERSION_TYPE = "0.2.4"
+export const KERNEL_V3_0: KERNEL_V3_VERSION_TYPE = "0.3.0"
+export const KERNEL_V3_1: KERNEL_V3_VERSION_TYPE = "0.3.1"
+
 export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
 export const ONLY_ENTRYPOINT_HOOK_ADDRESS =
     "0xb230f0A1C7C95fa11001647383c8C7a8F316b900"
 export const KERNEL_NAME = "Kernel"
-export const LATEST_KERNEL_VERSION: { [key in EntryPointVersion]: string } = {
-    "v0.6": "0.2.4",
-    "v0.7": "0.3.0-beta"
-}
+
 export const VALIDATOR_TYPE = {
     SUDO: "0x00",
     SECONDARY: "0x01",

package/index.ts

@@ -43,6 +43,7 @@ export {
     KernelV3ExecuteAbi,
     KernelV3InitAbi
 } from "./accounts/kernel/abi/kernel_v_3_0_0/KernelAccountAbi.js"
+export { KernelV3_1AccountAbi } from "./accounts/kernel/abi/kernel_v_3_1/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"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/sdk",
-    "version": "5.3.0-alpha-0",
+    "version": "5.3.1",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",
@@ -9,13 +9,7 @@
     "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",
@@ -87,38 +81,27 @@
             "types": "./_types/providers/index.d.ts",
             "import": "./_esm/providers/index.js",
             "default": "./_cjs/providers/index.js"
+        },
+        "./constants": {
+            "types": "./_types/constants.d.ts",
+            "import": "./_esm/constants.js",
+            "default": "./_cjs/constants.js"
         }
     },
     "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": {
-        "viem": "^2.9.17",
+        "viem": "^2.15.1",
         "permissionless": "^0.1.18"
     },
     "dependencies": {

package/types/kernel.ts

@@ -242,7 +242,7 @@ export type Execution = {
 
 export type KERNEL_V2_VERSION_TYPE = "0.0.2" | "0.2.2" | "0.2.3" | "0.2.4"
 
-export type KERNEL_V3_VERSION_TYPE = "0.3.0-beta" | "0.3.1"
+export type KERNEL_V3_VERSION_TYPE = "0.3.0" | "0.3.1"
 
 export type KERNEL_VERSION_TYPE =
     | KERNEL_V2_VERSION_TYPE

package/utils.ts

@@ -1,8 +1,4 @@
-import {
-    ENTRYPOINT_ADDRESS_V06,
-    ENTRYPOINT_ADDRESS_V07,
-    getEntryPointVersion
-} from "permissionless"
+import { ENTRYPOINT_ADDRESS_V06, ENTRYPOINT_ADDRESS_V07 } from "permissionless"
 import type { EntryPoint } from "permissionless/types/entrypoint"
 import { satisfies } from "semver"
 import {
@@ -14,31 +10,12 @@ import {
     hexToSignature,
     isHex,
     pad,
-    signatureToHex,
-    zeroAddress
+    signatureToHex
 } from "viem"
 import type { ZeroDevPaymasterClient } from "./clients/paymasterClient.js"
-import {
-    type CALL_TYPE,
-    type EXEC_TYPE,
-    KernelImplToVersionMap,
-    LATEST_KERNEL_VERSION
-} from "./constants.js"
+import type { CALL_TYPE, EXEC_TYPE } from "./constants.js"
 import type { GetKernelVersion } from "./types/kernel.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",
@@ -136,10 +113,10 @@ export const validateKernelVersionWithEntryPoint = <
         (entryPointAddress === ENTRYPOINT_ADDRESS_V06 &&
             !satisfies(kernelVersion, ">=0.2.2 || <=0.2.4")) ||
         (entryPointAddress === ENTRYPOINT_ADDRESS_V07 &&
-            !satisfies(kernelVersion, ">=0.3.0-beta"))
+            !satisfies(kernelVersion, ">=0.3.0"))
     ) {
         throw new Error(
-            "KernelVersion should be >= 0.2.2 and <= 0.2.4 for EntryPointV0.6 and >= 0.3.0-beta for EntryPointV0.7"
+            "KernelVersion should be >= 0.2.2 and <= 0.2.4 for EntryPointV0.6 and >= 0.3.0 for EntryPointV0.7"
         )
     }
 }