docs icon indicating copy to clipboard operation
docs copied to clipboard
verified publisher icon ethereum-optimism

update devnet

Open opfocus opened this issue 1 year ago • 4 comments

Description This update is in response to changes on the develop branch.

Tests Tested: op-challenger logs:

t=2024-08-16T18:27:43+0000 lvl=info msg="Publishing transaction" service=challenger tx=0xf8f8eb89a35e3be0ce888a438769c286e58e9c4bdf61bf03fc79098dcafaed89 nonce=12 gasTipCap=1000000000 gasFeeCap=3000000000 gasLimit=128937 tx=0xf8f8eb89a35e3be0ce888a438769c286e58e9c4bdf61bf03fc79098dcafaed89
t=2024-08-16T18:27:43+0000 lvl=info msg="Transaction successfully published" service=challenger tx=0xf8f8eb89a35e3be0ce888a438769c286e58e9c4bdf61bf03fc79098dcafaed89 nonce=12 gasTipCap=1000000000 gasFeeCap=3000000000 gasLimit=128937 tx=0xf8f8eb89a35e3be0ce888a438769c286e58e9c4bdf61bf03fc79098dcafaed89
t=2024-08-16T18:27:55+0000 lvl=info msg="Transaction confirmed" service=challenger tx=0xf8f8eb89a35e3be0ce888a438769c286e58e9c4bdf61bf03fc79098dcafaed89 block=0xfb60dcceb1a6eaa896dbba9c6d85046d9d803b662a12de69ca1be9ebafedfb73:39 effectiveGasPrice=1005694214
t=2024-08-16T18:27:55+0000 lvl=info msg="Resolving game" game=0x490319228F94cd58Ee8071bb3e37090aF1764f36
t=2024-08-16T18:27:55+0000 lvl=info msg="Publishing transaction" service=challenger tx=0x79551c9249248721be7c2760fa23715f5cc1780175b6af1aabbd90649f4a1665 nonce=13 gasTipCap=1000000000 gasFeeCap=3000000000 gasLimit=74590 tx=0x79551c9249248721be7c2760fa23715f5cc1780175b6af1aabbd90649f4a1665
t=2024-08-16T18:27:55+0000 lvl=info msg="Transaction successfully published" service=challenger tx=0x79551c9249248721be7c2760fa23715f5cc1780175b6af1aabbd90649f4a1665 nonce=13 gasTipCap=1000000000 gasFeeCap=3000000000 gasLimit=74590 tx=0x79551c9249248721be7c2760fa23715f5cc1780175b6af1aabbd90649f4a1665

Additional context

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

Metadata

  • Fixes #[Link to Issue]

opfocus avatar Aug 16 '24 18:08 opfocus

Walkthrough

The recent changes update the installation and setup instructions for the development environment. Key modifications include the addition of the just utility for command execution, improvements to the Go installation process for better PATH configuration, and a shift to using just for Foundry installation commands. Additionally, the timing between L1 blocks has been adjusted from 3 seconds to 6 seconds.

Changes

Files Change Summary
pages/chain/testing/dev-node.mdx Updated installation instructions to include just, modified Go PATH setup, and revised Foundry commands. Adjusted L1 block timing from 3 seconds to 6 seconds.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Go
    participant Foundry

    User->>CLI: Install just
    CLI-->>User: Download and install just
    User->>CLI: Set up Go
    CLI-->>Go: Install Go
    Go-->>CLI: Configure PATH
    User->>CLI: Install Foundry
    CLI-->>Foundry: Execute just install-foundry
    Foundry-->>CLI: Installation status
Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL

Commits

Files that changed from the base of the PR and between 738719fcf52dad46a99ce7e4ec5bf72f8a2368f6 and 78cecf72e07bfef11547367987de9785bb028b8d.

Files selected for processing (1)
  • pages/chain/testing/dev-node.mdx (4 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. 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/chain/testing/dev-node.mdx

[style] ~100-~100: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ... sh just check-foundry If you need to, you can run the following ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Additional comments not posted (6)
pages/chain/testing/dev-node.mdx (6)

46-46: Consider linking to the official just documentation.

Instead of specifying the installation process for just, consider linking to its official documentation for installation instructions. This approach ensures users always have access to the latest and most accurate instructions.

48-48: Correct list-item indentation.

Add 1 space to align the list item correctly.

Apply this diff to fix the indentation:

-    *   Install the command line utilities `make` and `jq`:
+     *   Install the command line utilities `make` and `jq`:

59-59: Consider linking to the official Homebrew documentation.

Instead of specifying the installation process for Homebrew, consider linking to its official documentation for installation instructions. This ensures users have access to the latest and most accurate instructions.

61-61: Correct list-item indentation.

Remove 2 spaces to align the list item correctly.

Apply this diff to fix the indentation:

-    *   Install the required utilities:
+     * Install the required utilities:

71-71: Consider linking to the official Go documentation.

Instead of specifying the installation process for Go, consider linking to its official documentation for installation instructions. This ensures users have access to the latest and most accurate instructions.

127-127: Verify timing adjustment for L1 blocks.

The time between L1 blocks has been adjusted from 12 seconds to 6 seconds. Ensure this change aligns with the intended configuration and does not affect other dependent systems.

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.

coderabbitai[bot] avatar Aug 16 '24 18:08 coderabbitai[bot]

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 78cecf72e07bfef11547367987de9785bb028b8d
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66c76be5d9559000084bcdd8
Deploy Preview https://deploy-preview-834--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.

netlify[bot] avatar Aug 16 '24 18:08 netlify[bot]

This might be a matter of style preference. I made these changes simply to update the document, which is currently outdated. I updated it in a way that continues the original style. Since I'm not a native English speaker, I'm not skilled at making stylistic changes to the text

opfocus avatar Aug 19 '24 10:08 opfocus

Thanks for the contribution, someone will check it soon.

anacrolix avatar Aug 20 '24 06:08 anacrolix

Additional:Installation methods are also mentioned in other locations: https://github.com/ethereum-optimism/superchain-ops .

opfocus avatar Aug 21 '24 03:08 opfocus