@n1xyz/nord-ts 0.3.5 → 0.4.0

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,7 +2,7 @@ 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, Transaction } from "@solana/web3.js";
 type ReceiptKind = NonNullable<proto.Receipt["kind"]>;
@@ -41,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/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;
 }
@@ -250,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<{
@@ -291,20 +291,27 @@ export declare class NordUser {
      * @param side - Order side for the trigger
      * @param kind - Stop-loss or take-profit trigger type
      * @param triggerPrice - Price that activates the trigger
-     * @param limitPrice - Limit price placed once the trigger fires
+     * @param limitPrice - Optional limit price used once the trigger fires
+     * @param limitBaseSize - Optional base size limit used once the trigger fires
+     * @param limitQuoteSize - Optional quote size limit used once the trigger fires
      * @param accountId - Account executing the trigger
      * @returns Object containing the actionId of the submitted trigger
      * @throws {NordError} If the operation fails
      *
-     * NOTE: You can upsert a trigger by providing the same trigger data
-     * with specifically identifiaction by (marketId, accountId,side,kind).
+     * Trigger identity is exact: (marketId, side, kind, triggerPrice, limits).
+     * If you add multiple triggers at the same triggerPrice, they must differ by limits.
+     * If both `limitBaseSize` and `limitQuoteSize` are omitted, trigger executes with max reduce size
+     *
+     * Max triggers per position: 16
      */
-    addTrigger({ marketId, side, kind, triggerPrice, limitPrice, accountId, }: Readonly<{
+    addTrigger({ marketId, side, kind, triggerPrice, limitPrice, limitBaseSize, limitQuoteSize, accountId, }: Readonly<{
         marketId: number;
         side: Side;
         kind: TriggerKind;
         triggerPrice: Decimal.Value;
         limitPrice?: Decimal.Value;
+        limitBaseSize?: Decimal.Value;
+        limitQuoteSize?: Decimal.Value;
         accountId?: number;
     }>): Promise<{
         actionId: bigint;
@@ -315,20 +322,51 @@ 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 limitPrice - Optional limit price of the trigger to remove
+     * @param limitBaseSize - Optional base size limit of the trigger to remove
+     * @param limitQuoteSize - Optional quote size limit 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
+     *
+     * Removal is exact-match by (marketId, side, kind, triggerPrice, limits).
+     * If the trigger was created with any limits, pass the same limit fields here.
+     * If trigger size limits were omitted (`NULL`) on add, keep `limitBaseSize` and `limitQuoteSize`
+     * omitted here as well.
      */
-    removeTrigger({ marketId, side, kind, accountId, }: Readonly<{
+    removeTrigger({ marketId, side, kind, triggerPrice, limitPrice, limitBaseSize, limitQuoteSize, accountId, }: Readonly<{
         marketId: number;
         side: Side;
         kind: TriggerKind;
+        triggerPrice: Decimal.Value;
+        limitPrice?: Decimal.Value;
+        limitBaseSize?: Decimal.Value;
+        limitQuoteSize?: 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
+     * @param fromAccountId - Source account id
+     * @param toAccountId - Destination account id
+     * @throws {NordError} If the operation fails
+     */
+    transferOwned({ tokenId, amount, fromAccountId, toAccountId, }: Readonly<{
+        tokenId: number;
+        amount: Decimal.Value;
+        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
@@ -336,15 +374,25 @@ export declare class NordUser {
      * @param toAccountId - Destination account id
      * @throws {NordError} If the operation fails
      */
-    transferToAccount({ tokenId, amount, fromAccountId, toAccountId, }: Readonly<{
+    transferUnowned({ 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 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:
@@ -395,4 +443,6 @@ export declare class NordUser {
         };
     }>;
     protected submitSignedAction(kind: proto.Action["kind"], makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>): Promise<proto.Receipt>;
+    private buildTriggerKey;
+    private buildLimits;
 }