Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
web3-validator
Advanced tools
This is a sub-package of web3.js.
web3-validator
contains functions for validating objects.
You can install the package either using NPM or using Yarn
npm install web3-validator
yarn add web3-validator
You can use the validator by importing as and using to validate;
import { validator } from '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.
Following eth types are supported to validate.
Type | Input As | Description |
---|---|---|
uint | number , string , HexString | Unsigned integer, all ethereum 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 ethereum 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
| Ethereum 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 ethereum 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.
[{ "name": "owner", "type": "address" }]
The implementation of the validator is extension of JSON-Schema-Draft07 with a custom keyword eth
. So you can use JSON-Schema compatible schema to validate any object based data as well.
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 |
FAQs
JSON-Schema compatible validator for web3
We found that web3-validator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.