Skip to content

Conversation

@arr00
Copy link
Contributor

@arr00 arr00 commented Dec 2, 2025

IERC7984Rwa and ERC7984Votes were missing from the docs API reference. This PR adds them.

Summary by CodeRabbit

  • Documentation
    • Updated interface reference documentation to include new RWA interface support
    • Added documentation for ERC7984Votes extension with voting functionality

✏️ Tip: You can customize this high-level summary in your review settings.

@arr00 arr00 requested a review from a team as a code owner December 2, 2025 14:55
@netlify
Copy link

netlify bot commented Dec 2, 2025

Deploy Preview for confidential-tokens ready!

Name Link
🔨 Latest commit ad14a3f
🔍 Latest deploy log https://app.netlify.com/projects/confidential-tokens/deploys/692efdf2b5f1030008308a42
😎 Deploy Preview https://deploy-preview-265--confidential-tokens.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 2, 2025

Walkthrough

Two README documentation files are updated to reference newly added interfaces and extensions: IERC7984Rwa interface is added to the interfaces documentation, and ERC7984Votes extension is added to the token documentation. Both are documentation-only changes with no code modifications.

Changes

Cohort / File(s) Summary
Documentation Updates
contracts/interfaces/README.adoc, contracts/token/README.adoc
Updated READMEs to add references for new IERC7984Rwa interface in the Core section and new ERC7984Votes (VotesConfidential) extension in the token contracts documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • These are pure documentation updates with no code logic, behavioral changes, or exported entity declarations affected.

Poem

✨ New interfaces blooming in the docs so bright,
IERC7984Rwa and Votes catch the light,
A rabbit hops through READMEs with glee,
References aligned for all to see! 🐰📚

Pre-merge checks and finishing touches

✅ 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 'Add missing contracts to API docs' directly and clearly reflects the main change in the pull request: adding IERC7984Rwa and ERC7984Votes to the API documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-missing-contracts-to-api

📜 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 c718cc3 and ad14a3f.

📒 Files selected for processing (2)
  • contracts/interfaces/README.adoc (1 hunks)
  • contracts/token/README.adoc (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-15T14:43:25.644Z
Learnt from: arr00
Repo: OpenZeppelin/openzeppelin-confidential-contracts PR: 186
File: contracts/token/ERC7984/extensions/ERC7984Omnibus.sol:140-167
Timestamp: 2025-09-15T14:43:25.644Z
Learning: In ERC7984Omnibus callback functions like confidentialTransferFromAndCallOmnibus, the encrypted sender and recipient addresses are not passed to the callback recipient - only the standard transfer parameters (omnibusFrom, omnibusTo, amount, data) are passed. The ACL grants for the encrypted addresses are for omnibus event emission and future access, not for callback usage.

Applied to files:

  • contracts/token/README.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: boostsecurity - boostsecurityio/semgrep-pro
  • GitHub Check: tests
  • GitHub Check: coverage
  • GitHub Check: slither
🔇 Additional comments (2)
contracts/token/README.adoc (1)

15-15: Documentation entry for ERC7984Votes is accurate and well-structured.

The description correctly identifies ERC7984Votes as an extension of ERC7984 with confidential vote tracking support, and the reference to VotesConfidential is valid. The entry is correctly positioned in both the overview list and Extensions section, following the established documentation pattern.

contracts/interfaces/README.adoc (1)

10-10: Documentation references are well-formatted and consistent.

The additions follow the established pattern with proper AsciiDoc syntax. The IERC7984Rwa interface file exists at contracts/interfaces/IERC7984Rwa.sol, and all references in the README are correctly formatted with single braces for reference links and double braces for includes.


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

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants