stack/dev-node: use teku as the l1 cl node #1414
Conversation
✅ Deploy Preview for docs-optimism ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe update adds a new configuration section for an Ethereum network within the documentation file. A new Sequence Diagram(s)sequenceDiagram
participant User as User
participant CLI as Command Line Interface
participant Remote as Remote YAML Config
participant Config as Ethereum Package
participant Teku as Teku Client
User->>CLI: Execute "start network" command
CLI->>Remote: Fetch YAML configuration from URL
Remote-->>CLI: Return configuration data
CLI->>Config: Load configuration (geth & teku)
Config->>Teku: Initialize Teku client service
Teku-->>CLI: Log new enclave details (proud-crater, UUID, timestamp)
sequenceDiagram
participant User as User
participant CLI as Command Line Interface
participant Teku as Teku Service
User->>CLI: Issue "send ETH" command
CLI->>Teku: Forward transaction request to Teku client
Teku-->>CLI: Return transaction status
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
I tried out these new instructions and got the same error that was highlighted in #1406. My recommendation to fix this is to:
- change the "Configure your network" section to say this is just an example configuration
- change the "Start your network" section to use the following command
kurtosis run github.com/ethpandaops/optimism-package --args-file https://raw.githubusercontent.com/ethpandaops/optimism-package/main/network_params.yamlthat is in the ethpandas quickstart - then change the output to what is reflected using the ethpandas configuration file
Signed-off-by: jsvisa <[email protected]>
Signed-off-by: jsvisa <[email protected]>
Curious why it will failed, I tested in my server, seems ok.
use the remote file instead of a local one will be a more suitable fix, no need to fix it any more when next time more modifies. @sbvegan PTAL. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
pages/stack/dev-net.mdx (1)
1-5:⚠️ Potential issueMissing Required Frontmatter Metadata
The frontmatter only includes
title,lang, anddescription. For regular pages, the required fieldstopic,personas,categories, andcontent_typeare missing. Please update the frontmatter accordingly. For example, you can run:pnpm metadata-batch-cli:dry "pages/stack/dev-net.mdx"
🧹 Nitpick comments (2)
pages/stack/dev-net.mdx (2)
77-79: Updated Network Start CommandThe
kurtosis runcommand now points to an external YAML file via a URL. This centralizes configuration management as intended. Consider pinning the URL to a version or commit hash to avoid potential non-deterministic behavior in the future. For example:- kurtosis run github.com/ethpandaops/optimism-package --args-file https://raw.githubusercontent.com/ethpandaops/optimism-package/main/network_params.yaml + kurtosis run github.com/ethpandaops/optimism-package --args-file https://raw.githubusercontent.com/ethpandaops/optimism-package/<version_or_commit>/network_params.yaml
42-46: Stylistic Note on Pronoun UsageThe documentation currently uses phrases like “We recommend using the latest version of Docker…” Consider rephrasing to avoid first-person pronouns. For example, use an imperative style: “Use the latest version of Docker on Linux, or employ OrbStack on macOS.”
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/dev-net.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/dev-net.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
pages/stack/dev-net.mdx (3)
67-70: New Ethereum Package Configuration AddedThe new
ethereum_packageblock configuring a participant withel_type: gethandcl_type: tekuis introduced. The YAML indentation appears correct. Ensure that this configuration is consistently referenced elsewhere in the documentation.
86-93: Updated Output Logs VerificationThe output log section now reflects the new enclave details (e.g., enclave name
proud-craterand updated UUID). Verify that these details match the expected values from the Teku integration and that the log format remains consistent with other environments.
116-124: User Services Table ConsistencyThe services list now includes entries such as
cl-1-teku-gethandel-1-geth-teku, which correctly reflect the integration of Teku as the CL node. Ensure that all references to these services in the documentation (e.g., RPC URL instructions) are consistent with the new naming convention.
Description
set devnet's cl node with teku, ref #1406
Tests
Additional context
Metadata