NexusSDK Class

Core SDK class for cross-chain operations

Overview

The NexusSDK class is the main entry point for all Avail Nexus SDK operations. It provides methods for:

• Cross-chain token bridging
• Token swapping (exact-in and exact-out)
• Smart contract execution with automatic bridging
• Balance management across chains
• Intent tracking and management

Constructor

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

const sdk = new NexusSDK(config?);

config · object

Configuration options for the SDK

Show properties

network · 'mainnet' | 'testnet' | NetworkConfig · default: "mainnet"

Network environment to use

debug · boolean · default: "false"

Enable debug logging

siweChain · number

Chain ID for SIWE (Sign-In with Ethereum) signing

analytics · AnalyticsConfig

Analytics configuration options

Show properties

enabled · boolean · default: "true"

Enable or disable analytics tracking

posthogApiKey · string

Custom PostHog API key (uses Avail’s instance by default)

posthogApiHost · string

Custom PostHog API host

appMetadata · object

Application metadata for analytics

Show properties

appName · string

Application name

appVersion · string

Application version

appUrl · string

Application URL

privacy · object

Privacy configuration

Show properties

anonymizeWallets · boolean · default: "false"

Anonymize wallet addresses by hashing

anonymizeAmounts · boolean · default: "false"

Exclude transaction amounts from analytics

Properties

utils

sdk.utils: NexusUtils

Utility functions for formatting, validation, and chain information. See Utilities for details.

analytics

sdk.analytics: AnalyticsManager

Analytics manager for tracking events and operations. See the Analytics guide for usage.

hasEvmProvider

sdk.hasEvmProvider: boolean

Indicates whether an EVM provider has been successfully set.

Examples

Basic Initialization

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

const sdk = new NexusSDK({ network: 'mainnet' });
await sdk.initialize(window.ethereum);

With Debug Logging

const sdk = new NexusSDK({
  network: 'mainnet',
  debug: true,
});

With Custom Analytics

const sdk = new NexusSDK({
  network: 'mainnet',
  analytics: {
    enabled: true,
    posthogApiKey: 'your-posthog-key',
    posthogApiHost: 'https://your-posthog-instance.com',
    appMetadata: {
      appName: 'My DApp',
      appVersion: '1.0.0',
    },
    privacy: {
      anonymizeWallets: true,
      anonymizeAmounts: true,
    },
  },
});

Testnet Configuration

const sdk = new NexusSDK({ network: 'testnet' });
await sdk.initialize(provider);

// Now all operations use testnet chains
const balances = await sdk.getBalancesForBridge();

API Reference

For detailed method documentation, see:

• Initialization & Lifecycle
• Balance Operations
• Bridge Operations
• Swap Operations
• Execute Operations
• Intent Management

Related

Initialization

Initialize and manage SDK lifecycle

Quick Start

Get started with the SDK