@n1xyz/nord-ts 0.1.5 → 0.1.7

package/dist/types.d.ts

@@ -1,22 +1,7 @@
 import * as proto from "./gen/nord_pb";
 import type { components } from "./gen/openapi.ts";
 import Decimal from "decimal.js";
-/**
- * The peak TPS rate is queried over the specified period.
- * The period is specified in units of: {hour, day, week, month, year}.
- * Example inputs:
- *  1. AggregateMetrics.txPeakTpsPeriod = 3,
- *     AggregateMetrics.txPeakTpsPeriodUnit = "d" => Peak TPS over last 3 days.
- *  1. AggregateMetrics.txPeakTpsPeriod = 1,
- *     AggregateMetrics.txPeakTpsPeriodUnit = "w" => Peak TPS over last week.
- */
-export declare enum PeakTpsPeriodUnit {
-    Hour = "h",
-    Day = "d",
-    Week = "w",
-    Month = "m",
-    Year = "y"
-}
+import { Connection } from "@solana/web3.js";
 /**
  * Nord subscription type for trades or deltas
  */
@@ -35,8 +20,10 @@ export interface NordConfig {
     webServerUrl: string;
     /** App address */
     app: string;
-    /** Solana cluster URL */
-    solanaUrl: string;
+    /** Solana connection */
+    solanaConnection: Connection;
+    /** Proton URL, defaults to webServerUrl */
+    protonUrl?: string;
     /**
      * Whether to initialize WebSockets on creation, defaults to true
      * @deprecated this is a funky api we're gonna be removing it
@@ -99,11 +86,6 @@ export interface Order {
     price: number;
     marketId: number;
 }
-export declare enum KeyType {
-    Ed25519 = 0,
-    Secp256k1 = 1,
-    Bls12_381 = 2
-}
 export declare enum Side {
     Ask = "ask",
     Bid = "bid"
@@ -163,32 +145,6 @@ export interface ActionResponse {
     action: proto.Action;
     physicalExecTime: Date;
 }
-/**
- * Block summary.
- * block_number Block number.
- * from_action_id First action_id in the block.
- * to_action_id Last action_id in the block.
- */
-export interface BlockSummary {
-    block_number: number;
-    from_action_id: number;
-    to_action_id: number;
-}
-/**
- * Aggregate metrics
- * blocks_total: Total number of L2 blocks.
- * tx_total: Total number of transactions.
- * tx_tps: Transaction throughput.
- * tx_tps_peak: Peak transaction throughput.
- * request_latency_average: Average request latency.
- */
-export interface AggregateMetrics {
-    blocks_total: number;
-    tx_total: number;
-    tx_tps: number;
-    tx_tps_peak: number;
-    request_latency_average: number;
-}
 /**
  * Converts a `FillMode` enum to its corresponding protobuf representation.
  *
@@ -212,7 +168,7 @@ export interface OrderbookEntry {
  */
 export interface OrderbookQuery {
     symbol?: string;
-    market_id?: number;
+    marketId?: number;
 }
 /**
  * Response for timestamp query

package/dist/types.js

@@ -36,34 +36,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuoteSize = exports.WebSocketMessageType = exports.TriggerStatus = exports.TriggerKind = exports.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
+exports.QuoteSize = exports.WebSocketMessageType = exports.TriggerStatus = exports.TriggerKind = exports.FillMode = exports.Side = void 0;
 exports.fillModeToProtoFillMode = fillModeToProtoFillMode;
 const proto = __importStar(require("./gen/nord_pb"));
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const utils_1 = require("./utils");
-/**
- * The peak TPS rate is queried over the specified period.
- * The period is specified in units of: {hour, day, week, month, year}.
- * Example inputs:
- *  1. AggregateMetrics.txPeakTpsPeriod = 3,
- *     AggregateMetrics.txPeakTpsPeriodUnit = "d" => Peak TPS over last 3 days.
- *  1. AggregateMetrics.txPeakTpsPeriod = 1,
- *     AggregateMetrics.txPeakTpsPeriodUnit = "w" => Peak TPS over last week.
- */
-var PeakTpsPeriodUnit;
-(function (PeakTpsPeriodUnit) {
-    PeakTpsPeriodUnit["Hour"] = "h";
-    PeakTpsPeriodUnit["Day"] = "d";
-    PeakTpsPeriodUnit["Week"] = "w";
-    PeakTpsPeriodUnit["Month"] = "m";
-    PeakTpsPeriodUnit["Year"] = "y";
-})(PeakTpsPeriodUnit || (exports.PeakTpsPeriodUnit = PeakTpsPeriodUnit = {}));
-var KeyType;
-(function (KeyType) {
-    KeyType[KeyType["Ed25519"] = 0] = "Ed25519";
-    KeyType[KeyType["Secp256k1"] = 1] = "Secp256k1";
-    KeyType[KeyType["Bls12_381"] = 2] = "Bls12_381";
-})(KeyType || (exports.KeyType = KeyType = {}));
 var Side;
 (function (Side) {
     Side["Ask"] = "ask";

package/dist/utils.d.ts

@@ -1,10 +1,11 @@
 import { Decimal } from "decimal.js";
-import { KeyType, type Market, type Token } from "./types";
+import { type Market, type Token } from "./types";
 import { type Message } from "@bufbuild/protobuf";
 import type { GenMessage } from "@bufbuild/protobuf/codegenv2";
 import { ethers } from "ethers";
 import { RequestInfo, RequestInit, Response } from "node-fetch";
 import { Keypair } from "@solana/web3.js";
+import * as solana from "@solana/web3.js";
 export declare const SESSION_TTL: bigint;
 export declare const ZERO_DECIMAL: Decimal;
 export declare const MAX_BUFFER_LEN = 10000;
@@ -12,7 +13,7 @@ export declare const MAX_BUFFER_LEN = 10000;
 export type BigIntValue = bigint | number | string;
 export declare function panic(message: string): never;
 export declare function isRfc3339(s: string): boolean;
-export declare function assert(predicate: boolean, message?: string): void;
+export declare function assert(predicate: boolean, message?: string): asserts predicate;
 /**
  * Extracts value out of optional if it's defined, or throws error if it's not
  * @param value   Optional value to unwrap
@@ -28,14 +29,6 @@ export declare function optExpect<T>(value: T | undefined, message: string): T;
  * @throws      If response wasn't Ok
  */
 export declare function checkedFetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
-/**
- * Signs an action using the specified secret key and key type.
- * @param action - The action data to be signed.
- * @param sk - Secret key used for signing the action.
- * @param keyType - Type of the key used for signing.
- * @returns A new Uint8Array containing the action followed by its signature.
- */
-export declare function signAction(action: Uint8Array, sk: Uint8Array, keyType: KeyType): Uint8Array;
 /**
  * Constructs wallet signing function, usable with `NordUser` type
  *
@@ -78,8 +71,12 @@ export declare const toScaledU128: (x: Decimal.Value, decimals: number) => bigin
  * @returns        Decoded message
  */
 export declare function decodeLengthDelimited<T extends Message>(bytes: Uint8Array, schema: GenMessage<T>): T;
-export declare function checkPubKeyLength(keyType: KeyType, len: number): void;
 export declare function decodeHex(value: string): Uint8Array;
 export declare function findMarket(markets: Market[], marketId: number): Market;
 export declare function findToken(tokens: Token[], tokenId: number): Token;
 export declare function keypairFromPrivateKey(privateKey: string | Uint8Array): Keypair;
+export declare function signUserPayload({ payload, user, signTransaction, }: Readonly<{
+    payload: Uint8Array;
+    user: solana.PublicKey;
+    signTransaction: (tx: solana.Transaction) => Promise<solana.Transaction>;
+}>): Promise<Uint8Array>;

package/dist/utils.js

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -9,26 +42,21 @@ exports.isRfc3339 = isRfc3339;
 exports.assert = assert;
 exports.optExpect = optExpect;
 exports.checkedFetch = checkedFetch;
-exports.signAction = signAction;
 exports.makeWalletSignFn = makeWalletSignFn;
 exports.decodeLengthDelimited = decodeLengthDelimited;
-exports.checkPubKeyLength = checkPubKeyLength;
 exports.decodeHex = decodeHex;
 exports.findMarket = findMarket;
 exports.findToken = findToken;
 exports.keypairFromPrivateKey = keypairFromPrivateKey;
+exports.signUserPayload = signUserPayload;
 const decimal_js_1 = require("decimal.js");
-const ed25519_1 = require("@noble/curves/ed25519");
-const bls12_381_1 = require("@noble/curves/bls12-381");
-const secp256k1_1 = require("@noble/curves/secp256k1");
-const sha256_1 = require("@noble/hashes/sha256");
-const types_1 = require("./types");
 const wire_1 = require("@bufbuild/protobuf/wire");
 const protobuf_1 = require("@bufbuild/protobuf");
 const ethers_1 = require("ethers");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const web3_js_1 = require("@solana/web3.js");
 const bs58_1 = __importDefault(require("bs58"));
+const solana = __importStar(require("@solana/web3.js"));
 exports.SESSION_TTL = 60n * 60n * 24n * 30n;
 exports.ZERO_DECIMAL = new decimal_js_1.Decimal(0);
 exports.MAX_BUFFER_LEN = 10000;
@@ -68,29 +96,6 @@ async function checkedFetch(url, init) {
     assert(resp.ok, `Request failed with ${resp.status}: ${resp.statusText}`);
     return resp;
 }
-/**
- * Signs an action using the specified secret key and key type.
- * @param action - The action data to be signed.
- * @param sk - Secret key used for signing the action.
- * @param keyType - Type of the key used for signing.
- * @returns A new Uint8Array containing the action followed by its signature.
- */
-function signAction(action, sk, keyType) {
-    let sig;
-    if (keyType === types_1.KeyType.Ed25519) {
-        sig = ed25519_1.ed25519.sign(action, sk);
-    }
-    else if (keyType === types_1.KeyType.Bls12_381) {
-        sig = bls12_381_1.bls12_381.sign(action, sk);
-    }
-    else if (keyType === types_1.KeyType.Secp256k1) {
-        sig = secp256k1_1.secp256k1.sign((0, sha256_1.sha256)(action), sk).toCompactRawBytes();
-    }
-    else {
-        throw new Error("Invalid key type");
-    }
-    return new Uint8Array([...action, ...sig]);
-}
 /**
  * Constructs wallet signing function, usable with `NordUser` type
  *
@@ -185,17 +190,6 @@ function decodeLengthDelimited(bytes, schema) {
     // decode the message using the offset and size from peek
     return (0, protobuf_1.fromBinary)(schema, bytes.slice(peekResult.offset, peekResult.offset + peekResult.size));
 }
-function checkPubKeyLength(keyType, len) {
-    if (keyType === types_1.KeyType.Bls12_381) {
-        throw new Error("Cannot create a user using Bls12_381, use Ed25119 or Secp256k1 instead.");
-    }
-    if (len !== 32 && keyType === types_1.KeyType.Ed25519) {
-        throw new Error("Ed25519 pubkeys must be 32 length.");
-    }
-    if (len !== 33 && keyType === types_1.KeyType.Secp256k1) {
-        throw new Error("Secp256k1 pubkeys must be 33 length.");
-    }
-}
 function decodeHex(value) {
     const hex = value.startsWith("0x") ? value.slice(2) : value;
     return Uint8Array.from(Buffer.from(hex, "hex"));
@@ -223,3 +217,22 @@ function keypairFromPrivateKey(privateKey) {
     }
     return web3_js_1.Keypair.fromSecretKey(privateKey);
 }
+async function signUserPayload({ payload, user, signTransaction, }) {
+    const tx = new solana.Transaction({
+        blockhash: bs58_1.default.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.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;
+}

package/dist/websocket/Subscriber.d.ts

@@ -0,0 +1,37 @@
+import { EventEmitter } from "events";
+import { Account, DeltaEvent, OrderbookResponse, SubscriberConfig, StreamTrade, Trades } from "../types";
+/**
+ * Subscriber class for handling WebSocket subscriptions
+ */
+export declare class Subscriber {
+    streamURL: string;
+    buffer: (DeltaEvent | Trades | Account)[];
+    maxBufferLen: number;
+    /**
+     * Create a new Subscriber instance
+     * @param config Subscriber configuration
+     */
+    constructor(config: SubscriberConfig);
+    /**
+     * Subscribe to WebSocket events
+     */
+    subscribe(): void;
+}
+/**
+ * Interface for orderbook subscription
+ */
+export interface OrderbookSubscription extends EventEmitter {
+    on(event: "message", listener: (data: OrderbookResponse) => void): this;
+    on(event: "error", listener: (error: Error) => void): this;
+    close(): void;
+    removeAllListeners(event?: string): this;
+}
+/**
+ * Interface for trade subscription
+ */
+export interface TradeSubscription extends EventEmitter {
+    on(event: "message", listener: (data: StreamTrade[]) => void): this;
+    on(event: "error", listener: (error: Error) => void): this;
+    close(): void;
+    removeAllListeners(event?: string): this;
+}

package/dist/websocket/Subscriber.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscriber = void 0;
+const utils_1 = require("../utils");
+/**
+ * Subscriber class for handling WebSocket subscriptions
+ */
+class Subscriber {
+    /**
+     * Create a new Subscriber instance
+     * @param config Subscriber configuration
+     */
+    constructor(config) {
+        this.streamURL = config.streamURL;
+        this.buffer = [];
+        this.maxBufferLen = config.maxBufferLen ?? utils_1.MAX_BUFFER_LEN;
+    }
+    /**
+     * Subscribe to WebSocket events
+     */
+    subscribe() {
+        // TODO: Implement subscription logic
+    }
+}
+exports.Subscriber = Subscriber;

package/dist/websocket/index.d.ts

@@ -1,2 +1,19 @@
-export { NordWebSocketClient } from "./NordWebSocketClient";
-export type { NordWebSocketEvents, NordWebSocketClientEvents } from "./events";
+import { NordWebSocketClient } from "./NordWebSocketClient";
+import type { SubscriptionPattern } from "../types";
+import type { NordWebSocketEvents, NordWebSocketClientEvents } from "./events";
+import { Subscriber } from "./Subscriber";
+export { NordWebSocketClient, NordWebSocketEvents, NordWebSocketClientEvents, 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 declare function initWebSocketClient(webServerUrl: string, subscriptions?: SubscriptionPattern[] | "trades" | "delta" | "account"): NordWebSocketClient;

package/dist/websocket/index.js

@@ -1,5 +1,85 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NordWebSocketClient = void 0;
-var NordWebSocketClient_1 = require("./NordWebSocketClient");
+exports.Subscriber = exports.NordWebSocketClient = void 0;
+exports.initWebSocketClient = initWebSocketClient;
+const NordWebSocketClient_1 = require("./NordWebSocketClient");
 Object.defineProperty(exports, "NordWebSocketClient", { enumerable: true, get: function () { return NordWebSocketClient_1.NordWebSocketClient; } });
+const error_1 = require("../error");
+const Subscriber_1 = require("./Subscriber");
+Object.defineProperty(exports, "Subscriber", { enumerable: true, get: function () { return Subscriber_1.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
+ */
+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 error_1.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_1.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 error_1.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 error_1.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 error_1.NordError(`Invalid account ID in subscription: ${subscription}. Account ID must be a number.`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n1xyz/nord-ts",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Typescript for Nord",
   "keywords": [],
   "author": "",