@zyfai/sdk 0.1.27 → 0.1.28

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ZyFAI
+Copyright (c) 2024 Zyfai
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,9 +1,9 @@
-# ZyFAI SDK
+# Zyfai SDK
 
 [![npm version](https://img.shields.io/npm/v/@zyfai/sdk.svg)](https://www.npmjs.com/package/@zyfai/sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-TypeScript SDK for interacting with the ZyFAI Yield Optimization Engine. This SDK provides easy-to-use methods for deploying Safe smart wallets, managing DeFi positions, and optimizing yield across multiple protocols.
+TypeScript SDK for interacting with the Zyfai Yield Optimization Engine. This SDK provides easy-to-use methods for deploying Safe smart wallets, managing DeFi positions, and optimizing yield across multiple protocols.
 
 You can generate an api key from here: https://sdk.zyf.ai/
 
@@ -29,7 +29,7 @@ pnpm add @zyfai/sdk viem
 
 1. **API Key**: Single API key for both Execution API (Safe deployment, transactions, session keys) and Data API (earnings, opportunities, analytics)
 
-**Get your API key from [ZyFAI Dashboard](https://sdk.zyf.ai)**
+**Get your API key from [Zyfai Dashboard](https://sdk.zyf.ai)**
 
 ## Quick Start
 
@@ -167,7 +167,7 @@ new ZyfaiSDK(config: SDKConfig | string)
 - `config`: Configuration object or API key string
   - If a string is provided, it's treated as the `apiKey`
   - If an object is provided:
-    - `apiKey` (string): Your ZyFAI API key (required)
+    - `apiKey` (string): Your Zyfai API key (required)
     - `environment` ('production' | 'staging', optional): API environment (default: 'production')
     - `rpcUrls` (object, optional): Custom RPC URLs per chain to avoid rate limiting (optional, only needed for local operations like `getSmartWalletAddress`)
       - `8453` (string, optional): Base Mainnet RPC URL
@@ -319,7 +319,7 @@ Session keys enable delegated transaction execution without exposing the main pr
 
 #### Simple Usage (Recommended)
 
-The SDK automatically fetches optimal session configuration from ZyFAI API:
+The SDK automatically fetches optimal session configuration from Zyfai API:
 
 ```typescript
 // SDK automatically:
@@ -375,7 +375,7 @@ if (result.success) {
 
 - Amount must be in least decimal units. For USDC (6 decimals): 1 USDC = 1000000
 - Token address is automatically selected based on chain (USDC for Base/Arbitrum, USDT for Plasma)
-- The SDK automatically authenticates via SIWE before logging the deposit with ZyFAI's API, so no extra steps are required on your end once the transfer confirms
+- The SDK automatically authenticates via SIWE before logging the deposit with Zyfai's API, so no extra steps are required on your end once the transfer confirms
 
 ### 5. Withdraw Funds
 
@@ -902,7 +902,7 @@ If `withdrawFunds` returns without a `txHash`, the withdrawal is being processed
 
 ### Data API CORS Errors
 
-Some Data API endpoints may require server-side CORS configuration. If you see CORS errors for endpoints like `onchain-earnings`, `calculate-onchain-earnings`, or `opportunities`, contact ZyFAI support to ensure your origin is whitelisted.
+Some Data API endpoints may require server-side CORS configuration. If you see CORS errors for endpoints like `onchain-earnings`, `calculate-onchain-earnings`, or `opportunities`, contact Zyfai support to ensure your origin is whitelisted.
 
 ## Contributing
 

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { Chain, PublicClient } from 'viem';
 
 /**
- * ZyFAI SDK Types
+ * Zyfai SDK Types
  */
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
@@ -404,7 +404,7 @@ declare const isSupportedChain: (chainId: number) => chainId is SupportedChainId
 declare const getSupportedChainIds: () => SupportedChainId[];
 
 /**
- * ZyFAI SDK Main Class
+ * Zyfai SDK Main Class
  */
 
 declare class ZyfaiSDK {
@@ -515,7 +515,7 @@ declare class ZyfaiSDK {
      */
     deploySafe(userAddress: string, chainId: SupportedChainId): Promise<DeploySafeResponse>;
     /**
-     * Create session key with auto-fetched configuration from ZyFAI API
+     * Create session key with auto-fetched configuration from Zyfai API
      * This is the simplified method that automatically fetches session configuration
      *
      * @param userAddress - User's EOA or Safe address
@@ -544,7 +544,7 @@ declare class ZyfaiSDK {
      */
     private updateUserProtocols;
     /**
-     * Activate session key via ZyFAI API
+     * Activate session key via Zyfai API
      */
     private activateSessionKey;
     /**
@@ -577,7 +577,7 @@ declare class ZyfaiSDK {
     depositFunds(userAddress: string, chainId: SupportedChainId, amount: string): Promise<DepositResponse>;
     /**
      * Withdraw funds from Safe smart wallet
-     * Initiates a withdrawal request to the ZyFAI API
+     * Initiates a withdrawal request to the Zyfai API
      * Note: The withdrawal is processed asynchronously, so txHash may not be immediately available
      * Funds are always withdrawn to the Safe owner's address (userAddress)
      *
@@ -649,7 +649,7 @@ declare class ZyfaiSDK {
      */
     getUserDetails(): Promise<UserDetailsResponse>;
     /**
-     * Get total value locked (TVL) across all ZyFAI accounts
+     * Get total value locked (TVL) across all Zyfai accounts
      *
      * @returns Total TVL in USD and breakdown by chain
      *
@@ -661,7 +661,7 @@ declare class ZyfaiSDK {
      */
     getTVL(): Promise<TVLResponse>;
     /**
-     * Get total volume across all ZyFAI accounts
+     * Get total volume across all Zyfai accounts
      *
      * @returns Total volume in USD
      *

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Chain, PublicClient } from 'viem';
 
 /**
- * ZyFAI SDK Types
+ * Zyfai SDK Types
  */
 type Address = `0x${string}`;
 type Hex = `0x${string}`;
@@ -404,7 +404,7 @@ declare const isSupportedChain: (chainId: number) => chainId is SupportedChainId
 declare const getSupportedChainIds: () => SupportedChainId[];
 
 /**
- * ZyFAI SDK Main Class
+ * Zyfai SDK Main Class
  */
 
 declare class ZyfaiSDK {
@@ -515,7 +515,7 @@ declare class ZyfaiSDK {
      */
     deploySafe(userAddress: string, chainId: SupportedChainId): Promise<DeploySafeResponse>;
     /**
-     * Create session key with auto-fetched configuration from ZyFAI API
+     * Create session key with auto-fetched configuration from Zyfai API
      * This is the simplified method that automatically fetches session configuration
      *
      * @param userAddress - User's EOA or Safe address
@@ -544,7 +544,7 @@ declare class ZyfaiSDK {
      */
     private updateUserProtocols;
     /**
-     * Activate session key via ZyFAI API
+     * Activate session key via Zyfai API
      */
     private activateSessionKey;
     /**
@@ -577,7 +577,7 @@ declare class ZyfaiSDK {
     depositFunds(userAddress: string, chainId: SupportedChainId, amount: string): Promise<DepositResponse>;
     /**
      * Withdraw funds from Safe smart wallet
-     * Initiates a withdrawal request to the ZyFAI API
+     * Initiates a withdrawal request to the Zyfai API
      * Note: The withdrawal is processed asynchronously, so txHash may not be immediately available
      * Funds are always withdrawn to the Safe owner's address (userAddress)
      *
@@ -649,7 +649,7 @@ declare class ZyfaiSDK {
      */
     getUserDetails(): Promise<UserDetailsResponse>;
     /**
-     * Get total value locked (TVL) across all ZyFAI accounts
+     * Get total value locked (TVL) across all Zyfai accounts
      *
      * @returns Total TVL in USD and breakdown by chain
      *
@@ -661,7 +661,7 @@ declare class ZyfaiSDK {
      */
     getTVL(): Promise<TVLResponse>;
     /**
-     * Get total volume across all ZyFAI accounts
+     * Get total volume across all Zyfai accounts
      *
      * @returns Total volume in USD
      *

package/dist/index.js

@@ -1095,7 +1095,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Create session key with auto-fetched configuration from ZyFAI API
+   * Create session key with auto-fetched configuration from Zyfai API
    * This is the simplified method that automatically fetches session configuration
    *
    * @param userAddress - User's EOA or Safe address
@@ -1266,7 +1266,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Activate session key via ZyFAI API
+   * Activate session key via Zyfai API
    */
   async activateSessionKey(signer, signature, sessionNonces) {
     const nonces = this.normalizeSessionNonces(sessionNonces);
@@ -1377,7 +1377,7 @@ var ZyfaiSDK = class {
   }
   /**
    * Withdraw funds from Safe smart wallet
-   * Initiates a withdrawal request to the ZyFAI API
+   * Initiates a withdrawal request to the Zyfai API
    * Note: The withdrawal is processed asynchronously, so txHash may not be immediately available
    * Funds are always withdrawn to the Safe owner's address (userAddress)
    *
@@ -1598,7 +1598,7 @@ var ZyfaiSDK = class {
   // TVL & Volume Methods
   // ============================================================================
   /**
-   * Get total value locked (TVL) across all ZyFAI accounts
+   * Get total value locked (TVL) across all Zyfai accounts
    *
    * @returns Total TVL in USD and breakdown by chain
    *
@@ -1629,7 +1629,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Get total volume across all ZyFAI accounts
+   * Get total volume across all Zyfai accounts
    *
    * @returns Total volume in USD
    *

package/dist/index.mjs

@@ -1072,7 +1072,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Create session key with auto-fetched configuration from ZyFAI API
+   * Create session key with auto-fetched configuration from Zyfai API
    * This is the simplified method that automatically fetches session configuration
    *
    * @param userAddress - User's EOA or Safe address
@@ -1243,7 +1243,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Activate session key via ZyFAI API
+   * Activate session key via Zyfai API
    */
   async activateSessionKey(signer, signature, sessionNonces) {
     const nonces = this.normalizeSessionNonces(sessionNonces);
@@ -1354,7 +1354,7 @@ var ZyfaiSDK = class {
   }
   /**
    * Withdraw funds from Safe smart wallet
-   * Initiates a withdrawal request to the ZyFAI API
+   * Initiates a withdrawal request to the Zyfai API
    * Note: The withdrawal is processed asynchronously, so txHash may not be immediately available
    * Funds are always withdrawn to the Safe owner's address (userAddress)
    *
@@ -1575,7 +1575,7 @@ var ZyfaiSDK = class {
   // TVL & Volume Methods
   // ============================================================================
   /**
-   * Get total value locked (TVL) across all ZyFAI accounts
+   * Get total value locked (TVL) across all Zyfai accounts
    *
    * @returns Total TVL in USD and breakdown by chain
    *
@@ -1606,7 +1606,7 @@ var ZyfaiSDK = class {
     }
   }
   /**
-   * Get total volume across all ZyFAI accounts
+   * Get total volume across all Zyfai accounts
    *
    * @returns Total volume in USD
    *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.1.27",
-  "description": "TypeScript SDK for ZyFAI Yield Optimization Engine - Deploy Safe smart wallets, manage session keys, and interact with DeFi protocols",
+  "version": "0.1.28",
+  "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",
   "types": "dist/index.d.ts",