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

Command to scaffold a new task directory with required files #341

Open
mds1 opened this issue Oct 9, 2024 · 0 comments
Open

Command to scaffold a new task directory with required files #341

mds1 opened this issue Oct 9, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@mds1
Copy link
Contributor

mds1 commented Oct 9, 2024

There is no easy way to create new tasks. Add a command just new-task to the root justfile that takes the following arguments:

  1. L1 network short name. Allowed network names are currently eth, oeth, opsep, sep, and sep-dev-0. Unrecognized network names should error
  2. L2 network short name. Allowed network names are all short names from the superchain registry. Unrecognized network names should error
  3. Task name. This must be a hyphenated string such as fjord-gas-config or guardian-upgrade
  4. Task kind. Single or nested are the only allowed values for now. In the future we can expand this to other tasks, like presigned pauses, or the fault proof recovery template tasks.

The command should:

  • Create a folder called tasks/{arg1}/{arg2}-{x}-{arg3}, where arg1 and arg3 match the above arguments. arg2 matches the above argument but is omitted if the L2 network is OP Mainnet (this is the current convention). Lastly, x is the next incrementing number for that L2's task sequence. For example if mode-002-* is the most recent task for mode, the next task would have x as 003.
  • Create README.md and VALIDATION.md templates with placeholders for the user to fill out
  • Create a template input.json file
  • Create the appropriate SignFromJson.s.sol or NestedSignFromJson.s.sol with the appropriate imports, functions that need to be implemented, etc
  • A .env file (or equivalent if Remove hardcoded addresses #336 is done first)
@mds1 mds1 added the good first issue Good for newcomers label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Development

No branches or pull requests

1 participant