> ## 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 Developers

> Integrate stablecoin yield into your application using the Amplify SDK or direct smart contract calls

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

## Choose Your Integration Path

<CardGroup cols={2}>
  <Card title="Amplify SDK" icon="cube" href="/v0.5.2/intro/products/earn/developers/guides/index">
    **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).
  </Card>

  <Card title="Direct Contract Integration" icon="file-contract" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/index">
    **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.
  </Card>
</CardGroup>

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

<CardGroup cols={3}>
  <Card title="Getting Started" icon="rocket" href="/v0.5.2/intro/products/earn/developers/getting-started/installation">
    Install the SDK and run your first deposit in under 10 minutes.
  </Card>

  <Card title="Guides" icon="book" href="/v0.5.2/intro/products/earn/developers/guides/index">
    Step-by-step tutorials for deposits, withdrawals, and smart wallets.
  </Card>

  <Card title="API Reference" icon="code" href="/v0.5.2/intro/products/earn/developers/api/index">
    Complete function reference with parameters, return types, and examples.
  </Card>
</CardGroup>

<Warning>
  **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](/v0.5.2/intro/products/earn/developers/changelog#migration-guide)
  for step-by-step instructions.
</Warning>

## Direct Contract Path

<CardGroup cols={2}>
  <Card title="Overview & Setup" icon="gear" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/index">
    Contract architecture, address resolution, supported languages, and prerequisites.
  </Card>

  <Card title="Deposits" icon="arrow-down-to-line" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/deposits">
    Standard and permit deposit flows with multi-language examples.
  </Card>

  <Card title="Withdrawals" icon="arrow-up-from-line" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/withdrawals">
    Submit withdrawal orders and monitor status.
  </Card>

  <Card title="Cancellations" icon="xmark" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/cancellations">
    Cancel pending withdrawal orders.
  </Card>

  <Card title="Account Queries" icon="chart-line" href="/v0.5.2/intro/products/earn/developers/guides/direct-contract/vault-queries/index">
    Read APY, TVL, fees, balances, and withdrawal history via REST API and on-chain.
  </Card>

  <Card title="Smart Contract Source" icon="github" href="https://github.com/paxoslabs/nucleus-boring-vault">
    View the Nucleus BoringVault contracts on GitHub.
  </Card>
</CardGroup>

***

## What's New in v0.5.2

* **Base mainnet** — Built-in support for Base (`chainId` **8453**) in the SDK chain map for discovery, deposits, and withdrawals. See [Multi-Chain](/v0.5.2/intro/products/earn/developers/guides/multi-chain) and the [changelog](/v0.5.2/intro/products/earn/developers/changelog).

## v0.5.0 highlights

* **`vaultName` migration** — All transaction functions identify accounts by `vaultName` instead of `yieldType` — [migration guide](/v0.5.2/intro/products/earn/developers/changelog#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()`

## Quick Links

<CardGroup cols={2}>
  <Card title="Concepts" icon="lightbulb" href="/v0.5.2/intro/products/earn/developers/getting-started/concepts">
    Understand accounts, yield types, permits, and slippage controls.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/v0.5.2/intro/products/earn/developers/troubleshooting">
    Common issues, error codes, and debugging strategies.
  </Card>

  <Card title="Types Reference" icon="brackets-curly" href="/v0.5.2/intro/products/earn/developers/types/index">
    TypeScript types, enums, and discriminated unions.
  </Card>

  <Card title="Changelog" icon="clock-rotate-left" href="/v0.5.2/intro/products/earn/developers/changelog">
    Version history and migration guides.
  </Card>

  <Card title="SDK AI Reference" icon="robot" href="/v0.5.2/intro/products/earn/developers/ai-reference">
    Condensed SDK reference optimized for Cursor, Copilot, and Claude.
  </Card>

  <Card title="Contract AI Reference" icon="robot" href="/v0.5.2/intro/products/earn/developers/direct-contract-ai-reference">
    Condensed contract integration reference for AI coding assistants.
  </Card>
</CardGroup>