@n1xyz/nord-ts 0.1.3 → 0.1.5

package/dist/gen/openapi.d.ts

@@ -59,7 +59,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["Info2"];
+                        "application/json": components["schemas"]["MarketsInfo"];
                     };
                 };
             };
@@ -361,6 +361,14 @@ export interface paths {
                         "application/json": number;
                     };
                 };
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["UserNotFound"];
+                    };
+                };
             };
         };
         put?: never;
@@ -1068,6 +1076,161 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/state/info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["StateInfo"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/fee/brackets/info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": [
+                            components["schemas"]["FeeTierId"],
+                            components["schemas"]["FeeTierConfig"]
+                        ][];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/{account_id}/fee/tier": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    account_id: number;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["FeeTierId"];
+                    };
+                };
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["UserNotFound"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/accounts/fee-tiers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List fee tiers assigned to accounts. */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
+                    startInclusive?: number | null;
+                    /** @description Query returns up to 50 trades in one go. */
+                    pageSize?: number | null;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PageResult_for_uint32_and_AccountFeeTier"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/tv": {
         parameters: {
             query?: never;
@@ -1967,7 +2130,7 @@ export interface components {
         } & {
             [key: string]: unknown;
         };
-        Info2: {
+        MarketsInfo: {
             markets: components["schemas"]["MarketInfo"][];
             tokens: components["schemas"]["TokenInfo"][];
         };
@@ -2041,6 +2204,7 @@ export interface components {
         ActionNotFound: null;
         /** @description Returns fee parts per market per balance change per action per account. Fee is taken from user without return. Please note that some operations need some deposit which will be returned - these are not part of fees. */
         FillRole: "maker" | "taker";
+        UserNotFound: null;
         OrderbookInfo: {
             /** Format: uint64 */
             updateId: number;
@@ -2118,7 +2282,6 @@ export interface components {
             pubkey: string;
             expiry: string;
         };
-        UserNotFound: null;
         PageQueryPart_for_String: {
             /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
             startInclusive?: string | null;
@@ -2475,6 +2638,56 @@ export interface components {
             version?: components["schemas"]["BinaryId"] | null;
         };
         BinaryId: string;
+        StateInfo: {
+            version: components["schemas"]["ExecutableVersion"];
+            state: components["schemas"]["EngineStateHeader"];
+        };
+        EngineStateHeader: {
+            /** Format: uint16 */
+            version: number;
+            /** Format: uint64 */
+            action_id: number;
+            /** Format: uint64 */
+            action_nonce: number;
+            /** Format: uint64 */
+            timestamp: number;
+            paused: boolean;
+        };
+        /** Format: uint32 */
+        FeeTierId: number;
+        FeeTierConfig: {
+            /** Format: uint16 */
+            maker_fee_bps: number;
+            /** Format: uint16 */
+            taker_fee_bps: number;
+        };
+        PageQueryPart_for_uint32: {
+            /**
+             * Format: uint32
+             * @description fetch results starting with this page; query starts with first entry if page isn't specified
+             */
+            startInclusive?: number | null;
+            /**
+             * Format: uint8
+             * @description Query returns up to 50 trades in one go.
+             * @default null
+             */
+            pageSize: number | null;
+        };
+        PageResult_for_uint32_and_AccountFeeTier: {
+            /** @description Set of items for requested by query. */
+            items: components["schemas"]["AccountFeeTier"][];
+            /**
+             * Format: uint32
+             * @description If request contains more data, this is the id is set with which next request should be performed to get next page. If no more data, then it is undefined.
+             */
+            nextStartInclusive?: number | null;
+        };
+        AccountFeeTier: {
+            /** Format: uint32 */
+            accountId: number;
+            feeTier: components["schemas"]["FeeTierId"];
+        };
         /** @description TV config query response https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data */
         TvConfigResponse: {
             supported_resolutions: components["schemas"]["Resolution"][];

package/dist/nord/api/actions.d.ts

@@ -2,6 +2,16 @@ import Decimal from "decimal.js";
 import * as proto from "../../gen/nord_pb";
 import { FillMode, Side, QuoteSize, TriggerKind } from "../../types";
 import { BigIntValue } from "../../utils";
+type ReceiptKind = NonNullable<proto.Receipt["kind"]>;
+type ExtractReceiptKind<K extends ReceiptKind["case"]> = Extract<ReceiptKind, {
+    case: K;
+}>;
+export declare function formatReceiptError(receipt: proto.Receipt): string;
+export declare function expectReceiptKind<K extends ReceiptKind["case"]>(receipt: proto.Receipt, expected: K, action: string): asserts receipt is proto.Receipt & {
+    kind: ExtractReceiptKind<K>;
+};
+export declare function createAction(currentTimestamp: bigint, nonce: number, kind: proto.Action["kind"]): proto.Action;
+export declare function sendAction(serverUrl: string, makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>, action: proto.Action): Promise<proto.Receipt>;
 export declare function prepareAction(action: proto.Action, makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>): Promise<Uint8Array<ArrayBufferLike>>;
 export declare function createSession(serverUrl: string, walletSignFn: (message: string | Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
     userPubkey: Uint8Array;
@@ -113,3 +123,4 @@ export declare function atomic(serverUrl: string, signFn: (message: Uint8Array)
     actionId: bigint;
     results: proto.Receipt_AtomicSubactionResultKind[];
 }>;
+export {};

package/dist/nord/api/actions.js

@@ -36,6 +36,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatReceiptError = formatReceiptError;
+exports.expectReceiptKind = expectReceiptKind;
+exports.createAction = createAction;
+exports.sendAction = sendAction;
 exports.prepareAction = prepareAction;
 exports.createSession = createSession;
 exports.revokeSession = revokeSession;
@@ -52,6 +56,20 @@ const protobuf_1 = require("@bufbuild/protobuf");
 const types_1 = require("../../types");
 const utils_1 = require("../../utils");
 const wire_1 = require("@bufbuild/protobuf/wire");
+const NordError_1 = require("../utils/NordError");
+function formatReceiptError(receipt) {
+    if (receipt.kind?.case === "err") {
+        const err = receipt.kind.value;
+        return proto.Error[err] ?? err.toString();
+    }
+    return receipt.kind?.case ?? "unknown";
+}
+function expectReceiptKind(receipt, expected, action) {
+    if (receipt.kind?.case !== expected) {
+        const label = formatReceiptError(receipt);
+        throw new NordError_1.NordError(`Failed to ${action}: ${label}`);
+    }
+}
 async function sessionSign(signFn, message) {
     const signature = await signFn(message);
     return new Uint8Array([...message, ...signature]);

package/dist/nord/client/Nord.d.ts

@@ -1,7 +1,7 @@
 import { ProtonClient } from "@n1xyz/proton";
 import { PublicKey } from "@solana/web3.js";
 import { EventEmitter } from "events";
-import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, AggregateMetrics, Info, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, PeakTpsPeriodUnit, Token, TradesResponse, User } from "../../types";
+import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, AggregateMetrics, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, PeakTpsPeriodUnit, Token, TradesResponse, User, AccountTriggerInfo, HistoryTriggerQuery, TriggerHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole } from "../../types";
 import { NordWebSocketClient } from "../../websocket/index";
 import { OrderbookSubscription, TradeSubscription } from "../models/Subscriber";
 /**
@@ -27,8 +27,6 @@ export interface WebSocketSubscriptionOptions {
 export declare class Nord {
     /** Base URL for the Nord web server */
     readonly webServerUrl: string;
-    /** Bridge verification key */
-    readonly bridgeVk: PublicKey;
     /** Solana RPC URL */
     readonly solanaUrl: string;
     /** Available markets */
@@ -37,7 +35,7 @@ export declare class Nord {
     tokens: Token[];
     /** Map of symbol to market_id */
     private symbolToMarketId;
-    /** Proton client for bridge and hansel operations */
+    /** Proton client for proton related operations */
     protonClient: ProtonClient;
     /** HTTP client for Nord operations */
     private httpClient;
@@ -46,7 +44,6 @@ export declare class Nord {
      *
      * @param config - Configuration options for the Nord client
      * @param config.webServerUrl - Base URL for the Nord web server
-     * @param config.bridgeVk - Bridge verification key
      * @param config.solanaUrl - Solana cluster URL
      * @throws {Error} If required configuration is missing
      */
@@ -99,12 +96,12 @@ export declare class Nord {
      *
      * @param nordConfig - Configuration options for the Nord client
      * @param nordConfig.webServerUrl - Base URL for the Nord web server
-     * @param nordConfig.bridgeVk - Bridge verification key
+     * @param nordConfig.app - App address
      * @param nordConfig.solanaUrl - Solana cluster URL
      * @returns Initialized Nord client
      * @throws {NordError} If initialization fails
      */
-    static initNord({ bridgeVk: bridgeVk_, solanaUrl, webServerUrl, }: Readonly<NordConfig>): Promise<Nord>;
+    static initNord({ app, solanaUrl, webServerUrl, }: Readonly<NordConfig>): Promise<Nord>;
     /**
      * Initialize the Nord client
      * @private
@@ -254,7 +251,22 @@ export declare class Nord {
      * @returns Information about markets and tokens
      * @throws {NordError} If the request fails
      */
-    getInfo(): Promise<Info>;
+    getInfo(): Promise<MarketsInfo>;
+    /**
+     * Fetch the current fee tier brackets configured on Nord.
+     *
+     * @returns Array of fee tier identifiers paired with their configuration
+     * @throws {NordError} If the request fails
+     */
+    getFeeBrackets(): Promise<Array<[FeeTierId, FeeTierConfig]>>;
+    /**
+     * Retrieve the fee tier assigned to a specific account.
+     *
+     * @param accountId - Account identifier to query
+     * @returns Fee tier details for the requested account
+     * @throws {NordError} If the request fails
+     */
+    getAccountFeeTier(accountId: number): Promise<FeeTierId>;
     /**
      * Get account information
      *
@@ -263,6 +275,41 @@ export declare class Nord {
      * @throws {NordError} If the request fails
      */
     getAccount(accountId: number): Promise<Account>;
+    /**
+     * Get the public key associated with an account id.
+     *
+     * @param accountId - Account id to query
+     * @returns Base58-encoded account public key
+     * @throws {NordError} If the request fails
+     */
+    getAccountPubkey(accountId: number): Promise<string>;
+    /**
+     * Get the withdrawal fee charged for an account.
+     *
+     * @param accountId - Account id to query
+     * @returns Withdrawal fee quoted in quote token units
+     * @throws {NordError} If the request fails
+     */
+    getAccountWithdrawalFee(accountId: number): Promise<number>;
+    /**
+     * Get open orders for an account.
+     *
+     * @param accountId - Account id to query
+     * @param query - Optional pagination parameters
+     * @returns Page of orders keyed by client order id
+     * @throws {NordError} If the request fails
+     */
+    getAccountOrders(accountId: number, query?: {
+        startInclusive?: string | null;
+        pageSize?: number | null;
+    }): Promise<PageResultStringOrderInfo>;
+    /**
+     * List account fee tiers with pagination support.
+     */
+    getAccountsFeeTiers(query?: {
+        startInclusive?: number | null;
+        pageSize?: number | null;
+    }): Promise<AccountFeeTierPage>;
     /**
      * Get profit and loss history for an account
      *
@@ -280,6 +327,46 @@ export declare class Nord {
     getMarketStats({ marketId, }: {
         marketId: number;
     }): Promise<MarketStats>;
+    /**
+     * Fetch the per-market fee quote for an account.
+     *
+     * @param params - Market id, fee kind, and account id to quote
+     * @returns Fee in quote token units (negative means fee is charged)
+     * @throws {NordError} If the request fails
+     */
+    getMarketFee({ marketId, feeKind, accountId, }: {
+        marketId: number;
+        feeKind: FillRole;
+        accountId: number;
+    }): Promise<number>;
+    /**
+     * Fetch token statistics such as index price and oracle metadata.
+     *
+     * @param tokenId - Token identifier
+     * @returns Token stats
+     * @throws {NordError} If the request fails
+     */
+    getTokenStats(tokenId: number): Promise<TokenStats>;
+    /**
+     * Get order summary by order id.
+     *
+     * @param orderId - Order identifier
+     * @returns Order information
+     * @throws {NordError} If the request fails
+     */
+    getOrder(orderId: string): Promise<OrderInfoFromApi>;
+    /**
+     * Get trade history for a specific order.
+     *
+     * @param orderId - Order identifier
+     * @param query - Optional pagination parameters
+     * @returns Page of trades associated with the order
+     * @throws {NordError} If the request fails
+     */
+    getOrderTrades(orderId: string, query?: {
+        startInclusive?: string | null;
+        pageSize?: number | null;
+    }): Promise<PageResultStringTrade>;
     /**
      * Check if an account exists for the given address
      *
@@ -288,4 +375,22 @@ export declare class Nord {
      * @deprecated use getUser instead
      */
     accountExists(pubkey: string | PublicKey): Promise<boolean>;
+    /**
+     * 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.
+     */
+    getAccountTriggers(params?: {
+        accountId?: number;
+    }): Promise<AccountTriggerInfo[]>;
+    /**
+     * 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.
+     */
+    getAccountTriggerHistory(params: HistoryTriggerQuery & {
+        accountId?: number;
+    }): Promise<TriggerHistoryPage>;
 }