Add Audit Reports #1169
Add Audit Reports #1169
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces several modifications across multiple files, primarily focusing on the In the Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolwords.txt[duplication] ~69-~69: Möglicher Tippfehler: ein Wort wird wiederholt (GERMAN_WORD_REPEAT_RULE) 🔇 Additional comments (4)words.txt (4)
The term "ConsenSys" has been properly added, addressing the previous review comment about the incomplete term "Consen".
The term "Pausability" is correctly cased and aligns with common smart contract security terminology.
The term "Permissioned" is correctly added and properly cased, matching standard blockchain terminology.
Please verify that "Dapphub" should not be "DappHub" as the latter appears to be the more common styling in their official communications. 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (2)
pages/stack/audits-report.mdx (2)
11-11: Revise introduction text to avoid using "our"Replace personal pronouns with proper nouns to maintain consistency in communal documentation.
-Security is a top priority for the OP Stack. Below, you'll find a comprehensive list of past audits conducted on various components of our ecosystem. Each report includes the scope, focus, and a link to the full audit documentation. These reviews ensure that our system is secure and reliable for all users. +Security is a top priority for the OP Stack. Below, you'll find a comprehensive list of past audits conducted on various components of the OP Stack ecosystem. Each report includes the scope, focus, and a link to the full audit documentation. These reviews ensure that the system is secure and reliable for all users.
27-30: Use consistent formatting for contract namesSome contract names use backticks while others don't. Apply backticks consistently for all contract names.
-| 2022-10 | Spearbit | Drippie: `Drippie.sol` | <Link href="/audit-reports/2022_10-Drippie-Spearbit.pdf" target="_blank"> view </Link> | -| 2022-11 | Trail of Bits | Invariant Testing: `OptimismPortal.sol` | <Link href="/audit-reports/2022_11-Invariant_Testing-TrailOfBits.pdf" target="_blank"> view </Link> | -| 2022-12 | Runtime Verification | Deposit Transaction: `OptimismPortal.sol` | <Link href="/audit-reports/2022_12-DepositTransaction-RuntimeVerification.pdf" target="_blank"> view </Link> | -| 2023-01 | Trail of Bits | Bedrock Updates: `SystemConfig.sol` | <Link href="/audit-reports/2023_01-Bedrock_Updates-TrailOfBits.pdf" target="_blank"> view </Link> | +| 2022-10 | Spearbit | Drippie: `Drippie.sol` | <Link href="/audit-reports/2022_10-Drippie-Spearbit.pdf" target="_blank">view</Link> | +| 2022-11 | Trail of Bits | Invariant Testing: `OptimismPortal.sol` | <Link href="/audit-reports/2022_11-Invariant_Testing-TrailOfBits.pdf" target="_blank">view</Link> | +| 2022-12 | Runtime Verification | Deposit Transaction: `OptimismPortal.sol` | <Link href="/audit-reports/2022_12-DepositTransaction-RuntimeVerification.pdf" target="_blank">view</Link> | +| 2023-01 | Trail of Bits | Bedrock Updates: `SystemConfig.sol` | <Link href="/audit-reports/2023_01-Bedrock_Updates-TrailOfBits.pdf" target="_blank">view</Link> |
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (18)
public/audit-reports/2020_10-Rollup-TrailOfBits.pdfis excluded by!**/*.pdfpublic/audit-reports/2020_11-Dapphub-ECDSA_Wallet.pdfis excluded by!**/*.pdfpublic/audit-reports/2021_03-OVM_and_Rollup-OpenZeppelin.pdfis excluded by!**/*.pdfpublic/audit-reports/2021_03-SafetyChecker-ConsenSysDiligence.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_05-Bedrock_Contracts-Zeppelin.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_05-OpNode-TrailOfBits.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_08-Bedrock_GoLang-SigmaPrime.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_09-Bedrock_and_Periphery-Zeppelin.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_10-Drippie-Spearbit.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_11-Invariant_Testing-TrailOfBits.pdfis excluded by!**/*.pdfpublic/audit-reports/2022_12-DepositTransaction-RuntimeVerification.pdfis excluded by!**/*.pdfpublic/audit-reports/2023_01-Bedrock_Updates-TrailOfBits.pdfis excluded by!**/*.pdfpublic/audit-reports/2023_12_SuperchainConfigUpgrade_Trust.pdfis excluded by!**/*.pdfpublic/audit-reports/2024_02-MCP_L1-Cantina.pdfis excluded by!**/*.pdfpublic/audit-reports/2024_05-FaultProofs-Sherlock.pdfis excluded by!**/*.pdfpublic/audit-reports/2024_05_SafeLivenessExtensions-Cantina.pdfis excluded by!**/*.pdfpublic/audit-reports/2024_08_Fault-Proofs-MIPS_Cantina.pdfis excluded by!**/*.pdfpublic/audit-reports/2024_08_Fault-Proofs-No-MIPS_Spearbit.pdfis excluded by!**/*.pdf
📒 Files selected for processing (3)
pages/stack/_meta.json(1 hunks)pages/stack/audits-report.mdx(1 hunks)words.txt(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/audits-report.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. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for 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).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
words.txt
[duplication] ~69-~69: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...onfs Consen corsdomain counterfactually Crosschain crosschain Crossmint Dapphub daserver DATACAP data...
(GERMAN_WORD_REPEAT_RULE)
🔇 Additional comments (1)
pages/stack/_meta.json (1)
13-13: LGTM!
The new entry follows the existing format and is appropriately placed before the experimental section.
pages/stack/audits-report.mdx
Outdated
| | 2024-03 | Sherlock | Fault Proofs | [view](https://github.com/sherlock-audit/2024-02-optimism-2024) | | ||
| | 2024-08 | Cantina | Fault proof MIPS: `MIPS.sol` | <Link href="/audit-reports/2024_08_Fault-Proofs-MIPS_Cantina.pdf" target="_blank"> view </Link> | | ||
| | 2024-08 | Spearbit | Fault proof no-MIPS: Dispute contracts | <Link href="/audit-reports/2024_08_Fault-Proofs-No-MIPS_Spearbit.pdf" target="_blank"> view </Link> | | ||
| | 2024-10 | 3Doc Security | Fault proof MIPS: `MIPS.sol` | <Link href="https://github.com/ethereum-optimism/optimism/edit/develop/docs/security-reviews/2024_10-Cannon-FGETFD-3DocSecurity.md" target="_blank"> view </Link> | |
There was a problem hiding this comment.
@sbvegan This audit doesn’t have a PDF file. Is it okay to link directly to the monorepo inste
pages/stack/audits-report.mdx
Outdated
| | 2023-01 | Sherlock | Bedrock: All contracts in `packages/contracts-bedrock/src` | [view](https://github.com/sherlock-audit/2023-01-optimism) | | ||
| | 2023-03 | Sherlock | Bedrock Fixes: All contracts in `packages/contracts-bedrock/src` | [view](https://github.com/sherlock-audit/2023-03-optimism) | |
There was a problem hiding this comment.
@sbvegan Should we update this link since it points to an archived repo? If yes, what's the preferred current repo we should direct users to?
pages/stack/audits-report.mdx
Outdated
| | 2023-12 | Trust | Superchain Config Upgrade: Various contracts | <Link href="/audit-reports/2023_12_SuperchainConfigUpgrade_Trust.pdf" target="_blank"> view </Link> | | ||
| | 2024-02 | Runtime Verification | Pausability | [view](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/test/kontrol/README.md) | | ||
| | 2024-02 | Cantina | MCP L1: Various contracts | <Link href="/audit-reports/2024_02-MCP_L1-Cantina.pdf" target="_blank"> view </Link> | | ||
| | 2024-03 | Sherlock | Fault Proofs | [view](https://github.com/sherlock-audit/2024-02-optimism-2024) | |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
pages/stack/security/audits-report.mdx (2)
31-32: Standardize link formattingFor consistency, use the Next.js Link component for all external links instead of mixing markdown and Link component syntax.
-| 2023-01 | Sherlock | Bedrock: All contracts in `packages/contracts-bedrock/src` | [view](https://github.com/sherlock-audit/2023-01-optimism) | -| 2023-03 | Sherlock | Bedrock Fixes: All contracts in `packages/contracts-bedrock/src` | [view](https://github.com/sherlock-audit/2023-03-optimism) | +| 2023-01 | Sherlock | Bedrock: All contracts in `packages/contracts-bedrock/src` | <Link href="https://github.com/sherlock-audit/2023-01-optimism" target="_blank">view</Link> | +| 2023-03 | Sherlock | Bedrock Fixes: All contracts in `packages/contracts-bedrock/src` | <Link href="https://github.com/sherlock-audit/2023-03-optimism" target="_blank">view</Link> |
27-28: Standardize contract name formattingMaintain consistent formatting for contract names in the Focus and Scope column. Some use backticks while others don't.
-| 2022-10 | Spearbit | Drippie: `Drippie.sol` | +| 2022-10 | Spearbit | Drippie: Drippie.sol |Also applies to: 37-38
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/stack/security.mdx(1 hunks)pages/stack/security/_meta.json(1 hunks)pages/stack/security/audits-report.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/stack/security/_meta.json
🧰 Additional context used
📓 Path-based instructions (2)
pages/stack/security.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. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for 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).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/security/audits-report.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. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for 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).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🔇 Additional comments (2)
pages/stack/security.mdx (1)
17-18: LGTM: Card addition follows documentation standards
The new audit report card maintains consistent formatting and proper title case usage.
pages/stack/security/audits-report.mdx (1)
9-9: LGTM: Headers follow sentence case guidelines
The headers "Audit reports" and "Summary" correctly use sentence case and maintain proper capitalization.
Also applies to: 13-13
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
This PR introduces a new page under the OP Stack section that consolidates and displays all Optimism audit reports.
Changes include:
Tests
Additional context
Metadata