Installation

Requirements

Node.js ≥ 20 (LTS recommended)
@stellar/stellar-sdk is a peer dependency of @buckspay/core - install it alongside the SDK

Every Buckspay integration starts with @buckspay/core. Install it with your preferred package manager:

pnpm add @buckspay/core @stellar/stellar-sdk

npm install @buckspay/core @stellar/stellar-sdk

yarn add @buckspay/core @stellar/stellar-sdk

bun add @buckspay/core @stellar/stellar-sdk

Add the surface packages for your target platform. You only need the ones you use.

pnpm add @buckspay/react @buckspay/signers @buckspay/accounts @buckspay/relayer

npm install @buckspay/react @buckspay/signers @buckspay/accounts @buckspay/relayer

yarn add @buckspay/react @buckspay/signers @buckspay/accounts @buckspay/relayer

bun add @buckspay/react @buckspay/signers @buckspay/accounts @buckspay/relayer

pnpm add @buckspay/react-native @buckspay/signers @buckspay/accounts @buckspay/relayer

npm install @buckspay/react-native @buckspay/signers @buckspay/accounts @buckspay/relayer

yarn add @buckspay/react-native @buckspay/signers @buckspay/accounts @buckspay/relayer

bun add @buckspay/react-native @buckspay/signers @buckspay/accounts @buckspay/relayer

pnpm add @buckspay/nextjs @buckspay/relayer

npm install @buckspay/nextjs @buckspay/relayer

yarn add @buckspay/nextjs @buckspay/relayer

bun add @buckspay/nextjs @buckspay/relayer

Not sure which packages you need? See Which package do I need? for a one-line summary of each.