@grvt/client 1.4.1 → 1.4.3

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 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 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 IApiQueryTradingPerformanceRequest, type IApiQueryTradingPerformanceResponse, type IApiQueryTradingPerformanceTrendRequest, type IApiQueryTradingPerformanceTrendResponse, type IApiSetInitialLeverageRequest, type IApiSetInitialLeverageResponse, type IApiSocializedLossStatusResponse, type IApiSubAccountHistoryRequest, type IApiSubAccountHistoryResponse, type IApiSubAccountSummaryRequest, type IApiSubAccountSummaryResponse, type IApiTimedAssetExposureRequest, type IApiTimedAssetExposureResponse, type IApiTransferHistoryRequest, type IApiTransferHistoryResponse, type IApiTransferRequest, type IApiWithdrawalHistoryRequest, type IApiWithdrawalHistoryResponse, type IApiWithdrawalRequest, type IConfig } from '../interfaces';
+import { 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 IApiQueryTradingPerformanceRequest, type IApiQueryTradingPerformanceResponse, type IApiQueryTradingPerformanceTrendRequest, type IApiQueryTradingPerformanceTrendResponse, type IApiSetInitialLeverageRequest, type IApiSetInitialLeverageResponse, type IApiSocializedLossStatusResponse, type IApiSubAccountHistoryRequest, type IApiSubAccountHistoryResponse, type IApiSubAccountSummaryRequest, type IApiSubAccountSummaryResponse, type IApiTimedAssetExposureRequest, type IApiTimedAssetExposureResponse, type IApiTransferHistoryRequest, type IApiTransferHistoryResponse, type IApiTransferRequest, type IApiTransferResponse, type IApiWithdrawalHistoryRequest, type IApiWithdrawalHistoryResponse, type IApiWithdrawalRequest, type IConfig } from '../interfaces';
 export declare class TDG {
     private readonly _axios;
     private readonly _fullUrl;
@@ -19,9 +19,7 @@ export declare class TDG {
      * TODO: missing response interface
      * @see https://api-docs.grvt.io/trading_api/#transfer
      */
-    transfer(payload: IApiTransferRequest, config?: AxiosRequestConfig): Promise<{
-        acknowledgement: boolean;
-    }>;
+    transfer(payload: IApiTransferRequest, config?: AxiosRequestConfig): Promise<IApiTransferResponse>;
     /**
      * @see https://api-docs.grvt.io/trading_api/#transfer-history
      */

package/TDG/index.js

@@ -37,7 +37,7 @@ class TDG {
      */
     transfer(payload, config) {
         return this._axios.post(this._liteUrl + '/transfer', utils_1.Utils.schemaMap(payload, interfaces_1.API_TRANSFER_REQUEST_MAP.FULL_TO_LITE, true), config).then((response) => {
-            return utils_1.Utils.schemaMap(response.data, interfaces_1.ACK_RESPONSE_MAP.LITE_TO_FULL);
+            return utils_1.Utils.schemaMap(response.data, interfaces_1.API_TRANSFER_RESPONSE_MAP.LITE_TO_FULL);
         }).catch(utils_1.Utils.coverApiError);
     }
     /**

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

@@ -1,5 +1,6 @@
 export declare enum EBridgeType {
-    XY = "XY"
+    XY = "XY",
+    RHINO = "RHINO"
 }
 export declare enum EBrokerTag {
     UNSPECIFIED = "UNSPECIFIED",
@@ -181,7 +182,9 @@ export declare enum ETimeInterval {
 export declare enum ETransferType {
     STANDARD = "STANDARD",
     FAST_ARB_DEPOSIT = "FAST_ARB_DEPOSIT",
-    FAST_ARB_WITHDRAWAL = "FAST_ARB_WITHDRAWAL"
+    FAST_ARB_WITHDRAWAL = "FAST_ARB_WITHDRAWAL",
+    NON_NATIVE_BRIDGE_DEPOSIT = "NON_NATIVE_BRIDGE_DEPOSIT",
+    NON_NATIVE_BRIDGE_WITHDRAWAL = "NON_NATIVE_BRIDGE_WITHDRAWAL"
 }
 export declare enum ETriggerBy {
     UNSPECIFIED = "UNSPECIFIED",
@@ -723,6 +726,10 @@ export interface IApiTradingPerformanceTrend {
     trading_volume?: string;
     realized_pnl?: string;
 }
+export interface IApiTransferAck {
+    ack?: boolean;
+    tx_id?: string;
+}
 export interface IApiTransferHistoryRequest {
     currency?: ECurrency[];
     start_time?: string;
@@ -747,6 +754,9 @@ export interface IApiTransferRequest {
     transfer_type?: ETransferType;
     transfer_metadata?: string;
 }
+export interface IApiTransferResponse {
+    result?: IApiTransferAck;
+}
 export interface IApiUserCategoryAffinityScoreRequest {
     account_id?: string;
     start_time?: string;

package/interfaces/codegen/data.interface.js

@@ -5,6 +5,8 @@ var EBridgeType;
 (function (EBridgeType) {
     // XY Bridge type
     EBridgeType["XY"] = "XY";
+    // Rhino Bridge type
+    EBridgeType["RHINO"] = "RHINO";
 })(EBridgeType || (exports.EBridgeType = EBridgeType = {}));
 // BrokerTag is a tag for the broker that the order is sent from.
 var EBrokerTag;
@@ -357,6 +359,10 @@ var ETransferType;
     ETransferType["FAST_ARB_DEPOSIT"] = "FAST_ARB_DEPOSIT";
     // Fast Arb Withdrawal Metadata type
     ETransferType["FAST_ARB_WITHDRAWAL"] = "FAST_ARB_WITHDRAWAL";
+    // Transfer type for non native bridging deposit
+    ETransferType["NON_NATIVE_BRIDGE_DEPOSIT"] = "NON_NATIVE_BRIDGE_DEPOSIT";
+    // Transfer type for non native bridging withdrawal
+    ETransferType["NON_NATIVE_BRIDGE_WITHDRAWAL"] = "NON_NATIVE_BRIDGE_WITHDRAWAL";
 })(ETransferType || (exports.ETransferType = ETransferType = {}));
 // Defines the price type that activates a Take Profit (TP) or Stop Loss (SL) order.
 //

package/interfaces/codegen/enum-int.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EVenueInt = exports.EVaultTypeInt = exports.ETriggerTypeInt = exports.ETriggerByInt = exports.ETransferTypeInt = exports.ETimeIntervalInt = exports.ETimeInForceInt = exports.ESubAccountTradeIntervalInt = exports.ERewardProgramTypeInt = exports.ERewardEpochStatusInt = exports.EOrderStatusInt = exports.EOrderRejectReasonInt = exports.EMarginTypeInt = exports.EKindInt = exports.EInstrumentSettlementPeriodInt = exports.EEpochBadgeTypeInt = exports.ECurrencyInt = exports.ECandlestickTypeInt = exports.ECandlestickIntervalInt = exports.ECancelStatusInt = exports.EBrokerTagInt = exports.EBridgeTypeInt = void 0;
 const data_interface_1 = require("./data.interface");
 exports.EBridgeTypeInt = Object.freeze({
-    [data_interface_1.EBridgeType.XY]: 1
+    [data_interface_1.EBridgeType.XY]: 1,
+    [data_interface_1.EBridgeType.RHINO]: 2
 });
 exports.EBrokerTagInt = Object.freeze({
     [data_interface_1.EBrokerTag.UNSPECIFIED]: 0,
@@ -185,7 +186,9 @@ exports.ETimeIntervalInt = Object.freeze({
 exports.ETransferTypeInt = Object.freeze({
     [data_interface_1.ETransferType.STANDARD]: 1,
     [data_interface_1.ETransferType.FAST_ARB_DEPOSIT]: 2,
-    [data_interface_1.ETransferType.FAST_ARB_WITHDRAWAL]: 3
+    [data_interface_1.ETransferType.FAST_ARB_WITHDRAWAL]: 3,
+    [data_interface_1.ETransferType.NON_NATIVE_BRIDGE_DEPOSIT]: 4,
+    [data_interface_1.ETransferType.NON_NATIVE_BRIDGE_WITHDRAWAL]: 5
 });
 exports.ETriggerByInt = Object.freeze({
     [data_interface_1.ETriggerBy.UNSPECIFIED]: 0,

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

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

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_TRANSFER_ACK_MAP = void 0;
+// Schema map for the 'API_TRANSFER_ACK' struct.
+exports.API_TRANSFER_ACK_MAP = Object.freeze({
+    FULL_TO_LITE: {
+        ack: 'a',
+        tx_id: 'ti'
+    },
+    LITE_TO_FULL: {
+        a: 'ack',
+        ti: 'tx_id'
+    }
+});

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

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

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

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

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

@@ -120,9 +120,11 @@ export * from './api_trade_history_response';
 export * from './api_trade_request';
 export * from './api_trade_response';
 export * from './api_trading_performance_trend';
+export * from './api_transfer_ack';
 export * from './api_transfer_history_request';
 export * from './api_transfer_history_response';
 export * from './api_transfer_request';
+export * from './api_transfer_response';
 export * from './api_user_category_affinity_score_request';
 export * from './api_user_category_affinity_score_response';
 export * from './api_withdrawal_history_request';

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

@@ -136,9 +136,11 @@ __exportStar(require("./api_trade_history_response"), exports);
 __exportStar(require("./api_trade_request"), exports);
 __exportStar(require("./api_trade_response"), exports);
 __exportStar(require("./api_trading_performance_trend"), exports);
+__exportStar(require("./api_transfer_ack"), exports);
 __exportStar(require("./api_transfer_history_request"), exports);
 __exportStar(require("./api_transfer_history_response"), exports);
 __exportStar(require("./api_transfer_request"), exports);
+__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_withdrawal_history_request"), exports);

package/package.json

@@ -1,50 +1,50 @@
-{
-  "name": "@grvt/client",
-  "version": "1.4.1",
-  "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": "dist/index.js",
-  "types": "dist/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.3",
+  "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": "dist/index.js",
+  "types": "dist/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"
+  }
+}