npm package: @odin/odinjs-lib
Description: Client-side ODIN Blockchain JavaScript library
Latest version: 5.0.0

# ODINJS (odinjs-lib)
[![Build Status](https://travis-ci.org/obsidianplatform/obsidianjs-lib.png?branch=master)](https://travis-ci.org/obsidianplatform/obsidianjs-lib)
[![NPM](https://img.shields.io/npm/v/@odin/odinjs-lib.svg)](https://www.npmjs.org/package/@odin/odinjs-lib)


A javascript ODIN library for node.js and browsers.

Released under the terms of the [MIT LICENSE](LICENSE).

## Should I use this in production?
If you are thinking of using the *master* branch of this library in production, **stop**.
Master is not stable; it is our development branch, and only tagged releases may be classified as stable.


## Can I trust this code?
> Don't trust. Verify.

We recommend every user of this library audit and verify any underlying code for its validity and suitability.

Mistakes and bugs happen, but with your help in resolving and reporting issues, together we can produce open source software that is:

- Easy to audit and verify,
- Tested, with test coverage >95%,
- Advanced and feature rich,
- Standardized, using [standard](http://github.com/standard/standard) and Node `Buffer`'s throughout, and
- Friendly, with a strong and helpful community, ready to answer questions.

## Documentation
Presently,  we do not have any formal documentation other than our [examples](#examples).


## Installation
ODINJS-lib is currently not available from NPM. Usage is currently localized.

## Usage

Coming soon.


## Examples

Coming soon.

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).


### Running the test suite

``` bash
npm test
npm run-script coverage
```

## Complementing Libraries
- [BIP21](https://github.com/bitcoinjs/bip21) - A BIP21 compatible URL encoding library
- [BIP38](https://github.com/bitcoinjs/bip38) - Passphrase-protected private keys
- [BIP39](https://github.com/bitcoinjs/bip39) - Mnemonic generation for deterministic keys
- [BIP32-Utils](https://github.com/bitcoinjs/bip32-utils) - A set of utilities for working with BIP32
- [BIP66](https://github.com/bitcoinjs/bip66) - Strict DER signature decoding
- [BIP68](https://github.com/bitcoinjs/bip68) - Relative lock-time encoding library
- [BIP69](https://github.com/bitcoinjs/bip69) - Lexicographical Indexing of Transaction Inputs and Outputs
- [Base58](https://github.com/cryptocoinjs/bs58) - Base58 encoding/decoding
- [Base58 Check](https://github.com/bitcoinjs/bs58check) - Base58 check encoding/decoding
- [Bech32](https://github.com/bitcoinjs/bech32) - A BIP173 compliant Bech32 encoding library
- [coinselect](https://github.com/bitcoinjs/coinselect) - A fee-optimizing, transaction input selection module for odinjs-lib.
- [merkle-lib](https://github.com/bitcoinjs/merkle-lib) - A performance conscious library for merkle root and tree calculations.
- [minimaldata](https://github.com/bitcoinjs/minimaldata) - A module to check bitcoin policy: SCRIPT_VERIFY_MINIMALDATA


## Special Thanks
Special thanks goes towards the [bitcoinjs](https://github.com/bitcoinjs) community and their amazing effort to build useful tools that can work alongside the Bitcoin protocol.

## LICENSE [MIT](LICENSE)