@n1xyz/nord-ts 0.1.12 → 0.3.1

package/dist/gen/openapi.d.ts

@@ -707,7 +707,7 @@ export interface paths {
                     /** @description end with this timestamp (RFC3339); defaults to current date-time */
                     until?: string;
                     /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
-                    startInclusive?: number | null;
+                    startInclusive?: string | null;
                     /** @description Query returns up to 50 trades in one go. */
                     pageSize?: number | null;
                 };
@@ -725,7 +725,49 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["PageResult_for_uint64_and_AccountPnl"];
+                        "application/json": components["schemas"]["PageResult_for_String_and_AccountPnlInfo"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/{account_id}/pnl/funding/history/PT1H": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description 11:00 - funding rate captured 11:30 - position 10 funding 0.01 12:00 - capture 12:20 - position zeroed
+         *
+         *     will return - used payed funding for 11:00-12.00, using last position before 12:00 capture using funding index formed at 11:30 and market funding index formed at 12:00 - 12:00 - 13:00 PnL will not be returned at all.
+         *
+         *     For exact applied PnL use more per trade PnL. */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Account for which to retrieve PnL history */
+                    account_id: number;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AccountPnlHistInfo"][];
                     };
                 };
             };
@@ -753,7 +795,7 @@ export interface paths {
                     /** @description end with this timestamp (RFC3339); defaults to current date-time */
                     until?: string;
                     /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
-                    startInclusive?: number | null;
+                    startInclusive?: string | null;
                     /** @description Query returns up to 50 trades in one go. */
                     pageSize?: number | null;
                 };
@@ -770,7 +812,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["PageResult_for_uint64_and_Trigger"];
+                        "application/json": components["schemas"]["PageResult_for_String_and_Trigger"];
                     };
                 };
             };
@@ -806,7 +848,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["AccountTriggerInfo"][] | null;
+                        "application/json": components["schemas"]["TriggerInfo"][] | null;
                     };
                 };
             };
@@ -1383,7 +1425,7 @@ export interface paths {
                     /** @description end with this timestamp (RFC3339); defaults to current date-time */
                     until?: string;
                     /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
-                    startInclusive?: number | null;
+                    startInclusive?: string | null;
                     /** @description Query returns up to 50 trades in one go. */
                     pageSize?: number | null;
                 };
@@ -1401,7 +1443,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["PageResult_for_uint64_and_Withdrawal"];
+                        "application/json": components["schemas"]["PageResult_for_String_and_Withdrawal"];
                     };
                 };
                 404: {
@@ -1458,6 +1500,43 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/market/{market_id}/history/PT1H": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Gets market updates history for some period of time. Default is hourly for last 24 hours */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    market_id: number;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PageResult_for_String_and_MarketHistoryInfo"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2427,7 +2506,9 @@ export interface components {
             indexPriceConf: number;
             frozen?: boolean;
             /** Format: double */
-            volume24h: number;
+            volumeBase24h: number;
+            /** Format: double */
+            volumeQuote24h: number;
             /** Format: double */
             high24h: number;
             /** Format: double */
@@ -2508,8 +2589,7 @@ export interface components {
             placedSize: number;
             /** Format: double */
             filledSize?: number | null;
-            /** Format: uint64 */
-            updateActionId: number;
+            updateActionId: string;
             isReduceOnly: boolean;
             fillMode: components["schemas"]["FillMode"];
             /** Format: double */
@@ -2644,11 +2724,8 @@ export interface components {
              * @default null
              */
             until: string;
-            /**
-             * Format: uint64
-             * @description fetch results starting with this page; query starts with first entry if page isn't specified
-             */
-            startInclusive?: number | null;
+            /** @description fetch results starting with this page; query starts with first entry if page isn't specified */
+            startInclusive?: string | null;
             /**
              * Format: uint8
              * @description Query returns up to 50 trades in one go.
@@ -2656,32 +2733,64 @@ export interface components {
              */
             pageSize: number | null;
         };
-        PageResult_for_uint64_and_AccountPnl: {
+        PageResult_for_String_and_AccountPnlInfo: {
             /** @description Set of items for requested by query. */
-            items: components["schemas"]["AccountPnl"][];
-            /**
-             * Format: uint64
-             * @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;
+            items: components["schemas"]["AccountPnlInfo"][];
+            /** @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?: string | null;
         };
-        AccountPnl: {
+        AccountPnlInfo: {
             time: string;
-            /** Format: uint64 */
-            actionId: number;
+            actionId: string;
             /** Format: uint32 */
             accountId: number;
             /** Format: double */
+            pricePnlDelta: number;
+            /** Format: double */
+            fundingPnlDelta: number;
+            /**
+             * Format: double
+             * @description Total PnL update
+             */
             pnl: number;
         };
-        PageResult_for_uint64_and_Trigger: {
-            /** @description Set of items for requested by query. */
-            items: components["schemas"]["Trigger"][];
+        AccountPnlHistInfo: {
+            /** @description Same time when funding is applied */
+            time: string;
             /**
-             * Format: uint64
-             * @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.
+             * Format: double
+             * @description Funding rate used to calculate this funding payment
              */
-            nextStartInclusive?: number | null;
+            fundingRate: number;
+            /**
+             * Format: double
+             * @description Size used to calculated funding payment
+             */
+            fundingSize?: number | null;
+            /** @description Side on time of funding application. */
+            side?: components["schemas"]["Side"] | null;
+            /**
+             * Format: double
+             * @description Result of `user_funding_index - market_Funding_index`.
+             */
+            fundingIndexChange?: number | null;
+            /**
+             * Format: double
+             * @description Funding pnl for this funding period, i.e. funding_size * funding_index_change. Negate for the funding paid by the account for this period.
+             */
+            fundingPnl: number;
+            market: components["schemas"]["MarketIdInfo"];
+        };
+        MarketIdInfo: {
+            /** Format: uint32 */
+            market_id: number;
+            market_symbol: string;
+        };
+        PageResult_for_String_and_Trigger: {
+            /** @description Set of items for requested by query. */
+            items: components["schemas"]["Trigger"][];
+            /** @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?: string | null;
         };
         Trigger: {
             /** Format: uint32 */
@@ -2693,10 +2802,8 @@ export interface components {
             side: components["schemas"]["Side"];
             kind: components["schemas"]["TriggerKind"];
             status: components["schemas"]["TriggerStatus"];
-            /** Format: uint64 */
-            createdAtActionId: number;
-            /** Format: uint64 */
-            finalizedAtActionId?: number | null;
+            createdAtActionId: string;
+            finalizedAtActionId?: string | null;
             createdAt: string;
             finalizedAt: string;
         };
@@ -2709,22 +2816,20 @@ export interface components {
         TriggerKind: "stopLoss" | "takeProfit";
         /** @enum {string} */
         TriggerStatus: "Active" | "Success" | "Removed" | "Canceled";
-        /** @description Trigger into per account. */
-        AccountTriggerInfo: {
+        TriggerInfo: {
+            /** Format: uint32 */
+            accountId: number;
             /** Format: uint32 */
             marketId: number;
-            key: components["schemas"]["TriggerKey"];
-            triggerPrices: components["schemas"]["TriggerPrice"];
-            /** Format: uint64 */
-            actionId: number;
-        };
-        TriggerKey: {
+            /** Format: int64 */
+            triggerPrice: number;
+            /** Format: int64 */
+            limitPrice?: number | null;
             side: components["schemas"]["Side"];
             kind: components["schemas"]["TriggerKind"];
-        };
-        TriggerPrice: {
-            trigger: components["schemas"]["PositivePriceMantissa"];
-            settlement?: components["schemas"]["PositivePriceMantissa"] | null;
+            /** @description created_at_action_id */
+            actionId: string;
+            createdAt: string;
         };
         OrderNotFound: null;
         PageResult_for_String_and_Trade: {
@@ -2787,13 +2892,17 @@ export interface components {
              */
             pageSize: number | null;
         };
-        DownloadFilter: components["schemas"]["Op_for_DataDateTime"] | components["schemas"]["Op_for_uint64"] | components["schemas"]["Op_for_uint64"] | null;
+        DownloadFilter: components["schemas"]["Op_for_DataDateTime"] | components["schemas"]["Op_for_String"] | components["schemas"]["Op_for_uint64"] | null;
         /** @description Parses tag (anycase), and value in round braces using `from_str`. */
         Op_for_DataDateTime: {
             le: components["schemas"]["DataDateTime"];
         };
         DataDateTime: string;
         /** @description Parses tag (anycase), and value in round braces using `from_str`. */
+        Op_for_String: {
+            le: string;
+        };
+        /** @description Parses tag (anycase), and value in round braces using `from_str`. */
         Op_for_uint64: {
             /** Format: uint64 */
             le: number;
@@ -2884,7 +2993,9 @@ export interface components {
             /** Format: uint32 */
             marketId: number;
             /** Format: double */
-            volume: number;
+            volumeBase: number;
+            /** Format: double */
+            volumeQuote: number;
         };
         GetPrevMarketPriceQuery: {
             atOrBefore: string;
@@ -2895,19 +3006,15 @@ export interface components {
             /** Format: double */
             price?: number | null;
         };
-        PageResult_for_uint64_and_Withdrawal: {
+        PageResult_for_String_and_Withdrawal: {
             /** @description Set of items for requested by query. */
             items: components["schemas"]["Withdrawal"][];
-            /**
-             * Format: uint64
-             * @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;
+            /** @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?: string | null;
         };
         Withdrawal: {
             time: string;
-            /** Format: uint64 */
-            actionId: number;
+            actionId: string;
             /** Format: uint32 */
             accountId: number;
             /** Format: uint32 */
@@ -3083,6 +3190,26 @@ export interface components {
         };
         /** @description Empty object, to make quotes item conform to API error spec */
         TvQuotesErrorValues: Record<string, never>;
+        PageResult_for_String_and_MarketHistoryInfo: {
+            /** @description Set of items for requested by query. */
+            items: components["schemas"]["MarketHistoryInfo"][];
+            /** @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?: string | null;
+        };
+        MarketHistoryInfo: {
+            /** Format: uint32 */
+            marketId: number;
+            time: string;
+            actionId: string;
+            fundingIndex: components["schemas"]["FundingIndexMantissa"];
+            /** Format: double */
+            fundingRate: number;
+        };
+        /**
+         * Format: int128
+         * @description Consist of some sum of `SignedBasisPoints` weighted by `PriceMantissa`(with market decimals). Funding rate jitters around 0, so really hard to get big numbers. Is `basic points numerator * market price mantissa` unit.
+         */
+        FundingIndexMantissa: number;
     };
     responses: never;
     parameters: never;

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

@@ -0,0 +1,128 @@
+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, 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, client?: Client<paths>): 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: (x: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    userPubkey: Uint8Array;
+    sessionPubkey: Uint8Array;
+    expiryTimestamp?: bigint;
+}, client?: Client<paths>): Promise<{
+    actionId: bigint;
+    sessionId: bigint;
+}>;
+export declare function revokeSession(serverUrl: string, walletSignFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+}, client?: Client<paths>): Promise<{
+    actionId: bigint;
+}>;
+export declare function withdraw(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sizeDecimals: number;
+    sessionId: BigIntValue;
+    tokenId: number;
+    amount: Decimal.Value;
+}): Promise<{
+    actionId: bigint;
+} & proto.Receipt_WithdrawResult>;
+export declare function placeOrder(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    senderId?: number;
+    sizeDecimals: number;
+    priceDecimals: number;
+    marketId: number;
+    side: Side;
+    fillMode: FillMode;
+    isReduceOnly: boolean;
+    size?: Decimal.Value;
+    price?: Decimal.Value;
+    quoteSize?: QuoteSize;
+    liquidateeId?: number;
+    clientOrderId?: BigIntValue;
+}): Promise<{
+    actionId: bigint;
+    orderId?: bigint;
+    fills: proto.Receipt_Trade[];
+}>;
+export declare function cancelOrder(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    senderId?: number;
+    orderId: BigIntValue;
+    liquidateeId?: number;
+}): Promise<{
+    actionId: bigint;
+    orderId: bigint;
+    accountId: number;
+}>;
+export declare function transfer(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    fromAccountId: number;
+    toAccountId?: number;
+    tokenId: number;
+    tokenDecimals: number;
+    amount: Decimal.Value;
+}): Promise<{
+    actionId: bigint;
+    fromAccountId: number;
+    toAccountId?: number;
+    tokenId: number;
+    amount: bigint;
+    accountCreated: boolean;
+}>;
+export declare function addTrigger(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    marketId: number;
+    side: Side;
+    kind: TriggerKind;
+    priceDecimals: number;
+    triggerPrice: Decimal.Value;
+    limitPrice?: Decimal.Value;
+    accountId?: number;
+}): Promise<{
+    actionId: bigint;
+}>;
+export declare function removeTrigger(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    marketId: number;
+    side: Side;
+    kind: TriggerKind;
+    accountId?: number;
+}): Promise<{
+    actionId: bigint;
+}>;
+export type AtomicSubaction = {
+    kind: "place";
+    marketId: number;
+    side: Side;
+    fillMode: FillMode;
+    isReduceOnly: boolean;
+    sizeDecimals: number;
+    priceDecimals: number;
+    size?: Decimal.Value;
+    price?: Decimal.Value;
+    quoteSize?: QuoteSize;
+    clientOrderId?: BigIntValue;
+} | {
+    kind: "cancel";
+    orderId: BigIntValue;
+};
+export declare function atomic(serverUrl: string, signFn: (message: Uint8Array) => Promise<Uint8Array>, currentTimestamp: bigint, nonce: number, params: {
+    sessionId: BigIntValue;
+    accountId?: number;
+    actions: AtomicSubaction[];
+}, client?: Client<paths>): Promise<{
+    actionId: bigint;
+    results: proto.Receipt_AtomicSubactionResultKind[];
+}>;
+export {};