Installation

The YieldFi SDK is available as an npm package and can be installed in your project using npm, yarn, or pnpm.

Prerequisites

• Node.js: Version 18.0.0 or higher

• Package Manager: npm, yarn, or pnpm

• TypeScript: Recommended (SDK is written in TypeScript)

Install via npm

npm install yieldfi-sdk

Install via yarn

yarn add yieldfi-sdk

Install via pnpm

pnpm add yieldfi-sdk

Verify Installation

After installation, verify that the SDK is properly installed:

import { YieldFiSDK } from "yieldfi-sdk";

console.log(YieldFiSDK.getVersion()); // "0.3.0"

TypeScript Support

The SDK is written in TypeScript and includes full type definitions. No additional @types packages are required.

If you're using TypeScript, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "module": "ESNext",
    "target": "ES2020",
    "lib": ["ES2020"],
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Next Steps

• Quick Start Guide - Get up and running in minutes

• Configuration - Learn about SDK configuration options