@zyfai/sdk 0.1.30 → 0.2.0

package/README.md

@@ -112,11 +112,11 @@ const walletInfo = await sdk.getSmartWalletAddress(userAddress, 8453);
 console.log("Safe Address:", walletInfo.address);
 console.log("Is Deployed:", walletInfo.isDeployed);
 
-// Deploy the Safe with default safe strategy (automatically checks if already deployed)
+// Deploy the Safe with default conservative strategy (automatically checks if already deployed)
 const result = await sdk.deploySafe(userAddress, 8453);
 
-// Or deploy with degen strategy (yieldor)
-const degenResult = await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+// Or deploy with aggressive strategy
+const aggressiveResult = await sdk.deploySafe(userAddress, 8453, "aggressive");
 
 if (result.success) {
   console.log("Safe Address:", result.safeAddress);
@@ -129,8 +129,8 @@ if (result.success) {
 
 **Strategy Options:**
 
-- `"safe_strategy"` (default): Low-risk, stable yield strategy
-- `"degen_strategy"`: High-risk, high-reward strategy (also known as "yieldor" on the frontend)
+- `"conservative"` (default): Low-risk, stable yield strategy
+- `"aggressive"`: High-risk, high-reward strategy
 
 ### 2. Multi-Chain Support
 
@@ -280,9 +280,9 @@ Deploy a Safe smart wallet for a user. **Deployment is handled by the backend AP
 
 - `userAddress`: User's EOA address
 - `chainId`: Target chain ID
-- `strategy`: Optional strategy selection (default: `"safe_strategy"`)
-  - `"safe_strategy"`: Low-risk, stable yield strategy (default)
-  - `"degen_strategy"`: High-risk, high-reward strategy (also known as "yieldor" on the frontend)
+- `strategy`: Optional strategy selection (default: `"conservative"`)
+  - `"conservative"`: Low-risk, stable yield strategy (default)
+  - `"aggressive"`: High-risk, high-reward strategy
 
 **Returns:**
 
@@ -602,7 +602,7 @@ degenStrats.data.forEach((s) => {
 
 ```typescript
 // Get same-chain rebalances
-const apyPerStrategy = await sdk.getAPYPerStrategy(false, "7D", "safe");
+const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
 console.log("APY per strategy:", apyPerStrategy.data);
 ```
 
@@ -712,11 +712,11 @@ async function main() {
     return;
   }
 
-  // Deploy Safe with default safe strategy
+  // Deploy Safe with default conservative strategy
   const result = await sdk.deploySafe(userAddress, 8453);
 
-  // Or deploy with degen strategy (yieldor)
-  // const result = await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+  // Or deploy with aggressive strategy
+  // const result = await sdk.deploySafe(userAddress, 8453, "aggressive");
 
   if (result.success) {
     console.log("✅ Successfully deployed Safe");

package/dist/index.d.mts

@@ -5,7 +5,7 @@ import { Chain, PublicClient } from 'viem';
  */
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
-type Strategy = "safe_strategy" | "degen_strategy";
+type Strategy = "conservative" | "aggressive";
 interface RpcUrlsConfig {
     8453?: string;
     42161?: string;
@@ -305,13 +305,13 @@ interface Opportunity {
     tvl?: number;
     asset?: string;
     risk?: string;
-    strategyType: "safe" | "degen";
+    strategyType: "conservative" | "aggressive";
     status?: string;
 }
 interface OpportunitiesResponse {
     success: boolean;
     chainId?: number;
-    strategyType: "safe" | "degen";
+    strategyType: "conservative" | "aggressive";
     data: Opportunity[];
 }
 interface DailyApyEntry {
@@ -513,16 +513,16 @@ declare class ZyfaiSDK {
      *
      * @param userAddress - User's EOA address (the connected EOA, not the smart wallet address)
      * @param chainId - Target chain ID
-     * @param strategy - Optional strategy selection: "safe_strategy" (default) or "degen_strategy" (yieldor)
+     * @param strategy - Optional strategy selection: "conservative" (default) or "aggressive"
      * @returns Deployment response with Safe address and transaction hash
      *
      * @example
      * ```typescript
-     * // Deploy with default safe strategy
+     * // Deploy with default conservative strategy
      * await sdk.deploySafe(userAddress, 8453);
      *
-     * // Deploy with degen strategy (yieldor)
-     * await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+     * // Deploy with aggressive strategy
+     * await sdk.deploySafe(userAddress, 8453, "aggressive");
      * ```
      */
     deploySafe(userAddress: string, chainId: SupportedChainId, strategy?: Strategy): Promise<DeploySafeResponse>;
@@ -676,17 +676,17 @@ declare class ZyfaiSDK {
      * Get APY per strategy for a specific chain
      *
      * @param crossChain - Whether to get cross-chain APY (true = omni account, false = simple account)
-     * @param days - Time period: "7D", "14D", or "30D"
-     * @param strategyType - Strategy type: "safe" or "degen"
+     * @param days - Time period: 7, 14, or 30
+     * @param strategy - Strategy type: "conservative" (default) or "aggressive"
      * @returns APY per strategy for a specific chain
      *
      * @example
      * ```typescript
-     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, "7D", "safe");
+     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
      * console.log("APY per strategy per chain:", apyPerStrategy.data);
      * ```
      */
-    getAPYPerStrategy(crossChain?: boolean, days?: string, strategyType?: string): Promise<APYPerStrategyResponse>;
+    getAPYPerStrategy(crossChain?: boolean, days?: number, strategy?: Strategy): Promise<APYPerStrategyResponse>;
     /**
      * Get total volume across all Zyfai accounts
      *
@@ -816,10 +816,10 @@ declare class ZyfaiSDK {
      */
     getDebankPortfolio(walletAddress: string): Promise<DebankPortfolioResponse>;
     /**
-     * Get safe (low-risk) yield opportunities
+     * Get conservative (low-risk) yield opportunities
      *
      * @param chainId - Optional chain ID filter
-     * @returns List of safe yield opportunities
+     * @returns List of conservative yield opportunities
      *
      * @example
      * ```typescript
@@ -829,10 +829,10 @@ declare class ZyfaiSDK {
      */
     getSafeOpportunities(chainId?: number): Promise<OpportunitiesResponse>;
     /**
-     * Get degen (high-risk, high-reward) yield strategies
+     * Get aggressive (high-risk, high-reward) yield strategies
      *
      * @param chainId - Optional chain ID filter
-     * @returns List of degen strategies
+     * @returns List of aggressive strategies
      *
      * @example
      * ```typescript

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { Chain, PublicClient } from 'viem';
  */
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
-type Strategy = "safe_strategy" | "degen_strategy";
+type Strategy = "conservative" | "aggressive";
 interface RpcUrlsConfig {
     8453?: string;
     42161?: string;
@@ -305,13 +305,13 @@ interface Opportunity {
     tvl?: number;
     asset?: string;
     risk?: string;
-    strategyType: "safe" | "degen";
+    strategyType: "conservative" | "aggressive";
     status?: string;
 }
 interface OpportunitiesResponse {
     success: boolean;
     chainId?: number;
-    strategyType: "safe" | "degen";
+    strategyType: "conservative" | "aggressive";
     data: Opportunity[];
 }
 interface DailyApyEntry {
@@ -513,16 +513,16 @@ declare class ZyfaiSDK {
      *
      * @param userAddress - User's EOA address (the connected EOA, not the smart wallet address)
      * @param chainId - Target chain ID
-     * @param strategy - Optional strategy selection: "safe_strategy" (default) or "degen_strategy" (yieldor)
+     * @param strategy - Optional strategy selection: "conservative" (default) or "aggressive"
      * @returns Deployment response with Safe address and transaction hash
      *
      * @example
      * ```typescript
-     * // Deploy with default safe strategy
+     * // Deploy with default conservative strategy
      * await sdk.deploySafe(userAddress, 8453);
      *
-     * // Deploy with degen strategy (yieldor)
-     * await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+     * // Deploy with aggressive strategy
+     * await sdk.deploySafe(userAddress, 8453, "aggressive");
      * ```
      */
     deploySafe(userAddress: string, chainId: SupportedChainId, strategy?: Strategy): Promise<DeploySafeResponse>;
@@ -676,17 +676,17 @@ declare class ZyfaiSDK {
      * Get APY per strategy for a specific chain
      *
      * @param crossChain - Whether to get cross-chain APY (true = omni account, false = simple account)
-     * @param days - Time period: "7D", "14D", or "30D"
-     * @param strategyType - Strategy type: "safe" or "degen"
+     * @param days - Time period: 7, 14, or 30
+     * @param strategy - Strategy type: "conservative" (default) or "aggressive"
      * @returns APY per strategy for a specific chain
      *
      * @example
      * ```typescript
-     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, "7D", "safe");
+     * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
      * console.log("APY per strategy per chain:", apyPerStrategy.data);
      * ```
      */
-    getAPYPerStrategy(crossChain?: boolean, days?: string, strategyType?: string): Promise<APYPerStrategyResponse>;
+    getAPYPerStrategy(crossChain?: boolean, days?: number, strategy?: Strategy): Promise<APYPerStrategyResponse>;
     /**
      * Get total volume across all Zyfai accounts
      *
@@ -816,10 +816,10 @@ declare class ZyfaiSDK {
      */
     getDebankPortfolio(walletAddress: string): Promise<DebankPortfolioResponse>;
     /**
-     * Get safe (low-risk) yield opportunities
+     * Get conservative (low-risk) yield opportunities
      *
      * @param chainId - Optional chain ID filter
-     * @returns List of safe yield opportunities
+     * @returns List of conservative yield opportunities
      *
      * @example
      * ```typescript
@@ -829,10 +829,10 @@ declare class ZyfaiSDK {
      */
     getSafeOpportunities(chainId?: number): Promise<OpportunitiesResponse>;
     /**
-     * Get degen (high-risk, high-reward) yield strategies
+     * Get aggressive (high-risk, high-reward) yield strategies
      *
      * @param chainId - Optional chain ID filter
-     * @returns List of degen strategies
+     * @returns List of aggressive strategies
      *
      * @example
      * ```typescript

package/dist/index.js

@@ -94,7 +94,7 @@ var DATA_ENDPOINTS = {
   // Rebalance
   REBALANCE_INFO: (isCrossChain) => isCrossChain !== void 0 ? `/rebalance/rebalance-info?isCrossChain=${isCrossChain}` : "/rebalance/rebalance-info",
   // APY Per Strategy
-  APY_PER_STRATEGY: (isCrossChain = false, days = "7D", strategyType = "safe") => `/rebalance/rebalance-info?isCrossChain=${isCrossChain}&days=${days}&strategyType=${strategyType}`
+  APY_PER_STRATEGY: (isCrossChain = false, days = 7, strategy = "safe") => `/rebalance/rebalance-info?isCrossChain=${isCrossChain}&days=${days}&strategy=${strategy}`
 };
 
 // src/utils/http-client.ts
@@ -624,6 +624,20 @@ var signSessionKey = async (config, sessions, allPublicClients, signingParams) =
   };
 };
 
+// src/utils/strategy.ts
+function toInternalStrategy(publicStrategy) {
+  switch (publicStrategy) {
+    case "conservative":
+      return "safe_strategy";
+    case "aggressive":
+      return "degen_strategy";
+    default:
+      throw new Error(
+        `Invalid public strategy: ${publicStrategy}. Must be "conservative" or "aggressive".`
+      );
+  }
+}
+
 // src/core/ZyfaiSDK.ts
 var import_siwe = require("siwe");
 var ZyfaiSDK = class {
@@ -1005,16 +1019,16 @@ var ZyfaiSDK = class {
    *
    * @param userAddress - User's EOA address (the connected EOA, not the smart wallet address)
    * @param chainId - Target chain ID
-   * @param strategy - Optional strategy selection: "safe_strategy" (default) or "degen_strategy" (yieldor)
+   * @param strategy - Optional strategy selection: "conservative" (default) or "aggressive"
    * @returns Deployment response with Safe address and transaction hash
    *
    * @example
    * ```typescript
-   * // Deploy with default safe strategy
+   * // Deploy with default conservative strategy
    * await sdk.deploySafe(userAddress, 8453);
    *
-   * // Deploy with degen strategy (yieldor)
-   * await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+   * // Deploy with aggressive strategy
+   * await sdk.deploySafe(userAddress, 8453, "aggressive");
    * ```
    */
   async deploySafe(userAddress, chainId, strategy) {
@@ -1057,6 +1071,7 @@ var ZyfaiSDK = class {
           status: "deployed"
         };
       }
+      const internalStrategy = strategy ? toInternalStrategy(strategy) : "safe_strategy";
       const deploymentResult = await deploySafeAccount({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1064,7 +1079,7 @@ var ZyfaiSDK = class {
         publicClient: chainConfig.publicClient,
         chainId,
         httpClient: this.httpClient,
-        strategy: strategy || "safe_strategy"
+        strategy: internalStrategy
       });
       try {
         await this.initializeUser(deploymentResult.safeAddress, chainId);
@@ -1621,19 +1636,23 @@ var ZyfaiSDK = class {
    * Get APY per strategy for a specific chain
    *
    * @param crossChain - Whether to get cross-chain APY (true = omni account, false = simple account)
-   * @param days - Time period: "7D", "14D", or "30D"
-   * @param strategyType - Strategy type: "safe" or "degen"
+   * @param days - Time period: 7, 14, or 30
+   * @param strategy - Strategy type: "conservative" (default) or "aggressive"
    * @returns APY per strategy for a specific chain
    *
    * @example
    * ```typescript
-   * const apyPerStrategy = await sdk.getAPYPerStrategy(false, "7D", "safe");
+   * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
    * console.log("APY per strategy per chain:", apyPerStrategy.data);
    * ```
    */
-  async getAPYPerStrategy(crossChain = false, days = "7D", strategyType = "safe") {
+  async getAPYPerStrategy(crossChain = false, days = 7, strategy = "conservative") {
     try {
-      const response = await this.httpClient.dataGet(DATA_ENDPOINTS.APY_PER_STRATEGY(crossChain, days, strategyType));
+      const internalStrategy = toInternalStrategy(strategy);
+      const internalStrategyShort = internalStrategy === "safe_strategy" ? "safe" : "degen";
+      const response = await this.httpClient.dataGet(
+        DATA_ENDPOINTS.APY_PER_STRATEGY(crossChain, days, internalStrategyShort)
+      );
       return {
         success: true,
         count: response.count || 0,
@@ -1978,10 +1997,10 @@ var ZyfaiSDK = class {
   // Opportunities Methods (Data API v2)
   // ============================================================================
   /**
-   * Get safe (low-risk) yield opportunities
+   * Get conservative (low-risk) yield opportunities
    *
    * @param chainId - Optional chain ID filter
-   * @returns List of safe yield opportunities
+   * @returns List of conservative yield opportunities
    *
    * @example
    * ```typescript
@@ -1998,7 +2017,7 @@ var ZyfaiSDK = class {
       return {
         success: true,
         chainId,
-        strategyType: "safe",
+        strategyType: "conservative",
         data: Array.isArray(data) ? data.map((o) => ({
           id: o.id,
           protocolId: o.protocol_id || o.protocolId,
@@ -2009,7 +2028,7 @@ var ZyfaiSDK = class {
           tvl: o.tvl || o.zyfiTvl,
           asset: o.asset || o.underlying_token,
           risk: o.risk,
-          strategyType: "safe",
+          strategyType: "conservative",
           status: o.status
         })) : []
       };
@@ -2020,10 +2039,10 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Get degen (high-risk, high-reward) yield strategies
+   * Get aggressive (high-risk, high-reward) yield strategies
    *
    * @param chainId - Optional chain ID filter
-   * @returns List of degen strategies
+   * @returns List of aggressive strategies
    *
    * @example
    * ```typescript
@@ -2040,7 +2059,7 @@ var ZyfaiSDK = class {
       return {
         success: true,
         chainId,
-        strategyType: "degen",
+        strategyType: "aggressive",
         data: Array.isArray(data) ? data.map((o) => ({
           id: o.id,
           protocolId: o.protocol_id || o.protocolId,
@@ -2051,7 +2070,7 @@ var ZyfaiSDK = class {
           tvl: o.tvl || o.zyfiTvl,
           asset: o.asset || o.underlying_token,
           risk: o.risk,
-          strategyType: "degen",
+          strategyType: "aggressive",
           status: o.status
         })) : []
       };

package/dist/index.mjs

@@ -53,7 +53,7 @@ var DATA_ENDPOINTS = {
   // Rebalance
   REBALANCE_INFO: (isCrossChain) => isCrossChain !== void 0 ? `/rebalance/rebalance-info?isCrossChain=${isCrossChain}` : "/rebalance/rebalance-info",
   // APY Per Strategy
-  APY_PER_STRATEGY: (isCrossChain = false, days = "7D", strategyType = "safe") => `/rebalance/rebalance-info?isCrossChain=${isCrossChain}&days=${days}&strategyType=${strategyType}`
+  APY_PER_STRATEGY: (isCrossChain = false, days = 7, strategy = "safe") => `/rebalance/rebalance-info?isCrossChain=${isCrossChain}&days=${days}&strategy=${strategy}`
 };
 
 // src/utils/http-client.ts
@@ -601,6 +601,20 @@ var signSessionKey = async (config, sessions, allPublicClients, signingParams) =
   };
 };
 
+// src/utils/strategy.ts
+function toInternalStrategy(publicStrategy) {
+  switch (publicStrategy) {
+    case "conservative":
+      return "safe_strategy";
+    case "aggressive":
+      return "degen_strategy";
+    default:
+      throw new Error(
+        `Invalid public strategy: ${publicStrategy}. Must be "conservative" or "aggressive".`
+      );
+  }
+}
+
 // src/core/ZyfaiSDK.ts
 import { SiweMessage } from "siwe";
 var ZyfaiSDK = class {
@@ -982,16 +996,16 @@ var ZyfaiSDK = class {
    *
    * @param userAddress - User's EOA address (the connected EOA, not the smart wallet address)
    * @param chainId - Target chain ID
-   * @param strategy - Optional strategy selection: "safe_strategy" (default) or "degen_strategy" (yieldor)
+   * @param strategy - Optional strategy selection: "conservative" (default) or "aggressive"
    * @returns Deployment response with Safe address and transaction hash
    *
    * @example
    * ```typescript
-   * // Deploy with default safe strategy
+   * // Deploy with default conservative strategy
    * await sdk.deploySafe(userAddress, 8453);
    *
-   * // Deploy with degen strategy (yieldor)
-   * await sdk.deploySafe(userAddress, 8453, "degen_strategy");
+   * // Deploy with aggressive strategy
+   * await sdk.deploySafe(userAddress, 8453, "aggressive");
    * ```
    */
   async deploySafe(userAddress, chainId, strategy) {
@@ -1034,6 +1048,7 @@ var ZyfaiSDK = class {
           status: "deployed"
         };
       }
+      const internalStrategy = strategy ? toInternalStrategy(strategy) : "safe_strategy";
       const deploymentResult = await deploySafeAccount({
         owner: walletClient,
         safeOwnerAddress: userAddress,
@@ -1041,7 +1056,7 @@ var ZyfaiSDK = class {
         publicClient: chainConfig.publicClient,
         chainId,
         httpClient: this.httpClient,
-        strategy: strategy || "safe_strategy"
+        strategy: internalStrategy
       });
       try {
         await this.initializeUser(deploymentResult.safeAddress, chainId);
@@ -1598,19 +1613,23 @@ var ZyfaiSDK = class {
    * Get APY per strategy for a specific chain
    *
    * @param crossChain - Whether to get cross-chain APY (true = omni account, false = simple account)
-   * @param days - Time period: "7D", "14D", or "30D"
-   * @param strategyType - Strategy type: "safe" or "degen"
+   * @param days - Time period: 7, 14, or 30
+   * @param strategy - Strategy type: "conservative" (default) or "aggressive"
    * @returns APY per strategy for a specific chain
    *
    * @example
    * ```typescript
-   * const apyPerStrategy = await sdk.getAPYPerStrategy(false, "7D", "safe");
+   * const apyPerStrategy = await sdk.getAPYPerStrategy(false, 7, "conservative");
    * console.log("APY per strategy per chain:", apyPerStrategy.data);
    * ```
    */
-  async getAPYPerStrategy(crossChain = false, days = "7D", strategyType = "safe") {
+  async getAPYPerStrategy(crossChain = false, days = 7, strategy = "conservative") {
     try {
-      const response = await this.httpClient.dataGet(DATA_ENDPOINTS.APY_PER_STRATEGY(crossChain, days, strategyType));
+      const internalStrategy = toInternalStrategy(strategy);
+      const internalStrategyShort = internalStrategy === "safe_strategy" ? "safe" : "degen";
+      const response = await this.httpClient.dataGet(
+        DATA_ENDPOINTS.APY_PER_STRATEGY(crossChain, days, internalStrategyShort)
+      );
       return {
         success: true,
         count: response.count || 0,
@@ -1955,10 +1974,10 @@ var ZyfaiSDK = class {
   // Opportunities Methods (Data API v2)
   // ============================================================================
   /**
-   * Get safe (low-risk) yield opportunities
+   * Get conservative (low-risk) yield opportunities
    *
    * @param chainId - Optional chain ID filter
-   * @returns List of safe yield opportunities
+   * @returns List of conservative yield opportunities
    *
    * @example
    * ```typescript
@@ -1975,7 +1994,7 @@ var ZyfaiSDK = class {
       return {
         success: true,
         chainId,
-        strategyType: "safe",
+        strategyType: "conservative",
         data: Array.isArray(data) ? data.map((o) => ({
           id: o.id,
           protocolId: o.protocol_id || o.protocolId,
@@ -1986,7 +2005,7 @@ var ZyfaiSDK = class {
           tvl: o.tvl || o.zyfiTvl,
           asset: o.asset || o.underlying_token,
           risk: o.risk,
-          strategyType: "safe",
+          strategyType: "conservative",
           status: o.status
         })) : []
       };
@@ -1997,10 +2016,10 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Get degen (high-risk, high-reward) yield strategies
+   * Get aggressive (high-risk, high-reward) yield strategies
    *
    * @param chainId - Optional chain ID filter
-   * @returns List of degen strategies
+   * @returns List of aggressive strategies
    *
    * @example
    * ```typescript
@@ -2017,7 +2036,7 @@ var ZyfaiSDK = class {
       return {
         success: true,
         chainId,
-        strategyType: "degen",
+        strategyType: "aggressive",
         data: Array.isArray(data) ? data.map((o) => ({
           id: o.id,
           protocolId: o.protocol_id || o.protocolId,
@@ -2028,7 +2047,7 @@ var ZyfaiSDK = class {
           tvl: o.tvl || o.zyfiTvl,
           asset: o.asset || o.underlying_token,
           risk: o.risk,
-          strategyType: "degen",
+          strategyType: "aggressive",
           status: o.status
         })) : []
       };

package/package.json

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