@owstack/bch-lib

A Javascript library to build bitcoin cash and blockchain-based applications.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
131May 16, 2019Aug 22, 2017Minified + gzip package size for @owstack/bch-lib in KB

Readme

Bch Lib

NPM Package Build Status Coverage Status

A pure and powerful JavaScript Bitcoin Cash library.

Attribution

This repository was created by copy forking bitcore-lib 09b97ac.

Principles

Bitcoin Cash is a powerful peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin Cash network allows for highly resilient bitcoin cash infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin cash apps and services.

Bitcoin Cash vs. Bitcoin

Bitcoin Cash uses an optional alternate address format called "cashaddr". It also has several additional changes to the script interpreter that allow the basics for smart contracts.

Get Started

npm install @owstack/bch-lib

Examples

Security

If you find a security issue, please email security@openwalletstack.com.

Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.

Building the Browser Bundle

To build a bch-lib full bundle for the browser:

gulp browser

This will generate files named bch.js and bch.min.js.

Development & Tests

git clone https://github.com/owstack/bch-lib
cd bch-lib
npm install

Run all the tests:

gulp test

You can also run just the Node.js tests with gulp test:node, just the browser tests with gulp test:browser or create a test coverage report (you can open coverage/lcov-report/index.html to visualize it) with gulp coverage.

License

Code released under the MIT license.

Copyright 2017 Open Wallet Stack.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.