block -> error handling: added BlockHeader._error() helper function to annotate errors

Author: holgerd77

packages/block/src/block.ts

@@ -263,7 +263,8 @@ export class Block {
   async validateData(): Promise<void> {
     const txErrors = this.validateTransactions(true)
     if (txErrors.length > 0) {
-      throw new Error(`invalid transactions: ${txErrors.join(' ')}`)
+      const msg = `invalid transactions: ${txErrors.join(' ')}`
+      throw this.header._error(msg)
     }
 
     const validateTxTrie = await this.validateTransactionsTrie()
@@ -358,6 +359,16 @@ export class Block {
     }
   }
 
+  /**
+   * Internal helper function to create an annotated error message
+   *
+   * @param msg Base error message
+   * @hidden
+   */
+  _error(msg: string) {
+    return this.header._error(msg)
+  }
+
   /**
    * The following rules are checked in this method:
    * Uncle Header is a valid header.

packages/block/src/header.ts

@@ -46,6 +46,7 @@ export class BlockHeader {
   public readonly nonce: Buffer
 
   public readonly _common: Common
+  public _errorPostfix = ''
 
   public static fromHeaderData(headerData: HeaderData = {}, opts?: BlockOptions) {
     const {
@@ -245,6 +246,10 @@ export class BlockHeader {
       this.extraData = this.cliqueSealBlock(options.cliqueSigner)
     }
 
+    this._errorPostfix = `block number=${this.number.toNumber()} hash=${this.hash().toString(
+      'hex'
+    )}`
+
     const freeze = options?.freeze ?? true
     if (freeze) {
       Object.freeze(this)
@@ -451,46 +456,41 @@ export class BlockHeader {
       return
     }
     const hardfork = this._getHardfork()
-    const errorPostfix = `(block number=${this.number.toNumber()} hash=${this.hash().toString(
-      'hex'
-    )})`
     if (this._common.consensusAlgorithm() !== 'clique') {
       if (
         this.extraData.length > this._common.paramByHardfork('vm', 'maxExtraDataSize', hardfork)
       ) {
-        throw new Error('invalid amount of extra data')
+        const msg = 'invalid amount of extra data'
+        throw this._error(msg)
       }
     } else {
       const minLength = CLIQUE_EXTRA_VANITY + CLIQUE_EXTRA_SEAL
       if (!this.cliqueIsEpochTransition()) {
         // ExtraData length on epoch transition
         if (this.extraData.length !== minLength) {
-          throw new Error(
-            `extraData must be ${minLength} bytes on non-epoch transition blocks, received ${this.extraData.length} bytes ${errorPostfix}`
-          )
+          const msg = `extraData must be ${minLength} bytes on non-epoch transition blocks, received ${this.extraData.length} bytes`
+          throw this._error(msg)
         }
       } else {
         const signerLength = this.extraData.length - minLength
         if (signerLength % 20 !== 0) {
-          throw new Error(
-            `invalid signer list length in extraData, received signer length of ${signerLength} (not divisible by 20) ${errorPostfix}`
-          )
+          const msg = `invalid signer list length in extraData, received signer length of ${signerLength} (not divisible by 20)`
+          throw this._error(msg)
         }
         // coinbase (beneficiary) on epoch transition
         if (!this.coinbase.isZero()) {
-          throw new Error(
-            `coinbase must be filled with zeros on epoch transition blocks, received ${this.coinbase.toString()} ${errorPostfix}`
-          )
+          const msg = `coinbase must be filled with zeros on epoch transition blocks, received ${this.coinbase.toString()}`
+          throw this._error(msg)
         }
       }
       // MixHash format
       if (!this.mixHash.equals(Buffer.alloc(32))) {
-        throw new Error(
-          `mixHash must be filled with zeros, received ${this.mixHash} ${errorPostfix}`
-        )
+        const msg = `mixHash must be filled with zeros, received ${this.mixHash}`
+        throw this._error(msg)
       }
       if (!this.validateCliqueDifficulty(blockchain)) {
-        throw new Error(`invalid clique difficulty ${errorPostfix}`)
+        const msg = `invalid clique difficulty`
+        throw this._error(msg)
       }
     }
 
@@ -722,6 +722,18 @@ export class BlockHeader {
     }
   }
 
+  /**
+   * Internal helper function to create an annotated error message
+   *
+   * @param msg Base error message
+   * @hidden
+   */
+  _error(msg: string) {
+    msg += ` (${this._errorPostfix})`
+    const e = new Error(msg)
+    return e
+  }
+
   private _getHardfork(): string {
     return this._common.hardfork() || this._common.activeHardfork(this.number.toNumber())
   }

packages/block/test/header.spec.ts

@@ -139,7 +139,7 @@ tape('[Block]: Header functions', function (t) {
       await header.validate(blockchain)
       st.fail(testCase)
     } catch (error) {
-      st.equal(error.message, 'invalid amount of extra data', testCase)
+      st.ok(error.message.includes('invalid amount of extra data'), testCase)
     }
 
     // PoA