TransactionRevertWithCustomError <ReceiptType>

This error is used when a transaction to a smart contract fails and a custom user error (https://blog.soliditylang.org/2021/04/21/custom-errors/) is able to be parsed from the revert reason

Hierarchy

• TransactionRevertInstructionError<ReceiptType>
  • TransactionRevertWithCustomError

Index

Constructors

• constructor

Properties

• cause
• code
• customErrorArguments
• customErrorDecodedSignature
• customErrorName
• data
• name
• reason
• receipt
• signature
• stack

Accessors

• innerError

Methods

• toJSON
• convertToString

Constructors

publicconstructor

• new TransactionRevertWithCustomError<ReceiptType>(reason: string, customErrorName: string, customErrorDecodedSignature: string, customErrorArguments: Record<string, unknown>, signature?: string, receipt?: ReceiptType, data?: string): TransactionRevertWithCustomError<ReceiptType>

• Overrides TransactionRevertInstructionError.constructor

  Type parameters

  • ReceiptType = TransactionReceipt

  Parameters

  • reason: string

  • customErrorName: string

  • customErrorDecodedSignature: string

  • customErrorArguments: Record<string, unknown>

  • optionalsignature: string

  • optionalreceipt: ReceiptType

  • optionaldata: string

  Returns TransactionRevertWithCustomError<ReceiptType>

Properties

publiccause

cause: undefined | Error

Inherited from TransactionRevertInstructionError.cause

publiccode

code: number = ERR_TX_REVERT_TRANSACTION_CUSTOM_ERROR

Overrides TransactionRevertInstructionError.code

publiccustomErrorArguments

customErrorArguments: Record<string, unknown>

publiccustomErrorDecodedSignature

customErrorDecodedSignature: string

publiccustomErrorName

customErrorName: string

publicoptionaldata

data?: string

Inherited from TransactionRevertInstructionError.data

publicreadonlyname

name: string

Inherited from TransactionRevertInstructionError.name

publicreason

reason: string

Inherited from TransactionRevertInstructionError.reason

publicoptionalreceipt

receipt?: ReceiptType

Inherited from TransactionRevertInstructionError.receipt

publicoptionalsignature

signature?: string

Inherited from TransactionRevertInstructionError.signature

publicstack

stack: undefined | string

Inherited from TransactionRevertInstructionError.stack

Accessors

publicinnerError

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

• Inherited from TransactionRevertInstructionError.innerError

  @deprecated

  Use the cause property instead.

  ---

  Returns undefined | Error | Error[]

• Inherited from TransactionRevertInstructionError.innerError

  @deprecated

  Use the cause property instead.

  ---

  Parameters

  • cause: undefined | Error | Error[]

  Returns void

Methods

publictoJSON

• toJSON(): { cause: undefined | Error; code: number; customErrorArguments: Record<string, unknown>; customErrorDecodedSignature: string; customErrorName: string; data: undefined | string; innerError: undefined | Error; message: string; name: string; reason: string; receipt: undefined | ReceiptType; signature: undefined | string }

• Overrides TransactionRevertInstructionError.toJSON

  Returns { cause: undefined | Error; code: number; customErrorArguments: Record<string, unknown>; customErrorDecodedSignature: string; customErrorName: string; data: undefined | string; innerError: undefined | Error; message: string; name: string; reason: string; receipt: undefined | ReceiptType; signature: undefined | string }

  • cause: undefined | Error

  • code: number

  • customErrorArguments: Record<string, unknown>

  • customErrorDecodedSignature: string

  • customErrorName: string

  • data: undefined | string

  • innerError: undefined | Error

  • message: string

  • name: string

  • reason: string

  • receipt: undefined | ReceiptType

  • signature: undefined | string

publicstaticconvertToString

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

• Inherited from TransactionRevertInstructionError.convertToString

  Parameters

  • value: unknown

  • unquotValue: boolean = false

  Returns string