Technical Reference

# npm
npm install @zyfai/sdk viem

# pnpm
pnpm add @zyfai/sdk viem

# yarn
yarn add @zyfai/sdk viem

interface SDKConfig {
  apiKey: string;
  rpcUrls?: Partial<Record<SupportedChainId, string>>;
}

type SupportedChainId = 8453 | 42161 | 1;

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

getSupportedChainIds();       // [8453, 42161, 1]
isSupportedChain(8453);       // true

ZYFAI_API_KEY=zyfai_xxxxxxxxxxxxxxxx
PRIVATE_KEY=0x...                       # backend only

# Optional but recommended in production
BASE_RPC_URL=https://base-mainnet.g.alchemy.com/v2/...
ARBITRUM_RPC_URL=https://arb-mainnet.g.alchemy.com/v2/...
MAINNET_RPC_URL=https://eth-mainnet.g.alchemy.com/v2/...

import { ZyfaiSDK } from "@zyfai/sdk";

const sdk = new ZyfaiSDK({
  apiKey: process.env.ZYFAI_API_KEY!,
  rpcUrls: {
    8453:  process.env.BASE_RPC_URL,
    42161: process.env.ARBITRUM_RPC_URL,
    1:     process.env.MAINNET_RPC_URL,
  },
});

await sdk.connectAccount(process.env.PRIVATE_KEY!, 42161);

import { ZyfaiSDK } from "@zyfai/sdk";

const sdk = new ZyfaiSDK({ apiKey: process.env.NEXT_PUBLIC_ZYFAI_API_KEY! });

await sdk.connectAccount(provider, 8453); // SIWE handshake is automatic

const sdk = new ZyfaiSDK({ apiKey: process.env.ZYFAI_API_KEY! });

const wallets = await sdk.getSdkAllowedWallets();
const tvl     = await sdk.getSdkKeyTVL();

1. CONNECT   sdk.connectAccount(...)
2. SEND      sdk.sendDeposit(eoa, chainId, amountInWei, asset, strategy?)
3. CREDIT    sdk.waitForDepositCredit(depositId, chainId)
4. WITHDRAW  sdk.withdrawFunds(eoa, chainId, amountInWei?, asset?)

const sent = await sdk.sendDeposit(eoa, 8453, "100000000", "USDC", "conservative");
await sdk.waitForDepositCredit(sent.registration.id, 8453);
await sdk.updateUserProfile({ strategy: "aggressive" });

// For USDC / EURC (6 decimals), 100 = 100 * 10^6
const sent = await sdk.sendDeposit(eoa, 8453, "100000000", "USDC");
await sdk.waitForDepositCredit(sent.registration.id, 8453);

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

{
  success: boolean;
  // ...method-specific fields
}

try {
  const sent = await sdk.sendDeposit(userAddress, chainId, amount, "USDC");
  await sdk.waitForDepositCredit(sent.registration.id, chainId);
} catch (error) {
  const message = error instanceof Error ? error.message : String(error);

  if (message.includes("Safe not available")) return "Safe not assigned yet. Retry deposit.";
  if (message.includes("User rejected"))    return "Signing was rejected.";
  if (message.includes("No account"))       return "Call sdk.connectAccount() first.";
  if (message.includes("Unsupported chain")) return "Chain must be 8453, 42161 or 1.";

  throw error;
}