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(ctb): Support OptimismPortal2
in kontrol tests
#10429
Conversation
WalkthroughWalkthroughThe recent changes focus on enhancing deployment and testing frameworks in a blockchain project, emphasizing fault-proof deployment and withdrawal transaction proofs. New scripts, test cases, and configurations were introduced to support these features and improve performance, particularly targeting the functionalities of the Optimism Portal. Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files ignored due to path filters (1)
Files selected for processing (11)
Files not summarized due to errors (1)
Files skipped from review as they are similar to previous changes (8)
Additional Context UsedLanguageTool (20)
Learnings (1)
Additional comments not posted (3)
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 (
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
0e568d1
to
da5a3ca
Compare
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: 2
f9d0299
to
a978e7f
Compare
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: 2
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: 2
Out of diff range and nitpick comments (1)
packages/contracts-bedrock/test/kontrol/proofs/utils/DeploymentSummaryFaultProofs.sol (1)
10-645
: Review the extensive use ofvm.etch
andvm.store
.The method
recreateDeployment
makes extensive use ofvm.etch
andvm.store
to manipulate contract storage. This approach is powerful but should be used with caution to avoid unintended side effects or security vulnerabilities. Ensure that these operations are wrapped in adequate safety checks and validations, especially when used in a broader testing framework.
packages/contracts-bedrock/test/kontrol/proofs/utils/DeploymentSummaryFaultProofs.sol
Outdated
Show resolved
Hide resolved
79ec385
to
8673e20
Compare
8673e20
to
10d62cf
Compare
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: 1
packages/contracts-bedrock/test/kontrol/proofs/utils/DeploymentSummaryFaultProofs.sol
Outdated
Show resolved
Hide resolved
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: 0
Out of diff range and nitpick comments (9)
packages/contracts-bedrock/test/kontrol/README.md (9)
Line range hint
24-24
: Check for a possible missing closing bracket for the link to Kontrol's documentation.
Line range hint
95-97
: Consider removing the extra spaces before the colons in the list items.
Line range hint
106-106
: Consider adding a comma after "options" for better readability.
Line range hint
118-118
: Consider simplifying the phrase "Hence, in order to write a proof for a contract which is not present inKontrolDeployment
it must be added there first." to "To write a proof for a contract not present inKontrolDeployment
, add it there first."
Line range hint
131-131
: After "In the future," add a comma for better readability.
Line range hint
131-131
: Change "there might interfaces" to "there might be interfaces".- there might interfaces + there might be interfaces
Line range hint
166-166
: Consider changing "deploy" to "deployment" for correct usage.- changes to the deploy script + changes to the deployment script
Line range hint
179-179
: Add a comma after "Therefore" for better readability.
Line range hint
193-193
: Change "workaround" to "work around".- to workaround their absence + to work around their absence
48d8bfb
to
75f4eab
Compare
Adds a second `DeploymentSummary` to `kontrol` for fault proofs, and ports the existing `OptimismPortal` proofs with the `OptimismPortal2`.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Matt Solomon <matt@mattsolomon.dev>
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: 1
Out of diff range and nitpick comments (1)
packages/contracts-bedrock/test/kontrol/proofs/utils/DeploymentSummaryFaultProofs.sol (1)
1-3
: Ensure the file header comment is accurate and up-to-date.The comment "Do not edit this file manually" is crucial for autogenerated files to prevent manual edits that could be overwritten. Ensure this policy is well communicated and adhered to.
75f4eab
to
584f398
Compare
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: 1
packages/contracts-bedrock/test/kontrol/proofs/utils/DeploymentSummaryFaultProofs.sol
Show resolved
Hide resolved
* feat(ctb): Support `OptimismPortal2` in kontrol tests Adds a second `DeploymentSummary` to `kontrol` for fault proofs, and ports the existing `OptimismPortal` proofs with the `OptimismPortal2`. * summary tests * Update packages/contracts-bedrock/test/kontrol/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * tests * Update `check-snapshots` * Update packages/contracts-bedrock/test/kontrol/README.md Co-authored-by: Matt Solomon <matt@mattsolomon.dev> * Separate snapshot gen --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Matt Solomon <matt@mattsolomon.dev>
* feat(ctb): Support `OptimismPortal2` in kontrol tests Adds a second `DeploymentSummary` to `kontrol` for fault proofs, and ports the existing `OptimismPortal` proofs with the `OptimismPortal2`. * summary tests * Update packages/contracts-bedrock/test/kontrol/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * tests * Update `check-snapshots` * Update packages/contracts-bedrock/test/kontrol/README.md Co-authored-by: Matt Solomon <matt@mattsolomon.dev> * Separate snapshot gen --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Matt Solomon <matt@mattsolomon.dev>
Overview
Adds a second
DeploymentSummary
tokontrol
for fault proofs, andports the existing
OptimismPortal
proofs with theOptimismPortal2
.