npm package: @klayr/client
Description: A default set of Elements for use by clients of the Klayr network
Author: Klayr Labs
Latest version: 6.1.2

# @klayr/client

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

## Installation

### Installation via npm

Add Klayr Client as a dependency of your project:

```sh
$ npm install --save @klayr/client
```

Import using ES6 modules syntax:

```js
import * as klayr from '@klayr/client';
```

Or using Node.js modules:

```js
const klayr = require('@klayr/client');
```

Or import specific namespaced functionality:

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

### Installation via CDN

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

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

Or minified:

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

## Packages

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

[klayr core github]: https://github.com/Klayrhq/klayr
[klayr documentation site]: https://klayr.xyz/documentation/klayr-sdk/references/klayr-elements/client.html