@n1xyz/nord-ts 0.5.0 → 0.6.0

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 } from "./types";
+import { FillMode, PlacementRequest, Side, TriggerKind } from "./types";
 import { BigIntValue } from "./utils";
 import { PublicKey, Transaction } from "@solana/web3.js";
 type ReceiptKind = NonNullable<proto.Receipt["kind"]>;
@@ -13,6 +13,8 @@ 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 buildLimits(marketPriceDecimals: number, marketSizeDecimals: number, limitPrice?: Decimal.Value, limitBaseSize?: Decimal.Value, limitQuoteSize?: Decimal.Value): proto.OrderLimit | undefined;
+export declare function toProtoU128(value: BigIntValue): proto.U128;
 export declare function createAction(currentTimestamp: bigint, nonce: number, kind: proto.Action["kind"]): proto.Action;
 export declare function sendAction(client: Client<paths>, 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>>;
@@ -54,14 +56,49 @@ export type AtomicSubaction = {
     quoteSize?: Decimal.Value;
     clientOrderId?: BigIntValue;
     delegatorAccountId?: number;
+    placement?: PlacementRequest;
+    referrer?: BigIntValue;
 } | {
     kind: "cancel";
     orderId: BigIntValue;
     delegatorAccountId?: number;
+    placement?: PlacementRequest;
 } | {
     kind: "cancelByClientId";
     clientOrderId: BigIntValue;
     delegatorAccountId?: number;
+    placement?: PlacementRequest;
+} | {
+    kind: "addTrigger";
+    marketId: number;
+    side: Side;
+    triggerKind: TriggerKind;
+    triggerPrice: Decimal.Value;
+    priceDecimals: number;
+    sizeDecimals: number;
+    limitPrice?: Decimal.Value;
+    limitBaseSize?: Decimal.Value;
+    limitQuoteSize?: Decimal.Value;
+    placement?: PlacementRequest;
+    referrer?: BigIntValue;
+} | {
+    kind: "editTrigger";
+    triggerId: BigIntValue;
+    marketId: number;
+    side: Side;
+    triggerKind: TriggerKind;
+    triggerPrice: Decimal.Value;
+    priceDecimals: number;
+    sizeDecimals: number;
+    limitPrice?: Decimal.Value;
+    limitBaseSize?: Decimal.Value;
+    limitQuoteSize?: Decimal.Value;
+    placement?: PlacementRequest;
+} | {
+    kind: "removeTrigger";
+    marketId: number;
+    triggerId: BigIntValue;
+    placement?: PlacementRequest;
 };
 export declare function atomic(client: Client<paths>, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
     sessionId: BigIntValue;

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, AccountPnlInfoPage, AccountPositionInfoPage, AccountPnlSummaryResult, GetAccountPnlQuery, PagedQuery, ActionResponse, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, Token, TradesResponse, User, AccountTriggerInfo, TriggerPlaceHistoryPage, TriggerFinaliseHistoryPage, WithdrawalHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole, AdminInfo, AccountVolumeInfo, GetAccountVolumeQuery, CandleResolution, TakeAllInfo, MarketsLiveInfo, MarketLiveInfo } from "../types";
+import { Account, AccountPnlInfoPage, AccountPositionInfoPage, AccountPnlSummaryResult, ActionIdSubActionIdMarketIdCursor, AtomicActionId, GetAccountPositionHistoryQuery, GetAccountPnlQuery, PagedQuery, ActionResponse, MarketsInfo, Market, MarketStats, NordConfig, OrderbookQuery, OrderbookResponse, FeeTierConfig, Token, TradesResponse, User, AccountTriggerInfo, TriggerPlaceHistoryPage, TriggerFinaliseHistoryPage, WithdrawalHistoryPage, FeeTierId, AccountFeeTierPage, PageResultStringOrderInfo, PageResultStringTrade, OrderInfoFromApi, TokenStats, FillRole, AdminInfo, AccountVolumeInfo, GetAccountVolumeQuery, CandleResolution, TakeAllInfo, MarketsLiveInfo, MarketLiveInfo } from "../types";
 import { NordWebSocketClient } from "../websocket/index";
 import { OrderbookSubscription, TradeSubscription, CandleSubscription } from "../websocket/Subscriber";
 /**
@@ -321,7 +321,10 @@ export declare class Nord {
      * @returns Page of PnL entries ordered from latest to oldest
      * @throws {NordError} If the request fails
      */
-    getAccountPnl(accountId: number, { since, until, startInclusive, pageSize, }?: Readonly<Partial<PagedQuery>>): Promise<AccountPnlInfoPage>;
+    getAccountPnl(accountId: number, { since, until, startInclusive, pageSize, }?: Readonly<Partial<GetAccountPnlQuery> & {
+        startInclusive?: ActionIdSubActionIdMarketIdCursor;
+        pageSize?: number;
+    }>): Promise<AccountPnlInfoPage>;
     /**
      * Get profit and loss totals for an account over a time window.
      *
@@ -344,9 +347,7 @@ export declare class Nord {
      * @returns History of position updates
      * @throws {NordError} If the request fails
      */
-    getAccountPositionHistory(accountId: number, { since, until, marketId, pageSize, startInclusive, }?: Readonly<Partial<GetAccountPnlQuery & Omit<PagedQuery, "startInclusive">> & {
-        startInclusive?: string;
-    }>): Promise<AccountPositionInfoPage>;
+    getAccountPositionHistory(accountId: number, { since, until, marketId, pageSize, startInclusive, }?: Readonly<Partial<GetAccountPositionHistoryQuery>>): Promise<AccountPositionInfoPage>;
     getAccountPnlSummary(accountId: number, { since, until, marketId }?: Readonly<Partial<GetAccountPnlQuery>>): Promise<AccountPnlSummaryResult>;
     getMarketsLive(): Promise<MarketsLiveInfo>;
     getMarketLive({ marketId, }: Readonly<{
@@ -425,8 +426,9 @@ export declare class Nord {
      * @param startInclusive - Pagination cursor to resume from
      * @throws {NordError} If no account can be resolved or the request fails.
      */
-    getAccountTriggerPlaceHistory({ accountId, since, until, pageSize, startInclusive, }: Readonly<PagedQuery & {
+    getAccountTriggerPlaceHistory({ accountId, since, until, pageSize, startInclusive, }: Readonly<Omit<PagedQuery, "startInclusive"> & {
         accountId?: number;
+        startInclusive?: AtomicActionId;
     }>): Promise<TriggerPlaceHistoryPage>;
     /**
      * Fetch trigger finalisation history for an account.

package/dist/client/NordAdmin.d.ts

@@ -156,6 +156,24 @@ export declare class NordAdmin {
     }>): Promise<{
         actionId: bigint;
     } & proto.Receipt_BackstopAccountSet>;
+    createVault({ manager, config, }: Readonly<{
+        manager: PublicKey;
+        config: proto.VaultConfig;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.CreateVaultReceipt>;
+    updateVaultConfig({ vaultId, configPatch, }: Readonly<{
+        vaultId: number;
+        configPatch: proto.VaultConfigPatch;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.UpdateVaultConfigReceipt>;
+    setVaultManager({ vaultId, manager, }: Readonly<{
+        vaultId: number;
+        manager: PublicKey;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.SetVaultManagerReceipt>;
     /**
      * Freeze an individual market, preventing new trades and orders.
      *

package/dist/client/NordUser.d.ts

@@ -1,36 +1,60 @@
 import { PublicKey, Transaction, SendOptions } from "@solana/web3.js";
 import Decimal from "decimal.js";
-import { FillMode, Side, SPLTokenInfo, TriggerKind } from "../types";
+import { FillMode, Side, SPLTokenInfo, TriggerKind, SelfTradePrevention, PlacementRequest, VaultWithdrawRequestKind } from "../types";
 import * as proto from "../gen/nord_pb";
 import { BigIntValue } from "../utils";
 import { Nord } from "./Nord";
-/**
- * Parameters for individual atomic subactions (user-friendly version)
- */
-export interface UserAtomicSubaction {
-    /** The type of action to perform. */
-    kind: "place" | "cancel" | "cancelByClientId";
-    /** The market ID to place the order in. */
-    marketId?: number;
-    /** The order ID to cancel. */
-    orderId?: BigIntValue;
-    /** Order side (bid or ask) */
-    side?: Side;
-    /** Fill mode (limit, market, etc.) */
-    fillMode?: FillMode;
-    /** Whether the order is reduce-only. */
-    isReduceOnly?: boolean;
-    /** The size of the order. */
+export type UserAtomicSubaction = {
+    kind: "place";
+    marketId: number;
+    side: Side;
+    fillMode: FillMode;
+    isReduceOnly: boolean;
     size?: Decimal.Value;
-    /** Order price */
     price?: Decimal.Value;
-    /** Quote size in `base_decimals` + `price_decimals` (for market-style placement) */
     quoteSize?: Decimal.Value;
-    /** The client order ID of the order. */
     clientOrderId?: BigIntValue;
-    /** Optional account to delegate this subaction to. */
     delegatorAccountId?: number;
-}
+    placement?: PlacementRequest;
+    referrer?: BigIntValue;
+} | {
+    kind: "cancel";
+    orderId: BigIntValue;
+    delegatorAccountId?: number;
+    placement?: PlacementRequest;
+} | {
+    kind: "cancelByClientId";
+    clientOrderId: BigIntValue;
+    delegatorAccountId?: number;
+    placement?: PlacementRequest;
+} | {
+    kind: "addTrigger";
+    marketId: number;
+    side: Side;
+    triggerKind: TriggerKind;
+    triggerPrice: Decimal.Value;
+    limitPrice?: Decimal.Value;
+    limitBaseSize?: Decimal.Value;
+    limitQuoteSize?: Decimal.Value;
+    placement?: PlacementRequest;
+    referrer?: BigIntValue;
+} | {
+    kind: "editTrigger";
+    triggerId: BigIntValue;
+    marketId: number;
+    side: Side;
+    triggerKind: TriggerKind;
+    triggerPrice: Decimal.Value;
+    limitPrice?: Decimal.Value;
+    limitBaseSize?: Decimal.Value;
+    limitQuoteSize?: Decimal.Value;
+    placement?: PlacementRequest;
+} | {
+    kind: "removeTrigger";
+    marketId: number;
+    triggerId: BigIntValue;
+    placement?: PlacementRequest;
+};
 export interface NormalizedReceiptTrade {
     orderId: bigint;
     price: number;
@@ -217,7 +241,7 @@ export declare class NordUser {
      *
      * @throws {NordError} If the operation fails
      */
-    refreshSession(): Promise<void>;
+    refreshSession(expiryTimestamp?: bigint): Promise<void>;
     /**
      * Revoke a session
      *
@@ -246,6 +270,29 @@ export declare class NordUser {
     }>): Promise<{
         actionId: bigint;
     }>;
+    vaultDeposit({ vaultId, amount, }: Readonly<{
+        vaultId: number;
+        amount: Decimal.Value;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.VaultDepositReceipt>;
+    vaultWithdrawRequest({ vaultId, kind, amount, }: Readonly<{
+        vaultId: number;
+        kind: VaultWithdrawRequestKind;
+        amount: Decimal.Value;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.VaultWithdrawReceipt>;
+    vaultWithdrawClaim({ vaultId, }: Readonly<{
+        vaultId: number;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.VaultWithdrawReceipt>;
+    vaultSyncEpochs({ vaultId, }: Readonly<{
+        vaultId: number;
+    }>): Promise<{
+        actionId: bigint;
+    } & proto.VaultSyncEpochsReceipt>;
     /**
      * Place an order on the exchange
      *
@@ -258,10 +305,11 @@ export declare class NordUser {
      * @param quoteSize - Quote-sized order representation
      * @param accountId - Account executing the order
      * @param clientOrderId - Optional client-specified identifier
+     * @param referrer - Optional referrer ID. Tracks which frontend/referral source placed order.
      * @returns Object containing actionId, orderId (if posted), fills, and reducedOrders (reduce-only orders fully or partially cancelled by maintenance)
      * @throws {NordError} If the operation fails
      */
-    placeOrder({ marketId, side, fillMode, isReduceOnly, size, price, quoteSize, accountId, clientOrderId, }: Readonly<{
+    placeOrder({ marketId, side, fillMode, isReduceOnly, size, price, quoteSize, selfTradePrevention, accountId, clientOrderId, referrer, }: Readonly<{
         marketId: number;
         side: Side;
         fillMode: FillMode;
@@ -269,8 +317,10 @@ export declare class NordUser {
         size?: Decimal.Value;
         price?: Decimal.Value;
         quoteSize?: Decimal.Value;
+        selfTradePrevention?: SelfTradePrevention;
         accountId?: number;
         clientOrderId?: BigIntValue;
+        referrer?: BigIntValue;
     }>): Promise<{
         actionId: bigint;
         orderId?: bigint;
@@ -281,6 +331,12 @@ export declare class NordUser {
             cancelledSize: number;
             price: number;
         }[];
+        selfTradeCancels: {
+            orderId: bigint;
+            remainingSize: number;
+            cancelledSize: number;
+            price: number;
+        }[];
     }>;
     /**
      * Cancel an order
@@ -327,6 +383,7 @@ export declare class NordUser {
      * @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
+     * @param referrer - Optional referrer ID. Tracks which frontend/referral source placed trigger
      * @returns Object containing the actionId of the submitted trigger
      * @throws {NordError} If the operation fails
      *
@@ -336,7 +393,7 @@ export declare class NordUser {
      *
      * Max triggers per position: 16
      */
-    addTrigger({ marketId, side, kind, triggerPrice, limitPrice, limitBaseSize, limitQuoteSize, accountId, }: Readonly<{
+    addTrigger({ marketId, side, kind, triggerPrice, limitPrice, limitBaseSize, limitQuoteSize, accountId, referrer, }: Readonly<{
         marketId: number;
         side: Side;
         kind: TriggerKind;
@@ -345,6 +402,7 @@ export declare class NordUser {
         limitBaseSize?: Decimal.Value;
         limitQuoteSize?: Decimal.Value;
         accountId?: number;
+        referrer?: BigIntValue;
     }>): Promise<{
         actionId: bigint;
         triggerId: bigint;
@@ -440,13 +498,25 @@ export declare class NordUser {
      */
     private transferToAccount;
     /**
-     * Execute up to four place/cancel operations atomically.
-     * Per Market:
-     * 1. cancels can only be in the start (one cannot predict future order ids)
+     * Execute up to ten supported subactions atomically.
+     *
+     * Supported subactions:
+     * - place
+     * - cancel
+     * - cancelByClientId
+     * - addTrigger
+     * - editTrigger
+     * - removeTrigger
+     *
+     * Per market, market-scoped subactions are phase-validated:
+     * 1. cancels and trigger removals can only be at the start
      * 2. intermediate trades can trade only
-     * 3. placements go last
+     * 3. placements and trigger adds/edits go last
+     *
+     * Across markets, market-scoped subactions can be in any order.
      *
-     * Across Markets, order action can be any
+     * Trigger subactions are account-scoped. In one atomic sequence, the same
+     * trigger target cannot be added, edited, or removed more than once.
      *
      * @param userActions array of user-friendly subactions
      * @param providedAccountId optional account performing the action (defaults to first account)
@@ -489,5 +559,4 @@ export declare class NordUser {
         };
     }>;
     protected submitSignedAction(kind: proto.Action["kind"], makeSignedMessage: (message: Uint8Array) => Promise<Uint8Array>): Promise<proto.Receipt>;
-    private buildLimits;
 }