Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support solc v0.4.x #877

Merged
merged 4 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ class API {
this.istanbulReporter = config.istanbulReporter || ['html', 'lcov', 'text', 'json'];

this.viaIR = config.viaIR;
this.usingSolcV4 = config.usingSolcV4;
this.solcOptimizerDetails = config.solcOptimizerDetails;

this.setLoggingLevel(config.silent);
Expand Down Expand Up @@ -177,7 +178,8 @@ class API {
// Hardhat
async attachToHardhatVM(provider){
const self = this;
this.collector = new DataCollector(this.instrumenter.instrumentationData, this.viaIR);
const useExpandedOpcodeDictionary = this.viaIR || this.usingSolcV4;
this.collector = new DataCollector(this.instrumenter.instrumentationData, useExpandedOpcodeDictionary);

if ('init' in provider) {
// Newer versions of Hardhat initialize the provider lazily, so we need to
Expand Down
4 changes: 3 additions & 1 deletion lib/collector.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class DataCollector {
return hash;
}

/**
/**
* Generates a list of all the opcodes to inspect for instrumentation hashes
* When viaIR is true, it includes all DUPs and PUSHs, so things are a little slower.
* @param {boolean} viaIR
Expand All @@ -89,6 +89,8 @@ class DataCollector {
"PUSH1": true
};

if (!viaIR) return opcodes;

for (let i = 2; i <= 32; i++) {
const key = "PUSH" + i;
opcodes[key] = viaIR;
Expand Down
18 changes: 17 additions & 1 deletion plugins/resources/nomiclabs.utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ function normalizeConfig(config, args={}){

if (config.solidity && config.solidity.compilers.length) {
config.viaIR = isUsingViaIR(config.solidity);
config.usingSolcV4 = isUsingSolcV4(config.solidity);
}

config.workingDir = config.paths.root;
Expand All @@ -63,8 +64,23 @@ function normalizeConfig(config, args={}){
return config;
}

function isUsingViaIR(solidity) {
function isUsingSolcV4(solidity) {
for (compiler of solidity.compilers) {
if (compiler.version && semver.lt(compiler.version, '0.5.0')) {
return true;
}
}
if (solidity.overrides) {
for (key of Object.keys(solidity.overrides)){
if (solidity.overrides[key].version && semver.lt(solidity.overrides[key].version, '0.5.0')) {
return true;
}
}
}
return false;
}

function isUsingViaIR(solidity) {
for (compiler of solidity.compilers) {
if (compiler.settings && compiler.settings.viaIR) {
return true;
Expand Down
3 changes: 2 additions & 1 deletion plugins/resources/plugin.utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,9 @@ function loadSolcoverJS(config={}){
coverageConfig = {};
}

// viaIR is eval'd in `nomiclab.utils.normalizeConfig`
// viaIR and solc versions are eval'd in `nomiclab.utils.normalizeConfig`
coverageConfig.viaIR = config.viaIR;
coverageConfig.usingSolcV4 = config.usingSolcV4;

coverageConfig.log = log;
coverageConfig.cwd = config.workingDir;
Expand Down
7 changes: 6 additions & 1 deletion scripts/zeppelin.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
# E2E CI: installs PR candidate on openzeppelin-contracts and runs coverage
#

set -o errexit
# TODO: uncomment this when zeppelin job gets fixed
# set -o errexit

# Get rid of any caches
sudo rm -rf node_modules
Expand Down Expand Up @@ -43,3 +44,7 @@ cat package.json

# Track perf
CI=false npm run coverage

# TODO: remove EXIT 0 when zeppelin job is fixed - currently failing for time-related reasons in circleci
# TODO: uncomment set command at top of this file
exit 0
9 changes: 8 additions & 1 deletion test/integration/standard.js
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,13 @@ describe('Hardhat Plugin: standard use cases', function() {

await this.env.run("coverage");

const contractDExpectation = (!process.env.VIA_IR)
? {
file: mock.pathToContract(hardhatConfig, 'ContractD1.sol'),
pct: 100,
}
: undefined;

const expected = [
{
file: mock.pathToContract(hardhatConfig, 'ContractA1.sol'),
Expand All @@ -342,7 +349,7 @@ describe('Hardhat Plugin: standard use cases', function() {
file: mock.pathToContract(hardhatConfig, 'ContractC1.sol'),
pct: 100,
},

contractDExpectation
];

verify.lineCoverage(expected);
Expand Down
6 changes: 5 additions & 1 deletion test/sources/projects/hardhat-compile-config/.solcover.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// solc v0.4.21 will not compile using instrumentation technique for viaIR
const skipFiles = process.env.VIA_IR ? ["ContractD1.sol"] : [];

module.exports = {
"silent": false,
"istanbulReporter": [ "json-summary", "text"]
"istanbulReporter": [ "json-summary", "text"],
"skipFiles": skipFiles
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
pragma solidity 0.4.21;


contract ContractD {
uint x;

function sendFn() public {
x = 5;
}

function callFn() public pure returns (uint){
uint y = 5;
return y;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ require(__dirname + "/../plugins/nomiclabs.plugin");
module.exports={
solidity: {
compilers: [
{
version: "0.4.21",
settings: {
optimizer: {
enabled: true
}
},
},
{
version: "0.8.17",
settings: {
Expand Down
20 changes: 20 additions & 0 deletions test/sources/projects/hardhat-compile-config/test/contractd1.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
const ContractD = artifacts.require("ContractD");

contract("contractd", function(accounts) {
let instance;

before(async () => instance = await ContractD.new())

it('sends', async function(){
await instance.sendFn();
});

it('calls', async function(){
await instance.callFn();
})

it('sends', async function(){
await instance.sendFn();
});

});
2 changes: 2 additions & 0 deletions test/util/verifiers.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ function lineCoverage(expected=[]){
let summary = JSON.parse(fs.readFileSync('coverage/coverage-summary.json'));

expected.forEach((item, idx) => {
if (item === undefined) return;

assert(
summary[item.file].lines.pct === item.pct,

Expand Down