Skip to main content

​
Choose Your Package

Drift Common is organized into three packages. Install the ones you need based on your use case:

@drift-labs/common

Core utilities and clients

@drift-labs/react

React hooks and components

@drift-labs/icons

Icon components

​
Installation

​
@drift-labs/common

Core package for Drift Protocol utilities and client libraries. 
npm install @drift-labs/common

​
Peer Dependencies

You must also install these peer dependencies: 
npm install @drift-labs/sdk@^2.158.0-beta.0 @solana/[email protected]

​
@drift-labs/react

React components, hooks, and providers for Drift applications. 
npm install @drift-labs/react

​
Peer Dependencies

You must also install these peer dependencies: 
npm install [email protected] [email protected] @drift-labs/sdk@^2.158.0-beta.0 @solana/[email protected] @solana/[email protected]
The React package requires React 19.0.3. Make sure your project uses this version.

​
@drift-labs/icons

Icon components for Drift applications.
The icons package is currently marked as private and is typically used as an internal dependency of @drift-labs/react. You usually don’t need to install it separately unless you’re developing custom Drift components.
npm install @drift-labs/icons

​
Install All Packages

If you’re building a complete React application with Drift integration, install all packages together: 
npm install @drift-labs/common @drift-labs/react @drift-labs/sdk@^2.158.0-beta.0 @solana/[email protected] @solana/[email protected] [email protected] [email protected]

​
Version Compatibility

Drift Common packages are designed to work together. Make sure you’re using compatible versions:
  • @drift-labs/common: 1.0.39+
  • @drift-labs/react: 1.0.0+
  • @drift-labs/sdk: ^2.158.0-beta.0
  • @solana/web3.js: 1.98.0
  • react: 19.0.3

​
Node.js Requirements

The @drift-labs/common package requires Node.js version ^24.x.x. Make sure your environment meets this requirement: 
node --version
# Should output v24.x.x

​
TypeScript Configuration

Drift Common packages are written in TypeScript. Add these settings to your tsconfig.json for optimal compatibility:
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "lib": ["ES2020", "DOM"],
    "module": "ESNext",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true
  }
}

​
Verify Installation

Verify your installation by importing from the packages: 
import { EnvironmentConstants, Initialize } from '@drift-labs/common';
import { DriftProvider, useWalletContext } from '@drift-labs/react';

console.log('Drift Common packages installed successfully!');
If the imports work without errors, you’re ready to start building!

​
Next Steps

Quick Start Guide

Follow our quick start guide to build your first Drift application

Build docs developers (and LLMs) love

Get started for freeTalk to us