@owstack/bch-lib
v0.4.6
Published
A Javascript library to build bitcoin cash and blockchain-based applications.
Downloads
438
Readme
Bch Lib
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
- Generate a random address
- Generate a address from a SHA256 hash
- Import an address via WIF
- Create a Transaction
- Sign a Bitcoin Cash message
- Verify a Bitcoin Cash message
- Create an OP RETURN transaction
- Create a 2-of-3 multisig P2SH address
- Spend from a 2-of-2 multisig P2SH address
Security
If you find a security issue, please email [email protected].
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.