@zyfai/sdk 0.1.22 → 0.1.24

package/README.md

@@ -29,7 +29,7 @@ pnpm add @zyfai/sdk viem
 2. **Bundler API Key**: Required for Safe deployment. Get it from:
    - [Pimlico](https://www.pimlico.io/) (Recommended)
 
-**Get your API key from [ZyFAI Dashboard](https://app.zyf.ai)**
+**Get your API key from [ZyFAI Dashboard](https://sdk.zyf.ai)**
 
 ## Quick Start
 
@@ -177,6 +177,10 @@ new ZyfaiSDK(config: SDKConfig | string)
     - `apiKey` (string): Your ZyFAI API key (required)
     - `environment` ('production' | 'staging', optional): API environment (default: 'production')
     - `bundlerApiKey` (string, optional): Bundler API key for Safe deployment (required for deploySafe)
+    - `rpcUrls` (object, optional): Custom RPC URLs per chain to avoid rate limiting
+      - `8453` (string, optional): Base Mainnet RPC URL
+      - `42161` (string, optional): Arbitrum One RPC URL
+      - `9745` (string, optional): Plasma Mainnet RPC URL
 
 **Examples:**
 
@@ -190,6 +194,18 @@ const sdk = new ZyfaiSDK({
   bundlerApiKey: "your-bundler-api-key",
   environment: "production",
 });
+
+// Option 3: With custom RPC URLs (recommended to avoid rate limiting)
+const sdk = new ZyfaiSDK({
+  apiKey: "your-api-key",
+  bundlerApiKey: "your-bundler-api-key",
+  environment: "production",
+  rpcUrls: {
+    8453: "https://base-mainnet.g.alchemy.com/v2/YOUR_API_KEY", // Base
+    42161: "https://arb-mainnet.g.alchemy.com/v2/YOUR_API_KEY", // Arbitrum
+    9745: "https://your-plasma-rpc-provider.com", // Plasma
+  },
+});
 ```
 
 #### Methods

package/dist/index.d.mts

@@ -6,13 +6,16 @@ import { Chain, PublicClient } from 'viem';
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
 type Environment = "staging" | "production";
+interface RpcUrlsConfig {
+    8453?: string;
+    42161?: string;
+    9745?: string;
+}
 interface SDKConfig {
-    /** API key for both Execution API and Data API */
     apiKey: string;
-    /** Environment: 'staging' or 'production' (default: 'production') */
     environment?: Environment;
-    /** Bundler API key for Safe deployment (e.g., Pimlico) */
     bundlerApiKey?: string;
+    rpcUrls?: RpcUrlsConfig;
 }
 interface DeploySafeResponse {
     success: boolean;
@@ -388,9 +391,12 @@ interface ChainConfig {
 declare const DEFAULT_TOKEN_ADDRESSES: Record<SupportedChainId, string>;
 declare const getDefaultTokenAddress: (chainId: SupportedChainId) => string;
 /**
- * Get chain configuration for a given chain ID
+ * Get chain configuration for a given chain ID.
+ *
+ * @param chainId - Supported chain ID
+ * @param rpcUrls - Optional per-chain RPC URL overrides
  */
-declare const getChainConfig: (chainId: SupportedChainId) => ChainConfig;
+declare const getChainConfig: (chainId: SupportedChainId, rpcUrls?: RpcUrlsConfig) => ChainConfig;
 /**
  * Check if a chain ID is supported
  */
@@ -414,6 +420,7 @@ declare class ZyfaiSDK {
     private environment;
     private currentProvider;
     private currentChainId;
+    private rpcUrls?;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token

package/dist/index.d.ts

@@ -6,13 +6,16 @@ import { Chain, PublicClient } from 'viem';
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
 type Environment = "staging" | "production";
+interface RpcUrlsConfig {
+    8453?: string;
+    42161?: string;
+    9745?: string;
+}
 interface SDKConfig {
-    /** API key for both Execution API and Data API */
     apiKey: string;
-    /** Environment: 'staging' or 'production' (default: 'production') */
     environment?: Environment;
-    /** Bundler API key for Safe deployment (e.g., Pimlico) */
     bundlerApiKey?: string;
+    rpcUrls?: RpcUrlsConfig;
 }
 interface DeploySafeResponse {
     success: boolean;
@@ -388,9 +391,12 @@ interface ChainConfig {
 declare const DEFAULT_TOKEN_ADDRESSES: Record<SupportedChainId, string>;
 declare const getDefaultTokenAddress: (chainId: SupportedChainId) => string;
 /**
- * Get chain configuration for a given chain ID
+ * Get chain configuration for a given chain ID.
+ *
+ * @param chainId - Supported chain ID
+ * @param rpcUrls - Optional per-chain RPC URL overrides
  */
-declare const getChainConfig: (chainId: SupportedChainId) => ChainConfig;
+declare const getChainConfig: (chainId: SupportedChainId, rpcUrls?: RpcUrlsConfig) => ChainConfig;
 /**
  * Check if a chain ID is supported
  */
@@ -414,6 +420,7 @@ declare class ZyfaiSDK {
     private environment;
     private currentProvider;
     private currentChainId;
+    private rpcUrls?;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token

package/dist/index.js

@@ -411,12 +411,12 @@ var CHAINS = {
   42161: import_chains.arbitrum,
   9745: plasma
 };
-var getChainConfig = (chainId) => {
+var getChainConfig = (chainId, rpcUrls) => {
   const chain = CHAINS[chainId];
   if (!chain) {
     throw new Error(`Unsupported chain ID: ${chainId}`);
   }
-  const rpcUrl = DEFAULT_RPC_URLS[chainId];
+  const rpcUrl = rpcUrls && rpcUrls[chainId] || DEFAULT_RPC_URLS[chainId];
   const publicClient = (0, import_viem.createPublicClient)({
     chain,
     transport: (0, import_viem.http)(rpcUrl)
@@ -819,25 +819,25 @@ var signSessionKey = async (config, sessions, allPublicClients, signingParams) =
 // src/core/ZyfaiSDK.ts
 var import_siwe = require("siwe");
 var ZyfaiSDK = class {
-  // Store current chain ID for private key connections
+  // Optional custom RPC URLs per chain
   constructor(config) {
     this.signer = null;
     this.walletClient = null;
     this.authenticatedUserId = null;
     // If non-null, user is authenticated
     this.hasActiveSessionKey = false;
-    // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
     this.currentProvider = null;
     // Store reference to current provider for event handling
     this.currentChainId = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
-    const { apiKey, environment, bundlerApiKey } = sdkConfig;
+    const { apiKey, environment, bundlerApiKey, rpcUrls } = sdkConfig;
     if (!apiKey) {
       throw new Error("API key is required");
     }
     this.environment = environment || "production";
     this.httpClient = new HttpClient(apiKey, this.environment);
     this.bundlerApiKey = bundlerApiKey;
+    this.rpcUrls = rpcUrls;
   }
   /**
    * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -995,7 +995,8 @@ var ZyfaiSDK = class {
     this.httpClient.clearAuthToken();
     if (this.walletClient && this.currentProvider) {
       const chainConfig = getChainConfig(
-        this.walletClient.chain?.id || 8453
+        this.walletClient.chain?.id || 8453,
+        this.rpcUrls
       );
       this.walletClient = (0, import_viem4.createWalletClient)({
         account: newAddress,
@@ -1043,7 +1044,7 @@ var ZyfaiSDK = class {
       } catch (error) {
       }
     }
-    const chainConfig = getChainConfig(chainId);
+    const chainConfig = getChainConfig(chainId, this.rpcUrls);
     let connectedAddress;
     if (typeof account === "string") {
       let privateKey = account;
@@ -1134,10 +1135,14 @@ var ZyfaiSDK = class {
   getWalletClient(chainId) {
     if (this.signer) {
       const targetChainId = chainId || this.currentChainId || 8453;
+      const targetChainConfig = getChainConfig(
+        targetChainId,
+        this.rpcUrls
+      );
       return (0, import_viem4.createWalletClient)({
         account: this.signer,
-        chain: getChainConfig(targetChainId).chain,
-        transport: (0, import_viem4.http)(getChainConfig(targetChainId).rpcUrl)
+        chain: targetChainConfig.chain,
+        transport: (0, import_viem4.http)(targetChainConfig.rpcUrl)
       });
     } else {
       if (!this.walletClient) {
@@ -1161,7 +1166,7 @@ var ZyfaiSDK = class {
     if (!isSupportedChain(chainId)) {
       throw new Error(`Unsupported chain ID: ${chainId}`);
     }
-    const chainConfig = getChainConfig(chainId);
+    const chainConfig = getChainConfig(chainId, this.rpcUrls);
     try {
       const smartWalletInfo = await this.getSmartWalletByEOA(userAddress);
       if (smartWalletInfo.smartWallet) {
@@ -1214,7 +1219,7 @@ var ZyfaiSDK = class {
         );
       }
       const walletClient = this.getWalletClient(chainId);
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const safeAddress = await getDeterministicSafeAddress({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1333,7 +1338,7 @@ var ZyfaiSDK = class {
           (action) => action.actionTarget === DEFAULT_ACTION_TARGET && action.actionTargetSelector === DEFAULT_ACTION_SELECTOR
         )
       );
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const accountType = await getAccountType(
         userAddress,
         chainConfig.publicClient
@@ -1387,7 +1392,7 @@ var ZyfaiSDK = class {
         throw new Error("At least one session configuration is required");
       }
       const walletClient = this.getWalletClient();
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const accountType = await getAccountType(
         userAddress,
         chainConfig.publicClient
@@ -1400,7 +1405,7 @@ var ZyfaiSDK = class {
       const sessionChainIds = [
         ...new Set(sessions.map((s) => Number(s.chainId)))
       ];
-      const allPublicClients = sessionChainIds.filter(isSupportedChain).map((id) => getChainConfig(id).publicClient);
+      const allPublicClients = sessionChainIds.filter(isSupportedChain).map((id) => getChainConfig(id, this.rpcUrls).publicClient);
       const { signature, sessionNonces } = await signSessionKey(
         {
           owner: walletClient,
@@ -1523,7 +1528,7 @@ var ZyfaiSDK = class {
       }
       const token = getDefaultTokenAddress(chainId);
       const walletClient = this.getWalletClient();
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const safeAddress = await getDeterministicSafeAddress({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1598,7 +1603,7 @@ var ZyfaiSDK = class {
       if (!isSupportedChain(chainId)) {
         throw new Error(`Unsupported chain ID: ${chainId}`);
       }
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       let safeAddress;
       try {
         const smartWalletInfo = await this.getSmartWalletByEOA(userAddress);

package/dist/index.mjs

@@ -375,12 +375,12 @@ var CHAINS = {
   42161: arbitrum,
   9745: plasma
 };
-var getChainConfig = (chainId) => {
+var getChainConfig = (chainId, rpcUrls) => {
   const chain = CHAINS[chainId];
   if (!chain) {
     throw new Error(`Unsupported chain ID: ${chainId}`);
   }
-  const rpcUrl = DEFAULT_RPC_URLS[chainId];
+  const rpcUrl = rpcUrls && rpcUrls[chainId] || DEFAULT_RPC_URLS[chainId];
   const publicClient = createPublicClient({
     chain,
     transport: http(rpcUrl)
@@ -804,25 +804,25 @@ var signSessionKey = async (config, sessions, allPublicClients, signingParams) =
 // src/core/ZyfaiSDK.ts
 import { SiweMessage } from "siwe";
 var ZyfaiSDK = class {
-  // Store current chain ID for private key connections
+  // Optional custom RPC URLs per chain
   constructor(config) {
     this.signer = null;
     this.walletClient = null;
     this.authenticatedUserId = null;
     // If non-null, user is authenticated
     this.hasActiveSessionKey = false;
-    // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
     this.currentProvider = null;
     // Store reference to current provider for event handling
     this.currentChainId = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
-    const { apiKey, environment, bundlerApiKey } = sdkConfig;
+    const { apiKey, environment, bundlerApiKey, rpcUrls } = sdkConfig;
     if (!apiKey) {
       throw new Error("API key is required");
     }
     this.environment = environment || "production";
     this.httpClient = new HttpClient(apiKey, this.environment);
     this.bundlerApiKey = bundlerApiKey;
+    this.rpcUrls = rpcUrls;
   }
   /**
    * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -980,7 +980,8 @@ var ZyfaiSDK = class {
     this.httpClient.clearAuthToken();
     if (this.walletClient && this.currentProvider) {
       const chainConfig = getChainConfig(
-        this.walletClient.chain?.id || 8453
+        this.walletClient.chain?.id || 8453,
+        this.rpcUrls
       );
       this.walletClient = createWalletClient({
         account: newAddress,
@@ -1028,7 +1029,7 @@ var ZyfaiSDK = class {
       } catch (error) {
       }
     }
-    const chainConfig = getChainConfig(chainId);
+    const chainConfig = getChainConfig(chainId, this.rpcUrls);
     let connectedAddress;
     if (typeof account === "string") {
       let privateKey = account;
@@ -1119,10 +1120,14 @@ var ZyfaiSDK = class {
   getWalletClient(chainId) {
     if (this.signer) {
       const targetChainId = chainId || this.currentChainId || 8453;
+      const targetChainConfig = getChainConfig(
+        targetChainId,
+        this.rpcUrls
+      );
       return createWalletClient({
         account: this.signer,
-        chain: getChainConfig(targetChainId).chain,
-        transport: http3(getChainConfig(targetChainId).rpcUrl)
+        chain: targetChainConfig.chain,
+        transport: http3(targetChainConfig.rpcUrl)
       });
     } else {
       if (!this.walletClient) {
@@ -1146,7 +1151,7 @@ var ZyfaiSDK = class {
     if (!isSupportedChain(chainId)) {
       throw new Error(`Unsupported chain ID: ${chainId}`);
     }
-    const chainConfig = getChainConfig(chainId);
+    const chainConfig = getChainConfig(chainId, this.rpcUrls);
     try {
       const smartWalletInfo = await this.getSmartWalletByEOA(userAddress);
       if (smartWalletInfo.smartWallet) {
@@ -1199,7 +1204,7 @@ var ZyfaiSDK = class {
         );
       }
       const walletClient = this.getWalletClient(chainId);
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const safeAddress = await getDeterministicSafeAddress({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1318,7 +1323,7 @@ var ZyfaiSDK = class {
           (action) => action.actionTarget === DEFAULT_ACTION_TARGET && action.actionTargetSelector === DEFAULT_ACTION_SELECTOR
         )
       );
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const accountType = await getAccountType(
         userAddress,
         chainConfig.publicClient
@@ -1372,7 +1377,7 @@ var ZyfaiSDK = class {
         throw new Error("At least one session configuration is required");
       }
       const walletClient = this.getWalletClient();
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const accountType = await getAccountType(
         userAddress,
         chainConfig.publicClient
@@ -1385,7 +1390,7 @@ var ZyfaiSDK = class {
       const sessionChainIds = [
         ...new Set(sessions.map((s) => Number(s.chainId)))
       ];
-      const allPublicClients = sessionChainIds.filter(isSupportedChain).map((id) => getChainConfig(id).publicClient);
+      const allPublicClients = sessionChainIds.filter(isSupportedChain).map((id) => getChainConfig(id, this.rpcUrls).publicClient);
       const { signature, sessionNonces } = await signSessionKey(
         {
           owner: walletClient,
@@ -1508,7 +1513,7 @@ var ZyfaiSDK = class {
       }
       const token = getDefaultTokenAddress(chainId);
       const walletClient = this.getWalletClient();
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const safeAddress = await getDeterministicSafeAddress({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1583,7 +1588,7 @@ var ZyfaiSDK = class {
       if (!isSupportedChain(chainId)) {
         throw new Error(`Unsupported chain ID: ${chainId}`);
       }
-      const chainConfig = getChainConfig(chainId);
+      const chainConfig = getChainConfig(chainId, this.rpcUrls);
       let safeAddress;
       try {
         const smartWalletInfo = await this.getSmartWalletByEOA(userAddress);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "description": "TypeScript SDK for ZyFAI Yield Optimization Engine - Deploy Safe smart wallets, manage session keys, and interact with DeFi protocols",
   "main": "dist/index.js",
   "module": "dist/index.mjs",