Util, Block: added generic error types like ValidationError, UsageError

packages/block/src/errors.ts

@@ -1,12 +1,29 @@
-import { EthereumJSError } from '@ethereumjs/util'
+import { UsageError, ValidationError } from '@ethereumjs/util'
 
-export enum HeaderValidationErrorCode {
+/**
+ * Always define error codes on the generic Util
+ * error class level (e.g. associated to `ValidationError`)
+ */
+export enum ValidationErrorCode {
   WRONG_TX_TRIE_LENGTH = 'WRONG_TX_TRIE_LENGTH',
 }
 
+/**
+ * Additional types extending the generic Util
+ * error types (e.g. `ValidationErrorType`)
+ */
 export type HeaderValidationErrorType = {
   block: string
   received: string
 }
+export type HeaderUsageErrorType = {
+  block: string
+}
 
-export class HeaderValidationError extends EthereumJSError<HeaderValidationErrorType> {}
+/**
+ * Dedicated error classes for the specific package,
+ * always to be subclassed from the generic Util error type
+ * classes (e.g. `ValidationError`, not: `EthereumJSError`)
+ */
+export class HeaderValidationError extends ValidationError<HeaderValidationErrorType> {}
+export class HeaderUsageError extends UsageError<HeaderUsageErrorType> {}

packages/block/src/header/header.ts

@@ -26,7 +26,7 @@ import {
   CLIQUE_EXTRA_VANITY,
   cliqueIsEpochTransition,
 } from '../consensus/clique.js'
-import { HeaderValidationError, HeaderValidationErrorCode } from '../errors.js'
+import { HeaderValidationError, ValidationErrorCode } from '../errors.js'
 import { fakeExponential } from '../helpers.js'
 import { paramsBlock } from '../params.js'
 
@@ -270,7 +270,7 @@ export class BlockHeader {
     if (transactionsTrie.length !== 32) {
       const e = new HeaderValidationError(
         'transactionsTrie must be 32 bytes',
-        HeaderValidationErrorCode.WRONG_TX_TRIE_LENGTH,
+        ValidationErrorCode.WRONG_TX_TRIE_LENGTH,
         {
           block: this.errorStr(),
           received: `${bytesToHex(transactionsTrie)} (${transactionsTrie.length} bytes)`,

packages/util/src/errors.ts

@@ -1,5 +1,5 @@
 /**
- * Generic EthereumJS error with metadata attached
+ * Generic EthereumJS error class with metadata attached
  *
  * Kudos to https://github.com/ChainSafe/lodestar monorepo
  * for the inspiration :-)
@@ -28,3 +28,21 @@ export class EthereumJSError<T extends {}> extends Error {
     }
   }
 }
+
+export type ValidationErrorType = {
+  received: string
+}
+
+/**
+ * Error along Object Validation
+ *
+ * Use directly or in a subclassed context for error comparison (`e instanceof ValidationError`)
+ */
+export class ValidationError<T extends ValidationErrorType> extends EthereumJSError<T> {}
+
+/**
+ * Error along API Usage
+ *
+ * Use directly or in a subclassed context for error comparison (`e instanceof UsageError`)
+ */
+export class UsageError<T extends {}> extends EthereumJSError<T> {}