Skip to content

Document possible rounding down of user deposits #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arr00 merged 3 commits into from
Mar 12, 2026
Merged

Document possible rounding down of user deposits #327

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
987637f
Document possible rounding down of user deposits
arr00 Mar 12, 2026
47776e2
add contract level comment as well
arr00 Mar 12, 2026
c71eec3
up
arr00 Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion contracts/finance/BatcherConfidential.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ import {FHESafeMath} from "./../utils/FHESafeMath.sol";
*
* Developers must also implement the virtual function {routeDescription} to provide a human readable description of the batch's route.
*
* Claim outputs are rounded down. This may result in small deposits being rounded down to 0 if the exchange rate is less than 1:1.
* {toToken} dust from rounding down will accumulate in the batcher over time.
*
* NOTE: The batcher does not support {ERC7984ERC20Wrapper} contracts prior to v0.4.0.
*
* NOTE: The batcher could be used to maintain confidentiality of deposits--by default there are no confidentiality guarantees.
Expand Down Expand Up @@ -250,7 +253,14 @@ abstract contract BatcherConfidential is ReentrancyGuardTransient, IERC7984Recei
}
}

/// @inheritdoc IERC7984Receiver
/**
* @dev See {IERC7984Receiver-onConfidentialTransferReceived}.
*
* Deposit {fromToken} into the current batch.
*
* NOTE: See {_claim} to understand how the {toToken} amount is calculated. Claim amounts are rounded down. Small
* deposits may be rounded down to 0 if the exchange rate is less than 1:1.
*/
function onConfidentialTransferReceived(
address,
address from,
Expand Down
Loading