-
Notifications
You must be signed in to change notification settings - Fork 26
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
Create OP-Alt-DA.md #126
Create OP-Alt-DA.md #126
Conversation
WalkthroughThe new documentation provides a detailed guide to running NEAR DA with OP Alt-DA mode, focusing on setup for localnet and testnet environments. It includes specific instructions for configuring the NEAR DA Server and OP Node, detailing necessary account IDs, secret keys, contract IDs, and network parameters. It also outlines how to run Docker compose setups and configure OP Node and Batcher settings to enable Alt-DA mode, facilitating communication between OP components and the DA server. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant NEAR DA Server
participant OP Node
participant Batcher
User->>NEAR DA Server: Configure server
User->>OP Node: Configure node for Alt-DA
User->>Batcher: Configure batcher for Alt-DA
NEAR DA Server->>OP Node: Send network configurations
OP Node->>Batcher: Communicate with batcher
Batcher->>NEAR DA Server: Verify data on read
Batcher->>OP Node: Enable Alt-DA mode
Note over OP Node, Batcher: Alt-DA mode enabled and verified
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 Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 8
Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Files selected for processing (1)
- docs/OP-Alt-DA.md (1 hunks)
Additional context used
LanguageTool
docs/OP-Alt-DA.md
[grammar] ~48-~48: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...perators/tutorials/create-l2-rollup) to setup your OP Node. Check the ports in `dock...(NOUN_VERB_CONFUSION)
Markdownlint
docs/OP-Alt-DA.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
76-76: Expected: 0 or 2; Actual: 3
Trailing spaces(MD009, no-trailing-spaces)
31-31: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
51-51: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
93-93: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
77-77: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
94-94: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Additional comments not posted (1)
docs/OP-Alt-DA.md (1)
1-6
: LGTM!The introduction section is clear and concise.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 10
Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Files selected for processing (1)
- docs/OP-Alt-DA.md (1 hunks)
Additional context used
Markdownlint
docs/OP-Alt-DA.md
75-75: Expected: 0 or 2; Actual: 3
Trailing spaces(MD009, no-trailing-spaces)
50-50: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
92-92: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
89-89: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
76-76: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
93-93: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Additional comments not posted (1)
docs/OP-Alt-DA.md (1)
20-20
: Avoid hardcoding secret keys.Hardcoding secret keys in the documentation is a security risk. Consider using placeholders or environment variables.
- "secret_key": "ed25519:4dagBsEqCv3Ao5wa4KKFa57xNAH4wuBjh9wdTNYeCqDSeA9zE7fCnHSvWpU8t68jUpcCGqgfYwcH68suPaqmdcgm", + "secret_key": "<your-secret-key>",Likely invalid or redundant comment.
OP Stack Alt-DA Readme
This change is
Summary by CodeRabbit
Documentation
Configuration Changes