Skip to content
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

docs(metamorpho): comment forced market removal #354

Merged
merged 11 commits into from
Dec 28, 2023
7 changes: 7 additions & 0 deletions src/interfaces/IMetaMorpho.sol
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ interface IMetaMorphoBase {
function revokePendingCap(Id id) external;

/// @notice Submits a forced market removal from the vault, eventually losing all funds supplied to the market.
/// @notice Funds can always be recovered as a donation by withdrawing from this market (using `reallocate`), but
Rubilmax marked this conversation as resolved.
Show resolved Hide resolved
/// funds will be distributed pro-rata to the shares at the time of withdrawal, not at the time of market removal.
/// @notice This forced removal is expected to be used as an emergency process in case a market constantly reverts.
/// To softly remove a sane market, the curator role is expected to bundle a reallocation that empties the market
/// first (using `reallocate`), followed by the removal of the market (using `updateWithdrawQueue`).
/// @dev Warning: Submitting a forced removal will overwrite the timestamp at which the market will be removable.
Rubilmax marked this conversation as resolved.
Show resolved Hide resolved
/// @dev Warning: Removing a market with non-zero supply will instantly impact the vault's price per share.
MathisGD marked this conversation as resolved.
Show resolved Hide resolved
function submitMarketRemoval(Id id) external;

/// @notice Revokes the pending removal of the market defined by `id`.
Expand Down
Loading