Add `ERC7984ERC20Wrapper` missing docs by arr00 · Pull Request #280 · OpenZeppelin/openzeppelin-confidential-contracts

arr00 · 2025-12-31T15:21:51Z

Summary by CodeRabbit

Documentation
- Enhanced internal code documentation for improved developer reference and maintainability.

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

coderabbitai · 2025-12-31T15:22:01Z

Walkthrough

Documentation additions to the ERC7984ERC20Wrapper contract, introducing explanatory comments for the _update and _unwrap methods without modifying any function signatures, public APIs, or control flow.

Changes

Cohort / File(s)	Summary
Documentation updates `contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol`	Added inherited contract documentation tag above `_update` method and descriptive comment above `_unwrap` method for improved code clarity. No functional changes to signatures or control flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Add warning comment about wrapper unwrap flow #276 — Modifies the same file and adds or updates comments around the unwrap flow, including warnings about unwrap request storage.

Suggested labels

ignore-changeset

Suggested reviewers

james-toussaint
Amxx

Poem

🐰 A comment here, a note right there,
Clarity blooms in the wrapper's care,
No code was changed, just thoughts revealed,
Documentation gems, now sealed! ✨

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.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The pull request title accurately describes the main change: adding missing documentation to the ERC7984ERC20Wrapper contract, which aligns with the file-level summaries showing documentation annotations and comments were added.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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

netlify · 2025-12-31T15:22:50Z

✅ Deploy Preview for confidential-tokens ready!

Name	Link
🔨 Latest commit	`815238b`
🔍 Latest deploy log	https://app.netlify.com/projects/confidential-tokens/deploys/69553f92a1ba2b0008c7f833
😎 Deploy Preview	https://deploy-preview-280--confidential-tokens.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

Add missing docs

* Start release candidate * Release v0.3.0 (rc) (#221) * Release v0.3.0 (rc) * Update changelog --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * Update `checkOnTransferReceived` doc (#235) * Versioned Docs (#236) * generate versioned docs * publish docs even on pre-release * N-04: remove unused import in `ERC7984Rwa` (#243) * N-01: reset user instead of allowing user in `unblockUser` (#244) * N-05: Named mapping var in `ERC7984ObserverAccess` (#251) * N-05: Named mapping var in `ERC7984ObserverAccess` * Update contracts/token/ERC7984/extensions/ERC7984ObserverAccess.sol Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> --------- Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * N-08: constant names are screaming camel case (#247) * N-08: constant names are screaming camel case * fix lint * N-02: reorder allowances omnibus (#250) * Support ERC-165 interface detection on ERC-7984 (#246) * Support ERC-165 interface detection on ERC-7984 * update link format * Add ERC7984 impl changeset * Update changeset --------- Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> * M-03: grant allowances to agent in `ERC7984Rwa` (#242) * M-03: grant allowances to agent in `ERC7984Rwa` * up * N-12: update docs in `ERC7984Restricted` (#245) * Upgrade to use fhevm contracts v0.9.0 (#248) * chore: fhevm-v9 * chore: port all tests for fhevm v9 * Merge pull request #1 from OpenZeppelin/chore/update-disclose-flow update disclose flow * Update wrapper contract (#2) * Update wrapper contract * fix tests * fix mock * update docs * add changeset * request id unnecessary * Update contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * remove unused params * Update test/token/ERC7984/ERC7984.test.ts Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * `cts` -> `handles` * `cleartext` -> `cleartextAmount` * Update test/token/ERC7984/extensions/ERC7984Wrapper.test.ts Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * nit --------- Co-authored-by: 0xalexbel <alexandre.belhoste@zama.ai> Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * N-[9,11]: fix `ERC7984Rwa` docs (#249) * M-11: fix `ERC7984Rwa` docs * add docs * Update contracts/token/ERC7984/extensions/ERC7984Rwa.sol * L-05: Grant allowances in `confidentialAvailable` (#252) * L-05: Grant allowances in `confidentialAvailable` * fix doc * L-01: `tryDecrease` return initialized value if delta is initialized (#241) * L-01: `tryDecrease` return initialized value if delta is initialized * add comment * Add changeset * Upgrade to use fhevm contracts v0.9.1 (#254) * Upgrade to use fhevm contracts v0.9.1 * bump sub package as well * Update `ERC7984Rwa` docs (#255) * Exit pre-release (#258) * Release v0.3.0 (#253) * Release v0.3.0 * Update changelog (#259) * Update changelog * Update CHANGELOG.md Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> --------- Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * remove duplicate entry --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * Revert when wrapper is full (#268) (#271) * Revert when wrapper full * up * simplify and add tests * update docs * cei * add doc * up * add custom error and fix tests * comment clarification * Rename `_checkTotalSupply` to `_checkConfidentialTotalSupply` * add changeset * Update contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol * docs --------- Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Add `ERC7984ERC20Wrapper` missing docs (#280) Add missing docs * Rename `ERC7984ERC20Wrapper` `totalSupply()` to `inferredTotalSuppy()` (#284) Rename `totalSupply()` to `inferredTotalSuppy()` * Release v0.3.1 (#272) * Release v0.3.1 * update changelog --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: 0xalexbel <alexandre.belhoste@zama.ai> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Add missing docs

815238b

arr00 requested a review from a team as a code owner December 31, 2025 15:21

arr00 changed the title ~~Add missing docs~~ Add ERC7984ERC20Wrapper missing docs Dec 31, 2025

arr00 added docs Documentation-focused workImprovements or additions to documentation ignore-changeset labels Dec 31, 2025

arr00 requested a review from james-toussaint January 2, 2026 13:51

james-toussaint approved these changes Jan 5, 2026

View reviewed changes

arr00 merged commit 426b11c into OpenZeppelin:master Jan 5, 2026
14 of 15 checks passed

arr00 deleted the chore/add-comments branch January 5, 2026 10:36

arr00 added a commit that referenced this pull request Jan 5, 2026

Add ERC7984ERC20Wrapper missing docs (#280)

7b0eeb9

Add missing docs

coderabbitai bot mentioned this pull request Mar 4, 2026

Typo fixes #316

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `ERC7984ERC20Wrapper` missing docs#280

Add `ERC7984ERC20Wrapper` missing docs#280
arr00 merged 1 commit intoOpenZeppelin:masterfrom
arr00:chore/add-comments

arr00 commented Dec 31, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 31, 2025 •

edited

Loading

Uh oh!

netlify bot commented Dec 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

arr00 commented Dec 31, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

netlify bot commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for confidential-tokens ready!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arr00 commented Dec 31, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 31, 2025 •

edited

Loading

netlify bot commented Dec 31, 2025 •

edited

Loading