maint(ct): misc comment cleanup

[smartcontracts]

Description
Some miscellaneous comment cleanup for dispute contracts.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates focus on enhancing the dispute resolution system within a blockchain framework, specifically optimizing the initialization of dispute games and refining the permission system for network operations. Key improvements include storing latest state information for efficient dispute game starts, refining permissioned dispute game operations, and improving documentation for clearer understanding and consistency. These changes aim to streamline dispute resolution processes and ensure clarity in operations and functionalities.

Changes

File(s)	Summary
.../AnchorStateRegistry.sol, .../PermissionedDisputeGame.sol	Introduced AnchorStateRegistry for efficient dispute game initialization and updated PermissionedDisputeGame for optimized fault proof iteration in certain network conditions.
.../DisputeGameFactory.sol	Updated @notice comments for enhanced clarity and consistency in documentation.
.../interfaces/IAnchorStateRegistry.sol	Refined documentation for tryUpdateAnchorState function to clarify the anchor state updating process.
.../dispute/weth/DelayedWETH.sol	Made semantic changes in documentation for improved clarity and consistency, without altering logic or control flow.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.17%. Comparing base (a86de7a) to head (037db03).

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #9902       +/-   ##
============================================
- Coverage    28.46%   16.17%   -12.29%     
============================================
  Files          165      123       -42     
  Lines         7229     5297     -1932     
  Branches      1324     1172      -152     
============================================
- Hits          2058      857     -1201     
+ Misses        5065     4365      -700     
+ Partials       106       75       -31     

Flag	Coverage Δ
cannon-go-tests	?
chain-mon-tests	27.14% <ø> (ø)
common-ts-tests	?
contracts-bedrock-tests	0.60% <ø> (ø)
contracts-ts-tests	12.25% <ø> (ø)
core-utils-tests	?
sdk-next-tests	41.94% <ø> (ø)
sdk-tests	41.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...tracts-bedrock/src/dispute/AnchorStateRegistry.sol	0.00% <ø> (ø)
...ntracts-bedrock/src/dispute/DisputeGameFactory.sol	0.00% <ø> (ø)
...ts-bedrock/src/dispute/PermissionedDisputeGame.sol	0.00% <ø> (ø)
...contracts-bedrock/src/dispute/weth/DelayedWETH.sol	0.00% <ø> (ø)

... and 42 files with indirect coverage changes