@n1xyz/nord-ts 0.1.6 → 0.1.8

package/src/nord/index.ts

@@ -1,25 +0,0 @@
-// Export main client classes
-export { Nord } from "./client/Nord";
-export { NordUser } from "./client/NordUser";
-export { NordAdmin, AclRole } from "./client/NordAdmin";
-export { NordClient } from "./client/NordClient";
-export type { NordClientParams } from "./client/NordClient";
-export type {
-  CreateTokenParams,
-  CreateMarketParams,
-  PythSetWormholeGuardiansParams,
-  PythSetSymbolFeedParams,
-  FreezeMarketParams,
-  UnfreezeMarketParams,
-} from "./client/NordAdmin";
-
-// Export utility classes
-export { NordError } from "./utils/NordError";
-
-// Export API modules
-export * from "./api/core";
-export * from "./api/metrics";
-export * from "./api/actions";
-
-// Export models
-export * from "./models/Subscriber";

package/src/nord/models/Subscriber.ts

@@ -1,56 +0,0 @@
-import { EventEmitter } from "events";
-import {
-  Account,
-  DeltaEvent,
-  OrderbookResponse,
-  SubscriberConfig,
-  StreamTrade,
-  Trades,
-} from "../../types";
-import { MAX_BUFFER_LEN } from "../../utils";
-
-/**
- * Subscriber class for handling WebSocket subscriptions
- */
-export class Subscriber {
-  streamURL: string;
-  buffer: (DeltaEvent | Trades | Account)[];
-  maxBufferLen: number;
-
-  /**
-   * Create a new Subscriber instance
-   * @param config Subscriber configuration
-   */
-  constructor(config: SubscriberConfig) {
-    this.streamURL = config.streamURL;
-    this.buffer = [];
-    this.maxBufferLen = config.maxBufferLen ?? MAX_BUFFER_LEN;
-  }
-
-  /**
-   * Subscribe to WebSocket events
-   */
-  subscribe(): void {
-    // TODO: Implement subscription logic
-  }
-}
-
-/**
- * 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/src/nord/utils/NordError.ts

@@ -1,76 +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 class NordError extends Error {
-  /** The original error that caused this error */
-  public readonly cause?: unknown;
-
-  /** HTTP status code (if applicable) */
-  public readonly statusCode?: number;
-
-  /** Additional error details */
-  public readonly details?: Record<string, unknown>;
-
-  /**
-   * Create a new NordError
-   *
-   * @param message - Error message
-   * @param options - Error options
-   */
-  constructor(message: string, options: NordErrorOptions = {}) {
-    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(): string {
-    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;
-  }
-}

package/src/types.ts

@@ -1,377 +0,0 @@
-import * as proto from "./gen/nord_pb";
-import type { components } from "./gen/openapi.ts";
-import Decimal from "decimal.js";
-import { toScaledU64 } from "./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.
- */
-export 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;
-  /** App address */
-  app: string;
-  /** Solana cluster URL */
-  solanaUrl: string;
-  /** Proton URL, defaults to webServerUrl */
-  // TODO: this is ass. move to NordUser.
-  protonUrl?: string;
-  /**
-   * Whether to initialize WebSockets on creation, defaults to true
-   * @deprecated this is a funky api we're gonna be removing it
-   */
-  initWebSockets?: boolean;
-}
-
-export type MarketsInfo = components["schemas"]["MarketsInfo"];
-export type Market = MarketsInfo["markets"][number];
-export type Token = MarketsInfo["tokens"][number];
-export type Account = components["schemas"]["Account"];
-export type TradesResponse =
-  components["schemas"]["PageResult_for_String_and_Trade"];
-export type User = components["schemas"]["User"];
-export type OrderbookResponse = components["schemas"]["OrderbookInfo"];
-export type MarketStats = components["schemas"]["MarketStats"];
-export type OrderbookInfo = components["schemas"]["OrderbookInfo"];
-export type MarketStatsFromApi = components["schemas"]["MarketStats"];
-export type TradeFromApi = components["schemas"]["Trade"];
-// Generic PageResult type - note that K and V must match existing schema keys
-export type PageResult<K extends string, V extends string> = K extends "String"
-  ? V extends "OrderInfo"
-    ? components["schemas"]["PageResult_for_String_and_OrderInfo"]
-    : V extends "Trade"
-      ? components["schemas"]["PageResult_for_String_and_Trade"]
-      : never
-  : never;
-export type PageResultStringOrderInfo =
-  components["schemas"]["PageResult_for_String_and_OrderInfo"];
-export type PageResultStringTrade =
-  components["schemas"]["PageResult_for_String_and_Trade"];
-export type OrderInfoFromApi = components["schemas"]["OrderInfo"];
-export type OpenOrder = components["schemas"]["OpenOrder"];
-export type Balance = components["schemas"]["Balance"];
-export type PositionSummary = components["schemas"]["PositionSummary"];
-export type PerpPosition = components["schemas"]["PerpPosition"];
-export type AccountMarginsView = components["schemas"]["AccountMarginsView"];
-export type SideSummary = components["schemas"]["SideSummary"];
-export type UserSession = components["schemas"]["UserSession"];
-export type ActionsItem = components["schemas"]["ActionsItem"];
-export type FillRole = components["schemas"]["FillRole"];
-export type PerpMarketStatsFromApi = components["schemas"]["PerpMarketStats"];
-export type SideFromApi = components["schemas"]["Side"];
-export type FillModeFromApi = components["schemas"]["FillMode"];
-export type PlacementOrigin = components["schemas"]["PlacementOrigin"];
-export type FinalizationReason = components["schemas"]["FinalizationReason"];
-export type AccountPnlQuery = components["schemas"]["AccountPnlQuery"];
-export type AccountPnl = components["schemas"]["AccountPnl"];
-export type AccountPnlPage =
-  components["schemas"]["PageResult_for_uint64_and_AccountPnl"];
-export type AccountTriggerInfo = components["schemas"]["AccountTriggerInfo"];
-export type TriggerHistoryPage =
-  components["schemas"]["PageResult_for_uint64_and_HistoryTriggerInfo"];
-export type HistoryTriggerQuery = components["schemas"]["AccountTriggersQuery"];
-export type FeeTierConfig = components["schemas"]["FeeTierConfig"];
-export type FeeTierId = components["schemas"]["FeeTierId"];
-export type TokenStats = components["schemas"]["TokenStats"];
-export type AccountFeeTier = components["schemas"]["AccountFeeTier"];
-export type AccountFeeTierPage =
-  components["schemas"]["PageResult_for_uint32_and_AccountFeeTier"];
-
-/**
- * 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 enum KeyType {
-  Ed25519,
-  Secp256k1,
-  Bls12_381,
-}
-
-export enum Side {
-  Ask = "ask",
-  Bid = "bid",
-}
-
-export enum FillMode {
-  Limit,
-  PostOnly,
-  ImmediateOrCancel,
-  FillOrKill,
-}
-
-export enum TriggerKind {
-  StopLoss = 0,
-  TakeProfit = 1,
-}
-
-export enum TriggerStatus {
-  Active = 0,
-  Success = 1,
-  Cancel = 2,
-  Remove = 4,
-}
-
-export interface SubscriberConfig {
-  streamURL: string;
-  maxBufferLen?: number;
-}
-
-export interface DeltaEvent {
-  last_update_id: number;
-  update_id: number;
-  market_symbol: string;
-  asks: OrderbookEntry[];
-  bids: OrderbookEntry[];
-}
-
-export interface StreamTrade {
-  side: Side;
-  price: number;
-  size: number;
-  order_id: number;
-}
-
-export interface Trades {
-  last_update_id: number;
-  update_id: number;
-  market_symbol: string;
-  trades: StreamTrade[];
-}
-
-export interface LocalOrderInfo {
-  id: number;
-  reduce_only: boolean;
-  limit_price: number;
-  size: number;
-  account_id: number;
-  sender_tracking_id?: number;
-}
-
-export interface HashMap<T> {
-  [key: number]: T;
-}
-
-export interface ActionResponse {
-  actionId: number;
-  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.
- *
- * @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: FillMode): proto.FillMode {
-  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");
-}
-
-/**
- * Orderbook entry representing price and size
- */
-export interface OrderbookEntry {
-  price: number;
-  size: 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; // engine's current logical timestamp
-}
-
-/**
- * Response for action nonce query
- */
-export interface ActionNonceResponse {
-  nonce: number; // next expected action nonce
-}
-
-/**
- * WebSocket message types
- */
-export enum WebSocketMessageType {
-  TradeUpdate = "trades",
-  DeltaUpdate = "delta",
-  AccountUpdate = "account",
-}
-
-/**
- * WebSocket trade update message
- */
-export interface WebSocketTradeUpdate {
-  e: WebSocketMessageType.TradeUpdate;
-  symbol: string;
-  trades: StreamTrade[];
-  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 =
-  | WebSocketTradeUpdate
-  | WebSocketDeltaUpdate
-  | WebSocketAccountUpdate;
-
-export interface SPLTokenInfo {
-  mint: string;
-  precision: number;
-  tokenId: number;
-  name: string;
-}
-
-// 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: Decimal;
-  size: Decimal;
-  /// Input can be only positive values.
-  constructor(quotePrice: Decimal.Value, quoteSize: Decimal.Value) {
-    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(): Decimal {
-    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: number,
-    marketSizeDecimals: number,
-  ): { price: bigint; size: bigint } {
-    return {
-      price: toScaledU64(this.price, marketPriceDecimals),
-      size: toScaledU64(this.size, marketSizeDecimals),
-    };
-  }
-}