docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon ethereum-optimism

docs: pre-image URL

Open PaulRBerg opened this issue 1 year ago • 2 comments

Description

Adds a link to the spec for the Preimage Oracle API.

Additional context

https://specs.optimism.io/experimental/fault-proof/index.html#pre-image-oracle

PaulRBerg avatar May 23 '24 08:05 PaulRBerg

Walkthrough

The update enhances the Fault Proof Program (FPP) documentation by linking to the Preimage Oracle API specification and clarifying the dual roles of the op-program. It distinguishes between the "client" component, which operates within the Fault Proof Program, and the "host" component, which retrieves preimages from nodes via JSON-RPC requests.

Changes

Files Change Summary
pages/stack/protocol/fault-proofs/overview.mdx Updated the reference to the Preimage Oracle API with a hyperlink and clarified the dual roles of op-program.
Recent Review Details

Configuration used: .coderabbit.yaml Review profile: CHILL

Commits Files that changed from the base of the PR and between bbcefd0870e445b827691bae38f30cb6b0ae6114 and 2abb2d4b04e989c408e5938bfe091efc63fd78f1.
Files selected for processing (1)
  • pages/stack/protocol/fault-proofs/overview.mdx (1 hunks)
Additional Context Used
LanguageTool (8)
pages/stack/protocol/fault-proofs/overview.mdx (8)

Near line 13: Style-wise, it’s not ideal to insert an adverb (‘eventually’) in the middle of an infinitive construction (‘to enable’). Try moving the adverb to avoid split infinitives. Context: ... a dispute game protocol. The system is designed to eventually enable secure bridging without central fallback. The modular d...

Near line 30: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it. Context: ...roof systems, unique dispute games, and a variety of FPVMs in the future. * custom-built f...

Near line 32: Possible missing comma found. Context: ... ZKVM. * dispute games in the dispute protocol backed by multiple security mechanisms....

Near line 51: Consider a more expressive alternative. Context: ... to be proven in the L1 EVM onchain. To do this, only one instruction is proven at...

Near line 51: Consider adding a comma after ‘generally’ for more clarity. Context: ...n may look different for each FPVM, but generally it looks similar to Cannon, which prove...

Near line 71: Possible missing article found. Context: ...` executes a single instruction step on chain using a generic VM. The VM's state tran...

Near line 72: Unpaired symbol: ‘'’ seems to be missing Context: ...hing, so long as it adheres to the form T(s, i) -> s', where s = the agreed upon prestate,...

Near line 72: Unpaired symbol: ‘'’ seems to be missing Context: ... i = the state transition inputs, and s' = the post state. The first full impl...

Path-based Instructions (1)
pages/stack/protocol/fault-proofs/overview.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/stack/protocol/fault-proofs/overview.mdx (1)

41-41: Update the link to use proper title casing as per the guidelines.

- All data is retrieved via the [Preimage Oracle API](https://specs.optimism.io/experimental/fault-proof/index.html#pre-image-oracle).
+ All data is retrieved via the [Preimage Oracle API Specification](https://specs.optimism.io/experimental/fault-proof/index.html#pre-image-oracle).

Likely invalid or redundant comment.

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.

coderabbitai[bot] avatar May 23 '24 08:05 coderabbitai[bot]

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 2abb2d4b04e989c408e5938bfe091efc63fd78f1
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/664efd0f41c12400084886ed
Deploy Preview https://deploy-preview-711--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 May 23 '24 08:05 netlify[bot]