@n1xyz/nord-ts 0.3.4 → 0.3.6

package/README.md

@@ -110,6 +110,27 @@ try {
 }
 ```
 
+### Quote-Sized Orders
+
+For orders limited by quote amount (e.g., USD value), pass a single decimal value:
+
+```typescript
+// Place a market/limit order capped by quote value
+await user.placeOrder({
+  marketId: 0,
+  side: Side.Bid,
+  fillMode: FillMode.Limit,
+  isReduceOnly: false,
+  // Limit by quote: $100 at $50,000 results in ~0.002 BTC
+  quoteSize: 100,
+});
+```
+
+Notes:
+- `quoteSize` is a positive decimal representing the desired quote amount.
+- The wire format encodes quote amount as a 128-bit value scaled by `price_decimals + size_decimals` of the target market.
+- At least one limit must be provided among `size`, `price`, or `quoteSize`.
+
 ### Deposits and Withdrawals
 
 ```typescript

package/dist/actions.d.ts

@@ -2,9 +2,9 @@ import Decimal from "decimal.js";
 import * as proto from "./gen/nord_pb";
 import { paths } from "./gen/openapi";
 import { Client } from "openapi-fetch";
-import { FillMode, Side, QuoteSize } from "./types";
+import { FillMode, Side } from "./types";
 import { BigIntValue } from "./utils";
-import { PublicKey } from "@solana/web3.js";
+import { PublicKey, Transaction } from "@solana/web3.js";
 type ReceiptKind = NonNullable<proto.Receipt["kind"]>;
 type ExtractReceiptKind<K extends ReceiptKind["case"]> = Extract<ReceiptKind, {
     case: K;
@@ -19,7 +19,9 @@ export declare function prepareAction(action: proto.Action, makeSignedMessage: (
 export declare function createSession(client: Client<paths>, signMessage: (_: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
     userPubkey: PublicKey;
     sessionPubkey: PublicKey;
+    signatureFraming: "hex" | "solanaTransaction";
     expiryTimestamp?: bigint;
+    signTransactionFn: (tx: Transaction) => Promise<Transaction>;
 }): Promise<{
     actionId: bigint;
     sessionId: bigint;
@@ -39,7 +41,7 @@ export type AtomicSubaction = {
     priceDecimals: number;
     size?: Decimal.Value;
     price?: Decimal.Value;
-    quoteSize?: QuoteSize;
+    quoteSize?: Decimal.Value;
     clientOrderId?: BigIntValue;
 } | {
     kind: "cancel";

package/dist/client/Nord.d.ts

@@ -205,7 +205,7 @@ export declare class Nord {
         pageSize?: number;
         since?: string;
         until?: string;
-        startInclusive?: string;
+        startInclusive?: number;
     }>): Promise<TradesResponse>;
     /**
      * Get user account IDs
@@ -284,18 +284,20 @@ export declare class Nord {
      * @throws {NordError} If the request fails
      */
     getAccountOrders(accountId: number, { startInclusive, pageSize, }?: Readonly<{
-        startInclusive?: string | null;
-        pageSize?: number | null;
+        startInclusive?: number;
+        pageSize?: number;
     }>): Promise<PageResultStringOrderInfo>;
     /**
      * List account fee tiers with pagination support.
      *
      * @param startInclusive - Account id cursor to resume from
      * @param pageSize - Maximum number of entries to return
+     * @param tier - Optional fee tier filter
      */
-    getAccountsFeeTiers({ startInclusive, pageSize, }?: Readonly<{
-        startInclusive?: number | null;
-        pageSize?: number | null;
+    getAccountsFeeTiers({ startInclusive, pageSize, tier, }?: Readonly<{
+        startInclusive?: number;
+        pageSize?: number;
+        tier?: FeeTierId;
     }>): Promise<AccountFeeTierPage>;
     /**
      * Get profit and loss history for an account
@@ -349,7 +351,7 @@ export declare class Nord {
      * @returns Order information
      * @throws {NordError} If the request fails
      */
-    getOrder(orderId: string): Promise<OrderInfoFromApi>;
+    getOrder(orderId: number): Promise<OrderInfoFromApi>;
     /**
      * Get trade history for a specific order.
      *
@@ -359,9 +361,9 @@ export declare class Nord {
      * @returns Page of trades associated with the order
      * @throws {NordError} If the request fails
      */
-    getOrderTrades(orderId: string, { startInclusive, pageSize, }?: Readonly<{
-        startInclusive?: string | null;
-        pageSize?: number | null;
+    getOrderTrades(orderId: number, { startInclusive, pageSize, }?: Readonly<{
+        startInclusive?: number;
+        pageSize?: number;
     }>): Promise<PageResultStringTrade>;
     /**
      * Check if an account exists for the given address

package/dist/client/NordAdmin.d.ts

@@ -2,6 +2,7 @@ import { PublicKey, Transaction } from "@solana/web3.js";
 import * as proto from "../gen/nord_pb";
 import { Nord } from "./Nord";
 import { FeeTierConfig } from "../gen/nord_pb";
+import Decimal from "decimal.js";
 export declare enum AclRole {
     FEE_MANAGER = 1,
     MARKET_MANAGER = 2,
@@ -182,6 +183,20 @@ export declare class NordAdmin {
      * - The first appended tier receives id 1, and subsequent tiers increment the id.
      *
      * @param config - Fee tier configuration to insert
+     *
+     * Use 1/1_000_000 granularity (ppm)
+     * | ppm  | decimal  | percent |
+     * |------|----------|---------|
+     * | 1    | 0.000001 | 0.0001% |
+     * | 5    | 0.000005 | 0.0005% |
+     * | 10   | 0.00001  | 0.001%  |
+     * | 50   | 0.00005  | 0.005%  |
+     * | 100  | 0.0001   | 0.01%   |
+     * | 500  | 0.0005   | 0.05%   |
+     * | 1000 | 0.001    | 0.10%   |
+     * | 5000 | 0.005    | 0.50%   |
+     * | 10000| 0.01     | 1.00%   |
+     *
      * @returns Action identifier and fee tier addition receipt
      * @throws {NordError} If the action submission fails or the new tier exceeds the maximum range (0-15).
      */
@@ -222,4 +237,11 @@ export declare class NordAdmin {
     updateAccountsTier(accounts: number[], tierId: number): Promise<{
         actionId: bigint;
     } & proto.Receipt_AccountsTierUpdated>;
+    feeVaultTransfer({ recipient, tokenId, amount, }: Readonly<{
+        recipient: number;
+        tokenId: number;
+        amount: Decimal.Value;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.Receipt_FeeVaultTransferred>;
 }

package/dist/client/NordUser.d.ts

@@ -1,6 +1,6 @@
 import { PublicKey, Transaction, SendOptions } from "@solana/web3.js";
 import Decimal from "decimal.js";
-import { FillMode, Side, SPLTokenInfo, QuoteSize, TriggerKind } from "../types";
+import { FillMode, Side, SPLTokenInfo, TriggerKind } from "../types";
 import * as proto from "../gen/nord_pb";
 import { BigIntValue } from "../utils";
 import { Nord } from "./Nord";
@@ -24,8 +24,8 @@ export interface UserAtomicSubaction {
     size?: Decimal.Value;
     /** Order price */
     price?: Decimal.Value;
-    /** Quote size object (for market-style placement) */
-    quoteSize?: QuoteSize;
+    /** Quote size in `base_decimals` + `price_decimals` (for market-style placement) */
+    quoteSize?: Decimal.Value;
     /** The client order ID of the order. */
     clientOrderId?: BigIntValue;
 }
@@ -36,6 +36,13 @@ export declare class NordUser {
     private readonly signSessionMessage;
     private readonly signMessage;
     private readonly signTransaction;
+    /** If set, will use signTransaction instead of signMessage for session creation.
+     * Because ledgers don't support signMessage, we have an escape hatch for them.
+     * However, the escape hatch is brittle and we recommend avoiditing as much as
+     * possible. Thus, _only_ use this if you are forced to use ledgers.
+     * To use this, just set it to true in your NordUser instance.
+     */
+    __use_solana_transaction_framing__: boolean;
     readonly nord: Nord;
     sessionId?: bigint;
     sessionPubKey: PublicKey;
@@ -52,7 +59,7 @@ export declare class NordUser {
     };
     orders: {
         [key: string]: {
-            orderId: string;
+            orderId: number;
             marketId: number;
             side: "ask" | "bid";
             size: number;
@@ -243,7 +250,7 @@ export declare class NordUser {
         isReduceOnly: boolean;
         size?: Decimal.Value;
         price?: Decimal.Value;
-        quoteSize?: QuoteSize;
+        quoteSize?: Decimal.Value;
         accountId?: number;
         clientOrderId?: BigIntValue;
     }>): Promise<{
@@ -259,7 +266,20 @@ export declare class NordUser {
      * @returns Object containing actionId, cancelled orderId, and accountId
      * @throws {NordError} If the operation fails
      */
-    cancelOrder(orderId: BigIntValue, providedAccountId?: number): Promise<{
+    cancelOrder(orderId: BigIntValue, accountId?: number): Promise<{
+        actionId: bigint;
+        orderId: bigint;
+        accountId: number;
+    }>;
+    /**
+     * Cancel an order by client_order_id.
+     *
+     * @param clientOrderId - Client order ID to cancel
+     * @param providedAccountId - Account ID that placed the order (defaults to the first account)
+     * @returns Object containing actionId, cancelled orderId, and accountId
+     * @throws {NordError} If the operation fails
+     */
+    cancelOrderByClientId(clientOrderId: BigIntValue, accountId?: number): Promise<{
         actionId: bigint;
         orderId: bigint;
         accountId: number;
@@ -295,20 +315,22 @@ export declare class NordUser {
      * @param marketId - Market the trigger belongs to
      * @param side - Order side for the trigger
      * @param kind - Stop-loss or take-profit trigger type
+     * @param triggerPrice - Trigger price of the trigger to remove
      * @param accountId - Account executing the trigger
      * @returns Object containing the actionId of the removal action
      * @throws {NordError} If the operation fails
      */
-    removeTrigger({ marketId, side, kind, accountId, }: Readonly<{
+    removeTrigger({ marketId, side, kind, triggerPrice, accountId, }: Readonly<{
         marketId: number;
         side: Side;
         kind: TriggerKind;
+        triggerPrice: Decimal.Value;
         accountId?: number;
     }>): Promise<{
         actionId: bigint;
     }>;
     /**
-     * Transfer tokens to another account
+     * Transfer tokens to one of the user's subaccounts
      *
      * @param tokenId - Token identifier to move
      * @param amount - Amount to transfer
@@ -316,15 +338,43 @@ export declare class NordUser {
      * @param toAccountId - Destination account id
      * @throws {NordError} If the operation fails
      */
-    transferToAccount({ tokenId, amount, fromAccountId, toAccountId, }: Readonly<{
+    transferOwned({ tokenId, amount, fromAccountId, toAccountId, }: Readonly<{
         tokenId: number;
         amount: Decimal.Value;
-        fromAccountId?: number;
-        toAccountId?: number;
+        fromAccountId: number;
+        toAccountId: number;
     }>): Promise<{
         actionId: bigint;
         newAccountId?: number;
     }>;
+    /**
+     * Transfer tokens to another unowned account
+     *
+     * @param tokenId - Token identifier to move
+     * @param amount - Amount to transfer
+     * @param fromAccountId - Source account id
+     * @param toAccountId - Destination account id
+     * @throws {NordError} If the operation fails
+     */
+    transferUnowned({ tokenId, amount, fromAccountId, toAccountId, }: Readonly<{
+        tokenId: number;
+        amount: Decimal.Value;
+        fromAccountId: number;
+        toAccountId: number;
+    }>): Promise<{
+        actionId: bigint;
+        newAccountId?: number;
+    }>;
+    /**
+     * Transfer tokens to another account
+     *
+     * @param tokenId - Token identifier to move
+     * @param amount - Amount to transfer
+     * @param fromAccountId - Source account id
+     * @param toAccountId - Destination account id
+     * @throws {NordError} If the operation fails
+     */
+    private transferToAccount;
     /**
      * Execute up to four place/cancel operations atomically.
      * Per Market: