docs: add hub funded spoke pool documentation - #385
Draft
Debugger022 wants to merge 1 commit into
Draft
Conversation
Covers the SpokeComptroller fork, its supply and liquidation allowlists, per-market liquidation incentives and bounded collateral pricing. Adds the Liquidity Hub Spoke adapter, the bStock liquidator reference, and the internalCash change to isolated-pool markets.
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
1 participant
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.
Documents the hub-funded spoke pool work. Draft: nothing is deployed or wired yet, and every page says so.
Implementation PRs this covers:
New
whats-new/hub-funded-spoke-pools.md- product introduction: the two-sided pool, access matrix, retail and bulk shapes, worked example, risk controls, where bad debt lands.reference-isolated-pools/spoke/-README(why the fork exists, deploy and VIP ordering),spoke-comptroller(supply and liquidation allowlists, per-market liquidation incentives, themaxClearableDebtrouting betweenliquidateAccountandhealAccount, bounded pricing, full API/event/error delta),spoke-comptroller-storage(layout and why it is not swappable withComptrollerStorage).reference-core-pool/bstock-liquidator.md-BStockLiquidatorhad no docs at all despite being live on BNB Chain, so this is a full page: both pools, both funding modes, the swap chain, the loss floors, the vBNB and VAI branches.Updated
AdapterSpokeV1section: NAV excludesbadDebt, withdraw redeems by vToken count, inverted supply-cap sentinels, and the ordering constraint (setAllowedSupplierbeforeaddResource).internalCashchange, which applies to every isolated-pools market and not just spoke pools. CoverssyncCash, the correctedgetCashsemantics, and the migration hazard: an upgraded market reports zero cash untilsyncCash()runs, so it belongs in the same VIP as the beacon upgrade.SUMMARY.md- three TOC entries.