Skip to content

Commit 2781c13

Browse files
committed
add sections for safeharbor adoption
1 parent 161895d commit 2781c13

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

spell/spell-crafter-mainnet-workflow.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,14 @@ Repo: https://github.com/makerdao/spells-mainnet
125125
* [ ] Changes are tested via `testNewOrUpdatedChainlogValues`
126126
* [ ] Adjust system values, collateral values inside `config.sol`
127127
* [ ] Ensure every spell variable is declared as public/internal
128+
* Bug Bounty Registry Updates
129+
* [ ] Run `make update-bug-bounty` command in the `spells-mainnet` repo to check for bug bounty updates
130+
* [ ] IF the command outputs hex encoded calls:
131+
* [ ] Add ALL output calls to the spell using low-level Solidity calls
132+
* [ ] Each call MUST use the pattern: `(bool succ, bytes memory err) = AGREEMENT.call(<encodedDATA>);`
133+
* [ ] Ensure proper error handling after each call (e.g., `require(succ, "Bug bounty update failed");`)
134+
* [ ] Add comment above the bug bounty section: `// ----- Bug Bounty Registry Updates -----`
135+
* [ ] Include note: `// Note: Updates to bug bounty registry identified by make generate command`
128136
* Add specific tests in `DssSpell.t.sol` to have sufficient test coverage for every spell action
129137
* [ ] Test new collaterals
130138
* [ ] Test new ilk registry values
@@ -139,6 +147,9 @@ Repo: https://github.com/makerdao/spells-mainnet
139147
* [ ] Sanity checks of the constructor arguments
140148
* [ ] Sanity checks of all values added/updated by the spell function
141149
* [ ] End-to-end "happy path" interaction with the module
150+
* IF bug bounty updates are present
151+
* [ ] Test that all bug bounty registry calls execute successfully
152+
* [ ] Verify `make update-bug-bounty` returns empty diff in test environment after spell execution
142153
* [ ] Tests PASS via `make test`
143154
* [ ] Ensure `DssExecLib` address used in current spell (`DssExecLib.address`) matches `dss-exec-lib` [Latest Release Tag](https://github.com/makerdao/dss-exec-lib/releases/latest)
144155
* [ ] Push committed content to already opened PR

spell/spell-reviewer-mainnet-checklist.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,13 @@
272272
* [ ] Target contract is not upgradable
273273
* [ ] Target Contract is included in the ChainLog
274274
* [ ] Test Coverage is comprehensive
275+
* IF bug bounty registry updates are present
276+
* [ ] Run `make update-bug-bounty` command independently to verify required updates
277+
* [ ] Ensure ALL hex encoded calls from the command output are present in the spell
278+
* [ ] Verify each call uses the correct pattern: `(bool succ, bytes memory err) = AGREEMENT.call(<encodedDATA>);`
279+
* [ ] Cross-check that each `<encodedDATA>` exactly matches the script output
280+
* [ ] Confirm proper error handling is implemented for each call
281+
* [ ] Verify the bug bounty section has appropriate comments/documentation
275282
* IF spell interacts with ChainLog
276283
* [ ] ChainLog version is incremented based on update type
277284
* Major -> New Vat (++.0.0)
@@ -383,6 +390,7 @@ _Insert your local test logs here_
383390
* [ ] All actions are executed in the transaction trace
384391
* [ ] No reverts are present that block execution
385392
* [ ] No out-of-gas errors are present
393+
* [ ] Confirm `make update-bug-bounty` returns empty
386394
* Archive checks
387395
* [ ] `make diff-archive-spell` for current date or `make diff-archive-spell date="YYYY-MM-DD"`
388396
* [ ] Ensure date corresponds to target Exec Doc date

0 commit comments

Comments
 (0)