@zyfai/sdk 0.2.37 → 0.2.39

package/dist/index.mjs

@@ -4,6 +4,7 @@ import axios from "axios";
 // src/config/endpoints.ts
 var API_ENDPOINT = "https://api.zyf.ai";
 var DATA_API_ENDPOINT = "https://defiapi.zyf.ai";
+var WS_ENDPOINT = "wss://defiapi.zyf.ai/ws/events";
 var API_VERSION = "/api/v1";
 var DATA_API_VERSION = "/api/v2";
 var ENDPOINTS = {
@@ -37,6 +38,21 @@ var ENDPOINTS = {
   SDK_TVL: "/data/sdk-tvl",
   // Agent Identity Registry
   AGENT_TOKEN_URI: "/users/me/agent-token-uri",
+  // Simulation
+  SIMULATE_BEST_POSITIONS: (params) => {
+    const networks = Array.isArray(params.networks) ? params.networks.join(",") : params.networks;
+    const query = [
+      `amount=${params.amount}`,
+      `token=${params.token}`,
+      `networks=${networks}`,
+      `strategy=${params.strategy}`
+    ];
+    if (params.minSplit !== void 0) query.push(`minSplit=${params.minSplit}`);
+    if (params.protocols?.length) query.push(`protocols=${params.protocols.join(",")}`);
+    if (params.pools?.length) query.push(`pools=${params.pools.join(",")}`);
+    if (params.userPositions?.length) query.push(`userPositions=${encodeURIComponent(JSON.stringify(params.userPositions))}`);
+    return `/simulate/best-positions?${query.join("&")}`;
+  },
   // Customization
   CUSTOMIZE_BATCH: "/customization/customize-batch",
   CUSTOMIZATION_POOLS: (protocolId, strategy) => `/customization/pools?protocolId=${protocolId}${strategy ? `&strategy=${strategy}` : ""}`,
@@ -433,6 +449,20 @@ var VAULT_ABI = [
 ];
 var VAULT_ADDRESS = "0xD580071c47d4a667858B5FafAb85BC9C609beC5D";
 
+// src/config/constants.ts
+var MIN_PORTFOLIO_BALANCE = {
+  1: {
+    USDC: 10000n * 10n ** 6n,
+    // 10,000 USDC (6 decimals)
+    WETH: 5n * 10n ** 18n
+    // 5 WETH (18 decimals)
+  }
+};
+var formatMinPortfolioLabel = (raw, decimals, symbol) => {
+  const whole = raw / 10n ** BigInt(decimals);
+  return `${whole.toString()} ${symbol}`;
+};
+
 // src/core/ZyfaiSDK.ts
 import { privateKeyToAccount } from "viem/accounts";
 import {
@@ -445,35 +475,14 @@ import {
 
 // src/config/chains.ts
 import { createPublicClient, http } from "viem";
-import { arbitrum, base } from "viem/chains";
-import { defineChain } from "viem";
-var plasma = defineChain({
-  id: 9745,
-  name: "Plasma",
-  nativeCurrency: {
-    decimals: 18,
-    name: "Plasma",
-    symbol: "PLSM"
-  },
-  rpcUrls: {
-    default: {
-      http: ["https://rpc.plasma.to"]
-    }
-  },
-  blockExplorers: {
-    default: {
-      name: "Plasma Explorer",
-      url: "https://explorer.plasma.io"
-    }
-  }
-});
+import { arbitrum, base, mainnet } from "viem/chains";
 var DEFAULT_TOKEN_ADDRESSES = {
+  1: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+  // USDC on Ethereum Mainnet
   8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
   // USDC on Base
-  42161: "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
+  42161: "0xaf88d065e77c8cc2239327c5edb3a432268e5831"
   // USDC on Arbitrum
-  9745: "0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb"
-  // USDT on Plasma
 };
 var ASSET_CONFIGS = {
   USDC: {
@@ -484,25 +493,23 @@ var ASSET_CONFIGS = {
     decimals: 6,
     tokenSymbols: ["USDC", "USDC.e", "USDT", "USDT0"],
     tokenSymbolsByChainId: {
+      1: "USDC",
       8453: "USDC",
       42161: "USDC",
-      9745: "USDT0",
       146: "USDC.e",
-      1: "USDC"
+      59144: "USDC"
     },
     addresses: {
+      1: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      // Ethereum
       8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
       // Base
       42161: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
       // Arbitrum
-      9745: "0xb8ce59fc3717ada4c02eadf9682a9e934f625ebb",
-      // Plasma
       146: "0x29219dd400f2bf60e5a23d13be72b486d4038894",
       // Sonic
-      59144: "0x176211869ca2b568f2a7d4ee941e073a821ee1ff",
+      59144: "0x176211869ca2b568f2a7d4ee941e073a821ee1ff"
       // Linea
-      1: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
-      // Ethereum
     },
     enabled: true
   },
@@ -514,26 +521,23 @@ var ASSET_CONFIGS = {
     decimals: 18,
     tokenSymbols: ["WETH", "ETH"],
     tokenSymbolsByChainId: {
+      1: "WETH",
       8453: "WETH",
       42161: "WETH",
-      9745: "WETH",
       146: "WETH",
-      59144: "WETH",
-      1: "WETH"
+      59144: "WETH"
     },
     addresses: {
+      1: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+      // Ethereum
       8453: "0x4200000000000000000000000000000000000006",
       // Base
       42161: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
       // Arbitrum
-      9745: "0x4200000000000000000000000000000000000006",
-      // Plasma
       146: "0x039e64f90d4199560e7533692f69448878db85c7",
       // Sonic
-      59144: "0xe5d7c2a44ffddf6b295a15c148167daaaf5cf34f",
+      59144: "0xe5d7c2a44ffddf6b295a15c148167daaaf5cf34f"
       // Linea
-      1: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
-      // Ethereum
     },
     enabled: true
   }
@@ -548,14 +552,14 @@ var getDefaultTokenAddress = (chainId, asset) => {
   return address;
 };
 var DEFAULT_RPC_URLS = {
+  1: "https://mainnet.infura.io/v3/8e6cdd06e30d40ac9990bf61bed3a3d0",
   8453: "https://mainnet.base.org",
-  42161: "https://arb1.arbitrum.io/rpc",
-  9745: "https://rpc.plasma.to"
+  42161: "https://arb1.arbitrum.io/rpc"
 };
 var CHAINS = {
+  1: mainnet,
   8453: base,
-  42161: arbitrum,
-  9745: plasma
+  42161: arbitrum
 };
 var getChainConfig = (chainId, rpcUrls) => {
   const chain = CHAINS[chainId];
@@ -1776,22 +1780,30 @@ var _ZyfaiSDK = class _ZyfaiSDK {
    * Deposit funds from EOA to Safe smart wallet
    * Transfers tokens from the connected wallet to the user's Safe and logs the deposit
    *
-   * Token is automatically selected based on chain:
-   * - Base (8453) and Arbitrum (42161): USDC
-   * - Plasma (9745): USDT
+   * Token is automatically selected based on chain (USDC by default):
+   * - Ethereum Mainnet (1), Base (8453), Arbitrum (42161)
+   *
+   * Minimum portfolio balance enforced (Safe balance + deposit amount),
+   * configured per-chain in `MIN_PORTFOLIO_BALANCE`:
+   * - Ethereum Mainnet (1): 5 USDC (test threshold)
+   * - Base (8453) & Arbitrum (42161): no minimum
+   *
+   * If no minimum is configured for a given (chainId, asset) pair,
+   * the check is skipped.
    *
    * @param userAddress - User's address (owner of the Safe)
    * @param chainId - Target chain ID
    * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
+   * @param asset - Optional asset symbol ("USDC" or "WETH"). Defaults to "USDC".
    * @returns Deposit response with transaction hash
    *
    * @example
    * ```typescript
-   * // Deposit 100 USDC (6 decimals) to Safe on Base
+   * // Deposit 10,000 USDC (6 decimals) to Safe on Base
    * const result = await sdk.depositFunds(
    *   "0xUser...",
    *   8453,
-   *   "100000000" // 100 USDC = 100 * 10^6
+   *   "10000000000" // 10,000 USDC = 10_000 * 10^6
    * );
    * ```
    */
@@ -1806,7 +1818,15 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       if (!amount || isNaN(Number(amount)) || Number(amount) <= 0) {
         throw new Error("Valid amount is required");
       }
-      const token = getDefaultTokenAddress(chainId, asset);
+      const assetSymbol = (asset || "USDC").toUpperCase();
+      const assetConfig = ASSET_CONFIGS[assetSymbol];
+      if (!assetConfig) {
+        throw new Error(
+          `Unsupported asset: ${assetSymbol}. Supported: USDC, WETH.`
+        );
+      }
+      const minRequired = MIN_PORTFOLIO_BALANCE[chainId]?.[assetSymbol];
+      const token = getDefaultTokenAddress(chainId, assetSymbol);
       const walletClient = this.getWalletClient();
       const chainConfig = getChainConfig(chainId, this.rpcUrls);
       const safeAddress = await getDeterministicSafeAddress({
@@ -1824,6 +1844,25 @@ var _ZyfaiSDK = class _ZyfaiSDK {
         );
       }
       const amountBigInt = BigInt(amount);
+      if (minRequired !== void 0) {
+        const currentSafeBalance = await chainConfig.publicClient.readContract({
+          address: token,
+          abi: ERC20_ABI,
+          functionName: "balanceOf",
+          args: [safeAddress]
+        });
+        const totalAfterDeposit = currentSafeBalance + amountBigInt;
+        if (totalAfterDeposit < minRequired) {
+          const minLabel = formatMinPortfolioLabel(
+            minRequired,
+            assetConfig.decimals,
+            assetSymbol
+          );
+          throw new Error(
+            `Minimum portfolio balance not met on chain ${chainId}. Total portfolio must be at least ${minLabel}. Current Safe balance: ${currentSafeBalance.toString()}, deposit amount: ${amountBigInt.toString()}, total after deposit: ${totalAfterDeposit.toString()} (raw units, ${assetConfig.decimals} decimals).`
+          );
+        }
+      }
       const txHash = await walletClient.writeContract({
         address: token,
         abi: ERC20_ABI,
@@ -1871,8 +1910,7 @@ var _ZyfaiSDK = class _ZyfaiSDK {
    * - Need more control over transaction execution
    *
    * Token is automatically selected based on chain if not provided:
-   * - Base (8453) and Arbitrum (42161): USDC
-   * - Plasma (9745): USDT
+   * - Ethereum Mainnet (1), Base (8453), Arbitrum (42161): USDC by default
    *
    * @param chainId - Chain ID where the deposit was made
    * @param txHash - Transaction hash of the deposit
@@ -3049,6 +3087,54 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       );
     }
   }
+  // ============================================================================
+  // Simulation
+  // ============================================================================
+  /**
+   * Simulate the best yield positions for a given amount, splitting it across
+   * the top-ranked pools (up to minSplit positions) for the requested chains/strategy.
+   *
+   * Returns ready-to-execute calldata (approve + deposit) per position. The deposit
+   * calldata contains a "<RECEIVER>" placeholder that must be replaced with the
+   * actual receiving address (e.g. the user's Safe) before sending the transaction.
+   *
+   * @param params - Simulation parameters
+   * @returns Chain-keyed map of simulated positions with calldata
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.simulateBestPositions({
+   *   amount: 3000,
+   *   token: "USDC",
+   *   networks: 8453,
+   *   strategy: "conservative",
+   *   minSplit: 3,
+   *   protocols: ["aave", "compound", "morpho"],
+   * });
+   * console.log(result.data["8453"]);
+   * ```
+   */
+  async simulateBestPositions(params) {
+    try {
+      if (!isValidPublicStrategy(params.strategy)) {
+        throw new Error(
+          `Invalid strategy: ${params.strategy}. Must be "conservative" or "aggressive".`
+        );
+      }
+      const internalStrategy = toInternalStrategy(params.strategy);
+      const response = await this.httpClient.get(
+        ENDPOINTS.SIMULATE_BEST_POSITIONS({
+          ...params,
+          strategy: internalStrategy
+        })
+      );
+      return response;
+    } catch (error) {
+      throw new Error(
+        `Failed to simulate best positions: ${error.message}`
+      );
+    }
+  }
   /**
    * Get currently selected pools for a protocol on a specific chain.
    *
@@ -3491,6 +3577,78 @@ var _ZyfaiSDK = class _ZyfaiSDK {
       symbol: tokenSymbol
     };
   }
+  // ============================================================================
+  // WebSocket Event Stream
+  // ============================================================================
+  /**
+   * Subscribe to real-time Zyfai risk and liquidity events via WebSocket.
+   *
+   * Events: depeg, liquidity_trap, liquidity_restored, pool_status_change,
+   * new_collateral_detected, liquidity_drop.
+   *
+   * @param handlers - Callback per event type, plus onError
+   * @param filters - Optional protocol/pool filter sent to the server on subscribe
+   * @returns Cleanup function — call it to close the connection
+   *
+   * @example
+   * ```typescript
+   * const unsubscribe = sdk.subscribeToEvents(
+   *   {
+   *     onDepeg: (data) => console.log("Depeg detected:", data.token, data.severity),
+   *     onLiquidityDrop: (data) => console.log("Liquidity drop:", data.pool, data.dropPercent),
+   *   },
+   *   { protocols: ["morpho"], pools: ["gauntlet usdc core"] }
+   * );
+   *
+   * // Later, close the connection:
+   * unsubscribe();
+   * ```
+   */
+  subscribeToEvents(handlers, filters) {
+    let ws = null;
+    let closed = false;
+    const connect = () => {
+      ws = new globalThis.WebSocket(WS_ENDPOINT);
+      ws.onopen = () => {
+        const msg = { type: "subscribe" };
+        if (filters && (filters.chains?.length || filters.protocols?.length || filters.pools?.length)) {
+          msg.filters = filters;
+        }
+        ws.send(JSON.stringify(msg));
+      };
+      ws.onmessage = (event) => {
+        try {
+          const msg = JSON.parse(event.data);
+          if (msg.type !== "event") return;
+          switch (msg.eventType) {
+            case "depeg":
+              handlers.onDepeg?.(msg.data);
+              break;
+            case "new_collateral_detected":
+              handlers.onNewCollateralDetected?.(msg.data);
+              break;
+            case "liquidity_drop":
+              handlers.onLiquidityDrop?.(msg.data);
+              break;
+          }
+        } catch {
+        }
+      };
+      ws.onerror = (error) => {
+        handlers.onError?.(error);
+      };
+      ws.onclose = () => {
+        if (!closed) {
+          setTimeout(connect, 3e3);
+        }
+      };
+    };
+    connect();
+    return () => {
+      closed = true;
+      ws?.close();
+    };
+  }
 };
 // ============================================================================
 // Agent Identity Registry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.2.37",
+  "version": "0.2.39",
   "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",