README
Garlicore Library
A pure and powerful JavaScript Garlicoin library.
Principles
Garlicoin is a garlic-themed decentralized cryptocurrency, with an ASIC-mining resistant proof of work and rapid difficulty readjustment, intended to be mined on consumer-grade hardware. The decentralized nature of the Garlicoin network allows for highly resilient Garlicoin infrastructure, and the developer community needs reliable, open-source tools to implement Garlicoin apps and services.
Get Started
npm install bitcore-lib-grlc
bower install bitcore-lib-grlc
Documentation (bitcore, not grlc)
- Tests have not been modified for Garlicoin
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.
Examples
- Generate a random address
- Generate a address from a SHA256 hash
- Import an address via WIF
- Create a Transaction
- Sign a Bitcoin message
- Verify a Bitcoin message
- Create an OP RETURN transaction
- Create a P2SH address
- Create a 2-of-3 multisig P2SH address
- Spend from a 2-of-2 multisig P2SH address
Building the Browser Bundle
To build a bitcore-lib full bundle for the browser:
gulp browser
This will generate files named bitcore-lib-grlc.js and bitcore-lib-grlc.min.js.
Development & Tests
git clone https://github.com/MaxPuig/bitcore-lib-grlc.git
cd bitcore-lib-grlc
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.
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
See CONTRIBUTING.md on the main bitcore repo for information about how to contribute.
License
Code released under the MIT license.
Copyright 2013-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.