docs: MidnightBundles (Stermi no. 14)#965
Open
MathisGD wants to merge 4 commits into
Open
Conversation
Removed redundant authorization comments for the taker and msg.sender in multiple functions. Signed-off-by: MathisGD <74971347+MathisGD@users.noreply.github.com>
Signed-off-by: MathisGD <74971347+MathisGD@users.noreply.github.com>
MathisGD
commented
Jun 2, 2026
adhusson
reviewed
Jun 2, 2026
QGarchery
reviewed
Jun 2, 2026
| /// on Midnight. | ||
| /// @dev msg.sender is always the tokens payer (for buy, supplyCollateral and repay), and receiver is always the tokens | ||
| /// receiver (for sell and withdraw collateral). | ||
| /// @dev msg.sender must have approved the bundler to pull enough tokens. |
Collaborator
There was a problem hiding this comment.
same remark actually for the tokens
| /// @dev The msg.sender will pay at most maxBuyerAssets. | ||
| /// @dev Total loan assets transferred from msg.sender is | ||
| /// filledBuyerAssets + filledBuyerAssets * referralFeePct / (WAD - referralFeePct). | ||
| /// @dev The receiver will receive collateralWithdrawals[0].assets of the first collateral token of the list etc. |
Collaborator
There was a problem hiding this comment.
Not very clear, which list ? It's actually the following list:
[
takes[0].offer.market.collateralParams[collateralWithdrawals[0].collateralIndex).token,
takes[0].offer.market.collateralParams[collateralWithdrawals[1].collateralIndex).token,
takes[0].offer.market.collateralParams[collateralWithdrawals[2].collateralIndex).token,
...
]
| /// EXTERNAL /// | ||
|
|
||
| /// @dev The taker must have authorized this bundler and the msg.sender (if different from the taker) on Midnight. | ||
| /// @dev This function should only be called with the same market for all takes. |
Collaborator
There was a problem hiding this comment.
We should mention that the offers may not be all the same at the end of the Take[] array, if the amount needed is found without needing those offers: the check is in the take loop, not the collateral loop.
So someone could supply/withdraw collateral in a market not desired, if he did not check that all the markets are the same in the passed offers
peyha
reviewed
Jun 3, 2026
| /// @dev The receiver will receive at least minSellerAssets. | ||
| /// @dev Total loan assets received by the receiver is | ||
| /// filledSellerAssets - filledSellerAssets * referralFeePct / WAD. | ||
| /// @dev msg.sender will pay collateralWithdrawals[0].assets of the first collateral token of the list etc. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// @dev msg.sender will pay collateralWithdrawals[0].assets of the first collateral token of the list etc. | |
| /// @dev msg.sender will pay collateralSupplies[0].assets of the first collateral token of the list etc. |
also not super clear syntax, would go for something like
Suggested change
| /// @dev msg.sender will pay collateralWithdrawals[0].assets of the first collateral token of the list etc. | |
| /// @dev msg.sender will pay all collaterals from collateralSupplies. |
adhusson
reviewed
Jun 3, 2026
| import {ConsumableUnitsLib} from "./ConsumableUnitsLib.sol"; | ||
| import {WAD} from "../libraries/ConstantsLib.sol"; | ||
|
|
||
| /// @dev buy/sell functions take min("units needed to targetUnits", takes[i].units, "consumable units") units. |
Contributor
There was a problem hiding this comment.
For clarity, also just talking about target units is a bit misleading for functions that target assets
Suggested change
| /// @dev buy/sell functions take min("units needed to targetUnits", takes[i].units, "consumable units") units. | |
| /// @dev For each offer, the buy/sell functions will take min("units needed to fill target units / assets", takes[i].units, "units still consumable in takes[i].offer") units. |
adhusson
reviewed
Jun 3, 2026
| /// @dev The msg.sender will pay at most maxBuyerAssets. | ||
| /// @dev Total loan assets transferred from msg.sender is | ||
| /// filledBuyerAssets + filledBuyerAssets * referralFeePct / (WAD - referralFeePct). | ||
| /// @dev The receiver will receive collateralWithdrawals[0].assets of the first collateral token of the list etc. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// @dev The receiver will receive collateralWithdrawals[0].assets of the first collateral token of the list etc. | |
| /// @dev The collateralReceiver will receive collateralWithdrawals[0].assets of the first collateral token of the list etc. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.