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.

Three integration paths into Amplify Earn. Pick the one that matches your stack.

Amplify SDK

TypeScript / JavaScript client. Calls the REST API for you and returns ready-to-submit transaction calldata.

Direct Contract

Any language. Call the on-chain contracts directly using your own ABI tooling.

API Calldata

Any language. Hit the REST API directly — it returns ABI-encoded calldata your signer submits.
SDKDirect ContractAPI Calldata
LanguagesTypeScript / JavaScriptAny EVM-capable languageAny language with an HTTP client
Setuppnpm add @paxoslabs/amplify-sdkRPC + contract addresses + ABIAPI key + HTTP client
Calldata sourceSDK calls API on your behalfEncode locally with viem/web3/etc.REST API
Best forWeb + Node.js appsMobile, non-JS backends, bespoke clientsServer builders, custodial wallets, multisig

Start here

Project setup

Install the SDK, create a client, make your first call.

Concepts

Vaults, share tokens, deposit + withdraw flows, decimals.

Deposits

End-to-end deposit flow with permit and approval paths.

Withdrawals

Submit, preview fees, list pending, and cancel orders.

AI Coding Reference

Every method, parameter, and response on AmplifyClient.

Migrating from 0.5.x

Breaking changes and a side-by-side rename table.

AI-ready references

SDK reference

Condensed SDK surface for Cursor, Copilot, and Claude.

Contract reference

On-chain integration reference for AI coding assistants.

API calldata reference

REST endpoint reference for AI coding assistants.