@zerodev/sdk 5.4.0-beta.1 → 5.4.0-beta.3

package/accounts/kernel/createKernelAccount.ts

@@ -34,6 +34,7 @@ import {
 import { KernelVersionToAddressesMap } from "../../constants.js"
 import type {
     CallType,
+    EntryPointType,
     GetEntryPointAbi,
     GetKernelVersion,
     KernelPluginManager,
@@ -96,10 +97,7 @@ export type CreateKernelAccountParameters<
               "entryPoint" | "kernelVersion"
           >
         | KernelPluginManager<entryPointVersion>
-    entryPoint: {
-        address: Address
-        version: entryPointVersion
-    }
+    entryPoint: EntryPointType<entryPointVersion>
     index?: bigint
     factoryAddress?: Address
     accountImplementationAddress?: Address

package/actions/paymaster/sponsorUserOperation.ts

@@ -1,63 +1,29 @@
-import type { Address, Hex } from "viem"
-import type { PartialBy } from "viem"
-import type { EntryPointVersion, UserOperation } from "viem/account-abstraction"
+import { type Address, type Hex, type Prettify, isAddressEqual } from "viem"
+import {
+    type EntryPointVersion,
+    type GetPaymasterDataParameters,
+    type GetPaymasterStubDataReturnType,
+    entryPoint06Address
+} from "viem/account-abstraction"
 import type { ZeroDevPaymasterClient } from "../../clients/paymasterClient.js"
-import type { PartialPick } from "../../types/index.js"
 import { deepHexlify } from "../../utils.js"
 
-export type SponsorUserOperationParameters<
-    entryPointVersion extends EntryPointVersion
-> = {
-    userOperation: entryPointVersion extends "0.6"
-        ? PartialBy<
-              UserOperation<"0.6">,
-              "callGasLimit" | "preVerificationGas" | "verificationGasLimit"
-          >
-        : PartialBy<
-              UserOperation<"0.7">,
-              | "callGasLimit"
-              | "preVerificationGas"
-              | "verificationGasLimit"
-              | "paymasterVerificationGasLimit"
-              | "paymasterPostOpGasLimit"
-          >
-    entryPoint: {
-        address: Address
-        version: entryPointVersion
-    }
+export type SponsorUserOperationParameters = {
+    userOperation: GetPaymasterDataParameters
     gasToken?: Hex
     shouldOverrideFee?: boolean
     shouldConsume?: boolean
 }
 
-export type SponsorUserOperationReturnType<
-    entryPointVersion extends EntryPointVersion
-> = entryPointVersion extends "0.6"
-    ? Pick<
-          UserOperation<"0.6">,
-          | "callGasLimit"
-          | "verificationGasLimit"
-          | "preVerificationGas"
-          | "paymasterAndData"
-      > &
-          PartialPick<
-              UserOperation<"0.6">,
-              "maxFeePerGas" | "maxPriorityFeePerGas"
-          >
-    : Pick<
-          UserOperation<"0.7">,
-          | "callGasLimit"
-          | "verificationGasLimit"
-          | "preVerificationGas"
-          | "paymaster"
-          | "paymasterVerificationGasLimit"
-          | "paymasterPostOpGasLimit"
-          | "paymasterData"
-      > &
-          PartialPick<
-              UserOperation<"0.7">,
-              "maxFeePerGas" | "maxPriorityFeePerGas"
-          >
+export type SponsorUserOperationReturnType = Prettify<
+    GetPaymasterStubDataReturnType & {
+        maxFeePerGas?: bigint | undefined
+        maxPriorityFeePerGas?: bigint | undefined
+        callGasLimit?: bigint | undefined
+        verificationGasLimit?: bigint | undefined
+        preVerificationGas?: bigint | undefined
+    }
+>
 
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
@@ -66,15 +32,28 @@ export const sponsorUserOperation = async <
     entryPointVersion extends EntryPointVersion
 >(
     client: ZeroDevPaymasterClient<entryPointVersion>,
-    args: SponsorUserOperationParameters<entryPointVersion>
-): Promise<SponsorUserOperationReturnType<entryPointVersion>> => {
+    args: SponsorUserOperationParameters
+): Promise<SponsorUserOperationReturnType> => {
+    console.log({ args })
+    const {
+        userOperation: {
+            chainId,
+            entryPointAddress,
+            context,
+            // @ts-ignore
+            calls,
+            // @ts-ignore
+            account,
+            ..._userOperation
+        }
+    } = args
     const response = await client.request({
         method: "zd_sponsorUserOperation",
         params: [
             {
                 chainId: client.chain?.id as number,
-                userOp: deepHexlify(args.userOperation),
-                entryPointAddress: args.entryPoint.address,
+                userOp: deepHexlify(_userOperation),
+                entryPointAddress: entryPointAddress,
                 gasTokenData: args.gasToken && {
                     tokenAddress: args.gasToken
                 },
@@ -83,18 +62,19 @@ export const sponsorUserOperation = async <
             }
         ]
     })
-    if (args.entryPoint.version === "0.6") {
+    if (isAddressEqual(entryPointAddress, entryPoint06Address)) {
         return {
             paymasterAndData: response.paymasterAndData,
             preVerificationGas: BigInt(response.preVerificationGas),
             verificationGasLimit: BigInt(response.verificationGasLimit),
             callGasLimit: BigInt(response.callGasLimit),
-            maxFeePerGas:
-                response.maxFeePerGas && BigInt(response.maxFeePerGas),
-            maxPriorityFeePerGas:
-                response.maxPriorityFeePerGas &&
-                BigInt(response.maxPriorityFeePerGas)
-        } as SponsorUserOperationReturnType<entryPointVersion>
+            maxFeePerGas: response.maxFeePerGas
+                ? BigInt(response.maxFeePerGas)
+                : args.userOperation.maxFeePerGas,
+            maxPriorityFeePerGas: response.maxPriorityFeePerGas
+                ? BigInt(response.maxPriorityFeePerGas)
+                : args.userOperation.maxPriorityFeePerGas
+        } as SponsorUserOperationReturnType
     }
     const responseV07 = response as {
         preVerificationGas: Hex
@@ -119,9 +99,11 @@ export const sponsorUserOperation = async <
         ),
         paymasterPostOpGasLimit: BigInt(responseV07.paymasterPostOpGasLimit),
         paymasterData: responseV07.paymasterData,
-        maxFeePerGas: response.maxFeePerGas && BigInt(response.maxFeePerGas),
-        maxPriorityFeePerGas:
-            response.maxPriorityFeePerGas &&
-            BigInt(response.maxPriorityFeePerGas)
-    } as SponsorUserOperationReturnType<entryPointVersion>
+        maxFeePerGas: response.maxFeePerGas
+            ? BigInt(response.maxFeePerGas)
+            : args.userOperation.maxFeePerGas,
+        maxPriorityFeePerGas: response.maxPriorityFeePerGas
+            ? BigInt(response.maxPriorityFeePerGas)
+            : args.userOperation.maxPriorityFeePerGas
+    } as SponsorUserOperationReturnType
 }

package/clients/decorators/kernel.ts

@@ -1,6 +1,5 @@
 import type {
     Abi,
-    Address,
     Chain,
     Client,
     ContractFunctionArgs,
@@ -47,37 +46,26 @@ import {
 } from "../../actions/paymaster/sponsorUserOperation.js"
 import type { ZeroDevPaymasterClient } from "../paymasterClient.js"
 
-export type ZeroDevPaymasterClientActions<
-    entryPointVersion extends EntryPointVersion
-> = {
+export type ZeroDevPaymasterClientActions = {
     /**
      * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
      */
     sponsorUserOperation: (
-        args: SponsorUserOperationParameters<entryPointVersion>
-    ) => Promise<SponsorUserOperationReturnType<entryPointVersion>>
+        args: SponsorUserOperationParameters
+    ) => Promise<SponsorUserOperationReturnType>
     estimateGasInERC20: (
         args: EstimateGasInERC20Parameters
     ) => Promise<EstimateGasInERC20ReturnType>
 }
 
 export const zerodevPaymasterActions =
-    <entryPointVersion extends EntryPointVersion>(entryPoint: {
-        address: Address
-        version: entryPointVersion
-    }) =>
-    (client: Client): ZeroDevPaymasterClientActions<entryPointVersion> => ({
-        sponsorUserOperation: async (
-            args: Omit<
-                SponsorUserOperationParameters<entryPointVersion>,
-                "entryPoint"
-            >
-        ) =>
+    <entryPointVersion extends EntryPointVersion>() =>
+    (client: Client): ZeroDevPaymasterClientActions => ({
+        sponsorUserOperation: async (args: SponsorUserOperationParameters) =>
             sponsorUserOperation(
                 client as ZeroDevPaymasterClient<entryPointVersion>,
                 {
-                    ...args,
-                    entryPoint
+                    ...args
                 }
             ),
         estimateGasInERC20: async (args: EstimateGasInERC20Parameters) =>

package/clients/paymasterClient.ts

@@ -1,5 +1,4 @@
 import {
-    type Address,
     type Chain,
     type Client,
     type ClientConfig,
@@ -12,11 +11,16 @@ import {
 import {
     type PaymasterActions,
     type SmartAccount,
-    entryPoint07Address,
     paymasterActions
 } from "viem/account-abstraction"
-import type { ZeroDevPaymasterRpcSchema } from "../types/kernel.js"
-import { zerodevPaymasterActions } from "./decorators/kernel.js"
+import type {
+    EntryPointType,
+    ZeroDevPaymasterRpcSchema
+} from "../types/kernel.js"
+import {
+    type ZeroDevPaymasterClientActions,
+    zerodevPaymasterActions
+} from "./decorators/kernel.js"
 
 export type ZeroDevPaymasterClient<
     entryPointVersion extends "0.6" | "0.7" = "0.7",
@@ -38,7 +42,7 @@ export type ZeroDevPaymasterClient<
         rpcSchema extends RpcSchema
             ? [...ZeroDevPaymasterRpcSchema<entryPointVersion>, ...rpcSchema]
             : ZeroDevPaymasterRpcSchema<entryPointVersion>,
-        PaymasterActions
+        PaymasterActions & ZeroDevPaymasterClientActions
     >
 >
 
@@ -61,10 +65,7 @@ export type ZeroDevPaymasterClientConfig<
         | "transport"
     >
 > & {
-    entryPoint?: {
-        address: Address
-        version: entryPointVersion
-    }
+    entryPoint?: EntryPointType<entryPointVersion>
 }
 /**
  * Creates a ZeroDev-specific Paymaster Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
@@ -89,7 +90,6 @@ export const createZeroDevPaymasterClient = (
     const {
         key = "public",
         name = "ZeroDev Paymaster Client",
-        entryPoint,
         transport
     } = parameters
     const client = createClient({
@@ -104,10 +104,5 @@ export const createZeroDevPaymasterClient = (
         name,
         type: "zerodevPaymasterClient"
     })
-    return client.extend(paymasterActions).extend(
-        zerodevPaymasterActions({
-            address: entryPoint?.address ?? entryPoint07Address,
-            version: entryPoint?.version ?? "0.7"
-        })
-    )
+    return client.extend(paymasterActions).extend(zerodevPaymasterActions())
 }

package/constants.ts

@@ -1,5 +1,11 @@
 import { type Address, type Hex, zeroAddress } from "viem"
+import {
+    type EntryPointVersion,
+    entryPoint06Address,
+    entryPoint07Address
+} from "viem/account-abstraction"
 import type {
+    EntryPointType,
     KERNEL_V2_VERSION_TYPE,
     KERNEL_V3_VERSION_TYPE,
     KERNEL_VERSION_TYPE
@@ -112,3 +118,17 @@ export const KernelFactoryToInitCodeHashMap: { [key: Address]: Hex } = {
     "0x6723b44Abeec4E71eBE3232BD5B455805baDD22f":
         "0x6fe6e6ea30eddce942b9618033ab8429f9ddac594053bec8a6744fffc71976e2"
 }
+
+export const getEntryPoint = <TEntryPointVersion extends EntryPointVersion>(
+    entryPointVersion: TEntryPointVersion
+): EntryPointType<TEntryPointVersion> => {
+    if (entryPointVersion === "0.6")
+        return {
+            address: entryPoint06Address,
+            version: entryPointVersion
+        }
+    return {
+        address: entryPoint07Address,
+        version: entryPointVersion
+    }
+}

package/index.ts

@@ -67,3 +67,4 @@ export { isProviderSet, setPimlicoAsProvider } from "./clients/utils.js"
 export { getUserOperationGasPrice } from "./actions/account-client/getUserOperationGasPrice.js"
 export { isPluginInitialized } from "./accounts/kernel/utils/plugins/ep0_7/isPluginInitialized.js"
 export * from "./errors/index.js"
+export * from "./utils/index.js"

package/package.json

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

package/types/index.ts

@@ -13,11 +13,14 @@ export type {
     KERNEL_V3_VERSION_TYPE,
     KERNEL_VERSION_TYPE,
     GetKernelVersion,
-    GetEntryPointAbi
+    GetEntryPointAbi,
+    EntryPointType
 } from "./kernel.js"
 
 export { ValidatorMode } from "./kernel.js"
 
+export type { Signer } from "./utils.js"
+
 export type WithRequired<T, K extends keyof T> = Required<Pick<T, K>>
 
 export type PartialPick<T, K extends keyof T> = Partial<Pick<T, K>>

package/types/kernel.ts

@@ -195,10 +195,7 @@ export type KernelPluginManagerParams<
     pluginEnableSignature?: Hex
     validatorInitData?: ValidatorInitData
     action?: Action
-    entryPoint: {
-        address: Address
-        version: entryPointVersion
-    }
+    entryPoint: EntryPointType<entryPointVersion>
     kernelVersion: KERNEL_VERSION_TYPE
     chainId?: number
 } & Partial<PluginValidityData>
@@ -256,3 +253,8 @@ export type GetKernelVersion<entryPointVersion extends EntryPointVersion> =
     entryPointVersion extends "0.6"
         ? KERNEL_V2_VERSION_TYPE
         : KERNEL_V3_VERSION_TYPE
+
+export type EntryPointType<entryPointVersion extends EntryPointVersion> = {
+    address: Address
+    version: entryPointVersion
+}

package/types/utils.ts

@@ -0,0 +1,15 @@
+import type {
+    Account,
+    Chain,
+    EIP1193Provider,
+    LocalAccount,
+    OneOf,
+    Transport,
+    WalletClient
+} from "viem"
+
+export type Signer = OneOf<
+    | EIP1193Provider
+    | WalletClient<Transport, Chain | undefined, Account>
+    | LocalAccount
+>

package/utils/index.ts

@@ -0,0 +1 @@
+export * from "./toSigner.js"

package/utils/toSigner.ts

@@ -0,0 +1,106 @@
+// Copied from: https://github.com/pimlicolabs/permissionless.js/blob/main/packages/permissionless/utils/toOwner.ts
+import {
+    type Account,
+    type Address,
+    type Chain,
+    type EIP1193Provider,
+    type EIP1193RequestFn,
+    type EIP1474Methods,
+    type LocalAccount,
+    type Transport,
+    type TypedData,
+    type TypedDataDefinition,
+    type WalletClient,
+    createWalletClient,
+    custom
+} from "viem"
+import { toAccount } from "viem/accounts"
+
+import { signMessage, signTypedData } from "viem/actions"
+import type { Signer } from "../types"
+
+export async function toSigner({
+    signer,
+    address
+}: {
+    signer: Signer
+    address?: Address
+}): Promise<LocalAccount> {
+    if ("type" in signer && signer.type === "local") {
+        return signer as LocalAccount
+    }
+
+    let walletClient:
+        | WalletClient<Transport, Chain | undefined, Account>
+        | undefined = undefined
+
+    if ("request" in signer) {
+        if (!address) {
+            try {
+                ;[address] = await (
+                    signer.request as EIP1193RequestFn<EIP1474Methods>
+                )({
+                    method: "eth_requestAccounts"
+                })
+            } catch {
+                ;[address] = await (
+                    signer.request as EIP1193RequestFn<EIP1474Methods>
+                )({
+                    method: "eth_accounts"
+                })
+            }
+        }
+        if (!address) {
+            // For TS to be happy
+            throw new Error("address is required")
+        }
+        walletClient = createWalletClient({
+            account: address,
+            transport: custom(signer as EIP1193Provider)
+        })
+    }
+
+    if (!walletClient) {
+        walletClient = signer as WalletClient<
+            Transport,
+            Chain | undefined,
+            Account
+        >
+    }
+
+    return toAccount({
+        address: walletClient.account.address,
+        async signMessage({ message }) {
+            return signMessage(
+                walletClient as WalletClient<
+                    Transport,
+                    Chain | undefined,
+                    Account
+                >,
+                { message }
+            )
+        },
+        async signTypedData(typedData) {
+            const { primaryType, domain, message, types } =
+                typedData as TypedDataDefinition<TypedData, string>
+            return signTypedData(
+                walletClient as WalletClient<
+                    Transport,
+                    Chain | undefined,
+                    Account
+                >,
+                {
+                    primaryType,
+                    domain,
+                    message,
+                    types
+                }
+            )
+        },
+        async signTransaction(_) {
+            throw new Error(
+                "Smart account signer doesn't need to sign transactions"
+            )
+        }
+    }) as LocalAccount
+}

package/utils.ts

@@ -14,7 +14,7 @@ import {
 import type { EntryPointVersion } from "viem/account-abstraction"
 import type { ZeroDevPaymasterClient } from "./clients/paymasterClient.js"
 import type { CALL_TYPE, EXEC_TYPE } from "./constants.js"
-import type { GetKernelVersion } from "./types/kernel.js"
+import type { EntryPointType, GetKernelVersion } from "./types/kernel.js"
 
 export enum KERNEL_FEATURES {
     ERC1271_SIG_WRAPPER = "ERC1271_SIG_WRAPPER",
@@ -50,7 +50,7 @@ export const getERC20PaymasterApproveCall = async <
     }: {
         gasToken: Address
         approveAmount: bigint
-        entryPoint: { address: Address; version: entryPointVersion }
+        entryPoint: EntryPointType<entryPointVersion>
     }
 ): Promise<{ to: Address; value: bigint; data: Hex }> => {
     const response = await client.request({