bitcore-matrixpay-lib/README.md

A pure and powerful JavaScript MatrixPay library.

# MatrixPaycore Library

[![Build Status](https://img.shields.io/travis/matrix-pay/bitcore-matrixpay-lib.svg?branch=master)](https://travis-ci.org/matrix-pay/bitcore-matrixpay-lib)
[![NPM Package](https://img.shields.io/npm/v/bitcore-matrixpay-lib.svg)](https://www.npmjs.org/package/bitcore-matrixpay-lib)

> A pure and powerful JavaScript MatrixPay library.

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

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)

## Install

### NodeJS

```
npm install bitcore-matrixpay-lib
```

### Browser

See the section below to generate your own bundle, or download the pre-generated [minified file](dist/matrixpaycore-lib.min.js)

#### Building the Browser Bundle

To build a matrixpaycore-lib full bundle for the browser:

```sh
npm run build
```

This will generate files named `matrixpaycore-lib.js` and `matrixpaycore-lib.min.js` in the `dist/` folder.

## Usage

### Browser

```
<script src='./dist/matrixpaycore-lib.min.js' type="text/javascript"></script>
<script>
  const PrivateKey = matrixpaycore.PrivateKey;
  const privateKey = new PrivateKey();
  const address = privateKey.toAddress().toString();
</script>
```

### Modules

Some functionality is implemented as a module that can be installed separately:

* [Payment Protocol Support](https://github.com/dashevo/matrixpaycore-payment-protocol)
* [Peer to Peer Networking](https://github.com/dashevo/matrixpaycore-p2p)
* [MatrixPay JSON-RPC](https://github.com/dashevo/dashd-rpc)
* [Payment Channels](https://github.com/dashevo/matrixpaycore-channel)
* [Mnemonics](https://github.com/dashevo/matrixpaycore-mnemonic)
* [Elliptical Curve Integrated Encryption Scheme](https://github.com/dashevo/bitcore-ecies-dash)
* [Signed Messages](https://github.com/dashevo/bitcore-message-dash)

### Development & Tests

```sh
git clone https://github.com/matrix-pay/bitcore-matrixpay-lib
cd matrixpaycore-lib
npm install
```

Run all the tests:

```sh
npm test
```

You can also run just the Node.js tests with `npm run test:node`, just the browser tests with `npm run test:browser` or run a test coverage report with `npm run coverage`.

## Documentation

* [Addresses](docs/address.md)
* [Block](docs/block.md)
* [Crypto](docs/crypto.md)
* [Encoding](docs/encoding.md)
* [Hierarchically-derived Private and Public Keys](docs/hierarchical.md)
* [Networks](docs/networks.md)
* [PrivateKey](docs/privatekey.md)
* [PublicKey](docs/publickey.md)
* [Script](docs/script.md)
* [Transaction](docs/transaction.md)
* [Using Different Units](docs/unit.md)
* [Unspent Output](docs/unspentoutput.md)
* [URI](docs/uri.md)
* [Governance Object / Proposal](docs/govobject/govobject.md)

### Examples

Some examples can be found [here](docs/examples.md), below is a list of direct links for some of them.

* [Generate a random address](docs/examples.md#generate-a-random-address)
* [Generate an address from a SHA256 hash](docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](docs/examples.md#import-an-address-via-wif)
* [Create a Transaction](docs/examples.md#create-a-transaction)
* [Sign a MatrixPay message](docs/examples.md#sign-a-bitcoin-message)
* [Verify a MatrixPay message](docs/examples.md#verify-a-bitcoin-message)
* [Create an OP RETURN transaction](docs/examples.md#create-an-op-return-transaction)
* [Create a 2-of-3 multisig P2SH address](docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
* [Spend from a 2-of-2 multisig P2SH address](docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)

## 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/matrix-pay/bitcore-matrixpay-lib/blob/master/CONTRIBUTING.md) file.

## License

Code released under [the MIT license](LICENSE).

Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.  
Copyright 2016-2017 The MatrixPay Foundation, Inc.  
Copyright 2017-2018 MatrixPay Group, Inc.