Skip to content
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

Jump to bottom

Add Natspec indicating amount must be amount - 1 wei or less when claiming fees #73

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Add Natspec indicating amount must be amount - 1 wei or less when claiming fees #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions src/V3FactoryOwner.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,14 @@ contract V3FactoryOwner {
/// @param _pool The Uniswap v3 pool contract from which protocol fees are being collected.
/// @param _recipient The address to which collected protocol fees will be transferred.
/// @param _amount0Requested The amount0Requested param to forward to the pool's collectProtocol
/// method.
/// method. Its maximum value will be `protocolFees.token0 - 1`.
/// @param _amount1Requested The amount1Requested param to forward to the pool's collectProtocol
/// method.
/// method. Its maximum value will be `protocolFees.token1 - 1`.
/// @return _amount0 The amount0 fees collected, returned by the pool's collectProtocol method.
/// @return _amount1 The amount1 fees collected, returned by the pool's collectProtocol method.
/// @dev See docs on IUniswapV3PoolOwnerActions for more information on forwarded params.
/// @dev The `UniswapV3Pool contract allows claiming a maximum of the total accrued fees minus 1.
/// We highly recommend checking the source code of the `UniswapV3Pool` contract in order to
/// better understand the potential constraints of the forwarded params.
function claimFees(
IUniswapV3PoolOwnerActions _pool,
address _recipient,
Expand Down
Loading