Skip to content

Commit

Permalink
changing payoutAmount documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wildmolasses committed Apr 9, 2024
1 parent 2ac42a5 commit 4edc3ea
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/V3FactoryOwner.sol
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,14 @@ contract V3FactoryOwner {
/// amount are. Effectively, as each pool accrues fees, it eventually becomes possible to "buy"
/// the pool fees for less than they are valued by "paying" the the payout amount of the payout
/// token.
/// `payoutAmount` may be changed by the admin (governance). Any proposal that changes this amount
/// is expected to be subject to the governance process, including a timelocked execution, and so
/// it's unlikely that a caller would be surprised by a change in this value. Still, callers
/// should be aware of the edge case where:
/// - 0. The caller grants a higher-than-necessary payout token approval to this factory.
/// - 1. caller's claimFee transaction is in the mempool.
/// - 2. the payoutAmount is changed.
/// - 3. the claimFee transaction is now included in a block.
/// @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
Expand Down

0 comments on commit 4edc3ea

Please sign in to comment.