diff --git a/src.ts/utils/errors.ts b/src.ts/utils/errors.ts index 6cd53e830..32f20410b 100644 --- a/src.ts/utils/errors.ts +++ b/src.ts/utils/errors.ts @@ -61,11 +61,62 @@ function stringify(value: any): any { * All errors emitted by ethers have an **ErrorCode** to help * identify and coalesce errors to simplfy programatic analysis. * - * _property: ``"UNKNOWN_ERROR"`` - * This is a general puspose fallback when no other error makes sense - * or the error wasn't expected + * Each **ErrorCode** is the %%code%% proerty of a coresponding + * [[EthersError]]. * - * _property: ``"NOT_IMPLEMENTED"`` + * **Generic Errors** + * + * **``"UNKNOWN_ERROR"``** - see [[UnknownError]] + * + * **``"NOT_IMPLEMENTED"``** - see [[NotImplementedError]] + * + * **``"UNSUPPORTED_OPERATION"``** - see [[UnsupportedOperationError]] + * + * **``"NETWORK_ERROR"``** - see [[NetworkError]] + * + * **``"SERVER_ERROR"``** - see [[ServerError]] + * + * **``"TIMEOUT"``** - see [[TimeoutError]] + * + * **``"BAD_DATA"``** - see [[BadDataError]] + * + * **``"CANCELLED"``** - see [[CancelledError]] + * + * **Operational Errors** + * + * **``"BUFFER_OVERRUN"``** - see [[BufferOverrunError]] + * + * **``"NUMERIC_FAULT"``** - see [[NumericFaultError]] + * + * **Argument Errors** + * + * **``"INVALID_ARGUMENT"``** - see [[InvalidArgumentError]] + * + * **``"MISSING_ARGUMENT"``** - see [[MissingArgumentError]] + * + * **``"UNEXPECTED_ARGUMENT"``** - see [[UnexpectedArgumentError]] + * + * **``"VALUE_MISMATCH"``** - //unused// + * + * **Blockchain Errors** + * + * **``"CALL_EXCEPTION"``** - see [[CallExceptionError]] + * + * **``"INSUFFICIENT_FUNDS"``** - see [[InsufficientFundsError]] + * + * **``"NONCE_EXPIRED"``** - see [[NonceExpiredError]] + * + * **``"REPLACEMENT_UNDERPRICED"``** - see [[ReplacementUnderpricedError]] + * + * **``"TRANSACTION_REPLACED"``** - see [[TransactionReplacedError]] + * + * **``"UNCONFIGURED_NAME"``** - see [[UnconfiguredNameError]] + * + * **``"OFFCHAIN_FAULT"``** - see [[OffchainFaultError]] + * + * **User Interaction Errors** + * + * **``"ACTION_REJECTED"``** - see [[ActionRejectedError]] */ export type ErrorCode = @@ -462,7 +513,7 @@ export interface TransactionReplacedError extends EthersError<"TRANSACTION_REPLA * been configured. * * This could indicate an ENS name is unowned or that the current - * address being pointed to is the [[Zero]]. + * address being pointed to is the [[ZeroAddress]]. */ export interface UnconfiguredNameError extends EthersError<"UNCONFIGURED_NAME"> { /** @@ -558,7 +609,7 @@ export function isError>(erro } /** - * Returns true if %%error%% is a [CALL_EXCEPTION](api:CallExceptionError). + * Returns true if %%error%% is a [[CallExceptionError]. */ export function isCallException(error: any): error is CallExceptionError { return isError(error, "CALL_EXCEPTION");