BitcoinSource is currently undergoing a major refactoring which might break parts of the API. We do not recommend it to be used until the version 1.0.0 is released.
About Bitcoin Cash
Bitcoin Cash is peer-to-peer electronic cash for the Internet. It is fully decentralized, has no central bank, and requires no trusted third-parties to operate. Bitcoin Cash is the continuation of the Bitcoin project, upgraded with consensus rules that allow it to grow and scale.
$ npm install --save bitcoinsource
$ bower install --save bitcoinsource
You can also download a pre-compiled and minified version here: dist
You can find many useful, up-to-date examples to get you started right away by following the provided examples:
- Generate a random address
- Generate a address from a SHA256 hash
- Translate an address to any Bitcoin Cash address format
- Read an address from any Bitcoin Cash address format
- Import an address via WIF
- Create a Transaction
- Verify a Bitcoin message
- Sign 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
This is an open-source project, and any form of contribution is welcome. Feel free to create an issue in case you would like to share ideas for improvement, or would like to report a bug. Also, please send pull requests for bug fixes or code optimization. For more information on how to contribute, please refer to our CONTRIBUTING file.
To get started with development, you should first clone the repository and install any dependencies:
$ git clone https://github.com/the-bitcoin-token/BitcoinSource $ cd BitcoinSource $ npm install
Next, you can check everything is installed correctly by running the full test-suite and verifying that all tests are completed successfully.
$ npm test
Code released under the MIT license.