@n1xyz/nord-ts 0.1.0 → 0.1.2

package/dist/nord/client/NordUser.js

@@ -42,6 +42,7 @@ ed.etc.sha512Sync = sha512_1.sha512;
 const proton_1 = require("@n1xyz/proton");
 const utils_1 = require("../../utils");
 const actions_1 = require("../api/actions");
+const triggers_1 = require("../api/triggers");
 const NordError_1 = require("../utils/NordError");
 /**
  * User class for interacting with the Nord protocol
@@ -460,6 +461,102 @@ 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) {
+        try {
+            this.checkSessionValidity();
+            const market = (0, utils_1.findMarket)(this.nord.markets, params.marketId);
+            if (!market) {
+                throw new NordError_1.NordError(`Market with ID ${params.marketId} not found`);
+            }
+            const result = await (0, actions_1.addTrigger)(this.nord.webServerUrl, this.sessionSignFn, await this.nord.getTimestamp(), this.getNonce(), {
+                sessionId: (0, utils_1.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_1.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) {
+        try {
+            this.checkSessionValidity();
+            const market = (0, utils_1.findMarket)(this.nord.markets, params.marketId);
+            if (!market) {
+                throw new NordError_1.NordError(`Market with ID ${params.marketId} not found`);
+            }
+            const result = await (0, actions_1.removeTrigger)(this.nord.webServerUrl, this.sessionSignFn, await this.nord.getTimestamp(), this.getNonce(), {
+                sessionId: (0, utils_1.optExpect)(this.sessionId, "No session"),
+                marketId: params.marketId,
+                side: params.side,
+                kind: params.kind,
+                accountId: params.accountId,
+            });
+            return result;
+        }
+        catch (error) {
+            throw new NordError_1.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) {
+        const accountId = params?.accountId ?? this.accountIds?.[0];
+        if (accountId == null) {
+            throw new NordError_1.NordError("Account ID is undefined. Make sure to call updateAccountId() before requesting triggers.");
+        }
+        try {
+            return await (0, triggers_1.getAccountTriggers)(this.nord.webServerUrl, accountId);
+        }
+        catch (error) {
+            throw new NordError_1.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) {
+        const { accountId: providedAccountId, ...query } = params;
+        const accountId = providedAccountId ?? this.accountIds?.[0];
+        if (accountId == null) {
+            throw new NordError_1.NordError("Account ID is undefined. Make sure to call updateAccountId() before requesting trigger history.");
+        }
+        try {
+            return await (0, triggers_1.getAccountTriggerHistory)(this.nord.webServerUrl, accountId, query);
+        }
+        catch (error) {
+            throw new NordError_1.NordError("Failed to fetch account trigger history", {
+                cause: error,
+            });
+        }
+    }
     /**
      * Transfer tokens to another account
      *

package/dist/types.d.ts

@@ -72,6 +72,9 @@ 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
  */
@@ -94,8 +97,8 @@ export declare enum KeyType {
     Bls12_381 = 2
 }
 export declare enum Side {
-    Ask = 0,
-    Bid = 1
+    Ask = "ask",
+    Bid = "bid"
 }
 export declare enum FillMode {
     Limit = 0,
@@ -103,6 +106,16 @@ export declare enum FillMode {
     ImmediateOrCancel = 2,
     FillOrKill = 3
 }
+export declare enum TriggerKind {
+    StopLoss = 0,
+    TakeProfit = 1
+}
+export declare enum TriggerStatus {
+    Active = 0,
+    Success = 1,
+    Cancel = 2,
+    Remove = 4
+}
 export interface SubscriberConfig {
     streamURL: string;
     maxBufferLen?: number;
@@ -255,7 +268,7 @@ export declare class QuoteSize {
     size: Decimal;
     constructor(quotePrice: Decimal.Value, quoteSize: Decimal.Value);
     value(): Decimal;
-    toScaledU64(marketPriceDecimals: number, marketSizeDecimals: number): {
+    toWire(marketPriceDecimals: number, marketSizeDecimals: number): {
         price: bigint;
         size: bigint;
     };

package/dist/types.js

@@ -36,7 +36,7 @@ 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.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
+exports.QuoteSize = exports.WebSocketMessageType = exports.TriggerStatus = exports.TriggerKind = exports.FillMode = exports.Side = exports.KeyType = exports.PeakTpsPeriodUnit = void 0;
 exports.fillModeToProtoFillMode = fillModeToProtoFillMode;
 const proto = __importStar(require("./gen/nord_pb"));
 const decimal_js_1 = __importDefault(require("decimal.js"));
@@ -66,8 +66,8 @@ var KeyType;
 })(KeyType || (exports.KeyType = KeyType = {}));
 var Side;
 (function (Side) {
-    Side[Side["Ask"] = 0] = "Ask";
-    Side[Side["Bid"] = 1] = "Bid";
+    Side["Ask"] = "ask";
+    Side["Bid"] = "bid";
 })(Side || (exports.Side = Side = {}));
 var FillMode;
 (function (FillMode) {
@@ -76,6 +76,18 @@ var FillMode;
     FillMode[FillMode["ImmediateOrCancel"] = 2] = "ImmediateOrCancel";
     FillMode[FillMode["FillOrKill"] = 3] = "FillOrKill";
 })(FillMode || (exports.FillMode = FillMode = {}));
+var TriggerKind;
+(function (TriggerKind) {
+    TriggerKind[TriggerKind["StopLoss"] = 0] = "StopLoss";
+    TriggerKind[TriggerKind["TakeProfit"] = 1] = "TakeProfit";
+})(TriggerKind || (exports.TriggerKind = TriggerKind = {}));
+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 || (exports.TriggerStatus = TriggerStatus = {}));
 /**
  * Converts a `FillMode` enum to its corresponding protobuf representation.
  *
@@ -105,7 +117,19 @@ var WebSocketMessageType;
     WebSocketMessageType["AccountUpdate"] = "account";
 })(WebSocketMessageType || (exports.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.
 class QuoteSize {
+    /// Input can be only positive values.
     constructor(quotePrice, quoteSize) {
         const p = new decimal_js_1.default(quotePrice);
         const s = new decimal_js_1.default(quoteSize);
@@ -115,10 +139,12 @@ class QuoteSize {
         this.price = p;
         this.size = s;
     }
+    // USD value of limit, use for debug
     value() {
         return this.price.mul(this.size);
     }
-    toScaledU64(marketPriceDecimals, marketSizeDecimals) {
+    // Converts to wire format to be send to server, scaling price and size according to market decimals.
+    toWire(marketPriceDecimals, marketSizeDecimals) {
         return {
             price: (0, utils_1.toScaledU64)(this.price, marketPriceDecimals),
             size: (0, utils_1.toScaledU64)(this.size, marketSizeDecimals),

package/dist/utils.js

@@ -31,6 +31,7 @@ const bs58_1 = __importDefault(require("bs58"));
 exports.SESSION_TTL = 60n * 60n * 24n * 30n;
 exports.ZERO_DECIMAL = new decimal_js_1.Decimal(0);
 exports.MAX_BUFFER_LEN = 10000;
+// Max size of data returned from Nord endpoints
 const MAX_PAYLOAD_SIZE = 100 * 1024; // 100 kB
 function panic(message) {
     throw new Error(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n1xyz/nord-ts",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Typescript for Nord",
   "keywords": [],
   "author": "",
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@bufbuild/protobuf": "^2.6.3",
-    "@n1xyz/proton": "0.0.2",
+    "@n1xyz/proton": "0.0.3",
     "@noble/curves": "^1.9.6",
     "@noble/ed25519": "^2.3.0",
     "@noble/hashes": "^1.8.0",