@northstake/northstakeapi 1.0.39 → 1.0.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,7 +52,7 @@ export declare class LidoReadApi {
52
52
  addInterceptor(interceptor: Interceptor): void;
53
53
  /**
54
54
  *
55
- * @summary Get all dashboard role members for a specific Lido staking contract set
55
+ * @summary Get dashboard role members for a vault
56
56
  * @param contractsId The unique identifier of the Lido staking contracts
57
57
  */
58
58
  getAllDashboardRoleMembers(contractsId: string, options?: {
@@ -67,7 +67,7 @@ export declare class LidoReadApi {
67
67
  }>;
68
68
  /**
69
69
  *
70
- * @summary Get the vault report data from the lazy oracle for a specific Lido staking contract set
70
+ * @summary Get vault report data from lazy oracle
71
71
  * @param contractsId The unique identifier of the Lido staking contracts
72
72
  */
73
73
  getLazyOracleReportData(contractsId: string, options?: {
@@ -97,7 +97,7 @@ export declare class LidoReadApi {
97
97
  }>;
98
98
  /**
99
99
  *
100
- * @summary Get the vault report data from the lazy oracle for a specific Lido staking contract set
100
+ * @summary Get quarantine info for a vault
101
101
  * @param contractsId The unique identifier of the Lido staking contracts
102
102
  */
103
103
  getQuarantineInfo(contractsId: string, options?: {
@@ -77,7 +77,7 @@ class LidoReadApi {
77
77
  }
78
78
  /**
79
79
  *
80
- * @summary Get all dashboard role members for a specific Lido staking contract set
80
+ * @summary Get dashboard role members for a vault
81
81
  * @param contractsId The unique identifier of the Lido staking contracts
82
82
  */
83
83
  async getAllDashboardRoleMembers(contractsId, options = { headers: {} }) {
@@ -144,7 +144,7 @@ class LidoReadApi {
144
144
  }
145
145
  /**
146
146
  *
147
- * @summary Get the vault report data from the lazy oracle for a specific Lido staking contract set
147
+ * @summary Get vault report data from lazy oracle
148
148
  * @param contractsId The unique identifier of the Lido staking contracts
149
149
  */
150
150
  async getLazyOracleReportData(contractsId, options = { headers: {} }) {
@@ -292,7 +292,7 @@ class LidoReadApi {
292
292
  }
293
293
  /**
294
294
  *
295
- * @summary Get the vault report data from the lazy oracle for a specific Lido staking contract set
295
+ * @summary Get quarantine info for a vault
296
296
  * @param contractsId The unique identifier of the Lido staking contracts
297
297
  */
298
298
  async getQuarantineInfo(contractsId, options = { headers: {} }) {
@@ -14,6 +14,7 @@ import { CreateVaultRequest } from '../model/createVaultRequest';
14
14
  import { LidoStakingContracts } from '../model/lidoStakingContracts';
15
15
  import { LidoStakingContractsWithData } from '../model/lidoStakingContractsWithData';
16
16
  import { RenameVaultRequest } from '../model/renameVaultRequest';
17
+ import { SupportedValidatorProvidersResponse } from '../model/supportedValidatorProvidersResponse';
17
18
  import { VaultCreationStartResponse } from '../model/vaultCreationStartResponse';
18
19
  import { Authentication, Interceptor } from '../model/models';
19
20
  import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
@@ -66,6 +67,18 @@ export declare class LidoStakingVaultsApi {
66
67
  body: LidoStakingContractsWithData;
67
68
  status: number;
68
69
  }>;
70
+ /**
71
+ * Returns the list of validator providers that the current user can use when creating a Lido staking vault.
72
+ * @summary List supported validator providers for vault creation
73
+ */
74
+ getSupportedValidatorProviders(options?: {
75
+ headers: {
76
+ [name: string]: string;
77
+ };
78
+ }): Promise<{
79
+ body: SupportedValidatorProvidersResponse;
80
+ status: number;
81
+ }>;
69
82
  /**
70
83
  *
71
84
  * @summary List all Lido staking contract sets
@@ -209,6 +209,67 @@ class LidoStakingVaultsApi {
209
209
  });
210
210
  });
211
211
  }
212
+ /**
213
+ * Returns the list of validator providers that the current user can use when creating a Lido staking vault.
214
+ * @summary List supported validator providers for vault creation
215
+ */
216
+ async getSupportedValidatorProviders(options = { headers: {} }) {
217
+ const localVarPath = this.basePath + '/lidov3/staking-vaults/supported-providers';
218
+ let localVarQueryParameters = {};
219
+ let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
220
+ const produces = ['application/json'];
221
+ if (produces.indexOf('application/json') >= 0) {
222
+ localVarHeaderParams.Accept = 'application/json';
223
+ }
224
+ else {
225
+ localVarHeaderParams.Accept = produces.join(',');
226
+ }
227
+ let localVarFormParams = {};
228
+ Object.assign(localVarHeaderParams, options.headers);
229
+ let localVarUseFormData = false;
230
+ let localVarRequestOptions = {
231
+ method: 'GET',
232
+ qs: localVarQueryParameters,
233
+ headers: localVarHeaderParams,
234
+ uri: localVarPath,
235
+ useQuerystring: this._useQuerystring,
236
+ json: true,
237
+ };
238
+ let authenticationPromise = Promise.resolve();
239
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
240
+ let interceptorPromise = authenticationPromise;
241
+ for (const interceptor of this.interceptors) {
242
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
243
+ }
244
+ return interceptorPromise.then(() => {
245
+ if (Object.keys(localVarFormParams).length) {
246
+ if (localVarUseFormData) {
247
+ localVarRequestOptions.formData = localVarFormParams;
248
+ }
249
+ else {
250
+ localVarRequestOptions.form = localVarFormParams;
251
+ }
252
+ }
253
+ return new Promise((resolve, reject) => {
254
+ (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
255
+ if (error) {
256
+ console.error('API call error:', error);
257
+ reject(error);
258
+ }
259
+ else {
260
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
261
+ body = models_1.ObjectSerializer.deserialize(body, "SupportedValidatorProvidersResponse");
262
+ resolve({ body: body, status: response.statusCode });
263
+ }
264
+ else {
265
+ console.error('API response error:', response.statusCode);
266
+ resolve({ body: body, status: response.statusCode });
267
+ }
268
+ }
269
+ });
270
+ });
271
+ });
272
+ }
212
273
  /**
213
274
  *
214
275
  * @summary List all Lido staking contract sets
@@ -14,6 +14,7 @@ import { ApproveWstETH } from '../model/approveWstETH';
14
14
  import { BurnShares } from '../model/burnShares';
15
15
  import { BurnStETH } from '../model/burnStETH';
16
16
  import { BurnWstETH } from '../model/burnWstETH';
17
+ import { ChangeTier } from '../model/changeTier';
17
18
  import { CollectERC20FromVault } from '../model/collectERC20FromVault';
18
19
  import { ConsolidateValidators } from '../model/consolidateValidators';
19
20
  import { ConsolidateValidatorsResponse } from '../model/consolidateValidatorsResponse';
@@ -33,6 +34,7 @@ import { StakeEthResponse } from '../model/stakeEthResponse';
33
34
  import { StakingRequest } from '../model/stakingRequest';
34
35
  import { TriggerValidatorWithdrawals } from '../model/triggerValidatorWithdrawals';
35
36
  import { UnwrapWstETH } from '../model/unwrapWstETH';
37
+ import { UpdateShareLimit } from '../model/updateShareLimit';
36
38
  import { ValidateConsolidationRequestsResponse } from '../model/validateConsolidationRequestsResponse';
37
39
  import { WithdrawFromVault } from '../model/withdrawFromVault';
38
40
  import { WrapStETH } from '../model/wrapStETH';
@@ -63,6 +65,7 @@ export declare class LidoWriteApi {
63
65
  addInterceptor(interceptor: Interceptor): void;
64
66
  /**
65
67
  *
68
+ * @summary Encode approval to burn stETH
66
69
  * @param contractsId The unique identifier of the Lido staking contracts
67
70
  * @param approveStETH
68
71
  */
@@ -76,6 +79,7 @@ export declare class LidoWriteApi {
76
79
  }>;
77
80
  /**
78
81
  *
82
+ * @summary Encode approval to burn wstETH
79
83
  * @param contractsId The unique identifier of the Lido staking contracts
80
84
  * @param approveWstETH
81
85
  */
@@ -89,6 +93,7 @@ export declare class LidoWriteApi {
89
93
  }>;
90
94
  /**
91
95
  *
96
+ * @summary Approve wrapping stETH to wstETH
92
97
  * @param approveStETH
93
98
  */
94
99
  approveWrapStETH(approveStETH: ApproveStETH, options?: {
@@ -101,6 +106,7 @@ export declare class LidoWriteApi {
101
106
  }>;
102
107
  /**
103
108
  *
109
+ * @summary Encode burn shares transaction
104
110
  * @param contractsId The unique identifier of the Lido staking contracts
105
111
  * @param burnShares
106
112
  */
@@ -114,6 +120,7 @@ export declare class LidoWriteApi {
114
120
  }>;
115
121
  /**
116
122
  *
123
+ * @summary Encode burn stETH transaction
117
124
  * @param contractsId The unique identifier of the Lido staking contracts
118
125
  * @param burnStETH
119
126
  */
@@ -127,6 +134,7 @@ export declare class LidoWriteApi {
127
134
  }>;
128
135
  /**
129
136
  *
137
+ * @summary Encode burn wstETH transaction
130
138
  * @param contractsId The unique identifier of the Lido staking contracts
131
139
  * @param burnWstETH
132
140
  */
@@ -140,6 +148,21 @@ export declare class LidoWriteApi {
140
148
  }>;
141
149
  /**
142
150
  *
151
+ * @summary Encode change tier transaction
152
+ * @param contractsId The unique identifier of the Lido staking contracts
153
+ * @param changeTier
154
+ */
155
+ changeTier(contractsId: string, changeTier: ChangeTier, options?: {
156
+ headers: {
157
+ [name: string]: string;
158
+ };
159
+ }): Promise<{
160
+ body: PartialTransaction;
161
+ status: number;
162
+ }>;
163
+ /**
164
+ *
165
+ * @summary Collect ERC20 from vault
143
166
  * @param contractsId The unique identifier of the Lido staking contracts
144
167
  * @param collectERC20FromVault
145
168
  */
@@ -167,6 +190,7 @@ export declare class LidoWriteApi {
167
190
  }>;
168
191
  /**
169
192
  *
193
+ * @summary Fund vault with ETH
170
194
  * @param contractsId The unique identifier of the Lido staking contracts
171
195
  * @param fundVault
172
196
  */
@@ -179,11 +203,12 @@ export declare class LidoWriteApi {
179
203
  status: number;
180
204
  }>;
181
205
  /**
182
- *
183
- * @summary Update the lazy oracle report for a specific Lido staking contract set, returns the calldata needed to submit the updateVaultData transaction to the lazy oracle contract.
206
+ * Returns the calldata needed to submit the updateVaultData transaction to the lazy oracle contract for a specific Lido staking contract set.
207
+ * @summary Update lazy oracle report
184
208
  * @param contractsId The unique identifier of the Lido staking contracts
209
+ * @param simulateAddress Optional Ethereum address to simulate the transaction from. If provided, the transaction will be simulated and any revert errors will be returned.
185
210
  */
186
- getLazyOracleReportCallData(contractsId: string, options?: {
211
+ getLazyOracleReportCallData(contractsId: string, simulateAddress?: string, options?: {
187
212
  headers: {
188
213
  [name: string]: string;
189
214
  };
@@ -207,6 +232,7 @@ export declare class LidoWriteApi {
207
232
  }>;
208
233
  /**
209
234
  *
235
+ * @summary Grant vault role
210
236
  * @param contractsId The unique identifier of the Lido staking contracts
211
237
  * @param grantRole
212
238
  */
@@ -220,7 +246,7 @@ export declare class LidoWriteApi {
220
246
  }>;
221
247
  /**
222
248
  *
223
- * @summary List staking request IDs for a specific Lido staking contract set
249
+ * @summary List staking request IDs for a vault
224
250
  * @param contractsId The unique identifier of the Lido staking contracts
225
251
  * @param status
226
252
  */
@@ -234,6 +260,7 @@ export declare class LidoWriteApi {
234
260
  }>;
235
261
  /**
236
262
  *
263
+ * @summary Encode mint shares transaction
237
264
  * @param contractsId The unique identifier of the Lido staking contracts
238
265
  * @param mintShares
239
266
  */
@@ -247,6 +274,7 @@ export declare class LidoWriteApi {
247
274
  }>;
248
275
  /**
249
276
  *
277
+ * @summary Encode mint stETH transaction
250
278
  * @param contractsId The unique identifier of the Lido staking contracts
251
279
  * @param mintStETH
252
280
  */
@@ -260,6 +288,7 @@ export declare class LidoWriteApi {
260
288
  }>;
261
289
  /**
262
290
  *
291
+ * @summary Encode mint wstETH transaction
263
292
  * @param contractsId The unique identifier of the Lido staking contracts
264
293
  * @param mintWstETH
265
294
  */
@@ -273,6 +302,7 @@ export declare class LidoWriteApi {
273
302
  }>;
274
303
  /**
275
304
  *
305
+ * @summary Rebalance vault with ETH
276
306
  * @param contractsId The unique identifier of the Lido staking contracts
277
307
  * @param rebalanceVaultWithEther
278
308
  */
@@ -286,6 +316,7 @@ export declare class LidoWriteApi {
286
316
  }>;
287
317
  /**
288
318
  *
319
+ * @summary Rebalance vault with shares
289
320
  * @param contractsId The unique identifier of the Lido staking contracts
290
321
  * @param rebalanceVaultWithShares
291
322
  */
@@ -299,6 +330,7 @@ export declare class LidoWriteApi {
299
330
  }>;
300
331
  /**
301
332
  *
333
+ * @summary Recover ERC20 from vault
302
334
  * @param contractsId The unique identifier of the Lido staking contracts
303
335
  * @param recoverERC20
304
336
  */
@@ -312,6 +344,7 @@ export declare class LidoWriteApi {
312
344
  }>;
313
345
  /**
314
346
  *
347
+ * @summary Revoke vault role
315
348
  * @param contractsId The unique identifier of the Lido staking contracts
316
349
  * @param revokeRole
317
350
  */
@@ -324,8 +357,8 @@ export declare class LidoWriteApi {
324
357
  status: number;
325
358
  }>;
326
359
  /**
327
- *
328
- * @summary Stake ETH using a specific Lido staking contract set. Returns the call data needed to submit the unguaranteed deposit transaction to the dashboard contract.
360
+ * Returns the call data needed to submit the unguaranteed deposit transaction to the dashboard contract.
361
+ * @summary Stake ETH with a Lido staking vault
329
362
  * @param contractsId The unique identifier of the Lido staking contracts
330
363
  * @param stakeEthRequest
331
364
  */
@@ -339,6 +372,21 @@ export declare class LidoWriteApi {
339
372
  }>;
340
373
  /**
341
374
  *
375
+ * @summary Encode sync tier transaction
376
+ * @param contractsId The unique identifier of the Lido staking contracts
377
+ * @param simulateAddress Optional Ethereum address to simulate the transaction from. If provided, the transaction will be simulated and any revert errors will be returned.
378
+ */
379
+ syncTier(contractsId: string, simulateAddress?: string, options?: {
380
+ headers: {
381
+ [name: string]: string;
382
+ };
383
+ }): Promise<{
384
+ body: PartialTransaction;
385
+ status: number;
386
+ }>;
387
+ /**
388
+ *
389
+ * @summary Trigger validator withdrawals
342
390
  * @param contractsId The unique identifier of the Lido staking contracts
343
391
  * @param triggerValidatorWithdrawals
344
392
  */
@@ -352,6 +400,7 @@ export declare class LidoWriteApi {
352
400
  }>;
353
401
  /**
354
402
  *
403
+ * @summary Unwrap wstETH to stETH
355
404
  * @param unwrapWstETH
356
405
  */
357
406
  unwrapWstETH(unwrapWstETH: UnwrapWstETH, options?: {
@@ -364,7 +413,21 @@ export declare class LidoWriteApi {
364
413
  }>;
365
414
  /**
366
415
  *
367
- * @summary Validate consolidation requests and return validator balances and signing wallet information
416
+ * @summary Encode update share limit transaction
417
+ * @param contractsId The unique identifier of the Lido staking contracts
418
+ * @param updateShareLimit
419
+ */
420
+ updateShareLimit(contractsId: string, updateShareLimit: UpdateShareLimit, options?: {
421
+ headers: {
422
+ [name: string]: string;
423
+ };
424
+ }): Promise<{
425
+ body: PartialTransaction;
426
+ status: number;
427
+ }>;
428
+ /**
429
+ * Returns validator balances and signing wallet information for the given consolidation requests.
430
+ * @summary Validate consolidation requests
368
431
  * @param contractsId The unique identifier of the Lido staking contracts
369
432
  * @param consolidateValidators
370
433
  */
@@ -378,6 +441,7 @@ export declare class LidoWriteApi {
378
441
  }>;
379
442
  /**
380
443
  *
444
+ * @summary Withdraw from vault
381
445
  * @param contractsId The unique identifier of the Lido staking contracts
382
446
  * @param withdrawFromVault
383
447
  */
@@ -391,6 +455,7 @@ export declare class LidoWriteApi {
391
455
  }>;
392
456
  /**
393
457
  *
458
+ * @summary Wrap stETH to wstETH
394
459
  * @param wrapStETH
395
460
  */
396
461
  wrapStETH(wrapStETH: WrapStETH, options?: {