docs: refresh overview pages for keepers, min_usdc_out, and immutability - #623
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
how-it-works.md:withdraw()'s documented signature was missingmin_usdc_out(added by fix(vault): add min_usdc_out slippage guard to withdraw() #600). Added the new slippage-guard and contract-immutability security properties, and a missing section on the keeper system (accrual + migration), which wasn't documented anywhere despite being how the product keeps its yield promise over time.introduction.md: corrected an inaccuracy implying protocol switching only happens via manual admin action. The migration keeper does this automatically now;set_adapteris the manual fallback, not the mechanism.why-meridian.md: connected the "why an aggregator" pitch to the fact that rate-chasing is now automated, not just a deposit-time decision.index.mdwas checked and needed no changes, its claims still hold.Test plan
prettier --checkpasses on all three fileswithdraw()'s current signature and the keeper schedule directly againstpackages/contracts/vault/src/lib.rsand.github/workflows/keepers.ymlbefore writing