v2.3.0 scripts: migrations, dry-run, detect changes #686

zajck · 2023-06-15T07:47:17Z

Changes in this PR:

updates script detect-changed-contracts.js to work when protocol versions from different tags use different compiler versions
adds migrate_2.3.0.js. NB: This is not the final version of the migration script. It will be adapted as part of v2.3.0 migration script and upgrade test #680 when other PRs are merged into the main. The parts that are common with migrate_2.2.1 will be refactored into util functions.
adds possibility to simulate the migration by adding --dry-run flag when executing migration command. If successful, it outputs the estimation of how much ether will be spent on fees.
updates the documentation. Closes Dry-run upgrade on forked network #681

coveralls · 2023-06-15T16:59:54Z

coverage: 99.708%. remained the same when pulling 9c01246 on scripts-v2.3.0 into 02a4d2f on main.

anajuliabit

I have some considerations

docs/local-development.md

docs/tasks.md

scripts/migrations/dry-run.js

scripts/migrations/migrate_2.3.0.js

scripts/util/detect-changed-contracts.js

anajuliabit

Looks good to me :)

anajuliabit

LGTM

levalleux-ludo · 2023-07-11T12:44:32Z

docs/local-development.md

+#### Using the migrations
+If you are testing an upgrade of official release, you can simply run
+```
+npx hardhat migrate version --network local --env ""


network localdoes not exist. Should be hardhat or localhost ??

use "<...>" notation to mean variable arguments (?)

Suggested change

npx hardhat migrate version --network local --env ""

npx hardhat migrate <version> --network localhost --env ""

good catch! localhost should be the correct value

levalleux-ludo · 2023-07-11T12:45:19Z

docs/local-development.md

 ### Upgrade clients
 To test the upgrade functionality, you first need to setup an upgrader account as described in section [Manage roles](local-development.md#optional-manage-roles)

 To perform the upgrade you then
 - Update some of the existing clients
- Run `npm run upgrade-clients:local`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.
+- Run `npm run upgrade-clients:local --new-version version`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.


missing -- separator between the npm run command and the arguments (otherwise the "--new-version" string is dropped from the command)

use "<...>" notation to mean variable arguments (?)

Suggested change

- Run `npm run upgrade-clients:local --new-version version`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.

- Run `npm run upgrade-clients:local -- --new-version <version>`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.

levalleux-ludo · 2023-07-11T13:02:09Z

docs/tasks.md

+
+To use them, execute the following command
+```
+npx hardhat migrate version --network network --env environment [--dry-run]


use "<...>" notation to mean variable arguments (?)

Suggested change

npx hardhat migrate version --network network --env environment [--dry-run]

npx hardhat migrate <version> --network <network> --env <environment> [--dry-run]

levalleux-ludo · 2023-07-11T13:02:33Z

docs/tasks.md

 ### Upgrade clients
 Upgrade existing clients (currently only BosonVoucher). Script deploys new implementation and updates address on beacon. 
 We provide different npm scripts for different use cases. A script for Hardhat network does not exist. Since contracts are discarded after the deployment, they cannot be upgraded. 
 For upgrade to succeed you need an account with UPGRADER role. Refer to [Manage roles](#manage-roles) to see how to grant it. 
 If you are not sure which contracts were changed since last deployment/upgrade, refer to [Detect changed contract](#detect-changed-contract) to see how to get the list of changed contracts.

 - **local network**. This upgrades the clients on a independent instance of local network (e.g. `npx hardhat node`). Upgrade process is described [here](local-development.md#upgrade-clients). 
-```npm run upgrade-clients:local```
+```npm run upgrade-clients:local --new-version version```


Suggested change

```npm run upgrade-clients:local --new-version version```

```npm run upgrade-clients:local --new-version <version>```

levalleux-ludo · 2023-07-11T13:02:43Z

docs/tasks.md

 - **internal test node**. This upgrades the clients on a custom test network. You need to modifiy `.env` with appropriate values for this to work. 
-```npm run upgrade-clients:test```
+```npm run upgrade-clients:test --new-version version```


Suggested change

```npm run upgrade-clients:test --new-version version```

```npm run upgrade-clients:test --new-version <version>```

levalleux-ludo · 2023-07-11T13:02:54Z

docs/tasks.md

-```npm run upgrade-clients:polygon:mumbai-test``` 
-```npm run upgrade-clients:polygon:mumbai-staging```
+```npm run upgrade-clients:polygon:mumbai-test --new-version version``` 
+```npm run upgrade-clients:polygon:mumbai-staging --new-version version```


Suggested change

```npm run upgrade-clients:polygon:mumbai-staging --new-version version```

```npm run upgrade-clients:polygon:mumbai-staging --new-version <version>```

levalleux-ludo · 2023-07-11T13:03:05Z

docs/tasks.md

 - **Polygon Mainnet**. This upgrades the clients on Polygon Mainnet. 
-```npm run upgrade-clients:polygon:mainnet```
+```npm run upgrade-clients:polygon:mainnet --new-version version```


Suggested change

```npm run upgrade-clients:polygon:mainnet --new-version version```

```npm run upgrade-clients:polygon:mainnet --new-version <version>```

levalleux-ludo · 2023-07-11T13:03:16Z

docs/tasks.md

 - **Ethereum Mainnet**. This upgrades the clients on Ethereum Mainnet. 
-```npm run upgrade-clients:ethereum:mainnet```
+```npm run upgrade-clients:ethereum:mainnet --new-version version```


Suggested change

```npm run upgrade-clients:ethereum:mainnet --new-version version```

```npm run upgrade-clients:ethereum:mainnet --new-version <version>```

levalleux-ludo · 2023-07-11T13:19:29Z

hardhat.config.js

+ ({ setupDryRun, getBalance } = await lazyImport(`./scripts/migrations/dry-run.js`));
+ ({ env, upgraderBalance: balanceBefore } = await setupDryRun(env));
+ } else {
+ process.exit();


If the dry-run option is not activated, the command does nothing (???)

levalleux-ludo · 2023-07-11T13:49:54Z

scripts/migrations/migrate_2.3.0.js

+ const { chainId } = await ethers.provider.getNetwork();
+ const contractsFile = readContracts(chainId, network, env);
+ if (contractsFile?.protocolVersion != "2.2.1") {
+ throw new Error("Current contract version must be 2.2.1");


This check should be done at the very beginning of the migrate function (before any change has been done on the repo), so that if the criteria is not met, the repo is not modified

I move to after the local changes checks otherwise, the version could be wrong if we only change the version locally.

anajuliabit · 2023-07-11T14:47:10Z

@levalleux-ludo applied all!

v2.3.0 scripts

04c4c0b

zajck self-assigned this Jun 15, 2023

zajck added 3 commits June 15, 2023 10:19

update documentation

8e6419d

Print out spent ether

ce3db33

EIP-1559 style fees

c5b2c6d

zajck marked this pull request as ready for review June 15, 2023 10:16

zajck added 2 commits June 15, 2023 12:47

Fix failing unit tests

de072d3

fix coverage

ee2f328

anajuliabit suggested changes Jun 16, 2023

View reviewed changes

zajck added 2 commits June 19, 2023 09:50

Apply suggestions from code review

c700221

Merge branch 'main' into scripts-v2.3.0

e7d2d27

zajck force-pushed the scripts-v2.3.0 branch from c05cba4 to e7d2d27 Compare June 19, 2023 07:50

Always install dependencies

5695bde

anajuliabit previously approved these changes Jun 20, 2023

View reviewed changes

zajck added the v2.3.0 label Jun 20, 2023

Merge branch 'main' into scripts-v2.3.0

1bacc7c

zajck dismissed anajuliabit’s stale review via 1bacc7c July 7, 2023 07:50

zajck and others added 6 commits July 7, 2023 11:07

fix "detect changed cpntracts"

ecd5399

fix dry-run setup

2dfa535

fix tests

b15a536

change gas used in tests

8f79778

Merge branch 'main' into scripts-v2.3.0

4361b47

fix tests

eedfe58

anajuliabit previously approved these changes Jul 10, 2023

View reviewed changes

levalleux-ludo requested changes Jul 11, 2023

View reviewed changes

Review changes

5b41b4b

anajuliabit dismissed their stale review via 5b41b4b July 11, 2023 14:46

anajuliabit requested a review from levalleux-ludo July 11, 2023 14:47

levalleux-ludo previously approved these changes Jul 11, 2023

View reviewed changes

anajuliabit dismissed levalleux-ludo’s stale review via c89c054 July 11, 2023 17:29

Fix ProtocolInitializationHandler

9c01246

anajuliabit force-pushed the scripts-v2.3.0 branch from c89c054 to 9c01246 Compare July 11, 2023 17:30

anajuliabit approved these changes Jul 11, 2023

View reviewed changes

levalleux-ludo approved these changes Jul 11, 2023

View reviewed changes

anajuliabit merged commit c1952c5 into main Jul 11, 2023
9 checks passed

zajck deleted the scripts-v2.3.0 branch September 13, 2023 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v2.3.0 scripts: migrations, dry-run, detect changes #686

v2.3.0 scripts: migrations, dry-run, detect changes #686

zajck commented Jun 15, 2023 •

edited

Loading

coveralls commented Jun 15, 2023 •

edited

Loading

anajuliabit left a comment

anajuliabit left a comment

anajuliabit left a comment

levalleux-ludo Jul 11, 2023

anajuliabit Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

levalleux-ludo Jul 11, 2023

anajuliabit Jul 11, 2023

levalleux-ludo Jul 11, 2023

anajuliabit Jul 11, 2023

anajuliabit commented Jul 11, 2023

	npx hardhat migrate version --network local --env ""
	npx hardhat migrate <version> --network localhost --env ""

	- Run `npm run upgrade-clients:local --new-version version`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.
	- Run `npm run upgrade-clients:local -- --new-version <version>`. This will deploy new clients and set implementation address on beacon. It also updates the existing addresses file `addresses/<chain-id>-<environment>.json` (for example `addresses/31337-localhost.json` if you are using a default local hardhat node) and outputs the upgrade log to the console.

	npx hardhat migrate version --network network --env environment [--dry-run]
	npx hardhat migrate <version> --network <network> --env <environment> [--dry-run]

	```npm run upgrade-clients:local --new-version version```
	```npm run upgrade-clients:local --new-version <version>```

	```npm run upgrade-clients:test --new-version version```
	```npm run upgrade-clients:test --new-version <version>```

	```npm run upgrade-clients:polygon:mumbai-staging --new-version version```
	```npm run upgrade-clients:polygon:mumbai-staging --new-version <version>```

	```npm run upgrade-clients:polygon:mainnet --new-version version```
	```npm run upgrade-clients:polygon:mainnet --new-version <version>```

	```npm run upgrade-clients:ethereum:mainnet --new-version version```
	```npm run upgrade-clients:ethereum:mainnet --new-version <version>```

v2.3.0 scripts: migrations, dry-run, detect changes #686

v2.3.0 scripts: migrations, dry-run, detect changes #686

Conversation

zajck commented Jun 15, 2023 • edited Loading

coveralls commented Jun 15, 2023 • edited Loading

anajuliabit left a comment

Choose a reason for hiding this comment

anajuliabit left a comment

Choose a reason for hiding this comment

anajuliabit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anajuliabit commented Jul 11, 2023

zajck commented Jun 15, 2023 •

edited

Loading

coveralls commented Jun 15, 2023 •

edited

Loading