vm: improve runTx and evm debug logs (#1677)

Author: ryanio

packages/vm/src/evm/evm.ts

@@ -161,10 +161,11 @@ export default class EVM {
 
     let result
     if (this._vm.DEBUG) {
+      const { caller, gasLimit, to, value, delegatecall } = message
       debug(
-        `New message caller=${message.caller} gasLimit=${message.gasLimit} to=${
-          message.to ? message.to.toString() : ''
-        } value=${message.value} delegatecall=${message.delegatecall ? 'yes' : 'no'}`
+        `New message caller=${caller} gasLimit=${gasLimit} to=${
+          to?.toString() ?? 'none'
+        } value=${value} delegatecall=${delegatecall ? 'yes' : 'no'}`
       )
     }
     if (message.to) {
@@ -179,14 +180,11 @@ export default class EVM {
       result = await this._executeCreate(message)
     }
     if (this._vm.DEBUG) {
+      const { gasUsed, exceptionError, returnValue, gasRefund } = result.execResult
       debug(
-        `Received message results gasUsed=${result.gasUsed} execResult: [ gasUsed=${
-          result.gasUsed
-        } exceptionError=${
-          result.execResult.exceptionError ? result.execResult.exceptionError.toString() : ''
-        } returnValue=${short(result.execResult.returnValue)} gasRefund=${
-          result.execResult.gasRefund
-        } ]`
+        `Received message execResult: [ gasUsed=${gasUsed} exceptionError=${
+          exceptionError ? `'${exceptionError.error}'` : 'none'
+        } returnValue=0x${short(returnValue)} gasRefund=${gasRefund ?? 0} ]`
       )
     }
     const err = result.execResult.exceptionError
@@ -258,7 +256,7 @@ export default class EVM {
     if (errorMessage) {
       exit = true
       if (this._vm.DEBUG) {
-        debug(`Exit early on value tranfer overflowed`)
+        debug(`Exit early on value transfer overflowed`)
       }
     }
     if (exit) {
@@ -357,7 +355,7 @@ export default class EVM {
     if (errorMessage) {
       exit = true
       if (this._vm.DEBUG) {
-        debug(`Exit early on value tranfer overflowed`)
+        debug(`Exit early on value transfer overflowed`)
       }
     }
     if (exit) {

packages/vm/src/runTx.ts

@@ -53,7 +53,7 @@ export interface RunTxOpts {
 
   /**
    * If true, skips the validation of the tx's gas limit
-   * agains the block's gas limit.
+   * against the block's gas limit.
    */
   skipBlockGasLimitValidation?: boolean
 
@@ -395,22 +395,19 @@ async function _runTx(this: VM, opts: RunTxOpts): Promise<RunTxResult> {
       `Running tx=0x${
         tx.isSigned() ? tx.hash().toString('hex') : 'unsigned'
       } with caller=${caller} gasLimit=${gasLimit} to=${
-        to ? to.toString() : ''
+        to?.toString() ?? 'none'
       } value=${value} data=0x${short(data)}`
     )
   }
 
   const results = (await evm.executeMessage(message)) as RunTxResult
   if (this.DEBUG) {
+    const { gasUsed, exceptionError, returnValue, gasRefund } = results.execResult
     debug('-'.repeat(100))
     debug(
-      `Received tx results gasUsed=${results.gasUsed} execResult: [ gasUsed=${
-        results.gasUsed
-      } exceptionError=${
-        results.execResult.exceptionError ? results.execResult.exceptionError.error : ''
-      } returnValue=${short(results.execResult.returnValue)} gasRefund=${
-        results.execResult.gasRefund
-      } ]`
+      `Received tx execResult: [ gasUsed=${gasUsed} exceptionError=${
+        exceptionError ? `'${exceptionError.error}'` : 'none'
+      } returnValue=0x${short(returnValue)} gasRefund=${gasRefund ?? 0} ]`
     )
   }
 
@@ -423,7 +420,7 @@ async function _runTx(this: VM, opts: RunTxOpts): Promise<RunTxResult> {
     debug(`Generated tx bloom with logs=${results.execResult.logs?.length}`)
   }
 
-  // Caculate the total gas used
+  // Calculate the total gas used
   results.gasUsed.iadd(txBaseFee)
   if (this.DEBUG) {
     debugGas(`tx add baseFee ${txBaseFee} to gasUsed (-> ${results.gasUsed})`)
@@ -461,7 +458,7 @@ async function _runTx(this: VM, opts: RunTxOpts): Promise<RunTxResult> {
   // Update miner's balance
   let miner
   if (this._common.consensusType() === ConsensusType.ProofOfAuthority) {
-    // Backwards-compatibilty check
+    // Backwards-compatibility check
     // TODO: can be removed along VM v6 release
     if ('cliqueSigner' in block.header) {
       miner = block.header.cliqueSigner()