[boost improve] update readme

stakewise · Feb 5, 2025 · ddb472a · ddb472a
1 parent 6820de8
commit ddb472a
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 8 deletions.
diff --git a/changelog/next-release.md b/changelog/next-release.md
@@ -0,0 +1,18 @@
+# Updates
+### 1. `sdk.boost.getData`
+
+#### New output fields:
+
+```ts
+type AddedOutput = {
+  totalShares: bigint
+  borrowStatus: BorrowStatus
+  borrowedAssets: bigint
+}
+```
+
+| Name             | Description                                                      |
+|------------------|------------------------------------------------------------------|
+| `totalShares`    | Tokens count of boost + reward assets converted to shares        |
+| `borrowStatus`   | Aave borrow status. enum BorrowStatus (Healthy, Moderate, Risky) |
+| `borrowedAssets` | Amount of borrowed ETH                                           |
diff --git a/src/methods/boost/requests/getData/getData.md b/src/methods/boost/requests/getData/getData.md
@@ -20,22 +20,28 @@ Get boost data for vault user
 type Output = {
   shares: bigint
   vaultApy: number
+  totalShares: bigint
   rewardAssets: bigint
+  borrowStatus: BorrowStatus
   maxMintShares: bigint
+  borrowedAssets: bigint
   exitingPercent: number
   allocatorMaxBoostApy: number
   osTokenHolderMaxBoostApy: number
 }
 ```
 
-| Name             | Description                                                                                      |
-|------------------|--------------------------------------------------------------------------------------------------|
-| `shares`         | Tokens count of boost |
-| `vaultApy`       | Base vault apy |
-| `maxMintShares`  | Maximum possible number of osToken without deductions |
-| `exitingPercent` | The percent (in wad) of user's position that is currently exiting |
-| `rewardAssets`   | User boost rewards |
-| `allocatorMaxBoostApy` | The average max boost APY earned in this vault by the allocator |
+| Name                       | Description                                                          |
+|----------------------------|----------------------------------------------------------------------|
+| `shares`                   | Tokens count of boost                                                |
+| `totalShares`              | Tokens count of boost + reward assets converted to shares            |
+| `vaultApy`                 | Base vault apy                                                       |
+| `maxMintShares`            | Maximum possible number of osToken without deductions                |
+| `exitingPercent`           | The percent (in wad) of user's position that is currently exiting    |
+| `rewardAssets`             | User boost rewards                                                   |
+| `borrowStatus`             | Aave borrow status. enum BorrowStatus (Healthy, Moderate, Risky)     |
+| `borrowedAssets`           | Amount of borrowed ETH                                               |
+| `allocatorMaxBoostApy`     | The average max boost APY earned in this vault by the allocator      |
 | `osTokenHolderMaxBoostApy` | The average max boost APY earned in this vault by the osToken holder |
 
 #### Example: