A pure and powerful JavaScript Litecoin library
JavaScript
Clone or download
Pull request Compare This branch is 31 commits ahead, 68 commits behind bitpay:master.
losh11 Merge pull request #12 from majestic84/segwit
Added confirmations attribute to Transaction.UnspentOutput
Latest commit c0aebd6 Jun 1, 2018

README.md

Litecore Library

NPM Package Build Status Coverage Status

A pure and powerful JavaScript Litecoin library.

Principles

Litecoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Litecoin network allows for highly resilient litecoin infrastructure, and the developer community needs reliable, open-source tools to implement litecoin apps and services.

Get Started

npm install litecore-lib
bower install litecore-lib

Documentation

The complete docs are hosted here: litecore documentation. There's also a litecore API reference available generated from the JSDocs of the project, where you'll find low-level details on each litecore utility.

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

Examples

Security

We're using Litecore 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 litecore-lib full bundle for the browser:

gulp browser

This will generate files named litecore-lib.js and litecore-lib.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/bitpay/bitcore-lib/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).

To verify signatures, use the following PGP keys:

Development & Tests

git clone https://github.com/litecoin-project/litecore-lib
cd litecore-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 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. Copyright 2016-2017 The Litecoin Core Developers