# @klayr/codec

> Implementation of decoder and encoder using Klayr JSON schema according to the Klayr protocol

Latest version **0.5.1** (published 2024-08-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @klayr/codec
pnpm add @klayr/codec
yarn add @klayr/codec
bun add @klayr/codec
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2024-08-19 |
| First published | 2024-04-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.12.0 <=18 |
| Dependencies | 3 |
| Unpacked size | 74 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Klayr Labs |
| Maintainers | corbifex |
| Keywords | klayr, blockchain |

## Links

- npm: https://www.npmjs.com/package/@klayr/codec
- Repository: https://github.com/Klayrhq/klayr-sdk
- Homepage: https://github.com/Klayrhq/klayr-sdk/tree/master/elements/codec#readme
- Issues: https://github.com/Klayrhq/klayr-sdk/issues
- npm.io page: https://npm.io/package/@klayr/codec

## Dependencies (3)

- [@klayr/utils](https://npm.io/package/@klayr/utils.md) ^0.4.1
- [@klayr/validator](https://npm.io/package/@klayr/validator.md) ^0.9.1
- [@klayr/cryptography](https://npm.io/package/@klayr/cryptography.md) ^4.1.1

## Recent versions

- 0.5.1 (latest) — 2024-08-19
- 0.5.0 — 2024-08-16
- 0.4.2 — 2024-04-22
- 0.4.1 — 2024-04-16

## README

# @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

---
_Source: https://npm.io/package/@klayr/codec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._