# @theqrl/web3-validator

![ES Version](https://img.shields.io/badge/ES-2020-yellow)
![Node Version](https://img.shields.io/badge/node-%3E%3D20-green)
[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator)
[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator)

This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js).

`@theqrl/web3-validator` contains functions for validating objects.

## Installation

You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-validator) or using [pnpm](https://pnpm.io/)

### Using NPM

```bash
npm install @theqrl/web3-validator
```

### Using pnpm

```bash
pnpm add @theqrl/web3-validator
```

## Getting Started

-   :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord)
    ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord)

### Usage

You can use the the validator by importing as and using to validate;

```ts
import { validator } from '@theqrl/web3-validator';

// To validate and throw
validator.validate(['uint8', 'string'], [val1, val2]);

// To validate and return error
const errors = validator.validate(['uint8', 'string'], [val1, val2], { silent: true });
```

To see more examples of schema you can use to validate check [following file](./test/fixtures/abi_to_json_schema.ts).

Following qrl types are supported to validate.

| Type  | Input As                        | Description                                                                                                                                           |
| ----- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| uint  | `number`, `string`, `HexString` | Unsigned integer, all qrl compatible variants are also supported e.g. `uint8`, `uint256`. You can also use array specifiers as `uint[]` or `uint[2]` |
| int   | `number`, `string`, `HexString` | Signed integer, all qrl compatible variants are also supported e.g. `int8`, `int256`. You can also use array specifiers as `int[]` or `int[2]`       |
| bytes | `HexString`, `Uint8Array`       | Raw bytes. You can also use fixed length bytes as `bytes[2]`                                                                                          |

| string | `string` | String values |
| address | `string`, `HexString` | QRL network compatible address |
| bloom | `string`, `HexString` | Check if a given string is a Eth bloom |
| tuple | `array` | You can specify any tuple as nested arrays. e.g. `['uint', 'string']`. For a custom tuple or array tuple you can use syntax e.g. `['tuple[3]', ['uint', 'string']]` |

For the qrl compatible data values should be passed as arrays e.g. for schema `['uint', 'string']` value should be passed as `[2, 'my-string']`.

You can also pass full ABI schema for the validation. e.g.

```json
[{ "name": "owner", "type": "address" }]
```

The implementation of the validator is extension of [JSON-Schema-Draft07](https://json-schema.org/draft-07/json-schema-release-notes.html) with a custom keyword `eth`. So you can use JSON-Schema compatible schema to validate any object based data as well.

## Prerequisites

-   :gear: [NodeJS](https://nodejs.org/) (20 or newer)
-   :toolbox: [pnpm](https://pnpm.io/) and [Turbo](https://turbo.build/)

## Package.json Scripts

| Script           | Description                                        |
| ---------------- | -------------------------------------------------- |
| clean            | Uses `rimraf` to remove `dist/`                    |
| build            | Uses `tsc` to build package and dependent packages |
| lint             | Uses `eslint` to lint package                      |
| lint:fix         | Uses `eslint` to check and fix any warnings        |
| format           | Uses `prettier` to format the code                 |
| test             | Uses `jest` to run unit tests                      |
| test:integration | Uses `jest` to run tests under `/test/integration` |
| test:unit        | Uses `jest` to run tests under `/test/unit`        |

[docs]: https://docs.theqrl.org/
[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-validator
[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-validator%2Fpackage.json
[npm-url]: https://npmjs.org/package/@theqrl/web3-validator
[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-validator?label=npm%20downloads