@n1xyz/nord-ts 0.0.22 → 0.1.0

package/src/gen/openapi.ts

@@ -112,11 +112,13 @@ export interface paths {
             };
         };
         put?: never;
-        /** @description Send an action to nord to execute. */
+        /** @description Send an action to nord to execute. This doesn't use `Protobuf<T>` since we want to length-delimit this message. `body` - (length prefix of action, action data protobuf, and signature). signature has exact length, but depend on action kind. body is exact payload used via other transports and journalled for rexecution */
         post: {
             parameters: {
                 query?: never;
-                header?: never;
+                header: {
+                    "content-type": string;
+                };
                 path?: never;
                 cookie?: never;
             };
@@ -135,6 +137,19 @@ export interface paths {
                         "application/octet-stream": unknown;
                     };
                 };
+                415: {
+                    headers: {
+                        /**
+                         * @description Expected request media type
+                         * @example application/octet-stream
+                         */
+                        accept: string;
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AcceptedMediaType"];
+                    };
+                };
             };
         };
         delete?: never;
@@ -1893,6 +1908,9 @@ export interface components {
             /** Format: uint16 */
             weightBps: number;
         };
+        AcceptedMediaType: {
+            expected: string;
+        };
         ActionsQuery: {
             /** Format: uint64 */
             from: number;
@@ -2224,8 +2242,6 @@ export interface components {
         HistoryTriggerInfo: {
             /** Format: uint32 */
             accountId: number;
-            /** Format: uint64 */
-            actionId: number;
             /** Format: uint32 */
             marketId: number;
             /** Format: uint64 */
@@ -2233,21 +2249,30 @@ export interface components {
             side: components["schemas"]["Side"];
             kind: components["schemas"]["TriggerKind"];
             status: components["schemas"]["TriggerStatus"];
+            /** Format: uint64 */
+            createdAtActionId: number;
+            /** Format: uint64 */
+            finalizedAtActionId?: number | null;
             createdAt: string;
-            updatedAt: string;
+            finalizedAt: string;
         };
         /** @enum {string} */
         TriggerKind: "stopLoss" | "takeProfit";
         /** @enum {string} */
-        TriggerStatus: "added" | "succeeded" | "failed" | "removed";
+        TriggerStatus: "active" | "success" | "cancel" | "fail" | "remove";
         TriggerInfo: {
             /** Format: uint32 */
             marketId: number;
-            /** Format: uint64 */
-            price: number;
             side: components["schemas"]["Side"];
             kind: components["schemas"]["TriggerKind"];
+            triggerPrice: components["schemas"]["PositivePriceMantissa"];
+            limitPrice?: components["schemas"]["PositivePriceMantissa"] | null;
         };
+        /**
+         * Format: uint64
+         * @description 63 bit integer, which is always positive
+         */
+        PositivePriceMantissa: number;
         OrderNotFound: null;
         PageResult_for_String_and_Trade: {
             /** @description Set of items for requested by query. */

package/src/nord/api/actions.ts

@@ -1,5 +1,8 @@
 import Decimal from "decimal.js";
 import * as proto from "../../gen/nord_pb";
+import { paths, components } from "../../gen/openapi";
+import createClient from "openapi-fetch";
+
 import { create } from "@bufbuild/protobuf";
 import {
   FillMode,
@@ -54,25 +57,23 @@ async function sendAction(
   action: proto.Action,
   actionErrorDesc: string,
 ): Promise<proto.Receipt> {
-  const encoded = sizeDelimitedEncode(proto.ActionSchema, action);
-  // validate the payload size
-  const MAX_PAYLOAD_SIZE = 100 * 1024; // 100 kB
-  if (encoded.byteLength > MAX_PAYLOAD_SIZE) {
-    throw new Error(
-      `Encoded message size (${encoded.byteLength} bytes) is greater than max payload size (${MAX_PAYLOAD_SIZE} bytes).`,
-    );
-  }
-  const body = await makeSignedMessage(encoded);
-
-  // TODO: this should be changed to use openapi
-  const response = await checkedFetch(`${serverUrl}/action`, {
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json",
+  const body = await prepareAction(action, makeSignedMessage);
+  // NOTE: restructure and reuse client as it is in Nord.ts
+  const client = createClient<paths>({ baseUrl: serverUrl });
+  const response = await client.POST("/action", {
+    params: {
+      header: {
+        "content-type": "application/octet-stream",
+      },
     },
-    body,
+    body: body,
   });
-  const rawResp = new Uint8Array(await response.arrayBuffer());
+
+  if (response.error) {
+    throw new Error(`Failed to ${actionErrorDesc}, HTTP status ${response}`);
+  }
+
+  const rawResp = new Uint8Array(await response.response.arrayBuffer());
 
   const resp: proto.Receipt = decodeLengthDelimited(
     rawResp,
@@ -88,6 +89,24 @@ async function sendAction(
   return resp;
 }
 
+// Given action and signature function, prepare the signed message to send to server as `body`.
+// `makeSignedMessage` must include the original message and signature.
+export async function prepareAction(
+  action: proto.Action,
+  makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>,
+) {
+  const encoded = sizeDelimitedEncode(proto.ActionSchema, action);
+  // NOTE(agent): keep in sync with MAX_HTTP_REQUEST_BODY_SIZE in rust code
+  const MAX_HTTP_REQUEST_BODY_SIZE = 1024;
+  if (encoded.byteLength > MAX_HTTP_REQUEST_BODY_SIZE) {
+    throw new Error(
+      `Encoded message size (${encoded.byteLength} bytes) is greater than max payload size (${MAX_HTTP_REQUEST_BODY_SIZE} bytes).`,
+    );
+  }
+  const body = await makeSignedMessage(encoded);
+  return body;
+}
+
 export async function createSession(
   serverUrl: string,
   walletSignFn: (message: string | Uint8Array) => Promise<Uint8Array>,
@@ -241,6 +260,11 @@ export async function placeOrder(
     ? params.quoteSize.toScaledU64(params.priceDecimals, params.sizeDecimals)
     : undefined;
 
+  assert(
+    price > 0n || size > 0n || scaledQuote !== undefined,
+    "OrderLimit must include at least one of: size, price, or quoteSize",
+  );
+
   const action = createAction(currentTimestamp, nonce, {
     case: "placeOrder",
     value: create(proto.Action_PlaceOrderSchema, {
@@ -431,6 +455,12 @@ export async function atomic(
         ? a.quoteSize.toScaledU64(a.priceDecimals, a.sizeDecimals)
         : undefined;
 
+      // Require at least one limit to be set (non-zero size, non-zero price, or quoteSize)
+      assert(
+        price > 0n || size > 0n || scaledQuote !== undefined,
+        "OrderLimit must include at least one of: size, price, or quoteSize",
+      );
+
       const tradeOrPlace: proto.TradeOrPlace = create(
         proto.TradeOrPlaceSchema,
         {

package/src/types.ts

@@ -310,8 +310,8 @@ export class QuoteSize {
   constructor(quotePrice: Decimal.Value, quoteSize: Decimal.Value) {
     const p = new Decimal(quotePrice);
     const s = new Decimal(quoteSize);
-    if (p.isZero() || s.isZero()) {
-      throw new Error("quotePrice and quoteSize must be non-zero");
+    if (!p.isPositive() || !s.isPositive()) {
+      throw new Error("quotePrice and quoteSize must be positive");
     }
     this.price = p;
     this.size = s;