[Provers N09] Update docs

[luiz-lvj]

Summary by CodeRabbit

• Documentation
  • Updated inline documentation in smart contracts. No functional changes.

[coderabbitai]

Warning

Rate limit exceeded

@luiz-lvj has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between ce556f4 and 815d089.

📒 Files selected for processing (1)

• src/contracts/provers/zksync/ParentToChildProver.sol

📝 Walkthrough

Walkthrough

Documentation refinements to two prover contracts: removed a comment about storage slot details in Scroll implementation and improved inline parameter documentation in Zksync implementation. No functional or behavioral changes.

Changes

Cohort / File(s)	Summary
Scroll ParentToChildProver src/contracts/provers/scroll/ParentToChildProver.sol	Removed comment describing finalizedStateRoots mapping slot as slot 7; no logic or control flow changes.
Zksync ParentToChildProver src/contracts/provers/zksync/ParentToChildProver.sol	Updated documentation for verifyTargetStateCommitment input parameters to separately document accountProof and storageProof instead of a generic proof reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: adding scroll implementation parent to child #47 — Implements Scroll ParentToChildProver with the finalizedStateRoots mapping that this PR's removed comment referenced.

Suggested reviewers

• nahimterrazas
• pepebndc

Poem

🐰 A rabbit hops through docs so neat,
Tidying comments, keeping lines sweet,
No logic changed, just words refined,
Clarity blooms in each reworded line!
✨ 📝

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title '[Provers N09] Update docs' accurately summarizes the changeset, which consists entirely of documentation updates to two Prover contracts.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/provers-N09

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/contracts/provers/zksync/ParentToChildProver.sol`:
- Around line 118-122: Update the param tuple signature comment so it matches
the actual abi.decode usage: include the missing bytes accountProof element in
the tuple description (the comment that currently lists (bytes rlpBlockHeader,
uint256 batchNumber, bytes storageProof) should be changed to include bytes
accountProof), ensuring the docblock for the input parameter in
ParentToChildProver.sol aligns with the abi.decode call that decodes four values
(rlpBlockHeader, batchNumber, accountProof, storageProof).

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7714c79 and ce556f4.

📒 Files selected for processing (2)

• src/contracts/provers/scroll/ParentToChildProver.sol
• src/contracts/provers/zksync/ParentToChildProver.sol

💤 Files with no reviewable changes (1)

• src/contracts/provers/scroll/ParentToChildProver.sol