@n1xyz/nord-ts 0.1.0 → 0.1.2

package/src/nord/client/NordUser.ts

@@ -15,7 +15,13 @@ import * as ed from "@noble/ed25519";
 import { sha512 } from "@noble/hashes/sha512";
 ed.etc.sha512Sync = sha512;
 import { floatToScaledBigIntLossy } from "@n1xyz/proton";
-import { FillMode, Side, SPLTokenInfo, QuoteSize } from "../../types";
+import {
+  FillMode,
+  Side,
+  SPLTokenInfo,
+  QuoteSize,
+  TriggerKind,
+} from "../../types";
 import * as proto from "../../gen/nord_pb";
 import {
   BigIntValue,
@@ -34,7 +40,18 @@ import {
   withdraw,
   atomic as atomicAction,
   AtomicSubaction as ApiAtomicSubaction,
+  addTrigger as addTriggerAction,
+  removeTrigger as removeTriggerAction,
 } from "../api/actions";
+import type {
+  AccountTriggerInfo,
+  TriggerHistoryPage,
+  HistoryTriggerQuery,
+} from "../api/triggers";
+import {
+  getAccountTriggers as fetchAccountTriggers,
+  getAccountTriggerHistory as fetchAccountTriggerHistory,
+} from "../api/triggers";
 import { NordError } from "../utils/NordError";
 import { Nord } from "./Nord";
 
@@ -99,6 +116,22 @@ export interface PlaceOrderParams {
   accountId?: number;
 }
 
+export interface AddTriggerParams {
+  marketId: number;
+  side: Side;
+  kind: TriggerKind;
+  triggerPrice: Decimal.Value;
+  limitPrice?: Decimal.Value;
+  accountId?: number;
+}
+
+export interface RemoveTriggerParams {
+  marketId: number;
+  side: Side;
+  kind: TriggerKind;
+  accountId?: number;
+}
+
 /**
  * Parameters for transferring tokens between accounts
  */
@@ -834,6 +867,132 @@ export class NordUser {
     }
   }
 
+  /**
+   * Add a trigger for the current session
+   *
+   * @param params - Trigger parameters including market, side, and prices
+   * @returns Object containing the actionId of the submitted trigger
+   * @throws {NordError} If the operation fails
+   */
+  async addTrigger(params: AddTriggerParams): Promise<{ actionId: bigint }> {
+    try {
+      this.checkSessionValidity();
+      const market = findMarket(this.nord.markets, params.marketId);
+      if (!market) {
+        throw new NordError(`Market with ID ${params.marketId} not found`);
+      }
+      const result = await addTriggerAction(
+        this.nord.webServerUrl,
+        this.sessionSignFn,
+        await this.nord.getTimestamp(),
+        this.getNonce(),
+        {
+          sessionId: optExpect(this.sessionId, "No session"),
+          marketId: params.marketId,
+          side: params.side,
+          kind: params.kind,
+          priceDecimals: market.priceDecimals,
+          triggerPrice: params.triggerPrice,
+          limitPrice: params.limitPrice,
+          accountId: params.accountId,
+        },
+      );
+      return result;
+    } catch (error) {
+      throw new NordError("Failed to add trigger", { cause: error });
+    }
+  }
+
+  /**
+   * Remove a trigger for the current session
+   *
+   * @param params - Trigger parameters identifying the trigger to remove
+   * @returns Object containing the actionId of the removal action
+   * @throws {NordError} If the operation fails
+   */
+  async removeTrigger(
+    params: RemoveTriggerParams,
+  ): Promise<{ actionId: bigint }> {
+    try {
+      this.checkSessionValidity();
+      const market = findMarket(this.nord.markets, params.marketId);
+      if (!market) {
+        throw new NordError(`Market with ID ${params.marketId} not found`);
+      }
+      const result = await removeTriggerAction(
+        this.nord.webServerUrl,
+        this.sessionSignFn,
+        await this.nord.getTimestamp(),
+        this.getNonce(),
+        {
+          sessionId: optExpect(this.sessionId, "No session"),
+          marketId: params.marketId,
+          side: params.side,
+          kind: params.kind,
+          accountId: params.accountId,
+        },
+      );
+      return result;
+    } catch (error) {
+      throw new NordError("Failed to remove trigger", { cause: error });
+    }
+  }
+
+  /**
+   * Fetch active triggers for an account.
+   *
+   * @param params Optional parameters containing an explicit account id.
+   * @throws {NordError} If no account can be resolved or the request fails.
+   */
+  async getAccountTriggers(params?: {
+    accountId?: number;
+  }): Promise<AccountTriggerInfo[]> {
+    const accountId = params?.accountId ?? this.accountIds?.[0];
+
+    if (accountId == null) {
+      throw new NordError(
+        "Account ID is undefined. Make sure to call updateAccountId() before requesting triggers.",
+      );
+    }
+
+    try {
+      return await fetchAccountTriggers(this.nord.webServerUrl, accountId);
+    } catch (error) {
+      throw new NordError("Failed to fetch account triggers", { cause: error });
+    }
+  }
+
+  /**
+   * Fetch trigger history for an account.
+   *
+   * @param params Optional parameters with account id and history query filters.
+   * @throws {NordError} If no account can be resolved or the request fails.
+   */
+  async getAccountTriggerHistory(
+    params: HistoryTriggerQuery & { accountId?: number },
+  ): Promise<TriggerHistoryPage> {
+    const { accountId: providedAccountId, ...query } = params;
+    const accountId = providedAccountId ?? this.accountIds?.[0];
+
+    if (accountId == null) {
+      throw new NordError(
+        "Account ID is undefined. Make sure to call updateAccountId() before requesting trigger history.",
+      );
+    }
+
+    try {
+      return await fetchAccountTriggerHistory(
+        this.nord.webServerUrl,
+        accountId,
+        query,
+      );
+    } catch (error) {
+      throw new NordError("Failed to fetch account trigger history", {
+        cause: error,
+      });
+    }
+  }
+
   /**
    * Transfer tokens to another account
    *

package/src/types.ts

@@ -88,6 +88,10 @@ 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"];
 
 /**
  * Configuration options for the Nord client
@@ -114,8 +118,8 @@ export enum KeyType {
 }
 
 export enum Side {
-  Ask,
-  Bid,
+  Ask = "ask",
+  Bid = "bid",
 }
 
 export enum FillMode {
@@ -125,6 +129,18 @@ export enum FillMode {
   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;
@@ -304,9 +320,22 @@ export interface SPLTokenInfo {
 }
 
 // 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);
@@ -317,11 +346,13 @@ export class QuoteSize {
     this.size = s;
   }
 
+  // USD value of limit, use for debug
   value(): Decimal {
     return this.price.mul(this.size);
   }
 
-  toScaledU64(
+  // 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 } {

package/src/utils.ts

@@ -17,6 +17,7 @@ export const SESSION_TTL: bigint = 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
 
 /** Any type convertible to bigint */