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 fix sync() issue #651

Conversation

BlueShells
Copy link

@BlueShells BlueShells commented Apr 24, 2024

Description
for branch tutorials/chain , if using the latest forge version , it will failed to run
forge script scripts/Deploy.s.sol:Deploy --sig 'sync()' --rpc-url $L1_RPC_URL

with error info
"Deploy Tx not found"

the root cause is the contract address is lower in : broadcast/Deploy.s.sol/11155111/run-latest.json

but its not lowercase in deployments/getting-started/.deploy

Tests

sync success

Additional context

bug of https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup

by the way , anyone please fix the doc if its outdated
Metadata

  • Fixes #[Link to Issue]

for branch tutorials/chain , if using the latest forge version , it will failed to run  forge script scripts/Deploy.s.sol:Deploy --sig 'sync()' --rpc-url $L1_RPC_URL

with error info "Deploy Tx not found"

the root cause is the contract address is lower in  : broadcast/Deploy.s.sol/11155111/run-latest.json

but its not lowercase in deployments/getting-started/.deploy
@BlueShells BlueShells requested a review from a team as a code owner April 24, 2024 12:53
@BlueShells BlueShells requested a review from a team April 24, 2024 12:53
Copy link
Contributor

coderabbitai bot commented Apr 24, 2024

Walkthrough

The update includes a cautionary note about using a specific version of forge in the L2 rollup creation tutorial due to an issue with address case sensitivity that affects the sync() method. A direct link to the recommended version of forge is also provided.

Changes

File Path Change Summary
pages/.../tutorials/create-l2-rollup.mdx Added caution about forge version and link to the recommended version due to an address case issue.

Possibly related issues

  • ethereum-optimism/docs#627: This issue requests updates to the L2 Rollup Testnet tutorial to reflect more recent changes. The PR could be linked as it addresses a specific version-related caution that is part of keeping the tutorial up-to-date.
  • ethereum-optimism/docs#549: Although this issue focuses on syncing tutorials with changes in version 1.7.0 and beyond, linking the PR could be beneficial as it also deals with ensuring tutorial accuracy concerning tool versions.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 77e3681 and 8cd2cbb.
Files selected for processing (1)
  • pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1 hunks)
Additional Context Used
LanguageTool (163)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (163)

Near line 6: This sentence does not start with an uppercase letter.
Context: ...ning up an OP Stack testnet chain. --- import { Callout, Steps } from 'nextra/compone...


Near line 7: Don’t put a space after the opening parenthesis.
Context: ... an OP Stack testnet chain. --- import { Callout, Steps } from 'nextra/components...


Near line 7: Don’t put a space before the closing parenthesis.
Context: ...tnet chain. --- import { Callout, Steps } from 'nextra/components' # Creating Yo...


Near line 7: Possible spelling mistake found.
Context: ...n. --- import { Callout, Steps } from 'nextra/components' # Creating Your Own L2 Rol...


Near line 9: Possible spelling mistake found.
Context: ...tra/components' # Creating Your Own L2 Rollup Testnet Please *...


Near line 9: Possible spelling mistake found.
Context: ...ponents' # Creating Your Own L2 Rollup Testnet Please **be prep...


Near line 16: Consider using an alternative to strengthen your wording.
Context: ...rial is designed for developers who want to learn about the OP Stack by spinning...


Near line 16: Possible spelling mistake found.
Context: ...the OP Stack by spinning up an OP Stack testnet chain. You'll walk through the full dep...


Near line 17: Consider removing “of” to be more concise
Context: ...e full deployment process and teach you all of the components that make up the OP Stack, a...


Near line 17: Try using a synonym here to elevate your writing.
Context: ...nd teach you all of the components that make up the OP Stack, and **you'll end up with ...


Near line 17: Possible spelling mistake found.
Context: ...u'll end up with your very own OP Stack testnet**. You can use this testnet to experim...


Near line 19: Possible spelling mistake found.
Context: ...n OP Stack testnet**. You can use this testnet to experiment and perform tests, or you...


Near line 20: 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...


Near line 35: Possible spelling mistake found.
Context: ...ives you the ability to deploy your own Rollup chains that use a Layer 1 blockchain to...


Near line 36: Possible spelling mistake found.
Context: ... L1 blockchain to manage aspects of the Rollup. Each OP Stack chain has its own set of...


Near line 57: Possible spelling mistake found.
Context: ...com/a16z/magi) (maintained by a16z) and [hildr](https://github.com/optimism-java/hild...


Near line 57: Possible spelling mistake found.
Context: ...com/optimism-java/hildr) (maintained by OptimismJ). In this tutorial you'll be using the ...


Near line 58: It appears that a comma is missing.
Context: ...ldr) (maintained by OptimismJ). In this tutorial you'll be using the [op-node implemen...


Near line 64: Possible spelling mistake found.
Context: ...Stack execution client exist, including op-geth (maintained by Optimism Foundation), [...


Near line 64: Possible spelling mistake found.
Context: ...h (maintained by Optimism Foundation), [op-erigon`](https://github.com/testinprod-io/op-e...


Near line 64: Possible spelling mistake found.
Context: ...igon) (maintained by Test in Prod), and op-nethermind (coming soon). In this tutorial you'll...


Near line 65: It appears that a comma is missing.
Context: ... op-nethermind (coming soon). In this tutorial you'll be using the [op-geth implemen...


Near line 65: Possible spelling mistake found.
Context: ...). In this tutorial you'll be using the [op-geth implementation](https://github.com/eth...


Near line 65: Possible spelling mistake found.
Context: ...reum-optimism/op-geth) found within the [op-geth repository](https://github.com/ethereu...


Near line 67: Possible spelling mistake found.
Context: ...ub.com/ethereum-optimism/op-geth). ### Batcher The Batcher is a service that publishe...


Near line 69: Possible spelling mistake found.
Context: ...um-optimism/op-geth). ### Batcher The Batcher is a service that publishes transaction...


Near line 70: Possible spelling mistake found.
Context: ...the Sequencer to the L1 blockchain. The Batcher runs continuously alongside the Sequenc...


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


Near line 71: Possible spelling mistake found.
Context: ...on a regular basis. You'll be using the [op-batcher implementation](https://github.com/eth...


Near line 71: Possible spelling mistake found.
Context: ...optimism/tree/v1.1.4/op-batcher) of the Batcher component found within the [Optimism Mo...


Near line 77: Consider adding a comma here.
Context: ...oser will be removed in the future, but for now it's a necessary component of the OP St...


Near line 82: Possible typo: you repeated a whitespace
Context: ... ## Software Dependencies | Dependency | Version | Version Check Command | | -...


Near line 82: Possible typo: you repeated a whitespace
Context: ... | Version | Version Check Command | | ------------...


Near line 84: Possible typo: you repeated a whitespace
Context: ...-------- | | git | ^2 | git --version | | [...


Near line 84: Possible typo: you repeated a whitespace
Context: ... | ^2 | git --version | | [go](https:/...


Near line 84: Possible typo: you repeated a whitespace
Context: ... | ^2 | git --version | | go ...


Near line 85: Possible typo: you repeated a whitespace
Context: ...version | | [go](https://go.dev/) |^1.21 |go version` | | [...


Near line 85: Possible typo: you repeated a whitespace
Context: ... | ^1.21 | go version | | [node](https...


Near line 85: Possible typo: you repeated a whitespace
Context: ... | ^1.21 | go version | | node ...


Near line 86: Possible typo: you repeated a whitespace
Context: ... | | node | ^20 | node --version | | [...


Near line 86: Possible typo: you repeated a whitespace
Context: ...) | ^20 | node --version | | [pnpm](https...


Near line 86: Possible typo: you repeated a whitespace
Context: ... | ^20 | node --version | | pnpm...


Near line 87: Possible spelling mistake found.
Context: ...| ^20 | node --version | | pnpm ...


Near line 87: Possible typo: you repeated a whitespace
Context: ...| | pnpm | ^8 | pnpm --version | | [...


Near line 87: Possible typo: you repeated a whitespace
Context: ...llation) | ^8 | pnpm --version | | [foundry](ht...


Near line 87: Possible spelling mistake found.
Context: ...) | ^8 | pnpm --version | | [foundry](https://g...


Near line 87: Possible typo: you repeated a whitespace
Context: ... | ^8 | pnpm --version | | [foundry](https://github.com/foundry...


Near line 88: Possible typo: you repeated a whitespace
Context: ...allation) | ^0.2.0 | forge --version | | [make](https://linux.die.net/man/1/m...


Near line 89: Possible typo: you repeated a whitespace
Context: ...make | ^3 | make --version | | [...


Near line 89: Possible typo: you repeated a whitespace
Context: .../man/1/make) | ^3 | make --version | | [jq](https:/...


Near line 89: Possible typo: you repeated a whitespace
Context: ... | ^3 | make --version | | jq ...


Near line 90: Possible spelling mistake found.
Context: ...| ^3 | make --version | | jq ...


Near line 90: Possible typo: you repeated a whitespace
Context: ... | | jq | ^1.6 | jq --version | | [...


Near line 90: Possible typo: you repeated a whitespace
Context: .../jq) | ^1.6 | jq --version | | [direnv](htt...


Near line 90: Possible spelling mistake found.
Context: ... | ^1.6 | jq --version | | [direnv](https://...


Near line 90: Possible typo: you repeated a whitespace
Context: ... | ^1.6 | jq --version | | direnv ...


Near line 91: Possible spelling mistake found.
Context: ...| ^1.6 | jq --version | | direnv ...


Near line 91: Possible typo: you repeated a whitespace
Context: ... | | direnv | ^2 | direnv --version | ##...


Near line 91: Possible typo: you repeated a whitespace
Context: ... | ^2 | direnv --version | ### Notes on ...


Near line 91: Possible spelling mistake found.
Context: ... | ^2 | direnv --version | ### Notes on Specific ...


Near line 91: Possible typo: you repeated a whitespace
Context: ... | ^2 | direnv --version | ### Notes on Specific Dependencies #...


Near line 97: Possible spelling mistake found.
Context: ...LTS version of Node.js (currently v20). nvm is a u...


Near line 103: Possible spelling mistake found.
Context: ...ed to use the scripts in the monorepo's package.json for managing foundry to ensure you'r...


Near line 104: This sentence does not start with an uppercase letter.
Context: ...he monorepo locally before proceeding. for forge , please use https://github.com/f...


Near line 105: Did you mean “forges”?
Context: ...onorepo locally before proceeding. for forge , please use https://github.com/foundry...


Near line 105: Put a space after the comma, but not before the comma.
Context: ...po locally before proceeding. for forge , please use https://github.com/foundry-r...


Near line 108: Possible spelling mistake found.
Context: ...## direnv Parts of this tutorial use direnv as a way of loadi...


Near line 108: Possible spelling mistake found.
Context: ...y of loading environment variables from .envrc files into your shell. This means you ...


Near line 109: Possible spelling mistake found.
Context: ...iables every time you want to use them. direnv only ever has access to files that you...


Near line 112: Possible spelling mistake found.
Context: ...tly allow it to see. After [installing direnv](https://direnv.net/docs/installation....


Near line 112: Possible spelling mistake found.
Context: ...tml), you will need to **make sure that [direnv is hooked into your shell](https://dir...


Near line 113: Possible spelling mistake found.
Context: ... sure you've followed [the guide on the direnv website](https://direnv.net/docs/hook....


Near line 120: Possible spelling mistake found.
Context: ... later). ## Get Access to a Sepolia Node You'll be deploying a OP Stack Ro...


Near line 122: Possible spelling mistake found.
Context: ...ia Node You'll be deploying a OP Stack Rollup chain that uses a Layer 1 blockchain to...


Near line 123: Possible spelling mistake found.
Context: ...nd order transaction data. The OP Stack Rollups were designed to use EVM Equivalent blo...


Near line 123: Possible spelling mistake found.
Context: ...quivalent blockchains like Ethereum, OP Mainnet, or standard Ethereum testnets as their...


Near line 123: Possible spelling mistake found.
Context: ...ereum, OP Mainnet, or standard Ethereum testnets as their L1 chains. **This guide uses ...


Near line 125: Possible spelling mistake found.
Context: ...their L1 chains. This guide uses the Sepolia testnet as an L1 chain. We recommend ...


Near line 125: Possible spelling mistake found.
Context: ... chains. This guide uses the Sepolia testnet as an L1 chain. We recommend that you...


Near line 126: Possible spelling mistake found.
Context: ...chain**. We recommend that you also use Sepolia. You can also use other EVM-compatible ...


Near line 128: Possible spelling mistake found.
Context: ...lly review each command and replace any Sepolia-specific values with the values for your network...


Near line 130: Possible spelling mistake found.
Context: ...you're deploying your OP Stack chain to Sepolia, you'll need to have access to a Sepoli...


Near line 130: Possible spelling mistake found.
Context: ...epolia, you'll need to have access to a Sepolia node. You can either use a node provide...


Near line 131: Possible spelling mistake found.
Context: ....alchemy.com/) (easier) or run your own Sepolia node (harder). ## Build the Source Cod...


Near line 135: Possible missing comma found.
Context: ...our OP Stack chain directly from source code instead of using a container system lik...


Near line 180: Consider removing “of” to be more concise
Context: ...g script and double check that you have all of the required versions installed. If you don...


Near line 193: This phrase is redundant. Consider using “inside”.
Context: ...ll {<h3>Build the various packages inside of the Optimism Monorepo</h3>} bash ma...


Near line 206: Possible spelling mistake found.
Context: ...## Build op-geth {

Clone op-geth

} ```bash cd ~ git clone https://g...


Near line 213: Possible spelling mistake found.
Context: ...um-optimism/op-geth.git {<h3>Enter op-geth</h3>} bash cd op-geth ``` {

Bui...


Near line 219: Possible spelling mistake found.
Context: ...3>} bash cd op-geth {

Build op-geth

} bash make geth ...


Near line 249: Possible typo: you repeated a whitespace
Context: ...ariables: | Variable Name | Description | | ------------- | --------------------...


Near line 251: Possible typo: you repeated a whitespace
Context: ...----------------------- | | L1_RPC_URL | URL for your L1 node (a Sepolia node i...


Near line 251: Possible spelling mistake found.
Context: ...L1_RPC_URL | URL for your L1 node (a Sepolia node in this case). ...


Near line 251: Possible typo: you repeated a whitespace
Context: ... L1 node (a Sepolia node in this case). | | L1_RPC_KIND | Kind of L1 RPC you'r...


Near line 252: Possible spelling mistake found.
Context: ...pts fetching. Valid options: alchemy, quicknode, infura, parity, nethermind, `de...


Near line 252: Possible spelling mistake found.
Context: ... Valid options: alchemy, quicknode, infura, parity, nethermind, debug_geth,...


Near line 252: Possible spelling mistake found.
Context: ...hemy, quicknode, infura, parity, nethermind, debug_geth, erigon, basic, any...


Near line 252: Possible spelling mistake found.
Context: ...ode, infura, parity, nethermind, debug_geth, erigon, basic, any`. | ...


Near line 252: Possible spelling mistake found.
Context: ..., parity, nethermind, debug_geth, erigon, basic, any. | ## Gener...


Near line 260: The phrase ‘has the ability to’ might be wordy. Consider using “can”.
Context: ... up the chain: * The Admin address has the ability to upgrade contracts. * The Batcher ad...


Near line 261: Possible spelling mistake found.
Context: ...e ability to upgrade contracts. * The Batcher address publishes Sequencer transactio...


Near line 310: Possible spelling mistake found.
Context: ...he previous step and paste it into your .envrc file as directed. {

Fund the addre...


Near line 314: Possible spelling mistake found.
Context: ...end ETH to the Admin, Proposer, and Batcher addresses.** The exact amount of ETH r...


Near line 316: Possible missing comma found.
Context: ...need to send any ETH to the Sequencer address as it does not send transactions.** It...


Near line 318: Possible spelling mistake found.
Context: ...s with the following amounts when using Sepolia: * Admin — 0.5 Sepolia ETH * `Pr...


Near line 320: Possible spelling mistake found.
Context: ... when using Sepolia: * Admin — 0.5 Sepolia ETH * Proposer — 0.2 Sepolia ETH * ...


Near line 321: Possible spelling mistake found.
Context: ... — 0.5 Sepolia ETH * Proposer — 0.2 Sepolia ETH * Batcher — 0.1 Sepolia ETH </...


Near line 322: Possible spelling mistake found.
Context: ...— 0.2 Sepolia ETH * Batcher` — 0.1 Sepolia ETH ## Load Environment vari...


Near line 338: Possible spelling mistake found.
Context: ...imism ``` {

Load the variables with direnv

} You're about to use `d...


Near line 344: Possible missing comma found.
Context: ...hell](#configuring-direnv). Next you'll need to allow direnv to read t...


Near line 345: Possible spelling mistake found.
Context: .... Next you'll need to allow direnv to read this file and load the variabl...


Near line 358: Possible spelling mistake found.
Context: ...iables were loaded} After running direnv allow you should see output that looks...


Near line 365: Possible spelling mistake found.
Context: ...you likely haven't properly configured direnv.** Make sure you...


Near line 366: Possible spelling mistake found.
Context: ...-direnv).** Make sure you've configured direnv properly and run direnv allow again ...


Near line 366: Possible spelling mistake found.
Context: ...ve configured direnv properly and run direnv allow again so that you see the desire...


Near line 373: This phrase is redundant. Consider using “inside”.
Context: ...n. Currently, chain configuration lives inside of the [contracts-bedrock](https://githu...


Near line 391: Possible spelling mistake found.
Context: ...un the following script to generate the getting-started.json configuration file inside of the `depl...


Near line 391: This phrase is redundant. Consider using “inside”.
Context: ...etting-started.jsonconfiguration file inside of thedeploy-config` directory. ```bash...


Near line 399: Possible spelling mistake found.
Context: ...e that was just generated by opening up deploy-config/getting-started.json in your favorite text editor. It's rec...


Near line 406: Possible spelling mistake found.
Context: ... OP Stack chain to a network other than Sepolia, you may need to deploy a Create2 facto...


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


Near line 428: Possible spelling mistake found.
Context: ...ip this section. {

Fund the factory deployer

} You will need to send some ETH t...


Near line 485: Possible missing comma found.
Context: ...es Now that you've set up the L1 smart contracts you can automatically generate several ...


Near line 489: This sentence does not start with an uppercase letter.
Context: ...ee important files: 1. genesis.json includes the genesis state of the chain for the ...


Near line 490: This sentence does not start with an uppercase letter.
Context: ...the Execution Client. 2. rollup.json includes configuration information for the Conse...


Near line 491: This sentence does not start with an uppercase letter.
Context: ...for the Consensus Client. 3. jwt.txt is a [JSON Web Token](https://jwt.io/intro...


Near line 503: Possible spelling mistake found.
Context: ...is files} Now you'll generate the genesis.json and rollup.json files within the `op...


Near line 503: Possible spelling mistake found.
Context: ... you'll generate the genesis.json and rollup.json files within the op-node folder...


Near line 524: Possible spelling mistake found.
Context: ...t ``` {

Copy genesis files into the op-geth directory

} Finally, you'll need t...


Near line 526: Possible spelling mistake found.
Context: .../h3>} Finally, you'll need to copy the genesis.json file and jwt.txt file into op-geth...


Near line 526: Possible spelling mistake found.
Context: ...esis.jsonfile andjwt.txtfile intoop-geth` so you can use it to initialize and ru...


Near line 526: Possible spelling mistake found.
Context: ...so you can use it to initialize and run op-geth: ```bash cp genesis.json ~/op-geth cp...


Near line 538: Possible spelling mistake found.
Context: ...eed to run a few commands to initialize op-geth. You're going to be running a Sequence...


Near line 539: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... be running a Sequencer node, so you'll need to import the Sequencer private key that...


Near line 544: Possible spelling mistake found.
Context: ... blocks. {

Navigate to the op-geth directory

} ```bash cd ~/op-geth `...


Near line 556: Possible spelling mistake found.
Context: ...bash mkdir datadir {<h3>Initialize op-geth</h3>} bash build/bin/geth init --da...


Near line 566: Possible spelling mistake found.
Context: ...> ## Start op-geth Now you'll start op-geth, your Execution Client. Note that you ...


Near line 573: Possible spelling mistake found.
Context: ...} You'll need a terminal window to run op-geth in. {

Navigate to the op-geth dire...


Near line 575: Possible spelling mistake found.
Context: ...run op-geth in. {

Navigate to the op-geth directory

} ```bash cd ~/op-geth `...


Near line 581: Possible spelling mistake found.
Context: ...3>} bash cd ~/op-geth {

Run op-geth

} You're usi...


Near line 622: Possible spelling mistake found.
Context: ...s> ## Start op-node Once you've got op-geth running you'll need to run op-node. ...


Near line 623: Possible spelling mistake found.
Context: ...nt (op-node) and an Execution Client (op-geth). The Consensus Client "drives" the Ex...


Near line 658: Possible spelling mistake found.
Context: ...L1 chain, it'll begin to send blocks to op-geth for execution. At that point, you'll s...


Near line 659: This phrase is redundant. Consider using “inside”.
Context: ...ou'll start to see blocks being created inside of op-geth. **By ...


Near line 659: Possible spelling mistake found.
Context: ...t to see blocks being created inside of op-geth. **By default, ...


Near line 684: Possible spelling mistake found.
Context: ...> ## Start op-batcher The op-batcher takes transactions from the Sequencer ...


Near line 686: Possible spelling mistake found.
Context: ...cially part of the canonical chain. The op-batcher is critical! It's best to give the `B...


Near line 688: Possible spelling mistake found.
Context: ...eris critical! It's best to give theBatcher` address at least 1 Sepolia ETH to ensu...


Near line 688: Possible spelling mistake found.
Context: ...o give the Batcher address at least 1 Sepolia ETH to ensure that it can continue oper...


Near line 689: Possible spelling mistake found.
Context: ... gas. Keep an eye on the balance of the Batcher address because it can expend ETH quic...


Near line 689: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ... it can expend ETH quickly if there are a lot of transactions to publish. {<h3...


Near line 695: Possible spelling mistake found.
Context: ...ou'll need a terminal window to run the op-batcher in. {

Navigate to the op-batcher d...


Near line 697: Possible spelling mistake found.
Context: ... op-batcher in. {

Navigate to the op-batcher directory

} ```bash cd ~/optimism/...


Near line 703: Possible spelling mistake found.
Context: ... cd ~/optimism/op-batcher {<h3>Run op-batcher</h3>} bash ./bin/op-batcher \ --l...


Near line 763: Did you mean “up”?
Context: ...Chain You now have a fully functioning OP Stack Rollup with a Sequencer node runn...


Near line 763: Possible spelling mistake found.
Context: ...u now have a fully functioning OP Stack Rollup with a Sequencer node running on `http:...


Near line 770: Possible spelling mistake found.
Context: ... your chain. The easiest way to deposit Sepolia ETH into your chain is to send ETH dire...


Near line 786: Possible spelling mistake found.
Context: ...on | jq -r .address ``` {

Send some Sepolia ETH to the L1StandardBridgeProxy contra...


Near line 788: Possible spelling mistake found.
Context: ...allet that you want to have ETH on your Rollup, send that address a small amount of ET...


Near line 788: Possible spelling mistake found.
Context: ...d that address a small amount of ETH on Sepolia (0.1 or less is fine). This will trigge...


Near line 794: Possible spelling mistake found.
Context: ...ur wallet on L2. ## See Your Rollup in Action You can interact with your R...


Near line 796: Possible spelling mistake found.
Context: ...p in Action You can interact with your Rollup the same way you'd interact with any ot...


Near line 802: Possible spelling mistake found.
Context: ...optimism.io/) for more detail about the rollup protocol. * If you run into any probl...

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).
    "
Additional comments not posted (1)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (1)

105-105: Specify the reason for recommending this specific version of forge.

Adding a brief explanation about why this specific version of forge is recommended (e.g., compatibility with current scripts) could help users understand the importance of following this guidance.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

netlify bot commented Apr 24, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 8cd2cbb
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/662900bec716d70008c6157e
😎 Deploy Preview https://deploy-preview-651--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.

@@ -101,6 +101,8 @@ You may experience unexpected errors on older versions of Node.js.
#### `foundry`

It's recommended to use the scripts in the monorepo's `package.json` for managing `foundry` to ensure you're always working with the correct version. This approach simplifies the installation, update, and version checking process. Make sure to clone the monorepo locally before proceeding.

for forge , please use https://github.com/foundry-rs/foundry/releases/tag/nightly-5b7e4cb3c882b28f3c32ba580de27ce7381f415a, latest version of forge will cause address Lowercase issue and fail the sync() method
Copy link
Contributor

Choose a reason for hiding this comment

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

We should avoid pinning a specific version in the docs. We specify the version inside the monorepo and relatively frequently update it.

Copy link
Author

Choose a reason for hiding this comment

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

so far only this version works with the "Creating Your Own L2 Rollup Testnet" doc, other version I tested (latest 2 version of forge ) ,failed because of the Lowercase @trianglesphere

@sbvegan
Copy link
Collaborator

sbvegan commented Apr 29, 2024

This tutorial is currently getting updated here #657. I'm working with the team internally to figure out how to get the best practices in here.

@cpengilly
Copy link
Collaborator

closing, see @sbvegan comment above

@cpengilly cpengilly closed this Jun 9, 2024
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.

4 participants