Skip to content

Commit 5a1528b

Browse files
committed
addressed PR comments
1 parent 93cbffa commit 5a1528b

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

spell/spell-crafter-mainnet-workflow.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,14 @@ Repo: https://github.com/makerdao/spells-mainnet
126126
* [ ] Adjust system values, collateral values inside `config.sol`
127127
* [ ] Ensure every spell variable is declared as public/internal
128128
* Bug Bounty Registry Updates
129-
* [ ] Run `make safeharbor-generate` command in the `spells-mainnet` repo to check for bug bounty updates
130-
* [ ] IF the command outputs a solidity snippet:
131-
* [ ] Paste the generated code into the spell as is. The code should not be modified. You may adjust formatting.
132-
* [ ] Import the `AGREEMENT_ADDRESS` from the `ChainLog`
133-
* [ ] If not already present, add the helper function to perform the call, using the established archive pattern.
129+
* [ ] Check that output of make safeharbor-generate matches the instructions provided by Governance Facilitators
130+
* [ ] If no instructions were provided and script produces "no changes", then no further action is required
131+
* [ ] If there is a mismatch, crafter should notify Governance Facilitators
132+
* [ ] If the scripts outputs a warning indicated by ⚠️ ❗, notify Governance Facilitators.
133+
* [ ] If the command outputs a solidity snippet that matches the instructions provided by Governance Facilitators:
134+
* [ ] Paste the generated code into the spell as is. The code should not be modified. You may adjust formatting
135+
* [ ] Import the `AGREEMENT_ADDRESS` from the `ChainLog`
136+
* [ ] If not already present, add the helper function to perform the call, using the established archive pattern.
134137
* Add specific tests in `DssSpell.t.sol` to have sufficient test coverage for every spell action
135138
* [ ] Test new collaterals
136139
* [ ] Test new ilk registry values
@@ -225,7 +228,7 @@ Repo: https://github.com/makerdao/spells-mainnet
225228
* [ ] Create testnet and cast deployed spell there using `make cast-on-tenderly spell=0x...` command
226229
* [ ] Check that returned `public explorer url` is publicly accessible (e.g. using incognito browser mode)
227230
* [ ] IF `cast-on-tenderly` command is executed several times for the same spell, delete all testnets of the same name except the last one
228-
* [ ] Verify `make safeharbor-generate` returns empty diff in the casted environment after spell execution.
231+
* [ ] `make safeharbor-generate` returns empty diff in the testnet environment after spell was cast
229232
* [ ] Archive Spell via `make archive-spell` for the current date (or `make archive-spell date="YYYY-MM-DD"`) using Target Date inside the Exec Doc
230233
* [ ] Commit & push changes for review
231234
* [ ] Wait for CI to PASS

spell/spell-reviewer-mainnet-checklist.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -273,10 +273,12 @@
273273
* [ ] Target Contract is included in the ChainLog
274274
* [ ] Test Coverage is comprehensive
275275
* IF bug bounty registry updates are present
276-
* [ ] Run `make safeharbor-generate` command passing the calldata in the spell to check for it's validity.
277-
* [ ] Verify that the generated code exactly matches the generated code in the spell.
278-
* [ ] Ensure that `AGREEMENT_ADDRESS` is imported from the ChainLog.
279-
* [ ] Ensure that the helper function to perform the call is present and is implemented correctly.
276+
* [ ] Run `make safeharbor-generate`
277+
* [ ] Verify that the generated code exactly matches the code in the spell
278+
* [ ] Verify that output matches the instructions provided by Governance Facilitators
279+
* [ ] Ensure that the script does not output any warnings, which are indicated by ⚠️ ❗
280+
* [ ] Ensure that agreement address is fetched from the Chainlog
281+
* [ ] Ensure that the helper function to perform the call is present and is implemented using the established archive pattern
280282
* IF spell interacts with ChainLog
281283
* [ ] ChainLog version is incremented based on update type
282284
* Major -> New Vat (++.0.0)
@@ -388,7 +390,7 @@ _Insert your local test logs here_
388390
* [ ] All actions are executed in the transaction trace
389391
* [ ] No reverts are present that block execution
390392
* [ ] No out-of-gas errors are present
391-
* [ ] Confirm `make safeharbor-generate` returns "no updates"
393+
* [ ] `make safeharbor-generate` against the testnet returns "no updates"
392394
* Archive checks
393395
* [ ] `make diff-archive-spell` for current date or `make diff-archive-spell date="YYYY-MM-DD"`
394396
* [ ] Ensure date corresponds to target Exec Doc date

0 commit comments

Comments
 (0)