@zerodev/sdk 5.2.0-alpha-1 → 5.2.0-alpha-3

package/accounts/kernel/v2/createKernelV2Account.ts

@@ -0,0 +1,409 @@
+import {
+    ENTRYPOINT_ADDRESS_V06,
+    getAccountNonce,
+    getSenderAddress,
+    isSmartAccountDeployed
+} from "permissionless"
+import {
+    SignTransactionNotSupportedBySmartAccount,
+    type SmartAccount
+} from "permissionless/accounts"
+import type {
+    ENTRYPOINT_ADDRESS_V06_TYPE,
+    EntryPoint
+} from "permissionless/types/entrypoint.js"
+import {
+    type Address,
+    type Chain,
+    type Client,
+    type EncodeDeployDataParameters,
+    type Hash,
+    type Hex,
+    type Transport,
+    type TypedDataDefinition,
+    concatHex,
+    encodeDeployData,
+    encodeFunctionData,
+    getTypesForEIP712Domain,
+    hashMessage,
+    hashTypedData,
+    parseAbi,
+    validateTypedData
+} from "viem"
+import { toAccount } from "viem/accounts"
+import type {
+    KernelEncodeCallDataArgs,
+    KernelPluginManager,
+    KernelPluginManagerParams
+} from "../../../types/kernel.js"
+import { wrapSignatureWith6492 } from "../../utils/6492.js"
+import { parseFactoryAddressAndCallDataFromAccountInitCode } from "../../utils/index.js"
+import {
+    MULTISEND_ADDRESS,
+    encodeMultiSend,
+    multiSendAbi
+} from "../../utils/multisend.js"
+import {
+    isKernelPluginManager,
+    toKernelPluginManager
+} from "../../utils/toKernelPluginManager.js"
+import { KernelAccountV2Abi } from "./abi/KernelAccountV2Abi.js"
+import { KernelFactoryV2Abi } from "./abi/KernelFactoryV2Abi.js"
+
+export type KernelSmartAccount<
+    entryPoint extends EntryPoint,
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined
+> = SmartAccount<entryPoint, "kernelSmartAccount", transport, chain> & {
+    kernelPluginManager: KernelPluginManager<entryPoint>
+    encodeCallData: (args: KernelEncodeCallDataArgs) => Promise<Hex>
+}
+
+// Safe's library for create and create2: https://github.com/safe-global/safe-contracts/blob/0acdd35a203299585438f53885df630f9d486a86/contracts/libraries/CreateCall.sol
+// Address was found here: https://github.com/safe-global/safe-deployments/blob/926ec6bbe2ebcac3aa2c2c6c0aff74aa590cbc6a/src/assets/v1.4.1/create_call.json
+const createCallAddress = "0x9b35Af71d77eaf8d7e40252370304687390A1A52"
+
+const createCallAbi = parseAbi([
+    "function performCreate(uint256 value, bytes memory deploymentData) public returns (address newContract)",
+    "function performCreate2(uint256 value, bytes memory deploymentData, bytes32 salt) public returns (address newContract)"
+])
+
+/**
+ * Default addresses for kernel smart account
+ */
+export const KERNEL_ADDRESSES: {
+    FACTORY_ADDRESS: Address
+    ENTRYPOINT_V0_6: Address
+} = {
+    FACTORY_ADDRESS: "0xaee9762ce625e0a8f7b184670fb57c37bfe1d0f1",
+    ENTRYPOINT_V0_6: "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789"
+}
+
+/**
+ * Get the account initialization code for a kernel smart account
+ * @param index
+ * @param factoryAddress
+ * @param ecdsaValidatorAddress
+ */
+const getAccountInitCode = async ({
+    index,
+    factoryAddress,
+    validatorAddress,
+    enableData
+}: {
+    index: bigint
+    factoryAddress: Address
+    validatorAddress: Address
+    enableData: Hex
+}): Promise<Hex> => {
+    // Build the account init code
+    return concatHex([
+        factoryAddress,
+        encodeFunctionData({
+            abi: KernelFactoryV2Abi,
+            functionName: "createAccount",
+            args: [validatorAddress, enableData, index]
+        }) as Hex
+    ])
+}
+
+/**
+ * Check the validity of an existing account address, or fetch the pre-deterministic account address for a kernel smart wallet
+ * @param client
+ * @param entryPoint
+ * @param initCodeProvider
+ */
+const getAccountAddress = async <
+    entryPoint extends EntryPoint,
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined
+>({
+    client,
+    entryPoint: entryPointAddress,
+    initCodeProvider
+}: {
+    client: Client<TTransport, TChain, undefined>
+    initCodeProvider: () => Promise<Hex>
+    entryPoint: entryPoint
+}): Promise<Address> => {
+    // Find the init code for this account
+    const initCode = await initCodeProvider()
+
+    // Get the sender address based on the init code
+    return getSenderAddress(client, {
+        initCode,
+        entryPoint: entryPointAddress as ENTRYPOINT_ADDRESS_V06_TYPE
+    })
+}
+
+/**
+ * Build a kernel smart account from a private key, that use the ECDSA signer behind the scene
+ * @param client
+ * @param privateKey
+ * @param entryPoint
+ * @param index
+ * @param factoryAddress
+ * @param ecdsaValidatorAddress
+ * @param deployedAccountAddress
+ */
+export async function createKernelV2Account<
+    entryPoint extends EntryPoint,
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined
+>(
+    client: Client<TTransport, TChain, undefined>,
+    {
+        plugins,
+        entryPoint: entryPointAddress = ENTRYPOINT_ADDRESS_V06 as entryPoint,
+        index = 0n,
+        factoryAddress = KERNEL_ADDRESSES.FACTORY_ADDRESS,
+        deployedAccountAddress
+    }: {
+        plugins:
+            | KernelPluginManagerParams<entryPoint>
+            | KernelPluginManager<entryPoint>
+        entryPoint?: entryPoint
+        index?: bigint
+        factoryAddress?: Address
+        deployedAccountAddress?: Address
+    }
+): Promise<KernelSmartAccount<entryPoint, TTransport, TChain>> {
+    const kernelPluginManager = isKernelPluginManager<entryPoint>(plugins)
+        ? plugins
+        : await toKernelPluginManager(client, {
+              sudo: plugins.sudo,
+              regular: plugins.regular,
+              executorData: plugins.executorData,
+              pluginEnableSignature: plugins.pluginEnableSignature,
+              kernelVersion: "0.0.2" ?? plugins.kernelVersion,
+              entryPoint: entryPointAddress
+          })
+    // Helper to generate the init code for the smart account
+    const generateInitCode = async () => {
+        const validatorInitData =
+            await kernelPluginManager.getValidatorInitData()
+        return getAccountInitCode({
+            index,
+            factoryAddress,
+            validatorAddress: validatorInitData.validatorAddress,
+            enableData: validatorInitData.enableData
+        })
+    }
+
+    // Fetch account address and chain id
+    const accountAddress =
+        deployedAccountAddress ??
+        (await getAccountAddress<entryPoint, TTransport, TChain>({
+            client,
+            entryPoint: entryPointAddress,
+            initCodeProvider: generateInitCode
+        }))
+
+    if (!accountAddress) throw new Error("Account address not found")
+
+    // Build the EOA Signer
+    const account = toAccount({
+        address: accountAddress,
+        async signMessage({ message }) {
+            const messageHash = hashMessage(message)
+            const [isDeployed, signature] = await Promise.all([
+                isSmartAccountDeployed(client, accountAddress),
+                kernelPluginManager.signMessage({
+                    message: {
+                        raw: messageHash
+                    }
+                })
+            ])
+            return create6492Signature(isDeployed, signature)
+        },
+        async signTransaction(_, __) {
+            throw new SignTransactionNotSupportedBySmartAccount()
+        },
+        async signTypedData(typedData) {
+            const types = {
+                EIP712Domain: getTypesForEIP712Domain({
+                    domain: typedData.domain
+                }),
+                ...typedData.types
+            }
+
+            // Need to do a runtime validation check on addresses, byte ranges, integer ranges, etc
+            // as we can't statically check this with TypeScript.
+            validateTypedData({
+                domain: typedData.domain,
+                message: typedData.message,
+                primaryType: typedData.primaryType,
+                types: types
+            } as TypedDataDefinition)
+
+            const typedHash = hashTypedData(typedData)
+            const [isDeployed, signature] = await Promise.all([
+                isSmartAccountDeployed(client, accountAddress),
+                kernelPluginManager.signMessage({
+                    message: {
+                        raw: typedHash
+                    }
+                })
+            ])
+            return create6492Signature(isDeployed, signature)
+        }
+    })
+
+    let smartAccountDeployed = await isSmartAccountDeployed(
+        client,
+        accountAddress
+    )
+
+    const create6492Signature = async (
+        isDeployed: boolean,
+        signature: Hash
+    ): Promise<Hash> => {
+        if (isDeployed) {
+            return signature
+        }
+
+        const [factoryAddress, factoryCalldata] =
+            parseFactoryAddressAndCallDataFromAccountInitCode(
+                await generateInitCode()
+            )
+
+        return wrapSignatureWith6492({
+            factoryAddress,
+            factoryCalldata,
+            signature
+        })
+    }
+
+    return {
+        ...account,
+        client: client,
+        publicKey: accountAddress,
+        entryPoint: entryPointAddress,
+        source: "kernelSmartAccount",
+        kernelPluginManager,
+        async getFactory() {
+            if (smartAccountDeployed) return undefined
+
+            smartAccountDeployed = await isSmartAccountDeployed(
+                client,
+                accountAddress
+            )
+
+            if (smartAccountDeployed) return undefined
+
+            return factoryAddress
+        },
+
+        async getFactoryData() {
+            if (smartAccountDeployed) return undefined
+
+            smartAccountDeployed = await isSmartAccountDeployed(
+                client,
+                accountAddress
+            )
+
+            if (smartAccountDeployed) return undefined
+
+            return parseFactoryAddressAndCallDataFromAccountInitCode(
+                await generateInitCode()
+            )[1]
+        },
+
+        // Get the nonce of the smart account
+        async getNonce() {
+            const key = await kernelPluginManager.getNonceKey()
+            return getAccountNonce(client, {
+                sender: accountAddress,
+                entryPoint: entryPointAddress,
+                key
+            })
+        },
+
+        // Sign a user operation
+        async signUserOperation(userOperation) {
+            return kernelPluginManager.signUserOperation(userOperation)
+        },
+
+        // Encode the init code
+        async getInitCode() {
+            if (smartAccountDeployed) return "0x"
+
+            smartAccountDeployed = await isSmartAccountDeployed(
+                client,
+                accountAddress
+            )
+
+            if (smartAccountDeployed) return "0x"
+            return generateInitCode()
+        },
+
+        // Encode the deploy call data
+        async encodeDeployCallData(_tx) {
+            return encodeFunctionData({
+                abi: KernelAccountV2Abi,
+                functionName: "execute",
+                args: [
+                    createCallAddress,
+                    0n,
+                    encodeFunctionData({
+                        abi: createCallAbi,
+                        functionName: "performCreate",
+                        args: [
+                            0n,
+                            encodeDeployData({
+                                abi: _tx.abi,
+                                bytecode: _tx.bytecode,
+                                args: _tx.args
+                            } as EncodeDeployDataParameters)
+                        ]
+                    }),
+                    1 // Delegate call
+                ]
+            })
+        },
+
+        // Encode a call
+        async encodeCallData(_tx) {
+            const tx = _tx as KernelEncodeCallDataArgs
+            if (Array.isArray(tx)) {
+                const multiSendCallData = encodeFunctionData({
+                    abi: multiSendAbi,
+                    functionName: "multiSend",
+                    args: [encodeMultiSend(tx)]
+                })
+                return encodeFunctionData({
+                    abi: KernelAccountV2Abi,
+                    functionName: "execute",
+                    args: [MULTISEND_ADDRESS, 0n, multiSendCallData, 1]
+                })
+            }
+
+            // Default to `call`
+            if (!tx.callType || tx.callType === "call") {
+                if (tx.to.toLowerCase() === accountAddress.toLowerCase()) {
+                    return tx.data
+                }
+                return encodeFunctionData({
+                    abi: KernelAccountV2Abi,
+                    functionName: "execute",
+                    args: [tx.to, tx.value, tx.data, 0]
+                })
+            }
+
+            if (tx.callType === "delegatecall") {
+                return encodeFunctionData({
+                    abi: KernelAccountV2Abi,
+                    functionName: "execute",
+                    args: [tx.to, 0n, tx.data, 1]
+                })
+            }
+
+            throw new Error("Invalid call type")
+        },
+
+        // Get simple dummy signature
+        async getDummySignature(userOperation) {
+            return kernelPluginManager.getDummySignature(userOperation)
+        }
+    }
+}

package/accounts/{kernel/v1 → utils}/multisend.ts

@@ -2,7 +2,7 @@ import { type Address, type Hex, encodePacked, toBytes } from "viem"
 import {
     type CallType,
     type KernelEncodeCallDataArgs
-} from "../../../types/index.js"
+} from "../../types/index.js"
 
 export const MULTISEND_ADDRESS = "0x8ae01fcf7c655655ff2c6ef907b8b4718ab4e17c"
 

package/accounts/utils/toKernelPluginManager.ts

@@ -54,7 +54,8 @@ export async function toKernelPluginManager<
         },
         validAfter = 0,
         validUntil = 0,
-        entryPoint: entryPointAddress
+        entryPoint: entryPointAddress,
+        kernelVersion
     }: KernelPluginManagerParams<entryPoint>
 ): Promise<KernelPluginManager<entryPoint>> {
     const entryPointVersion = getEntryPointVersion(entryPointAddress)
@@ -167,16 +168,14 @@ export async function toKernelPluginManager<
             client,
             accountAddress
         )
-        const kernelVersion = getKernelVersion(
-            entryPointAddress,
-            kernelImplAddr
-        )
+        const _kernelVersion =
+            kernelVersion ?? getKernelVersion(entryPointAddress, kernelImplAddr)
         let ownerSig: Hex
         if (entryPointVersion === "v0.6") {
             ownerSig = await sudo.signTypedData({
                 domain: {
                     name: "Kernel",
-                    version: kernelVersion,
+                    version: _kernelVersion,
                     chainId,
                     verifyingContract: accountAddress
                 },
@@ -213,7 +212,7 @@ export async function toKernelPluginManager<
         ownerSig = await sudo.signTypedData({
             domain: {
                 name: "Kernel",
-                version: kernelVersion,
+                version: _kernelVersion,
                 chainId,
                 verifyingContract: accountAddress
             },
@@ -278,6 +277,21 @@ export async function toKernelPluginManager<
 
     return {
         ...activeValidator,
+        getValidationId: (isSudo = false) => {
+            const validator = (isSudo ? sudo : regular) ?? activeValidator
+            return concat([
+                validator.isPermissionValidator
+                    ? VALIDATOR_TYPE.PERMISSION
+                    : VALIDATOR_TYPE.SECONDARY,
+                validator?.isPermissionValidator
+                    ? // @ts-ignore
+                      pad(validator.getPermissionId() as Hex, {
+                          size: 20,
+                          dir: "right"
+                      })
+                    : validator.address
+            ])
+        },
         signUserOperation: async (userOperation) => {
             const userOpSig =
                 await activeValidator.signUserOperation(userOperation)

package/constants.ts

@@ -36,3 +36,8 @@ export enum EXEC_TYPE {
     DEFAULT = "0x00",
     TRY_EXEC = "0x01"
 }
+
+// Safe's library for create and create2: https://github.com/safe-global/safe-contracts/blob/0acdd35a203299585438f53885df630f9d486a86/contracts/libraries/CreateCall.sol
+// 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"

package/index.ts

@@ -1,10 +1,11 @@
 export {
     createKernelAccount,
     createKernelV1Account,
+    createKernelV2Account,
     type KernelSmartAccount,
     KERNEL_ADDRESSES,
     addressToEmptyAccount,
-    EIP1271ABI
+    EIP1271Abi
 } from "./accounts/index.js"
 export {
     sponsorUserOperation,

package/package.json

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

package/types/index.ts

@@ -10,3 +10,5 @@ export type {
 } from "./kernel.js"
 
 export { ValidatorMode } from "./kernel.js"
+
+export type WithRequired<T, K extends keyof T> = Required<Pick<T, K>>

package/types/kernel.ts

@@ -136,6 +136,7 @@ export type KernelPluginManager<entryPoint extends EntryPoint> =
         getValidatorInitData(): Promise<ValidatorInitData>
         getExecutorData(): ExecutorData
         getValidityData(): PluginValidityData
+        getValidationId(isSudo?: boolean): Hex
     }
 
 export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
@@ -145,6 +146,7 @@ export type KernelPluginManagerParams<entryPoint extends EntryPoint> = {
     validatorInitData?: ValidatorInitData
     executorData?: ExecutorData
     entryPoint: entryPoint
+    kernelVersion?: string
 } & Partial<PluginValidityData>
 
 export type ExecutorData = {

package/utils.ts

@@ -103,7 +103,13 @@ export const fixSignedData = (sig: Hex): Hex => {
     return joined
 }
 
-export const getExecMode = (callType: CALL_TYPE, execType: EXEC_TYPE): Hex => {
+export const getExecMode = ({
+    callType,
+    execType
+}: {
+    callType: CALL_TYPE
+    execType: EXEC_TYPE
+}): Hex => {
     return concatHex([
         callType, // 1 byte
         execType, // 1 byte

package/_cjs/accounts/kernel/v1/multisend.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"multisend.js","sourceRoot":"","sources":["../../../../accounts/kernel/v1/multisend.ts"],"names":[],"mappings":";;;AAAA,+BAAoE;AAMvD,QAAA,iBAAiB,GAAG,4CAA4C,CAAA;AAEhE,QAAA,YAAY,GAAG;IACxB;QACI,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;KACpD;CACJ,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,IAKnB,EAAU,EAAE;IACT,MAAM,IAAI,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC/B,MAAM,OAAO,GAAG,IAAA,mBAAY,EACxB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACnD;QACI,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,CAAC,EAAE;QACP,IAAI,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACnB,IAAI,CAAC,IAAI;KACZ,CACJ,CAAA;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAC3B,CAAC,CAAA;AAEM,MAAM,eAAe,GAAG,CAAC,KAA+B,EAAO,EAAE;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;IAC5E,CAAC;IAED,OAAO,KAAK,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;AAChE,CAAC,CAAA;AANY,QAAA,eAAe,mBAM3B"}

package/_esm/accounts/kernel/v1/multisend.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"multisend.js","sourceRoot":"","sources":["../../../../accounts/kernel/v1/multisend.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,YAAY,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACpE,OAAO,EAGN,MAAM,yBAAyB,CAAA;AAEhC,MAAM,CAAC,MAAM,iBAAiB,GAAG,4CAA4C,CAAA;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB;QACI,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;KACpD;CACJ,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,IAKnB,EAAU,EAAE;IACT,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC/B,MAAM,OAAO,GAAG,YAAY,CACxB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACnD;QACI,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,CAAC,EAAE;QACP,IAAI,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACnB,IAAI,CAAC,IAAI;KACZ,CACJ,CAAA;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAA+B,EAAO,EAAE;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;IAC5E,CAAC;IAED,OAAO,KAAK,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAA;AAChE,CAAC,CAAA"}

package/_types/accounts/kernel/v1/multisend.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multisend.d.ts","sourceRoot":"","sources":["../../../../accounts/kernel/v1/multisend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,GAAG,EAAyB,MAAM,MAAM,CAAA;AACpE,OAAO,EAEH,KAAK,wBAAwB,EAChC,MAAM,yBAAyB,CAAA;AAEhC,eAAO,MAAM,iBAAiB,+CAA+C,CAAA;AAE7E,eAAO,MAAM,YAAY;;;;;;;GAMxB,CAAA;AAsBD,eAAO,MAAM,eAAe,UAAW,wBAAwB,KAAG,GAMjE,CAAA"}