validator
Index
Namespaces
Classes
Type Aliases
Variables
Functions
- checkAddressCheckSum
- isAddress
- isBigInt
- isBlockNumber
- isBlockNumberOrTag
- isBlockTag
- isBloom
- isBoolean
- isBuffer
- isBytes
- isContractAddressInBloom
- isFilterObject
- isHex
- isHexStrict
- isHexString32Bytes
- isHexString8Bytes
- isInBloom
- isInt
- isNullish
- isNumber
- isObject
- isString
- isTopic
- isTopicInBloom
- isUInt
- isUserEthereumAddressInBloom
- isValidEthBaseType
Namespaces
utils
abiSchemaToJsonSchema
Parameters
abis: FullValidationSchema | ShortValidationSchema
optionallevel: string
Returns JsonSchema
codePointToInt
Parameters
codePoint: number
Returns number
ethAbiToJsonSchema
Parameters
abis: ValidationSchemaInput
Returns JsonSchema
fetchArrayElement
Parameters
data: unknown[]
level: number
Returns unknown
hexToNumber
Parameters
value: string
Returns number | bigint
numberToHex
Parameters
value: ValidInputTypes
Returns string
padLeft
Parameters
value: ValidInputTypes
characterAmount: number
optionalsign: string
Returns string
parseBaseType
Type parameters
- T = string
Parameters
type: string
Returns { arraySizes: number[]; baseType?: T; baseTypeSize: undefined | number; isArray: boolean }
arraySizes: number[]
optionalbaseType?: T
baseTypeSize: undefined | number
isArray: boolean
transformJsonDataToAbiFormat
Parameters
abis: FullValidationSchema
data: Record<string, unknown> | readonly unknown[]
optionaltransformedData: unknown[]
Returns unknown[]
Classes
Web3Validator
constructor
Returns Web3Validator
validate
Parameters
schema: ValidationSchemaInput
data: readonly unknown[]
optionaloptions: Web3ValidationOptions
Returns undefined | Web3ValidationErrorObject[]
validateJSONSchema
Parameters
schema: object
data: object
optionaloptions: Web3ValidationOptions
Returns undefined | Web3ValidationErrorObject[]
Web3ValidatorError
constructor
Parameters
errors: Web3ValidationErrorObject[]
Returns Web3ValidatorError
code
readonlyerrors
innerError
readonlyname
stack
toJSON
Returns { code: number; innerError: undefined | Error | Error[]; message: string; name: string }
code: number
innerError: undefined | Error | Error[]
message: string
name: string
staticconvertToString
Parameters
value: unknown
optionalunquotValue: boolean
Returns string
Type Aliases
EthBaseTypes
EthBaseTypesWithMeta
EthExtendedTypes
FullValidationSchema
JsonSchema
ShortValidationSchema
ValidInputTypes
ValidationSchemaInput
Web3ValidationErrorObject
Web3ValidationOptions
Type declaration
readonlysilent: boolean
Variables
constVALID_ETH_BASE_TYPES
constvalidator
Functions
checkAddressCheckSum
Parameters
data: string
Returns boolean
isAddress
Parameters
value: ValidInputTypes
optionalcheckChecksum: boolean
Returns boolean
isBigInt
Parameters
value: ValidInputTypes
Returns boolean
isBlockNumber
Parameters
value: string | number | bigint
Returns boolean
isBlockNumberOrTag
Parameters
value: string | number | bigint
Returns boolean
isBlockTag
Parameters
value: string
Returns boolean
isBloom
Parameters
bloom: ValidInputTypes
Returns boolean
isBoolean
Parameters
value: ValidInputTypes
Returns boolean
isBuffer
Parameters
data: ValidInputTypes
Returns boolean
isBytes
Parameters
value: Uint8Array | number[] | ValidInputTypes
optionaloptions: { abiType: string; size?: undefined } | { abiType?: undefined; size: number }
Returns boolean
isContractAddressInBloom
Parameters
bloom: string
contractAddress: string
Returns boolean
isFilterObject
Parameters
value: Filter
Returns boolean
isHex
Parameters
hex: ValidInputTypes
Returns boolean
isHexStrict
Parameters
hex: ValidInputTypes
Returns boolean
isHexString32Bytes
Parameters
value: string
optionalprefixed: boolean
Returns boolean
isHexString8Bytes
Parameters
value: string
optionalprefixed: boolean
Returns boolean
isInBloom
Parameters
bloom: string
value: string | Uint8Array
Returns boolean
isInt
Parameters
value: ValidInputTypes
optionaloptions: { abiType: string; bitSize?: undefined } | { abiType?: undefined; bitSize: number }
Returns boolean
isNullish
Parameters
item: unknown
Returns item is undefined | null
isNumber
Parameters
value: ValidInputTypes
Returns boolean
isObject
Parameters
item: unknown
Returns item is Record<string, unknown>
isString
Parameters
value: ValidInputTypes
Returns boolean
isTopic
Parameters
topic: string
Returns boolean
isTopicInBloom
Parameters
bloom: string
topic: string
Returns boolean
isUInt
Parameters
value: ValidInputTypes
optionaloptions: { abiType: string; bitSize?: undefined } | { abiType?: undefined; bitSize: number }
Returns boolean
isUserEthereumAddressInBloom
Parameters
bloom: string
ethereumAddress: string
Returns boolean
isValidEthBaseType
Parameters
type: string
Returns boolean