Skip to content

Commit

Permalink
fix: comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Schlagonia committed Jan 19, 2024
1 parent 8846f6e commit 8af5784
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
9 changes: 4 additions & 5 deletions src/BaseStrategy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ abstract contract BaseStrategy {
* be entirely permissionless and thus can be sandwiched or otherwise
* manipulated.
*
* @param _amount The amount of 'asset' that the strategy should attempt
* @param _amount The amount of 'asset' that the strategy can attempt
* to deposit in the yield source.
*/
function _deployFunds(uint256 _amount) internal virtual;
Expand Down Expand Up @@ -365,7 +365,7 @@ abstract contract BaseStrategy {
* Unless a whitelist is implemented this will be entirely permissionless
* and thus can be sandwiched or otherwise manipulated.
*
* @param _amount The amount of 'asset' that the strategy should
* @param _amount The amount of 'asset' that the strategy can
* attempt to deposit in the yield source.
*/
function deployFunds(uint256 _amount) external virtual onlySelf {
Expand Down Expand Up @@ -410,7 +410,7 @@ abstract contract BaseStrategy {
* so msg.sender == address(this).
*
* We name the function `tendThis` so that `tend` calls are forwarded to
* the TokenizedStrategy so it can do the necessary accounting.
* the TokenizedStrategy.
* @param _totalIdle The amount of current idle funds that can be
* deployed during the tend
Expand All @@ -427,8 +427,7 @@ abstract contract BaseStrategy {
* the TokenizedStrategy so msg.sender == address(this).
*
* We name the function `shutdownWithdraw` so that `emergencyWithdraw`
* calls are forwarded to the TokenizedStrategy so it can do the necessary
* accounting after the withdraw.
* calls are forwarded to the TokenizedStrategy.
*
* @param _amount The amount of asset to attempt to free.
*/
Expand Down
8 changes: 4 additions & 4 deletions src/TokenizedStrategy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -1193,14 +1193,14 @@ contract TokenizedStrategy {
* This will callback the internal '_tend' call in the BaseStrategy
* with the total current amount available to the strategy to deploy.
*
* Keepers are expected to use protected relays in tend calls so this
* can be used for illiquid or manipulatable strategies to compound
* This is a permissioned function so if desired it could
* be used for illiquid or manipulatable strategies to compound
* rewards, perform maintenance or deposit/withdraw funds.
*
* This will not cause an increase in PPS. Total assets will
* This will not cause any change in PPS. Total assets will
* be the same before and after.
*
* A report() call will be needed to record the profit.
* A report() call will be needed to record any profits or losses.
*/
function tend() external nonReentrant onlyKeepers {
// Tend the strategy with the current loose balance.
Expand Down

0 comments on commit 8af5784

Please sign in to comment.