Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document foundry version #44

Merged
merged 6 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ collaterals
config
configs
Crafter
Crafter's
cron
CUs
DAI
Expand Down
13 changes: 11 additions & 2 deletions spell/spell-crafter-mainnet-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ Repo: https://github.com/makerdao/spells-mainnet

## Development Stage

* Install stable Foundry version
* [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now
* [ ] Insert the release URL here:
* [ ] Install the specified version via `foundryup --version git_tag_name`
```
Document the installation logs containing installed versions below:
```
* Create new branch
* [ ] Pull `master` branch of the `spells-mainnet` repo locally
* [ ] Create a new branch named `YYYY-MM-DD` using the _initial_ target date of the spell
Expand All @@ -58,7 +65,6 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] Keep all tests that are already skipped (e.g. `testOSMs`, `testMedianizers`)
* [ ] Remove unused interface declarations
* Ensure correctness of the cleanup
* [ ] Ensure to use latest `foundry` stable version by running `foundryup`
* [ ] Run Tests `make test` (or `make test match=<test_name>` to inspect debug traces)
* Add comments to the spell based on the relevant [Exec Sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw)
* [ ] Copy every _Section text_ from the Exec Sheet as comment to the spell code
Expand Down Expand Up @@ -210,7 +216,10 @@ Repo: https://github.com/makerdao/spells-mainnet
* [ ] 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
* [ ] Commit & push changes for review
* [ ] Wait for CI to PASS
* [ ] Post a comment inside the PR containing links to the deployed spell and Tenderly Testnet
* [ ] Post a comment inside the PR containing:
* Foundry installation logs containing installed versions (from above)
* A link to the deployed spell
* A link to the created Tenderly Testnet
* [ ] Notify the reviewers (e.g. "the spell was deployed")

## Handover and Merge Stage
Expand Down
13 changes: 12 additions & 1 deletion spell/spell-reviewer-mainnet-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## Development Stage

* Install stable Foundry version
* [ ] Find the first [Foundry release](https://github.com/foundry-rs/foundry/releases) that is older than 7 days from now
* [ ] Insert the release URL here:
* [ ] Install the specified version via `foundryup --version git_tag_name`
```
Document the installation logs containing installed versions below:
```
* Preparation
* [ ] Exec Sheet for the specified date is found in the ["Executive Vote Implementation Process" google sheet](https://docs.google.com/spreadsheets/d/1w_z5WpqxzwreCcaveB2Ye1PP5B8QAHDglzyxKHG3CHw)
_Insert URL to the specific sheet here_
Expand Down Expand Up @@ -29,7 +36,6 @@
* `// Forum:` if URL starts with `https://forum.makerdao.com/t/`
* `// MIP:` if URL starts with `https://mips.makerdao.com/mips/details/`
* Dependency checks
* [ ] Update Foundry by running `foundryup`
* [ ] Reinstall libraries by running `rm -rf ./lib && git submodule update --init --recursive`
```bash
Insert checked out submodule paths here
Expand Down Expand Up @@ -364,6 +370,11 @@ _Insert your local test logs here_

## Deployed Stage

* Crafter's comment in the PR
* [ ] Contains relevant Foundry installation logs
* [ ] Contains a URL to the deployed spell
* [ ] URL matches the spell address declared in `config.sol`
* [ ] Contains a URL to the Tenderly Testnet
* Source code settings
* [ ] Deployed spell is verified on etherscan
* [ ] Optimization enabled: `false` UNLESS the contract size is too big AND all mitigation strategies (i.e.: removing revert strings) have failed
Expand Down