diff --git a/src/inverse-client.ts b/src/inverse-client.ts index a22e327..405c4b1 100644 --- a/src/inverse-client.ts +++ b/src/inverse-client.ts @@ -1,5 +1,5 @@ import { AxiosRequestConfig } from 'axios'; -import { GenericAPIResponse, getBaseRESTInverseUrl, RestClientInverseOptions } from './util/requestUtils'; +import { GenericAPIResponse, getRestBaseUrl, RestClientOptions } from './util/requestUtils'; import RequestWrapper from './util/requestWrapper'; import SharedEndpoints from './shared-endpoints'; @@ -12,23 +12,23 @@ export class InverseClient extends SharedEndpoints { * @param {string} key - your API key * @param {string} secret - your API secret * @param {boolean} [useLivenet=false] - * @param {RestClientInverseOptions} [restInverseOptions={}] options to configure REST API connectivity + * @param {RestClientOptions} [restInverseOptions={}] options to configure REST API connectivity * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios */ constructor( key?: string | undefined, secret?: string | undefined, useLivenet?: boolean, - restInverseOptions: RestClientInverseOptions = {}, - httpOptions: AxiosRequestConfig = {} + restInverseOptions: RestClientOptions = {}, + requestOptions: AxiosRequestConfig = {} ) { super() this.requestWrapper = new RequestWrapper( key, secret, - getBaseRESTInverseUrl(useLivenet), + getRestBaseUrl(useLivenet), restInverseOptions, - httpOptions + requestOptions ); return this; } @@ -47,7 +47,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/public/kline/list', params); } - + /** * @deprecated use getTickers() instead */ @@ -56,7 +56,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.getTickers(params); } - + /** * @deprecated use getTrades() instead */ @@ -75,7 +75,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/public/trading-records', params); } - + /** * @deprecated use getLiquidations() instead */ @@ -97,7 +97,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/public/mark-price-kline', params); } - + getIndexPriceKline(params: { symbol: string; interval: string; @@ -106,7 +106,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/public/index-price-kline', params); } - + getPremiumIndexKline(params: { symbol: string; interval: string; @@ -121,7 +121,7 @@ export class InverseClient extends SharedEndpoints { * Account Data Endpoints * */ - + /** * Active orders */ @@ -183,7 +183,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/private/order', params); } - + /** * Conditional orders */ @@ -246,7 +246,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/private/stop-order', params); } - + /** * Position */ @@ -328,7 +328,7 @@ export class InverseClient extends SharedEndpoints { /** * Risk Limit */ - + getRiskLimitList(): GenericAPIResponse { return this.requestWrapper.get('open-api/wallet/risk-limit/list'); } @@ -339,7 +339,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.post('open-api/wallet/risk-limit', params); } - + /** * Funding */ @@ -361,7 +361,7 @@ export class InverseClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('v2/private/funding/predicted-funding', params); } - + /** * LCP Info */ diff --git a/src/linear-client.ts b/src/linear-client.ts index e62f9e0..4ef2566 100644 --- a/src/linear-client.ts +++ b/src/linear-client.ts @@ -1,5 +1,5 @@ import { AxiosRequestConfig } from 'axios'; -import { GenericAPIResponse, getBaseRESTInverseUrl, RestClientInverseOptions } from './util/requestUtils'; +import { GenericAPIResponse, getRestBaseUrl, RestClientOptions } from './util/requestUtils'; import RequestWrapper from './util/requestWrapper'; import SharedEndpoints from './shared-endpoints'; @@ -11,23 +11,22 @@ export class LinearClient extends SharedEndpoints { * * @param {string} key - your API key * @param {string} secret - your API secret - * @param {boolean} [livenet=false] - * @param {RestClientInverseOptions} [restInverseOptions={}] options to configure REST API connectivity + * @param {boolean} [useLivenet=false] + * @param {RestClientOptions} [restInverseOptions={}] options to configure REST API connectivity * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios */ - constructor( key?: string | undefined, secret?: string | undefined, - livenet?: boolean, - restInverseOptions:RestClientInverseOptions = {}, // TODO: Rename this type to be more general. + useLivenet?: boolean, + restInverseOptions: RestClientOptions = {}, requestOptions: AxiosRequestConfig = {} ) { super() this.requestWrapper = new RequestWrapper( key, secret, - getBaseRESTInverseUrl(livenet), + getRestBaseUrl(useLivenet), restInverseOptions, requestOptions ); @@ -46,7 +45,7 @@ export class LinearClient extends SharedEndpoints { from: number; limit?: number; }): GenericAPIResponse { - return this.requestWrapper.get('/public/linear/kline', params); + return this.requestWrapper.get('public/linear/kline', params); } /** @@ -82,7 +81,7 @@ export class LinearClient extends SharedEndpoints { }): GenericAPIResponse { return this.requestWrapper.get('public/linear/mark-price-kline', params); } - + getIndexPriceKline(params: { symbol: string; interval: string; diff --git a/src/util/requestUtils.ts b/src/util/requestUtils.ts index f75f106..903a7a2 100644 --- a/src/util/requestUtils.ts +++ b/src/util/requestUtils.ts @@ -1,6 +1,6 @@ import { createHmac } from 'crypto'; -export interface RestClientInverseOptions { +export interface RestClientOptions { // override the max size of the request window (in ms) recv_window?: number; @@ -42,7 +42,7 @@ export function serializeParams(params: object = {}, strict_validation = false): .join('&'); }; -export function getBaseRESTInverseUrl(useLivenet?: boolean, restInverseOptions?: RestClientInverseOptions) { +export function getRestBaseUrl(useLivenet?: boolean, restInverseOptions?: RestClientOptions) { const baseUrlsInverse = { livenet: 'https://api.bybit.com', testnet: 'https://api-testnet.bybit.com' diff --git a/src/util/requestWrapper.ts b/src/util/requestWrapper.ts index 7645061..e19f8f3 100644 --- a/src/util/requestWrapper.ts +++ b/src/util/requestWrapper.ts @@ -1,11 +1,11 @@ import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios'; -import { signMessage, serializeParams, RestClientInverseOptions, GenericAPIResponse, isPublicEndpoint } from './requestUtils'; +import { signMessage, serializeParams, RestClientOptions, GenericAPIResponse, isPublicEndpoint } from './requestUtils'; export default class RequestUtil { private timeOffset: number | null; private syncTimePromise: null | Promise; - private options: RestClientInverseOptions; + private options: RestClientOptions; private baseUrl: string; private globalRequestOptions: AxiosRequestConfig; private key: string | undefined; @@ -15,7 +15,7 @@ export default class RequestUtil { key: string | undefined, secret: string | undefined, baseUrl: string, - options: RestClientInverseOptions = {}, + options: RestClientOptions = {}, requestOptions: AxiosRequestConfig = {} ) { this.timeOffset = null;