ECDSA: Workaround hardhat-gas-reporter bug #2970
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This version contains improvements from threshold-network/solidity-contracts#100 which help workaround problems with gas reporter.
There is a bug in hardhat-gas-reporter that we need to workaround in order to obtain gas report for tests: cgewecke/hardhat-gas-reporter#86 Long story short: we cannot use `hre.ethers` in the deployment script. Here we introduce an alternative deployment path just to get the report generated correctly. The alternative path usage is determined by `GAS_REPORTER_BUG_WORKAROUND` env property set to `true`. To run the tests with the alternative path to get the gas report execute `yarn test:gas-reporter-workaround`. It will execute the same test (upgrade tests were skipped as they are strictly related to the original deployment path). `yarn test` is still a preferred way to run the tests, as it does the deployment exactly the way we want it to test for mainnet. Use the alternative path only if you wish to get the gas report. Once a bug in the `hardhat-gas-reporter` is fixed, we should revert all the changes from this commit.
nkuba
changed the title
dimpar
reviewed
May 10, 2022
pdyraga
approved these changes
May 10, 2022
| We introduced an alternative deployment path as a workaround. | ||
| To execute tests with the alternative deployment path run `yarn test:gas-reporter-workaround`. | ||
| Please keep in mind that `yarn test` is preferred way for testing. Use alternative | ||
| path only if you want to get the gas report. |
There was a problem hiding this comment.
Can we clarify what are the differences between the alternative path and the default path?
My understanding is that the default one uses OpenZeppelin plugin for upgrades to deploy proxies and the alternative path is still deploying proxies but not using the OpenZeppelin plugin.
2 tasks
nkuba
added a commit
that referenced
this pull request
May 11, 2022
In #2970 we introduced a workaround for a bug in hardhat-gas-reporter plugin cgewecke/hardhat-gas-reporter#86. It turned out that there is a much simpler workaround, which is based on just removing `--deploy-fixture` flag. With the flag removed it is required that we load a global snapshot of the deployment (`deployments.fixture()`) instead of loading a specific tag (`deployments.fixture(<tag>)`. Which we do anyway after one of a recent code updates. We removed all the traces of the previous workaround.
pdyraga
added a commit
that referenced
this pull request
May 11, 2022
…orkaround Workaround hardhat-gas-reporter bug with removing --deploy-fixture In this PR we replace a previous workaround (#2970) for a bug in the hardhat-gas-reporter plugin (cgewecke/hardhat-gas-reporter#86). It turned out that there is a much simpler workaround, which is based on just removing --deploy-fixture flag. With the flag removed it is required that we load a global snapshot of the deployment (deployments.fixture()) instead of loading a specific tag (deployments.fixture(<tag>). Which we do anyway after one of a recent code updates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #2969 (draft until it's merged)
Refs #2955
There is a bug in
hardhat-gas-reporterthat we need to work around inorder to obtain a gas report for tests: cgewecke/hardhat-gas-reporter#86
Long story short: we cannot use
hre.ethersin the deployment scripts.Here we introduce an alternative deployment path just to get the report generated correctly. The alternative path usage is determined by the
GAS_REPORTER_BUG_WORKAROUNDenv property set totrue.To run the tests with the alternative path to get the gas report execute
yarn test:gas-reporter-workaroundcommand. It will execute the same tests (upgrade tests were skipped as they are strictly related to the original deployment path).yarn testis still a preferred way to run the tests, as it does the deployment exactly the way we want it to test for mainnet. Use the alternative path only if you wish to get the gas report.Once a bug in the
hardhat-gas-reporteris fixed, we should revert all the changes related to the workaround.