docs
docs copied to clipboard
ethereum-optimism
Add tutorial for devnet
Deploy Preview for docs-optimism ready!
| Name | Link |
|---|---|
| Latest commit | 645585402dc44a80a7bf6ed47a87f8ba8096f327 |
| Latest deploy log | https://app.netlify.com/sites/docs-optimism/deploys/673eca2f6220830008cb51a5 |
| Deploy Preview | https://deploy-preview-914--docs-optimism.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Found this when looking for the latest devnet deployment info :) Apologies if I'm jumping the gun here on the draft PR, I'm deep in debugging some devnet sequencer issues and switching to the new method looked like the best option.
This tutorial seems to fail for me. I tried it on both Mac and Linux, on Mac using Orbstack + Homebrew Docker/Kurtosis and on Linux using an Ubuntu-based GitHub Codespace. Both fail with the same error, so I don't believe it's related to the local environment.
Here are the logs from the GitHub Codespace instance: Kurtosis Error:
kurtosis run github.com/ethpandaops/ethereum-package --args-file ./network-config.yml
The Kurtosis CLI collects user metrics by default. These metrics are anonymized, private & obfuscated. These metrics help us better understand what features are used, what features to invest in and what features might be buggy.
In case you wish to not send metrics, you can do so by running - kurtosis analytics disable
Read more at https://docs.kurtosis.com/advanced-concepts/metrics-philosophy
✔ (Optional) Share your email address for occasional updates & outreach for product feedback from Kurtosis: █
INFO[2024-09-28T02:35:26Z] No Kurtosis engine was found; attempting to start one...
INFO[2024-09-28T02:35:26Z] Starting the centralized logs components...
INFO[2024-09-28T02:35:26Z] Pulling image 'timberio/vector:0.31.0-debian'
INFO[2024-09-28T02:35:35Z] Centralized logs components started.
INFO[2024-09-28T02:35:35Z] Pulling image 'traefik:2.10.6'
INFO[2024-09-28T02:35:42Z] Reverse proxy started.
INFO[2024-09-28T02:35:42Z] Pulling image 'alpine:3.17'
INFO[2024-09-28T02:35:45Z] Pulling image 'kurtosistech/engine:1.3.0'
INFO[2024-09-28T02:35:49Z] Successfully started Kurtosis engine
INFO[2024-09-28T02:35:49Z] Creating a new enclave for Starlark to run inside...
INFO[2024-09-28T02:36:06Z] Enclave 'nameless-playa' created successfully
There was an error interpreting Starlark code
Evaluation error: fail: Invalid parameter optimism_package, allowed fields ["participants", "participants_matrix", "network_params", "dora_params", "tx_spammer_params", "goomy_blob_params", "prometheus_params", "grafana_params", "assertoor_params", "mev_params", "xatu_sentry_params", "port_publisher", "wait_for_finalization", "global_log_level", "snooper_enabled", "ethereum_metrics_exporter_enabled", "parallel_keystore_generation", "disable_peer_scoring", "persistent", "mev_type", "xatu_sentry_enabled", "apache_port", "global_tolerations", "global_node_selectors", "keymanager_enabled", "checkpoint_sync_enabled", "checkpoint_sync_url", "additional_services"]
at [github.com/ethpandaops/ethereum-package/main.star:76:57]: run
at [github.com/ethpandaops/ethereum-package/src/package_io/input_parser.star:83:30]: input_parser
at [github.com/ethpandaops/ethereum-package/src/package_io/sanity_check.star:332:17]: sanity_check
at [0:0]: fail
Error encountered running Starlark code.
⭐ us on GitHub - https://github.com/kurtosis-tech/kurtosis
INFO[2024-09-28T02:36:09Z] =======================================================
INFO[2024-09-28T02:36:09Z] || Created enclave: nameless-playa ||
INFO[2024-09-28T02:36:09Z] =======================================================
Name: nameless-playa
UUID: e86595d61167
Status: RUNNING
Creation Time: Sat, 28 Sep 2024 02:35:49 UTC
Flags:
========================================= Files Artifacts =========================================
UUID Name
========================================== User Services ==========================================
UUID Name Ports Status
Version info:
docker --version
Docker version 27.0.3-1, build 7d4bcd863a4c863e650eed02a550dfeb98560b83
kurtosis version
CLI Version: 1.3.0
To see the engine version (provided it is running): kurtosis engine status
kurtosis engine status
A Kurtosis engine is running with the following info:
Version: 1.3.0
Network config file:
cat network-config.yml
optimism_package:
chains: # you can define multiple L2s, which will be deployed against the same L1 as a single Superchain
- participants: # each participant is a node in the network. here we've defined two, one running op-geth and one running op-reth
- el_type: op-geth
sequencer: true # this node will be the sequencer
- el_type: op-reth
network_params:
name: rollup-1 # can be anything as long as it is unique
chain_id: 12345 # can be anything as long as it is unique
op_contract_deployer_params: # configures the contract versions to deploy
image: mslipper/op-deployer:latest
artifacts_url: https://storage.googleapis.com/oplabs-contract-artifacts/artifacts-v1-4accd01f0c35c26f24d2aa71aba898dd7e5085a2ce5daadc8a84b10caf113409.tar.gz
Hey @mslipper thanks for opening this PR! Instead of updating the testnet tutorial, can it update this page? It would address this issue: https://github.com/ethereum-optimism/docs/issues/984
I also ran into some issues involving Starlark.
version info:
docker --version
Docker version 27.2.0, build 3ab4256958
kurtosis version
CLI Version: 1.3.1
To see the engine version (provided it is running): kurtosis engine status
kurtosis engine status
A Kurtosis engine is running with the following info:
Version: 1.3.1
network yaml file
optimism_package:
chains: # you can define multiple L2s, which will be deployed against the same L1 as a single Superchain
- participants: # each participant is a node in the network. here we've defined two, one running op-geth and one running op-reth
- el_type: op-geth
sequencer: true # this node will be the sequencer
- el_type: op-reth
network_params:
name: rollup-1 # can be anything as long as it is unique
chain_id: 12345 # can be anything as long as it is unique
op_contract_deployer_params: # configures the contract versions to deploy
image: mslipper/op-deployer:latest
artifacts_url: https://storage.googleapis.com/oplabs-contract-artifacts/artifacts-v1-4accd01f0c35c26f24d2aa71aba898dd7e5085a2ce5daadc8a84b10caf113409.tar.gz
command with complaints
soyboy@soyboys-MacBook-Air devnet-test % kurtosis run github.com/ethpandaops/ethereum-package --args-file ./network-config.yml
The Kurtosis CLI collects user metrics by default. These metrics are anonymized, private & obfuscated. These metrics help us better understand what features are used, what features to invest in and what features might be buggy.
In case you wish to not send metrics, you can do so by running - kurtosis analytics disable
Read more at https://docs.kurtosis.com/advanced-concepts/metrics-philosophy
✔ (Optional) Share your email address for occasional updates & outreach for prod(Optional) Share your email address for occasional updates & outreach for produc✔ (Optional) Share your email address for occasional updates & outreach for product feedback from Kurtosis: █
INFO[2024-10-15T16:29:05-06:00] No Kurtosis engine was found; attempting to start one...
INFO[2024-10-15T16:29:05-06:00] Starting the centralized logs components...
INFO[2024-10-15T16:29:05-06:00] Pulling image 'timberio/vector:0.31.0-debian'
INFO[2024-10-15T16:29:12-06:00] Centralized logs components started.
INFO[2024-10-15T16:29:12-06:00] Pulling image 'traefik:2.10.6'
INFO[2024-10-15T16:29:17-06:00] Reverse proxy started.
INFO[2024-10-15T16:29:17-06:00] Pulling image 'alpine:3.17'
INFO[2024-10-15T16:29:19-06:00] Pulling image 'kurtosistech/engine:1.3.1'
INFO[2024-10-15T16:29:24-06:00] Successfully started Kurtosis engine
INFO[2024-10-15T16:29:24-06:00] Creating a new enclave for Starlark to run inside...
INFO[2024-10-15T16:29:40-06:00] Enclave 'quiet-cenote' created successfully
There was an error interpreting Starlark code
Evaluation error: fail: Invalid parameter optimism_package, allowed fields ["participants", "participants_matrix", "network_params", "dora_params", "tx_spammer_params", "goomy_blob_params", "prometheus_params", "grafana_params", "assertoor_params", "mev_params", "xatu_sentry_params", "port_publisher", "wait_for_finalization", "global_log_level", "snooper_enabled", "ethereum_metrics_exporter_enabled", "parallel_keystore_generation", "disable_peer_scoring", "persistent", "mev_type", "xatu_sentry_enabled", "apache_port", "global_tolerations", "global_node_selectors", "keymanager_enabled", "checkpoint_sync_enabled", "checkpoint_sync_url", "additional_services"]
at [github.com/ethpandaops/ethereum-package/main.star:76:57]: run
at [github.com/ethpandaops/ethereum-package/src/package_io/input_parser.star:87:30]: input_parser
at [github.com/ethpandaops/ethereum-package/src/package_io/sanity_check.star:356:17]: sanity_check
at [0:0]: fail
Error encountered running Starlark code.
⭐ us on GitHub - https://github.com/kurtosis-tech/kurtosis
INFO[2024-10-15T16:29:43-06:00] =====================================================
INFO[2024-10-15T16:29:43-06:00] || Created enclave: quiet-cenote ||
INFO[2024-10-15T16:29:43-06:00] =====================================================
Name: quiet-cenote
UUID: 6e2a2e8e3934
Status: RUNNING
Creation Time: Tue, 15 Oct 2024 16:29:24 CST
Flags:
========================================= Files Artifacts =========================================
UUID Name
========================================== User Services ==========================================
UUID Name Ports Status
I ended up with these containers:
@sbvegan updated to use the doc you requested, and fixed the instructions to avoid the errors you described.
📝 Walkthrough
📝 Walkthrough
Walkthrough
The pull request introduces substantial changes to the dev-node.mdx document, primarily focusing on the setup of a local OP Stack development environment. The title has been modified for capitalization consistency, and the content has been restructured to emphasize the process of spinning up an OP Stack devnet chain. Sections like "What is this?" and "Do I need this?" have been removed, while new sections such as "Installing Dependencies," "Configure your network," and "Start your network" have been added. The updated document provides detailed instructions on using Kurtosis for deploying the devnet, including YAML configuration examples. Additionally, a "Callout" section has been included to inform users about the guide's active development status and encourage issue reporting on GitHub. There are also warnings regarding potential impacts from modifications to the OP Stack. The installation instructions now specify dependencies like Docker and Kurtosis, complete with version checks and installation commands, enhancing the overall flow and usability of the document.
Possibly related PRs
- #834: This PR updates the installation instructions in
dev-node.mdx, which is directly related to the changes made in the main PR that also modifies this document's content and structure. - #1092: This PR updates the command path for deploying L1 contracts in
create-l2-rollup.mdx, which is relevant as it pertains to the setup and deployment processes discussed in the main PR's modifications todev-node.mdx.
Suggested labels
tutorial
Suggested reviewers
- sbvegan
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}