[POC]: example if we remove share to 0 if only lockup shares are left #217
Conversation
This file contains 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
|
will further polish the tests once picked |
ChefMist
reviewed
Nov 13, 2024
src/pool-bin/libraries/BinPool.sol
Outdated
|
|
||
| bytes32 amountsOutFromBin = binReserves.getAmountOutOfBin(amountToBurn, supply); | ||
| if (supply == amountToBurn) feeAmountToProtocol = binReserves.getAmountOutOfBin(MINIMUM_SHARE, supply); |
There was a problem hiding this comment.
need to document in code probably on why supply == amountToBurn we'll do this
ChefMist
reviewed
Nov 13, 2024
| @@ -465,9 +471,16 @@ library BinPool { | |||
| } | |||
|
|
|||
| /// @notice Subtract share from user's position and update total share supply of bin | |||
| function _subShare(State storage self, address owner, uint24 binId, bytes32 salt, uint256 shares) internal { | |||
| function _subShare(State storage self, address owner, uint24 binId, bytes32 salt, uint256 shares) | |||
There was a problem hiding this comment.
need comment on this -- so other devs can understand the logic below easily
There was a problem hiding this comment.
eg.
/// @notice Subtract share from user's position and update total share supply of bin
/// @param shares - amount of share to deduct
/// @return amountsToBurn amount of share burned, if bin is left with MINIMUM_SHARE, amountsToBurn will be share + MINIMUM_SHARE
ChefMist
reviewed
Nov 13, 2024
| @@ -317,15 +317,21 @@ library BinPool { | |||
| bytes32 binReserves = self.reserveOfBin[id]; | |||
| uint256 supply = self.shareOfBin[id]; | |||
|
|
|||
| _subShare(self, params.from, id, params.salt, amountToBurn); | |||
| amountToBurn = _subShare(self, params.from, id, params.salt, amountToBurn); | |||
There was a problem hiding this comment.
// if user is last lp for this bin, amountToBurn would be amountToBurn + MINIMUM_SHARE
amountToBurn = _subShare(self, params.from, id, params.salt, amountToBurn);
ChefMist
reviewed
Nov 13, 2024
src/pool-bin/libraries/BinPool.sol
Outdated
|
|
||
| bytes32 amountsOutFromBin = binReserves.getAmountOutOfBin(amountToBurn, supply); | ||
| if (supply == amountToBurn) feeAmountToProtocol = binReserves.getAmountOutOfBin(MINIMUM_SHARE, supply); |
There was a problem hiding this comment.
also feeAmountToProtocol should be += as we are in the loop. so feeAmountToProtocol is being overwritten if we loop twice with such cases.
can you have look at this implementation? moved the code a bit
/// @notice Burn user's share and withdraw tokens form the pool.
/// @return result the delta of the token balance of the pool
function burn(State storage self, BurnParams memory params)
internal
returns (BalanceDelta result, uint256[] memory ids, bytes32[] memory amounts, bytes32 feeAmountToProtocol)
{
ids = params.ids;
uint256 idsLength = ids.length;
uint256[] memory amountsToBurn = params.amountsToBurn;
if (idsLength == 0 || idsLength != amountsToBurn.length) revert BinPool__InvalidBurnInput();
bytes32 amountsOut;
amounts = new bytes32[](idsLength);
for (uint256 i; i < idsLength;) {
uint24 id = ids[i].safe24();
uint256 amountToBurn = amountsToBurn[i];
if (amountToBurn == 0) revert BinPool__BurnZeroAmount(id);
bytes32 binReserves = self.reserveOfBin[id];
uint256 supply = self.shareOfBin[id];
// if user is last lp for this bin, amountToBurn would be amountToBurn + MINIMUM_SHARE
amountToBurn = _subShare(self, params.from, id, params.salt, amountToBurn);
bytes32 amountsOutFromBin = binReserves.getAmountOutOfBin(amountToBurn, supply);
if (amountsOutFromBin == 0) revert BinPool__ZeroAmountsOut(id);
if (supply == amountToBurn) {
_removeBinIdToTree(self, id);
/// @notice withdraw all the liquidity from the bin, the locked up share will be withdrawn as protocol fee
feeAmountToProtocol = feeAmountToProtocol.add(binReserves.getAmountOutOfBin(MINIMUM_SHARE, supply));
amountsOutFromBin.sub(feeAmountToProtocol);
}
binReserves = binReserves.sub(amountsOutFromBin);
self.reserveOfBin[id] = binReserves;
amounts[i] = amountsOutFromBin;
amountsOut = amountsOut.add(amountsOutFromBin);
unchecked {
++i;
}
}
result = toBalanceDelta(amountsOut.decodeX().safeInt128(), amountsOut.decodeY().safeInt128());
}
|
chefburger
force-pushed
the
feat/hexen-r7-option-2-optimise-beta
branch
from
91ed183 to
acbc781
Compare
chefburger
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.