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

feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san, remove mocha guide from menu temporarily #1388

Merged
merged 2 commits into from
Feb 5, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 31, 2024

Overview

Reverts accidental change from #1387

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated information on deploying to different networks within the .vitepress/config.ts file.
    • Adjusted tips and removed outdated sections in the developers/arbitrum-deploy.md file.
    • Removed an image related to Nitro Vroom and Celestia rollup deployment in the developers/arbitrum-mocha.md file.

@jcstein jcstein requested a review from Ferret-san January 31, 2024 20:41
Copy link
Contributor

coderabbitai bot commented Jan 31, 2024

Walkthrough

This update reflects the integration of Arbitrum into our development environment, streamlining deployment processes and enhancing compatibility with various networks. It marks a strategic move towards optimizing performance and cost-effectiveness in blockchain operations.

Changes

Files Change Summary
developers/arbitrum-deploy.md Adjusted RAM and CPU tip, removed Mocha testnet steps
.vitepress/config.ts Commented out Mocha testnet deployment functionality
developers/arbitrum-mocha.md Removed nitro-vroom.png image related to Mocha testnet

🐇✨
In the world of code, a rabbit hops,
Bringing Arbitrum, scaling non-stops.
Through the blockchain, it swiftly pops,
A leap for devs, in giant hops.
🚀🌟

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@jcstein jcstein changed the title feat: Update arbitrum-integration.md - add back credit to @ferret-san feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san Jan 31, 2024
Copy link
Contributor

github-actions bot commented Jan 31, 2024

PR Preview Action v1.4.6
🚀 Deployed preview to https://celestiaorg.github.io/docs/pr-preview/pr-1388/
on branch gh-pages at 2024-02-02 17:28 UTC

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 874ec9d and 7d28a3b.
Files selected for processing (1)
  • developers/arbitrum-integration.md (1 hunks)
Additional comments: 1
developers/arbitrum-integration.md (1)
  • 60-60: The addition of credit to @Ferret-san is appropriately placed within the context of the Blobstream integration section. This acknowledgment is crucial for maintaining the integrity of the documentation and recognizing contributions accurately. However, ensure that the link provided is accessible and points to the correct location in the repository to verify @Ferret-san's contribution.

@jcstein jcstein enabled auto-merge (squash) January 31, 2024 20:53
@jcstein jcstein requested a review from Bidon15 February 1, 2024 00:44
@jcstein jcstein self-assigned this Feb 1, 2024
@jcstein jcstein added the documentation Improvements or additions to documentation label Feb 1, 2024
@@ -57,7 +57,7 @@ Arbitrum `SequencerInbox.sol` contract.
In the `SequencerInbox.sol` contract, the `validateBatchData`
modifier has been designed to authenticate that the data root is
on Celestia when reading a batch of data. This is achieved by the
[following code in `arbnode/sequencer_inbox.go`](https://github.com/celestiaorg/nitro-contracts/blob/celestia/blobstream/src/bridge/SequencerInbox.sol#L334-L360):
[following code in `SequencerInbox.sol` by @Ferret-San](https://github.com/celestiaorg/nitro-contracts/blob/celestia/blobstream/src/bridge/SequencerInbox.sol#L334-L360):
Copy link
Member Author

Choose a reason for hiding this comment

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

this also fixes incorrect file name

@jcstein jcstein changed the title feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san, use stable commit, remove mocha guide from menu temporarily Feb 2, 2024
@jcstein jcstein changed the title feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san, use stable commit, remove mocha guide from menu temporarily feat: Update arbitrum-integration.md - fix file name and add back credit to @ferret-san, remove mocha guide from menu temporarily Feb 2, 2024
@jcstein
Copy link
Member Author

jcstein commented Feb 2, 2024

Validation has been achieved locally, see full logs and an example:

validator-1  | INFO [02-02|17:20:14.305] validated execution                      messageCount=3 globalstate="{BlockHash:0x7ee505b8e3b9e1256dea22003c4a412cff4b666cae79b1756df38c0aeb6f6010 SendRoot:0x0000000000000000000000000000000000000000000000000000000000000000 Batch:3 PosInBatch:0}" WasmRoots=[0x4fb94ef6426b04ed46b54ddadc13ec6b07c36691b8503bb924a25fcfc4177a1b]

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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7d28a3b and 483942b.
Files ignored due to path filters (2)
  • public/img/nitro-vroom-devnet.png is excluded by: !**/*.png
  • public/img/nitro-vroom.png is excluded by: !**/*.png
Files selected for processing (3)
  • .vitepress/config.ts (1 hunks)
  • developers/arbitrum-deploy.md (2 hunks)
  • developers/arbitrum-mocha.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • developers/arbitrum-mocha.md
Additional comments: 1
developers/arbitrum-deploy.md (1)
  • 118-120: The update to the tip about RAM and CPU requirements for validating blocks with WASM is clear and concise. However, ensure that the specific RAM and CPU requirements are based on accurate and up-to-date benchmarks to avoid misleading users.

developers/arbitrum-deploy.md Show resolved Hide resolved
.vitepress/config.ts Show resolved Hide resolved
@jcstein jcstein merged commit 7d741ef into main Feb 5, 2024
4 checks passed
@jcstein jcstein deleted the jcstein-patch-2 branch February 5, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants