LnexSdk SDK

A JavaScript SDK for LN Exchange (LnexSdk) that provides unified access to spot trading, perpetual trading, and utility functions. Built with Nostr protocol integration for secure and decentralized trading.

Features

- Spot Trading: Complete spot trading API with order management
- Perpetual Trading: Full perpetual contracts trading functionality
- Nostr Integration: Secure authentication and communication via Nostr protocol
- TypeScript Support: Full TypeScript definitions included
- Lightweight: Minimal dependencies for optimal performance
- Modern: ES6+ modules with tree-shaking support

Installation

``bash
npm install lnex-sdk

or

yarn add lnex-sdk

or

pnpm add lnex-sdk
`

Quick Start

$3

`javascript
import createLNEX from 'lnex-sdk';

// Initialize the SDK for browser (uses window.nostr automatically)
const lnex = createLNEX();

// Get public key
const publicKey = await lnex.getPublicKey();
console.log('Public Key:', publicKey);

// Use spot trading
const markets = await lnex.spot.getAllMarkets();
const userInfo = await lnex.spot.getUserInfo();

// Use perpetual trading
const perpMarkets = await lnex.perp.getAllMarkets();
const positions = await lnex.perp.getAllPosition();
`

$3

`javascript
import createLNEX from 'lnex-sdk';
import { lnfiNostr } from 'lnfi-sdk';

// Create custom signer using lnfi-sdk
const signer = lnfiNostr({
privateKey: 'your-private-key-here'
});

// Initialize the SDK for Node.js
const lnex = createLNEX({
signer: signer
});

// Get public key
const publicKey = await lnex.getPublicKey();
console.log('Public Key:', publicKey);

// Use spot trading
const markets = await lnex.spot.getAllMarkets();
const userInfo = await lnex.spot.getUserInfo();
`

API Reference

$3

Parameters:
- env (optional): Environment ('development' | 'production', default: 'production')
- spotBaseURL (optional): Base URL for spot trading API (default: 'https://test-spots-api.ln.exchange')
- perpBaseURL (optional): Base URL for perpetual trading API (default: 'https://test-futures-api.ln.exchange')
- relay (optional): Nostr relay URL(s) - string or array (default: 'wss://relay01.lnfi.network')
- signer (optional): Custom signer instance (auto-detected from window.nostr if not provided)
- headers (optional): Additional HTTP headers object (default: {})

Spot Trading API

$3

#### createUser(referrals?)
Creates a new user account.
- Parameters:
- referrals (string, optional): Referral code
- Returns: Promise