ok-javascript-sdk

OKChain JavaScript SDK

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

• crypto - core cryptographic functions.
• client - implementations of OKChain 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 ok-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 OKChain 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.