Clean up logs / comments

Author: cgewecke

lib/api.js

@@ -93,8 +93,6 @@ class API {
           target.canonicalPath
         );
 
-        //console.log('instrumented.contract --> ' + instrumented.contract);
-
         this.coverage.addContract(instrumented, target.canonicalPath);
 
         outputs.push({

lib/collector.js

@@ -40,9 +40,7 @@ class DataCollector {
       if (this.validOpcodes[info.opcode.name] && info.stack.length > 0){
         const idx = info.stack.length - 1;
         let hash = '0x' +  info.stack[idx].toString(16);
-
         this._registerHash(hash)
-
       }
     } catch (err) { /*Ignore*/ };
   }
@@ -67,7 +65,7 @@ class DataCollector {
     hash = this._normalizeHash(hash);
 
     if(this.instrumentationData[hash]){
-      // abi.encode (used to circumvent viaIR) puts the hash on the stack twice
+      // abi.encode (used to circumvent viaIR) sometimes puts the hash on the stack twice
       if (this.lastHash !== hash) {
         this.lastHash = hash;
         this.instrumentationData[hash].hits++
@@ -76,7 +74,6 @@ class DataCollector {
     }
 
     // Detect and recover from viaIR mangled hashes by left-padding single `0`
-    // for some cases
     if(this.viaIR && hash.length === 18) {
       hash = hash.slice(2);
       hash = '0' + hash;
@@ -100,7 +97,7 @@ class DataCollector {
    * @return {String}       0x prefixed hash of length 18.
    */
   _normalizeHash(hash){
-    // viaIR sometimes zero right-pads the hashes out to 32bytes
+    // viaIR sometimes right-pads the hashes out to 32 bytes
     // but it doesn't preserve leading zeroes when it does this
     if (this.viaIR && hash.length >= 18) {
       hash = hash.slice(0,18);

lib/injector.js

@@ -54,10 +54,9 @@ class Injector {
     return `c_mod${web3Utils.keccak256(id).slice(2,10)}`
   }
 
-  // Way to get hash on the stack with viaIR (which seems to ignore abi.encode (v0.8.24))
-  // If you visiting solidity-coverage & understand what's happening here, please do not mention
-  // this obscure and irrelevant optimization opportunity in the issues at ethereum/solidity
-  _getAbiEncodeStatementHash(hash){
+  // Way to get hash on the stack with viaIR (which seems to ignore abi.encode builtin)
+  // Tested with v0.8.17, v0.8.24
+    _getAbiEncodeStatementHash(hash){
     return `abi.encode(${hash}); `
   }
 

package.json

@@ -1,4 +1,4 @@
- {
+{
   "name": "solidity-coverage",
   "version": "0.8.6",
   "description": "Code coverage for Solidity testing",

plugins/hardhat.plugin.js

@@ -52,16 +52,16 @@ subtask(TASK_COMPILE_SOLIDITY_GET_COMPILATION_JOB_FOR_FILE).setAction(async (_,
     if (settings.optimizer === undefined) {
       settings.optimizer = {};
     }
-
     // Unset useLiteralContent due to solc metadata size restriction
     settings.metadata.useLiteralContent = false;
 
     // Beginning with v0.8.7, we let the optimizer run if viaIR is true and
-    // instrument using `verbatim` YUL keyword. Otherwise turn the optimizer off.
+    // instrument using `abi.encode(bytes8 covHash)`. Otherwise turn the optimizer off.
     if (!settings.viaIR) settings.optimizer.enabled = false;
 
-    // This is fixes a stack too deep bug in ABIEncoderV2
-    // Experimental because not sure this works as expected across versions....
+    // This sometimes fixed a stack-too-deep bug in ABIEncoderV2 for coverage plugin versions up to 0.8.6
+    // Although issue should be fixed in 0.8.7, am leaving this option in because it may still be necessary
+    // to configure optimizer details in some cases.
     if (configureYulOptimizer) {
       if (optimizerDetails === undefined) {
         settings.optimizer.details = {

plugins/resources/nomiclabs.utils.js

@@ -36,9 +36,6 @@ function normalizeConfig(config, args={}){
     ? sources = path.join(config.paths.sources, args.sources)
     : sources = config.paths.sources;
 
-  //const { inspect } = require('util');
-  //console.log('config --> ' + inspect(config.solidity.compilers));
-
   if (config.solidity && config.solidity.compilers.length) {
     config.viaIR = isUsingViaIR(config.solidity);
   }

test/util/util.js

@@ -96,8 +96,6 @@ function instrumentAndCompile(sourceName, api={ config: {} }) {
   const instrumenter = new Instrumenter(api.config);
   const instrumented = instrumenter.instrument(contract, filePath);
 
-  //console.log('instrumented: --> ' + instrumented.contract);
-
   return {
     contract: contract,
     instrumented: instrumented,
@@ -121,9 +119,6 @@ function report(output=[]) {
 async function bootstrapCoverage(file, api, provider){
   const info = instrumentAndCompile(file, api);
 
-  const {inspect} = require('util');
-  //console.log('info --> ' + inspect(info.solcOutput));
-
   // Need to define a gasLimit for contract calls because otherwise ethers will estimateGas
   // and cause duplicate hits for everything
   info.gas = { gasLimit: 2_000_000 }