Component
Documentation
Describe the suggested feature and problem it solves.
Summary
While reviewing the codebase, I noticed several NatSpec comments that either do not fully reflect the actual contract logic or omit important context.
Below is the list of identified inconsistencies and proposed clarifications:
| File / Location |
Current NatSpec |
Proposed NatSpec |
Rationale |
| src/interfaces/IProtocolFees.sol#L40 |
This will revert if the contract is unlocked |
Remove this comment |
The collectProtocolFees function does not contain any check regarding the state of the pool (locked or unlocked). |
| src/interfaces/IPoolManager.sol#L111 |
The only functions callable without an unlocking are initialize and updateDynamicLPFee |
The only functions callable without an unlocking are initialize, updateDynamicLPFee and sync |
Function sync() also callable without unlocking. |
| src/interfaces/IPoolManager.sol#55 |
The fee collected upon every swap in the pool, denominated in hundredths of a bip |
The fee collected upon every swap in the pool, denominated in hundredths of a bip, or DYNAMIC_FEE_FLAG if the fee is dynamically set by the hook |
When a pool uses dynamic fees, the fee parameter in the Initialize event contains the value from the DYNAMIC_FEE_FLAG constant |
Additional context.
All proposed modifications are strictly documentation/NatSpec improvements and do not alter any contract logic or interface ABIs.
Component
Documentation
Describe the suggested feature and problem it solves.
Summary
While reviewing the codebase, I noticed several NatSpec comments that either do not fully reflect the actual contract logic or omit important context.
Below is the list of identified inconsistencies and proposed clarifications:
initializeandupdateDynamicLPFeeinitialize,updateDynamicLPFeeandsyncsync()also callable without unlocking.Additional context.
All proposed modifications are strictly documentation/NatSpec improvements and do not alter any contract logic or interface ABIs.