contracts: Make L2 genesis script configurable

[sebastianst]

Description

Makes the L2 genesis script configurable via two new env vars

• OUTPUT_MODE
  • none - no state dump file written, used in tests
  • latest - only dump state of latest fork
  • all - dump states of all forks (default)
• FORK - for fork selection (delta, ecotone,fjord or latest (default, always selects latest fork))

All generated devnet allocs now explicitly have their fork as suffix, also the latest (no suffix previously).

Still WIP:

• solidity documentation needs update

Additional context

The L2 genesis script before had the latest fork hardcoded.

Metadata

• Fixes https://github.com/ethereum-optimism/client-pod/issues/895

[semgrep-app]

Semgrep found 5 sol-style-return-arg-fmt findings:

• packages/contracts-bedrock/scripts/PeripheryDeployConfig.s.sol
  • L60 - Triage
  • L117 - Triage
  • L121 - Triage
• packages/contracts-bedrock/scripts/DeployPeriphery.s.sol
  • L450 - Triage
  • L459 - Triage

Named return arguments to functions must be appended with an underscore (_)

_{Ignore this finding from sol-style-return-arg-fmt.}

Semgrep found 1 golang_fmt_errorf_no_params finding:

• op-node/rollup/derive/engine_queue_test.go
  • L945 - Triage

No fmt.Errorf invocations without fmt arguments allowed

_{Ignore this finding from golang_fmt_errorf_no_params.}

Semgrep found 1 writable-filesystem-service finding:

• ufm-test-services/docker-compose.yml
  • L27 - Triage

Service 'grafana' is running with a writable root filesystem. This may allow malicious applications to download and run additional payloads, or modify container files. If an application inside a container has to save something temporarily consider using a tmpfs. Add 'read_only: true' to this service to prevent this.

_{Ignore this finding from writable-filesystem-service.}

Semgrep found 3 port-all-interfaces findings:

• ufm-test-services/docker-compose.yml
  • L8 - Triage
  • L18 - Triage
  • L31 - Triage

Service port is exposed on all interfaces

_{Ignore this finding from port-all-interfaces.}

Semgrep found 1 math-random-used finding:

• op-node/rollup/derive/engine_queue_test.go
  • L8 - Triage

Do not use math/rand. Use crypto/rand instead.

_{Ignore this finding from math-random-used.}

Semgrep found 1 todos_require_linear finding:

• op-node/rollup/derive/engine_queue.go
  • L635 - Triage

Please create a GitHub ticket for this TODO.

_{Ignore this finding from todos_require_linear.}

Semgrep found 1 missing-user finding:

• ufm-test-services/metamask/Dockerfile
  • L27 - Triage

By not specifying a USER, a program in the container may run as 'root'. This is a security hazard. If an attacker can control a process running as root, they may have control over the container. Ensure that the last USER in a Dockerfile is a USER other than 'root'.

_{Ignore this finding from missing-user.}

Semgrep found 1 err-todo finding:

• op-node/rollup/derive/engine_queue.go
  • L635 - Triage

TODO in error handling code

_{Ignore this finding from err-todo.}

[tynes]

These abstractions definitely look clean to me! I am wondering since because the deploy config has access to the fork offsets, we could simplify things and remove the need to configure the fork via env var and instead parse the forks that have a genesis offset of 0

I imagine this looking like in the deploy config:

fjordOffsetTimestamp = _envOr(json, "fjordOffsetTimestamp", type(uint256).max);

then you could have something like DeployConfig.latestFork() or something like that or isXYZ

Just suggesting this to reduce possible footguns. Besides that, this code is clean and well structured

[sebastianst]

@tynes thanks for the suggestion, implemented (hopefully something like) this in the 2nd commit. If the FORK env var is set, it takes precedent, otherwise the fork is read from the deploy config. If the deploy config isn't set either, it fails to run, which is probably good because if forces the user to actively think about which fork to set.

If the 2nd commit isn't going in the right direction or needs much more work, we can also split it out into a 2nd PR and get the 1st commit in so that the functionality for fork selection is already there. So chain providers asking for this already have something that works.

[sebastianst]

I should probably add some documentation about the new env vars.

[tynes]

I think there are some ways to simplify this, left comments, curious what you think @sebastianst

[tynes]

Looks like linting has failed

[tynes]

If you rebase on develop, then it will fix ci/circleci: sdk-tests