Skip to main content

​
Prerequisites

Before installing, make sure you have:
  • Node.js 18 or later recommended
  • A package manager: npm, Yarn, or pnpm
  • WalletSuite API key — see Credentials & Authentication
  • GitHub personal access token with read:packages scope — the SDK is published to GitHub Packages, not the public npm registry

​
Configure the registry

The SDK is hosted on GitHub Packages, so npm needs to be told where to find it before install will work. Create or update .npmrc in your project root:
.npmrc
@walletsuite:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
Then export your token in the shell that runs install: 
export GITHUB_TOKEN=<your-personal-access-token>
Keep .npmrc out of version control if it contains a literal token. Prefer the ${GITHUB_TOKEN} form above so the token stays in your shell or CI secret store.

​
Install

Install with npm
npm install @walletsuite/wallet-sdk

​
Verify Installation

After installing, you should be able to import the SDK in your project.
example.ts
import { WalletSuiteSDK } from "@walletsuite/wallet-sdk";
If your build system uses ESM or TypeScript, this should work out of the box.

​
Next Step

Continue to the SDK Quick Start to make your first authenticated request.