feat: update to v3.0.0 #1609
feat: update to v3.0.0 #1609
Conversation
|
Warning Rate limit exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 47 minutes and 18 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis update introduces several significant changes to the Arbitrum integration documentation. Key updates include new deployment addresses, contract versions, and enhanced configuration options for validating full nodes. Descriptions of fallback mechanisms and contract addresses have been revised, along with an overall restructuring to reflect these changes. Changes
Sequence Diagram(s)The changes are primarily documentation and configuration updates, so sequence diagrams are not applicable here. Assessment against linked issues
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (2)
developers/arbitrum-deploy.md (2)
Line range hint
189-189: Consider adding a comma for clarity.- WebSocket (WSS) URLs which are essential for real-time data ... + WebSocket (WSS) URLs, which are essential for real-time data ...
Line range hint
246-246: Consider adding a comma after "accordingly" for better readability.- First understand the different variables that... + First, understand the different variables that...
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/arbitrum-deploy.md (5 hunks)
Additional context used
LanguageTool
developers/arbitrum-deploy.md
[uncategorized] ~189-~189: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...en running a full node. WebSocket (WSS) URLs which are essential for real-time data ...
[uncategorized] ~246-~246: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ave to configure your node accordingly. First understand the different variables that...
[uncategorized] ~248-~248: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...will be set in the config: -enable: set it to true if you are using Celes...
[uncategorized] ~255-~255: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...vents for Blobstream. -namespace-id: namespace being used to post data to ...
[uncategorized] ~258-~258: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ster, set to true if so. -gas-price: how much to pay for gas (in uTIA) - *...
[style] ~418-~418: Consider using “incompatible” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...rbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the lates...
[grammar] ~426-~426: You should probably use “relay”. (AGREEMENT_SENT_START)
Context: ...86777b499d6A665DF3ABD2` in both chains, relays headers from the Mocha-4 testnet to...
Markdownlint
developers/arbitrum-deploy.md
264-264: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
191-191: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
197-197: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
207-207: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
158-158: Expected: 80; Actual: 222 (MD013, line-length)
Line length
160-160: Expected: 80; Actual: 300 (MD013, line-length)
Line length
162-162: Expected: 80; Actual: 169 (MD013, line-length)
Line length
164-164: Expected: 80; Actual: 121 (MD013, line-length)
Line length
181-181: Expected: 80; Actual: 103 (MD013, line-length)
Line length
185-185: Expected: 80; Actual: 83 (MD013, line-length)
Line length
197-197: Expected: 80; Actual: 132 (MD013, line-length)
Line length
217-217: Expected: 80; Actual: 91 (MD013, line-length)
Line length
257-257: Expected: 80; Actual: 84 (MD013, line-length)
Line length
321-321: Expected: 80; Actual: 93 (MD013, line-length)
Line length
329-329: Expected: 80; Actual: 115 (MD013, line-length)
Line length
306-306: null (MD034, no-bare-urls)
Bare URL used
106-106: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe (MD055, table-pipe-style)
Table pipe style
Additional comments not posted (3)
developers/arbitrum-deploy.md (3)
416-416: Update the version of Nitro to align with the new release.Ensure that all components that depend on the Nitro version are compatible with v2.3.3.
440-440: Update the RollupCreator address as per the new deployment.Please verify that all references to the RollupCreator address across the documentation and configuration files have been updated to reflect this change.
445-445: Ensure the RollupCreator address in Base Sepolia is updated in all relevant contracts and documentation.Verify that this new address is correctly integrated into all deployment scripts and referenced configurations.
There was a problem hiding this comment.
Actionable comments posted: 9
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- developers/arbitrum-deploy.md (9 hunks)
- developers/arbitrum-full-node.md (2 hunks)
- developers/arbitrum-integration.md (4 hunks)
Additional context used
LanguageTool
developers/arbitrum-full-node.md
[uncategorized] ~46-~46: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ull nodes include: -tendermint-rpc: a celestia-core endpoint from a full ...
[uncategorized] ~51-~51: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... events for Blobstream. -blobstream: address of the Blobstream X contract ...developers/arbitrum-integration.md
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[style] ~50-~50: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...l! ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...
[style] ~51-~51: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...
[typographical] ~58-~58: Consider isolating this adverbial phrase with commas. (IN_FACT_COMMA_2)
Context: ...ng unpeeled as well as the row roots are in fact correct. ### Blobstream X implementati...
[uncategorized] ~73-~73: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ...e. ### DA fallback mechanism in Nitro By default in [Arbitrum Nitro](https://github.com/...
[style] ~91-~91: Try using a more formal synonym here to elevate your writing. (PLAN_ON_INTEND)
Context: ...e fallback to Anytrust is useful if you plan on having high throughput and cannot fallback to ...
[grammar] ~91-~91: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...an on having high throughput and cannot fallback to Ethereum because your blobs are too ...
[style] ~96-~96: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER)
Context: ...er to callVerifyAttestationto check if a data root has been posted on Blobstre...developers/arbitrum-deploy.md
[uncategorized] ~150-~150: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...tokens by your Orbit chain's validators the challenge mechanism, bridging mechanism...
[uncategorized] ~217-~217: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ave to configure your node accordingly. First understand the different variables that...
[uncategorized] ~219-~219: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...will be set in the config: -enable: set it to true if you are using Celes...
[uncategorized] ~223-~223: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... 1.01 increases the gas by 1%. -rpc: RPC endpoint for celestia-node - ...
[style] ~377-~377: Consider using “incompatible” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...rbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the lates...
[grammar] ~385-~385: You should probably use “relay”. (AGREEMENT_SENT_START)
Context: ...elopers/blobstream#deployed-contracts), relays headers from the Mocha-4 testnet to...
Markdownlint
developers/arbitrum-full-node.md
52-52: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
74-74: null (MD047, single-trailing-newline)
Files should end with a single newline characterdevelopers/arbitrum-integration.md
100-100: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
101-101: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank linesdevelopers/arbitrum-deploy.md
158-158: Expected: 80; Actual: 222 (MD013, line-length)
Line length
160-160: Expected: 80; Actual: 300 (MD013, line-length)
Line length
162-162: Expected: 80; Actual: 169 (MD013, line-length)
Line length
164-164: Expected: 80; Actual: 121 (MD013, line-length)
Line length
181-181: Expected: 80; Actual: 103 (MD013, line-length)
Line length
188-188: Expected: 80; Actual: 91 (MD013, line-length)
Line length
280-280: Expected: 80; Actual: 93 (MD013, line-length)
Line length
288-288: Expected: 80; Actual: 115 (MD013, line-length)
Line length
265-265: null (MD034, no-bare-urls)
Bare URL used
106-106: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe (MD055, table-pipe-style)
Table pipe style
Additional comments not posted (6)
developers/arbitrum-full-node.md (1)
46-52: Please confirm that theblobstreamaddress matches the latest contract deployment addresses provided.Verification successful
The
blobstreamaddress indevelopers/arbitrum-full-node.mdmatches the latest deployment addresses provided indevelopers/blobstream.md.
developers/arbitrum-full-node.md:"blobstream": "0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2"developers/blobstream.md:0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the `blobstream` address in the config matches the latest deployment. # Test: Search for the `blobstream` address in the contract deployment files. Expect: Address matches the one in the latest deployment. rg --type md $'0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2'Length of output: 835
Tools
LanguageTool
[uncategorized] ~46-~46: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ull nodes include: -tendermint-rpc: a celestia-core endpoint from a full ...
[uncategorized] ~51-~51: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... events for Blobstream. -blobstream: address of the Blobstream X contract ...Markdownlint
52-52: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentationdevelopers/arbitrum-integration.md (3)
2-2: Ensure the description accurately reflects the changes made in the PR.
40-40: Check that the core logic for data handling incelestia.gois up-to-date with the latest changes.
75-93: Confirm the updated fallback mechanisms are correctly implemented and no old references remain.Tools
LanguageTool
[style] ~91-~91: Try using a more formal synonym here to elevate your writing. (PLAN_ON_INTEND)
Context: ...e fallback to Anytrust is useful if you plan on having high throughput and cannot fallback to ...
[grammar] ~91-~91: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...an on having high throughput and cannot fallback to Ethereum because your blobs are too ...developers/arbitrum-deploy.md (2)
426-426: This correction from a previous review still applies. Please update accordingly.
375-378: ```shell
#!/bin/bashDescription: Confirm compatibility of the Orbit SDK with nitro-contracts.
Step 1: Perform repository maintenance.
Ensure the repository is in an optimal state for log retrieval.
git gc --aggressive
Step 2: Identify the latest changes in the nitro-contracts repository.
Get the latest commits in the nitro-contracts repository.
git log -n 10 --pretty=format:"%h - %s" -- nitro-contracts/
Step 3: Check the compatibility notes of the Orbit SDK.
Search for compatibility notes in the Orbit SDK repository.
rg "compatibility" --glob "orbit-sdk/**"
<details> <summary>Tools</summary> <details> <summary>LanguageTool</summary><blockquote> [style] ~377-~377: Consider using “incompatible” to avoid wordiness. (NOT_ABLE_PREMIUM) Context: ...rbit-sdk/releases/tag/v0.8.2) | This is not compatible with Orbit SDK v0.8.2 or with the lates... </blockquote></details> </details> </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 5
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- developers/arbitrum-full-node.md (2 hunks)
- developers/arbitrum-integration.md (5 hunks)
Additional context used
LanguageTool
developers/arbitrum-full-node.md
[uncategorized] ~46-~46: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ull nodes include: -tendermint-rpc: a celestia-core endpoint from a full ...
[uncategorized] ~51-~51: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... events for Blobstream. -blobstream: address of the Blobstream X contract ...developers/arbitrum-integration.md
[style] ~45-~45: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[style] ~54-~54: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...l! ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...
[style] ~55-~55: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...
[uncategorized] ~62-~62: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...square in which a blob resides in, this way each Orbit chain with Celestia undernea...
[typographical] ~62-~62: Consider isolating this adverbial phrase with commas. (IN_FACT_COMMA_2)
Context: ...ng unpeeled as well as the row roots are in fact correct. ### Blobstream X implementati...
[uncategorized] ~77-~77: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ...e. ### DA fallback mechanism in Nitro By default in [Arbitrum Nitro](https://github.com/...
[uncategorized] ~79-~79: This verb may not be in the correct tense. Consider changing the tense to fit the context better. (AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
Context: ...ter/arbnode/batch_poster.go#L989-L1001) is handling the process of storing data, with a fal...
[style] ~95-~95: Try using a more formal synonym here to elevate your writing. (PLAN_ON_INTEND)
Context: ...e fallback to Anytrust is useful if you plan on having high throughput and cannot fallback to ...
[grammar] ~95-~95: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...an on having high throughput and cannot fallback to Ethereum because your blobs are too ...
[style] ~100-~100: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER)
Context: ...er to callVerifyAttestationto check if a data root has been posted on Blobstre...
Markdownlint
developers/arbitrum-full-node.md
52-52: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentationdevelopers/arbitrum-integration.md
104-104: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
105-105: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
Additional comments not posted (4)
developers/arbitrum-integration.md (4)
2-2: Updated description to reflect new features.The description has been updated to include the DA fallback mechanism, aligning with the PR's objectives to enhance documentation on fallback options.
19-21: New features in version 3.0.0.Version 3.0.0 introduces the ability to write smart contracts in Rust using Arbitrum Stylus, which is a significant update for developers.
50-50: Update the message header flag.The message header flag for Celestia batches has been updated from '0x0c' to '0x63' to match the new specifications.
85-85: Link to updated fallback mechanism.The link to the fallback mechanism has been updated to point to the new version (v3.0.0), ensuring that the documentation remains accurate and up-to-date.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
open tasks from #1587 for @Ferret-san to help with 🙏
|
|
I think I will be closing this to make the nitro docs much more similar to the OP Stack docs cc @Ferret-san to confirm and then can close this |
|
closing in order to open a new PR. |
Overview
Updating nitro version and docs
Resolves #1587
Summary by CodeRabbit