Terminology update (v0.5.3): What were previously called “vaults” in the documentation and UI are now referred to as “accounts”. This is a naming change only — there are no breaking changes to the SDK API, smart contracts, or integration code. Existing code identifiers like
getVaultsByConfig, AmplifyVault, and vaultName remain unchanged.Choose Your Integration Path
Amplify SDK
TypeScript / JavaScript — The fastest way to integrate. The SDK handles
ABI encoding, address resolution, token approvals, slippage, and error handling.
Works with React (wagmi), Node.js (viem), and smart wallets (Privy, Alchemy).
Direct Contract Integration
Any language — Call the account smart contracts directly from Python, Go,
Swift, Kotlin, Flutter, or any EVM-compatible library. Full control over
transaction construction and signing.
| SDK | Direct Contract | |
|---|---|---|
| Languages | TypeScript, JavaScript | Any (Python, Go, Swift, Kotlin, Flutter, etc.) |
| Setup | npm install @paxoslabs/amplify-sdk | RPC endpoint + contract addresses + ABI |
| Address resolution | Automatic via getVaultsByConfig() | REST API or manual configuration |
| Approval handling | Automatic via prepareDepositAuthorization() | Manual approve() calls |
| Slippage protection | Built-in with configurable bps | Manual minimumMint calculation |
| Best for | Web apps, React, Node.js backends | Mobile apps, non-JS backends, full control |
SDK Path
Getting Started
Install the SDK and run your first deposit in under 10 minutes.
Guides
Step-by-step tutorials for deposits, withdrawals, and smart wallets.
API Reference
Complete function reference with parameters, return types, and examples.
Direct Contract Path
Overview & Setup
Contract architecture, address resolution, supported languages, and prerequisites.
Deposits
Standard and permit deposit flows with multi-language examples.
Withdrawals
Submit withdrawal orders and monitor status.
Cancellations
Cancel pending withdrawal orders.
Account Queries
Read APY, TVL, fees, balances, and withdrawal history via REST API and on-chain.
Smart Contract Source
View the Nucleus BoringVault contracts on GitHub.
What’s New in v0.5.3
- Supply cap awareness — Deposit supply caps are now read and enforced on-chain. New
getDepositCap()andgetCurrentSupply()helpers let you display remaining capacity. See Display Helpers. - Deposit fees — New
calculateDepositFee()helper returns variable, flat, and total fees with the net deposit amount.AmplifyVault.depositFeescarries per-asset fee data from the indexer. - Withdraw fees —
AmplifyVault.withdrawFeesnow carries withdraw queue fee metadata.getWithdrawalFee()reads the on-chain FeeModule for real-time fee previews. - Share value — New
getShareValue()helper calculates position value in any quote asset using the on-chain exchange rate.
v0.5.2 highlights
- Base mainnet — Built-in support for Base (
chainId8453) in the SDK chain map for discovery, deposits, and withdrawals. See Multi-Chain and the changelog.
v0.5.0 highlights
vaultNamemigration — All transaction functions identify accounts byvaultNameinstead ofyieldType— migration guide- Account discovery —
getVaultsByConfig()for multi-filter account lookup byyieldType,chainId, asset addresses - Withdrawal assets —
getWithdrawSupportedAssets()for withdrawal assets grouped by token - Cache management —
initializeCache(),getCache(),refreshVaultCache(),isCacheReady(),waitForCacheReady()
Quick Links
Concepts
Understand accounts, yield types, permits, and slippage controls.
Troubleshooting
Common issues, error codes, and debugging strategies.
Types Reference
TypeScript types, enums, and discriminated unions.
Changelog
Version history and migration guides.
SDK AI Reference
Condensed SDK reference optimized for Cursor, Copilot, and Claude.
Contract AI Reference
Condensed contract integration reference for AI coding assistants.