The YieldFi SDK is a TypeScript/JavaScript library for interacting with YieldFi services, smart contracts, and blockchain protocols.
What version of Node.js do I need?
Node.js 18.0.0 or higher is required.
Do I need TypeScript?
No, but TypeScript is recommended for the best developer experience. The SDK is written in TypeScript and provides full type definitions.
2
Authentication
How do I authenticate users?
Users authenticate using EVM wallet signatures. See the Wallet Authentication Guide.
Where are tokens stored?
The SDK does not store tokens internally. You must manage token storage in your application (localStorage, sessionStorage, HTTP-only cookies, etc.).
How do I refresh tokens?
Use the refresh() method with a refresh token. See Token Management.
What happens when a token expires?
When an access token expires, use the refresh token to get a new one. If the refresh token is also expired, the user needs to login again.
3
API Usage
Which APIs require authentication?
Most transaction endpoints, Glassbook, Forms, and Curator Handoff APIs require authentication. Most vault query endpoints are public. See API Reference Overview.
How does role-based filtering work?
Regular users automatically see only their own transactions. Admins, moderators, managers, and LPs can see all transactions. See Vault API - Transactions.
How do I handle pagination?
Most list endpoints support pagination with page and pageSize parameters. See individual API documentation for details.
4
Contract Interactions
How do I get contract ABIs?
Contract ABIs are not included in the SDK. You can get them from:
Official YieldFi documentation
Block explorers (Etherscan, Arbiscan, etc.)
Contract source code repositories
Can I use the SDK without ethers.js?
The SDK provides TypeScript types for contract interactions, but you'll need ethers.js (or another compatible library) for actual contract calls.
5
Errors
How do I handle errors?
Use try-catch blocks and check error types. See Error Handling.
What's the difference between AuthenticationError and NetworkError?