Skip to content

Commit

Permalink
chore: fix some typos in comment
Browse files Browse the repository at this point in the history
Signed-off-by: sunxunle <[email protected]>
  • Loading branch information
sunxunle committed Jan 20, 2025
1 parent ecaff63 commit 286f4c2
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/contracts/interfaces/IRewardsCoordinator.sol
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ interface IRewardsCoordinator {
OperatorDirectedRewardsSubmission operatorDirectedRewardsSubmission
);

/// @notice rewardsUpdater is responsible for submiting DistributionRoots, only owner can set rewardsUpdater
/// @notice rewardsUpdater is responsible for submitting DistributionRoots, only owner can set rewardsUpdater
event RewardsUpdaterSet(address indexed oldRewardsUpdater, address indexed newRewardsUpdater);
event RewardsForAllSubmitterSet(
address indexed rewardsForAllSubmitter,
Expand Down Expand Up @@ -306,7 +306,7 @@ interface IRewardsCoordinator {
/// @notice Mapping: claimer => token => total amount claimed
function cumulativeClaimed(address claimer, IERC20 token) external view returns (uint256);

/// @notice the defautl split for all operators across all avss
/// @notice the default split for all operators across all avss
function defaultOperatorSplitBips() external view returns (uint16);

/// @notice the split for a specific `operator` for a specific `avs`
Expand Down
4 changes: 2 additions & 2 deletions src/contracts/strategies/EigenStrategy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import "../interfaces/IEigen.sol";
* To mitigate against the common "inflation attack" vector, we have chosen to use the 'virtual shares' mitigation route,
* similar to [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC20/extensions/ERC4626.sol).
* We acknowledge that this mitigation has the known downside of the virtual shares causing some losses to users, which are pronounced
* particularly in the case of the share exchange rate changing signficantly, either positively or negatively.
* particularly in the case of the share exchange rate changing significantly, either positively or negatively.
* For a fairly thorough discussion of this issue and our chosen mitigation strategy, we recommend reading through
* [this thread](https://github.com/OpenZeppelin/openzeppelin-contracts/issues/3706) on the OpenZeppelin repo.
* We specifically use a share offset of `SHARES_OFFSET` and a balance offset of `BALANCE_OFFSET`.
Expand Down Expand Up @@ -63,7 +63,7 @@ contract EigenStrategy is StrategyBase {
/**
* @notice This function hook is called in EigenStrategy.withdraw() before withdrawn shares are calculated and is
* overridden here to allow for withdrawing shares either into EIGEN or bEIGEN tokens. If wrapping bEIGEN into EIGEN is needed,
* it is performed in _afterWithdrawal(). This hook just checks the token paramater is either EIGEN or bEIGEN.
* it is performed in _afterWithdrawal(). This hook just checks the token parameter is either EIGEN or bEIGEN.
* @param token token to be withdrawn, can be either EIGEN or bEIGEN. If EIGEN, then bEIGEN is wrapped into EIGEN
*/
function _beforeWithdrawal(
Expand Down
2 changes: 1 addition & 1 deletion src/contracts/strategies/StrategyBase.sol
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import "@openzeppelin-upgrades/contracts/proxy/utils/Initializable.sol";
* To mitigate against the common "inflation attack" vector, we have chosen to use the 'virtual shares' mitigation route,
* similar to [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC20/extensions/ERC4626.sol).
* We acknowledge that this mitigation has the known downside of the virtual shares causing some losses to users, which are pronounced
* particularly in the case of the share exchange rate changing signficantly, either positively or negatively.
* particularly in the case of the share exchange rate changing significantly, either positively or negatively.
* For a fairly thorough discussion of this issue and our chosen mitigation strategy, we recommend reading through
* [this thread](https://github.com/OpenZeppelin/openzeppelin-contracts/issues/3706) on the OpenZeppelin repo.
* We specifically use a share offset of `SHARES_OFFSET` and a balance offset of `BALANCE_OFFSET`.
Expand Down
2 changes: 1 addition & 1 deletion src/test/events/IRewardsCoordinatorEvents.sol
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ interface IRewardsCoordinatorEvents {
uint256 submissionNonce,
IRewardsCoordinator.OperatorDirectedRewardsSubmission operatorDirectedRewardsSubmission
);
/// @notice rewardsUpdater is responsible for submiting DistributionRoots, only owner can set rewardsUpdater
/// @notice rewardsUpdater is responsible for submitting DistributionRoots, only owner can set rewardsUpdater
event RewardsUpdaterSet(address indexed oldRewardsUpdater, address indexed newRewardsUpdater);
event RewardsForAllSubmitterSet(
address indexed rewardsForAllSubmitter,
Expand Down

0 comments on commit 286f4c2

Please sign in to comment.