WIP: WSAPI & Multiplex WebSockets

[tiagosiebler]

Summary

This major release brings major upgrades to the Node.js, TypeScript & JavaScript SDK for Binance's REST APIs and WebSockets.

Key points, with further details below:

• WIP: Upgraded the WebsocketClient in line with the newer generation found in my newer SDKs.
• WIP: Added integration for the WebSocket API (send orders via WS, await responses). See v2.8.5: fix(#336) fix handling for cancel batch orders endpoint. chore() readme updates. chore() linting in coinm client. #344.
• WIP: Authentication now uses the Web Crypto API for request sign, both for REST & WS. See small mistake in the spelling of get24hrChangeStatististics #321.
• Upgraded build version to Node LTS.
• Misc dependency updates:
  • Axios to 1.7.9
  • @types/node to LTS
  • typescript to 5.7.3

Major Changes

Auth/Performance (REST & WS)

• TODO: Use the Web Crypto API for request sign/auth by default.
  • This is marginally slower than node's native crypto module, but provides better compatibility with browser environments.
  • See for context: Web Crypto API bybit-api#321
• TODO: Add customSignMessageFn() parameter to WebsocketClient and REST clients.
  • If you're latency sensitive, use this to inject a custom sign method to use something faster than the Web Crypto API.
  • See the examples/fasterHmacSign.ts example for a demonstration on using the faster node crypto createHmac function instead (same behaviour as before this upgrade).

Breaking Changes

WebsocketClient

• Consolidated the internal DefaultLogger methods, in line with my other SDKs
  • Into 3 key levels: trace | info | error.
  • Similar to the silly level before this release, the trace level is disabled/silent by default.

[socket-security]

New and updated dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected] 🔁 npm/[email protected]	Transitive: environment, filesystem	+8	2.5 MB	jasonsaayman
npm/[email protected] 🔁 npm/[email protected]	Transitive: eval, network, shell	+156	15.5 MB	kul
npm/[email protected] 🔁 npm/[email protected]	None	0	22.7 MB	typescript-bot

View full report↗︎