4.2.0-shapeshift.1 • Published 2 years ago

@shapeshiftoss/bnb-javascript-sdk v4.2.0-shapeshift.1

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
2 years ago

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.
  • rpc - Node RPC client.
  • transaction - Transaction Class, build and sign.

You can find more detailed documentation and examples in our Documentation pages.

Installation

$ npm i @binance-chain/javascript-sdk
# Or:
$ yarn add @binance-chain/javascript-sdk

Prerequisites

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

  • Mac users: Make sure XCode Command Line Tools are installed: xcode-select --install.

Testing

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

$ yarn test

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.