Fix artifacts in 'Create L2 Rollup' tutorial #741

richardhuaaa · 2024-06-13T04:19:57Z

Fix the instructions in the tutorial so users don't run into the issue described in ethereum-optimism/optimism#10114, using the instructions from ethereum-optimism/developers#354 (reply in thread). I've tested this against the tutorials/chain branch and it is working. #627

coderabbitai · 2024-06-13T04:20:04Z

Walkthrough

Recent updates to create-l2-rollup.mdx involve removing the code snippet related to generating contract artifacts and modifying the --deployment-dir path used in the go run command. The changes improve the documentation's accuracy and relevance by pointing to the sepolia directory instead of the getting-started directory.

Changes

File Path	Change Summary
`pages/builders/chain-operators/tutorials/create-l2-rollup.mdx`	Removed code snippet for generating contract artifacts and updated `--deployment-dir` path to `../packages/contracts-bedrock/deployments/sepolia/`.

Possibly related issues

[DOCS] Update chain-deployment docs #728: This issue calls for an update to the chain-deployment docs, asking for more clarity and guidance, which aligns with the nature of this PR's improvements.
[TUTORIAL] Improve L2 Testnet Tutorial #627: This issue suggests improving the L2 Testnet Tutorial, which this PR partially addresses by updating paths and cleaning up outdated instructions.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a7b4b14 and 1a81399.

Files selected for processing (1)

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2 hunks)

Additional context used

Path-based instructions (1)

pages/builders/chain-operators/tutorials/create-l2-rollup.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. Use bold for prominence instead of all caps or italics.

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).
"

LanguageTool

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx

[style] ~21-~21: Consider using an alternative to strengthen your wording. (WANT_KEEN)
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...

[style] ~22-~22: Consider removing “of” to be more concise (ALL_OF_THE)
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...

[style] ~22-~22: Try using a synonym here to elevate your writing. (CONSTITUTE_COMPRISE)
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...

[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...r own needs. **The OP Stack is free and open source software licensed entirely under the MI...

[typographical] ~63-~63: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ...ldr) (maintained by OptimismJ). In this tutorial you'll be using the [op-node implemen...

[typographical] ~70-~70: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ... op-nethermind (coming soon). In this tutorial you'll be using the [op-geth implemen...

[style] ~75-~75: ‘on a regular basis’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
Context: ...ransactions in batches (hence the name) on a regular basis. You'll be using the [op-batcher impl...

[typographical] ~82-~82: Consider adding a comma here. (FOR_NOW_COMMA)
Context: ...oser will be removed in the future, but for now it's a necessary component of the OP St...

[uncategorized] ~125-~125: Use the indefinite article “an” before nouns that start with a vowel sound. (AI_EN_LECTOR_REPLACEMENT_DETERMINER_A_AN)
Context: ... to a Sepolia Node You'll be deploying a OP Stack Rollup chain that uses a Layer...

[uncategorized] ~138-~138: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...our OP Stack chain directly from source code instead of using a container system lik...

[style] ~183-~183: Consider removing “of” to be more concise (ALL_OF_THE)
Context: ...g script and double check that you have all of the required versions installed. If you don...

[style] ~196-~196: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...ll {<h3>Build the various packages inside of the Optimism Monorepo</h3>} bash ma...

[style] ~263-~263: The phrase ‘has the ability to’ might be wordy. Consider using “can”. (HAS_THE_ABILITY_TO)
Context: ... up the chain: * The Admin address has the ability to upgrade contracts. * The Batcher ad...

[uncategorized] ~319-~319: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...need to send any ETH to the Sequencer address as it does not send transactions.** It...

[uncategorized] ~347-~347: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...hell](#configuring-direnv). Next you'll need to allow direnv to read t...

[style] ~376-~376: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...n. Currently, chain configuration lives inside of the [contracts-bedrock](https://githu...

[style] ~394-~394: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```bash...

[uncategorized] ~429-~429: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...69 then the contract has been deployed and you can safely skip this section. {<h3...

[style] ~536-~536: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ... be running a Sequencer node, so you'll need to import the Sequencer private key that...

[uncategorized] ~619-~619: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...rt op-node Once you've got op-geth running you'll need to run op-node. Like Ethe...

[style] ~656-~656: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...ou'll start to see blocks being created inside of op-geth. **By ...

[style] ~686-~686: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative. (A_LOT_OF)
Context: ... it can expend ETH quickly if there are a lot of transactions to publish. {<h3...

Gitleaks

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx

296-297: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)

300-301: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)

304-305: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)

308-309: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)

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 Configration 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.

netlify · 2024-06-13T04:20:22Z

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	`1a81399`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/666a7c0c73a9650008998403
😎 Deploy Preview	https://deploy-preview-741--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.

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx

coderabbitai

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (2)
Line range hint 125-125:
The article incorrectly uses "a OP Stack Rollup" instead of "an OP Stack Rollup". The indefinite article "an" should be used before words that start with a vowel sound.
- You'll be deploying a OP Stack Rollup chain that uses a Layer 1 blockchain to host and order transaction data.
+ You'll be deploying an OP Stack Rollup chain that uses a Layer 1 blockchain to host and order transaction data.
Line range hint 296-297:
Detected potential exposure of Generic API Keys. It's crucial to ensure that sensitive keys are not hardcoded in the codebase or documentation. Consider using environment variables or secure vault solutions to manage these keys.
- export ETHERSCAN_API_KEY=0x123456789abcdef
+ export ETHERSCAN_API_KEY=$ETHERSCAN_API_KEY
Also applies to: 300-301, 304-305, 308-309

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx

sbvegan

ty!

Fix artifacts in tutorial according to ethereum-optimism/optimism#10114

a7b4b14

richardhuaaa requested a review from a team as a code owner June 13, 2024 04:19

richardhuaaa requested a review from a team June 13, 2024 04:19

richardhuaaa commented Jun 13, 2024

View reviewed changes

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx Outdated Show resolved Hide resolved

Follow the fix in ethereum-optimism/developers#354 (reply in thread)

1a81399

coderabbitai bot reviewed Jun 13, 2024

View reviewed changes

pages/builders/chain-operators/tutorials/create-l2-rollup.mdx Show resolved Hide resolved

sbvegan approved these changes Jun 13, 2024

View reviewed changes

sbvegan merged commit 8813657 into ethereum-optimism:main Jun 16, 2024

This was referenced Oct 23, 2024

fix: wrong Deploy.s.sol file path #1019

Merged

tutorials: make geth before using geth init #1042

Merged

coderabbitai bot mentioned this pull request Nov 21, 2024

fix: incompatible state scheme #1132

Merged

coderabbitai bot mentioned this pull request Jan 5, 2025

Suggested edits for tutorials/create-l2-rollup.mdx #1218

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix artifacts in 'Create L2 Rollup' tutorial #741

Fix artifacts in 'Create L2 Rollup' tutorial #741

Uh oh!

richardhuaaa commented Jun 13, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 13, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

netlify bot commented Jun 13, 2024 •

edited

Loading

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

sbvegan left a comment

Uh oh!

Uh oh!

Fix artifacts in 'Create L2 Rollup' tutorial #741

Fix artifacts in 'Create L2 Rollup' tutorial #741

Uh oh!

Conversation

richardhuaaa commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

netlify bot commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-optimism ready!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sbvegan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

richardhuaaa commented Jun 13, 2024 •

edited

Loading

coderabbitai bot commented Jun 13, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

netlify bot commented Jun 13, 2024 •

edited

Loading