Skip to main content
Get started with the Amplify SDK in under 5 minutes.

Requirements

  • Node.js 22 or higher
  • npm, yarn, pnpm, or bun

Install the SDK

bash pnpm add @paxoslabs/amplify-sdk

Install Peer Dependencies

The SDK works with various wallet libraries. Install the dependencies for your chosen stack:
bash pnpm add @privy-io/react-auth viem @tanstack/react-query

Environment Setup

Create a .env.local file in your project root:
Never commit .env, .env.local, etc. to version control. Add them to your .gitignore file.

Initialize the SDK

Call initAmplifySDK() once at application startup:

Verify Installation

Test that everything is working:
Expected output:

Package Exports & Helper Utilities

The SDK supports focused imports for helper-heavy integrations:

Next Steps

Quickstart

Build a complete React app with deposits and withdrawals.

Concepts

Understand vaults, yield types, and authorization flows.