|
1 |
| -# Updates |
2 |
| -### 1. `sdk.vault.getVault` |
3 |
| - |
4 |
| -#### New output field: |
5 |
| - |
6 |
| -```ts |
7 |
| -type AddedOutput = { |
8 |
| - osTokenConfig: { |
9 |
| - ltvPercent: string |
10 |
| - liqThresholdPercent: string |
11 |
| - } |
12 |
| - queuedShares: string |
13 |
| - allocatorMaxBoostApy: number |
14 |
| - osTokenHolderMaxBoostApy: number |
15 |
| - isGenesis: boolean |
16 |
| -} |
17 |
| -``` |
18 |
| -
|
19 |
| -| Name | Description | |
20 |
| -|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
21 |
| -| `osTokenConfig` | contains the `ltvPercent`, which is the percentage used to calculate how much a user can mint in OsToken shares, and `liqThresholdPercent`, which is the liquidation threshold percentage used to calculate the health factor for the OsToken position | |
22 |
| -| `isGenesis` | This vault is owned by stakewise | |
23 |
| -| `allocatorMaxBoostApy` | The average max boost APY earned in this vault by the allocator | |
24 |
| -| `osTokenHolderMaxBoostApy` | The average max boost APY earned in this vault by the osToken holder | |
25 |
| -| `queuedShares` | The total number of queued shares | |
26 |
| -
|
27 |
| ---- |
28 |
| -### 2. `sdk.vault.getHarvestParams` |
29 |
| -
|
30 |
| -#### New output format: |
31 |
| -
|
32 |
| -```ts |
33 |
| -type Output = { |
34 |
| - canHarvest: boolean // NEW |
35 |
| - params: { |
36 |
| - reward: string |
37 |
| - proof: Array<string> |
38 |
| - rewardsRoot: string |
39 |
| - unlockedMevReward: string |
40 |
| - } |
41 |
| -} |
42 |
| -``` |
43 |
| -
|
44 |
| ---- |
45 |
| -
|
46 |
| -### 3. Removed method |
47 |
| -### `sdk.osToken.getAvgRewardsPerSecond` |
48 |
| -
|
49 |
| ---- |
50 |
| -
|
51 |
| -### 4. Removed output field |
52 |
| -### `sdk.osToken.getPosition` |
53 |
| -
|
54 |
| -Removed fee |
55 |
| -
|
56 |
| -```ts |
57 |
| -type RemovedOutput = { |
58 |
| - minted: { |
59 |
| - fee: bigint |
60 |
| - } |
61 |
| -} |
62 |
| -``` |
63 |
| -
|
64 |
| -| Name | Description | |
65 |
| -|----------------|------------------------------------| |
66 |
| -| `boost.shares` | Count of osToken tokens with boost | |
67 |
| -
|
68 |
| -### 5. Added method getStakewiseStats |
69 |
| -### `sdk.utils.getStakewiseStats` |
70 |
| -#### Getting common stakewise data for the network |
71 |
| -
|
72 |
| ---- |
73 |
| -
|
74 |
| -### 6. Added optional input field |
75 |
| -### `sdk.vault.getExitQueuePositions` |
76 |
| -#### Added Argument: |
77 |
| -
|
78 |
| -| Name | Type | Required | |
79 |
| -|--------------|-----------|----------| |
80 |
| -| isClaimed | `boolean` | **No** | |
81 |
| -
|
82 |
| ---- |
83 |
| -
|
84 |
| -### 7. Removed output field |
85 |
| -### `sdk.vault.getStakeBalance` |
86 |
| -
|
87 |
| -```ts |
88 |
| -type RemovedOutput = { |
89 |
| - shares: bigint |
90 |
| -} |
91 |
| -``` |
92 |
| ---- |
93 |
| -
|
94 |
| -### 8. Deprecated method `sdk.osToken.getConfig` |
95 |
| -### Use `sdk.vault.getVault` instead to get the result in `osTokenConfig` field. |
96 |
| -
|
97 |
| ---- |
98 |
| -
|
99 |
| -### 9. Added methods |
100 |
| -### `sdk.vault.getVaultStats` & `sdk.vault.getUserStats` |
101 |
| -#### With the help of this data it is possible to build a chart. |
102 |
| -
|
103 |
| ---- |
104 |
| -
|
105 |
| -### 10. Removed method `sdk.vault.getSnapshots` |
106 |
| -### Use `sdk.vault.getVaultStats` instead |
107 |
| -
|
108 |
| ---- |
109 |
| -
|
110 |
| -### 11. Updated method `sdk.vault.getUserRewards` |
111 |
| -#### Updated output format: |
112 |
| -
|
113 |
| -```ts |
114 |
| -type Output = Array<{ |
115 |
| - date: number |
116 |
| - dailyRewards: number |
117 |
| - dailyRewardsEur: number |
118 |
| - dailyRewardsGbp: number |
119 |
| - dailyRewardsUsd: number |
120 |
| -}> |
121 |
| -``` |
122 |
| -
|
123 |
| -#### New arguments: |
124 |
| -
|
125 |
| -| Name | Type | Type | Description | |
126 |
| -|--------------|----------|---------|-------------------------------| |
127 |
| -| dateFrom | `number` | **Yes** | Time to start in milliseconds | |
128 |
| -| dateTo | `number` | **Yes** | Time to end in milliseconds | |
129 |
| -| userAddress | `string` | **Yes** | The user address | |
130 |
| -| vaultAddress | `string` | **Yes** | The address of the vault | |
131 |
| -
|
132 |
| ---- |
133 |
| -
|
134 |
| -### 12. Added method getFiatRates |
135 |
| -### `sdk.utils.getFiatRates` |
136 |
| -#### Getting fiat values for the network |
137 |
| -
|
138 |
| ---- |
139 |
| -
|
140 |
| -### 13. Removed input field |
141 |
| -### `sdk.vault.operate` |
142 |
| -#### Removed depositDataRoot use `vault.setDepositDataRoot` instead |
143 |
| -#### Removed depositDataManager use `vault.setDepositDataManager` instead |
144 |
| -
|
145 |
| -```ts |
146 |
| -type RemovedInput = { |
147 |
| - depositDataManager: string |
148 |
| - depositDataRoot: string |
149 |
| -} |
150 |
| -``` |
151 |
| -
|
152 |
| ---- |
153 |
| -
|
154 |
| -### 14. Removed method `sdk.vault.getScorePercentiles` |
155 |
| -
|
156 |
| ---- |
157 |
| -
|
158 |
| -### 15. Added method |
159 |
| -### `sdk.boost.getData` |
160 |
| -#### Get the address of the leverage strategy proxy contract |
161 |
| ---- |
162 |
| -
|
163 |
| -### 16. Added method |
164 |
| -### `sdk.boost.getLeverageStrategyProxy` |
165 |
| -#### Get the address of the leverage strategy proxy contract |
166 |
| -
|
167 |
| ---- |
168 |
| -
|
169 |
| -### 17. Added method |
170 |
| -### `sdk.utils.getPermitSignature` |
171 |
| -#### Get permit signature for ERC20 token |
172 |
| -
|
173 |
| ---- |
174 |
| -
|
175 |
| -### 18. Added method |
176 |
| -### `sdk.boost.lock` |
177 |
| -#### Boost your osToken apy using leverage staking |
178 |
| -
|
179 |
| ---- |
180 |
| -
|
181 |
| -### 19. Added method |
182 |
| -### `sdk.boost.unlock` |
183 |
| -#### Unboost your boosted osToken |
184 |
| -
|
185 |
| ---- |
186 |
| -
|
187 |
| -### 20. Added method |
188 |
| -### `sdk.boost.claimQueue` |
189 |
| -#### Claim user unboost queue |
190 |
| -
|
191 |
| ---- |
192 |
| -
|
193 |
| -### 20. Changed output field |
194 |
| -### `sdk.vault.getExitQueuePositions` |
195 |
| -
|
196 |
| -```ts |
197 |
| -// Output changed type from bigint to string |
198 |
| -positions[number]['exitQueueIndex'] |
199 |
| -``` |
200 |
| -
|
201 |
| ---- |
202 |
| -
|
203 |
| -### 21. Added method |
204 |
| -### `sdk.utils.getFiatRatesByDay` |
205 |
| -#### Get fiat data by day |
206 |
| -
|
207 |
| ---- |
208 |
| -
|
209 |
| -### 22. `sdk.osToken.getAPY` |
210 |
| -
|
211 |
| -#### New output field: |
212 |
| -
|
213 |
| -```ts |
214 |
| -type Output = { |
215 |
| - apy: string |
216 |
| - feePercent: number |
217 |
| -} |
218 |
| -``` |
219 |
| -
|
220 |
| ---- |
221 |
| -
|
222 |
| -### 23. Added input field `referrerAddress` |
223 |
| -### `sdk.vault.deposit` |
224 |
| -### `sdk.osToken.mint` |
225 |
| -
|
226 |
| ---- |
227 |
| -
|
228 |
| -### 24. `sdk.utils.getFiatRates` |
229 |
| -
|
230 |
| -#### New output fields: |
231 |
| -
|
232 |
| -```ts |
233 |
| -type AddedOutput = { |
234 |
| - 'USD/CNY': number |
235 |
| - 'USD/JPY': number |
236 |
| - 'USD/KRW': number |
237 |
| - 'USD/AUD': number |
238 |
| -} |
239 |
| -``` |
240 |
| -
|
241 |
| ---- |
242 |
| -
|
243 |
| -### 25. `sdk.vault.getUserRewards` |
244 |
| -
|
245 |
| -#### New output fields: |
246 |
| -
|
247 |
| -```ts |
248 |
| -type AddedOutput = { |
249 |
| - dailyRewardsCny: number |
250 |
| - dailyRewardsJpy: number |
251 |
| - dailyRewardsKrw: number |
252 |
| - dailyRewardsAud: number |
253 |
| -} |
254 |
| -``` |
255 |
| -
|
256 |
| ---- |
257 |
| -
|
258 |
| -### 26. `sdk.utils.getFiatRatesByDay` |
259 |
| -
|
260 |
| -#### New output fields: |
261 |
| -
|
262 |
| -```ts |
263 |
| -type AddedOutput = { |
264 |
| - usdToCnyRate: string |
265 |
| - usdToJpyRate: string |
266 |
| - usdToKrwRate: string |
267 |
| - usdToAudRate: string |
268 |
| -} |
269 |
| -``` |
0 commit comments