@n1xyz/nord-ts 0.1.8 → 0.1.10

package/dist/client/Nord.d.ts

@@ -3,7 +3,7 @@ import { Connection, PublicKey } from "@solana/web3.js";
 import { EventEmitter } from "events";
 import { Client } from "openapi-fetch";
 import type { paths } from "../gen/openapi.ts";
-import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, Token, TradesResponse, User, AccountTriggerInfo, HistoryTriggerQuery, TriggerHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole, AdminInfo } from "../types";
+import { Account, AccountPnlPage, AccountPnlQuery, ActionResponse, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, Token, TradesResponse, User, AccountTriggerInfo, HistoryTriggerQuery, TriggerHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole, AdminInfo, AccountVolumeInfo, GetAccountVolumeQuery } from "../types";
 import { NordWebSocketClient } from "../websocket/index";
 import { OrderbookSubscription, TradeSubscription } from "../websocket/Subscriber";
 /**
@@ -89,6 +89,17 @@ export declare class Nord {
      * @throws {NordError} If the request fails
      */
     getAdminList(): Promise<Array<AdminInfo>>;
+    /**
+     * Get account volume across all markets, optionally for a specific market.
+     *
+     * @param accountId - Account identifier
+     * @param since - RFC3339 timestamp marking the inclusive start of the window
+     * @param until - RFC3339 timestamp marking the exclusive end of the window
+     * @param marketId - Optional market identifier to scope the volume
+     * @returns Array of market volumes (single entry when `marketId` is provided)
+     * @throws {NordError} If the request fails
+     */
+    getAccountVolume({ accountId, since, until, marketId, }: Readonly<GetAccountVolumeQuery>): Promise<Array<AccountVolumeInfo>>;
     /**
      * Fetch information about Nord markets and tokens
      *

package/dist/client/Nord.js

@@ -130,6 +130,28 @@ export class Nord {
     async getAdminList() {
         return await this.GET("/admin", {});
     }
+    /**
+     * Get account volume across all markets, optionally for a specific market.
+     *
+     * @param accountId - Account identifier
+     * @param since - RFC3339 timestamp marking the inclusive start of the window
+     * @param until - RFC3339 timestamp marking the exclusive end of the window
+     * @param marketId - Optional market identifier to scope the volume
+     * @returns Array of market volumes (single entry when `marketId` is provided)
+     * @throws {NordError} If the request fails
+     */
+    async getAccountVolume({ accountId, since, until, marketId, }) {
+        return await this.GET("/account/volume", {
+            params: {
+                query: {
+                    accountId,
+                    since,
+                    until,
+                    marketId,
+                },
+            },
+        });
+    }
     /**
      * Fetch information about Nord markets and tokens
      *

package/dist/client/NordUser.d.ts

@@ -136,15 +136,23 @@ export declare class NordUser {
      * @param tokenId - Token ID
      * @param recipient - Recipient address; defaults to the user's address
      * @param sendOptions - Send options for .sendTransaction
-     * @returns Transaction signature
+     * @returns Transaction signature and buffer account
      * @throws {NordError} If required parameters are missing or operation fails
+     *
+     * The buffer account is used to correlate the deposit for when it gets queued.
+     * Note that even though there may technically be multiple deposits with the same
+     * buffer account, in the case of this method, there will only be one as it discards
+     * the buffer after performing the deposit.
      */
     deposit({ amount, tokenId, recipient, sendOptions, }: Readonly<{
         amount: number;
         tokenId: number;
         recipient?: PublicKey;
         sendOptions?: SendOptions;
-    }>): Promise<string>;
+    }>): Promise<{
+        signature: string;
+        buffer: PublicKey;
+    }>;
     /**
      * Get a new nonce for actions
      *

package/dist/client/NordUser.js

@@ -132,7 +132,7 @@ export class NordUser {
      * @throws {NordError} If required parameters are missing or operation fails
      */
     async depositSpl(amount, tokenId, recipient) {
-        return this.deposit({ amount, tokenId, recipient });
+        return this.deposit({ amount, tokenId, recipient }).then((x) => x.signature);
     }
     /**
      * Deposit SPL tokens to the app
@@ -141,8 +141,13 @@ export class NordUser {
      * @param tokenId - Token ID
      * @param recipient - Recipient address; defaults to the user's address
      * @param sendOptions - Send options for .sendTransaction
-     * @returns Transaction signature
+     * @returns Transaction signature and buffer account
      * @throws {NordError} If required parameters are missing or operation fails
+     *
+     * The buffer account is used to correlate the deposit for when it gets queued.
+     * Note that even though there may technically be multiple deposits with the same
+     * buffer account, in the case of this method, there will only be one as it discards
+     * the buffer after performing the deposit.
      */
     async deposit({ amount, tokenId, recipient, sendOptions, }) {
         try {
@@ -169,7 +174,10 @@ export class NordUser {
             const signedTx = await this.transactionSignFn(tx);
             signedTx.partialSign(extraSigner);
             const signature = await this.nord.solanaConnection.sendRawTransaction(signedTx.serialize(), sendOptions);
-            return signature;
+            return {
+                signature,
+                buffer: extraSigner.publicKey,
+            };
         }
         catch (error) {
             throw new NordError(`Failed to deposit ${amount} of token ID ${tokenId}`, { cause: error });

package/dist/gen/openapi.d.ts

@@ -1266,6 +1266,60 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/volume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get trading volume for an account
+         *
+         *     Optionally, you can specify a market to get volume for. If not specified, array of (MarketId, Volume) is returned.
+         *
+         *     Returns raw values, caller must rescale to base token decimals */
+        get: {
+            parameters: {
+                query: {
+                    accountId: number;
+                    marketId?: number | null;
+                    /** @description start with this timestamp (RFC3339); defaults to UNIX epoch start */
+                    since?: string;
+                    /** @description end with this timestamp (RFC3339); defaults to current date-time */
+                    until?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AccountVolumeInfo"][];
+                    };
+                };
+                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;
+    };
     "/tv": {
         parameters: {
             query?: never;
@@ -2276,6 +2330,8 @@ export interface components {
             high24h: number;
             /** Format: double */
             low24h: number;
+            /** Format: double */
+            closePrice24h: number;
             perpStats?: components["schemas"]["PerpMarketStats"] | null;
         };
         PerpMarketStats: {
@@ -2727,6 +2783,28 @@ export interface components {
             key: string;
             roles: string[];
         };
+        GetAccountVolumeQuery: {
+            /** Format: uint32 */
+            accountId: number;
+            /** Format: uint32 */
+            marketId?: number | null;
+            /**
+             * @description start with this timestamp (RFC3339); defaults to UNIX epoch start
+             * @default null
+             */
+            since: string;
+            /**
+             * @description end with this timestamp (RFC3339); defaults to current date-time
+             * @default null
+             */
+            until: string;
+        };
+        AccountVolumeInfo: {
+            /** Format: uint32 */
+            marketId: number;
+            /** Format: double */
+            volume: number;
+        };
         /** @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/types.d.ts

@@ -71,6 +71,8 @@ export type TokenStats = components["schemas"]["TokenStats"];
 export type AccountFeeTier = components["schemas"]["AccountFeeTier"];
 export type AccountFeeTierPage = components["schemas"]["PageResult_for_uint32_and_AccountFeeTier"];
 export type AdminInfo = components["schemas"]["AdminInfo"];
+export type GetAccountVolumeQuery = components["schemas"]["GetAccountVolumeQuery"];
+export type AccountVolumeInfo = components["schemas"]["AccountVolumeInfo"];
 /**
  * Configuration options for the Nord client
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n1xyz/nord-ts",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Typescript for Nord",
   "keywords": [],
   "author": "",
@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "@bufbuild/protobuf": "^2.6.3",
-    "@n1xyz/proton": "0.0.6",
+    "@n1xyz/proton": "0.0.7",
     "@noble/curves": "^1.9.6",
     "@noble/ed25519": "^2.3.0",
     "@noble/hashes": "^1.8.0",