Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update create-l2-rollup.mdx #824

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Update create-l2-rollup.mdx #824

merged 2 commits into from
Aug 9, 2024

Conversation

opfocus
Copy link
Contributor

@opfocus opfocus commented Aug 9, 2024

Description

  1. Removed --rpc.port=8547 from op-node:
    Use the default value to align with the JSON-RPC API documentation.
    Flag description:
    --rpc.port value (default: 9545) ($OP_NODE_RPC_PORT)
    RPC listening port.

  2. Changed --max-channel-duration for op-batcher:
    Updated --max-channel-duration=1 to --max-channel-duration=25, referencing the corresponding configuration value from op-sepolia.

  3. Added link target for --max-channel-duration=n:
    Added a link to "Set Your OP_BATCHER_MAX_CHANNEL_DURATION" to provide relevant recommendations.

  4. Updated op-proposer command for L1StandardBridgeProxy address:
    Changed the command from

    cat deployments/getting-started/L1StandardBridgeProxy.json | jq -r .address

    to

    cat ../packages/contracts-bedrock/deployments/getting-started/.deploy | jq -r .L2OutputOracleProxy

    as the previous command was no longer valid.

  5. Updated command to retrieve L1StandardBridgeProxy address:
    Changed the command from

    cat deployments/getting-started/L1StandardBridgeProxy.json | jq -r .address

    to

    cat deployments/getting-started/.deploy | jq -r .L1StandardBridgeProxy

    due to the previous command becoming invalid.

Tests

Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.

Additional context

Add any other context about the problem you're solving.

Metadata

  • Fixes #[Link to Issue]

@opfocus opfocus requested a review from a team as a code owner August 9, 2024 16:28
@opfocus opfocus requested a review from a team August 9, 2024 16:28
Copy link
Contributor

coderabbitai bot commented Aug 9, 2024

Walkthrough

The recent changes enhance the configuration options for batchers and proposers in the Optimism framework. Key updates include adjustments to the --max-channel-duration parameter, increasing it from 1 to 25, thereby allowing batchers to accumulate transactions longer before writing to Layer 1. Additionally, the method for retrieving the L2OutputOracleProxy address has been updated for improved reliability, alongside enhanced documentation for better user guidance.

Changes

Files Change Summary
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx Updated --max-channel-duration from 1 to 25; modified address retrieval for L2OutputOracleProxy and L1StandardBridgeProxy from .json to .deploy for improved reliability and configuration clarity.

Possibly related issues

  • ethereum-optimism/docs#728: This change aligns with the request to improve core documentation for the create-l2-rollup tutorial, emphasizing the need for clarity in deployment configurations.
  • ethereum-optimism/docs#549: The update to address retrieval directly addresses the concerns regarding synchronization with new builds, as it integrates the latest changes and file structure.
  • ethereum-optimism/docs#627: The adjustment in configuration parameters and documentation can contribute to improving the overall tutorial on creating L2 rollups, making it more relevant and user-friendly.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fee60c4 and 26dbdcc.

Files selected for processing (1)
  • pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • pages/builders/chain-operators/tutorials/create-l2-rollup.mdx

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?

Share
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>.
    • 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 @coderabbitai in 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 @coderabbitai in 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

netlify bot commented Aug 9, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 26dbdcc
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66b648b7e3de590008e21d0e
😎 Deploy Preview https://deploy-preview-824--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)

664-670: Clarify the explanation for --max-channel-duration.

The change to --max-channel-duration=25 is correct. The explanation in the callout is clear, but consider adding a brief example to illustrate the impact of setting this parameter low versus high.

- When it is high, transactions are written to L1 less frequently and the batcher spends less ETH.
+ For example, when set to 25, transactions are written to L1 less frequently, reducing ETH expenditure by the batcher.

Copy link
Collaborator

@sbvegan sbvegan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty simple! lgtm

@sbvegan sbvegan merged commit 6e9d054 into ethereum-optimism:main Aug 9, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants