Merge pull request #758 from lidofinance/v3-docs-update

DeFi Wrapper guide

Author: TheDZhon

run-on-lido/stvaults/building-guides/basic-stvault.md

@@ -2,9 +2,6 @@
 sidebar_position: 1
 ---
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
 # Basic stVault with optional liquidity
 
 ## Intro
@@ -49,7 +46,7 @@ Creating an stVault is permissionless. There are two main ways to do it:
 1. **Node Operator address** — a unique, immutable identifier of the Node Operator within stVaults, used in protocol logic such as calculating per-operator stETH minting terms and limits. It designates the Node Operator that provides validation services for the stVault and also manages ETH deposits from the stVault balance to validators, as well as handling validator exits when required.
 2. **Node Operator Manager address**. One of the two administrative roles in an stVault. From the Node Operator perspective, this role manages permissions and can update key vault parameters. Multiple addresses are supported.
 3. **Vault Owner address**. One of the two administrative roles in an stVault. From the Vault Owner (Staker) perspective, this role manages permissions and can update key vault parameters. Multiple addresses are supported.
-4. **Node Operator Fee**. The share of gross staking rewards that the Node Operator charges for providing validation services. Expressed in basis points [0 (0%) .. 10'000 (100%)].
+4. **Node Operator Fee**. The share of gross staking rewards that the Node Operator charges for providing validation services. Expressed in basis points [0 (0%) .. 10,000 (100%)].
 5. **Confirmation Lifetime**. The key parameter of the multi-role confirmation mechanism. It defines the maximum time interval between proposal and confirmation. This mechanism is used to update certain stVault parameters by requiring consensus between the two stVault representatives: the Vault Owner and the Node Operator Manager. Measured in seconds [86,400 sec (24 hours) .. 25,920,000 sec (30 days)]. For security reasons, it is strongly recommended to keep it as short as possible, ideally the minimum 86,400 sec.
 
 #### 1. Two-step process (recommended)
@@ -121,7 +118,7 @@ This is a permissioned operation. By default, this permission belongs to the Vau
 - `TierID`: the ID of the tier to which the stVault will be connected.
 - `RequestedShareLimit`: the requested absolute stETH minting limit for the stVault, expressed in shares. This value cannot exceed the tier’s stETH limit.
 - `payableAmount`: the amount of ETH to supply in the same transaction; minimum is **1 ETH**.
-- `currentSettledGrowth` the amount of unaccounted growth accrued on the vault while it was disconnected. 0 for newly created vaults via create without connecting method. Settled growth is the part of the total growth that has already been charged by the node operator or is not subject to fee (exempted), such as unguaranteed or side deposits, and consolidations accrued while the vault was disconnected.
+- `currentSettledGrowth`: the amount of unaccounted growth accrued on the vault while it was disconnected; 0 for newly created vaults via the create-without-connecting method. Settled growth is the part of the total growth that has already been charged by the node operator or is not subject to fee (exempted), such as unguaranteed or side deposits, and consolidations accrued while the vault was disconnected.
 
 
 <details>
@@ -130,8 +127,8 @@ This is a permissioned operation. By default, this permission belongs to the Vau
 
       2. Connect wallet on the "My Vaults" page.
 
-      3. Open an stVault overview page by the URL ```https://<domain>/vaults/<StakingVault_address>```
-      
+      3. Open an stVault overview page at `https://<domain>/vaults/<StakingVaultAddress>`
+
       ![Connect and accept tier](/img/stvaults/guide-basic-stvault/guide_1_scr_8.png)
 
       4. Review parameters and click "Approve and supply 1 ETH".
@@ -156,8 +153,8 @@ This is a permissioned operation. By default, this permission belongs to the Vau
       3. Open the **Contract** tab → **Write as Proxy**.
       4. Click **Connect to Web3** and connect your wallet in the dialog window.
       5. Find the `connectAndAcceptTier` method in the list, fill out the fields, and click **Write**.
-         -  fill out the `payableAmount` field with '1' to supply `1 ETH` in the same transaction.
-         -  set the `_currentSettledGrowth` field to '0' for newly created vault like in this scenario (if the stVault is newly created but had side deposits before connecting, settled growth must be set accordingly before the connection).
+         - fill out the `payableAmount` field with '1' to supply `1 ETH` in the same transaction.
+         - set the `_currentSettledGrowth` field to '0' for a newly created vault like in this scenario (if the stVault is newly created but had side deposits before connecting, settled growth must be set accordingly before the connection).
       6. Sign the transaction in your wallet.
       7. Click **View your transaction** and wait for it to be executed.
 </details>
@@ -235,7 +232,7 @@ Confirming tier change request requires applying fresh report to vault.
 
       ![Review settings](/img/stvaults/guide-basic-stvault/guide_1_scr_3.png)
 
-      4. On behalf of the another contracting party open 'Settings > Tiers'.
+      4. On behalf of the other contracting party, open 'Settings > Tiers'.
 
       ![Open proposal](/img/stvaults/guide-basic-stvault/guide_1_scr_4.png)
 
@@ -254,7 +251,7 @@ Confirming tier change request requires applying fresh report to vault.
       yarn start vo w change-tier -v <vaultAddress> -r <requestedShareLimit> <tierId>
       ```
 
-      On behalf of the Node Operator ([details and examples](https://lidofinance.github.io/lido-staking-vault-cli/commands/vault-operations/#change-tier-by-no-ct-no))::
+      On behalf of the Node Operator ([details and examples](https://lidofinance.github.io/lido-staking-vault-cli/commands/vault-operations/#change-tier-by-no-ct-no)):
 
       ```bash
       yarn start vo w change-tier-by-no -v <vaultAddress> -r <requestedShareLimit> <tierId>
@@ -337,8 +334,8 @@ yarn start vo w withdraw <amount>
       3. Open the **Contract** tab → **Write as Proxy**.
       4. Click **Connect to Web3** and connect your wallet in the dialog window.
       5. Find the required method in the list, fill out the fields, and click **Write**:
-         - `fund` to supply (fund) ETH into the stVault; 
-         - `withdraw` to withdraw ETH from the stVault balance. (accepts wei for amount)
+         - `fund` to supply (fund) ETH into the stVault.
+         - `withdraw` to withdraw ETH from the stVault balance (accepts wei for amount).
       6. Sign the transaction in your wallet.
       7. Click **View your transaction** and wait for it to be executed.
 </details>
@@ -439,8 +436,12 @@ Read more: [Technical details](https://hackmd.io/@lido/stVaults-design#315-Essen
 
 The key stVault metrics that the Vault Owner should monitor and control are:
 
-- **Utilization ratio** -- the share of the stETH minting capacity currently used by the Vault Owner. [Learn more](../parameters-and-metrics)
-- **Health Factor** -- a metric that reflects the economic state of the vault. It shows how the stETH liability is collateralized by the Total Value. A Health Factor of 100% corresponds to the Forced Rebalance Threshold, meaning that if the Health Factor falls below 100%, the stVault becomes subject to forced rebalancing. [Learn more](../parameters-and-metrics)
+- **Utilization ratio** — the share of the stETH minting capacity currently used by the Vault Owner. [Learn more](../parameters-and-metrics)
+- **Health Factor** — a metric that reflects the economic state of the vault. It shows how the stETH liability is collateralized by the Total Value. A Health Factor of 100% corresponds to the Forced Rebalance Threshold, meaning that if the Health Factor falls below 100%, the stVault becomes subject to forced rebalancing. [Learn more](../parameters-and-metrics)
+
+Read more:
+- [Health Monitoring Guide](../health-monitoring-guide.md)
+- [Health Emergency Guide](../health-emergency-guide.md)
 
 The Health Factor metric may decrease as a result of validator underperformance, penalties, or a slashing event.
 
@@ -450,7 +451,7 @@ If this happens, there are three main options available:
 - Repay stETH to reduce stETH liability.
 - Rebalance ETH (optionally combined with a supply in a single transaction).
 
-**Rebalancing** involves transferring available ETH from the stVault balance to Lido Core, receiving stETH at a 1:1 ratio, and repaying it back to the stVault. This reduces stETH Liability and thereby increases the Health Factor.
+**Rebalancing** involves transferring available ETH from the stVault balance to Lido Core, receiving stETH at a 1:1 ratio, and repaying it back to the stVault. This reduces stETH liability and thereby increases the Health Factor.
 
 Rebalancing is performed in one transaction.
 
@@ -485,7 +486,7 @@ The amount of ETH required for rebalancing to bring the Utilization Ratio to 100
 
 ## Useful links
 
-- [Health Monitoring Guide](../health-monitoring-guide.md)
-- [Health Emergency Guide](../health-emergency-guide.md)
 - [stVaults Roles](../roles-and-permissions)
 - [stVaults Metrics](../parameters-and-metrics)
+- [Health Monitoring Guide](../health-monitoring-guide.md)
+- [Health Emergency Guide](../health-emergency-guide.md)

run-on-lido/stvaults/building-guides/index.md

@@ -7,7 +7,7 @@ The stVaults platform enables the creation of staking products tailored to diffe
 | Staking Product to build | Its Value Proposition | Its Segments |
 | -------- | -------- | -------- |
 | [Basic stVault with optional liquidity](./basic-stvault.md) | A competitive alternative to native staking: users stake with the same Node Operator while gaining optional liquidity through stETH. | Institutional stakers, large individual stakers (32+ ETH), funds, treasuries, builders, integrators, liquidity providers. |
-| **(Coming soon)** Pooled staking product with white-labeled UI and yield-boosting strategy | A DeFi-wrapped stVault with pooling, liquidity, automated yield-boosting strategy, and white-labeled staking UI – all in one customizable no-code/low-code solution. | Retail stakers (< 32 ETH), APR-maximizers, institutional stakers seeking a simple staking UI. |
+| [Pooled staking product with white-labeled UI and yield-boosting strategy](./pooled-staking-product.md) | A DeFi-wrapped stVault with pooling, liquidity, automated yield-boosting strategy, and white-labeled staking UI – all in one customizable no-code/low-code solution. | Retail stakers (&lt;32 ETH), APR-maximizers, institutional stakers seeking a simple staking UI. |
 
 :::info
 Have your own custom product in mind? [Contact us](https://tally.so/r/mVrkZa)!