Skip to content

A pure and powerful JavaScript Bitcoin library forked to include support for many altoins

License

Notifications You must be signed in to change notification settings

9z25/altcore-lib

 
 

Repository files navigation

Altcore Library

Imgur

NPM Package Build Status Coverage Status

A pure and powerful JavaScript Bitcoin library. Forked to work with altcoins.

Principles

Bitcore is a powerful javascript blockchain library. It was originally built to work with the bitcoin and bitcoin testnet networks, and has the ability to be extended to other networks, like Namecoin and Litecoin.

Many altcoin communities have forked bitcore-lib to work with their altcoin, but thus far, the overwheling majority of these forks are done in such a way that makes them only work for that altcoin. This means if you want to build an application that uses multiple altcoins, you will need to include with your application multiple versions of the same large library that is mostly the same. This is not much of a problem if you are building a desktop application, but for a web application (the only platform where javascript has a purpose to exist), this is unacceptable.

This fork tries to move all modifications from each bitcore fork in existence and makes them available under a single codebase that is roughly the same size as a single instance of bitcore-lib.

This fork has expanded the Networks functionality found in bitcore-lib, and has kept everything else (as much as possible) the same as bitcore-lib. The 'livenet' network has been renamed to 'btc'. Only livenets of each currency is supported. The network called "testnet" is bitcoin's testnet and is the only testnet supported.

Currencies supported

Bitcoin, Litecoin, ZCash, Dash, Groestlcoin, KittehCoin, Fujicoin, BunnyCoin, Syscoin 2.1, Dogecoin.

Get Started

npm install altcore-lib
bower install altcore-lib

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.

To get community assistance and ask for help with implementation questions, please use our community forums.

Examples

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 security@bitpay.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 altcore-lib full bundle for the browser:

gulp browser

This will generate files named altcore-lib.js and altcore-lib.min.js.

Development & Tests

git clone https://github.com/priestc/altcore-lib
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.

License

Code released under the MIT license.

About

A pure and powerful JavaScript Bitcoin library forked to include support for many altoins

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%