0.1.0 • Published 1 year ago

@okbchain/javascript-sdk v0.1.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
1 year ago

OKBChain JavaScript SDK

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

  • crypto - core cryptographic functions.
  • client - implementations of OKBChain transaction types, such as for transfers and trading.
  • accounts - management of "accounts" and wallets, including seed and encrypted mnemonic generation.

Installation

Install the NPM package:

$ npm i @okbchain/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

Contributing

Contributions to the OKBChain 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.