Skip to content

Commit 9d2bd87

Browse files
authored
[ethereum] Update receiver guardian set (#493)
* [ethereum] Update receiver guardian set * Remove the test vaa * Add docs + reformat * Empty commit to trigger CI
1 parent 99246c2 commit 9d2bd87

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

target-chains/ethereum/Deploying.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,24 @@ process described above. Please bump the version properly as described in [the s
121121
Anything other than the operations above will probably cause a collision. Please refer to Open Zeppelin Upgradeable
122122
(documentations)[https://docs.openzeppelin.com/upgrades-plugins/1.x/writing-upgradeable] for more information.
123123

124+
### Upgrading the Wormhole guardian set in the Wormhole receiver contracts
125+
126+
If the Wormhole guardian set is going to change, you need to update the guardian set in the Wormhole receiver
127+
contracts. You should do it before the guardians start publishing VAAs with the new guardian set and not earlier than 24 hours before that
128+
to avoid any possible downtime. After updating the guardian set there is a 24 hour windows that the contracts
129+
will accept VAAs from both the old and the new index. So, you will need to do it when you are certain that Guardians
130+
will start publishing with the new set soon.
131+
132+
To update the guardian set update the
133+
[`receiverSubmitGuardianSetUpgrades.js`](./scripts/receiverSubmitGuardianSetUpgrades.js) script and add the new VAA and comment out the previous upgrades.
134+
Then, run it like below on the networks with Wormhole receiver contract:
135+
136+
```
137+
npm run receiver-submit-guardian-sets -- --network <network>
138+
```
139+
140+
You should create a PR to add this VAA to the repo for future deployments on new networks with Wormhole receiver contract.
141+
124142
### Versioning
125143

126144
We use [Semantic Versioning](https://semver.org/) for our releases. When upgrading the contract, update the npm package version using

target-chains/ethereum/scripts/receiverSubmitGuardianSetUpgrades.js

Lines changed: 11 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)