Skip to content

L-04 Missing Docstrings #2546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: sparrowDom/roosterAMO
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion contracts/contracts/strategies/plume/RoosterAMOStrategy.sol
Original file line number Diff line number Diff line change
Expand Up @@ -117,19 +117,43 @@ contract RoosterAMOStrategy is InitializableAbstractStrategy {
/// against a strategist / guardian being taken over and with multiple transactions draining the
/// protocol funds.
uint256 public constant SOLVENCY_THRESHOLD = 0.998 ether;

/// @notice Emitted when the allowed interval within which the strategy contract is allowed to deposit
/// liquidity to the underlying pool is updated.
/// @param allowedWethShareStart The start of the interval
/// @param allowedWethShareEnd The end of the interval
event PoolWethShareIntervalUpdated(
uint256 allowedWethShareStart,
uint256 allowedWethShareEnd
);
/// @notice Emitted when liquidity is removed from the underlying pool
/// @param withdrawLiquidityShare Share of strategy's liquidity that has been removed
/// @param removedWETHAmount The amount of WETH removed
/// @param removedOETHAmount The amount of OETH removed
/// @param underlyingAssets Updated amount of strategy's underlying assets
event LiquidityRemoved(
uint256 withdrawLiquidityShare,
uint256 removedWETHAmount,
uint256 removedOETHAmount,
uint256 underlyingAssets
);

/// @notice Emitted when the underlying pool is rebalanced
/// @param currentPoolWethShare The resulting share of strategy's liquidity
/// in the TICK_NUMBER
event PoolRebalanced(uint256 currentPoolWethShare);

/// @notice Emitted when the amount of underlying assets the strategy hold as
/// liquidity in the pool is updated.
/// @param underlyingAssets Updated amount of strategy's underlying assets
event UnderlyingAssetsUpdated(uint256 underlyingAssets);

/// @notice Emitted when liquidity is added to the underlying pool
/// @param wethAmountDesired Amount of WETH desired to be deposited
/// @param oethAmountDesired Amount of OETH desired to be deposited
/// @param wethAmountSupplied Amount of WETH deposited
/// @param oethAmountSupplied Amount of OETH deposited
/// @param tokenId NFT liquidity token id
/// @param underlyingAssets Updated amount of underlying assets
event LiquidityAdded(
uint256 wethAmountDesired,
uint256 oethAmountDesired,
Expand Down
Loading