Skip to main content

errors

Index

Classes

Type Aliases

Variables

Classes

AbiError

AbiError:

Base class for Web3 errors.

constructor

  • new AbiError(message: string, props?: Record<string, unknown> & { name?: string }): AbiError
  • Parameters

    • message: string
    • optionalprops: Record<string, unknown> & { name?: string }

    Returns AbiError

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

readonlyprops

props: Record<string, unknown> & { name?: string }

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

abstractBaseWeb3Error

BaseWeb3Error:

Base class for Web3 errors.

constructor

  • new BaseWeb3Error(msg?: string, cause?: Error | Error[]): BaseWeb3Error
  • Parameters

    • optionalmsg: string
    • optionalcause: Error | Error[]

    Returns BaseWeb3Error

cause

cause: undefined | Error

abstractreadonlycode

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ChainIdMismatchError

ChainIdMismatchError:

Base class for Web3 errors.

constructor

  • new ChainIdMismatchError(value: { customChainId: unknown; txChainId: unknown }): ChainIdMismatchError
  • Parameters

    • value: { customChainId: unknown; txChainId: unknown }

    Returns ChainIdMismatchError

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ChainMismatchError

ChainMismatchError:

Base class for Web3 errors.

constructor

  • new ChainMismatchError(value: { baseChain: unknown; txChain: unknown }): ChainMismatchError
  • Parameters

    • value: { baseChain: unknown; txChain: unknown }

    Returns ChainMismatchError

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

CommonOrChainAndHardforkError

CommonOrChainAndHardforkError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConfigChainMismatchError

ConfigChainMismatchError:

Base class for Web3 errors.

constructor

  • Parameters

    • defaultHardfork: string
    • commonHardFork: string

    Returns ConfigChainMismatchError

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConfigHardforkMismatchError

ConfigHardforkMismatchError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConnectionCloseError

ConnectionCloseError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

optionalerrorCode

errorCode?: number

optionalerrorReason

errorReason?: string

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • errorCode: undefined | number
    • errorReason: undefined | string
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConnectionError

ConnectionError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

optionalerrorCode

errorCode?: number

optionalerrorReason

errorReason?: string

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • errorCode: undefined | number
    • errorReason: undefined | string
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConnectionNotOpenError

ConnectionNotOpenError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

optionalerrorCode

errorCode?: number

optionalerrorReason

errorReason?: string

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • errorCode: undefined | number
    • errorReason: undefined | string
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ConnectionTimeoutError

ConnectionTimeoutError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

duration

duration: number

optionalerrorCode

errorCode?: number

optionalerrorReason

errorReason?: string

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; duration: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; duration: number; errorCode: undefined | number; errorReason: undefined | string; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • duration: number
    • errorCode: undefined | number
    • errorReason: undefined | string
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractCodeNotStoredError

ContractCodeNotStoredError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

optionalreceipt

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string; receipt: undefined | TransactionReceipt }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string; receipt: undefined | TransactionReceipt }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string
    • receipt: undefined | TransactionReceipt

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractEventDoesNotExistError

ContractEventDoesNotExistError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

eventName

eventName: string

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; eventName: string; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; eventName: string; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • eventName: string
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractExecutionError

ContractExecutionError:

Used when an error is raised while executing a function inside a smart contract. The data is expected to be encoded according to EIP-848.

constructor

cause

code

code: number

readonlyname

name: string

optionalreceipt

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractInstantiationError

ContractInstantiationError:

Base class for Web3 errors.

constructor

  • Parameters

    • optionalmsg: string
    • optionalcause: Error | Error[]

    Returns ContractInstantiationError

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractMissingABIError

ContractMissingABIError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractMissingDeployDataError

ContractMissingDeployDataError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractNoAddressDefinedError

ContractNoAddressDefinedError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractNoFromAddressDefinedError

ContractNoFromAddressDefinedError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractOnceRequiresCallbackError

ContractOnceRequiresCallbackError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractReservedEventError

ContractReservedEventError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

type

type: string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string; type: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string; type: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string
    • type: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ContractTransactionDataAndInputError

ContractTransactionDataAndInputError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

EIP1193ProviderRpcError

EIP1193ProviderRpcError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

optionaldata

data?: unknown

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ENSCheckInterfaceSupportError

ENSCheckInterfaceSupportError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ENSNetworkNotSyncedError

ENSNetworkNotSyncedError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

ENSUnsupportedNetworkError

ENSUnsupportedNetworkError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

Eip1559GasPriceError

Eip1559GasPriceError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

Eip1559NotSupportedError

Eip1559NotSupportedError:

Base class for Web3 errors.

constructor

cause

cause: undefined | Error

code

code: number

readonlyname

name: string

stack

stack: undefined | string

innerError

  • get innerError(): undefined | Error | Error[]
  • set innerError(cause: undefined | Error | Error[]): void
  • @deprecated

    Use the cause property instead.


    Returns undefined | Error | Error[]

  • @deprecated

    Use the cause property instead.


    Parameters

    • cause: undefined | Error | Error[]

    Returns void

toJSON

  • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
  • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

    • cause: undefined | Error
    • code: number
    • innerError: undefined | Error
    • message: string
    • name: string

staticconvertToString

  • convertToString(value: unknown, unquotValue?: boolean): string
  • Parameters

    • value: unknown
    • optionalunquotValue: boolean

    Returns string

Eip838ExecutionError

Eip838ExecutionError:

This class is expected to be set as an cause inside ContractExecutionError The properties would be typically decoded from the data if it was encoded according to EIP-838

constructor

cause

cause: undefined | Eip838ExecutionError

code

code: number

optionaldata

data?: string

optionalerrorArgs

errorArgs?: {}

Type declaration

    optionalerrorName

    errorName?: string

    optionalerrorSignature

    errorSignature?: string

    readonlyname

    name: string

    optionalreceipt

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    setDecodedProperties

    • setDecodedProperties(errorName: string, errorSignature?: string, errorArgs?: {}): void
    • Parameters

      • errorName: string
      • optionalerrorSignature: string
      • optionalerrorArgs: {}

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Eip838ExecutionError; code: number; data: string; errorArgs?: {}; errorName?: string; errorSignature?: string; innerError: undefined | Eip838ExecutionError; message: string; name: string }
    • Returns { cause: undefined | Eip838ExecutionError; code: number; data: string; errorArgs?: {}; errorName?: string; errorSignature?: string; innerError: undefined | Eip838ExecutionError; message: string; name: string }

      • cause: undefined | Eip838ExecutionError
      • code: number
      • data: string
      • optionalerrorArgs?: {}
        • [x string]: unknown
      • optionalerrorName?: string
      • optionalerrorSignature?: string
      • innerError: undefined | Eip838ExecutionError
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    ExistingPluginNamespaceError

    ExistingPluginNamespaceError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    FormatterError

    FormatterError:

    Base class for Web3 errors.

    constructor

    • new FormatterError(msg?: string, cause?: Error | Error[]): FormatterError
    • Parameters

      • optionalmsg: string
      • optionalcause: Error | Error[]

      Returns FormatterError

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    HardforkMismatchError

    HardforkMismatchError:

    Base class for Web3 errors.

    constructor

    • new HardforkMismatchError(value: { commonHardfork: unknown; txHardfork: unknown }): HardforkMismatchError
    • Parameters

      • value: { commonHardfork: unknown; txHardfork: unknown }

      Returns HardforkMismatchError

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    HexProcessingError

    HexProcessingError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    IVLengthError

    IVLengthError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InternalError

    InternalError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    id

    jsonRpcError

    jsonrpc

    jsonrpc: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidAddressError

    InvalidAddressError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidBlockError

    InvalidBlockError:

    Base class for Web3 errors.

    constructor

    • Parameters

      • value: string

      Returns InvalidBlockError

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidBooleanError

    InvalidBooleanError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidBytesError

    InvalidBytesError:

    Base class for Web3 errors.

    constructor

    • Parameters

      • value: unknown

      Returns InvalidBytesError

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidClientError

    InvalidClientError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidConnectionError

    InvalidConnectionError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    optionalerrorCode

    errorCode?: number

    optionalerrorReason

    errorReason?: string

    host

    host: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; host: string; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; errorCode: undefined | number; errorReason: undefined | string; host: string; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • errorCode: undefined | number
      • errorReason: undefined | string
      • host: string
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidGasOrGasPrice

    InvalidGasOrGasPrice:

    Base class for Web3 errors.

    constructor

    • new InvalidGasOrGasPrice(value: { gas: undefined | string | number | bigint; gasPrice: undefined | string | number | bigint }): InvalidGasOrGasPrice
    • Parameters

      • value: { gas: undefined | string | number | bigint; gasPrice: undefined | string | number | bigint }

      Returns InvalidGasOrGasPrice

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidInputError

    InvalidInputError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    id

    jsonRpcError

    jsonrpc

    jsonrpc: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidIntegerError

    InvalidIntegerError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidKdfError

    InvalidKdfError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidLargeValueError

    InvalidLargeValueError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidMaxPriorityFeePerGasOrMaxFeePerGas

    InvalidMaxPriorityFeePerGasOrMaxFeePerGas:

    Base class for Web3 errors.

    constructor

    • new InvalidMaxPriorityFeePerGasOrMaxFeePerGas(value: { maxFeePerGas: undefined | string | number | bigint; maxPriorityFeePerGas: undefined | string | number | bigint }): InvalidMaxPriorityFeePerGasOrMaxFeePerGas
    • Parameters

      • value: { maxFeePerGas: undefined | string | number | bigint; maxPriorityFeePerGas: undefined | string | number | bigint }

      Returns InvalidMaxPriorityFeePerGasOrMaxFeePerGas

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidMethodParamsError

    InvalidMethodParamsError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    optionalhint

    hint?: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; hint: undefined | string; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; hint: undefined | string; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • hint: undefined | string
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidNonceOrChainIdError

    InvalidNonceOrChainIdError:

    Base class for Web3 errors.

    constructor

    • new InvalidNonceOrChainIdError(value: { chainId: undefined | string | number | bigint; nonce: undefined | string | number | bigint }): InvalidNonceOrChainIdError
    • Parameters

      • value: { chainId: undefined | string | number | bigint; nonce: undefined | string | number | bigint }

      Returns InvalidNonceOrChainIdError

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidNumberError

    InvalidNumberError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidNumberOfParamsError

    InvalidNumberOfParamsError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    expected

    expected: number

    got

    got: number

    method

    method: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; expected: number; got: number; innerError: undefined | Error; message: string; method: string; name: string }
    • Returns { cause: undefined | Error; code: number; expected: number; got: number; innerError: undefined | Error; message: string; method: string; name: string }

      • cause: undefined | Error
      • code: number
      • expected: number
      • got: number
      • innerError: undefined | Error
      • message: string
      • method: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidParamsError

    InvalidParamsError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    id

    jsonRpcError

    jsonrpc

    jsonrpc: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidPasswordError

    InvalidPasswordError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidPrivateKeyError

    InvalidPrivateKeyError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidPropertiesForTransactionTypeError

    InvalidPropertiesForTransactionTypeError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidProviderError

    InvalidProviderError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    clientUrl

    clientUrl: string

    code

    code: number

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; innerError: undefined | Error; message: string; name: string }

      • cause: undefined | Error
      • code: number
      • innerError: undefined | Error
      • message: string
      • name: string

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidRequestError

    InvalidRequestError:

    Base class for Web3 errors.

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    id

    jsonRpcError

    jsonrpc

    jsonrpc: string

    readonlyname

    name: string

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated

      Use the cause property instead.


      Parameters

      • cause: undefined | Error | Error[]

      Returns void

    toJSON

    • toJSON(): { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }
    • Returns { cause: undefined | Error; code: number; error: JsonRpcError<JsonRpcResult>; id: JsonRpcId; innerError: undefined | Error; jsonRpc: string; message: string; name: string }

    staticconvertToString

    • convertToString(value: unknown, unquotValue?: boolean): string
    • Parameters

      • value: unknown
      • optionalunquotValue: boolean

      Returns string

    InvalidResponseError

    InvalidResponseError<ErrorType, RequestType>:

    Base class for Web3 errors.


    Type parameters

    • ErrorType = unknown
    • RequestType = unknown

    constructor

    cause

    cause: undefined | Error

    code

    code: number

    optionaldata

    data?: ErrorType | ErrorType[]

    readonlyname

    name: string

    optionalrequest

    request?: JsonRpcBatchRequest | JsonRpcRequest<RequestType>

    stack

    stack: undefined | string

    innerError

    • get innerError(): undefined | Error | Error[]
    • set innerError(cause: undefined | Error | Error[]): void
    • @deprecated

      Use the cause property instead.


      Returns undefined | Error | Error[]

    • @deprecated