From 4edc3ea24f4a1dfbcd725d58a273c026f92fa12f Mon Sep 17 00:00:00 2001 From: wildmolasses Date: Tue, 9 Apr 2024 12:23:57 -0400 Subject: [PATCH] changing payoutAmount documentation --- src/V3FactoryOwner.sol | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/V3FactoryOwner.sol b/src/V3FactoryOwner.sol index 15c714d..e0a2794 100644 --- a/src/V3FactoryOwner.sol +++ b/src/V3FactoryOwner.sol @@ -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