libcash
v8.1.1
Published
A pure and powerful JavaScript Bitcoin Cash library.
Downloads
1
Maintainers
Readme
LibCash
A pure and powerful JavaScript Bitcoin Cash (BCH) library.
LibCash is a fork of bitcore-lib-bitcoincash aimed at providing more up-to-date support for Bitcoin Cash.
Principles
Bitcoin Cash is an other powerful peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services.
Bitcoin Cash changes
Bitcoin cash uses a different sighash
for transaction signatures. The implementation in LibCash has been tested agains the original bitcoin-cash test vectors (see sighash.json in /test
). bitcoin-cash
modifications in script evaluation has not been implemented yet.
Get Started
npm install bitcore-lib-cash
Adding LibCash to your app's package.json
:
"dependencies": {
"libcash": "=0.18.0",
...
}
Documentation
The complete docs are hosted here: bitcore documentation. There's also a bitcore API reference available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.
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
Building the Browser Bundle
To build a bitcore-lib full bundle for the browser:
gulp browser
This will generate files named bitcore-lib-cash.js
and bitcore-lib-cash.min.js
.
You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout the releases.
Development & Tests
git clone https://github.com/bitpay/bitcore-lib-cash
cd bitcore-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
.
Security
We're using Bitcore in production, as are many others, but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.
If you find a security issue, please email [email protected].
Contributing
See CONTRIBUTING.md on the main bitcore repo for information about how to contribute.
License
Code released under the MIT license.
Copyright 2013-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.