API Reference Overview

// Authentication is automatic
await sdk.connectAccount(privateKey, chainId);

// Now all protected methods work
const user = await sdk.getUserDetails();

// Initialize SDK with just your API key
const sdk = new ZyfaiSDK({ apiKey: "zyfai_your_key" });

// No wallet connection needed
const wallets = await sdk.getSdkAllowedWallets();
const tvl = await sdk.getSdkKeyTVL();

console.log("Wallets created via SDK:", wallets.allowedWallets.length);
console.log("Total TVL:", tvl.totalTvl);

import { getSupportedChainIds, isSupportedChain } from "@zyfai/sdk";

const chains = getSupportedChainIds(); // [8453, 42161, 1]
const isValid = isSupportedChain(8453); // true

try {
  const sent = await sdk.sendDeposit(userAddress, chainId, amount, "USDC");
  await sdk.waitForDepositCredit(sent.registration.id, chainId);
} catch (error) {
  console.error("Deposit failed:", error.message);
}

// For USDC / EURC (6 decimals), 100 = 100 * 10^6
const amount = "100000000"; // 100 USDC

const sent = await sdk.sendDeposit(userAddress, chainId, amount, "USDC");
await sdk.waitForDepositCredit(sent.registration.id, chainId);

// Withdrawal is queued
const result = await sdk.withdrawFunds(userAddress, chainId);
console.log(result.message); // "Withdrawal request sent"

// Check history later to see completion
const history = await sdk.getHistory(walletAddress, chainId);

import type {
  SDKConfig,
  DepositResponse,
  PositionsResponse,
  UpdateUserProfileResponse,
  SupportedChainId,
} from "@zyfai/sdk";

{
  success: boolean; // Operation success status
  // ... method-specific data
}