open-index/open-npm huggingface dataset:
npm package: @klayr/api-client
Description: An API client for the Klayr network
Author: Klayr Labs
Latest version: 6.1.2

# @klayr/api-client

@klayr/api-client is containing an API client for the Klayr network

## Installation

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

## 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/api-client.html
npm package: @klayr/chain
Description: Blocks and state management implementation that are used for block processing according to the Klayr protocol
Author: Klayr Labs
Latest version: 0.6.2

# @klayr/chain

@klayr/chain implements blocks and state management that are used for block processing according to the Klayr protocol.

## Installation

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

## 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/chain.html
npm package: @klayr/codec
Description: Implementation of decoder and encoder using Klayr JSON schema according to the Klayr protocol
Author: Klayr Labs
Latest version: 0.5.1

# @klayr/codec

@klayr/codec implements decoder and encoder using Klayr JSON schema according to the Klayr protocol.

## Installation

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

## Benchmarks

The following are some benchmarks for version 0.1 of this library used for encoding and decoding different objects both generic and objects similar to the ones in the Klayr networks.

Node version used: v12.17.0. Computer Spec: SSD, 6 Core, 16 GB RAM. No special configuration for Node.

| Object Type                               | Encode (ops/sec) | Decode (ops/sec) |
| ----------------------------------------- | :--------------: | ---------------: |
| Account                                   |      75,081      |           86,908 |
| Transfer Transaction                      |     225,229      |          276,184 |
| Multi-signature registration (64 Members) |      23,539      |           44,231 |
| Block (15 KB transactions)                |      42,349      |           91,180 |

This and additional benchmarks can be found in the `benchmarks` folder

## 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/codec.html
npm package: @klayr/cryptography
Description: General cryptographic functions for use with Klayr-related software
Author: Klayr Labs
Latest version: 4.1.1

# @klayr/cryptography

@klayr/cryptography is containing general cryptographic functions for use with Klayr-related software

## Installation

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

## Benchmarking

Install optional dependencies:

```sh
$ npm i -D benchmark sodium-native
```

Benchmark nacl functions:

```sh
$ npx babel-node ./benchmark/nacl
```

Benchmark results for nacl functions:

|    Function    |           Fast           |           Slow           | Winner |
| :------------: | :----------------------: | :----------------------: | :----: |
|      box       | x 23,982 ops/sec ±0.59%  |   x 771 ops/sec ±0.44%   |  Fast  |
|    openBox     | x 24,247 ops/sec ±0.42%  |   x 770 ops/sec ±0.69%   |  Fast  |
|  signDetached  | x 46,402 ops/sec ±0.32%  |   x 236 ops/sec ±1.63%   |  Fast  |
| verifyDetached | x 17,153 ops/sec ±0.19%  |   x 122 ops/sec ±0.61%   |  Fast  |
| getRandomBytes | x 207,866 ops/sec ±0.23% | x 299,959 ops/sec ±0.39% |  Slow  |
|   getKeyPair   | x 38,815 ops/sec ±0.16%  |   x 242 ops/sec ±0.62%   |  Fast  |

## 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/cryptography.html
npm package: @klayr/passphrase
Description: Mnemonic passphrase helpers for use with Klayr-related software
Author: Klayr Labs
Latest version: 4.1.1

# @klayr/passphrase

@klayr/passphrase is containing mnemonic passphrase helpers for use with Klayr-related software

## Installation

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

## 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/passphrase.html
npm package: @klayr/transaction-pool
Description: Transaction pool library for use with Klayr-related software
Author: Klayr Labs
Latest version: 0.8.1

# klayr-transaction-pool

Transaction pool library for use with Klayr-related software

## Installation

```sh
$ npm install --save @klayr/transaction-pool
```

## 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/transaction-pool.html
npm package: @klayr/transactions
Description: Utility functions related to transactions according to the Klayr protocol
Author: Klayr Labs
Latest version: 6.1.1

# @klayr/transactions

@klayr/transactions contain utility functions related to transactions according to the Klayr protocol

## Installation

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

## 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/transactions.html
npm package: @klayr/tree
Description: Library containing Merkle tree implementations for use with Klayr-related software
Author: Klayr Labs
Latest version: 0.5.1

# @klayr/tree

@klayr/tree is containing Merkle tree implementations for use with Klayr-related software

## Installation

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

## Benchmarking

Node version used: v12.14.1. Computer Spec: SSD, 6 Core, 16 GB RAM. No special configuration for Node.

Benchmark results for main klayr-tree functions:

|           Function            | 1000 leaves | 10,000 leaves | 100,000 leaves |
| :---------------------------: | :---------: | :-----------: | :------------: |
|             build             |    45ms     |     240ms     |     2348ms     |
|            append             |     3ms     |      3ms      |      4ms       |
|    generateProof (1 query)    |     5ms     |      5ms      |      6ms       |
|  generateProof (100 queries)  |    50ms     |     125ms     |     172ms      |
| generateProof (1000 queries)  |    56ms     |     114ms     |     168ms      |
| generateProof (10000 queries) |     n/a     |    7993ms     |    14504ms     |
|     verifyProof (1 query)     |     3ms     |      5ms      |      5ms       |
|    verifyProof (100 query)    |    45ms     |     106ms     |     166ms      |
|   verifyProof (1000 query)    |    539ms    |     958ms     |     1592ms     |
|   verifyProof (10000 query)   |     n/a     |    8632ms     |    15909ms     |

## 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/tree.html
npm package: @klayr/utils
Description: Library containing generic utility functions for use with Klayr-related software
Author: Klayr Labs
Latest version: 0.4.3

# @klayr/utils

@klayr/utils is library containing generic utility functions for use with Klayr-related software.

## Installation

```sh
$ npm install --save @klayr/{PACKAGE}
```

## 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/utils.html
npm package: @klayr/validator
Description: Validation library according to the Klayr protocol
Author: Klayr Labs
Latest version: 0.9.1

# @klayr/validator

@klayr/validator is a wrapper of validation libraries. It includes custom validations utilities related to Klayr protocol

## Installation

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

## 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/validator.html