@zerodev/sdk 5.4.5 → 5.4.7

package/actions/account-client/upgradeKernel.ts

@@ -0,0 +1,65 @@
+import type { Chain, Client, Hash, Prettify, Transport } from "viem"
+import {
+    type SendUserOperationParameters,
+    type SmartAccount,
+    sendUserOperation
+} from "viem/account-abstraction"
+import { encodeFunctionData, getAction, parseAccount } from "viem/utils"
+import { KernelV3AccountAbi } from "../../accounts/kernel/abi/kernel_v_3_0_0/KernelAccountAbi.js"
+import { AccountNotFoundError } from "../../errors/index.js"
+import type { KERNEL_VERSION_TYPE } from "../../types/kernel.js"
+import { validateKernelVersionWithEntryPoint } from "../../utils.js"
+import { KernelVersionToAddressesMap } from "../../constants.js";
+
+export type UpgradeKernelParameters<
+    account extends SmartAccount | undefined,
+    accountOverride extends SmartAccount | undefined = undefined,
+    calls extends readonly unknown[] = readonly unknown[]
+> = Prettify<
+    Partial<SendUserOperationParameters<account, accountOverride, calls>> & {
+        kernelVersion: KERNEL_VERSION_TYPE
+    }
+>
+
+export async function upgradeKernel<
+    account extends SmartAccount | undefined,
+    chain extends Chain | undefined,
+    accountOverride extends SmartAccount | undefined = undefined,
+    calls extends readonly unknown[] = readonly unknown[]
+>(
+    client: Client<Transport, chain, account>,
+    args: Prettify<UpgradeKernelParameters<account, accountOverride, calls>>
+): Promise<Hash> {
+    const { account: account_ = client.account, kernelVersion } = args
+    if (!account_)
+        throw new AccountNotFoundError({
+            docsPath: "/docs/actions/wallet/sendTransaction"
+        })
+
+    const account = parseAccount(account_) as SmartAccount
+    validateKernelVersionWithEntryPoint(
+        account.entryPoint.version,
+        kernelVersion
+    )
+    const implementation = KernelVersionToAddressesMap[kernelVersion].accountImplementationAddress
+
+    return await getAction(
+        client,
+        sendUserOperation,
+        "sendUserOperation"
+    )({
+        ...args,
+        calls: [
+            {
+                to: account.address,
+                data: encodeFunctionData({
+                    abi: KernelV3AccountAbi,
+                    functionName: "upgradeTo",
+                    args: [implementation]
+                }),
+                value: 0n
+            }
+        ],
+        account
+    } as SendUserOperationParameters)
+}

package/actions/public/getKernelImplementationAddress.ts

@@ -0,0 +1,52 @@
+import type { Address, Client } from "viem"
+import { getStorageAt } from "viem/actions"
+import { getAction, getAddress, isHex, slice, toHex } from "viem/utils"
+import { KERNEL_IMPLEMENTATION_SLOT } from "../../constants"
+
+export type GetKernelImplementationAddressParams = {
+    address: Address
+}
+
+/**
+ * Returns the address of the kernel implementation.
+ *
+ * @param client {@link client} that you created using viem's createPublicClient.
+ * @param args {@link GetKernelImplementationAddressParams} address
+ * @returns Address
+ *
+ * @example
+ * import { createPublicClient } from "viem"
+ * import { getKernelImplementationAddress } from "@zerodev/sdk/actions"
+ *
+ * const client = createPublicClient({
+ *      chain: goerli,
+ *      transport: http("https://goerli.infura.io/v3/your-infura-key")
+ * })
+ *
+ * const kernelImplementationAddress = await getKernelImplementationAddress(client, {
+ *      address,
+ * })
+ *
+ * // Return 0x0000000000000000000000000000000000000000
+ */
+export const getKernelImplementationAddress = async (
+    client: Client,
+    args: GetKernelImplementationAddressParams
+): Promise<Address> => {
+    const { address } = args
+
+    const storageValue = await getAction(
+        client,
+        getStorageAt,
+        "getStorageAt"
+    )({
+        address,
+        slot: KERNEL_IMPLEMENTATION_SLOT
+    })
+    if (!storageValue) {
+        throw new Error("Kernel implementation address not found")
+    }
+    const addressSlice = slice(storageValue, 12)
+    const addressHex = isHex(addressSlice) ? addressSlice : toHex(addressSlice)
+    return getAddress(addressHex)
+}

package/actions/public/index.ts

@@ -8,3 +8,4 @@ export {
     getSenderAddress
 } from "./getSenderAddress.js"
 export { isSmartAccountDeployed } from "./isSmartAccountDeployed.js"
+export { getKernelImplementationAddress } from "./getKernelImplementationAddress.js"

package/clients/decorators/kernel.ts

@@ -45,6 +45,10 @@ import {
     sponsorUserOperation
 } from "../../actions/paymaster/sponsorUserOperation.js"
 import type { ZeroDevPaymasterClient } from "../paymasterClient.js"
+import {
+    upgradeKernel,
+    type UpgradeKernelParameters
+} from "../../actions/account-client/upgradeKernel.js"
 
 export type ZeroDevPaymasterClientActions = {
     /**
@@ -157,6 +161,20 @@ export type KernelAccountClientActions<
      * @returns nonce
      */
     getKernelV3ModuleCurrentNonce: () => Promise<number>
+    /**
+     * Creates, signs, and sends a transaction to upgrade the kernel to the network.
+     * This function also allows you to sponsor this transaction if sender is a smartAccount
+     *
+     * @param args - {@link UpgradeKernelParameters}
+     * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
+     */
+    upgradeKernel: <
+        accountOverride extends SmartAccount | undefined = undefined,
+        calls extends readonly unknown[] = readonly unknown[]
+    >(
+        args: UpgradeKernelParameters<TSmartAccount, accountOverride, calls>
+    ) => Promise<Hash>
+
     /**
      * Creates, signs, and sends a new transaction to the network.
      * This function also allows you to sponsor this transaction if sender is a smartAccount
@@ -464,6 +482,7 @@ export function kernelAccountClientActions() {
         invalidateNonce: async (args) => invalidateNonce(client, args),
         getKernelV3ModuleCurrentNonce: async () =>
             getKernelV3ModuleCurrentNonce(client),
+        upgradeKernel: async (args) => upgradeKernel(client, args),
         // biome-ignore lint/suspicious/noExplicitAny: <explanation>
         sendTransaction: (args) => sendTransaction(client, args as any),
         signMessage: (args) => signMessage(client, args),

package/constants.ts

@@ -14,6 +14,9 @@ import type {
 export const DUMMY_ECDSA_SIG =
     "0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c"
 
+export const MAGIC_VALUE_SIG_REPLAYABLE =
+    "0x0555ad2729e8da1777a4e5020806f8bf7601c3db6bfe402f410a34958363a95a"
+
 // export const KernelImplToVersionMap: { [key: Address]: string } = {
 //     "0x8dD4DBB54d8A8Cf0DE6F9CCC4609470A30EfF18C": "0.2.2",
 //     "0x0DA6a956B9488eD4dd761E59f52FDc6c8068E6B5": "0.2.2",
@@ -74,6 +77,14 @@ export const KernelVersionToAddressesMap: {
         metaFactoryAddress: "0xd703aaE79538628d27099B8c4f621bE4CCd142d5",
         initCodeHash:
             "0x85d96aa1c9a65886d094915d76ccae85f14027a02c1647dde659f869460f03e6"
+    },
+    "0.3.2": {
+        accountImplementationAddress:
+            "0xD830D15D3dc0C269F3dBAa0F3e8626d33CFdaBe1",
+        factoryAddress: "0x7a1dBAB750f12a90EB1B60D2Ae3aD17D4D81EfFe",
+        metaFactoryAddress: "0xd703aaE79538628d27099B8c4f621bE4CCd142d5",
+        initCodeHash:
+            "0xc7c48c9dd12de68b8a4689b6f8c8c07b61d4d6fa4ddecdd86a6980d045fa67eb"
     }
 }
 
@@ -83,6 +94,7 @@ 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 KERNEL_V3_2: KERNEL_V3_VERSION_TYPE = "0.3.2"
 
 export const TOKEN_ACTION = "0x2087C7FfD0d0DAE80a00EE74325aBF3449e0eaf1"
 export const ONLY_ENTRYPOINT_HOOK_ADDRESS =
@@ -119,6 +131,9 @@ export const KernelFactoryToInitCodeHashMap: { [key: Address]: Hex } = {
         "0x6fe6e6ea30eddce942b9618033ab8429f9ddac594053bec8a6744fffc71976e2"
 }
 
+export const KERNEL_IMPLEMENTATION_SLOT =
+    "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc"
+
 export const getEntryPoint = <TEntryPointVersion extends EntryPointVersion>(
     entryPointVersion: TEntryPointVersion
 ): EntryPointType<TEntryPointVersion> => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zerodev/sdk",
-    "version": "5.4.5",
+    "version": "5.4.7",
     "author": "ZeroDev",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",

package/types/kernel.ts

@@ -243,7 +243,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" | "0.3.1"
+export type KERNEL_V3_VERSION_TYPE = "0.3.0" | "0.3.1" | "0.3.2"
 
 export type KERNEL_VERSION_TYPE =
     | KERNEL_V2_VERSION_TYPE

package/utils.ts

@@ -19,13 +19,15 @@ import type { EntryPointType, GetKernelVersion } from "./types/kernel.js"
 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"
+    ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH = "ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH",
+    ERC1271_REPLAYABLE = "ERC1271_REPLAYABLE"
 }
 
 export 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"
+    [KERNEL_FEATURES.ERC1271_SIG_WRAPPER_WITH_WRAPPED_HASH]: ">=0.3.0-beta",
+    [KERNEL_FEATURES.ERC1271_REPLAYABLE]: ">=0.3.2"
 }
 
 export const hasKernelFeature = (