@grvt/client 1.4.15 → 1.4.16

package/README.md

@@ -1,62 +1,62 @@
-# GRVT
-
-Node.js & JavaScript client for GRVT REST APIs & WebSockets
-
-## Installing
-
-Using npm:
-
-```bash
-npm install @grvt/client
-```
-
-Using yarn:
-
-```bash
-yarn add @grvt/client
-```
-
-Using pnpm:
-
-```bash
-pnpm add @grvt/client
-```
-
-Once the package is installed, you can import the library using `import` or `require` approach:
-
-```js
-import GRVT from '@grvt/client'
-```
-
-You can also use the default export, since the named export is just a re-export from the GRVT factory:
-
-```js
-import GRVT from '@grvt/client'
-console.log(
-  new GRVT.MDG({
-    host: 'https://market-data.dev.gravitymarkets.io',
-    version: 'v1'
-  })
-)
-```
-
-If you use `require` for importing:
-
-```js
-const GRVT =  require('@grvt/client')
-console.log(
-  new GRVT.MDG({
-    host: 'https://market-data.dev.gravitymarkets.io',
-    version: 'v1'
-  })
-)
-```
-
-## To use WebSocket (available only in browsers/platforms that support WebSocket)
-
-[Browsers supported](https://caniuse.com/websockets)
-
-```js
-import { EStreamEndpoints, WS } from '@grvt/client/ws'
-console.log(new WS('wss://market-data.dev.gravitymarkets.io/ws'))
-```
+# GRVT
+
+Node.js & JavaScript client for GRVT REST APIs & WebSockets
+
+## Installing
+
+Using npm:
+
+```bash
+npm install @grvt/client
+```
+
+Using yarn:
+
+```bash
+yarn add @grvt/client
+```
+
+Using pnpm:
+
+```bash
+pnpm add @grvt/client
+```
+
+Once the package is installed, you can import the library using `import` or `require` approach:
+
+```js
+import GRVT from '@grvt/client'
+```
+
+You can also use the default export, since the named export is just a re-export from the GRVT factory:
+
+```js
+import GRVT from '@grvt/client'
+console.log(
+  new GRVT.MDG({
+    host: 'https://market-data.dev.gravitymarkets.io',
+    version: 'v1'
+  })
+)
+```
+
+If you use `require` for importing:
+
+```js
+const GRVT =  require('@grvt/client')
+console.log(
+  new GRVT.MDG({
+    host: 'https://market-data.dev.gravitymarkets.io',
+    version: 'v1'
+  })
+)
+```
+
+## To use WebSocket (available only in browsers/platforms that support WebSocket)
+
+[Browsers supported](https://caniuse.com/websockets)
+
+```js
+import { EStreamEndpoints, WS } from '@grvt/client/ws'
+console.log(new WS('wss://market-data.dev.gravitymarkets.io/ws'))
+```

package/TDG/index.d.ts

@@ -1,5 +1,5 @@
 import { type AxiosRequestConfig } from 'axios';
-import { type IAckResponse, type IApiAggregatedAccountSummaryResponse, type IApiCancelAllOrdersRequest, type IApiCancelAllOrdersResponse, type IApiCancelOrderRequest, type IApiCancelOrderResponse, type IApiCreateBulkOrdersRequest, type IApiCreateBulkOrdersResponse, type IApiCreateOrderRequest, type IApiCreateOrderResponse, type IApiDedustPositionRequest, type IApiDedustPositionResponse, type IApiDepositHistoryRequest, type IApiDepositHistoryResponse, type IApiFillHistoryRequest, type IApiFillHistoryResponse, type IApiFundingAccountSummaryResponse, type IApiFundingPaymentHistoryRequest, type IApiFundingPaymentHistoryResponse, type IApiGetAllInitialLeverageRequest, type IApiGetAllInitialLeverageResponse, type IApiGetMarginTiersResponse, type IApiGetOrderGroupRequest, type IApiGetOrderGroupResponse, type IApiGetOrderRequest, type IApiGetOrderResponse, type IApiOpenOrdersRequest, type IApiOpenOrdersResponse, type IApiOrderHistoryRequest, type IApiOrderHistoryResponse, type IApiPositionsRequest, type IApiPositionsResponse, type IApiPreDepositCheckRequest, type IApiPreDepositCheckResponse, type IApiPreOrderCheckRequest, type IApiPreOrderCheckResponse, type IApiQueryListFundingAccountSummaryRequest, type IApiQueryListFundingAccountSummaryResponse, type IApiQueryListSubAccountSummaryRequest, type IApiQueryListSubAccountSummaryResponse, type IApiQuerySnapVaultPositionRequest, type IApiQuerySnapVaultPositionResponse, type IApiQueryTradingPerformanceRequest, type IApiQueryTradingPerformanceResponse, type IApiQueryTradingPerformanceTrendRequest, type IApiQueryTradingPerformanceTrendResponse, type IApiQueryVaultPerformanceRequest, type IApiQueryVaultPerformanceResponse, type IApiQueryVaultPerformanceTrendRequest, type IApiQueryVaultPerformanceTrendResponse, type IApiQueryVaultRiskMetricRequest, type IApiQueryVaultRiskMetricResponse, type IApiQueryVaultSummaryHistoryRequest, type IApiQueryVaultSummaryHistoryResponse, type IApiReplaceOrdersRequest, type IApiReplaceOrdersResponse, type IApiSetInitialLeverageRequest, type IApiSetInitialLeverageResponse, type IApiSocializedLossStatusResponse, type IApiSubAccountHistoryRequest, type IApiSubAccountHistoryResponse, type IApiSubAccountSummaryRequest, type IApiSubAccountSummaryResponse, type IApiTimedAssetExposureRequest, type IApiTimedAssetExposureResponse, type IApiTimedVaultAssetExposureRequest, type IApiTransferHistoryRequest, type IApiTransferHistoryResponse, type IApiTransferRequest, type IApiTransferResponse, type IApiVaultBurnTokensRequest, type IApiVaultInvestorSummaryRequest, type IApiVaultInvestorSummaryResponse, type IApiVaultInvestRequest, type IApiVaultRedeemCancelRequest, type IApiVaultRedeemRequest, type IApiVaultViewRedemptionQueueRequest, type IApiVaultViewRedemptionQueueResponse, type IApiWithdrawalHistoryRequest, type IApiWithdrawalHistoryResponse, type IApiWithdrawalRequest, type IConfig } from '../interfaces';
+import { type IAckResponse, type IApiAggregatedAccountSummaryResponse, type IApiCancelAllOrdersRequest, type IApiCancelAllOrdersResponse, type IApiCancelOrderRequest, type IApiCancelOrderResponse, type IApiCreateBulkOrdersRequest, type IApiCreateBulkOrdersResponse, type IApiCreateOrderRequest, type IApiCreateOrderResponse, type IApiDedustPositionRequest, type IApiDedustPositionResponse, type IApiDepositHistoryRequest, type IApiDepositHistoryResponse, type IApiFillHistoryRequest, type IApiFillHistoryResponse, type IApiFundingAccountSummaryResponse, type IApiFundingPaymentHistoryRequest, type IApiFundingPaymentHistoryResponse, type IApiGetAllInitialLeverageRequest, type IApiGetAllInitialLeverageResponse, type IApiGetMarginTiersResponse, type IApiGetOrderGroupRequest, type IApiGetOrderGroupResponse, type IApiGetOrderRequest, type IApiGetOrderResponse, type IApiOpenOrdersRequest, type IApiOpenOrdersResponse, type IApiOrderHistoryRequest, type IApiOrderHistoryResponse, type IApiPositionsRequest, type IApiPositionsResponse, type IApiPreDepositCheckRequest, type IApiPreDepositCheckResponse, type IApiPreOrderCheckRequest, type IApiPreOrderCheckResponse, type IApiQueryListFundingAccountSummaryRequest, type IApiQueryListFundingAccountSummaryResponse, type IApiQueryListSubAccountSummaryRequest, type IApiQueryListSubAccountSummaryResponse, type IApiQuerySnapVaultPositionRequest, type IApiQuerySnapVaultPositionResponse, type IApiQueryTradingPerformanceRequest, type IApiQueryTradingPerformanceResponse, type IApiQueryTradingPerformanceTrendRequest, type IApiQueryTradingPerformanceTrendResponse, type IApiQueryVaultPerformanceRequest, type IApiQueryVaultPerformanceResponse, type IApiQueryVaultPerformanceTrendRequest, type IApiQueryVaultPerformanceTrendResponse, type IApiQueryVaultRiskMetricRequest, type IApiQueryVaultRiskMetricResponse, type IApiQueryVaultSummaryHistoryRequest, type IApiQueryVaultSummaryHistoryResponse, type IApiReplaceOrdersRequest, type IApiReplaceOrdersResponse, type IApiSetInitialLeverageRequest, type IApiSetInitialLeverageResponse, type IApiSocializedLossStatusResponse, type IApiSubAccountHistoryRequest, type IApiSubAccountHistoryResponse, type IApiSubAccountSummaryRequest, type IApiSubAccountSummaryResponse, type IApiTimedAssetExposureRequest, type IApiTimedAssetExposureResponse, type IApiTimedVaultAssetExposureRequest, type IApiTransferHistoryRequest, type IApiTransferHistoryResponse, type IApiTransferRequest, type IApiTransferResponse, type IApiVaultBurnTokensRequest, type IApiVaultDetailRequest, type IApiVaultDetailResponse, type IApiVaultInvestorSummaryRequest, type IApiVaultInvestorSummaryResponse, type IApiVaultInvestRequest, type IApiVaultRedeemCancelRequest, type IApiVaultRedeemRequest, type IApiVaultViewRedemptionQueueRequest, type IApiVaultViewRedemptionQueueResponse, type IApiWithdrawalHistoryRequest, type IApiWithdrawalHistoryResponse, type IApiWithdrawalRequest, type IConfig } from '../interfaces';
 export declare class TDG {
     private readonly _axios;
     private readonly _fullUrl;
@@ -125,4 +125,5 @@ export declare class TDG {
     vaultSummaryHistory(payload: IApiQueryVaultSummaryHistoryRequest, config?: AxiosRequestConfig): Promise<IApiQueryVaultSummaryHistoryResponse>;
     vaultAssetExposure(payload: IApiTimedVaultAssetExposureRequest, config?: AxiosRequestConfig): Promise<IApiTimedAssetExposureResponse>;
     snapVaultPosition(payload: IApiQuerySnapVaultPositionRequest, config?: AxiosRequestConfig): Promise<IApiQuerySnapVaultPositionResponse>;
+    vaultDetail(payload: IApiVaultDetailRequest, config?: AxiosRequestConfig): Promise<IApiVaultDetailResponse>;
 }

package/TDG/index.js

@@ -311,5 +311,10 @@ class TDG {
             return utils_1.Utils.schemaMap(response.data, interfaces_1.API_QUERY_SNAP_VAULT_POSITION_RESPONSE_MAP.LITE_TO_FULL);
         }).catch(utils_1.Utils.coverApiError);
     }
+    vaultDetail(payload, config) {
+        return this._axios.post(this._liteUrl + '/vault_detail', utils_1.Utils.schemaMap(payload, interfaces_1.API_VAULT_DETAIL_REQUEST_MAP.FULL_TO_LITE, true), config).then((response) => {
+            return utils_1.Utils.schemaMap(response.data, interfaces_1.API_VAULT_DETAIL_RESPONSE_MAP.LITE_TO_FULL);
+        }).catch(utils_1.Utils.coverApiError);
+    }
 }
 exports.TDG = TDG;

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

@@ -848,6 +848,14 @@ export interface IApiVaultBurnTokensRequest {
     num_tokens?: string;
     signature?: ISignature;
 }
+export interface IApiVaultDetailRequest {
+    vault_id?: string;
+}
+export interface IApiVaultDetailResponse {
+    share_price?: string;
+    total_equity?: string;
+    valuation_cap?: string;
+}
 export interface IApiVaultInvestRequest {
     main_account_id?: string;
     vault_id?: string;
@@ -1592,11 +1600,14 @@ export interface IVaultRedeemResults {
 export interface IVaultRedemption {
     num_lp_tokens?: string;
     request_valuation?: string;
+    request_time?: string;
+    max_redemption_period_timestamp?: string;
 }
 export interface IVaultRedemptionReqView {
     request_time?: string;
     currency?: ECurrency;
     num_lp_tokens?: string;
+    max_redemption_period_timestamp?: string;
 }
 export interface IWSCancelFeedDataV1 {
     stream?: string;

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

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

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_VAULT_DETAIL_REQUEST_MAP = void 0;
+// Schema map for the 'API_VAULT_DETAIL_REQUEST' struct.
+exports.API_VAULT_DETAIL_REQUEST_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        vault_id: 'vi'
+    },
+    LITE_TO_FULL: {
+        vi: 'vault_id'
+    }
+});

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

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

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_VAULT_DETAIL_RESPONSE_MAP = void 0;
+// Schema map for the 'API_VAULT_DETAIL_RESPONSE' struct.
+exports.API_VAULT_DETAIL_RESPONSE_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        share_price: 'sp',
+        total_equity: 'te',
+        valuation_cap: 'vc'
+    },
+    LITE_TO_FULL: {
+        sp: 'share_price',
+        te: 'total_equity',
+        vc: 'valuation_cap'
+    }
+});

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

@@ -143,6 +143,8 @@ export * from './api_transfer_response';
 export * from './api_user_category_affinity_score_request';
 export * from './api_user_category_affinity_score_response';
 export * from './api_vault_burn_tokens_request';
+export * from './api_vault_detail_request';
+export * from './api_vault_detail_response';
 export * from './api_vault_invest_request';
 export * from './api_vault_investor_summary_request';
 export * from './api_vault_investor_summary_response';

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

@@ -159,6 +159,8 @@ __exportStar(require("./api_transfer_response"), exports);
 __exportStar(require("./api_user_category_affinity_score_request"), exports);
 __exportStar(require("./api_user_category_affinity_score_response"), exports);
 __exportStar(require("./api_vault_burn_tokens_request"), exports);
+__exportStar(require("./api_vault_detail_request"), exports);
+__exportStar(require("./api_vault_detail_response"), exports);
 __exportStar(require("./api_vault_invest_request"), exports);
 __exportStar(require("./api_vault_investor_summary_request"), exports);
 __exportStar(require("./api_vault_investor_summary_response"), exports);

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

@@ -5,10 +5,14 @@ exports.VAULT_REDEMPTION_MAP = void 0;
 exports.VAULT_REDEMPTION_MAP = Object.freeze({
     FULL_TO_LITE: {
         num_lp_tokens: 'nl',
-        request_valuation: 'rv'
+        request_valuation: 'rv',
+        request_time: 'rt',
+        max_redemption_period_timestamp: 'mr'
     },
     LITE_TO_FULL: {
         nl: 'num_lp_tokens',
-        rv: 'request_valuation'
+        rv: 'request_valuation',
+        rt: 'request_time',
+        mr: 'max_redemption_period_timestamp'
     }
 });

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

@@ -6,11 +6,13 @@ exports.VAULT_REDEMPTION_REQ_VIEW_MAP = Object.freeze({
     FULL_TO_LITE: {
         request_time: 'rt',
         currency: 'c',
-        num_lp_tokens: 'nl'
+        num_lp_tokens: 'nl',
+        max_redemption_period_timestamp: 'mr'
     },
     LITE_TO_FULL: {
         rt: 'request_time',
         c: 'currency',
-        nl: 'num_lp_tokens'
+        nl: 'num_lp_tokens',
+        mr: 'max_redemption_period_timestamp'
     }
 });

package/package.json

@@ -1,50 +1,50 @@
-{
-  "name": "@grvt/client",
-  "version": "1.4.15",
-  "description": "Node.js & JavaScript client for GRVT REST APIs & WebSockets",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/gravity-technologies/grvt-js-client.git"
-  },
-  "keywords": [
-    "GRVT"
-  ],
-  "bugs": {
-    "url": "https://github.com/gravity-technologies/grvt-js-client/issues"
-  },
-  "homepage": "https://github.com/gravity-technologies/grvt-js-client#readme",
-  "author": "danh@grvt.io",
-  "license": "UNLICENSED",
-  "engines": {
-    "node": ">=20"
-  },
-  "main": "index.js",
-  "types": "index.d.ts",
-  "scripts": {
-    "start": "tsc --watch",
-    "prebuild": "rimraf dist",
-    "build": "tsc",
-    "postbuild": "cp package.json dist/ && cp README.md dist/ && cp LICENSE dist/",
-    "prerelease": "npm run build",
-    "release": "cd dist/ && npm publish --access public",
-    "link-local": "cp package.json dist/ && cd dist/ && npm link && cd ..",
-    "lint": "npx eslint \"src/**/*.{js,ts}\"",
-    "lint-fix": "npx eslint \"src/**/*.{js,ts}\" --fix",
-    "test": "nodemon dist/index.js"
-  },
-  "dependencies": {
-    "axios": "^1.8.2"
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "eslint": "^8.56.0",
-    "eslint-config-standard-with-typescript": "^39.1.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-import-newlines": "^1.3.4",
-    "eslint-plugin-n": "^16.3.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "nodemon": "^3.0.2",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.2.2"
-  }
-}
+{
+  "name": "@grvt/client",
+  "version": "1.4.16",
+  "description": "Node.js & JavaScript client for GRVT REST APIs & WebSockets",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gravity-technologies/grvt-js-client.git"
+  },
+  "keywords": [
+    "GRVT"
+  ],
+  "bugs": {
+    "url": "https://github.com/gravity-technologies/grvt-js-client/issues"
+  },
+  "homepage": "https://github.com/gravity-technologies/grvt-js-client#readme",
+  "author": "danh@grvt.io",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=20"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "start": "tsc --watch",
+    "prebuild": "rimraf dist",
+    "build": "tsc",
+    "postbuild": "cp package.json dist/ && cp README.md dist/ && cp LICENSE dist/",
+    "prerelease": "npm run build",
+    "release": "cd dist/ && npm publish --access public",
+    "link-local": "cp package.json dist/ && cd dist/ && npm link && cd ..",
+    "lint": "npx eslint \"src/**/*.{js,ts}\"",
+    "lint-fix": "npx eslint \"src/**/*.{js,ts}\" --fix",
+    "test": "nodemon dist/index.js"
+  },
+  "dependencies": {
+    "axios": "^1.8.2"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "eslint": "^8.56.0",
+    "eslint-config-standard-with-typescript": "^39.1.1",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-import-newlines": "^1.3.4",
+    "eslint-plugin-n": "^16.3.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "nodemon": "^3.0.2",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.2.2"
+  }
+}