@zerodev/sdk 5.2.11 → 5.2.12-alpha-1

package/actions/account-client/prepareMultiUserOpRequest.ts

@@ -0,0 +1,238 @@
+import {
+    AccountOrClientNotFoundError,
+    type UserOperation,
+    estimateUserOperationGas,
+    parseAccount
+} from "permissionless"
+import type {
+    PrepareUserOperationRequestParameters,
+    PrepareUserOperationRequestReturnType,
+    SponsorUserOperationReturnType
+} from "permissionless/actions/smartAccount"
+import type { StateOverrides } from "permissionless/types/bundler"
+import type {
+    ENTRYPOINT_ADDRESS_V07_TYPE,
+    EntryPoint,
+    GetEntryPointVersion
+} from "permissionless/types/entrypoint"
+import type {
+    Abi,
+    Address,
+    Chain,
+    Client,
+    Hex,
+    LocalAccount,
+    Transport
+} from "viem"
+import { estimateFeesPerGas } from "viem/actions"
+import type { Prettify } from "viem/chains"
+import { type EncodeDeployDataParameters, getAction } from "viem/utils"
+import type { KernelSmartAccount } from "../../accounts"
+
+export type SmartAccount<
+    entryPoint extends EntryPoint,
+    TSource extends string = string,
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    TAbi extends Abi | readonly unknown[] = Abi
+> = LocalAccount<TSource> & {
+    client: Client<transport, chain>
+    entryPoint: entryPoint
+    getNonce: () => Promise<bigint>
+    getInitCode: () => Promise<Hex>
+    getFactory: () => Promise<Address | undefined>
+    getFactoryData: () => Promise<Hex | undefined>
+    encodeCallData: (
+        args:
+            | {
+                  to: Address
+                  value: bigint
+                  data: Hex
+              }
+            | {
+                  to: Address
+                  value: bigint
+                  data: Hex
+              }[]
+    ) => Promise<Hex>
+    getDummySignature(
+        userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+    ): Promise<Hex>
+    getMultiUserOpDummySignature(
+        userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+        numOfUserOps: number
+    ): Promise<Hex>
+    encodeDeployCallData: ({
+        abi,
+        args,
+        bytecode
+    }: EncodeDeployDataParameters<TAbi>) => Promise<Hex>
+    signUserOperation: (
+        userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+    ) => Promise<Hex>
+}
+
+export async function prepareMultiUserOpRequest<
+    entryPoint extends EntryPoint = ENTRYPOINT_ADDRESS_V07_TYPE,
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined,
+    TSmartAccount extends KernelSmartAccount<entryPoint> | undefined =
+        | KernelSmartAccount<entryPoint>
+        | undefined
+>(
+    client: Client<TTransport, TChain, TSmartAccount>,
+    args: Prettify<
+        PrepareUserOperationRequestParameters<entryPoint, TSmartAccount>
+    >,
+    numOfUserOps: number,
+    stateOverrides?: StateOverrides
+): Promise<Prettify<PrepareUserOperationRequestReturnType<entryPoint>>> {
+    const {
+        account: account_ = client.account,
+        userOperation: partialUserOperation,
+        middleware
+    } = args
+
+    if (!account_) throw new AccountOrClientNotFoundError()
+
+    const account = parseAccount(
+        account_
+    ) as SmartAccount<ENTRYPOINT_ADDRESS_V07_TYPE>
+
+    const [sender, nonce, factory, factoryData, callData, gasEstimation] =
+        await Promise.all([
+            partialUserOperation.sender || account.address,
+            partialUserOperation.nonce || account.getNonce(),
+            partialUserOperation.factory || account.getFactory(),
+            partialUserOperation.factoryData || account.getFactoryData(),
+            partialUserOperation.callData,
+            !partialUserOperation.maxFeePerGas ||
+            !partialUserOperation.maxPriorityFeePerGas
+                ? estimateFeesPerGas(account.client)
+                : undefined
+        ])
+
+    const userOperation: UserOperation<"v0.7"> = {
+        sender,
+        nonce,
+        factory: factory,
+        factoryData: factoryData,
+        callData,
+        callGasLimit: partialUserOperation.callGasLimit || BigInt(0),
+        verificationGasLimit:
+            partialUserOperation.verificationGasLimit || BigInt(0),
+        preVerificationGas:
+            partialUserOperation.preVerificationGas || BigInt(0),
+        maxFeePerGas:
+            partialUserOperation.maxFeePerGas ||
+            gasEstimation?.maxFeePerGas ||
+            BigInt(0),
+        maxPriorityFeePerGas:
+            partialUserOperation.maxPriorityFeePerGas ||
+            gasEstimation?.maxPriorityFeePerGas ||
+            BigInt(0),
+        signature: partialUserOperation.signature || "0x"
+    }
+
+    if (typeof middleware === "function") {
+        return middleware({
+            userOperation,
+            entryPoint: account.entryPoint
+        } as {
+            userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+            entryPoint: entryPoint
+        }) as Promise<PrepareUserOperationRequestReturnType<entryPoint>>
+    }
+
+    if (middleware && typeof middleware !== "function" && middleware.gasPrice) {
+        const gasPrice = await middleware.gasPrice()
+        userOperation.maxFeePerGas = gasPrice.maxFeePerGas
+        userOperation.maxPriorityFeePerGas = gasPrice.maxPriorityFeePerGas
+    }
+
+    if (!userOperation.maxFeePerGas || !userOperation.maxPriorityFeePerGas) {
+        const estimateGas = await estimateFeesPerGas(account.client)
+        userOperation.maxFeePerGas =
+            userOperation.maxFeePerGas || estimateGas.maxFeePerGas
+        userOperation.maxPriorityFeePerGas =
+            userOperation.maxPriorityFeePerGas ||
+            estimateGas.maxPriorityFeePerGas
+    }
+
+    if (userOperation.signature === "0x") {
+        userOperation.signature = await account.getMultiUserOpDummySignature(
+            userOperation,
+            numOfUserOps
+        )
+    }
+
+    if (
+        middleware &&
+        typeof middleware !== "function" &&
+        middleware.sponsorUserOperation
+    ) {
+        const sponsorUserOperationData = (await middleware.sponsorUserOperation(
+            {
+                userOperation,
+                entryPoint: account.entryPoint
+            } as {
+                userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+                entryPoint: entryPoint
+            }
+        )) as SponsorUserOperationReturnType<ENTRYPOINT_ADDRESS_V07_TYPE>
+
+        userOperation.callGasLimit = sponsorUserOperationData.callGasLimit
+        userOperation.verificationGasLimit =
+            sponsorUserOperationData.verificationGasLimit
+        userOperation.preVerificationGas =
+            sponsorUserOperationData.preVerificationGas
+        userOperation.paymaster = sponsorUserOperationData.paymaster
+        userOperation.paymasterVerificationGasLimit =
+            sponsorUserOperationData.paymasterVerificationGasLimit
+        userOperation.paymasterPostOpGasLimit =
+            sponsorUserOperationData.paymasterPostOpGasLimit
+        userOperation.paymasterData = sponsorUserOperationData.paymasterData
+        userOperation.maxFeePerGas =
+            sponsorUserOperationData.maxFeePerGas || userOperation.maxFeePerGas
+        userOperation.maxPriorityFeePerGas =
+            sponsorUserOperationData.maxPriorityFeePerGas ||
+            userOperation.maxPriorityFeePerGas
+
+        return userOperation as PrepareUserOperationRequestReturnType<entryPoint>
+    }
+
+    if (
+        !userOperation.callGasLimit ||
+        !userOperation.verificationGasLimit ||
+        !userOperation.preVerificationGas
+    ) {
+        const gasParameters = await getAction(
+            client,
+            estimateUserOperationGas<ENTRYPOINT_ADDRESS_V07_TYPE>,
+            "estimateUserOperationGas"
+        )(
+            {
+                userOperation,
+                entryPoint: account.entryPoint
+            },
+            // @ts-ignore getAction takes only two params but when compiled this will work
+            stateOverrides
+        )
+
+        userOperation.callGasLimit |= gasParameters.callGasLimit
+        userOperation.verificationGasLimit =
+            userOperation.verificationGasLimit ||
+            gasParameters.verificationGasLimit
+        userOperation.preVerificationGas =
+            userOperation.preVerificationGas || gasParameters.preVerificationGas
+
+        userOperation.paymasterPostOpGasLimit =
+            userOperation.paymasterPostOpGasLimit ||
+            gasParameters.paymasterPostOpGasLimit
+        userOperation.paymasterPostOpGasLimit =
+            userOperation.paymasterPostOpGasLimit ||
+            gasParameters.paymasterPostOpGasLimit
+    }
+
+    return userOperation as PrepareUserOperationRequestReturnType<entryPoint>
+}

package/actions/account-client/sendSignedUserOperation.ts

@@ -0,0 +1,36 @@
+import { type SendUserOperationParameters, deepHexlify } from "permissionless"
+import type { SmartAccount } from "permissionless/accounts"
+import type { BundlerRpcSchema } from "permissionless/types/bundler"
+import type {
+    EntryPoint,
+    GetEntryPointVersion
+} from "permissionless/types/entrypoint"
+import type { UserOperationWithBigIntAsHex } from "permissionless/types/userOperation"
+import type { Chain, Client, Hash, Transport } from "viem"
+
+export async function sendSignedUserOperation<
+    entryPoint extends EntryPoint,
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends SmartAccount<entryPoint> | undefined =
+        | SmartAccount<entryPoint>
+        | undefined
+>(
+    client: Client<TTransport, TChain, TAccount, BundlerRpcSchema<entryPoint>>,
+    args: SendUserOperationParameters<entryPoint>
+): Promise<Hash> {
+    const { userOperation, entryPoint } = args
+
+    // send user operation directly without signing
+    const userOperationHash = await client.request({
+        method: "eth_sendUserOperation",
+        params: [
+            deepHexlify(userOperation) as UserOperationWithBigIntAsHex<
+                GetEntryPointVersion<entryPoint>
+            >,
+            entryPoint
+        ]
+    })
+
+    return userOperationHash
+}

package/clients/decorators/kernel.ts

@@ -1,12 +1,21 @@
-import { type SmartAccountActions, smartAccountActions } from "permissionless"
-import type { Middleware } from "permissionless/actions/smartAccount"
+import {
+    type SmartAccountActions,
+    type sendUserOperation,
+    smartAccountActions
+} from "permissionless"
+import type {
+    Middleware,
+    PrepareUserOperationRequestReturnType
+} 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,
     getUserOperationGasPrice
 } from "../../actions/account-client/getUserOperationGasPrice.js"
+import { prepareMultiUserOpRequest } from "../../actions/account-client/prepareMultiUserOpRequest.js"
+import { sendSignedUserOperation } from "../../actions/account-client/sendSignedUserOperation.js"
 import type {
     SignUserOperationParameters,
     SignUserOperationReturnType
@@ -87,6 +96,35 @@ export type KernelAccountClientActions<
     getUserOperationGasPrice: () => Promise<
         Prettify<GetUserOperationGasPriceReturnType>
     >
+    /**
+     *
+     * @returns
+     */
+    prepareMultiUserOpRequest: (
+        args: Prettify<
+            Parameters<
+                typeof prepareMultiUserOpRequest<
+                    entryPoint,
+                    Transport,
+                    TChain,
+                    TSmartAccount
+                >
+            >[1]
+        >,
+        numOfUserOps: number
+    ) => Promise<Prettify<PrepareUserOperationRequestReturnType<entryPoint>>>
+    sendSignedUserOperation: <TTransport extends Transport>(
+        args: Prettify<
+            Parameters<
+                typeof sendUserOperation<
+                    entryPoint,
+                    TTransport,
+                    TChain,
+                    TSmartAccount
+                >
+            >[1]
+        >
+    ) => Promise<Hash>
 }
 
 export function kernelAccountClientActions<entryPoint extends EntryPoint>({
@@ -110,6 +148,14 @@ export function kernelAccountClientActions<entryPoint extends EntryPoint>({
                     middleware
                 } as SignUserOperationParameters<entryPoint, TSmartAccount>
             ),
-        getUserOperationGasPrice: async () => getUserOperationGasPrice(client)
+        getUserOperationGasPrice: async () => getUserOperationGasPrice(client),
+        prepareMultiUserOpRequest: async (args, numOfUserOps) =>
+            prepareMultiUserOpRequest(
+                client,
+                { ...args, middleware },
+                numOfUserOps
+            ),
+        sendSignedUserOperation: async (args) =>
+            sendSignedUserOperation(client, args)
     })
 }

package/index.ts

@@ -30,7 +30,8 @@ export { createFallbackKernelAccountClient } from "./clients/fallbackKernelAccou
 export {
     type KernelValidator,
     type ZeroDevPaymasterRpcSchema,
-    type KernelPluginManager
+    type KernelPluginManager,
+    type Action
 } from "./types/kernel.js"
 export { KernelAccountAbi } from "./accounts/kernel/abi/KernelAccountAbi.js"
 export { KernelFactoryAbi } from "./accounts/kernel/abi/KernelFactoryAbi.js"
@@ -50,3 +51,4 @@ export {
     getCustomNonceKeyFromString
 } from "./accounts/utils/index.js"
 export { KernelEIP1193Provider } from "./providers/index.js"
+export { getEncodedPluginsData } from "./accounts/kernel/utils/plugins/ep0_7/getEncodedPluginsData.js"

package/package.json

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

package/types/kernel.ts

@@ -7,7 +7,7 @@ import type {
     UserOperation,
     UserOperationWithBigIntAsHex
 } from "permissionless/types/userOperation"
-import type { Address, Hex, LocalAccount } from "viem"
+import type { Address, CustomSource, Hex, LocalAccount } from "viem"
 import type { PartialBy } from "viem/types/utils"
 import type { VALIDATOR_TYPE } from "../constants.js"
 export type ZeroDevPaymasterRpcSchema<entryPoint extends EntryPoint> = [
@@ -134,6 +134,10 @@ export type KernelValidator<
         userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
         pluginEnableSignature?: Hex
     ): Promise<Hex>
+    getMultiUserOpDummySignature?(
+        userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
+        numOfUserOps: number
+    ): Promise<Hex>
     signUserOperation: (
         userOperation: UserOperation<GetEntryPointVersion<entryPoint>>,
         pluginEnableSignature?: Hex
@@ -151,12 +155,20 @@ export type ValidatorInitData = {
 
 export type KernelPluginManager<entryPoint extends EntryPoint> =
     KernelValidator<entryPoint> & {
+        sudoValidator?: KernelValidator<entryPoint>
+        activeValidator: KernelValidator<entryPoint>
         getPluginEnableSignature(accountAddress: Address): Promise<Hex>
         getValidatorInitData(): Promise<ValidatorInitData>
         getAction(): Action
         getValidityData(): PluginValidityData
         getIdentifier(isSudo?: boolean): Hex
         encodeModuleInstallCallData: (accountAddress: Address) => Promise<Hex>
+        getPluginsEnableTypedData: (
+            accountAddress: Address
+        ) => Promise<Parameters<CustomSource["signTypedData"]>[0]>
+        signUserOperationWithActiveValidator: (
+            userOperation: UserOperation<GetEntryPointVersion<entryPoint>>
+        ) => Promise<Hex>
     }
 
 export type PluginInstallData<entryPoint extends EntryPoint> =