Skip to content

Commit

Permalink
docs: fix comment for rewardGasAmount
Browse files Browse the repository at this point in the history
  • Loading branch information
xenide committed Jun 14, 2024
1 parent b63411b commit 16d77f3
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions src/ReservoirPriceOracle.sol
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,7 @@ contract ReservoirPriceOracle is IPriceOracle, IReservoirPriceOracle, Owned(msg.
/// 1e18 == 100%
uint64 public priceDeviationThreshold;

// TODO: Wording is confusing. Say "This number is multiplied by the base
// fee to determine the reward for keepers".
/// @notice multiples of the base fee the contract rewards the caller for updating the price when it goes
/// beyond the `priceDeviationThreshold`
/// @notice This number is multiplied by the base fee to determine the reward for keepers
uint64 public rewardGasAmount;

/// @notice TWAP period (in seconds) for querying the oracle
Expand Down

0 comments on commit 16d77f3

Please sign in to comment.