-
Notifications
You must be signed in to change notification settings - Fork 2
restructure and refine Vaults docs #114
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
ulieth
wants to merge
13
commits into
main
Choose a base branch
from
docs/improve-vaults
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
003b414
restructure and refine Vaults docs
ulieth 4650f9e
add redirects for renamed Vault pages
ulieth 1352bca
changed the visual's title from MetaVaults in plural to MetaVault in …
ulieth 56bf509
Potential fix for pull request finding
ulieth ea73757
Refine Vault Verification admonition, fix visuals and Oracle threshold
ulieth cf1b8ef
Merge main into docs/improve-vaults
ulieth 9386b07
address review comments, small edits
ulieth c19fe77
Refine Boost page and fix Vaults docs issues
ulieth 81d0690
add new chart for boost reward flow
ulieth b4e8c39
Merge main into docs/improve-vaults, resolve redirects.ts
ulieth 2ba16c6
add new boost image
ulieth 9a9c4d7
review comments and update Vault performance section
ulieth de49a36
apply review comments
ulieth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,94 @@ | ||
| --- | ||
| title: Boost | ||
| description: Amplify staking rewards up to 3x with StakeWise Boost. Learn how osToken looping on Aave works, safety mechanisms, and how to boost/unboost. | ||
| description: Amplify staking rewards up to 3x with StakeWise Boost. Learn how osETH looping on Aave works and the safety mechanisms behind it. | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage' | ||
|
|
||
| # Boost | ||
| StakeWise Boost is a one-click yield amplification strategy: it uses your osETH as collateral on Aave to borrow additional ETH, which is then staked to amplify your rewards. | ||
|
|
||
| StakeWise Boost is a yield amplification strategy that profits from the difference between the extra staking rewards and the cost of sourcing additional ETH. Boost uses osETH as collateral to borrow additional ETH on Aave and stake it again, creating a "looped" process that amplifies your staking position: | ||
|
|
||
| - **6x looping** in Vaults with 90% LTV | ||
| - **14x looping** in Vaults with 100% LTV | ||
| - **Up to 3x boost** in staking rewards compared to normal staking | ||
|
|
||
| Over the mid term (6+ months holding period), Boost historically generates ~1–3 percentage points above the base staking rate, depending on the spread between staking rewards and Aave borrow rates, for a total APY of approximately **4–6%**. | ||
| :::custom-tips[Boost Your Rewards] | ||
| To start using Boost right away, see [this guide](/staker/boost). | ||
| ::: | ||
|
|
||
| ## How Boost Works | ||
|
|
||
| Built into every Vault by default, Boost combines your original deposit with ETH borrowed from Aave into a single staking position. | ||
| You deposit osETH into Boost via the Vault or Stake page. | ||
| Boost then uses your osETH as collateral on Aave to borrow additional ETH. | ||
| The borrowed ETH is staked in the Vault on your behalf. | ||
| This process repeats automatically. | ||
| Boost combines your original osETH with ETH borrowed from Aave into a single staking position: | ||
|
|
||
| 1. You deposit osETH into [Boost via the Vault or Stake page](/staker/boost). | ||
| 2. Boost uses your osETH as collateral on Aave to borrow additional ETH. | ||
| 3. The borrowed ETH is staked in the Vault on your behalf. | ||
| 4. Steps 2–3 repeat in a loop, amplifying your rewards. | ||
|
|
||
| <Image img={require('./img/stakewise_boost_money_flow.png')} alt="Boost flow explanation" /> | ||
|
|
||
| Staking rewards are earned on the entire amount — so even after deducting Aave interest and operator fees, your net rewards are far greater than staking your original deposit alone — and StakeWise charges no additional fee for using Boost. Boost does not rely on the secondary market for repaying debt, so your strategy profit is not affected by slippage during exits. | ||
| The amount of amplification depends on the [Vault's osETH LTV](../ostoken/how-ostoken-works#loan-to-value-limits) — how much osETH you can mint per unit staked (distinct from Aave's borrow LTV in [Safety](#safety)): | ||
|
|
||
| Boost replaces 40+ manual steps with a single click, allowing even novice users to amplify their staking rewards without navigating the complex DeFi landscape — | ||
| with exposure limited to the node operators of your chosen Vault and the smart contracts of StakeWise and Aave. | ||
| - **6x looping** in Vaults with 90% osETH LTV | ||
| - **14x looping** in Vaults with 100% osETH LTV | ||
|
|
||
| This can amplify staking rewards up to **3x** compared to normal staking. Over the mid-term (a 6+ month holding period), Boost historically generates ~1–3 percentage points above the base staking rate, depending on the spread between staking rewards and Aave borrow rates, for a total APY of approximately **4–6%**. | ||
|
|
||
| Staking rewards are earned on the entire amount, so even after Aave interest and operator fees, net rewards beat staking your original deposit alone. StakeWise charges no additional fee for using Boost. | ||
|
|
||
| ## Safety | ||
|
|
||
| ### Price Stability Protection | ||
| The biggest risks of any looped position are **collateral depeg** and **LTV (Loan-to-Value) drift toward liquidation**. In Boost, both are mitigated by design. | ||
|
|
||
| Boost eliminates depeg-related liquidation risks through Aave's use of StakeWise's native price feed for osETH instead of volatile secondary market prices. This means osETH price fluctuations on DEXs cannot trigger liquidations, as your collateral value always equals the osETH redemption value rather than market price. This design ensures that temporary market volatility doesn't endanger your boosted position. | ||
| ### No Depeg Liquidations | ||
|
|
||
| ### Safety Mechanisms | ||
| A depeg occurs when an asset loses its intended value and trades at a different price. | ||
|
|
||
| LTV (Loan-to-Value) is the ratio of your borrowed amount to the value of your collateral. For example, at 93% LTV, you can borrow 0.93 ETH against an osETH deposit worth 1 ETH. | ||
| Three key LTV metrics determine how safe your boosted position is: | ||
| Boost eliminates depeg-related liquidation risks because Aave uses StakeWise's native price feed for osETH instead of volatile secondary-market prices. Your collateral is always valued at what osETH can be redeemed for. | ||
|
|
||
| **Max LTV**: 93% – the maximum you can borrow against your osETH collateral when initiating a loan | ||
| ### LTV Has a Built-In Buffer | ||
|
|
||
| **Current LTV** – the value of your loan relative to your collateral right now, influenced by the Aave borrow rate and osETH APY over time | ||
| If borrow costs rise above staking rewards, the loan can grow faster than the collateral and push LTV toward liquidation. Boost is structured so that this drift is slow and bounded. | ||
|
|
||
| **Liquidation Threshold**: 95% – the point at which a position is considered undercollateralized and subject to liquidation | ||
| LTV on Aave is the ratio of your borrow to your collateral. Three numbers bound your position: | ||
|
|
||
| The 2% gap between Max LTV and Liquidation Threshold acts as a safety buffer, providing substantial protection before any liquidation risk.<sup><a href="#fn-1" id="fnref-1">1</a></sup> | ||
| - **Max LTV — 93%**: the highest you can borrow against your osETH collateral when opening a loan. | ||
| - **Liquidation Threshold — 95%**: the point at which a position becomes undercollateralized. | ||
| - **Current LTV**: where your position sits right now, drifting slowly with the spread between staking APY and Aave's borrow APY. | ||
|
|
||
|  | ||
| In normal markets the LTV actually **decreases** over time. Staking rewards outpace borrow costs, so your collateral grows faster than your debt — continuously de-risking the position. [Historical data ↗](https://blog.stakewise.io/caseStudy/how-stakewise-boost-keeps-your-rewards-juicy-and-your-stake-safe#:~:text=Scenario%201%3A%20When,passing%20day.) shows LTV rises on roughly 1 day in 9, and even under a sustained negative spread (borrow APY exceeding staking APY by ~2%) liquidation would take over a year from the 93% starting point. | ||
|
|
||
| Current LTV and Liquidation Threshold are the key variables for maintaining a healthy borrow position and avoiding liquidation. | ||
| <Image img={require('./img/danger_zone.png')} alt="LTV safety buffer between Max LTV and Liquidation Threshold" /> | ||
|
|
||
| ### Automatic Unboost | ||
|
|
||
| As an additional safety layer, Boost includes an automatic unboost mechanism that activates when positions approach the liquidation threshold. When any boosted position reaches 94.5% LTV, anyone in the community can trigger an automatic unboosting transaction to protect the user. | ||
| The StakeWise core team actively monitors all boosted positions and will trigger these protective exits when necessary, with all funds always remaining under the original owner's control. | ||
| As a final safeguard, when any boosted position reaches **94.5% LTV**, anyone in the community can trigger an unboosting transaction on your behalf. The StakeWise core team actively monitors all boosted positions and triggers these protective exits when necessary. Funds always remain under your control. | ||
|
|
||
| Boost does not rely on the secondary market for repaying debt, so your profit is not affected by slippage during exits. | ||
|
|
||
| ## Risks & Limitations | ||
| From a smart contract security perspective, your exposure is limited to the node operators of your chosen Vault and the smart contracts of StakeWise and Aave, both of which are regularly audited. | ||
|
|
||
| ## Market Conditions | ||
|
|
||
| Two market-driven conditions can affect your Boost position: | ||
|
|
||
| ### Borrow APY Exceeds Staking APY | ||
|
|
||
| Boost APY depends on the spread between your Vault's staking APY and Aave's variable WETH borrow APY. | ||
| Boost APY is positive when the borrow APY is lower than the staking APY, and negative when the borrow APY exceeds the staking APY. | ||
| Boost APY depends on the spread between your Vault's staking APY and Aave's variable WETH borrow APY — it's positive when borrow APY is below staking APY, and negative when it exceeds it. | ||
|
|
||
| When the borrow APY is lower than the staking APY, your LTV gradually decreases, making your position progressively safer. | ||
| When the borrow APY exceeds the staking APY, your LTV gradually increases. | ||
| You can monitor the current WETH variable borrow APY in the **Borrow Info** section of the [WETH reserve on Aave ↗](https://app.aave.com/reserve-overview/?underlyingAsset=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&marketName=proto_mainnet_v3). | ||
|
|
||
| :::custom-warning[Negative APY Alert] | ||
| If you see a negative APY on your Boost position, it means the WETH borrow APY on Aave currently exceeds your Vault's staking APY. | ||
| If the APY remains negative for more than 7 consecutive days, consider exiting Boost manually. | ||
| Stay connected with the [StakeWise Discord ↗](https://discord.com/invite/2BSdr2g) community for real-time updates on market conditions. | ||
| ::: | ||
|
|
||
| You can monitor the current WETH variable borrow APY in the **Borrow Info** section of the [WETH reserve on Aave ↗](https://app.aave.com/reserve-overview/?underlyingAsset=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&marketName=proto_mainnet_v3). | ||
|
|
||
| ### osETH Supply Cap Reached | ||
|
|
||
| Boost deposits osETH as collateral on Aave, which enforces a maximum supply cap. | ||
| When total supplied osETH reaches this cap, no additional osETH can be deposited, making it impossible to open new boosted positions. | ||
| Existing boosted positions are not affected, but new boosts cannot be initiated until supply drops below the cap. | ||
|
|
||
| You can monitor the current supply usage in the **Supply Info** section of the [osETH reserve on Aave ↗](https://app.aave.com/reserve-overview/?underlyingAsset=0xf1c9acdc66974dfb6decb12aa385b9cd01190e38&marketName=proto_mainnet_v3). | ||
|
|
||
| :::custom-notes[Guide] | ||
| To start using Boost, see [How to Use Boost →](/staker/boost) | ||
| ::: | ||
| You can monitor the current supply level in the **Supply Info** section of the [osETH reserve on Aave ↗](https://app.aave.com/reserve-overview/?underlyingAsset=0xf1c9acdc66974dfb6decb12aa385b9cd01190e38&marketName=proto_mainnet_v3). | ||
|
|
||
| :::custom-notes[Further Reading] | ||
| - [StakeWise Boost: A DeFi-Native Yield Amplification Strategy Made Simple ↗](https://blog.stakewise.io/caseStudy/stakewise-boost-a-defi-native-yield-amplification-strategy-made-simple) | ||
| - [Maximize Your Rewards With StakeWise Boost ↗](https://blog.stakewise.io/productUpdate/maximize-your-rewards-with-stakewise-boost) | ||
| - [How StakeWise Boost Keeps Your Rewards Juicy & Your Stake Safe ↗](https://blog.stakewise.io/caseStudy/how-stakewise-boost-keeps-your-rewards-juicy-and-your-stake-safe) | ||
| ::: | ||
|
|
||
| <div id="fn-1" style={{fontSize: '0.85em', color: 'var(--ifm-color-content-secondary)', marginTop: '2rem', listStyle: 'none', fontFamily: 'Fragment Mono, ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, Liberation Mono, Courier New, monospace'}}> | ||
| <span>1.</span> Based on the <a href="https://blog.stakewise.io/caseStudy/how-stakewise-boost-keeps-your-rewards-juicy-and-your-stake-safe#:~:text=Scenario%201%3A%20When,passing%20day." target="_blank" rel="noopener noreferrer">historical analysis of 420 days</a>, LTV increases only ~10.7% of the time (39 days per year). On the remaining days, LTV actually decreases — for every 1 day of LTV increase, there are ~8 days of decline, making positions progressively safer over time. Even in an extreme scenario where borrow APY consistently exceeds osETH APY by 2%, starting from 93% LTV, liquidation would take over a year. As for mass slashing, breaching the 2% buffer would require 480–1,150 validators to be slashed across the protocol simultaneously — an event that has never occurred in StakeWise's 4-year history. | ||
| <a href="#fnref-1" style={{color: 'var(--ifm-color-content-secondary)', textDecoration: 'none'}}>↩</a> | ||
| </div> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| title: Configuration | ||
| description: Configure StakeWise Vault parameters — capacity, MEV strategy, management roles, branding, and fees. | ||
| toc_max_heading_level: 3 | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage' | ||
|
|
||
| When [creating a Vault](/operator/create-regular-vault), operators set parameters that define how it operates — deposit capacity, MEV strategy, management roles, branding, and fees. Some are fixed at creation; others can be updated later by designated roles. | ||
|
|
||
| <Image img={require('./img/config.png')} alt="Vault Configuration Parameters" /> | ||
|
|
||
| ## Immutable Parameters | ||
|
|
||
| Capacity and MEV strategy are immutable parameters set once during Vault creation. | ||
|
|
||
| ### Capacity | ||
|
|
||
| The maximum ETH a Vault can accept; if unset, deposits are unlimited. The cap is enforced on every deposit — transactions that would exceed it revert with a `CapacityExceeded` error. This is useful for matching Vault size to the node operator's infrastructure. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### MEV Strategy | ||
|
|
||
| <Image img={require('./img/mev_strategy.png')} alt="Vault MEV strategy options - Smoothing Pool vs Own Escrow" /> | ||
|
ulieth marked this conversation as resolved.
|
||
|
|
||
| MEV (Maximal Extractable Value) is the extra profit validators can capture when proposing blocks. | ||
| Vaults can use either a **Smoothing Pool** or **Own Escrow** to collect block rewards. This choice is set at creation and can't be changed. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### Smoothing Pool {#smoothing-pool} | ||
|
|
||
| Rewards are pooled across multiple Vaults and distributed in proportion to each Vault's stake, providing more stable and predictable returns regardless of block proposal frequency. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| For example, a Vault with only a few validators can still receive periodic small payouts from the Smoothing Pool. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
| In return, when one of its validators does earn a block proposal reward, that reward flows to the Smoothing Pool to be shared among all participating Vaults. | ||
|
|
||
| Vaults that use the Smoothing Pool must set every relay to one of the [StakeWise DAO-approved MEV relays](/operator/smoothing-pool-relays#approved-relay-endpoints). This ensures a consistently high contribution to the Smoothing Pool from every participating Vault. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### Own Escrow | ||
|
|
||
| Each Vault keeps its own block rewards. Because nothing is shared, the Vault can pick any relay — targeting maximum value capture at the cost of higher variability. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Roles | ||
|
|
||
| <Image img={require('./img/roles.png')} alt="Protocol Roles Diagram" /> | ||
|
|
||
| Every Vault has several key roles for the internal management of the staking process. All are assigned by the **Admin** — through the **Settings → Roles** tab on the Vault page, or by calling the corresponding function on the Vault contract. | ||
|
|
||
| ### Admin | ||
|
|
||
| Primary controller of the Vault, and its creator by default. An Admin can be a single wallet, multisig, or DAO. The Admin's authority covers: | ||
|
|
||
| - Assigning and reassigning every role, including its own | ||
| - Updating the Vault's branding and fees | ||
| - Setting the fee recipient and shareholder splits | ||
| - Upgrading the Vault to a new contract version | ||
|
|
||
| ### Vault Fee Claimer | ||
|
|
||
| Triggers [claims of accumulated Vault fees](/operator/manage-vault/fee-claiming) on behalf of shareholders. | ||
|
|
||
| By default a Vault's fees go to a single recipient. To split them, the Admin points the recipient at a **Fee Splitter** — a contract that divides incoming fees among multiple shareholders by their configured shares — set on the Vault page under **Settings → Vault fee**. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Whitelist Manager | ||
|
|
||
| Adds or removes the addresses authorized to deposit. Only present in Private Vaults. | ||
|
|
||
| ### Blocklist Manager | ||
|
|
||
| Adds or removes the addresses blocked from depositing. Only present in Blocklist Vaults. | ||
|
|
||
| ### Validators Manager | ||
|
|
||
| Authorizes the Vault's core validator operations — registration, funding, consolidation, and withdrawals. The [Operator Service automates most of the validator lifecycle](/operator/launch-operator-service#core-functions), and each on-chain action it submits must be signed by the address assigned to this role. | ||
|
|
||
| ## Settings | ||
|
|
||
| Branding and fees are configurable parameters updated by the Admin. | ||
|
|
||
| ### Branding | ||
|
|
||
| The Vault's name, description, and image. Set and updated on the Vault page under **Settings → Branding**. | ||
|
|
||
| :::custom-stakewise[Authenticity Guarantee] | ||
| Before Vault branding appears in the StakeWise interface, the StakeWise team manually verifies that the operator controls the Vault. This prevents impersonation — a Vault displayed as "Operator A" is always controlled and run by Operator A. | ||
|
ulieth marked this conversation as resolved.
Outdated
|
||
| ::: | ||
|
|
||
| ### Fee | ||
|
|
||
| A [percentage fee](../fees/intro) charged on staking rewards, ranging from 0% to 100%. | ||
|
|
||
| Initially set during Vault creation and updated later on the Vault page under **Settings → Vault fee**, subject to protocol restrictions: each increase is capped at 20% relative to the current fee (e.g., a 10% fee can rise to at most 12%), with a 3-day delay between updates. If the current fee is 0%, it cannot exceed 1% on the first increase. | ||
|
|
||
| The fee is automatically deducted from rewards when the Vault state is updated, and transferred to the Vault's fee recipient. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.