fp updates #732
fp updates #732
Conversation
cpengilly
commented
Jun 10, 2024
cpengilly
commented
- new explainer page, components page (was previous overview page), new fp security page
- small updates to mips.sol and security faq (maybe this isn't needed)
- redirects file update
- new explainer page, components page (was previous overview page), new fp security page - small updates to mips.sol and security faq (maybe this isn't needed) - redirects file update
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: soyboy <[email protected]>
Co-authored-by: Adrian Sutton <[email protected]>
|
Warning Rate limit exceeded@cpengilly has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 32 minutes and 52 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. WalkthroughThe changes primarily focus on updating the documentation and enhancing the security model for the Fault Proof System within the Optimism ecosystem. This includes renaming files, updating hyperlinks, adding new explanations, and refining the descriptions of various components and security mechanisms. Additionally, the changes introduce new JSON keys and redirect URLs to reflect the updated structure. Changes
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: 10
Outside diff range and nitpick comments (12)
pages/builders/notices/fp-changes.mdx (2)
Line range hint
45-45: Consider adding an article for clarity.- Most notable change for developers is that withdrawals will have to be proven against the `rootClaim` of some dispute game rather than referencing an output in the `L2OutputOracle` contract. + The most notable change for developers is that withdrawals will have to be proven against the `rootClaim` of some dispute game rather than referencing an output in the `L2OutputOracle` contract.
Line range hint
46-46: Consider adding a comma for better readability.- ...against the `rootClaim` of some dispute game rather than referencing an output in the... + ...against the `rootClaim` of some dispute game, rather than referencing an output in the...pages/stack/protocol/fault-proofs/fp-components.mdx (2)
Line range hint
34-34: Consider adding a comma for better readability.- ...dispute games in the dispute protocol backed by multiple security mechanisms. + ...dispute games in the dispute protocol, backed by multiple security mechanisms.Tools
LanguageTool
[style] ~15-~15: 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. (SPLIT_INFINITIVE)
Context: ... a dispute game protocol. The system is designed to eventually enable secure bridging without central fallback. The modular d...
Line range hint
56-56: Consider adding an article for clarity.- ...the program writes a hash as request for a pre-image, and then reads the value in small chunks at a time. + ...the program writes a hash as a request for a pre-image, and then reads the value in small chunks at a time.Tools
LanguageTool
[style] ~15-~15: 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. (SPLIT_INFINITIVE)
Context: ... a dispute game protocol. The system is designed to eventually enable secure bridging without central fallback. The modular d...pages/stack/protocol/fault-proofs/mips.mdx (8)
Line range hint
26-26: Clarify the phrase "up until this instruction" to enhance precision.- ...is the previously agreed-upon L2 state up until this instruction... + ...is the previously agreed-upon L2 state until this instruction...
Line range hint
38-38: Consider using concise language to enhance readability.- ...up to 3 different types of witness data in order to perform a single MIPS instruction onchain... - ...In order to execute a MIPS instruction onchain, the `MIPS.sol` contract needs to know... - ...The primary reason for this is because having to load the entire memory into the `MIPS.sol` contract in order to execute a single instruction onchain is prohibitively expensive... - ...Therefore, in order to optimize the amount of data that needs to be provided per onchain instruction execution while still maintaining integrity over the entire 32-bit address space... - ...In order to ensure the integrity of the entire address space each time memory is read or written to... - ...The address is used as the path in order to determine the order for hashing two nodes... - ...will be called by an active dispute game in order to determine the true post state given a pre state and a MIPS instruction to run... + ...up to 3 different types of witness data to perform a single MIPS instruction onchain... + ...To execute a MIPS instruction onchain, the `MIPS.sol` contract needs to know... + ...The primary reason for this is that loading the entire memory into the `MIPS.sol` contract to execute a single instruction onchain is prohibitively expensive... + ...Therefore, to optimize the amount of data provided per onchain instruction execution while still maintaining integrity over the entire 32-bit address space... + ...To ensure the integrity of the entire address space each time memory is read or written to... + ...The address is used as the path to determine the order for hashing two nodes... + ...will be called by an active dispute game to determine the true post state given a pre state and a MIPS instruction to run...Also applies to: 51-51, 85-85, 85-85, 87-87, 154-154, 169-169
Line range hint
53-53: Remove the redundant hyphen in "tightly-packed".- ...More specifically, a tightly-packed `State` struct contains all the relevant information... + ...More specifically, a tightly packed `State` struct contains all the relevant information...
Line range hint
58-58: Remove the unnecessary comma after "so that".- ...the offset into the Pre-image being read, so that an instruction can continue reading a Pre-image... + ...the offset into the Pre-image being read so that an instruction can continue reading a Pre-image...
Line range hint
87-87: Consider rephrasing "exactly the same" to a more concise form.- ...This merkle root should be exactly the same as the merkle root stored in the VM execution State struct... + ...This merkle root should match the merkle root stored in the VM execution State struct...
Line range hint
119-119: Clarify the use of "write" in the context of a syscall.- ...the file descriptor 6 as the target of the write syscall... + ...the file descriptor 6 as the target of the write operation in the syscall...
Line range hint
119-119: Remove the redundant hyphen in "newly-derived".- ...at the location of the newly-derived `preimageKey`. + ...at the location of the newly derived `preimageKey`.
Line range hint
178-178: Separate "however" from the sentence for better readability.- ...instructions according to the MIPS specification, however other instructions will pass through this function... + ...instructions according to the MIPS specification; however, other instructions will pass through this function...
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (1)
pages/stack/protocol/fault-proofs/explainer.mdx (1)
4-4: Ensure the description is concise and informative.The description is well-written and concise, providing a clear overview of the content to be expected in the document.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
