@zyfai/sdk 0.1.20 → 0.1.21

package/README.md

@@ -342,14 +342,16 @@ console.log("User ID:", result.userId);
 
 ### 4. Deposit Funds
 
-Transfer tokens to your Safe smart wallet:
+Transfer tokens to your Safe smart wallet. Token address is automatically selected based on chain:
+
+- **Base (8453) and Arbitrum (42161)**: USDC
+- **Plasma (9745)**: USDT
 
 ```typescript
 // Deposit 100 USDC (6 decimals) to Safe on Base
 const result = await sdk.depositFunds(
   userAddress,
   8453, // Chain ID
-  "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", // USDC on Base
   "100000000" // Amount: 100 USDC = 100 * 10^6
 );
 
@@ -359,8 +361,11 @@ if (result.success) {
 }
 ```
 
-**Note:** Amount must be in least decimal units. For USDC (6 decimals): 1 USDC = 1000000
-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.
+**Note:**
+
+- 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
 
 ### 5. Withdraw Funds
 

package/dist/index.d.mts

@@ -388,6 +388,8 @@ interface ChainConfig {
     rpcUrl: string;
     publicClient: PublicClient;
 }
+declare const DEFAULT_TOKEN_ADDRESSES: Record<SupportedChainId, string>;
+declare const getDefaultTokenAddress: (chainId: SupportedChainId) => string;
 /**
  * Get chain configuration for a given chain ID
  */
@@ -553,9 +555,12 @@ declare 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
+     *
      * @param userAddress - User's address (owner of the Safe)
      * @param chainId - Target chain ID
-     * @param tokenAddress - Token contract address to deposit
      * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
      * @returns Deposit response with transaction hash
      *
@@ -565,12 +570,11 @@ declare class ZyfaiSDK {
      * const result = await sdk.depositFunds(
      *   "0xUser...",
      *   8453,
-     *   "0xaf88d065e77c8cc2239327c5edb3a432268e5831", // USDC
      *   "100000000" // 100 USDC = 100 * 10^6
      * );
      * ```
      */
-    depositFunds(userAddress: string, chainId: SupportedChainId, tokenAddress: string, amount: string): Promise<DepositResponse>;
+    depositFunds(userAddress: string, chainId: SupportedChainId, amount: string): Promise<DepositResponse>;
     /**
      * Withdraw funds from Safe smart wallet
      * Initiates a withdrawal request to the ZyFAI API
@@ -857,4 +861,4 @@ declare class ZyfaiSDK {
     getRebalanceFrequency(walletAddress: string): Promise<RebalanceFrequencyResponse>;
 }
 
-export { type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type Environment, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RebalanceInfo, type RebalanceInfoResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getSupportedChainIds, isSupportedChain };
+export { type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type Environment, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RebalanceInfo, type RebalanceInfoResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };

package/dist/index.d.ts

@@ -388,6 +388,8 @@ interface ChainConfig {
     rpcUrl: string;
     publicClient: PublicClient;
 }
+declare const DEFAULT_TOKEN_ADDRESSES: Record<SupportedChainId, string>;
+declare const getDefaultTokenAddress: (chainId: SupportedChainId) => string;
 /**
  * Get chain configuration for a given chain ID
  */
@@ -553,9 +555,12 @@ declare 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
+     *
      * @param userAddress - User's address (owner of the Safe)
      * @param chainId - Target chain ID
-     * @param tokenAddress - Token contract address to deposit
      * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
      * @returns Deposit response with transaction hash
      *
@@ -565,12 +570,11 @@ declare class ZyfaiSDK {
      * const result = await sdk.depositFunds(
      *   "0xUser...",
      *   8453,
-     *   "0xaf88d065e77c8cc2239327c5edb3a432268e5831", // USDC
      *   "100000000" // 100 USDC = 100 * 10^6
      * );
      * ```
      */
-    depositFunds(userAddress: string, chainId: SupportedChainId, tokenAddress: string, amount: string): Promise<DepositResponse>;
+    depositFunds(userAddress: string, chainId: SupportedChainId, amount: string): Promise<DepositResponse>;
     /**
      * Withdraw funds from Safe smart wallet
      * Initiates a withdrawal request to the ZyFAI API
@@ -857,4 +861,4 @@ declare class ZyfaiSDK {
     getRebalanceFrequency(walletAddress: string): Promise<RebalanceFrequencyResponse>;
 }
 
-export { type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type Environment, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RebalanceInfo, type RebalanceInfoResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getSupportedChainIds, isSupportedChain };
+export { type ActionData, type ActiveWallet, type ActiveWalletsResponse, type AddWalletToSdkResponse, type Address, type ChainConfig, type ChainPortfolio, DEFAULT_TOKEN_ADDRESSES, type DailyApyEntry, type DailyApyHistoryResponse, type DailyEarning, type DailyEarningsResponse, type DebankPortfolioResponse, type DeploySafeResponse, type DepositResponse, type ERC7739Context, type ERC7739Data, type Environment, type FirstTopupResponse, type Hex, type HistoryEntry, type HistoryPosition, type HistoryResponse, type OnchainEarnings, type OnchainEarningsResponse, type OpportunitiesResponse, type Opportunity, type PolicyData, type Pool, type PortfolioToken, type Position, type PositionSlot, type PositionsResponse, type Protocol, type ProtocolsResponse, type RebalanceFrequencyResponse, type RebalanceInfo, type RebalanceInfoResponse, type SDKConfig, type Session, type SessionKeyResponse, type SmartWalletByEOAResponse, type SmartWalletResponse, type SupportedChainId, type TVLResponse, type UserDetails, type UserDetailsResponse, type VolumeResponse, type WithdrawResponse, ZyfaiSDK, getChainConfig, getDefaultTokenAddress, getSupportedChainIds, isSupportedChain };

package/dist/index.js

@@ -30,8 +30,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  DEFAULT_TOKEN_ADDRESSES: () => DEFAULT_TOKEN_ADDRESSES,
   ZyfaiSDK: () => ZyfaiSDK,
   getChainConfig: () => getChainConfig,
+  getDefaultTokenAddress: () => getDefaultTokenAddress,
   getSupportedChainIds: () => getSupportedChainIds,
   isSupportedChain: () => isSupportedChain
 });
@@ -382,6 +384,23 @@ var plasma = (0, import_viem2.defineChain)({
     }
   }
 });
+var DEFAULT_TOKEN_ADDRESSES = {
+  8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+  // USDC on Base
+  42161: "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
+  // USDC on Arbitrum
+  9745: "0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb"
+  // USDT on Plasma
+};
+var getDefaultTokenAddress = (chainId) => {
+  const address = DEFAULT_TOKEN_ADDRESSES[chainId];
+  if (!address || address === "0x0000000000000000000000000000000000000000") {
+    throw new Error(
+      `Default token address not configured for chain ${chainId}. Please provide tokenAddress explicitly.`
+    );
+  }
+  return address;
+};
 var DEFAULT_RPC_URLS = {
   8453: "https://mainnet.base.org",
   42161: "https://arb1.arbitrum.io/rpc",
@@ -1472,9 +1491,12 @@ var ZyfaiSDK = class {
    * 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
+   *
    * @param userAddress - User's address (owner of the Safe)
    * @param chainId - Target chain ID
-   * @param tokenAddress - Token contract address to deposit
    * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
    * @returns Deposit response with transaction hash
    *
@@ -1484,12 +1506,11 @@ var ZyfaiSDK = class {
    * const result = await sdk.depositFunds(
    *   "0xUser...",
    *   8453,
-   *   "0xaf88d065e77c8cc2239327c5edb3a432268e5831", // USDC
    *   "100000000" // 100 USDC = 100 * 10^6
    * );
    * ```
    */
-  async depositFunds(userAddress, chainId, tokenAddress, amount) {
+  async depositFunds(userAddress, chainId, amount) {
     try {
       if (!userAddress) {
         throw new Error("User address is required");
@@ -1497,12 +1518,10 @@ var ZyfaiSDK = class {
       if (!isSupportedChain(chainId)) {
         throw new Error(`Unsupported chain ID: ${chainId}`);
       }
-      if (!tokenAddress) {
-        throw new Error("Token address is required");
-      }
       if (!amount || isNaN(Number(amount)) || Number(amount) <= 0) {
         throw new Error("Valid amount is required");
       }
+      const token = getDefaultTokenAddress(chainId);
       const walletClient = this.getWalletClient();
       const chainConfig = getChainConfig(chainId);
       const safeAddress = await getDeterministicSafeAddress({
@@ -1523,7 +1542,7 @@ var ZyfaiSDK = class {
       }
       const amountBigInt = BigInt(amount);
       const txHash = await walletClient.writeContract({
-        address: tokenAddress,
+        address: token,
         abi: ERC20_ABI,
         functionName: "transfer",
         args: [safeAddress, amountBigInt],
@@ -2342,8 +2361,10 @@ var ZyfaiSDK = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DEFAULT_TOKEN_ADDRESSES,
   ZyfaiSDK,
   getChainConfig,
+  getDefaultTokenAddress,
   getSupportedChainIds,
   isSupportedChain
 });

package/dist/index.mjs

@@ -348,6 +348,23 @@ var plasma = defineChain({
     }
   }
 });
+var DEFAULT_TOKEN_ADDRESSES = {
+  8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+  // USDC on Base
+  42161: "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
+  // USDC on Arbitrum
+  9745: "0xB8CE59FC3717ada4C02eaDF9682A9e934F625ebb"
+  // USDT on Plasma
+};
+var getDefaultTokenAddress = (chainId) => {
+  const address = DEFAULT_TOKEN_ADDRESSES[chainId];
+  if (!address || address === "0x0000000000000000000000000000000000000000") {
+    throw new Error(
+      `Default token address not configured for chain ${chainId}. Please provide tokenAddress explicitly.`
+    );
+  }
+  return address;
+};
 var DEFAULT_RPC_URLS = {
   8453: "https://mainnet.base.org",
   42161: "https://arb1.arbitrum.io/rpc",
@@ -1459,9 +1476,12 @@ var ZyfaiSDK = class {
    * 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
+   *
    * @param userAddress - User's address (owner of the Safe)
    * @param chainId - Target chain ID
-   * @param tokenAddress - Token contract address to deposit
    * @param amount - Amount in least decimal units (e.g., "100000000" for 100 USDC with 6 decimals)
    * @returns Deposit response with transaction hash
    *
@@ -1471,12 +1491,11 @@ var ZyfaiSDK = class {
    * const result = await sdk.depositFunds(
    *   "0xUser...",
    *   8453,
-   *   "0xaf88d065e77c8cc2239327c5edb3a432268e5831", // USDC
    *   "100000000" // 100 USDC = 100 * 10^6
    * );
    * ```
    */
-  async depositFunds(userAddress, chainId, tokenAddress, amount) {
+  async depositFunds(userAddress, chainId, amount) {
     try {
       if (!userAddress) {
         throw new Error("User address is required");
@@ -1484,12 +1503,10 @@ var ZyfaiSDK = class {
       if (!isSupportedChain(chainId)) {
         throw new Error(`Unsupported chain ID: ${chainId}`);
       }
-      if (!tokenAddress) {
-        throw new Error("Token address is required");
-      }
       if (!amount || isNaN(Number(amount)) || Number(amount) <= 0) {
         throw new Error("Valid amount is required");
       }
+      const token = getDefaultTokenAddress(chainId);
       const walletClient = this.getWalletClient();
       const chainConfig = getChainConfig(chainId);
       const safeAddress = await getDeterministicSafeAddress({
@@ -1510,7 +1527,7 @@ var ZyfaiSDK = class {
       }
       const amountBigInt = BigInt(amount);
       const txHash = await walletClient.writeContract({
-        address: tokenAddress,
+        address: token,
         abi: ERC20_ABI,
         functionName: "transfer",
         args: [safeAddress, amountBigInt],
@@ -2328,8 +2345,10 @@ var ZyfaiSDK = class {
   }
 };
 export {
+  DEFAULT_TOKEN_ADDRESSES,
   ZyfaiSDK,
   getChainConfig,
+  getDefaultTokenAddress,
   getSupportedChainIds,
   isSupportedChain
 };

package/package.json

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