Skip to content

Conversation

@bethoffman
Copy link

@bethoffman bethoffman commented Aug 29, 2025

Fix typos

Summary by CodeRabbit

  • Documentation
    • Corrected typos and wording across user-facing and developer docs (e.g., staking descriptions and gateway behavior) to improve clarity.
    • Fixed minor grammar in technical references (such as “targeted,” “fields,” and return-value descriptions) to reduce ambiguity.
    • Updated inline comments in cryptography and codec components to correct spelling and enhance comprehension.
    • No changes to product behavior, APIs, or interfaces.

@bethoffman bethoffman requested a review from a team as a code owner August 29, 2025 07:05
@bethoffman bethoffman requested review from twcctop and removed request for a team August 29, 2025 07:05
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 29, 2025

Walkthrough

Documentation-only typo corrections across multiple files. No code, logic, API, or control-flow changes.

Changes

Cohort / File(s) Summary of changes
Docs: contracts README
contracts/README.md
Corrected “targetted” → “targeted” in Echidna section.
Docs: Staking spec
contracts/contracts/Staking.md
Fixed “call form” → “call from” in three L2 staking call descriptions.
Docs: L2 Gateway
contracts/contracts/l2/gateways/L2CustomERC20Gateway.sol
Removed duplicated word in @dev: “tokens tokens” → “tokens”.
Docs: Codec libraries
contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol, contracts/contracts/libraries/codec/BatchHeaderCodecV1.sol
V0: “The the number” → “The number” in @return. V1: “feilds” → “fields” in doc header.
Docs: Prover verifier
prover/contracts/src/PlonkVerifier.sol
Fixed typos in comments: “evalutions” → “evaluations”; “numger” → “number”.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • r3aker86
  • MarvelFisher

Poem

A nibble of words, a hop through lines,
I tidy the trails where the typo twines.
From fields to tokens, the letters align—
Proofs now pristine, codecs refine.
Thump-thump! says the hare, with commit-time cheer,
Small fixes made, the path is clear. 🐇✍️

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
contracts/contracts/Staking.md (3)

22-22: Typo: “Rollp” → “Rollup”

User-facing heading.

-**Rollp Verify**
+**Rollup Verify**

11-11: Grammar: remove duplicated “yet” and add passive

Improves correctness and clarity.

-- MorphToken has not yet issued yet
+- MorphToken has not yet been issued

63-63: Punctuation/grammar fix

Replace non-ASCII comma and improve phrasing.

-- `L1` Claim allowed until reach unlock height,remove staker info after claiming
+- `L1` Claim allowed until reaching the unlock height; remove staker info after claiming
🧹 Nitpick comments (7)
contracts/contracts/libraries/codec/BatchHeaderCodecV1.sol (1)

21-23: Grammar fix: “are the fields” (and optionally fix code fence).

Change “Below is the fields” to “Below are the fields”. Also, there’s a closing code fence on Line 23 without a matching opener in this section—either add an opening “```text” above the list or remove the closing fence.

-/// @dev Below is the fields for `BatchHeader` V1
+/// @dev Below are the fields for `BatchHeader` V1
prover/contracts/src/PlonkVerifier.sol (1)

765-771: Quick pass to fix a few remaining doc typos.

Several minor typos remain in nearby comments; suggest correcting in this PR.

-        // at this point we have mPtr = [ b1 || b2] where b1 is on 32byes and b2 in 16bytes.
+        // at this point we have mPtr = [ b1 || b2 ] where b1 is on 32 bytes and b2 is 16 bytes.

-      /// @param q pointer to the second point (calladata)
+      /// @param q pointer to the second point (calldata)

-      /// @parma dst pointer storing the result
+      /// @param dst pointer storing the result

-      /// @parma dst pointer storing the result
+      /// @param dst pointer storing the result

Also applies to: 1226-1233, 1239-1246, 1253-1261

contracts/README.md (1)

11-12: Sweep remaining typos/formatting in this section.

A few obvious nits nearby worth fixing while touching docs.

-| [`L1CrossDomainMessenger`](../../specs/messengers.md)                              | [`ResolvedDelegateProxy`](./contracts/legacy/ResolvedDelegateProxy.sol) | High-level interface for sending messages to and receiving messages from M                       
+| [`L1CrossDomainMessenger`](../../specs/messengers.md)                              | [`ResolvedDelegateProxy`](./contracts/legacy/ResolvedDelegateProxy.sol) | High-level interface for sending messages to and receiving messages from Morph                   

-| [`L1StandardBridge`](../../specs/bridges.md)                                       | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol)         | Standardized system for transfering ERC20 tokens to/from Mo r p h                                
+| [`L1StandardBridge`](../../specs/bridges.md)                                       | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol)         | Standardized system for transferring ERC20 tokens to/from Morph                                  

-| [`AddressManager`](contracts/deployment/AddressManager.solol)   | L1       | -                                          | Legacy upgrade mechanism (unused in Bedrock)                                          
+| [`AddressManager`](contracts/deployment/AddressManager.sol)     | L1       | -                                          | Legacy upgrade mechanism (unused in Bedrock)                                          

-2. Fill out this file according to the `deployConfigSpec` located inside of the [`hardhat.config.ts](./hardhat.config.ts)
+2. Fill out this file according to the `deployConfigSpec` located inside of the [`hardhat.config.ts`](./hardhat.config.ts)

Also applies to: 35-36, 94-95

contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol (1)

16-17: Nit: “Preview state root” → “Previous state root”.

Matches the field name prevStateHash.

-///   * prevStateHash           32          bytes32     89      Preview state root
+///   * prevStateHash           32          bytes32     89      Previous state root
contracts/contracts/Staking.md (3)

118-118: Capitalize L2 and prefer “called by” phrasing for clarity

Keeps terminology consistent with the rest of the doc and improves readability.

- - Update sequencer set, call from l2 staking contract
+ - Update sequencer set, called by the L2 Staking contract

126-127: Consistency: capitalize L2; streamline phrasing

Aligns with surrounding sections and reduces redundancy (“delegator's delegation reward”).

- - Compute delegator's delegation reward, call from l2 staking contract
+ - Compute a delegator's reward, called by the L2 Staking contract
- - Compute sequencer's commission, call from l2 staking contract
+ - Compute a sequencer's commission, called by the L2 Staking contract

16-16: Terminology: capitalize ETH

Follows standard ticker capitalization.

-- `L1` Register and stake eth to become staker
+- `L1` Register and stake ETH to become staker
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8097851 and 76c8952.

📒 Files selected for processing (6)
  • contracts/README.md (1 hunks)
  • contracts/contracts/Staking.md (1 hunks)
  • contracts/contracts/l2/gateways/L2CustomERC20Gateway.sol (1 hunks)
  • contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol (1 hunks)
  • contracts/contracts/libraries/codec/BatchHeaderCodecV1.sol (1 hunks)
  • prover/contracts/src/PlonkVerifier.sol (2 hunks)
🔇 Additional comments (5)
prover/contracts/src/PlonkVerifier.sol (2)

263-265: Typo fix LGTM.

“evaluations” correction reads well.


806-810: Typo fix LGTM.

“number” correction is correct.

contracts/README.md (1)

82-83: Typo fix LGTM.

“targeted” is correct.

contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol (1)

70-71: Typo fix LGTM.

Return description reads correctly now.

contracts/contracts/l2/gateways/L2CustomERC20Gateway.sol (1)

14-15: Typo fix LGTM.

Redundant “tokens” removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant