BitcoinCash.js: The simple, safe, and powerful JavaScript library for Bitcoin Cash.
Clone or download

README.md

BitcoinSource: A Bitcoin Cash implementation written in modern Javascript

About BitcoinSource

BitcoinSource is a community driven effort to produce a readable, reliable and modern Javascript implementation of Bitcoin. Most current Javascript Bitcoin implementations do not adhere to modern coding standards and are very hard to read as a consequence. We want to create a Bitcoin implementation that every JavaScript programmer can read and understand.

In step one, we want to get the entire codebase to comply with the Airbnb JavaScript Style Guide. Step two will be to port the code base to ES6. Step three will be to statically typecheck the entire codebase with Facebook’s Flow. We suspect we will uncover bugs in the process.

We are looking for contributors. You do not have to be a Bitcoin protocol expert to contribute. All you need to be is a good Javascript programmer. If you want to help, check out CONTRIBUTING.md or email clemens@bitcointoken.com.

Warning

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.

Installation

Using NPM

$ npm install --save bitcoinsource

Using Bower

$ bower install --save bitcoinsource

Manually

You can also download a pre-compiled and minified version here: dist

Examples

You can find many useful, up-to-date examples to get you started right away by following the provided examples:

Security

BitcoinSource is a fork of bitcore-lib, which is used in production at Bitpay Inc. and many other projects. If you find a security issue, please email clemens@bitcointoken.com.

Contributing

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.

Development

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

Progress

File Airbnb Style Guide ES6 Flow
address.js done done not done
bitcoinsource.js done done not done
block/block.js done done not done
block/blockheader.js done done not done
block/index.js done done not done
block/merkleblock.js done done not done
crypto/bn.js done not done not done
crypto/ecdsa.js done not done not done
crypto/hash.js done not done not done
crypto/point.js done not done not done
crypto/random.js done not done not done
crypto/signature.js done not done not done
encoding/base58.js done not done not done
encoding/base58check.js done not done not done
encoding/bufferreader.js done not done not done
encoding/bufferwriter.js done not done not done
encoding/varint.js done not done not done
errors/index.js done not done not done
errors/spec.js done not done not done
hdprivatekey.js done not done not done
hdpublickey.js done not done not done
message.js done not done not done
mnemonic/index.js done not done not done
mnemonic/mnemonic.js done not done not done
mnemonic/pbkdf2.js done not done not done
mnemonic/words/chinese.js done not done not done
mnemonic/words/english.js done not done not done
mnemonic/words/french.js done not done not done
mnemonic/words/index.js done not done not done
mnemonic/words/italian.js done not done not done
mnemonic/words/japanese.js done not done not done
mnemonic/words/spanish.js done not done not done
networks.js done not done not done
opcode.js done not done not done
privatekey.js done not done not done
publickey.js done not done not done
script/index.js done not done not done
script/interpreter.js done not done not done
script/script.js done not done not done
transaction/index.js done done not done
transaction/input/index.js done not done not done
transaction/input/input.js done not done not done
transaction/input/multisig.js done not done not done
transaction/input/multisigscripthash.js done not done not done
transaction/input/publickey.js done not done not done
transaction/input/publickeyhash.js done not done not done
transaction/input/scripthash.js done not done not done
transaction/output.js done done not done
transaction/sighash.js done done not done
transaction/signature.js done done not done
transaction/transaction.js done done not done
transaction/unspentoutput.js done done not done
unit.js done not done not done
uri.js done not done not done
util/buffer.js done not done not done
util/js.js done not done not done
util/preconditions.js done not done not done

License

Code released under the MIT license.