Skip to content

various task template improvements #432

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 17, 2025
Merged

various task template improvements #432

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa1a655
add general note about VALIDATION.md files and also change task compl…
leopoldjoy Oct 13, 2025
359aef9
improve the validation file generation instructions in README.md foll…
leopoldjoy Oct 14, 2025
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
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Next, `cd` into the directory that was created for you and follow the steps list

> **👥 For Signers:** Please read the [Signer Guide](SIGNER.md) for step-by-step instructions on using the validation UI.

Please note, you will need to manually create validation file(s) for your task as they are bespoke to each task and therefore not created automatically as a part of the templates. We use one validation Markdown file per multisig involved in the task, so if there's only one multisig involved in your task, then you can simply create a `VALIDATION.md` file at the root of your task containing the validation instructions, while if there are multiple multisigs involved in the task, then create a `validations/` sub-directory at the root of your task containing the corresponding validation Markdown files. If you need examples to work from, you can browse through similar past tasks in this repo and adapt them to your specific task. Also, please note that we have tooling to generate these files (like the `task-signer-tool`) which removes the manual aspect of creating these validation files, we will soon update these instructions to reflect how this process can be automated.

## Directory structure

Each task will have a directory structure similar to the following:
Expand Down Expand Up @@ -92,7 +94,7 @@ This template is increasing the throughput on Base Chain.
1. Go to the folder that was created using the `make setup-gas-increase network=<network>` step
1. Fill in all TODOs (search for "TODO" in the folder) in the `.env` and `README` files. Tip: you can run `make deps` followed by `make sign-upgrade` to produce a Tenderly simulation which will help fill in several of the TODOs in the README (and also `make sign-rollback`).
1. Check in the task when it's ready to sign and collect signatures from signers
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.

## Using the fault proof upgrade template

Expand All @@ -108,7 +110,7 @@ This template is used to upgrade the fault proof contracts. This is commonly don
1. Build the contracts with `forge build`
1. Remove the unneeded validations from `VALIDATION.md` and update the relevant validations accordingly
1. Check in the task when it's ready to sign and collect signatures from signers
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.

## Using the swap owner template

Expand All @@ -122,7 +124,7 @@ This template is used to perform ownership management on a Gnosis Safe multisig,
1. Build the contracts with `forge build`.
1. Simulate the task with `make sign` and update the generic validations in `VALIDATION.md` with the real values.
1. Check in the task when it's ready to sign and request the facilitators to collect signatures from signers.
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.

## Using the funding template

Expand All @@ -137,7 +139,7 @@ This template is used to fund addresses from a Gnosis Safe.
1. Build the contracts with `forge build`.
1. Simulate the task with `make sign` and update the generic validations in `VALIDATION.md` with the real values.
1. Check in the task when it's ready to sign and request the facilitators to collect signatures from signers.
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.

## Using the Base Bridge set partner threshold template

Expand All @@ -153,7 +155,7 @@ This template is used to update the partner threshold in [Base Bridge](https://g
1. Build the contracts with `forge build`.
1. Generate the validation file for signers with `make gen-validation`.
1. Check in the task when it's ready to sign and request the facilitators to collect signatures from signers.
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.

## Using the pause Base Bridge template

Expand All @@ -169,4 +171,4 @@ This template is used to pause or un-pause [Base Bridge](https://github.com/base
1. Build the contracts with `forge build`.
1. Generate the validation file for signers with `make gen-validation`.
1. Check in the task when it's ready to sign and request the facilitators to collect signatures from signers.
1. Once executed, check in the records files and mark the task `DONE` in the README.
1. Once executed, check in the records files and mark the task `EXECUTED` in the README.