docs(HomeProxy): add clarification

[unknownunknown1]

Summary by CodeRabbit

• Documentation
  • Enhanced inline documentation across several contracts to clarify that proxy addresses must be precomputed using the deployer’s address and transaction nonce before deployment.

[coderabbitai]

Walkthrough

This pull request enhances the documentation in four RealitioHomeProxy contracts by updating comments to specify that the foreignProxy address must be precomputed before deployment using the deployer’s address and transaction nonce. The changes apply to both the variable declarations and constructor parameters in the Arbitrum, Gnosis, Optimism, and ZkSync contracts. No modifications have been made to the contract logic, control flow, or error handling.

Changes

File(s)	Change Summary
contracts/src/0.8/RealitioHomeProxy{Arbitrum, Gnosis, Optimism, ZkSync}.sol	Updated documentation comments for the foreignProxy variable and _foreignProxy constructor parameter to indicate that the proxy address must be precomputed using the deployer’s address and tx nonce.

Possibly related PRs

• Feat/gnosis proxy compiler bump #54: Updated documentation for the foreignProxy in the RealitioHomeProxyGnosis contract, aligning with the precomputation requirement introduced here.

Poem

In my warren of code I happily dwell,
Hoping that comments now clearly tell,
Precompute the proxy with care and glee,
Using deployer’s address and nonce, you see.
With a joyful hop and a code-carrot crunch,
I celebrate docs that pack a punch!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc5222 and 549648e.

📒 Files selected for processing (4)

• contracts/src/0.8/RealitioHomeProxyArbitrum.sol (2 hunks)
• contracts/src/0.8/RealitioHomeProxyGnosis.sol (2 hunks)
• contracts/src/0.8/RealitioHomeProxyOptimism.sol (2 hunks)
• contracts/src/0.8/RealitioHomeProxyZkSync.sol (2 hunks)

✅ Files skipped from review due to trivial changes (4)

• contracts/src/0.8/RealitioHomeProxyOptimism.sol
• contracts/src/0.8/RealitioHomeProxyGnosis.sol
• contracts/src/0.8/RealitioHomeProxyZkSync.sol
• contracts/src/0.8/RealitioHomeProxyArbitrum.sol

---

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>, please review it.
  • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title 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

Documentation and Community

• 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.