Support for Linear (USDT) on the updated typescript version.

[peepo5]

Changelog

Summary

• Introducing All Linear Endpoints (USDT Pairs) to the project for both rest clients and websocket client. Initiated through a seperate client (LinearClient) and stored in linear-client.ts. Most endpoints are the same as inverse, however some have different paramaters & results and some are linear specific endpoints.
  • Market Data Endpoints Added.
  • Account Data Endpoints Added.
  • Other Endpoints are contained within shared-endpoints.ts
• Introduce Shared Endpoints that are used by both Linear and Inverse Client (Through extend to sharedendpoints.ts).
• Transferred shared endpoints from inverse-client.ts to shared-endpoints.ts
• Other Misc Changes (e.g Commenting, small functions).
• Websocket Clients for Linear and shared endpoints added. Not a breaking change. Parameter "linear" can passed into websocket client if you want to use linear, however it defaults to inverse client.
• Refactored websocket state into flexible wsStore. All websocket-specific state is now stored here.
• Existing inverse websocket functionality is unchanged.

Breaking Changes

• RestClient renamed to InverseClient. Only import needs rename as existing functionality is unchanged.
  • rest-client.ts renamed to inverse-client.ts
• Depreciations of old endpoints
  • A number of endpoints were marked deprecated by bybit with a deadline for December 2020.
  • These have now been removed.
• Websocket connection on init
  • Previous behaviour: websocket is automatically connected when websocket-client() instance is made.
  • New behaviour: websocket is automatically connected when a topic is subscribed to.
  • If the previous behaviour is necessary, earlier connections can be forced using the websocketClient.connectAll() method.

Deprecations

These are a consequence of module improvements (mainly open-api calls, to v2):

• getActiveOrder() deprecated. Use getActiveOrderList() instead.
  • Same params & response.
• replaceActiveOrderOld() deprecated. Use replaceActiveOrder() instead.
  • Same params & response.
• placeConditionalOrderOld() deprecated. Use placeConditionalOrder() instead.
  • Same params & response.
• getConditionalOrderOld() deprecated. Use getConditionalOrder() instead.
  • Same params & response.
• cancelConditionalOrderOld() deprecated. Use cancelConditionalOrder() instead.
  • Same params & response.
• replaceConditionalOrderOld() deprecated. Use replaceConditionalOrder() instead.
  • Same params & response.
• replaceConditionalOrderOld() deprecated. Use replaceConditionalOrder() instead.
  • Same params & response.

Endpoint Updates

• setTradingStop() updated from open-api to v2.
• getLastFundingRate() updated from open-api to v2.
• getMyLastFundingFee() updated from open-api to v2.
• getPredictedFunding() updated from open-api to v2.
• getApiKeyInfo() updated from open-api to v2.

Testing locally

// go to anywhere you want to save a copy of the repo locally, ideally outside your current project, and clone it
git clone git@github.com:peepopoggers/bybit-api.git

// build it
cd bybit-api
npm install
npm run tsc

// link it
npm link

// cd into your project
cd pathtoyourproject

// link it to your local bybit module
npm link bybit-api

TODO list

The following should work as before, except for any breaking changes documented above:

• Inverse REST API, implementation, function names and params.
• Inverse REST working as expected in testnet.
• Inverse REST working as expected in mainnet.
• Inverse WebSockets, implementation and usage.
• Inverse WebSockets working as expected in testnet.
• Inverse WebSockets working as expected in mainnet.

The following should be fully functional:

• Linear REST API. Implementation should be similar to Inverse, except for minimal params.
• Linear REST working as expected in testnet.
• Linear REST working as expected in mainnet.
• Inverse WebSockets, Implementation should be similar to Inverse, except for minimal params.
• Inverse WebSockets working as expected in testnet.
• Inverse WebSockets working as expected in mainnet.

Final checks:

• Validate all of inverse endpoints for breaking changes. Any changes in behaviour should be documented.
• Validate all of inverse endpoints for breaking changes. Any changes in behaviour should be documented.
• Validate all of inverse endpoints for validity (params, endpoints, method order matches bybit documentation).
• Validate all of linear endpoints for validity (params, endpoints, method order matches bybit documentation).
• Readme has been updated based on new usage for inverse and linear, REST & WS.
• Adding documentation for linear endpoints, and depreciating old endpoints from docs.
• Updating documentation for new naming scheme and linear endpoints.

[tiagosiebler]

Generally quite like the direction this is taking, nice work! Some comments although mostly minor nitpicks. My biggest caution is introducing changes to existing functionality while adding something new, although a one-line change is relatively minor.

If some of the RestClient (InverseClient) endpoints need to change I would prefer that happens in a separate smaller PR. Otherwise it's looking great, thanks for working on this!

[peepo5]

I removed some old open-api endpoints.

[tiagosiebler]

Inverse is looking good. Tested on my side too with testnet and mainnet, both are consistent (with the expected breaking change to LinearClient). Still have to check linear.

[tiagosiebler]

A few really silly formatting requests (sorry), otherwise looking great and almost finished!

[tiagosiebler]

Really happy with this! Only thing left is to finish final testing of linear REST on mainnet. Nice work!

[tiagosiebler]

Looking great!