@zerodev/sdk 4.3.3 → 4.3.4

package/src/kernel-zerodev/ethers-provider/ethers-provider.ts

@@ -1,6 +1,5 @@
 import { getChainId } from "../api/index.js";
 import {
-  getChain,
   BaseSmartContractAccount,
   defineReadOnly,
   type AccountMiddlewareFn,
@@ -18,6 +17,7 @@ import type {
 } from "../validator-provider/types.js";
 import { ValidatorProviders } from "../validator-provider/index.js";
 import { withZeroDevPaymasterAndData } from "../middleware/paymaster.js";
+import { getChain } from "../utils.js";
 
 export class ZeroDevEthersProvider<
   V extends SupportedValidators
@@ -27,7 +27,8 @@ export class ZeroDevEthersProvider<
     super();
     let bundlerProvider = params.bundlerProvider;
     const shouldUsePaymaster =
-      params.usePaymaster === undefined || params.usePaymaster;
+      (params.usePaymaster === undefined || params.usePaymaster) &&
+      bundlerProvider !== "GELATO";
     if (
       params.opts?.paymasterConfig &&
       params.opts?.paymasterConfig.policy === "TOKEN_PAYMASTER" &&

package/src/kernel-zerodev/middleware/gas-estimator.ts

@@ -16,10 +16,14 @@ export const withZeroDevGasEstimator = (
 ): ZeroDevProvider => {
   provider.withFeeDataGetter(async (struct) => {
     let overrides = await resolveProperties({
-      maxFeePerGas: struct.maxFeePerGas ?? 0n,
-      maxPriorityFeePerGas: struct.maxPriorityFeePerGas ?? 0n,
+      maxFeePerGas: struct.maxFeePerGas,
+      maxPriorityFeePerGas: struct.maxPriorityFeePerGas,
     });
 
+    if (provider.bundlerProvider === "GELATO") {
+      return { maxFeePerGas: 0n, maxPriorityFeePerGas: 0n };
+    }
+
     let maxFeePerGas, maxPriorityFeePerGas;
 
     try {
@@ -40,11 +44,12 @@ export const withZeroDevGasEstimator = (
         : 0n;
     }
 
-    if (
-      maxFeePerGas < BigInt(overrides.maxFeePerGas) ||
-      maxPriorityFeePerGas < BigInt(overrides.maxPriorityFeePerGas)
-    ) {
-      return overrides;
+    if (overrides.maxFeePerGas || overrides.maxPriorityFeePerGas) {
+      return {
+        maxFeePerGas: overrides.maxFeePerGas ?? maxFeePerGas,
+        maxPriorityFeePerGas:
+          overrides.maxPriorityFeePerGas ?? maxPriorityFeePerGas,
+      };
     }
     return { maxFeePerGas, maxPriorityFeePerGas };
   });
@@ -128,6 +133,7 @@ export const GAS_PRICE_RPC_METHODS_BY_BUNDLER: {
   STACKUP: "eth_maxPriorityFeePerGas",
   ALCHEMY: "rundler_maxPriorityFeePerGas",
   PIMLICO: "pimlico_getUserOperationGasPrice",
+  GELATO: "eth_maxPriorityFeePerGas",
 };
 
 export const eip1559GasPrice = async (provider: ZeroDevProvider) => {

package/src/kernel-zerodev/owner/getCustodialOwner.ts

@@ -1,13 +1,12 @@
 import type { SignTypedDataParams, SmartAccountSigner } from "@alchemy/aa-core";
 import { API_URL } from "../constants.js";
 import axios from "axios";
-import { memo, tryit } from "radash";
 
 /**
  * Params to get a custodial owner
  * Priv / pub key combo or custodial file path should be in different types
  */
-type GetCustodialOwnerParams = Readonly<{
+type GetCustodialOwnerParams = {
   // ZeroDev api url
   apiUrl?: string;
   // Turnkey client (if the client want to reuse it
@@ -20,7 +19,7 @@ type GetCustodialOwnerParams = Readonly<{
 
   // Or read them from the custodial file path
   custodialFilePath?: string;
-}>;
+};
 
 /**
  * Returns a signer for a custodial wallet via TurnKey
@@ -38,40 +37,80 @@ export async function getCustodialOwner(
 ): Promise<SmartAccountSigner | undefined> {
   // Extract data from the custodial file path if provided
   if (custodialFilePath) {
-    [privateKey, publicKey, keyId] = await loadSignDataFromCustodialFile(
-      custodialFilePath
-    );
+    let fsModule;
+    try {
+      fsModule = require.resolve("fs") && require("fs");
+    } catch (error) {
+      console.log("FS module not available. Skipping FS operation...");
+      return;
+    }
+    const data = fsModule.readFileSync(custodialFilePath, "utf8");
+    const values = data.split("\n");
+    // Override the values, if they are provided, to the one from the custodial file
+    [privateKey, publicKey, keyId] = values;
   }
 
   // Ensure we have the required values
-  if (!keyId) {
-    throw new Error("You must provide custodialFilePath or a keyId.");
+  if (!privateKey || !publicKey || !keyId) {
+    throw new Error(
+      "Must provide custodialFilePath or privateKey, publicKey, and keyId."
+    );
   }
 
   // Get our turnkey client (build it if needed)
-  let ensuredTurnkeyClient = turnKeyClient;
-  if (!ensuredTurnkeyClient && privateKey && publicKey) {
-    ensuredTurnkeyClient = await getDefaultTurnkeyClient({
-      privateKey,
-      publicKey,
-    });
-  } else {
-    throw new Error(
-      "No turnkey client available, if you don't provide one you should provide private and public key or a custodial file path"
+  if (!turnKeyClient) {
+    // Try to fetch turnkey client & api key stamper
+    let TurnkeyClient;
+    let ApiKeyStamper;
+    // TODO: Would be cleaner with something like radash and a tryit function?
+    try {
+      TurnkeyClient =
+        require.resolve("@turnkey/http") &&
+        require("@turnkey/http").TurnkeyClient;
+      ApiKeyStamper =
+        require.resolve("@turnkey/api-key-stamper") &&
+        require("@turnkey/api-key-stamper").ApiKeyStamper;
+    } catch (error) {
+      console.log(
+        "@turnkey/http or @turnkey/api-key-stamper module not available. Skipping FS operation..."
+      );
+      return;
+    }
+
+    // Build the turnkey client
+    turnKeyClient = new TurnkeyClient(
+      {
+        baseUrl: "https://api.turnkey.com",
+      },
+      new ApiKeyStamper({
+        apiPublicKey: publicKey,
+        apiPrivateKey: privateKey,
+      })
     );
   }
 
   // Get the wallet identifier from the API
-  const response = await fetchWallet({ identifier, keyId, apiUrl });
-  if (!response?.data?.walletId) {
-    throw new Error(`No wallet id found for ${identifier}`);
-  }
+  const response = await axios.post<any, { data: { walletId: string } }>(
+    `${apiUrl}/wallets/${identifier}`,
+    {
+      keyId,
+    }
+  );
 
   // Build the turnkey viem account
-  const turnkeySigner = await getTurnkeySigner({
-    keyId,
+  let createAccount;
+  try {
+    createAccount =
+      require.resolve("@turnkey/viem") &&
+      require("@turnkey/viem").createAccount;
+  } catch (error) {
+    console.log("@turnkey/viem module not available. Skipping FS operation...");
+    return;
+  }
+  const turnkeySigner = await createAccount({
+    client: turnKeyClient,
+    organizationId: keyId,
     privateKeyId: response.data.walletId,
-    turnkeyClient: ensuredTurnkeyClient,
   });
 
   // Return an alchemy AA signer from the turnkey signer
@@ -90,154 +129,3 @@ export async function getCustodialOwner(
       turnkeySigner.signTypedData(params),
   };
 }
-
-/**
- * Try to load sign data from a local custodial file path
- */
-const loadSignDataFromCustodialFile = memo(
-  async (custodialFilePath: string) => {
-    const [, fsModule] = await tryit(() => import("fs"))();
-    if (!fsModule) {
-      console.error("FS module not available");
-      throw new Error(
-        "FS module not available, you must provide each keys or install this module"
-      );
-    }
-    const data = fsModule.readFileSync(custodialFilePath, "utf8");
-    return data.split("\n");
-  },
-  {
-    // TTL of 1min in the memory cache
-    ttl: 1000 * 60,
-    // The key in the cache
-    key: (custodialFilePath: string) => `${custodialFilePath}`,
-  }
-);
-
-/**
- * Get our default turnkey client
- */
-const getDefaultTurnkeyClient = memo(
-  async ({
-    privateKey,
-    publicKey,
-  }: {
-    privateKey: string;
-    publicKey: string;
-  }) => {
-    // Try to fetch turnkey client & api key stamper
-    const [, turnkeyHttp] = await tryit(() => import("@turnkey/http"))();
-    const [, turnkeyApiKeyStamper] = await tryit(
-      () => import("@turnkey/api-key-stamper")
-    )();
-    if (!turnkeyHttp || !turnkeyApiKeyStamper) {
-      console.error(
-        "@turnkey/http or @turnkey/api-key-stamper module not available."
-      );
-      throw new Error(
-        "Turnkey http or api-key-stamper modules not available, you must provide a turnkey client or install this modules"
-      );
-    }
-
-    // Build the turnkey client
-    return new turnkeyHttp.TurnkeyClient(
-      {
-        baseUrl: "https://api.turnkey.com",
-      },
-      new turnkeyApiKeyStamper.ApiKeyStamper({
-        apiPublicKey: publicKey,
-        apiPrivateKey: privateKey,
-      })
-    );
-  },
-  {
-    // TTL of 1min in the memory cache
-    ttl: 1000 * 60,
-    // The key in the cache
-    key: ({
-      privateKey,
-      publicKey,
-    }: {
-      privateKey: string;
-      publicKey: string;
-    }) => `${privateKey}-${publicKey}`,
-  }
-);
-
-/**
- * Simple function used to fetch the wallet id from the API using an identifier
- */
-const fetchWallet = memo(
-  ({
-    identifier,
-    keyId,
-    apiUrl,
-  }: {
-    identifier: string;
-    keyId: string;
-    apiUrl: string;
-  }) => {
-    return axios.post<any, { data: { walletId: string } }>(
-      `${apiUrl}/wallets/${identifier}`,
-      {
-        keyId,
-      }
-    );
-  },
-  {
-    // TTL of 1min in the memory cache
-    ttl: 1000 * 60,
-    // The key in the cache
-    key: ({
-      identifier,
-      keyId,
-      apiUrl,
-    }: {
-      identifier: string;
-      keyId: string;
-      apiUrl: string;
-    }) => `${identifier}-${keyId}-${apiUrl}`,
-  }
-);
-
-/**
- * Get a turnkey signer
- */
-const getTurnkeySigner = memo(
-  async ({
-    keyId,
-    privateKeyId,
-    turnkeyClient,
-  }: {
-    keyId: string;
-    privateKeyId: string;
-    turnkeyClient: unknown;
-  }) => {
-    // Get the turnkey viem account
-    const [, turnkeyViem] = await tryit(() => import("@turnkey/viem"))();
-    if (!turnkeyViem) {
-      console.error("@turnkey/viem module not available");
-      throw new Error(
-        "Turnkey viem module not available, can't create a turnkey signer for the custodial owner"
-      );
-    }
-    return turnkeyViem.createAccount({
-      client: turnkeyClient as any,
-      organizationId: keyId,
-      privateKeyId,
-    });
-  },
-  {
-    // TTL of 1min in the memory cache
-    ttl: 1000 * 60,
-    // The key in the cache
-    key: ({
-      keyId,
-      privateKeyId,
-    }: {
-      keyId: string;
-      privateKeyId: string;
-      turnkeyClient: unknown;
-    }) => `${keyId}-${privateKeyId}`,
-  }
-);

package/src/kernel-zerodev/owner/passkey/utils.ts

@@ -47,10 +47,10 @@ export const signMessageImplementation = async (
   const signedRequest = await TurnkeyApi.signSignRawPayload(
     {
       body: {
-        type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2",
+        type: "ACTIVITY_TYPE_SIGN_RAW_PAYLOAD",
         organizationId: id,
         parameters: {
-          signWith: walletId,
+          privateKeyId: walletId,
           payload: msg,
           encoding: "PAYLOAD_ENCODING_HEXADECIMAL",
           hashFunction: "HASH_FUNCTION_NO_OP",

package/src/kernel-zerodev/paymaster/types.ts

@@ -2,7 +2,11 @@ import type { Hex } from "viem";
 import type { Paymaster } from "./base.js";
 import type { ZeroDevProvider } from "../provider.js";
 
-export type PaymasterAndBundlerProviders = "ALCHEMY" | "STACKUP" | "PIMLICO";
+export type PaymasterAndBundlerProviders =
+  | "ALCHEMY"
+  | "STACKUP"
+  | "PIMLICO"
+  | "GELATO";
 
 export type SupportedGasToken = "USDC" | "PEPE" | "TEST_ERC20";
 

package/src/kernel-zerodev/provider.ts

@@ -12,7 +12,6 @@ import {
   deepHexlify,
   resolveProperties,
   type SmartAccountProviderOpts,
-  getChain,
   type UserOperationCallData,
   type BatchUserOperationCallData,
   type SendUserOperationResult,
@@ -43,6 +42,7 @@ import type {
   PaymasterConfig,
   PaymasterPolicy,
 } from "./paymaster/types.js";
+import { getChain } from "./utils.js";
 
 export type ZeroDevProviderConfig = {
   projectId: string;
@@ -373,14 +373,27 @@ export class ZeroDevProvider extends SmartAccountProvider<HttpTransport> {
   waitForUserOperationTransaction = async (hash: Hash): Promise<Hash> => {
     let blockNumber = await this.rpcClient.getBlockNumber();
     for (let i = 0; i < this._txMaxRetries; i++) {
-      const logs = await this.rpcClient.getLogs({
-        address: ENTRYPOINT_ADDRESS,
-        event: getAbiItem({ abi: EntryPointAbi, name: "UserOperationEvent" }),
-        args: { userOpHash: hash },
-        fromBlock: blockNumber - 100n,
-      });
-      if (logs.length) {
-        return logs[0].transactionHash;
+      if (this.bundlerProvider === "GELATO") {
+        const receipt = await this.getUserOperationReceipt(
+          hash as `0x${string}`
+        )
+          // TODO: should maybe log the error?
+          .catch(() => null);
+        if (receipt) {
+          return this.getTransaction(receipt.receipt.transactionHash).then(
+            (x) => x.hash
+          );
+        }
+      } else {
+        const logs = await this.rpcClient.getLogs({
+          address: ENTRYPOINT_ADDRESS,
+          event: getAbiItem({ abi: EntryPointAbi, name: "UserOperationEvent" }),
+          args: { userOpHash: hash },
+          fromBlock: blockNumber - 100n,
+        });
+        if (logs.length) {
+          return logs[0].transactionHash;
+        }
       }
       await new Promise((resolve) =>
         setTimeout(resolve, this._txRetryIntervalMs)

package/src/kernel-zerodev/utils/custom-chains.ts

@@ -0,0 +1,55 @@
+import { defineChain } from "viem";
+
+export const gelatoOPTestnet = defineChain({
+  id: 42069,
+  name: "Gelato OPTestnet",
+  network: "gelatoOPTestnet",
+  nativeCurrency: {
+    decimals: 18,
+    name: "Ether",
+    symbol: "ETH",
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://rpc.op-testnet.gelato.digital"],
+      webSocket: [],
+    },
+    public: {
+      http: ["https://rpc.op-testnet.gelato.digital"],
+      webSocket: [],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: "Explorer",
+      url: "https://blockscout.op-testnet.gelato.digital",
+    },
+  },
+});
+
+export const astarZKatana = defineChain({
+  id: 1261120,
+  name: "Astar zKatana",
+  network: "astarZKatana",
+  nativeCurrency: {
+    decimals: 18,
+    name: "Ether",
+    symbol: "ETH",
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://rpc.zkatana.gelato.digital"],
+      webSocket: ["https://ws.zkatana.gelato.digital"],
+    },
+    public: {
+      http: ["https://rpc.zkatana.gelato.digital"],
+      webSocket: ["https://ws.zkatana.gelato.digital"],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: "Explorer",
+      url: "https://zkatana.blockscout.com",
+    },
+  },
+});

package/src/kernel-zerodev/utils.ts

@@ -9,6 +9,8 @@ import {
   hexToSignature,
   signatureToHex,
 } from "viem";
+import * as chains from "viem/chains";
+import * as customChains from "./utils/custom-chains.js";
 import type {
   SignTypedDataParams,
   SmartAccountSigner,
@@ -132,3 +134,22 @@ export const fixSignedData = (sig: Hex): Hex => {
   const joined = signatureToHex({ r, s, v });
   return joined;
 };
+
+// Modified from @alchemy/aa-core
+/**
+ * Utility method for converting a chainId to a {@link chains.Chain} object
+ *
+ * @param chainId
+ * @returns a {@link chains.Chain} object for the given chainId
+ * @throws if the chainId is not found
+ */
+export const getChain = (chainId: number): chains.Chain => {
+  for (const chain of Object.values(chains).concat(
+    Object.values(customChains)
+  )) {
+    if (chain.id === chainId) {
+      return chain;
+    }
+  }
+  throw new Error("could not find chain");
+};

package/src/kernel-zerodev/validator/ecdsa-validator.ts

@@ -1,5 +1,4 @@
 import {
-  getChain,
   getUserOperationHash,
   type Address,
   type Hex,
@@ -13,7 +12,7 @@ import { ECDSAValidatorAbi } from "../abis/ESCDAValidatorAbi.js";
 import { getChainId } from "../api/index.js";
 import { DUMMY_ECDSA_SIG } from "../constants.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
-import { fixSignedData } from "../utils.js";
+import { fixSignedData, getChain } from "../utils.js";
 
 export interface ECDSAValidatorParams extends KernelBaseValidatorParams {
   owner: SmartAccountSigner;

package/src/kernel-zerodev/validator/erc165-session-key-validator.ts

@@ -4,7 +4,6 @@ import {
   type Hex,
   type SmartAccountSigner,
   type UserOperationRequest,
-  getChain,
   type SignTypedDataParams,
 } from "@alchemy/aa-core";
 import {
@@ -17,7 +16,7 @@ import { ERC165SessionKeyValidatorAbi } from "../abis/ERC165SessionKeyValidatorA
 import { DUMMY_ECDSA_SIG } from "../constants.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
 import { getChainId } from "../api/index.js";
-import { fixSignedData } from "../utils.js";
+import { fixSignedData, getChain } from "../utils.js";
 
 export interface ERC165SessionKeyValidatorParams
   extends KernelBaseValidatorParams {

package/src/kernel-zerodev/validator/kill-switch-validator.ts

@@ -1,5 +1,4 @@
 import {
-  getChain,
   getUserOperationHash,
   type Address,
   type Hex,
@@ -26,7 +25,7 @@ import { KillSwitchValidatorAbi } from "../abis/KillSwitchValidatorAbi.js";
 import { getChainId } from "../api/index.js";
 import { DUMMY_ECDSA_SIG } from "../constants.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
-import { fixSignedData } from "../utils.js";
+import { fixSignedData, getChain } from "../utils.js";
 
 export interface KillSwitchValidatorParams extends KernelBaseValidatorParams {
   guardian: SmartAccountSigner;

package/src/kernel-zerodev/validator/recovery-validator.ts

@@ -1,5 +1,4 @@
 import {
-  getChain,
   type Address,
   type Hex,
   type SmartAccountSigner,
@@ -38,7 +37,7 @@ import {
   RECOVERY_VALIDATOR_ADDRESS,
 } from "../constants.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
-import { fixSignedData } from "../utils.js";
+import { fixSignedData, getChain } from "../utils.js";
 import type { EthereumProvider } from "./types.js";
 import { polygonMumbai } from "viem/chains";
 import { RecoveryActionAbi } from "../abis/RecoveryActionAbi.js";

package/src/kernel-zerodev/validator/session-key-validator.ts

@@ -4,7 +4,6 @@ import {
   type Hex,
   type SmartAccountSigner,
   type UserOperationRequest,
-  getChain,
   type SignTypedDataParams,
   type Abi,
 } from "@alchemy/aa-core";
@@ -35,7 +34,7 @@ import { DUMMY_ECDSA_SIG } from "../constants.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
 import { MerkleTree } from "merkletreejs";
 import { getChainId } from "../api/index.js";
-import { fixSignedData } from "../utils.js";
+import { fixSignedData, getChain } from "../utils.js";
 import type { GetAbiItemReturnType } from "viem/dist/types/utils/abi/getAbiItem.js";
 import { type AbiFunction } from "abitype";
 import type {

package/src/kernel-zerodev/validator-provider/base.ts

@@ -59,7 +59,8 @@ export abstract class ValidatorProvider<
   ) {
     let bundlerProvider = params.bundlerProvider;
     const shouldUsePaymaster =
-      params.usePaymaster === undefined || params.usePaymaster;
+      (params.usePaymaster === undefined || params.usePaymaster) &&
+      bundlerProvider !== "GELATO";
     if (
       params.opts?.paymasterConfig &&
       params.opts?.paymasterConfig.policy === "TOKEN_PAYMASTER" &&

package/src/kernel-zerodev/validator-provider/ecdsa-provider.ts

@@ -6,9 +6,9 @@ import {
   ECDSAValidator,
   type ECDSAValidatorParams,
 } from "../validator/ecdsa-validator.js";
-import { getChain } from "@alchemy/aa-core";
 import { getChainId } from "../api/index.js";
 import { polygonMumbai } from "viem/chains";
+import { getChain } from "../utils.js";
 
 export class ECDSAProvider extends ValidatorProvider<
   ECDSAValidator,

package/src/kernel-zerodev/validator-provider/erc165-session-key-provider.ts

@@ -6,10 +6,10 @@ import {
   ERC165SessionKeyValidator,
   type ERC165SessionKeyValidatorParams,
 } from "../validator/erc165-session-key-validator.js";
-import { getChain } from "@alchemy/aa-core";
 import { getChainId } from "../api/index.js";
 import { polygonMumbai } from "viem/chains";
 import { ERC165_SESSION_KEY_VALIDATOR_ADDRESS } from "../constants.js";
+import { getChain } from "../utils.js";
 
 export class ERC165SessionKeyProvider extends ValidatorProvider<
   ERC165SessionKeyValidator,

package/src/kernel-zerodev/validator-provider/kill-switch-provider.ts

@@ -6,10 +6,10 @@ import {
   KillSwitchValidator,
   type KillSwitchValidatorParams,
 } from "../validator/kill-switch-validator.js";
-import { getChain } from "@alchemy/aa-core";
 import { getChainId } from "../api/index.js";
 import { polygonMumbai } from "viem/chains";
 import { KILL_SWITCH_VALIDATOR_ADDRESS } from "../constants.js";
+import { getChain } from "../utils.js";
 
 export class KillSwitchProvider extends ValidatorProvider<
   KillSwitchValidator,

package/src/kernel-zerodev/validator-provider/recovery-provider.ts

@@ -7,11 +7,7 @@ import {
   type RecoveryConfig,
   type RecoveryValidatorParams,
 } from "../validator/recovery-validator.js";
-import {
-  getChain,
-  type Address,
-  type SendUserOperationResult,
-} from "@alchemy/aa-core";
+import { type Address, type SendUserOperationResult } from "@alchemy/aa-core";
 import {
   getChainId,
   getRecoveryData,
@@ -33,7 +29,7 @@ import {
 } from "viem";
 import { RecoveryActionAbi } from "../abis/RecoveryActionAbi.js";
 import { KernelAccountAbi } from "../abis/KernelAccountAbi.js";
-import { base64ToBytes, bytesToBase64 } from "../utils.js";
+import { base64ToBytes, bytesToBase64, getChain } from "../utils.js";
 
 export interface RecoveryProviderParams
   extends ExtendedValidatorProviderParams<RecoveryValidatorParams> {