@n1xyz/nord-ts 0.0.18-8121ed05.0 → 0.0.19

package/dist/nord/models/Subscriber.js

@@ -1,25 +0,0 @@
-"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/nord/utils/NordError.d.ts

@@ -1,35 +0,0 @@
-/**
- * Options for creating a NordError
- */
-export interface NordErrorOptions {
-    /** The original error that caused this error */
-    cause?: unknown;
-    /** HTTP status code (if applicable) */
-    statusCode?: number;
-    /** Additional error details */
-    details?: Record<string, unknown>;
-}
-/**
- * Custom error class for Nord-related errors
- */
-export declare class NordError extends Error {
-    /** The original error that caused this error */
-    readonly cause?: unknown;
-    /** HTTP status code (if applicable) */
-    readonly statusCode?: number;
-    /** Additional error details */
-    readonly details?: Record<string, unknown>;
-    /**
-     * Create a new NordError
-     *
-     * @param message - Error message
-     * @param options - Error options
-     */
-    constructor(message: string, options?: NordErrorOptions);
-    /**
-     * Convert the error to a string representation
-     *
-     * @returns String representation of the error
-     */
-    toString(): string;
-}

package/dist/nord/utils/NordError.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NordError = void 0;
-/**
- * Custom error class for Nord-related errors
- */
-class NordError extends Error {
-    /**
-     * Create a new NordError
-     *
-     * @param message - Error message
-     * @param options - Error options
-     */
-    constructor(message, options = {}) {
-        super(message);
-        this.name = "NordError";
-        this.cause = options.cause;
-        this.statusCode = options.statusCode;
-        this.details = options.details;
-        // Capture stack trace
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, NordError);
-        }
-        // Handle nested errors
-        if (this.cause instanceof Error) {
-            this.stack =
-                this.stack + "\nCaused by: " + (this.cause.stack || this.cause.message);
-        }
-    }
-    /**
-     * Convert the error to a string representation
-     *
-     * @returns String representation of the error
-     */
-    toString() {
-        let result = `${this.name}: ${this.message}`;
-        if (this.statusCode) {
-            result += `  \nstatus: ${this.statusCode}`;
-        }
-        if (this.details && Object.keys(this.details).length > 0) {
-            result += `  \ndetails: ${JSON.stringify(this.details, null, 2)}`;
-        }
-        if (this.cause) {
-            result += `  \ncause: ${this.cause.toString()}`;
-        }
-        return result;
-    }
-}
-exports.NordError = NordError;

package/dist/types.d.ts

@@ -1,407 +0,0 @@
-import * as proto from "./gen/nord";
-/**
- * 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"
-}
-/**
- * Nord subscription type for trades or deltas
- */
-export type SubscriptionType = "trades" | "deltas" | "account";
-/**
- * Pattern for a valid Nord subscription
- * Format should be: "<type>@<parameter>"
- * Examples: "trades@BTCUSDC", "deltas@ETHUSDC", "account@42"
- */
-export type SubscriptionPattern = `${SubscriptionType}@${string}` | string;
-/**
- * Configuration options for the Nord client
- */
-export interface NordConfig {
-    /** Base URL for the Nord web server */
-    webServerUrl: string;
-    /** Bridge verification key */
-    bridgeVk: string;
-    /** Solana cluster URL */
-    solanaUrl: string;
-    /**
-     * Whether to initialize WebSockets on creation, defaults to true
-     * @deprecated this is a funky api we're gonna be removing it
-     */
-    initWebSockets?: boolean;
-}
-/**
- * Configuration options for the Nord client
- */
-export interface TokenInfo {
-    address: string;
-    precision: number;
-    tokenId: number;
-    name: string;
-}
-export interface Order {
-    orderId: number;
-    isLong: boolean;
-    size: number;
-    price: number;
-    marketId: number;
-}
-export declare enum KeyType {
-    Ed25519 = 0,
-    Secp256k1 = 1,
-    Bls12_381 = 2
-}
-export declare enum Side {
-    Ask = 0,
-    Bid = 1
-}
-export declare enum FillMode {
-    Limit = 0,
-    PostOnly = 1,
-    ImmediateOrCancel = 2,
-    FillOrKill = 3
-}
-export interface SubscriberConfig {
-    streamURL: string;
-    maxBufferLen?: number;
-}
-export interface Market {
-    marketId: number;
-    symbol: string;
-    priceDecimals: number;
-    sizeDecimals: number;
-    baseTokenId: number;
-    quoteTokenId: number;
-    frozen: boolean;
-}
-export interface Token {
-    tokenId: number;
-    symbol: string;
-    decimals: number;
-    mintAddr: string;
-}
-export interface Info {
-    markets: Market[];
-    tokens: Token[];
-}
-export interface DeltaEvent {
-    last_update_id: number;
-    update_id: number;
-    market_symbol: string;
-    asks: OrderbookEntry[];
-    bids: OrderbookEntry[];
-}
-export interface Trade {
-    side: Side;
-    price: number;
-    size: number;
-    order_id: number;
-}
-export interface Trades {
-    last_update_id: number;
-    update_id: number;
-    market_symbol: string;
-    trades: Trade[];
-}
-export interface OrderInfo {
-    id: number;
-    reduce_only: boolean;
-    limit_price: number;
-    size: number;
-    account_id: number;
-}
-export interface HashMap<T> {
-    [key: number]: T;
-}
-export interface Account {
-    last_update_id: number;
-    update_id: number;
-    account_id: number;
-    fills: HashMap<number>;
-    places: HashMap<OrderInfo>;
-    cancels: HashMap<OrderInfo>;
-    balances: HashMap<number>;
-}
-/**
- * Query the transactions in the specified L2 block.
- * block_number specifies the block number to query.
- * If not specified, transactions from latest block are returned.
- */
-export interface BlockQuery {
-    block_number?: number;
-}
-/**
- * Response for BlockQuery.
- * block_number specifies the block number being returned.
- * actions are the list of transactions from the block.
- */
-export interface BlockResponse {
-    block_number: number;
-    actions: ActionInfo[];
-}
-/**
- * Response for BlockSummaryQuery.
- * block_summary is the summary of upto the last N blocks.
- * The server can return fewer than last_n block summary if
- * fewer blocks are available or if it exceeds a max cap.
- */
-export interface BlockSummaryResponse {
-    block_summary: BlockSummary[];
-}
-/**
- * Query the action for the specified action id.
- * action_id specifies the action to query.
- */
-export interface ActionQuery {
-    action_id: number;
-}
-/**
- * Response for ActionQuery.
- * block_number the block the action is part of.
- * If the action is not yet included in any block, null is returned.
- * action the transaction.
- */
-export interface ActionResponse {
-    block_number?: number;
-    action: proto.Action;
-}
-/**
- * Query the recent actions
- * last_n requests last N actions.
- */
-export interface ActionsQuery {
-    last_n: number;
-}
-/**
- * Response for ActionsQuery.
- * actions returns upto the last N actions.
- * The server can return fewer than last_n actions if
- * fewer actions are available or if it exceeds a max cap.
- */
-export interface ActionsResponse {
-    actions: ActionsExtendedInfo[];
-}
-/**
- * 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;
-}
-/**
- * Info about the block transaction.
- * action_id is the action identifier.
- * action in protobuf format.
- * exec_timestamp is the execution timestamp.
- */
-export interface ActionInfo {
-    action_id: number;
-    action: proto.Action;
-    exec_timestamp: number;
-}
-/**
- * Extended info about the block transaction.
- * block_number the block the action is part of.
- * If the action is not yet included in any block, null is returned.
- * action_id of the action.
- * action the transaction.
- */
-export interface ActionsExtendedInfo {
-    block_number?: number;
-    action_id: number;
-    action: proto.Action;
-}
-/**
- * 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;
-}
-export interface RollmanBlockResponse {
-    block_number: number;
-    actions: RollmanActionInfo[];
-}
-export interface RollmanActionResponse {
-    block_number?: number;
-    action_pb: Uint8Array;
-    exec_timestamp: number;
-}
-export interface RollmanActionsResponse {
-    actions: RollmanActionExtendedInfo[];
-}
-export interface RollmanActionInfo {
-    action_id: number;
-    action_pb: Uint8Array;
-    exec_timestamp: number;
-}
-export interface RollmanActionExtendedInfo {
-    block_number?: number;
-    action_id: number;
-    action_pb: Uint8Array;
-}
-export interface MarketsStatsResponse {
-    markets: MarketStats[];
-}
-export interface MarketStats {
-    market_id: number;
-    index_price: [number, number];
-    volume_24h: number;
-    high_24h: number;
-    low_24h: number;
-    perp_stats?: PerpMarketStats;
-}
-export interface PerpMarketStats {
-    mark_price?: number;
-    funding_rate?: number;
-    next_funding_time?: Date;
-    open_interest?: number;
-}
-/**
- * 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 declare function fillModeToProtoFillMode(x: FillMode): proto.FillMode;
-/**
- * Response for trades query with pagination support
- */
-export interface TradesResponse {
-    trades: Trade[];
-    accountId: number;
-    since?: string;
-    until?: string;
-    nextPageId?: string;
-}
-/**
- * Query parameters for trades endpoint
- */
-export interface TradesQuery {
-    accountId: number;
-    since?: string;
-    until?: string;
-    pageId?: string;
-}
-/**
- * Response for user account IDs query
- */
-export interface UserAccountIdsResponse {
-    accountIds: number[];
-}
-/**
- * Query parameters for user account IDs
- */
-export interface UserAccountIdsQuery {
-    pubkey: string;
-}
-/**
- * Orderbook entry representing price and size
- */
-export interface OrderbookEntry {
-    price: number;
-    size: number;
-}
-/**
- * Response for orderbook query
- */
-export interface OrderbookResponse {
-    symbol: string;
-    asks: OrderbookEntry[];
-    bids: OrderbookEntry[];
-    timestamp: number;
-}
-/**
- * Query parameters for orderbook
- *
- * Note: While you can provide either symbol or market_id, the API endpoint only accepts market_id.
- * If you provide a symbol, it will be converted to a market_id internally.
- */
-export interface OrderbookQuery {
-    symbol?: string;
-    market_id?: number;
-}
-/**
- * Response for timestamp query
- */
-export interface TimestampResponse {
-    timestamp: number;
-}
-/**
- * Response for action nonce query
- */
-export interface ActionNonceResponse {
-    nonce: number;
-}
-/**
- * WebSocket message types
- */
-export declare enum WebSocketMessageType {
-    Subscribe = "subscribe",
-    Unsubscribe = "unsubscribe",
-    TradeUpdate = "trades",
-    DeltaUpdate = "delta",
-    AccountUpdate = "account"
-}
-/**
- * WebSocket subscription request
- */
-export interface WebSocketSubscription {
-    e: WebSocketMessageType;
-    streams: string[];
-}
-/**
- * WebSocket trade update message
- */
-export interface WebSocketTradeUpdate {
-    e: WebSocketMessageType.TradeUpdate;
-    symbol: string;
-    trades: Trade[];
-    timestamp: number;
-}
-/**
- * WebSocket delta update message
- */
-export interface WebSocketDeltaUpdate {
-    e: WebSocketMessageType.DeltaUpdate;
-    last_update_id: number;
-    update_id: number;
-    market_symbol: string;
-    asks: OrderbookEntry[];
-    bids: OrderbookEntry[];
-    timestamp: number;
-}
-/**
- * WebSocket user update message
- */
-export interface WebSocketAccountUpdate {
-    e: WebSocketMessageType.AccountUpdate;
-    accountId: number;
-    account: Account;
-    timestamp: number;
-}
-export type WebSocketMessage = WebSocketSubscription | WebSocketTradeUpdate | WebSocketDeltaUpdate | WebSocketAccountUpdate;

package/dist/types.js

@@ -1,103 +0,0 @@
-"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;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebSocketMessageType = exports.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
-exports.fillModeToProtoFillMode = fillModeToProtoFillMode;
-const proto = __importStar(require("./gen/nord"));
-/**
- * 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[Side["Ask"] = 0] = "Ask";
-    Side[Side["Bid"] = 1] = "Bid";
-})(Side || (exports.Side = Side = {}));
-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 || (exports.FillMode = FillMode = {}));
-/**
- * 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.
- */
-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
- */
-var WebSocketMessageType;
-(function (WebSocketMessageType) {
-    WebSocketMessageType["Subscribe"] = "subscribe";
-    WebSocketMessageType["Unsubscribe"] = "unsubscribe";
-    WebSocketMessageType["TradeUpdate"] = "trades";
-    WebSocketMessageType["DeltaUpdate"] = "delta";
-    WebSocketMessageType["AccountUpdate"] = "account";
-})(WebSocketMessageType || (exports.WebSocketMessageType = WebSocketMessageType = {}));