UNPKG

@xchainjs/xchain-binance

Version:

Custom Binance client and utilities used by XChainJS clients

github.com/xchainjs/xchainjs-lib

xchainjs/xchainjs-lib

44 lines (29 loc) • 2.74 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# `@xchainjs/xchain-binance` Binance Module for XChainJS Clients ## Modules - `client` - Custom client for communicating with Binance Chain by using [`binance-chain/javascript-sdk`](https://github.com/binance-chain/javascript-sdk) - `types` - TypeScript type definitions for [`binance-chain/javascript-sdk`](https://github.com/binance-chain/javascript-sdk) (not completed) and [`Binance WebSocket Streams`](https://docs.binance.org/api-reference/dex-api/ws-streams.html). - `util` - Utitilies for using [`binance-chain/javascript-sdk`](https://github.com/binance-chain/javascript-sdk) ## Installation ``` yarn add @xchainjs/xchain-binance ``` Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-binance`. ``` yarn add @binance-chain/javascript-sdk @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util ``` ## Documentation ### [`xchain binance`](http://docs.xchainjs.org/xchain-client/xchain-binance/) [`How xchain-binance works`](http://docs.xchainjs.org/xchain-client/xchain-binance/how-it-works.html)\ [`How to use xchain-binance`](http://docs.xchainjs.org/xchain-client/xchain-binance/how-to-use.html) ## Service Providers This package uses the following service providers: | Function | Service | Notes | Rate limits | | --------------------------- | -------------------- | ----------------------------------------------------------------------------- | ----------------------------- | | Balances | Binance Dex | https://docs.binance.org/api-reference/dex-api/paths.html#apiv1accountaddress | 5 requests per IP per second. | | Transaction history | Binance Dex | https://docs.binance.org/api-reference/dex-api/paths.html#apiv1transactions | 60 requests per IP per minute | | Transaction details by hash | Binance Dex | https://docs.binance.org/api-reference/dex-api/paths.html#apiv1txhash | 10 requests per IP per second | | Transaction fees | Binance Dex | https://docs.binance.org/api-reference/dex-api/paths.html#apiv1fees | 1 request per IP per second | | Transaction broadcast | Binance Dex | https://docs.binance.org/api-reference/dex-api/paths.html#apiv1broadcast | 5 requests per IP per second | | Explorer | Binance Dex Explorer | https://explorer.binance.org | | This package gets the node information (`https://docs.binance.org/api-reference/dex-api/paths.html#apiv1node-info`) to transfer tokens.