Add tutorial for devnet #914
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mslipper
force-pushed
the
feat/devnet-tutorial
branch
2 times, most recently
from
98eb36f to
d38582f
Compare
|
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: Version info: Network config file: |
|
Hey @mslipper thanks for opening this PR! Instead of updating the testnet tutorial, can it update this page? It would address this issue: #984 I also ran into some issues involving Starlark. version info:network yaml fileoptimism_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.gzcommand with complaintsI ended up with these containers: 
|
mslipper
force-pushed
the
feat/devnet-tutorial
branch
from
d38582f to
e8b730e
Compare
|
@sbvegan updated to use the doc you requested, and fixed the instructions to avoid the errors you described. |
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces substantial changes to the Possibly related PRs
Suggested labels
Suggested reviewers
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (6)
pages/chain/testing/dev-node.mdx (6)
2-2: Update title to use sentence caseAccording to the documentation guidelines, use sentence case for titles while preserving proper nouns:
- title: Running a Local Development Environment + title: Running a local development environment
17-18: Revise to remove personal pronounsReplace personal pronouns with more direct language:
- This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up a local OP Stack devnet. - You'll perform the full deployment process, and **you'll end up with your very own OP Stack devnet**. + This tutorial is **designed for developers** learning about the OP Stack through local devnet deployment. + The process guides through the full deployment, resulting in a **complete OP Stack devnet**.🧰 Tools
🪛 LanguageTool
[style] ~17-~17: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...(WANT_KEEN)
20-22: Add missing comma and revise sentence structureAdd the required comma and improve clarity:
- It's useful to understand what each of these components does before - you start deploying your chain. To learn about the different components please - read the [deployment overview page](/builders/chain-operators/deploy/overview). + Understanding each component's function is essential before + deployment. To learn about the different components, please + refer to the [deployment overview page](/builders/chain-operators/deploy/overview).🧰 Tools
🪛 LanguageTool
[typographical] ~21-~21: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...(PLEASE_COMMA)
37-37: Fix table cell paddingAdjust the table cell padding to match the style guide:
-| [docker](https://docs.docker.com/engine/install/) | `^27` | `docker --version` | +| [docker](https://docs.docker.com/engine/install/) | `^27` | `docker --version` |🧰 Tools
🪛 GitHub Check: lint
[warning] 37-37:
Cell should be padded with 1 space, not 13
58-67: Add configuration validation stepsConsider adding validation steps to help users verify their configuration:
- Add a command to validate YAML syntax
- Document required and optional fields
- Include common configuration errors to watch for
Would you like assistance in drafting the validation section?
185-188: Fix list formattingUpdate the list formatting to match the style guide:
-* You can [modify the blockchain in various ways](../hacks/overview). -* Check out the [protocol specs](https://specs.optimism.io/) for more detail about the rollup protocol. -* If you run into any problems, please visit the [Chain Operators Troubleshooting Guide](../management/troubleshooting) - or [file an issue](https://github.com/ethereum-optimism/optimism/issues) for help. +* You can [modify the blockchain in various ways](../hacks/overview). +* Check out the [protocol specs](https://specs.optimism.io/) for more detail about the rollup protocol. +* If you run into any problems, please visit the [Chain Operators Troubleshooting Guide](../management/troubleshooting) + or [file an issue](https://github.com/ethereum-optimism/optimism/issues) for help.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/chain/testing/dev-node.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/chain/testing/dev-node.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/chain/testing/dev-node.mdx
[style] ~17-~17: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...
(WANT_KEEN)
[typographical] ~21-~21: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...
(PLEASE_COMMA)
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[typographical] ~145-~145: It appears that a comma is missing.
Context: ...use to connect to the service. At this point your chain is up and running. Let's mov...
(DURING_THAT_TIME_COMMA)
[grammar] ~156-~156: This phrase is duplicated. You should probably use “test test” only once.
Context: ...re-fund development addresses using the `test test test test test test test test test test test junk...
(PHRASE_REPETITION)
🪛 GitHub Check: lint
pages/chain/testing/dev-node.mdx
[warning] 37-37:
Cell should be padded with 1 space, not 13
[warning] 140-140:
Marker style should be *
[warning] 140-140:
Incorrect list-item indent: add 2 spaces
[warning] 142-142:
Marker style should be *
[warning] 142-142:
Incorrect list-item indent: add 2 spaces
[warning] 143-143:
Marker style should be *
[warning] 143-143:
Incorrect list-item indent: add 2 spaces
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pages/chain/testing/dev-node.mdx (3)
17-22: Enhance readability with proper punctuation and stronger wordingConsider these improvements:
- Replace "who want to" with "who need to" for stronger wording
- Add a comma after "components" in the sentence "To learn about the different components, please"
-This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up a local OP Stack devnet. +This tutorial is **designed for developers** who need to learn about the OP Stack by spinning up a local OP Stack devnet. -To learn about the different components please +To learn about the different components, please🧰 Tools
🪛 LanguageTool
[style] ~17-~17: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...(WANT_KEEN)
[typographical] ~21-~21: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...(PLEASE_COMMA)
58-67: Add configuration validation guidanceConsider adding instructions for validating the YAML configuration before running it, such as:
- How to verify the chain ID is unique
- How to validate the YAML syntax
- Common configuration mistakes to avoid
178-182: Enhance the section with practical examplesConsider adding:
- A basic smart contract deployment example
- Sample transaction commands
- Common interaction patterns
Would you like me to help draft these examples?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/chain/testing/dev-node.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/chain/testing/dev-node.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/chain/testing/dev-node.mdx
[style] ~17-~17: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...
(WANT_KEEN)
[typographical] ~21-~21: Consider adding a comma here.
Context: ... To learn about the different components please read the [deployment overview page](/bu...
(PLEASE_COMMA)
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[typographical] ~145-~145: It appears that a comma is missing.
Context: ...use to connect to the service. At this point your chain is up and running. Let's mov...
(DURING_THAT_TIME_COMMA)
[grammar] ~156-~156: This phrase is duplicated. You should probably use “test test” only once.
Context: ...re-fund development addresses using the `test test test test test test test test test test test junk...
(PHRASE_REPETITION)
🔇 Additional comments (2)
pages/chain/testing/dev-node.mdx (2)
2-8: LGTM! Frontmatter and imports are properly structured.
The title follows proper title case, and the description clearly states the tutorial's purpose.
183-188: LGTM! Good resources for further learning
The section provides appropriate next steps and troubleshooting resources.
No description provided.