# Paxos Labs Documentation

> Paxos Labs builds infrastructure for stablecoin yield. The Amplify SDK is a TypeScript library that lets developers integrate deposits and withdrawals into DeFi vaults across multiple EVM chains.

## SDK Version

The current SDK version is **0.5.0**. All links below point to the latest version.

## API Specification

- [OpenAPI Spec (REST)](https://docs.paxoslabs.com/v0.5.0/api-reference/openapi.yml): Backend REST API for vault analytics, withdrawal requests, and address book management.

## Getting Started

- [Overview](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/index): SDK overview and quick links
- [Installation](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/getting-started/installation): Install the SDK (`@paxoslabs/amplify-sdk`) with npm/pnpm/yarn
- [Quickstart](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/getting-started/quickstart): Build a React app with deposits in under 30 minutes
- [Concepts](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/getting-started/concepts): Vaults, vault names, yield types, permits, slippage

## Guides

- [Project Setup](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/project-setup): Recommended directory structure and SDK initialization patterns
- [Deposits](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/deposits): Complete deposit flows with Privy, Wagmi, and Viem examples
- [Withdrawals](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/withdrawals): Withdrawal authorization and order submission
- [Smart Wallets](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/smart-wallets): Smart wallet detection and authorization routing
- [Multi-Chain](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/multi-chain): Cross-chain vault operations with viem
- [Logging](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/guides/logging): Debug logging and telemetry configuration

## API Reference

- [API Overview](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/index): Complete function reference with type guards and vault discovery pattern
- [initAmplifySDK](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/initAmplifySDK): Initialize the SDK with API key and options
- [fetchSupportedAssets](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/fetchSupportedAssets): Fetch supported tokens with filters for yield type, chain, address, symbol
- [getVaultsByConfig](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/getVaultsByConfig): Discover vaults by yield type, chain, and asset filters — returns `vaultName`
- [Deposit Workflow](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/deposit-workflow): Unified deposit API with prepareDepositAuthorization and prepareDeposit
- [prepareDepositTxData](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareDepositTxData): Build standard deposit transaction data
- [prepareDepositWithPermitTxData](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareDepositWithPermitTxData): Build permit-based deposit transaction data
- [prepareDepositPermitSignature](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareDepositPermitSignature): Build EIP-712 typed data for permit signing
- [prepareWithdrawalAuthorization](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareWithdrawalAuthorization): Check approval requirements for withdrawal
- [prepareWithdrawal](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareWithdrawal): Unified withdrawal wrapper
- [prepareWithdrawOrderTxData](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareWithdrawOrderTxData): Low-level WithdrawQueue order transaction data
- [prepareApproveWithdrawOrderTxData](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareApproveWithdrawOrderTxData): Low-level withdraw approval transaction data
- [prepareCancelWithdrawOrderTxData](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/prepareCancelWithdrawOrderTxData): Cancel a pending withdrawal order

## Display Helpers

- [Display Helpers Overview](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/index): UI helper functions for vault APY, TVL, fees, and withdrawal history
- [findVaultByConfig](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/findVaultByConfig): Find a single vault by asset + yield type + chain
- [getMinimumMint](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getMinimumMint): Calculate expected vault shares for a deposit
- [getVaultAPY](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getVaultAPY): Fetch latest vault APY
- [getVaultTVL](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getVaultTVL): Fetch vault total value locked
- [getWithdrawalFee](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getWithdrawalFee): Calculate withdrawal fees
- [getWithdrawalRequests](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getWithdrawalRequests): Fetch user withdrawal request history
- [getMinimumWithdrawalOrderSize](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/api/display/getMinimumWithdrawalOrderSize): Get minimum withdrawal order size

## Types

- [Types Overview](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/types/index): AmplifyVault, SupportedAsset, SDKInitOptions, and other TypeScript types
- [YieldType](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/types/YieldType): CORE, TREASURY, FRONTIER enum
- [DepositAuthMethod](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/types/DepositAuthMethod): PERMIT, APPROVAL, ALREADY_APPROVED discriminated union
- [WithdrawAuthMethod](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/types/WithdrawAuthMethod): APPROVAL, ALREADY_APPROVED discriminated union
- [Errors](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/types/errors): APIError, WithdrawError hierarchy and type guards

## AI Coding Reference

- [SDK AI Reference](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/ai-reference): Condensed single-page SDK reference optimized for AI context windows (Cursor, Copilot, Claude). Copy this page into your AI assistant for accurate completions.
- [Calldata AI Reference](https://docs.paxoslabs.com/v0.5.3/intro/products/earn/developers/api-calldata-ai-reference): Condensed single-page REST calldata reference for server-side / non-JS integrations (v0.5.3).

## Agent Skills

- [Agent Skills Index](https://docs.paxoslabs.com/.well-known/agent-skills/index.json): Auto-discoverable Agent Skills (agentskills.io 0.2.0) for skill-aware tools (Claude Code, Cursor, Windsurf, etc.).
- [amplify-earn-api-calldata](https://docs.paxoslabs.com/.well-known/agent-skills/amplify-earn-api-calldata): End-to-end skill for the Amplify Earn REST calldata API — auth, discovery, deposits, withdrawals, cancellations, and display helpers.

## Troubleshooting & Changelog

- [Troubleshooting](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/troubleshooting): Common issues, error codes, and debugging strategies
- [Changelog](https://docs.paxoslabs.com/v0.5.0/intro/products/earn/developers/changelog): Version history, migration guides, and breaking changes