SDK API Reference
Generated API reference for @upshiftfinance/sdk — the SDK entry point, vault and subaccount modules, chain adapters, and contract ABIs.
Generated from @upshiftfinance/sdk 1.0.1
This page is produced from the SDK's TSDoc on every release. To correct it, edit the TSDoc in the SDK repository — an edit here is overwritten by the next release.
For a guided introduction, start with the Quick Start, Vault Actions, and Error Handling guides.
Modules
| Module | Description |
|---|---|
| UpshiftSDK | The main Upshift SDK class. |
| UpshiftVaults | The Upshift Vaults Module. |
| UpshiftSubAccounts | The Upshift Sub Accounts Module. |
| UpshiftApi | The Upshift backend API Module — read-only client for public backend endpoints (transparency dashboard, unrealized PnL) and authenticated loan-book / risk / OTC reads. Accessible as sdk.apiModule. |
| EVMAdapter | EVM Adapter for Upshift SDK |
| SolanaAdapter | Solana Adapter for Upshift SDK |
| SuiAdapter | Sui Adapter for Upshift SDK |
| StellarAdapter | Stellar Adapter for Upshift SDK |
| ABIs | Contract ABI definitions for interacting with Upshift smart contracts. |
ABI Functions
Contract ABIs bundled with the Upshift SDK — vaults, receipt tokens, the swap router, loans, rewards, and the infrastructure contracts the SDK reads.
UpshiftSDK
API reference for the UpshiftSDK class — the main entry point for interacting with Upshift vaults and services across EVM, Solana, Sui, and Stellar.