# @liskhq/lisk-client

A default set of Elements for use by clients of the Lisk network

## Installation

### Installation via npm

Add Lisk Client as a dependency of your project:

```sh
$ npm install --save @liskhq/lisk-client
```

Import using ES6 modules syntax:

```js
import * as lisk from '@liskhq/lisk-client';
```

Or using Node.js modules:

```js
const lisk = require('@liskhq/lisk-client');
```

Or import specific namespaced functionality:

```js
import { transactions } from '@liskhq/lisk-client';
// or
const { transactions } = require('@liskhq/lisk-client');
```

### Installation via CDN

Include the following script using the following HTML. The `lisk` variable will be exposed.

```html
<script src="https://js.lisk.com/lisk-client-5.0.0.js"></script>
```

Or minified:

```html
<script src="https://js.lisk.com/lisk-client-5.0.0.min.js"></script>
```

## Packages

| Package                                                                              |                            Version                             | Description                                                               |
| ------------------------------------------------------------------------------------ | :------------------------------------------------------------: | ------------------------------------------------------------------------- |
| [@liskhq/lisk-api-client](https://www.npmjs.com/package/@liskhq/lisk-api-client)     |  ![npm](https://img.shields.io/npm/v/@liskhq/lisk-api-client)  | An API client for the Lisk network                                        |
| [@liskhq/lisk-codec](https://www.npmjs.com/package/@liskhq/lisk-codec)               |    ![npm](https://img.shields.io/npm/v/@liskhq/lisk-codec)     | Decoder and encoder using Lisk JSON schema according to the Lisk protocol |
| [@liskhq/lisk-cryptography](https://www.npmjs.com/package/@liskhq/lisk-cryptography) | ![npm](https://img.shields.io/npm/v/@liskhq/lisk-cryptography) | General cryptographic functions for use with Lisk-related software        |
| [@liskhq/lisk-passphrase](https://www.npmjs.com/package/@liskhq/lisk-passphrase)     |  ![npm](https://img.shields.io/npm/v/@liskhq/lisk-passphrase)  | Mnemonic passphrase helpers for use with Lisk-related software            |
| [@liskhq/lisk-transactions](https://www.npmjs.com/package/@liskhq/lisk-transactions) | ![npm](https://img.shields.io/npm/v/@liskhq/lisk-transactions) | Everything related to transactions according to the Lisk protocol         |
| [@liskhq/lisk-tree](https://www.npmjs.com/package/@liskhq/lisk-tree)                 |     ![npm](https://img.shields.io/npm/v/@liskhq/lisk-tree)     | Merkle tree implementations for use with Lisk-related software            |
| [@liskhq/lisk-utils](https://www.npmjs.com/package/@liskhq/lisk-utils)               |    ![npm](https://img.shields.io/npm/v/@liskhq/lisk-utils)     | Generic utility functions for use with Lisk-related software              |
| [@liskhq/lisk-validator](https://www.npmjs.com/package/@liskhq/lisk-validator)       |  ![npm](https://img.shields.io/npm/v/@liskhq/lisk-validator)   | Validation library according to the Lisk protocol                         |

## License

Copyright 2016-2020 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[lisk core github]: https://github.com/LiskHQ/lisk
[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/client.html