Skip to content

Document possible rounding down of user deposits#327

Merged
arr00 merged 3 commits intomasterfrom
chore/add-docs-batcher
Mar 12, 2026
Merged

Document possible rounding down of user deposits#327
arr00 merged 3 commits intomasterfrom
chore/add-docs-batcher

Conversation

@arr00
Copy link
Copy Markdown
Member

@arr00 arr00 commented Mar 12, 2026

Summary by CodeRabbit

  • Documentation
    • Improved internal documentation for smart contract functions with detailed notes on behavior and calculations. No functional changes or user-facing updates.

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 12, 2026

Deploy Preview for confidential-tokens ready!

Name Link
🔨 Latest commit c71eec3
🔍 Latest deploy log https://app.netlify.com/projects/confidential-tokens/deploys/69b313c851651e0008c208c3
😎 Deploy Preview https://deploy-preview-327--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
Copy Markdown
Contributor

coderabbitai bot commented Mar 12, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1c598e2e-6694-40c2-8f29-60dedead5192

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

A detailed developer comment was added to the onConfidentialTransferReceived function in BatcherConfidential.sol, explaining its purpose of depositing fromToken into batches, how toToken amounts are calculated via _claim, and rounding behavior for small deposits. No code logic changed.

Changes

Cohort / File(s) Summary
Documentation Update
contracts/finance/BatcherConfidential.sol
Replaced placeholder comment with comprehensive developer note documenting function purpose, _claim-based toToken calculation, and rounding behavior; no code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A comment was born, so helpful and bright,
Explaining the batcher's batching delight,
No code was changed, just words shining clear,
Documentation perfection—hooray and good cheer! 📝

🚥 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 accurately describes the main change: adding documentation about rounding behavior for deposits in the BatcherConfidential contract.
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 chore/add-docs-batcher
📝 Coding Plan
  • Generate coding plan for human review comments

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

@arr00 arr00 requested a review from a team as a code owner March 12, 2026 19:26
@arr00 arr00 merged commit 5abcb1c into master Mar 12, 2026
16 checks passed
@arr00 arr00 deleted the chore/add-docs-batcher branch March 12, 2026 19:39
arr00 added a commit that referenced this pull request Mar 12, 2026
* Document possible rounding down of user deposits

* add contract level comment as well

* up
arr00 added a commit that referenced this pull request Apr 1, 2026
* Start release candidate

* Fix local docs generation (#320)

* remove properties symlink

* add properties.js

* lint fix

* Remove backwards compatibility from Batcher (#321)

* Remove backwards compatibility from Batcher

* Apply suggestion from @arr00

* Validate `fromToken` and `toToken` on construction (#322)

* Validate `fromToken` on construction

* use `ERC165Checker`

* check toToken as well

* directly validate to and from token

* Add additional functions to `IERC7984ERC20Wrapper` (#323)

* remove incorrect docs on `unwrap` function

* add finalize unwrap and rate to wrapper interface

* update batcher to use unwrap request ids instead of unwrap amounts

* add `unwrapAmount` to wrapper interface for unwrap request introspection

* additional docs

* call getter for `unwrapAmount` in `finalizeUnwrap`

* update events and errors appropriately

* remove `ERC7984ERC20Wrapper` import

* fix import order

* Move events to interface from `ERC7984ERC20Wrapper`

* add note on request id for `unwrap`

* change mapping to be of `bytes32` identifiers

* add changeset

* Allow claiming on behalf of another account in batcher (#324)

* Allow claiming on behalf of another account in batcher

* revert on claim if users not part of the batch

* add error on quit too

* Add additional warnings to the batcher (#325)

* Return a bytes32 unwrap id from the `_unwrap` function in `BatcherConfidential` (#326)

* Return a bytes32 unwrap id from the `_unwrap` function in `BatcherConfidential`

* modify warning

* Document possible rounding down of user deposits (#327)

* Document possible rounding down of user deposits

* add contract level comment as well

* up

* Release v0.4.0 (rc) (#318)

* Release v0.4.0 (rc)

* update changelog

* update changelog

* Apply suggestion from @james-toussaint

Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com>

---------

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>

* Update node version to 24.x in CI (#328)

* Exit release candidate

* Release v0.4.0 (#335)

* Release v0.4.0

* update changelog

* remove changelog duplicate

---------

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: Arr00 <13561405+arr00@users.noreply.github.com>
Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com>
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.

1 participant