BitcoinCash.js

A simple, safe, and powerful JavaScript Bitcoin Cash library.

Bitcoin Cash

Bitcoin Cash is the continuation of the Bitcoin project as peer-to-peer electronic cash for the Internet.

Bitcoin Cash uses a different SigHash for transaction signatures. The implementation in BitcoinCash.js has been tested agains the original Bitcoin Cash test vectors (see sighash.json in /test). Modifications in script evaluation have not yet been implemented.

Get Started

npm install --save bitcoincashjs

bower install bitcoincashjs

Documentation

The complete docs are hosted here: BitcoinCash.js documentation.

• Read the Developer Guide

Examples

• Generate a random address
• Generate a address from a SHA256 hash
• Import an address via WIF
• Create a Transaction
• Sign a Bitcoin message
• Verify a Bitcoin message
• Create an OP RETURN transaction
• Create a 2-of-3 multisig P2SH address
• Spend from a 2-of-2 multisig P2SH address

Security

BitcoinCash.js is built upon Bitcore, which is used in production at Bitpay and many other projects.

If you find a security issue, please email bitcoincashjs@tuta.io.

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 bitcoincashjs full bundle for the browser:

gulp browser

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

Development & Tests

git clone https://github.com/bitcoincashjs/bitcoincashjs
cd bitcoincashjs
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 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.