Installation

Prerequisites

Use matching versions for Wallet Kit packages when pinning dependencies.

• Node.js 18 or later
• TypeScript 5.0 or later (if using TypeScript)
• A bundler (Vite, webpack, Rollup) — recommended for production
• Or a plain HTML page — use the IIFE bundle instead

Recommended: Modular Install

Install the core and only the adapters your app needs:

npm

# Core (required)
npm install @xrpl-wallet-kit/core

# UI components (optional — skip if building your own UI)
npm install @xrpl-wallet-kit/ui

# Adapters — install only what you need
npm install @xrpl-wallet-kit/adapter-xaman
npm install @xrpl-wallet-kit/adapter-gemwallet
npm install @xrpl-wallet-kit/adapter-walletconnect

yarn

yarn add @xrpl-wallet-kit/core
yarn add @xrpl-wallet-kit/ui
yarn add @xrpl-wallet-kit/adapter-xaman
yarn add @xrpl-wallet-kit/adapter-gemwallet
yarn add @xrpl-wallet-kit/adapter-walletconnect

pnpm

pnpm add @xrpl-wallet-kit/core
pnpm add @xrpl-wallet-kit/ui
pnpm add @xrpl-wallet-kit/adapter-xaman
pnpm add @xrpl-wallet-kit/adapter-gemwallet
pnpm add @xrpl-wallet-kit/adapter-walletconnect

All available adapters:

Package	Wallet
@xrpl-wallet-kit/adapter-xaman	Xaman (mobile)
@xrpl-wallet-kit/adapter-gemwallet	GemWallet (extension)
@xrpl-wallet-kit/adapter-joey-wallet	Joey Wallet (extension, opt-in)
@xrpl-wallet-kit/adapter-walletconnect	WalletConnect v2
@xrpl-wallet-kit/adapter-crossmark	Crossmark (extension)
@xrpl-wallet-kit/adapter-ledger	Ledger hardware wallet
@xrpl-wallet-kit/adapter-dropfi	DropFi (extension + mobile)
@xrpl-wallet-kit/adapter-xrpl-snap	XRPL Snap (MetaMask)
@xrpl-wallet-kit/adapter-ghostsig	GhostSig (hosted popup, opt-in)
@xrpl-wallet-kit/adapter-xyra	Xyra (hosted popup, opt-in)

Install the GhostSig adapter with its XRPL peer dependency:

npm install @xrpl-wallet-kit/core @xrpl-wallet-kit/adapter-ghostsig xrpl@^4

GhostSig is opt-in: the default client list and wallets: "all" exclude it.

Install Xyra with core and the XRPL peer dependency, then follow the Xyra connection guide:

npm install @xrpl-wallet-kit/core @xrpl-wallet-kit/adapter-xyra xrpl@^4

Install Joey Wallet with core and the XRPL peer dependency:

npm install @xrpl-wallet-kit/core @xrpl-wallet-kit/adapter-joey-wallet xrpl@^4

See the Joey Wallet guide for configuration. With the all-in-one client, enable it using wallets: ["joey-wallet"]; wallets: "all" does not include it. The WalletConnect wallet ID remains joey.

All-in-One Client Package

If you want everything in one install:

npm

npm install @xrpl-wallet-kit/client

yarn

yarn add @xrpl-wallet-kit/client

pnpm

pnpm add @xrpl-wallet-kit/client

The client package re-exports core, UI, and all adapters for convenience. For a smaller production bundle, use @xrpl-wallet-kit/client/selective with named adapter packages; importing the default client can retain adapter SDKs that cannot be fully tree-shaken.

The full client also configures Xahau automatically when network is "xahau-mainnet" or "xahau-testnet"; its signing runtime loads on demand. Xaman, GemWallet and Xyra are available on that path; Ledger is explicit opt-in. Configure a positive fee ceiling as shown in Xahau. For core/selective setups, also install @xrpl-wallet-kit/xahau and register its protocol and networks explicitly.

React / Next.js

React

npm install @xrpl-wallet-kit/react @xrpl-wallet-kit/client

Next.js

npm install @xrpl-wallet-kit/next @xrpl-wallet-kit/client

See the React guide or Next.js guide for setup instructions.

Sign-In with Wallet (Auth)

npm

npm install @xrpl-wallet-kit/auth

yarn

yarn add @xrpl-wallet-kit/auth

pnpm

pnpm add @xrpl-wallet-kit/auth

Server-side peer dependencies (install on your backend only):

npm install ripple-keypairs@^3 xrpl@^4

HTML (Legacy / CDN)

For pages that cannot use a bundler, load the IIFE bundle from a CDN or copy it to your server:

<!-- From CDN (tracks the latest release; not version-pinned) -->
<script src="https://cdn.jsdelivr.net/npm/@xrpl-wallet-kit/browser@latest/dist/xrpl-wallet-kit.iife.min.js"></script>

<!-- Or host it yourself -->
<script src="/assets/xrpl-wallet-kit.iife.min.js"></script>

The bundle exposes a global XRPLWalletKit object:

const { createWalletKit, createXamanAdapter } = XRPLWalletKit;

On Xahau, the IIFE automatically loads the minified xrpl-wallet-kit-xahau.runtime.js beside the main script on first preparation or lookup. Self-host both files from the same release; no second script tag is needed. See Browser / CDN.

Bundle size

The IIFE bundle is large because it includes all adapters and polyfills. For production sites, prefer the modular install with a bundler.

See the HTML Legacy / CDN guide for a complete example.

TypeScript

All packages ship full TypeScript declarations. No @types/ package needed.

import type { WalletManager, WalletSession, WalletAccount } from "@xrpl-wallet-kit/core";

Environment Variables

Some adapters require credentials. Add them to your .env file (never commit secrets):

Vite

# .env.local
VITE_WALLETCONNECT_PROJECT_ID=your_project_id_here
VITE_XAMAN_API_KEY=your_xaman_api_key_here

Next.js

# .env.local
NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=your_project_id_here
NEXT_PUBLIC_XAMAN_API_KEY=your_xaman_api_key_here

Get your WalletConnect Project ID at cloud.walletconnect.com.
Get your public Xaman API key at apps.xaman.dev. These browser-exposed application credentials identify your dApp; they are not wallet seeds or private server secrets.