0.0.1 • Published 6 years ago

@owstack/btg-lib v0.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

BTG Lib

NPM Package Build Status Coverage Status

A pure and powerful JavaScript Bitcoin Gold library.

What this provides

This repository extends @owstack/satoshi-common-lib with bitcoin-gold fork changes

Principles

Bitcoin Gold is an other powerful peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin Gold network allows for highly resilient bitcoin gold infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin gold apps and services.

Bitcoin Gold vs. Bitcoin

Bitcoin Gold uses a different sighash for transaction signatures. The implementation has been tested against the original bitcoin gold test vectors (see sighash.json in /test). bitcoin gold modifications in script evaluation has not been implemented yet.

Get Started

npm install btg-lib
bower install btg-lib

Examples

Security

If you find a security issue, please email security@openwalletstack.com.

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

gulp browser

This will generate files named bch.js and bch.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 a release commit (for example, https://github.com/owstack/btg-lib/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).

To verify signatures, use the following PGP keys:

Development & Tests

git clone https://github.com/owstack/btg-lib
cd btg-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.