Skip to main content

web3-validator

Index

Type Aliases

EthBaseTypes

EthBaseTypes: bool | bytes | string | uint | int | address | tuple

EthBaseTypesWithMeta

EthBaseTypesWithMeta: `string${string}` | `string${string}[${number}]` | `bytes${string}` | `bytes${string}[${number}]` | `address[${number}]` | `bool[${number}]` | `int${string}` | `int${string}[${number}]` | `uint${string}` | `uint${string}[${number}]` | tuple[] | `tuple[${number}]`

EthExtendedTypes

EthExtendedTypes: hex | number | blockNumber | blockNumberOrTag | filter | bloom

FullValidationSchema

FullValidationSchema: ReadonlyArray<AbiParameter>

Json

Json: string | number | boolean | Json[] | {}

JsonSchema

JsonSchema: Schema

Schema

Schema: { $anchor?: string; $comment?: string; $defs?: {}; $id?: string; $recursiveAnchor?: boolean; $recursiveRef?: string; $ref?: string; $schema?: string; $vocabulary?: string; additionalItems?: Schema; additionalProperties?: Schema; allOf?: Schema[]; anyOf?: Schema[]; const?: Json; contains?: Schema; contentEncoding?: string; contentMediaType?: string; contentSchema?: Schema; default?: Json; definitions?: {}; dependencies?: {}; dependentRequired?: {}; dependentSchemas?: {}; deprecated?: boolean; description?: string; discriminator?: { mapping?: {}; propertyName: string }; divisibleBy?: number; else?: Schema; enum?: Json[]; eth?: string; examples?: Json[]; exclusiveMaximum?: number | boolean; exclusiveMinimum?: number | boolean; format?: string; id?: string; if?: Schema; items?: Schema | Schema[]; maxContains?: number; maxItems?: number; maxLength?: number; maxProperties?: number; maximum?: number; minContains?: number; minItems?: number; minLength?: number; minProperties?: number; minimum?: number; multipleOf?: number; not?: Schema; oneOf?: Schema[]; pattern?: string; patternProperties?: {}; properties?: {}; propertyNames?: Schema; readOnly?: boolean; required?: string[] | boolean; then?: Schema; title?: string; type?: string | string[]; unevaluatedItems?: Schema; unevaluatedProperties?: Schema; uniqueItems?: boolean; writeOnly?: boolean }

Type declaration

  • optional$anchor?: string
  • optional$comment?: string
  • optional$defs?: {}
  • optional$id?: string
  • optional$recursiveAnchor?: boolean
  • optional$recursiveRef?: string
  • optional$ref?: string
  • optional$schema?: string
  • optional$vocabulary?: string
  • optionaladditionalItems?: Schema
  • optionaladditionalProperties?: Schema
  • optionalallOf?: Schema[]
  • optionalanyOf?: Schema[]
  • optionalconst?: Json
  • optionalcontains?: Schema
  • optionalcontentEncoding?: string
  • optionalcontentMediaType?: string
  • optionalcontentSchema?: Schema
  • optionaldefault?: Json
  • optionaldefinitions?: {}
  • optionaldependencies?: {}
    • [id string]: string[] | Schema
  • optionaldependentRequired?: {}
    • [id string]: string[]
  • optionaldependentSchemas?: {}
  • optionaldeprecated?: boolean
  • optionaldescription?: string
  • optionaldiscriminator?: { mapping?: {}; propertyName: string }
    • optionalmapping?: {}
      • [value string]: string
    • propertyName: string
  • optionaldivisibleBy?: number
  • optionalelse?: Schema
  • optionalenum?: Json[]
  • optionalreadonlyeth?: string
  • optionalexamples?: Json[]
  • optionalexclusiveMaximum?: number | boolean
  • optionalexclusiveMinimum?: number | boolean
  • optionalformat?: string
  • optionalid?: string
  • optionalif?: Schema
  • optionalitems?: Schema | Schema[]
  • optionalmaxContains?: number
  • optionalmaxItems?: number
  • optionalmaxLength?: number
  • optionalmaxProperties?: number
  • optionalmaximum?: number
  • optionalminContains?: number
  • optionalminItems?: number
  • optionalminLength?: number
  • optionalminProperties?: number
  • optionalminimum?: number
  • optionalmultipleOf?: number
  • optionalnot?: Schema
  • optionaloneOf?: Schema[]
  • optionalpattern?: string
  • optionalpatternProperties?: {}
  • optionalproperties?: {}
  • optionalpropertyNames?: Schema
  • optionalreadOnly?: boolean
  • optionalrequired?: string[] | boolean
  • optionalthen?: Schema
  • optionaltitle?: string
  • optionaltype?: string | string[]
  • optionalunevaluatedItems?: Schema
  • optionalunevaluatedProperties?: Schema
  • optionaluniqueItems?: boolean
  • optionalwriteOnly?: boolean

ShortValidationSchema

ShortValidationSchema: ReadonlyArray<string | EthBaseTypes | EthExtendedTypes | EthBaseTypesWithMeta | ShortValidationSchema>

ValidInputTypes

ValidInputTypes: Uint8Array | bigint | string | number | boolean

ValidationError

ValidationError: ZodIssueBase

ValidationSchemaInput

Web3ValidationOptions

Web3ValidationOptions: { silent: boolean }

Type declaration

  • readonlysilent: boolean

Variables

constVALID_ETH_BASE_TYPES

VALID_ETH_BASE_TYPES: string[] = ...

constvalidator

validator: Web3Validator = ...