Clamcore
=======
[](https://www.npmjs.org/package/clamcore)
[](https://travis-ci.org/daxxog/clamcore)
[](https://coveralls.io/r/daxxog/clamcore?branch=dev-1)
A pure and powerful JavaScript CLAM library.
## Principles
CLAM is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the CLAM network allows for highly resilient clam infrastructure, and the developer community needs reliable, open-source tools to implement clam apps and services.
## Get Started
```
npm install clamcore
```
Using it in Node.js:
```javascript
var clamcore = require('clamcore');
assert(clamcore.Address.isValid('x9QZFeNUwhUprwp7owRZQDuYEYENKzfr8A'));
var simpleTx = new clamcore.Transaction();
var simpleTx.from(unspent).to(address, amount);
simpleTx.sign(privateKey);
```
## Examples
* [Generate a random address](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#generate-a-random-address)
* [Generate a address from a SHA256 hash](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#import-an-address-via-wif)
* [Create a Transaction](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#create-a-transaction)
* [Sign a CLAM message](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#sign-a-clam-message)
* [Verify a CLAM message](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#verify-a-clam-message)
* [Create an OP RETURN transaction](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#create-an-op-return-transaction)
* [Create a 2-of-3 multisig P2SH address](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/daxxog/clamcore/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)
## Modules
This module provides clam's core features. Other features and protocol extensions are built into separate modules. Here is a list of official clamcore modules:
Module | Version | Building | Coverage
-------|---------|----------|---------
| [](https://www.npmjs.org/package/clamcore-payment-protocol) | [](https://travis-ci.org/daxxog/clamcore-payment-protocol) | [](https://coveralls.io/r/daxxog/clamcore-payment-protocol)
| [](https://www.npmjs.org/package/clamcore-p2p) | [](https://travis-ci.org/daxxog/clamcore-p2p) | [](https://coveralls.io/r/daxxog/clamcore-p2p?branch=master)
| [](https://www.npmjs.org/package/clamcore-mnemonic) | [](https://travis-ci.org/daxxog/clamcore-mnemonic) | [](https://coveralls.io/r/daxxog/clamcore-mnemonic)
| [](https://www.npmjs.org/package/clamcore-ecies) | [](https://travis-ci.org/daxxog/clamcore-ecies) | [](https://coveralls.io/r/daxxog/clamcore-ecies)
| [](https://www.npmjs.org/package/clamcore-channel) | [](https://travis-ci.org/daxxog/clamcore-channel) | [](https://coveralls.io/r/daxxog/clamcore-channel)
| [](https://www.npmjs.org/package/clamcore-explorers) | [](https://travis-ci.org/daxxog/clamcore-explorers) | [](https://coveralls.io/r/daxxog/clamcore-explorers)
| [](https://www.npmjs.org/package/clamcore-message) | [](https://travis-ci.org/daxxog/clamcore-message) | [](https://coveralls.io/r/daxxog/clamcore-message)
## 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](https://github.com/daxxog/clamcore/blob/master/CONTRIBUTING.md) file.
## Building the Browser Bundle
To build clamcore full bundle for the browser:
```sh
gulp browser
```
This will generate files named `clamcore.js` and `clamcore.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/daxxog/clamcore/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).
To verify signatures, use the following PGP keys:
- @braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D
- @pnagurny: https://pgp.mit.edu/pks/lookup?op=get&search=0x0909B33F0AA53013
## Development & Tests
```sh
git clone https://github.com/bitpay/bitcore
cd bitcore
npm install
```
Run all the tests:
```sh
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](https://github.com/daxxog/clamcore/blob/master/LICENSE).
Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.