Skip to content

Commit c6c8f7b

Browse files
authored
Remove ScorePercentiles logic (#185)
* remove ScorePercentiles logic * improve docs
1 parent 6a62ffa commit c6c8f7b

File tree

7 files changed

+7
-115
lines changed

7 files changed

+7
-115
lines changed

README.md

+1-33
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,12 @@ const sdk = new StakeWiseSDK({
9898
| [vault.getMaxWithdraw](#sdkvaultgetmaxwithdraw) | [osToken.getSharesFromAssets](#sdkostokengetsharesfromassets) | |
9999
| [vault.getHarvestParams](#sdkvaultgetharvestparams) | [osToken.getAssetsFromShares](#sdkostokengetassetsfromshares) | |
100100
| [vault.getStakeBalance](#sdkvaultgetstakebalance) | [osToken.getRate](#sdkostokengetrate) | |
101-
| [vault.getScorePercentiles](#sdkvaultgetscorepercentiles) | [osToken.getConfig](#sdkostokengetconfig) | |
101+
| [vault.getUserStats](#sdkvaultgetuserstats) | [osToken.getConfig](#sdkostokengetconfig) | |
102102
| [vault.getUserRewards](#sdkvaultgetuserrewards) | [osToken.getHealthFactor](#sdkostokengethealthfactor) | |
103103
| [vault.getWhitelist](#sdkvaultgetwhitelist) | | |
104104
| [vault.getBlocklist](#sdkvaultgetblocklist) | | |
105105
| [vault.getRewardSplitters](#sdkvaultgetrewardsplitters) | | |
106106
| [vault.getVaultStats](#sdkvaultgetvaultstats) | | |
107-
| [vault.getUserStats](#sdkvaultgetuserstats) | | |
108107

109108
| **Utils** |
110109
|-----------------------------------------------------|
@@ -207,37 +206,6 @@ await sdk.vault.getStakerActions({
207206
})
208207
```
209208
---
210-
### `sdk.vault.getScorePercentiles`
211-
212-
#### Description:
213-
214-
This method is used to fetch information indicating the effectiveness or performance level of the vault.
215-
The retrieved data includes percentiles corresponding to various statuses.
216-
217-
#### Returns:
218-
219-
```ts
220-
type Output = {
221-
percentile25: number
222-
percentile50: number
223-
percentile75: number
224-
}
225-
```
226-
227-
| Name | Description |
228-
|------|---------------------------------------------------------------------------------------------------------|
229-
| `percentile25` | Represents the value corresponding to the **lowest** status. It is associated with the color (red) |
230-
| `percentile50` | Represents the value corresponding to the **moderate** status. It is associated with the color (orange) |
231-
| `percentile75` | Represents the value corresponding to the **good** status. It is associated with the color (light green) |
232-
233-
_For values greater than percentile75 the status corresponds to **excellent** with color (green)_
234-
235-
#### Example:
236-
237-
```ts
238-
await sdk.vault.getScorePercentiles()
239-
```
240-
---
241209
### `sdk.vault.getUserRewards`
242210

243211
#### Description:

changelog/next-release.md

+6
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,9 @@ type RemovedInput = {
136136
depositDataRoot: string
137137
}
138138
```
139+
140+
---
141+
142+
### 14. Removed method `sdk.vault.getScorePercentiles`
143+
144+
---

src/methods/vault/index.ts

-7
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import getStakeBalance from './requests/getStakeBalance'
1212
import getHarvestParams from './requests/getHarvestParams'
1313
import getStakerActions from './requests/getStakerActions'
1414
import getRewardSplitters from './requests/getRewardSplitters'
15-
import getScorePercentiles from './requests/getScorePercentiles'
1615
import getExitQueuePositions from './requests/getExitQueuePositions'
1716

1817
// Transactions
@@ -35,12 +34,6 @@ export default {
3534
* @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkvaultgetexitqueuepositions
3635
*/
3736
getExitQueuePositions,
38-
/**
39-
* @description This method is used to fetch information indicating the effectiveness
40-
* or performance level of the vault. The retrieved data includes percentiles corresponding to various statuses.
41-
* @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkvaultgetscorepercentiles
42-
*/
43-
getScorePercentiles,
4437
/**
4538
* @description Fetch the list of created reward splitters. A reward splitter is a contract
4639
* designed to distribute vault rewards among multiple fee recipients in predefined proportions.

src/methods/vault/requests/getScorePercentiles/index.ts

-29
This file was deleted.

src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.spec.ts

-23
This file was deleted.

src/methods/vault/requests/getScorePercentiles/modifyScorePercentiles.ts

-18
This file was deleted.

src/methods/vault/requests/getScorePercentiles/types.ts

-5
This file was deleted.

0 commit comments

Comments
 (0)