Skip to content

Commit

Permalink
add missing setter docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tritium-VLK committed Oct 5, 2024
1 parent e9fe6a4 commit 4a04eb6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion contracts/ChildChainGaugeInjectorV2.sol
Original file line number Diff line number Diff line change
Expand Up @@ -558,19 +558,27 @@ KeeperCompatibleInterface
}

/**
* @notice Sets global MaxInjectionAmount for the injector
* @notice Sets global MaxInjectionAmount for the injector which will be checked on each injection.
* @param amount The max amount that the injector will allow to be paid to a single gauge in single programmed injection
*/
function setMaxInjectionAmount(uint256 amount) external onlyOwner {
emit MaxInjectionAmountUpdated(MaxInjectionAmount, amount);
MaxInjectionAmount = amount;
}

/**
* @notice Sets global MaxGlobalAmountPerPeriod for the injector, which will prevent schedules from being added that increases the spend of a single round of all active periods from exceeding this amount.
* @param amount The max amount that should be allowed to be scheduled in 1 period across all active programs.
*/
function setMaxGlobalAmountPerPeriod(uint256 amount) external onlyOwner {
emit MaxGlobalAmountPerPeriodUpdated(MaxGlobalAmountPerPeriod, amount);
MaxGlobalAmountPerPeriod = amount;
}

/**
* @notice Sets global MaxTotalDue for the injector, which will prevent schedules from being added that increases the the total spend of all active programs over all remaining periods from exceeding this amount.
* @param amount The max amount that should be allowed to be scheduled across all remaining periods of all active programs.
*/
function setMaxTotalDue(uint256 amount) external onlyOwner {
emit MaxTotalDueUpdated(MaxTotalDue, amount);
MaxTotalDue = amount;
Expand Down

0 comments on commit 4a04eb6

Please sign in to comment.