@n1xyz/nord-ts 0.2.0 → 0.3.2

package/dist/gen/openapi.js

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export {};

package/dist/index.js

@@ -1,10 +0,0 @@
-export * from "./types";
-export * from "./utils";
-export * from "./const";
-export * from "./error";
-export * from "./websocket/index";
-export * from "./client/Nord";
-export * from "./client/NordUser";
-export * from "./client/NordAdmin";
-export * as proto from "./gen/nord_pb";
-export * as openapi from "./gen/openapi";

package/dist/types.js

@@ -1,92 +0,0 @@
-import * as proto from "./gen/nord_pb";
-import Decimal from "decimal.js";
-import { toScaledU64 } from "./utils";
-export var Side;
-(function (Side) {
-    Side["Ask"] = "ask";
-    Side["Bid"] = "bid";
-})(Side || (Side = {}));
-export var FillMode;
-(function (FillMode) {
-    FillMode[FillMode["Limit"] = 0] = "Limit";
-    FillMode[FillMode["PostOnly"] = 1] = "PostOnly";
-    FillMode[FillMode["ImmediateOrCancel"] = 2] = "ImmediateOrCancel";
-    FillMode[FillMode["FillOrKill"] = 3] = "FillOrKill";
-})(FillMode || (FillMode = {}));
-export var TriggerKind;
-(function (TriggerKind) {
-    TriggerKind[TriggerKind["StopLoss"] = 0] = "StopLoss";
-    TriggerKind[TriggerKind["TakeProfit"] = 1] = "TakeProfit";
-})(TriggerKind || (TriggerKind = {}));
-export var TriggerStatus;
-(function (TriggerStatus) {
-    TriggerStatus[TriggerStatus["Active"] = 0] = "Active";
-    TriggerStatus[TriggerStatus["Success"] = 1] = "Success";
-    TriggerStatus[TriggerStatus["Cancel"] = 2] = "Cancel";
-    TriggerStatus[TriggerStatus["Remove"] = 4] = "Remove";
-})(TriggerStatus || (TriggerStatus = {}));
-/**
- * Converts a `FillMode` enum to its corresponding protobuf representation.
- *
- * @param x - The fill mode to convert.
- * @returns The corresponding protobuf fill mode.
- * @throws Will throw an error if provided with an invalid fill mode.
- */
-export function fillModeToProtoFillMode(x) {
-    if (x === FillMode.Limit)
-        return proto.FillMode.LIMIT;
-    if (x === FillMode.PostOnly)
-        return proto.FillMode.POST_ONLY;
-    if (x === FillMode.ImmediateOrCancel) {
-        return proto.FillMode.IMMEDIATE_OR_CANCEL;
-    }
-    if (x === FillMode.FillOrKill)
-        return proto.FillMode.FILL_OR_KILL;
-    throw new Error("Invalid fill mode");
-}
-/**
- * WebSocket message types
- */
-export var WebSocketMessageType;
-(function (WebSocketMessageType) {
-    WebSocketMessageType["TradeUpdate"] = "trades";
-    WebSocketMessageType["DeltaUpdate"] = "delta";
-    WebSocketMessageType["AccountUpdate"] = "account";
-})(WebSocketMessageType || (WebSocketMessageType = {}));
-// Positive decimal price and size.
-// Example:
-// ```
-// const limit = new QuoteSize(new Decimal(114000), new Decimal(0.00035)),
-//```
-// Gives 40$ USD limit.
-//
-// Given price is same(or very close) to the market price,
-// limit gives size tick as close as possible to settlemnt size tick.
-// If you want to get smaller tick on client (on server it will not change),
-// do `new QuoteSize(new Decimal(114000/2), new Decimal(0.00070))`.
-// It will be 40$ limit, but may help if BTC suddently moves fast.
-export class QuoteSize {
-    price;
-    size;
-    /// Input can be only positive values.
-    constructor(quotePrice, quoteSize) {
-        const p = new Decimal(quotePrice);
-        const s = new Decimal(quoteSize);
-        if (!p.isPositive() || !s.isPositive()) {
-            throw new Error("quotePrice and quoteSize must be positive");
-        }
-        this.price = p;
-        this.size = s;
-    }
-    // USD value of limit, use for debug
-    value() {
-        return this.price.mul(this.size);
-    }
-    // Converts to wire format to be send to server, scaling price and size according to market decimals.
-    toWire(marketPriceDecimals, marketSizeDecimals) {
-        return {
-            price: toScaledU64(this.price, marketPriceDecimals),
-            size: toScaledU64(this.size, marketSizeDecimals),
-        };
-    }
-}

package/dist/utils.js

@@ -1,193 +0,0 @@
-import { Decimal } from "decimal.js";
-import { sizeDelimitedPeek } from "@bufbuild/protobuf/wire";
-import { fromBinary } from "@bufbuild/protobuf";
-import { ethers } from "ethers";
-import fetch from "node-fetch";
-import { Keypair } from "@solana/web3.js";
-import bs58 from "bs58";
-import * as solana from "@solana/web3.js";
-import { Buffer } from "buffer";
-export const SESSION_TTL = 60n * 60n * 24n * 30n;
-export const ZERO_DECIMAL = new Decimal(0);
-export const MAX_BUFFER_LEN = 10_000;
-// Max size of data returned from Nord endpoints
-const MAX_PAYLOAD_SIZE = 100 * 1024; // 100 kB
-export function panic(message) {
-    throw new Error(message);
-}
-export function isRfc3339(s) {
-    const REGEX = /^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$/;
-    return REGEX.test(s);
-}
-export function assert(predicate, message) {
-    if (!predicate)
-        panic(message ?? "Assertion violated");
-}
-/**
- * Extracts value out of optional if it's defined, or throws error if it's not
- * @param value   Optional value to unwrap
- * @param message Error message
- * @returns       Unwrapped value
- */
-export function optExpect(value, message) {
-    if (value === undefined)
-        throw new Error(message);
-    return value;
-}
-/** Behaves same as `node-fetch/fetch` but throws if response is a failure
- *
- * @param url   Request HTTP URL
- * @param init  Request parameters
- * @returns     Raw response if fetch succeeded
- * @throws      If response wasn't Ok
- */
-export async function checkedFetch(url, init) {
-    const resp = await fetch(url, init);
-    assert(resp.ok, `Request failed with ${resp.status}: ${resp.statusText}`);
-    return resp;
-}
-/**
- * Constructs wallet signing function, usable with `NordUser` type
- *
- * @param walletKey   Either raw signing key as bytes array or hex string prefixed with `"0x"`
- * @returns           Async function which accepts arbitrary message, generates its digets,
- *                    then signs it with provided user wallet key and returns signature
- *                    as hex string prefixed with `"0x"`
- */
-export function makeWalletSignFn(walletKey) {
-    const signingKey = new ethers.SigningKey(walletKey);
-    return async (message) => signingKey.sign(ethers.hashMessage(message)).serialized;
-}
-// Returned numbers do fit into specified bits range, or error is thrown.
-function makeToScaledBigUint(params) {
-    const Dec = Decimal.clone({
-        precision: params.precision,
-        toExpPos: params.exponent,
-        toExpNeg: -params.exponent,
-    });
-    const Ten = new Dec(10);
-    const Max = new Dec(((1n << BigInt(params.bits)) - 1n).toString());
-    return (x, decimals) => {
-        const dec = new Dec(x);
-        if (dec.isZero()) {
-            return 0n;
-        }
-        if (dec.isNeg()) {
-            throw new Error(`Number is negative`);
-        }
-        const scaled = Ten.pow(decimals).mul(dec).truncated();
-        if (scaled.isZero()) {
-            throw new Error(`Precision loss when converting ${dec} to scaled integer`);
-        }
-        if (scaled.greaterThan(Max)) {
-            throw new Error(`Integer is out of range: ${scaled} exceeds limit ${Max}`);
-        }
-        return BigInt(scaled.toString());
-    };
-}
-/**
- * Converts decimal value into rescaled 64-bit unsigned integer
- * by scaling it up by specified number of decimal digits.
- *
- * Ensures that number won't accidentally become zero
- * or exceed U64's value range
- *
- * @param x         Decimal value to rescale
- * @param decimals  Number of decimal digits
- * @returns         Rescaled unsigned integer
- */
-export const toScaledU64 = makeToScaledBigUint({
-    bits: 64,
-    precision: 20,
-    exponent: 28,
-});
-/**
- * Converts decimal value into rescaled 128-bit unsigned integer
- * by scaling it up by specified number of decimal digits.
- *
- * Ensures that number won't accidentally become zero
- * or exceed U128's value range
- *
- * @param x         Decimal value to rescale
- * @param decimals  Number of decimal digits
- * @returns         Rescaled unsigned integer
- */
-export const toScaledU128 = makeToScaledBigUint({
-    bits: 128,
-    precision: 40,
-    exponent: 56,
-});
-/**
- * Decodes any protobuf message from a length-delimited format,
- * i.e. prefixed with its length encoded as varint
- *
- * @param   bytes  Byte array with encoded message
- * @param   schema Message schema for decoding
- * @returns        Decoded message
- */
-export function decodeLengthDelimited(bytes, schema) {
-    // use sizeDelimitedPeek to extract the message length and offset
-    const peekResult = sizeDelimitedPeek(bytes);
-    if (peekResult.size === null || peekResult.offset === null) {
-        throw new Error("Failed to parse size-delimited message");
-    }
-    if (peekResult.size > MAX_PAYLOAD_SIZE) {
-        throw new Error(`Encoded message size (${peekResult.size} bytes) is greater than max payload size (${MAX_PAYLOAD_SIZE} bytes).`);
-    }
-    if (peekResult.offset + peekResult.size > bytes.length) {
-        throw new Error(`Encoded message size (${peekResult.size} bytes) is greater than remaining buffer size (${bytes.length - peekResult.offset} bytes).`);
-    }
-    // decode the message using the offset and size from peek
-    return fromBinary(schema, bytes.slice(peekResult.offset, peekResult.offset + peekResult.size));
-}
-export function decodeHex(value) {
-    const hex = value.startsWith("0x") ? value.slice(2) : value;
-    return Uint8Array.from(Buffer.from(hex, "hex"));
-}
-export function findMarket(markets, marketId) {
-    if (marketId < 0 || markets.length - 1 < marketId) {
-        throw new Error(`The market with marketId=${marketId} not found`);
-    }
-    return markets[marketId];
-}
-export function findToken(tokens, tokenId) {
-    if (tokenId < 0 || tokens.length - 1 < tokenId) {
-        throw new Error(`The token with tokenId=${tokenId} not found`);
-    }
-    return tokens[tokenId];
-}
-export function keypairFromPrivateKey(privateKey) {
-    if (typeof privateKey === "string") {
-        if (!privateKey.startsWith("0x")) {
-            return Keypair.fromSecretKey(bs58.decode(privateKey));
-        }
-        const hex = privateKey.startsWith("0x") ? privateKey.slice(2) : privateKey;
-        const bytes = new Uint8Array(hex.match(/.{1,2}/g).map((byte) => parseInt(byte, 16)));
-        return Keypair.fromSecretKey(bytes);
-    }
-    return Keypair.fromSecretKey(privateKey);
-}
-export async function signAdminPayload({ payload, user, signTransaction, }) {
-    const tx = new solana.Transaction({
-        blockhash: bs58.encode(new Uint8Array(32)),
-        lastValidBlockHeight: 0,
-        feePayer: user,
-    });
-    tx.add(new solana.TransactionInstruction({
-        keys: [],
-        programId: user,
-        data: Buffer.from(payload),
-    }));
-    const signedTx = await signTransaction(tx);
-    const sig = signedTx.signatures[0];
-    assert(sig !== undefined, //.
-    "signed transaction must have a signature");
-    assert(sig.signature !== null, "signature must be non-null; check your signTransaction function");
-    assert(sig.signature.length === 64, //.
-    "signature must be 64 bytes");
-    assert(sig.publicKey.equals(user), `signature is for ${sig.publicKey}, expected ${user}`);
-    return sig.signature;
-}
-export async function signUserPayload({ payload, signMessage, }) {
-    return await signMessage(new TextEncoder().encode(payload.toHex()));
-}

package/dist/websocket/NordWebSocketClient.js

@@ -1,242 +0,0 @@
-import { EventEmitter } from "events";
-import WebSocket from "ws";
-const VALID_STREAM_TYPES = ["trades", "delta", "account"];
-/**
- * WebSocket client for Nord exchange
- *
- * This client connects to one of the specific Nord WebSocket endpoints:
- *
- * Each endpoint handles a specific type of data and subscriptions must match
- * the endpoint type (e.g., only 'trades@BTCUSDC' subscriptions are valid on
- * the /ws/trades endpoint).
- */
-export class NordWebSocketClient extends EventEmitter {
-    ws = null;
-    url;
-    reconnectAttempts = 0;
-    maxReconnectAttempts = 5;
-    reconnectDelay = 1000;
-    pingInterval = null;
-    pingTimeout = null;
-    isBrowser;
-    /**
-     * Create a new NordWebSocketClient
-     * @param url WebSocket server URL
-     */
-    constructor(url) {
-        super();
-        this.url = url;
-        // Check if we're in a browser environment
-        // The most reliable way is to check for Node.js process
-        this.isBrowser =
-            typeof process === "undefined" ||
-                !process.versions ||
-                !process.versions.node;
-    }
-    /**
-     * Validate stream format
-     * @param stream Stream identifier to validate
-     * @throws Error if stream format is invalid
-     */
-    validateStream(stream) {
-        const [type, params] = stream.split("@");
-        if (!type || !params) {
-            throw new Error(`Invalid stream format: ${stream}. Expected format: <type>@<params>`);
-        }
-        // Extract the endpoint from the URL
-        const urlPath = new URL(this.url).pathname;
-        const endpoint = urlPath.split("/").pop();
-        // Ensure the stream type matches the endpoint we're connected to
-        if (endpoint && type !== endpoint) {
-            throw new Error(`Stream type '${type}' doesn't match the connected endpoint '${endpoint}'`);
-        }
-        if (!VALID_STREAM_TYPES.includes(type)) {
-            throw new Error(`Invalid stream type: ${type}. Valid types are: ${VALID_STREAM_TYPES.join(", ")}`);
-        }
-        if (type === "account" && !/^\d+$/.test(params)) {
-            throw new Error(`Invalid account ID in stream: ${params}. Expected numeric ID`);
-        }
-    }
-    /**
-     * Setup WebSocket ping/pong heartbeat
-     */
-    setupHeartbeat() {
-        if (this.pingInterval) {
-            clearInterval(this.pingInterval);
-        }
-        if (this.pingTimeout) {
-            clearTimeout(this.pingTimeout);
-        }
-        // In browser, we rely on the browser's WebSocket implementation to handle ping/pong
-        if (this.isBrowser) {
-            return;
-        }
-        this.pingInterval = setInterval(() => {
-            if (this.ws && !this.isBrowser) {
-                // Only use ping() method in Node.js environment
-                this.ws.ping();
-                // Set timeout for pong response
-                this.pingTimeout = setTimeout(() => {
-                    this.emit("error", new Error("WebSocket ping timeout"));
-                    this.close();
-                    this.reconnect();
-                }, 5000); // 5 second timeout
-            }
-        }, 30000); // Send ping every 30 seconds
-    }
-    /**
-     * Get the appropriate WebSocket class based on environment
-     */
-    getWebSocketClass() {
-        if (this.isBrowser) {
-            // In browser environments
-            if (typeof globalThis !== "undefined" && globalThis.WebSocket) {
-                return globalThis.WebSocket;
-            }
-            throw new Error("WebSocket is not available in this environment");
-        }
-        else {
-            // In Node.js
-            return WebSocket;
-        }
-    }
-    /**
-     * Connect to the Nord WebSocket server
-     */
-    connect() {
-        if (this.ws) {
-            return;
-        }
-        try {
-            const WebSocketClass = this.getWebSocketClass();
-            if (this.isBrowser) {
-                // Browser WebSocket setup
-                this.ws = new WebSocketClass(this.url);
-                this.ws.onopen = () => {
-                    this.emit("connected");
-                    this.reconnectAttempts = 0;
-                    this.reconnectDelay = 1000;
-                };
-                this.ws.onmessage = (event) => {
-                    try {
-                        const message = JSON.parse(event.data);
-                        this.handleMessage(message);
-                    }
-                    catch (error) {
-                        this.emit("error", new Error(`Failed to parse message: ${error instanceof Error ? error.message : String(error)}`));
-                    }
-                };
-                this.ws.onclose = (_event) => {
-                    this.emit("disconnected");
-                    this.reconnect();
-                };
-                this.ws.onerror = (event) => {
-                    const errorMsg = `WebSocket error: ${event && event.type ? event.type : "unknown"}`;
-                    this.emit("error", new Error(errorMsg));
-                };
-            }
-            else {
-                // Node.js WebSocket setup
-                const nodeWs = new WebSocketClass(this.url);
-                this.ws = nodeWs;
-                nodeWs.on("open", () => {
-                    this.emit("connected");
-                    this.reconnectAttempts = 0;
-                    this.reconnectDelay = 1000;
-                    this.setupHeartbeat();
-                });
-                nodeWs.on("message", (data) => {
-                    try {
-                        const message = JSON.parse(data.toString());
-                        this.handleMessage(message);
-                    }
-                    catch (error) {
-                        this.emit("error", new Error(`Failed to parse message: ${error instanceof Error ? error.message : String(error)}`));
-                    }
-                });
-                nodeWs.on("close", (_code, _reason) => {
-                    this.emit("disconnected");
-                    if (this.pingInterval) {
-                        clearInterval(this.pingInterval);
-                    }
-                    if (this.pingTimeout) {
-                        clearTimeout(this.pingTimeout);
-                    }
-                    this.reconnect();
-                });
-                nodeWs.on("error", (error) => {
-                    this.emit("error", error);
-                });
-                nodeWs.on("pong", () => {
-                    if (this.pingTimeout) {
-                        clearTimeout(this.pingTimeout);
-                    }
-                });
-            }
-        }
-        catch (error) {
-            const errorMsg = `Failed to initialize WebSocket: ${error instanceof Error ? error.message : String(error)}`;
-            this.emit("error", new Error(errorMsg));
-        }
-    }
-    /**
-     * Close the WebSocket connection
-     */
-    close() {
-        if (this.ws) {
-            if (this.isBrowser) {
-                this.ws.close();
-            }
-            else {
-                this.ws.close();
-            }
-            this.ws = null;
-        }
-        if (this.pingInterval) {
-            clearInterval(this.pingInterval);
-            this.pingInterval = null;
-        }
-        if (this.pingTimeout) {
-            clearTimeout(this.pingTimeout);
-            this.pingTimeout = null;
-        }
-    }
-    /**
-     * Handle incoming WebSocket messages
-     * @param message WebSocket message
-     */
-    handleMessage(message) {
-        if (!message || typeof message !== "object") {
-            this.emit("error", new Error(`Unexpected message type: ${message}`));
-            return;
-        }
-        const hasOwn = (k) => Object.prototype.hasOwnProperty.call(message, k);
-        if (hasOwn("trades")) {
-            this.emit("trades", message.trades);
-            return;
-        }
-        if (hasOwn("delta")) {
-            this.emit("delta", message.delta);
-            return;
-        }
-        if (hasOwn("account")) {
-            this.emit("account", message.account);
-            return;
-        }
-        this.emit("error", new Error(`Unexpected message type: ${message}`));
-    }
-    /**
-     * Attempt to reconnect to the WebSocket server
-     */
-    reconnect() {
-        if (this.reconnectAttempts >= this.maxReconnectAttempts) {
-            this.emit("error", new Error("Max reconnection attempts reached"));
-            return;
-        }
-        setTimeout(() => {
-            this.reconnectAttempts++;
-            this.reconnectDelay *= 2; // Exponential backoff
-            this.connect();
-        }, this.reconnectDelay);
-    }
-}

package/dist/websocket/Subscriber.js

@@ -1,24 +0,0 @@
-import { MAX_BUFFER_LEN } from "../utils";
-/**
- * Subscriber class for handling WebSocket subscriptions
- */
-export class Subscriber {
-    streamURL;
-    buffer;
-    maxBufferLen;
-    /**
-     * Create a new Subscriber instance
-     * @param config Subscriber configuration
-     */
-    constructor(config) {
-        this.streamURL = config.streamURL;
-        this.buffer = [];
-        this.maxBufferLen = config.maxBufferLen ?? MAX_BUFFER_LEN;
-    }
-    /**
-     * Subscribe to WebSocket events
-     */
-    subscribe() {
-        // TODO: Implement subscription logic
-    }
-}

package/dist/websocket/events.js

@@ -1 +0,0 @@
-export {};

package/dist/websocket/index.js

@@ -1,80 +0,0 @@
-import { NordWebSocketClient } from "./NordWebSocketClient";
-import { NordError } from "../error";
-import { Subscriber } from "./Subscriber";
-export { NordWebSocketClient, Subscriber, };
-/**
- * Initialize a WebSocket client for Nord
- *
- * Connects to the Nord WebSocket endpoint with support for multiple subscription types:
- * - trades@SYMBOL - For trade updates
- * - deltas@SYMBOL - For orderbook delta updates
- * - account@ACCOUNT_ID - For user-specific updates
- *
- * @param webServerUrl - Base URL for the Nord web server
- * @param subscriptions - Array of subscriptions (e.g., ["trades@BTCUSDC", "deltas@BTCUSDC", "account@42"])
- * @returns WebSocket client
- * @throws {NordError} If initialization fails or invalid subscription is provided
- */
-export function initWebSocketClient(webServerUrl, subscriptions) {
-    try {
-        // Determine URL and subscriptions based on parameters
-        let wsUrl = webServerUrl.replace(/^http/, "ws") + `/ws`;
-        // Validate subscriptions parameter
-        if (typeof subscriptions === "string") {
-            // Legacy mode - handle endpoint string
-            if (subscriptions === "trades" ||
-                subscriptions === "delta" ||
-                subscriptions === "account") {
-                wsUrl += `/${subscriptions}`;
-            }
-            else {
-                throw new NordError(`Invalid endpoint: ${subscriptions}. Must be "trades", "deltas", or "account".`);
-            }
-        }
-        else if (Array.isArray(subscriptions) && subscriptions.length > 0) {
-            // New mode - validate and combine subscriptions in URL
-            subscriptions.forEach(validateSubscription);
-            wsUrl += `/${subscriptions.join("&")}`;
-        }
-        else {
-            // Default to trades endpoint if no subscriptions specified
-            wsUrl += `/trades`;
-        }
-        console.log(`Initializing WebSocket client with URL: ${wsUrl}`);
-        // Create and connect the WebSocket client
-        const ws = new NordWebSocketClient(wsUrl);
-        // Add error handler
-        ws.on("error", (error) => {
-            console.error("Nord WebSocket error:", error);
-        });
-        // Add connected handler for debugging
-        ws.on("connected", () => {
-            console.log("Nord WebSocket connected successfully");
-        });
-        // Connect the WebSocket
-        ws.connect();
-        return ws;
-    }
-    catch (error) {
-        console.error("Failed to initialize WebSocket client:", error);
-        throw new NordError("Failed to initialize WebSocket client", {
-            cause: error,
-        });
-    }
-}
-/**
- * Validates a subscription string follows the correct format
- *
- * @param subscription - The subscription to validate
- * @throws {NordError} If the subscription format is invalid
- */
-function validateSubscription(subscription) {
-    const [type, param] = subscription.split("@");
-    if (!type || !param || !["trades", "deltas", "account"].includes(type)) {
-        throw new NordError(`Invalid subscription format: ${subscription}. Expected format: "trades@SYMBOL", "deltas@SYMBOL", or "account@ID"`);
-    }
-    // Additional validation for account subscriptions
-    if (type === "account" && isNaN(Number(param))) {
-        throw new NordError(`Invalid account ID in subscription: ${subscription}. Account ID must be a number.`);
-    }
-}