Skip to main content
Amplify Earn lets you integrate stablecoin yield into any application. Choose the integration path that fits your stack.

​
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 vault smart contracts directly from Python, Go, Swift, Kotlin, Flutter, or any EVM-compatible library. Full control over transaction construction and signing.
SDKDirect Contract
LanguagesTypeScript, JavaScriptAny (Python, Go, Swift, Kotlin, Flutter, etc.)
Setupnpm install @paxoslabs/amplify-sdkRPC endpoint + contract addresses + ABI
Address resolutionAutomatic via getVaultsByConfig()REST API or manual configuration
Approval handlingAutomatic via prepareDepositAuthorization()Manual approve() calls
Slippage protectionBuilt-in with configurable bpsManual minimumMint calculation
Best forWeb apps, React, Node.js backendsMobile 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.
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.

Vault 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.0

  • vaultName Migration - All transaction functions now identify vaults by vaultName instead of yieldType — migration guide
  • Vault Discovery - New getVaultsByConfig() for multi-filter vault lookup by yieldType, chainId, asset addresses
  • Withdrawal Assets - New getWithdrawSupportedAssets() to fetch all supported withdrawal assets grouped by token
  • Cache Management - Fully documented initializeCache(), getCache(), refreshVaultCache(), isCacheReady(), waitForCacheReady()

Concepts

Understand vaults, 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.