Skip to content

Commit 9902cd7

Browse files
Address review and add other changes
1 parent a85c611 commit 9902cd7

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

spell/spell-crafter-mainnet-workflow.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Repo: https://github.com/sky-ecosystem/spells-mainnet
3737
* Install stable Foundry version
3838
* [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now
3939
* [ ] Insert the release URL here:
40-
* [ ] Install the specified version via `foundryup --version git_tag_name`
40+
* [ ] Install the specified version via `foundryup --install stable`
4141
```
4242
Document the installation logs containing installed versions below:
4343
```
@@ -96,7 +96,7 @@ Repo: https://github.com/sky-ecosystem/spells-mainnet
9696
* IF some actions require using interfaces
9797
* [ ] Prefer using `DssExecLib` actions where possible (to avoid adding interfaces where not required)
9898
* [ ] Avoid multi-import layout / importing from `Interfaces.sol` (see [issue #69](https://github.com/sky-ecosystem/dss-interfaces/issues/69))
99-
* [ ] Prefer single import layout (e.g. `import { VatAbstract } from "dss-interfaces/dss/VatAbstract.sol";`)
99+
* [ ] Prefer single import layout (e.g. `import {VatAbstract} from "dss-interfaces/dss/VatAbstract.sol";`)
100100
* [ ] Use static interfaces IF not present in `dss-interfaces` OR present in `dss-interfaces` but outdated OR only a few function interfaces are needed
101101
* IF new collateral is onboarded
102102
* Deploy `Join` contract (check which one is required)
@@ -124,7 +124,8 @@ Repo: https://github.com/sky-ecosystem/spells-mainnet
124124
* Minor -> Core Module (DSS) Update (e.g. Flapper) (0.++.0)
125125
* Patch -> Collateral addition or addition/modification (0.0.++)
126126
* [ ] New addresses are added to the `addresses_mainnet.sol`
127-
* [ ] Changes are tested via `testNewOrUpdatedChainlogValues`
127+
* [ ] Additions are tested via `testAddedChainlogKeys`
128+
* [ ] Removals are tested via `testRemovedChainlogKeys`
128129
* [ ] Adjust system values, collateral values inside `config.sol`
129130
* [ ] Ensure every spell variable is declared as public/internal
130131
* Add specific tests in `DssSpell.t.sol` to have sufficient test coverage for every spell action

spell/spell-reviewer-mainnet-checklist.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Mainnet Executive Spell Review Checklist
22

3+
Repo: https://github.com/sky-ecosystem/spells-mainnet
4+
35
## Development Stage
46

57
* Install stable Foundry version
68
* [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now
79
* [ ] Insert the release URL here:
8-
* [ ] Install the specified version via `foundryup --version git_tag_name`
10+
* [ ] Install the specified version via `foundryup --install stable`
911
```
1012
Document the installation logs containing installed versions below:
1113
```
@@ -49,7 +51,7 @@
4951
* IF interfaces are present in the spell
5052
* Interfaces imported from `dss-interfaces`
5153
* [ ] No unused `dss-interfaces`
52-
* [ ] Only single import layout is used (e.g. `import { VatAbstract } from "dss-interfaces/dss/VatAbstract.sol";`)
54+
* [ ] Only single import layout is used (e.g. `import {VatAbstract} from "dss-interfaces/dss/VatAbstract.sol";`)
5355
* Static Interfaces
5456
* [ ] No unused static interfaces
5557
* [ ] Declared static interface not present in the `dss-interfaces`, OTHERWISE should be imported from there
@@ -200,7 +202,7 @@
200202
* [ ] Recipient address variable name matches one found in `addresses_wallets.sol`
201203
* [ ] Transfer amount matches Exec Sheet
202204
* [ ] Transfer amount is specified with (at least) 2 decimals using `ether` keyword
203-
* [ ] IF `ether` keyword is used, comment is present on the same line `// Note: ether is a keyword helper, only MKR is transferred here`
205+
* [ ] IF `ether` keyword is used, comment is present on the same line `// Note: ether is a keyword that represents 10**18, not the ETH token`
204206
* [ ] The transfers are tested via `testPayments` test
205207
* [ ] Sum of all MKR transfers tested in `testPayments` matches number in the Exec Sheet
206208
* IF `SKY` transfers are present
@@ -231,7 +233,7 @@
231233
* [ ] `usr` address in the instruction is in the checksummed format
232234
* [ ] `usr` address variable name match one found in `addresses_wallets.sol`
233235
* [ ] `tot` (Total stream amount) matches Exec Sheet
234-
* [ ] IF `ether` keyword is used, comment is present on the same line `// Note: ether is a keyword helper, only MKR is transferred here`
236+
* [ ] IF `ether` keyword is used, comment is present on the same line `// Note: ether is a keyword that represents 10**18, not the ETH token`
235237
* [ ] IF vest amount is expressed in 'per year' or similar in the Exec Sheet, account for leap days
236238
* [ ] `bgn` (Vest start timestamp) matches Exec Sheet
237239
* [ ] `tau` is expressed as `fin - bgn` (i.e. `MONTH_DD_YYYY - MONTH_DD_YYYY`)
@@ -274,12 +276,12 @@
274276
* [ ] `MCD_VEST_DAI` chainlog address is used for DAI stream `yank`
275277
* [ ] `MCD_VEST_USDS` chainlog address is used for USDS stream `yank`
276278
* [ ] Tested via:
277-
* `testYankDAI`
278-
* `testYankMKR`
279-
* `testYankSky`
280-
* `testYankSkyMint`
281-
* `testYankUsds`
282-
* `testYankSpk`
279+
* `testVestDai`
280+
* `testVestMkr`
281+
* `testVestSky`
282+
* `testVestSkyMint`
283+
* `testVestUsds`
284+
* `testVestSpk`
283285
* IF SubDAO-related content is present
284286
* IF SubDAO provides SubProxy spell address
285287
* [ ] SubDAO spell address matches Exec Sheet
@@ -317,7 +319,7 @@
317319
* Minor -> Core Module (DSS) Update (e.g. Flapper) (0.++.0)
318320
* Patch -> Collateral addition or addition/modification (0.0.++)
319321
* [ ] New addresses are added to the `addresses_mainnet.sol`
320-
* [ ] Changes are tested via `testChainlogIntegrity` and `testChainlogValues`
322+
* [ ] Changes are tested via `testChainlogIntegrity`, `testChainlogValues`, `testAddedChainlogKeys` and `testRemovedChainlogKeys`
321323
* [ ] Ensure every spell variable is declared as `public`/`internal`
322324
* [ ] Ensure `immutable` visibility is only used when fetching addresses from the `ChainLog` via `DssExecLib.getChangelogAddress(key)` and `constant` is used instead for static addresses
323325
* [ ] Fetch addresses as type `address` and wrap with `Like` suffix interfaces inline (when making calls), UNLESS archive patterns permit otherwise (Such as `MKR`)

0 commit comments

Comments
 (0)