Remove ScorePercentiles logic (#185)

* remove ScorePercentiles logic * improve docs
stakewise · Oct 16, 2024 · c6c8f7b · c6c8f7b
1 parent 6a62ffa
commit c6c8f7b
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 115 deletions.
diff --git a/README.md b/README.md
@@ -98,13 +98,12 @@ const sdk = new StakeWiseSDK({
 | [vault.getMaxWithdraw](#sdkvaultgetmaxwithdraw)                 | [osToken.getSharesFromAssets](#sdkostokengetsharesfromassets) |                                                                   |
 | [vault.getHarvestParams](#sdkvaultgetharvestparams)             | [osToken.getAssetsFromShares](#sdkostokengetassetsfromshares) |                                                                   |
 | [vault.getStakeBalance](#sdkvaultgetstakebalance)               | [osToken.getRate](#sdkostokengetrate)                        |                                                                   |
-| [vault.getScorePercentiles](#sdkvaultgetscorepercentiles)       | [osToken.getConfig](#sdkostokengetconfig)                    |                                                                   |
+| [vault.getUserStats](#sdkvaultgetuserstats)        | [osToken.getConfig](#sdkostokengetconfig)                    |                                                                   |
 | [vault.getUserRewards](#sdkvaultgetuserrewards)                 |   [osToken.getHealthFactor](#sdkostokengethealthfactor)                                                            |                                                                   |
 | [vault.getWhitelist](#sdkvaultgetwhitelist)                     |                                                              |                                                                   |
 | [vault.getBlocklist](#sdkvaultgetblocklist)                     |                                                              |                                                                   |
 | [vault.getRewardSplitters](#sdkvaultgetrewardsplitters)         |                                                              |                                                                   |
 | [vault.getVaultStats](#sdkvaultgetvaultstats)                   |                                                               |                                                                   |
-| [vault.getUserStats](#sdkvaultgetuserstats)                     |                                                              |                                                                   |
 
 | **Utils**                                           |
 |-----------------------------------------------------|
@@ -207,37 +206,6 @@ await sdk.vault.getStakerActions({
 })
 ```
 ---
-### `sdk.vault.getScorePercentiles`
-
-#### Description:
-
-This method is used to fetch information indicating the effectiveness or performance level of the vault. 
-The retrieved data includes percentiles corresponding to various statuses.
-
-#### Returns:
-
-```ts
-type Output = {
-  percentile25: number
-  percentile50: number
-  percentile75: number
-}
-```
-
-| Name | Description                                                                                             |
-|------|---------------------------------------------------------------------------------------------------------|
-| `percentile25` | Represents the value corresponding to the **lowest** status. It is associated with the color (red)      |
-| `percentile50` | Represents the value corresponding to the **moderate** status. It is associated with the color (orange) |
-| `percentile75` | Represents the value corresponding to the **good** status. It is associated with the color (light green)      |
-
-_For values greater than percentile75 the status corresponds to **excellent** with color (green)_
-
-#### Example:
-
-```ts
-await sdk.vault.getScorePercentiles()
-```
----
 ### `sdk.vault.getUserRewards`
 
 #### Description:

diff --git a/changelog/next-release.md b/changelog/next-release.md
@@ -136,3 +136,9 @@ type RemovedInput = {
   depositDataRoot: string
 }
 ```
+
+---
+
+### 14. Removed method `sdk.vault.getScorePercentiles`
+
+---
diff --git a/src/methods/vault/index.ts b/src/methods/vault/index.ts
@@ -12,7 +12,6 @@ import getStakeBalance from './requests/getStakeBalance'
 import getHarvestParams from './requests/getHarvestParams'
 import getStakerActions from './requests/getStakerActions'
 import getRewardSplitters from './requests/getRewardSplitters'
-import getScorePercentiles from './requests/getScorePercentiles'
 import getExitQueuePositions from './requests/getExitQueuePositions'
 
 // Transactions
@@ -35,12 +34,6 @@ export default {
      * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkvaultgetexitqueuepositions
     */
     getExitQueuePositions,
-    /**
-     * @description This method is used to fetch information indicating the effectiveness
-     * or performance level of the vault. The retrieved data includes percentiles corresponding to various statuses.
-     * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkvaultgetscorepercentiles
-    */
-    getScorePercentiles,
     /**
      * @description Fetch the list of created reward splitters. A reward splitter is a contract
      * designed to distribute vault rewards among multiple fee recipients in predefined proportions.

diff --git a/src/methods/vault/requests/getScorePercentiles/index.ts b/src/methods/vault/requests/getScorePercentiles/index.ts
diff --git a/src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.spec.ts b/src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.spec.ts
diff --git a/src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.ts b/src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.ts
diff --git a/src/methods/vault/requests/getScorePercentiles/types.ts b/src/methods/vault/requests/getScorePercentiles/types.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -136,3 +136,9 @@ type RemovedInput = { @@
       depositDataRoot: string
     }
     ```
+    ---
+    ### 14. Removed method `sdk.vault.getScorePercentiles`
+    ---