Binance Chain JavaScript SDK

The Binance Chain JavaScript SDK allows browsers and node.js clients to interact with Binance Chain. It includes the following core components:

• crypto - core cryptographic functions.
• amino - amino (protobuf-like) encoding and decoding of transactions.
• client - implementations of Binance Chain transaction types, such as for transfers and trading.
• accounts - management of "accounts" and wallets, including seed and encrypted mnemonic generation.
• ledger - Ledger Nano S/X support via HID, U2F and Web BLE (Bluetooth).
• rpc - RPC client, coming soon.

Installation

Windows users: Please install windows-build-tools first.

Linux users: You may need some dev packages to be installed on your system for USB support. For Debian-based systems (Ubuntu):

$ sudo apt-get install libudev-dev libusb-dev usbutils

Install the NPM package:

$ npm i @binance-chain/javascript-sdk

API

For up-to-date API documentation, please check the wiki.

Testing

All new code changes should be covered with unit tests. You can run the tests with the following command:

$ npm run test

Tests for the Ledger hardware wallet integration have their own suite that runs in both node and in the browser:

$ npm run test:ledger
$ npm run test:ledger:browser

Contributing

Contributions to the Binance Chain JavaScript SDK are welcome. Please ensure that you have tested the changes with a local client and have added unit test coverage for your code.