Skip to Content
Avail Nexus is now live! Check out our docs to get started.
NexusNexus SDK Overview

Nexus SDK Overview

A powerful TypeScript SDK for cross-chain operations, token bridging, and unified balance management across multiple EVM chains.

Nexus Core

The core functionality of the Nexus SDK is provided by the @avail-project/nexus-core package.

  • @avail-project/nexus-core: Headless SDK for cross-chain operations
    • No React dependencies required
    • Direct Chain Abstraction integration

Install:

Terminal
npm install @avail-project/nexus-core

Next Steps

Nexus Core SDK ReferenceNexus Core Quickstart
  1. Nexus Core SDK still requires an injected wallet provider (e.g. MetaMask, WalletConnect, etc.)
  2. It is designed for client-side browser environments and cannot be used in any server-side environments.

YOU WILL NEED A REACT-BASED FRONTEND

  1. Any React-based dev environment works, including React frameworks like Next.js, Remix, Gatsby, or build tools like Vite, Create React App, and Webpack.
  2. You also need the following peer dependencies: react , react-dom, viem.

Nexus Elements

A shadcn-based component library that allows devs to integrate working components that use the Nexus SDK effectively and conveniently. Nexus Elements currently provides the following components:

  1. Unified Balance Widget (unified-balance)
  2. Deposit Widget (deposit)
  3. Fast Bridge Widget (fast-bridge)
  4. Swaps Widget (swaps)

Install:

  1. Install shadcn/ui into your project. Refer to shadcn/ui installation guide  for more details.

  2. Install the components you need using the shadcn CLI. For example, this is how you would install the unified balance widget:

Terminal
npx shadcn@latest add https://elements.nexus.availproject.org/r/unified-balance.json

Next Steps

Nexus Elements SDK ReferenceNexus Elements Quickstart
Last updated on
SolversQuickstart