# clamcore
> A pure and powerful JavaScript CLAM library.
Latest version **0.13.3** (published 2015-10-06) · MIT license · 0 weekly downloads
## Install
```sh
npm install clamcore
pnpm add clamcore
yarn add clamcore
bun add clamcore
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.13.3 |
| Published | 2015-10-06 |
| First published | 2015-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+14 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | daXXog |
| Maintainers | daxxog |
| Keywords | clam, transaction, address, p2p, ecies, cryptocurrency, blockchain, payment, bip21, bip32, bip37, bip70, multisig |
## Links
- npm: https://www.npmjs.com/package/clamcore
- Repository: https://github.com/daxxog/clamcore
- Homepage: https://github.com/daxxog/clamcore#readme
- Issues: https://github.com/daxxog/clamcore/issues
- npm.io page: https://npm.io/package/clamcore
## Dependencies (7)
- [bs58](https://npm.io/package/bs58.md) =2.0.0
- [bn.js](https://npm.io/package/bn.js.md) =2.0.4
- [lodash](https://npm.io/package/lodash.md) =3.10.1
- [sha512](https://npm.io/package/sha512.md) =0.0.1
- [hash.js](https://npm.io/package/hash.js.md) =1.0.2
- [elliptic](https://npm.io/package/elliptic.md) =3.0.3
- [inherits](https://npm.io/package/inherits.md) =2.0.1
## Alternatives
- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads
## Recent versions
- 0.13.3 (latest) — 2015-10-06
- 0.12.13 — 2015-07-16
- 0.12.8 — 2015-06-04
## README
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.
---
_Source: https://npm.io/package/clamcore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._