Add dev node RPC ports to local node instructions #982
Conversation
Here is the command output of `make devnet-up` for reference: ``` [+] Running 3/3 ✔ Container ops-bedrock-l1-1 Started 0.1s ✔ Container ops-bedrock-l1-bn-1 Started 0.2s ✔ Container ops-bedrock-l1-vc-1 Started 0.4s [INFO|10-12-2024 08:43:12] Trying 127.0.0.1:8545 [INFO|10-12-2024 08:43:12] Connected 127.0.0.1:8545 [INFO|10-12-2024 08:43:12] Waiting for RPC server at 127.0.0.1:8545 [INFO|10-12-2024 08:43:12] RPC server at 127.0.0.1:8545 ready [INFO|10-12-2024 08:43:12] L2 genesis and rollup configs already generated. [INFO|10-12-2024 08:43:12] Bringing up L2. WARN[0000] The "DG_TYPE" variable is not set. Defaulting to a blank string. WARN[0000] The "L2OO_ADDRESS" variable is not set. Defaulting to a blank string. WARN[0000] The "DGF_ADDRESS" variable is not set. Defaulting to a blank string. WARN[0000] The "PROPOSAL_INTERVAL" variable is not set. Defaulting to a blank string. WARN[0000] The "ALTDA_ENABLED" variable is not set. Defaulting to a blank string. WARN[0000] The "ALTDA_SERVICE" variable is not set. Defaulting to a blank string. WARN[0000] The "DA_TYPE" variable is not set. Defaulting to a blank string. WARN[0000] The "DGF_ADDRESS" variable is not set. Defaulting to a blank string. WARN[0000] The "ALTDA_GENERIC_DA" variable is not set. Defaulting to a blank string. WARN[0000] The "ALTDA_ENABLED" variable is not set. Defaulting to a blank string. WARN[0000] The "ALTDA_SERVICE" variable is not set. Defaulting to a blank string. [+] Running 1/1 ✔ Container ops-bedrock-l2-1 Started 0.1s [INFO|10-12-2024 08:43:12] Trying 127.0.0.1:9545 [INFO|10-12-2024 08:43:12] Connected 127.0.0.1:9545 [INFO|10-12-2024 08:43:12] Waiting for RPC server at 127.0.0.1:9545 [INFO|10-12-2024 08:43:12] Waiting for RPC server at 127.0.0.1:9545 [INFO|10-12-2024 08:43:13] RPC server at 127.0.0.1:9545 ready [INFO|10-12-2024 08:43:13] Using batch inbox 0x00289c189bee4e70334629f04cd5ed602b6600eb [INFO|10-12-2024 08:43:13] Using DisputeGameFactory 0xeCb92a686D1ab066fc4E559A305FEB75DD512377 [INFO|10-12-2024 08:43:13] Bringing up `op-node`, `op-proposer` and `op-batcher`. WARN[0000] The "L2OO_ADDRESS" variable is not set. Defaulting to a blank string. ```
This matches the CLI output
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request updates the document titled "Running a Local Development Environment" by adding specific information about the availability of L1 and L2 RPC servers after starting the development node. It includes a new line in the "Operations" section, specifying that the L2 RPC server can be accessed at Changes
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: 0
🧹 Outside diff range and nitpick comments (1)
pages/chain/testing/dev-node.mdx (1)
112-113: Approved with a minor suggestion for clarity.The added information about RPC server availability is valuable and well-placed within the "Operations" section. It provides clear instructions for users to access the L1 and L2 RPC servers after starting the devnet.
To enhance clarity, consider adding a brief explanation of what these RPC servers are used for. For example:
After the devnet starts, the L2 RPC server will be available at `127.0.0.1:9545` and the L1 RPC server will be available at `127.0.0.1:8545`. +These RPC servers allow you to interact with your local L1 and L2 nodes, send transactions, and query blockchain data.This addition would provide context for users who might be less familiar with the purpose of RPC servers in blockchain development.
📜 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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pages/chain/testing/dev-node.mdx (1)
110-111: Improve grammar and use Oxford commaThe added information is valuable for users. However, there are two minor improvements we can make:
- Add a comma after "images" for better readability.
- Use the Oxford comma before "and" in the list of RPC servers.
Here's the suggested revision:
- The first time it runs it will be relatively slow because it needs to download the images, after that it will be faster.\ - After the devnet starts, the L2 RPC server will be available at `127.0.0.1:9545` and the L1 RPC server will be available at `127.0.0.1:8545`. + The first time it runs it will be relatively slow because it needs to download the images, after that it will be faster.\ + After the devnet starts, the L2 RPC server will be available at `127.0.0.1:9545`, and the L1 RPC server will be available at `127.0.0.1:8545`.🧰 Tools
🪛 LanguageTool
[typographical] ~110-~110: Consider adding a comma here.
Context: ...ecause it needs to download the images, after that it will be faster.\ After the devne...(FOR_THAT_COMMA)
📜 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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/chain/testing/dev-node.mdx
[typographical] ~110-~110: Consider adding a comma here.
Context: ...ecause it needs to download the images, after that it will be faster.\ After the devne...(FOR_THAT_COMMA)
Description
The local node documentation does not list the RPC ports needed to access a local node. They are included in the CLI output but not the docs, so this PR adds them to the docs.
Tests
This can be verified after running
make devnet-upvia the CLI output (included in a commit below) and: