Installation

Install Commerce Kit packages for your use case

Installation

Choose the Commerce Kit packages you need based on what you're building. Each package is independently installable and can be used alone or combined with others.

System Requirements

Node.js: Version 18 or higher (LTS recommended)
Package Manager: pnpm, npm, or yarn
TypeScript: Version 4.5+ (recommended but not required)

Common Peer Dependencies

Solana Commerce Kit is built on top of the Solana Kit library, so it is compatible with Solana Kit, Gill, Solana Programs Clients, and Codama-generated JS Clients.

pnpm add gill # or @solana/kit
pnpm add @solana-program/token # or @solana-program/target-program
pnpm add @my-program/codama-js-client

TypeScript Configuration

If using TypeScript, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "module": "ESNext",
    "target": "ES2020",
    "lib": ["ES2020", "DOM", "DOM.Iterable"],
    "jsx": "react-jsx",
    "moduleResolution": "bundler",
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Next.js Configuration

If using Next.js, update next.config.js to transpile Commerce Kit packages:

/** @type {import('next').NextConfig} */
const nextConfig = {
  transpilePackages: [
    '@solana-commerce/react',
    '@solana-commerce/connector',
    '@solana-commerce/headless',
    '@solana-commerce/solana-pay',
    '@solana-commerce/sdk',
  ],
};

export default nextConfig;