Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Amplify Earn lets you integrate stablecoin yield into any application. Choose the integration path that fits your stack.
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.

API Calldata

Any language, no ABI encoding — REST endpoints return ready-to-sign transaction calldata. No SDK or contract ABIs needed — just HTTP requests and a signer.
SDKDirect ContractAPI Calldata
LanguagesTypeScript, JavaScriptAny (Python, Go, Swift, Kotlin, Flutter, etc.)Any language with HTTP client
Setupnpm install @paxoslabs/amplify-sdkRPC endpoint + contract addresses + ABIAPI key + HTTP client
Address resolutionAutomatic via getVaultsByConfig()REST API or manual configurationAutomatic via GET /v2/amplify/vaults
Approval handlingAutomatic via prepareDepositAuthorization()Manual approve() callsAutomatic via GET /v2/core/permit
Slippage protectionBuilt-in with configurable bpsManual minimumMint calculationServer-side with configurable bps
Best forWeb apps, React, Node.js backendsMobile apps, non-JS backends, full controlServer-side builders, custodial wallets, multisig

​
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.
Upgrading from v0.4.2 or earlier? All transaction and display helper functions now use vaultName instead of yieldType. See the v0.5.0 Migration Guide for step-by-step instructions.

​
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.

​
API Calldata Path

Overview & Authentication

API key setup, response formats, and when to use this path.

Account Discovery

Find accounts and contract addresses via REST API.

Deposits

Authorize and deposit via API-generated calldata.

Withdrawals

Submit withdrawal orders via API-generated calldata.

Cancellations

Cancel pending withdrawal orders.

Display Helpers

Read deposit caps, supply, fees, and share values via API.

​
What’s New in v0.5.3

  • Supply cap awareness — Deposit supply caps are now read and enforced on-chain. The new getDepositCap() helper lets you display remaining capacity. See Display Helpers.
  • Deposit fees — New calculateDepositFee() helper returns variable, flat, and total fees with the net deposit amount. AmplifyVault.depositFees carries per-asset fee data from the indexer.
  • Withdraw fees — AmplifyVault.withdrawFees now carries withdraw queue fee metadata. getWithdrawalFee() reads the on-chain FeeModule for real-time fee previews.

​
v0.5.2 highlights

  • Base mainnet — Built-in support for Base (chainId 8453) in the SDK chain map for discovery, deposits, and withdrawals. See Multi-Chain and the changelog.

​
v0.5.0 highlights

  • vaultName migration — All transaction functions identify accounts by vaultName instead of yieldType — migration guide
  • Account discovery — getVaultsByConfig() for multi-filter account lookup by yieldType, chainId, asset addresses
  • Withdrawal assets — getWithdrawSupportedAssets() for withdrawal assets grouped by token
  • Cache management — initializeCache(), getCache(), refreshVaultCache(), isCacheReady(), waitForCacheReady()

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.