Update checkOnTransferReceived doc

[james-toussaint]

Summary by CodeRabbit

• Documentation
  • Updated documentation clarifying fallback behavior when a receiver contract returns false. The transfer function will now attempt to refund the initiating address instead of reversing the transfer.

[netlify]

✅ Deploy Preview for confidential-tokens ready!

Name	Link
🔨 Latest commit	8ff23ad
🔍 Latest deploy log	https://app.netlify.com/projects/confidential-tokens/deploys/69022796d5bf690008b662ac
😎 Deploy Preview	https://deploy-preview-235--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.

[coderabbitai]

Walkthrough

Documentation comment updated in ERC7984Utils for the checkOnTransferReceived function, clarifying fallback behavior when the receiver contract returns false. The description changed from indicating a transfer reversal to suggesting a refund attempt to the sender address. No functional code modifications were made.

Changes

Cohort / File(s)	Change Summary
Documentation Update contracts/token/ERC7984/utils/ERC7984Utils.sol	Updated NatSpec comment for checkOnTransferReceived to clarify fallback behavior: changed from "transfer would be reversed" to "transfer function should attempt to refund the from address instead" when receiver returns false.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📜✨ A clarified note, so precise and fine,
Our refund logic now shines in each line,
Words rearranged with intention so clear—
The rabbit approves, no changes to fear! 🐰

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Update checkOnTransferReceived doc" directly and accurately summarizes the main change in the changeset. The raw summary confirms that the pull request updates the documentation comment for the checkOnTransferReceived function to change the described fallback behavior when the receiver contract returns false, with no actual code changes present. The title is concise, specific to the function being modified, and clearly indicates this is a documentation update rather than a functional change. A developer scanning the repository history would immediately understand that this commit pertains to documentation improvements for a specific utility function.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/check-on-transfer-received-note

---

📜 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 0024cc7 and 8ff23ad.

📒 Files selected for processing (1)

• contracts/token/ERC7984/utils/ERC7984Utils.sol (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-15T14:43:25.644Z

Learnt from: arr00
PR: OpenZeppelin/openzeppelin-confidential-contracts#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/ERC7984/utils/ERC7984Utils.sol

🔇 Additional comments (1)

contracts/token/ERC7984/utils/ERC7984Utils.sol (1)

19-20: Documentation clarification is accurate and properly implemented.

The documentation update correctly describes the expected behavior. Verification shows that the transfer implementation in ERC7984._transferAndCall() (line 264) properly handles the encrypted boolean return value using FHE.select(success, FHE.asEuint64(0), sent), which conditionally refunds the sender based on the callback's encrypted boolean response.

---

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