@grvt/client 1.5.1 → 1.5.3

package/interfaces/codegen/data.interface.d.ts

@@ -285,6 +285,17 @@ export interface IApiBatchQueryVaultRiskMetricRequest {
 export interface IApiBatchQueryVaultRiskMetricResponse {
     result?: IVaultRiskMetric[];
 }
+export interface IApiBulkOrdersRequest {
+    sub_account_id?: string;
+    orders?: IOrder[];
+    order_i_ds?: string[];
+    client_order_i_ds?: string[];
+    time_to_live_ms?: string;
+}
+export interface IApiBulkOrdersResponse {
+    orders?: IOrder[];
+    cancel_acks?: IAck[];
+}
 export interface IApiCancelAllOrdersRequest {
     sub_account_id?: string;
     kind?: EKind[];
@@ -357,6 +368,9 @@ export interface IApiDepositHistoryResponse {
     result?: IDepositHistory[];
     next?: string;
 }
+export interface IApiDetailedAggregatedAccountSummaryResponse {
+    result?: IDetailedAggregatedAccountSummary;
+}
 export interface IApiDropClientWsRequest {
     main_account_id?: string;
 }
@@ -575,6 +589,11 @@ export interface IApiGetUserEcosystemPointRequest {
 export interface IApiGetUserEcosystemPointResponse {
     points?: IEcosystemPoint[];
 }
+export interface IApiGetUserVaultRewardPointResponse {
+    ecosystem_point?: string;
+    trader_point?: string;
+    lp_point?: string;
+}
 export interface IApiGetVerifiedEcosystemLeaderboardRequest {
     calculate_from?: string;
     completed_kyc_before?: string;
@@ -589,7 +608,10 @@ export interface IApiListAggregatedAccountSummaryRequest {
     main_account_ids?: string[];
 }
 export interface IApiListAggregatedAccountSummaryResponse {
-    account_summaries?: IApiAggregatedAccountSummaryResponse[];
+    account_summaries?: IApiDetailedAggregatedAccountSummaryResponse[];
+}
+export interface IApiListEpochUserVaultRewardPointResponse {
+    result?: IEpochUserVaultRewardPoint[];
 }
 export interface IApiMiniTickerRequest {
     instrument?: string;
@@ -1139,6 +1161,13 @@ export interface IDepositHistory {
     confirmed_time?: string;
     from_address?: string;
 }
+export interface IDetailedAggregatedAccountSummary {
+    main_account_id?: string;
+    total_equity?: string;
+    spot_balances?: ISpotBalance[];
+    vault_investments?: IVaultInvestment[];
+    funding_account_balance?: string;
+}
 export interface IECNToBrokerFeed {
     order_id?: string;
     client_order_id?: string;
@@ -1222,6 +1251,12 @@ export interface IEpochLPPoint {
     liquidity_score?: string;
     vault_liquidity_score?: string;
 }
+export interface IEpochUserVaultRewardPoint {
+    epoch?: number;
+    ecosystem_point?: string;
+    trader_point?: string;
+    lp_point?: string;
+}
 export interface IError {
     code?: number;
     message?: string;
@@ -1553,6 +1588,9 @@ export interface IQueryTradingPerformanceTrendResponse {
 export interface IQueryVaultInvestorHistoryRequest {
     main_account_id?: string;
     vault_id?: string;
+    types?: EVaultInvestorAction[];
+    start_time?: string;
+    end_time?: string;
 }
 export interface IQueryVaultInvestorHistoryResponse {
     result?: IVaultInvestorHistory[];
@@ -1617,6 +1655,7 @@ export interface ISnapVaultSummary {
     lp_infos?: ILpInfoEntry[];
     total_lp_token_supply?: string;
     share_price?: string;
+    reward_sharing_ratio_centi_beeps?: number;
 }
 export interface ISpotBalance {
     currency?: string;

package/interfaces/codegen/schema-maps/api_bulk_orders_request.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const API_BULK_ORDERS_REQUEST_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/api_bulk_orders_request.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_BULK_ORDERS_REQUEST_MAP = void 0;
+const order_1 = require("./order");
+// Schema map for the 'API_BULK_ORDERS_REQUEST' struct.
+exports.API_BULK_ORDERS_REQUEST_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        sub_account_id: 'sa',
+        orders: ['o', [order_1.ORDER_MAP.FULL_TO_LITE]],
+        order_i_ds: 'oi',
+        client_order_i_ds: 'co',
+        time_to_live_ms: 'tt'
+    },
+    LITE_TO_FULL: {
+        sa: 'sub_account_id',
+        o: ['orders', [order_1.ORDER_MAP.LITE_TO_FULL]],
+        oi: 'order_i_ds',
+        co: 'client_order_i_ds',
+        tt: 'time_to_live_ms'
+    }
+});

package/interfaces/codegen/schema-maps/api_bulk_orders_response.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const API_BULK_ORDERS_RESPONSE_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/api_bulk_orders_response.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_BULK_ORDERS_RESPONSE_MAP = void 0;
+const order_1 = require("./order");
+const ack_1 = require("./ack");
+// Schema map for the 'API_BULK_ORDERS_RESPONSE' struct.
+exports.API_BULK_ORDERS_RESPONSE_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        orders: ['o', [order_1.ORDER_MAP.FULL_TO_LITE]],
+        cancel_acks: ['ca', [ack_1.ACK_MAP.FULL_TO_LITE]]
+    },
+    LITE_TO_FULL: {
+        o: ['orders', [order_1.ORDER_MAP.LITE_TO_FULL]],
+        ca: ['cancel_acks', [ack_1.ACK_MAP.LITE_TO_FULL]]
+    }
+});

package/interfaces/codegen/schema-maps/api_detailed_aggregated_account_summary_response.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/api_detailed_aggregated_account_summary_response.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP = void 0;
+const detailed_aggregated_account_summary_1 = require("./detailed_aggregated_account_summary");
+// Schema map for the 'API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE' struct.
+exports.API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        result: ['r', detailed_aggregated_account_summary_1.DETAILED_AGGREGATED_ACCOUNT_SUMMARY_MAP.FULL_TO_LITE]
+    },
+    LITE_TO_FULL: {
+        r: ['result', detailed_aggregated_account_summary_1.DETAILED_AGGREGATED_ACCOUNT_SUMMARY_MAP.LITE_TO_FULL]
+    }
+});

package/interfaces/codegen/schema-maps/api_get_user_vault_reward_point_response.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const API_GET_USER_VAULT_REWARD_POINT_RESPONSE_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/api_get_user_vault_reward_point_response.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_GET_USER_VAULT_REWARD_POINT_RESPONSE_MAP = void 0;
+// Schema map for the 'API_GET_USER_VAULT_REWARD_POINT_RESPONSE' struct.
+exports.API_GET_USER_VAULT_REWARD_POINT_RESPONSE_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        ecosystem_point: 'ep',
+        trader_point: 'tp',
+        lp_point: 'lp'
+    },
+    LITE_TO_FULL: {
+        ep: 'ecosystem_point',
+        tp: 'trader_point',
+        lp: 'lp_point'
+    }
+});

package/interfaces/codegen/schema-maps/api_list_aggregated_account_summary_response.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API_LIST_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP = void 0;
-const api_aggregated_account_summary_response_1 = require("./api_aggregated_account_summary_response");
+const api_detailed_aggregated_account_summary_response_1 = require("./api_detailed_aggregated_account_summary_response");
 // Schema map for the 'API_LIST_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE' struct.
 exports.API_LIST_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP = Object.freeze({
     FULL_TO_LITE: {
-        account_summaries: ['as', [api_aggregated_account_summary_response_1.API_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP.FULL_TO_LITE]]
+        account_summaries: ['as', [api_detailed_aggregated_account_summary_response_1.API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP.FULL_TO_LITE]]
     },
     LITE_TO_FULL: {
-        as: ['account_summaries', [api_aggregated_account_summary_response_1.API_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP.LITE_TO_FULL]]
+        as: ['account_summaries', [api_detailed_aggregated_account_summary_response_1.API_DETAILED_AGGREGATED_ACCOUNT_SUMMARY_RESPONSE_MAP.LITE_TO_FULL]]
     }
 });

package/interfaces/codegen/schema-maps/api_list_epoch_user_vault_reward_point_response.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const API_LIST_EPOCH_USER_VAULT_REWARD_POINT_RESPONSE_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/api_list_epoch_user_vault_reward_point_response.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_LIST_EPOCH_USER_VAULT_REWARD_POINT_RESPONSE_MAP = void 0;
+const epoch_user_vault_reward_point_1 = require("./epoch_user_vault_reward_point");
+// Schema map for the 'API_LIST_EPOCH_USER_VAULT_REWARD_POINT_RESPONSE' struct.
+exports.API_LIST_EPOCH_USER_VAULT_REWARD_POINT_RESPONSE_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        result: ['r', [epoch_user_vault_reward_point_1.EPOCH_USER_VAULT_REWARD_POINT_MAP.FULL_TO_LITE]]
+    },
+    LITE_TO_FULL: {
+        r: ['result', [epoch_user_vault_reward_point_1.EPOCH_USER_VAULT_REWARD_POINT_MAP.LITE_TO_FULL]]
+    }
+});

package/interfaces/codegen/schema-maps/detailed_aggregated_account_summary.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const DETAILED_AGGREGATED_ACCOUNT_SUMMARY_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/detailed_aggregated_account_summary.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DETAILED_AGGREGATED_ACCOUNT_SUMMARY_MAP = void 0;
+const api_spot_balance_1 = require("./api_spot_balance");
+const vault_investment_1 = require("./vault_investment");
+// Schema map for the 'DETAILED_AGGREGATED_ACCOUNT_SUMMARY' struct.
+exports.DETAILED_AGGREGATED_ACCOUNT_SUMMARY_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        main_account_id: 'ma',
+        total_equity: 'te',
+        spot_balances: ['sb', [api_spot_balance_1.SPOT_BALANCE_MAP.FULL_TO_LITE]],
+        vault_investments: ['vi', [vault_investment_1.VAULT_INVESTMENT_MAP.FULL_TO_LITE]],
+        funding_account_balance: 'fa'
+    },
+    LITE_TO_FULL: {
+        ma: 'main_account_id',
+        te: 'total_equity',
+        sb: ['spot_balances', [api_spot_balance_1.SPOT_BALANCE_MAP.LITE_TO_FULL]],
+        vi: ['vault_investments', [vault_investment_1.VAULT_INVESTMENT_MAP.LITE_TO_FULL]],
+        fa: 'funding_account_balance'
+    }
+});

package/interfaces/codegen/schema-maps/epoch_user_vault_reward_point.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaPairMap } from './types';
+export declare const EPOCH_USER_VAULT_REWARD_POINT_MAP: SchemaPairMap;

package/interfaces/codegen/schema-maps/epoch_user_vault_reward_point.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EPOCH_USER_VAULT_REWARD_POINT_MAP = void 0;
+// Schema map for the 'EPOCH_USER_VAULT_REWARD_POINT' struct.
+exports.EPOCH_USER_VAULT_REWARD_POINT_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        epoch: 'e',
+        ecosystem_point: 'ep',
+        trader_point: 'tp',
+        lp_point: 'lp'
+    },
+    LITE_TO_FULL: {
+        e: 'epoch',
+        ep: 'ecosystem_point',
+        tp: 'trader_point',
+        lp: 'lp_point'
+    }
+});

package/interfaces/codegen/schema-maps/query_vault_investor_history_request.js

@@ -5,10 +5,16 @@ exports.QUERY_VAULT_INVESTOR_HISTORY_REQUEST_MAP = void 0;
 exports.QUERY_VAULT_INVESTOR_HISTORY_REQUEST_MAP = Object.freeze({
     FULL_TO_LITE: {
         main_account_id: 'ma',
-        vault_id: 'vi'
+        vault_id: 'vi',
+        types: 't',
+        start_time: 'st',
+        end_time: 'et'
     },
     LITE_TO_FULL: {
         ma: 'main_account_id',
-        vi: 'vault_id'
+        vi: 'vault_id',
+        t: 'types',
+        st: 'start_time',
+        et: 'end_time'
     }
 });

package/interfaces/codegen/schema-maps/snap_vault_summary.js

@@ -10,7 +10,8 @@ exports.SNAP_VAULT_SUMMARY_MAP = Object.freeze({
         vault_id: 'vi',
         lp_infos: ['li', [lp_info_entry_1.LP_INFO_ENTRY_MAP.FULL_TO_LITE]],
         total_lp_token_supply: 'tl',
-        share_price: 'sp'
+        share_price: 'sp',
+        reward_sharing_ratio_centi_beeps: 'rs'
     },
     LITE_TO_FULL: {
         et: 'event_time',
@@ -18,6 +19,7 @@ exports.SNAP_VAULT_SUMMARY_MAP = Object.freeze({
         vi: 'vault_id',
         li: ['lp_infos', [lp_info_entry_1.LP_INFO_ENTRY_MAP.LITE_TO_FULL]],
         tl: 'total_lp_token_supply',
-        sp: 'share_price'
+        sp: 'share_price',
+        rs: 'reward_sharing_ratio_centi_beeps'
     }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grvt/client",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Node.js & JavaScript client for GRVT REST APIs & WebSockets",
   "repository": {
     "type": "git",

package/ws/ws.d.ts

@@ -27,14 +27,13 @@ export declare class WS {
     private _bindWebSocketListeners;
     /**
      * Only use for TDG
-     * Use for TEntities of GROUP | STATE | DEPOSIT | TRANSFER | WITHDRAWAL streams
+     * Use for TEntities of DEPOSIT | TRANSFER | WITHDRAWAL streams
      */
-    private _getNonInstrumentConsumers;
+    private _getHistoryConsumers;
     /**
      * Use for MDG/TDG
-     * Use for TEntityHasInstrument
      */
-    private _getInstrumentConsumers;
+    private _getSelectorConsumers;
     private _parseStream;
     private _messageLiteToFull;
     private _sendMessage;

package/ws/ws.js

@@ -149,7 +149,7 @@ class WS {
             reconnect();
         });
         currentWs.addEventListener('message', (e) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f;
             // only keep the latest ws
             if (currentWs !== this.__ws) {
                 this._close(currentWs);
@@ -183,12 +183,13 @@ class WS {
                 return;
             }
             const stream = message.s = (_f = (_e = message.s) === null || _e === void 0 ? void 0 : _e.replace) === null || _f === void 0 ? void 0 : _f.call(_e, `${this._version}.`, '');
+            const selector = typeof message.s1 === 'string' ? message.s1 : '';
             const result = this._messageLiteToFull(message);
             // no entity found
-            if (!result) {
+            if (!selector || !result) {
                 // if no entity found and not a subscription message
-                if (!((_g = message.s1) === null || _g === void 0 ? void 0 : _g.length)) {
-                    console.warn('Error: something went wrong with message', message);
+                if (typeof message.s1 === 'string') {
+                    console.warn('Error: not found selector', message);
                 }
                 return;
             }
@@ -196,13 +197,16 @@ class WS {
                 console.warn('Error: cannot parse stream or feed from message', message);
                 return;
             }
-            const instrument = (_k = (_j = (_h = result === null || result === void 0 ? void 0 : result.legs) === null || _h === void 0 ? void 0 : _h[0]) === null || _j === void 0 ? void 0 : _j.instrument) !== null && _k !== void 0 ? _k : result === null || result === void 0 ? void 0 : result.instrument;
-            /**
-             * Handle subscriptions with instrument
-             */
-            const consumers = instrument
-                ? this._getInstrumentConsumers({ stream, instrument, result })
-                : this._getNonInstrumentConsumers({ stream, result });
+            const consumers = (() => {
+                switch (stream) {
+                    case interfaces_1.EStream.DEPOSIT:
+                    case interfaces_1.EStream.TRANSFER:
+                    case interfaces_1.EStream.WITHDRAWAL:
+                        return this._getHistoryConsumers({ stream, result });
+                    default:
+                        return this._getSelectorConsumers({ stream, selector });
+                }
+            })();
             if (!(consumers === null || consumers === void 0 ? void 0 : consumers.length)) {
                 // There are delay in sending unsubscribe message so clients might receive messages after unsubscribing
                 // console.log('TODO: send unsubscribe with by message:', message, result)
@@ -244,9 +248,9 @@ class WS {
     }
     /**
      * Only use for TDG
-     * Use for TEntities of GROUP | STATE | DEPOSIT | TRANSFER | WITHDRAWAL streams
+     * Use for TEntities of DEPOSIT | TRANSFER | WITHDRAWAL streams
      */
-    _getNonInstrumentConsumers({ result, stream }) {
+    _getHistoryConsumers({ result, stream }) {
         return Object.entries(this._pairs).reduce((acc, [key, value]) => {
             if (!key.startsWith(`${stream}__`)) {
                 return acc;
@@ -262,10 +266,6 @@ class WS {
             ].filter(Boolean).join('-');
             const withdrawalFromAccountId = omitZeroStr(result.from_account_id);
             switch (stream) {
-                case interfaces_1.EStream.GROUP:
-                    return [...acc, ...Object.values(value)];
-                case interfaces_1.EStream.STATE:
-                    return [...acc, ...Object.values(value)];
                 case interfaces_1.EStream.DEPOSIT:
                     if (depositDestinationAccountId && key.endsWith(depositDestinationAccountId)) {
                         return [...acc, ...Object.values(value)];
@@ -287,45 +287,18 @@ class WS {
     }
     /**
      * Use for MDG/TDG
-     * Use for TEntityHasInstrument
      */
-    _getInstrumentConsumers({ result, stream, instrument }) {
+    _getSelectorConsumers({ stream, selector }) {
+        const selectorPrimary = selector.split('@')[0];
         return Object.entries(this._pairs).reduce((acc, [key, value]) => {
-            var _a, _b, _c, _d;
-            if (!key.startsWith(`${stream}__`)) {
+            const pairPrefix = `${stream}__${selectorPrimary}`;
+            const isKeyMatch = key.includes('@')
+                ? key.startsWith(pairPrefix)
+                : key === pairPrefix;
+            if (!isKeyMatch) {
                 return acc;
             }
-            const hasSubAccountId = [
-                interfaces_1.EStream.ORDER,
-                // EStream.STATE,
-                interfaces_1.EStream.POSITION,
-                interfaces_1.EStream.FILL
-                // EStream.DEPOSIT,
-                // EStream.TRANSFER,
-                // EStream.WITHDRAWAL
-            ].includes(stream);
-            // no sub account id handling
-            if (!hasSubAccountId) {
-                return key.startsWith(`${stream}__${instrument}`)
-                    ? [...acc, ...Object.values(value)]
-                    : acc;
-            }
-            // has sub account id handling
-            const subAccountId = String((_a = result.sub_account_id) !== null && _a !== void 0 ? _a : '');
-            // const subAccountId = String((result as IPositions).sub_account_id)
-            // const subAccountId = String((result as IFill).sub_account_id)
-            const feed = (_b = this._parseStream({
-                stream: stream,
-                params: {
-                    sub_account_id: omitZeroStr(subAccountId),
-                    instrument
-                }
-            })) === null || _b === void 0 ? void 0 : _b.feed;
-            const tdgFeedPrefix = (_d = (_c = feed === null || feed === void 0 ? void 0 : feed[0]) === null || _c === void 0 ? void 0 : _c.split('@')) === null || _d === void 0 ? void 0 : _d[0];
-            if (tdgFeedPrefix && key.startsWith(`${stream}__${tdgFeedPrefix}`)) {
-                return [...acc, ...Object.values(value)];
-            }
-            return acc;
+            return [...acc, ...Object.values(value)];
         }, []);
     }
     _parseStream(options) {
@@ -707,7 +680,7 @@ class WS {
             const onPaired = (e) => {
                 var _a, _b, _c;
                 const message = utils_1.JsonUtils.parse(e.data);
-                if (!(message === null || message === void 0 ? void 0 : message.s) || !((_a = message === null || message === void 0 ? void 0 : message.s1) === null || _a === void 0 ? void 0 : _a.length)) {
+                if (!(message === null || message === void 0 ? void 0 : message.s) || !((_a = message === null || message === void 0 ? void 0 : message.s1) === null || _a === void 0 ? void 0 : _a.length) || typeof message.s1 === 'string') {
                     return;
                 }
                 const responseStream = (_c = (_b = message.s) === null || _b === void 0 ? void 0 : _b.replace) === null || _c === void 0 ? void 0 : _c.call(_b, `${this._version}.`, '');
@@ -790,7 +763,7 @@ class WS {
                 const onPaired = (e) => {
                     var _a, _b, _c;
                     const message = utils_1.JsonUtils.parse(e.data);
-                    if (!(message === null || message === void 0 ? void 0 : message.s) || !((_a = message === null || message === void 0 ? void 0 : message.s1) === null || _a === void 0 ? void 0 : _a.length)) {
+                    if (!(message === null || message === void 0 ? void 0 : message.s) || !((_a = message === null || message === void 0 ? void 0 : message.s1) === null || _a === void 0 ? void 0 : _a.length) || typeof message.s1 === 'string') {
                         return;
                     }
                     const responseStream = (_c = (_b = message.s) === null || _b === void 0 ? void 0 : _b.replace) === null || _c === void 0 ? void 0 : _c.call(_b, `${this._version}.`, '');