Skip to main content

​
Package Installation

Install the Nexus SDK using your preferred package manager: 
npm install @avail-project/nexus-core

​
Prerequisites

Before installing, ensure your environment meets these requirements:

Node.js

Version 18.0.0 or higher

Package Manager

npm 9.0.0 or equivalent yarn/pnpm

​
Verify Your Environment

Check your Node.js and npm versions: 
node --version
# Should output v18.0.0 or higher

npm --version
# Should output 9.0.0 or higher
The SDK requires Node.js 18+ due to its use of modern JavaScript features and cryptographic APIs. Using an older version may result in runtime errors.

​
TypeScript Configuration

While the SDK works with JavaScript, we strongly recommend using TypeScript for the best developer experience. The SDK includes comprehensive TypeScript definitions.
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "lib": ["ES2020", "DOM"],
    "moduleResolution": "node",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "resolveJsonModule": true
  }
}

​
Import the SDK

Once installed, you can import the SDK components you need:

​
ESM (ES Modules)

import { NexusSDK, NEXUS_EVENTS } from '@avail-project/nexus-core';

​
CommonJS

const { NexusSDK, NEXUS_EVENTS } = require('@avail-project/nexus-core');
The SDK is fully tree-shakeable, so bundlers like Webpack, Rollup, or Vite will only include the code you actually use.

​
Available Exports

The SDK exports a wide range of utilities, types, and constants:

​
Core Classes

import {
  NexusSDK,           // Main SDK class
  NexusError,         // Error class
  AnalyticsManager,   // Analytics manager
} from '@avail-project/nexus-core';

​
Type Definitions

import type {
  // Operation Parameters
  BridgeParams,
  TransferParams,
  ExecuteParams,
  BridgeAndExecuteParams,
  ExactInSwapInput,
  ExactOutSwapInput,
  
  // Results
  BridgeResult,
  TransferResult,
  ExecuteResult,
  SwapResult,
  
  // Hooks
  OnIntentHook,
  OnAllowanceHook,
  OnSwapIntentHook,
  
  // Balance Types
  UserAsset,
  AssetBreakdown,
  
  // Metadata
  ChainMetadata,
  TokenMetadata,
} from '@avail-project/nexus-core';

​
Constants and Events

import {
  NEXUS_EVENTS,           // Event name constants
  SUPPORTED_CHAINS,       // Supported chain IDs
  CHAIN_METADATA,         // Chain information
  TOKEN_METADATA,         // Token information
  ERROR_CODES,            // Error code constants
  BRIDGE_STEPS,           // Bridge step types
  SWAP_STEPS,             // Swap step types
} from '@avail-project/nexus-core';

​
Utility Functions

import {
  formatTokenBalance,     // Format token amounts for display
  formatUnits,            // Convert from wei to decimal
  parseUnits,             // Convert from decimal to wei
  isValidAddress,         // Validate Ethereum addresses
  truncateAddress,        // Shorten addresses for display
  getSupportedChains,     // Get supported chain list
  getCoinbaseRates,       // Get current token prices
} from '@avail-project/nexus-core';

​
Browser Environment

The SDK works seamlessly in browser environments with bundlers like:
  • Vite
  • Webpack 5+
  • Rollup
  • esbuild
  • Parcel

​
Polyfills

The SDK includes necessary polyfills automatically. No additional configuration is required for most modern bundlers.
If you’re using an older bundler or encounter issues with Node.js built-ins like buffer, you may need to configure polyfills manually.

​
Node.js Environment

The SDK works out of the box in Node.js environments:
node-example.ts
import { NexusSDK } from '@avail-project/nexus-core';
import { ethers } from 'ethers';

const wallet = new ethers.Wallet(privateKey);
const sdk = new NexusSDK({ network: 'mainnet' });
await sdk.initialize(wallet);
For Node.js usage, you’ll need a wallet provider. Popular options include ethers.js, viem, or custom implementations of the EIP-1193 standard.

​
Verification

Verify your installation by creating a simple test file:
test-install.ts
import { NexusSDK, SUPPORTED_CHAINS } from '@avail-project/nexus-core';

console.log('SDK imported successfully!');
console.log('Supported chains:', Object.keys(SUPPORTED_CHAINS));

const sdk = new NexusSDK({ network: 'testnet' });
console.log('SDK instance created:', sdk.isInitialized());
Run it: 
npx tsx test-install.ts
# or
node --loader ts-node/esm test-install.ts
You should see output confirming the SDK is properly installed.

​
Next Steps

Quick Start Guide

Build your first bridge transaction

Configuration

Learn about SDK configuration options
Troubleshooting Installation IssuesIf you encounter installation problems:
  1. Clear your package manager cache: npm cache clean --force
  2. Delete node_modules and lock files, then reinstall
  3. Ensure you’re using Node.js 18+ and npm 9+
  4. Check for conflicting peer dependencies
Still having issues? Visit our GitHub Issues or Discord.

Build docs developers (and LLMs) love

Get started for freeTalk to us