Clamcore

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:

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
• Generate a address from a SHA256 hash
• Import an address via WIF
• Create a Transaction
• Sign a CLAM message
• Verify a CLAM message
• Create an OP RETURN transaction
• Create a 2-of-3 multisig P2SH address
• 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 -------|---------|----------|--------- | | | | | | | | | | | | | | | | | | | | |

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

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

git clone https://github.com/bitpay/bitcore
cd bitcore
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-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.