TypeScript SDK

A TypeScript SDK for interacting with the Nexus DEX

Overview

The Nexus TypeScript SDK provides a simple interface for trading, accessing market data, and managing accounts on the Nexus DEX. This SDK supports both REST and WS API connections.

Features

• Fully typed

• Minimal dependencies

• Integratable: Easy to use with wallet providers like viem or ethers

• Documented: JSDoc annotations with usage examples

• Tree-shaking friendly: Easily import only the API calls you need for minimal bundle size

Installation

NodeJS

npm i @nexus-xyz/nexus-ts-sdk
yarn add @nexus-xyz/nexus-ts-sdk
pnpm add @nexus-xyz/nexus-ts-sdk

Web

The SDK is fully browser-compatible. Integrate via CDN or bundle it with your application.

<script type="module">
    import * as nex from "https://esm.sh/jsr/@nexus-xyz/nexus-ts-sdk"
</script>

React Native / Expo

For React Native you need to import polyfills before importing the SDK:

import "fast-text-encoding"; // `TextEncoder` (utf-8)
import "event-target-polyfill"; // `EventTarget`, `Event`
import * as nex from "@nexus-xys/nexus-sdk";

Quick Start

Info Endpoint

// 1. Import module
import * as nex from "@nexus-xyz/nexus-ts-sdk";

// 2. Set up client with transport
const infoClient = new nex.InfoClient({
    transport: new nex.HttpTranspot(), // or `WebSocketTransport`
});

// 3. Query data
const openOrders = await infoClient.openOrders({ user: "0x..." });

Exchange Endpoint

// 1. Import module
import * as nex from "@nexus-xyz/nexus-ts-sdk";

// 2. Set up client with wallet and transport
const exchClient = new nex.ExchangeClient({
  wallet: "0x...", // `viem`, `ethers`, or private key directly
  transport: new nex.HttpTransport(), // or `WebSocketTransport`
});

// 3. Execute an action
const result = await exchClient.order({
  orders: [{
    a: 0,
    b: true,
    p: "30000",
    s: "0.1",
    r: false,
    t: {
      limit: {
        tif: "Gtc",
      },
    },
  }],
  grouping: "na",
});