@dfns/sdk 0.8.13 → 0.8.17

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.
Files changed (17) hide show
  1. package/generated/allocations/types.d.ts +8 -8
  2. package/generated/auth/types.d.ts +2 -2
  3. package/generated/exchanges/types.d.ts +1 -1
  4. package/generated/feeSponsors/types.d.ts +6 -6
  5. package/generated/keys/types.d.ts +52 -52
  6. package/generated/networks/types.d.ts +2 -2
  7. package/generated/payouts/types.d.ts +8 -8
  8. package/generated/permissions/types.d.ts +2 -2
  9. package/generated/policies/types.d.ts +135 -135
  10. package/generated/staking/types.d.ts +290 -50
  11. package/generated/swaps/types.d.ts +10 -10
  12. package/generated/wallets/client.d.ts +2 -0
  13. package/generated/wallets/client.js +24 -0
  14. package/generated/wallets/delegatedClient.d.ts +4 -0
  15. package/generated/wallets/delegatedClient.js +54 -0
  16. package/generated/wallets/types.d.ts +892 -100
  17. package/package.json +6 -1
package/generated/staking/types.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export type CreateStakeBody = ({
2
2
  protocol: "Ethereum";
3
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
3
+ /** Id of the Dfns wallet making the deposit. */
4
4
  walletId: string;
5
5
  /** Staking Provider */
6
6
  provider: "Figment";
@@ -8,7 +8,7 @@ export type CreateStakeBody = ({
8
8
  amount: string;
9
9
  } | {
10
10
  protocol: "Iota";
11
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
11
+ /** Id of the Dfns wallet making the deposit. */
12
12
  walletId: string;
13
13
  validator: string;
14
14
  /** Transaction amount denominated in min units */
@@ -19,8 +19,21 @@ export type CreateStakeBody = ({
19
19
  };
20
20
  export type CreateStakeResponse = ({
21
21
  id: string;
22
+ /** The staking infrastructure provider used to manage the stake. */
22
23
  provider?: ("Figment") | undefined;
24
+ /** Wallet id. */
23
25
  walletId: string;
26
+ /** Status of the stake position.
27
+
28
+ | Status | Definition |
29
+ | --- | --- |
30
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
31
+ | `Active` | The stake is active and earning rewards. |
32
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
33
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
34
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
35
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
36
+ | `Failed` | The staking operation failed. | */
24
37
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
25
38
  /** The user who initiated the request. */
26
39
  requester: {
@@ -31,7 +44,7 @@ export type CreateStakeResponse = ({
31
44
  };
32
45
  requestBody: ({
33
46
  protocol: "Babylon";
34
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
47
+ /** Id of the Dfns wallet making the deposit. */
35
48
  walletId: string;
36
49
  /** Staking Provider */
37
50
  provider: "Figment";
@@ -40,7 +53,7 @@ export type CreateStakeResponse = ({
40
53
  duration: number;
41
54
  } | {
42
55
  protocol: "Ethereum";
43
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
56
+ /** Id of the Dfns wallet making the deposit. */
44
57
  walletId: string;
45
58
  /** Staking Provider */
46
59
  provider: "Figment";
@@ -48,7 +61,7 @@ export type CreateStakeResponse = ({
48
61
  amount: string;
49
62
  } | {
50
63
  protocol: "Iota";
51
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
64
+ /** Id of the Dfns wallet making the deposit. */
52
65
  walletId: string;
53
66
  validator: string;
54
67
  /** Transaction amount denominated in min units */
@@ -69,8 +82,21 @@ export type CreateStakeResponse = ({
69
82
  };
70
83
  } | {
71
84
  id: string;
85
+ /** The staking infrastructure provider used to manage the stake. */
72
86
  provider?: ("Figment") | undefined;
87
+ /** Wallet id. */
73
88
  walletId: string;
89
+ /** Status of the stake position.
90
+
91
+ | Status | Definition |
92
+ | --- | --- |
93
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
94
+ | `Active` | The stake is active and earning rewards. |
95
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
96
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
97
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
98
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
99
+ | `Failed` | The staking operation failed. | */
74
100
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
75
101
  /** The user who initiated the request. */
76
102
  requester: {
@@ -81,7 +107,7 @@ export type CreateStakeResponse = ({
81
107
  };
82
108
  requestBody: ({
83
109
  protocol: "Babylon";
84
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
110
+ /** Id of the Dfns wallet making the deposit. */
85
111
  walletId: string;
86
112
  /** Staking Provider */
87
113
  provider: "Figment";
@@ -90,7 +116,7 @@ export type CreateStakeResponse = ({
90
116
  duration: number;
91
117
  } | {
92
118
  protocol: "Ethereum";
93
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
119
+ /** Id of the Dfns wallet making the deposit. */
94
120
  walletId: string;
95
121
  /** Staking Provider */
96
122
  provider: "Figment";
@@ -98,7 +124,7 @@ export type CreateStakeResponse = ({
98
124
  amount: string;
99
125
  } | {
100
126
  protocol: "Iota";
101
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
127
+ /** Id of the Dfns wallet making the deposit. */
102
128
  walletId: string;
103
129
  validator: string;
104
130
  /** Transaction amount denominated in min units */
@@ -121,8 +147,21 @@ export type CreateStakeResponse = ({
121
147
  };
122
148
  } | {
123
149
  id: string;
150
+ /** The staking infrastructure provider used to manage the stake. */
124
151
  provider?: ("Figment") | undefined;
152
+ /** Wallet id. */
125
153
  walletId: string;
154
+ /** Status of the stake position.
155
+
156
+ | Status | Definition |
157
+ | --- | --- |
158
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
159
+ | `Active` | The stake is active and earning rewards. |
160
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
161
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
162
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
163
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
164
+ | `Failed` | The staking operation failed. | */
126
165
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
127
166
  /** The user who initiated the request. */
128
167
  requester: {
@@ -133,7 +172,7 @@ export type CreateStakeResponse = ({
133
172
  };
134
173
  requestBody: ({
135
174
  protocol: "Babylon";
136
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
175
+ /** Id of the Dfns wallet making the deposit. */
137
176
  walletId: string;
138
177
  /** Staking Provider */
139
178
  provider: "Figment";
@@ -142,7 +181,7 @@ export type CreateStakeResponse = ({
142
181
  duration: number;
143
182
  } | {
144
183
  protocol: "Ethereum";
145
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
184
+ /** Id of the Dfns wallet making the deposit. */
146
185
  walletId: string;
147
186
  /** Staking Provider */
148
187
  provider: "Figment";
@@ -150,7 +189,7 @@ export type CreateStakeResponse = ({
150
189
  amount: string;
151
190
  } | {
152
191
  protocol: "Iota";
153
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
192
+ /** Id of the Dfns wallet making the deposit. */
154
193
  walletId: string;
155
194
  validator: string;
156
195
  /** Transaction amount denominated in min units */
@@ -171,10 +210,30 @@ export type CreateStakeResponse = ({
171
210
  actions: {
172
211
  id: string;
173
212
  stakeId: string;
213
+ /** Status of the stake action.
214
+
215
+ | Status | Definition |
216
+ | --- | --- |
217
+ | `PendingPolicyApproval` | The action is pending approval due to a policy applied to the wallet. |
218
+ | `InProgress` | The action has been initiated and is being processed. |
219
+ | `Completed` | The action has been successfully completed. |
220
+ | `Failed` | The action has failed. Check failureReason for details. |
221
+ | `Rejected` | The action has been rejected by a policy approval action. | */
174
222
  status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
223
+ /** Deprecated. */
175
224
  transactionId?: string | undefined;
225
+ /** Deprecated. */
176
226
  signatureId?: string | undefined;
227
+ /** Deprecated. */
177
228
  transactionHash?: string | undefined;
229
+ /** The type of staking action being performed.
230
+
231
+ | Kind | Definition |
232
+ | --- | --- |
233
+ | `Stake` | Delegate funds to a validator to begin earning rewards. |
234
+ | `Unbond` | Initiate the unbonding process to release staked funds (subject to cooldown). |
235
+ | `Deposit` | Add additional funds to an existing stake position. |
236
+ | `Withdraw` | Withdraw unbonded funds from the stake position. | */
178
237
  kind: "Stake" | "Unbond" | "Deposit" | "Withdraw";
179
238
  /** The user who initiated the request. */
180
239
  requester: {
@@ -185,7 +244,7 @@ export type CreateStakeResponse = ({
185
244
  };
186
245
  requestBody: (({
187
246
  protocol: "Babylon";
188
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
247
+ /** Id of the Dfns wallet making the deposit. */
189
248
  walletId: string;
190
249
  /** Staking Provider */
191
250
  provider: "Figment";
@@ -194,7 +253,7 @@ export type CreateStakeResponse = ({
194
253
  duration: number;
195
254
  } | {
196
255
  protocol: "Ethereum";
197
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
256
+ /** Id of the Dfns wallet making the deposit. */
198
257
  walletId: string;
199
258
  /** Staking Provider */
200
259
  provider: "Figment";
@@ -202,7 +261,7 @@ export type CreateStakeResponse = ({
202
261
  amount: string;
203
262
  } | {
204
263
  protocol: "Iota";
205
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
264
+ /** Id of the Dfns wallet making the deposit. */
206
265
  walletId: string;
207
266
  validator: string;
208
267
  /** Transaction amount denominated in min units */
@@ -253,8 +312,21 @@ export type CreateStakeActionParams = {
253
312
  };
254
313
  export type CreateStakeActionResponse = ({
255
314
  id: string;
315
+ /** The staking infrastructure provider used to manage the stake. */
256
316
  provider?: ("Figment") | undefined;
317
+ /** Wallet id. */
257
318
  walletId: string;
319
+ /** Status of the stake position.
320
+
321
+ | Status | Definition |
322
+ | --- | --- |
323
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
324
+ | `Active` | The stake is active and earning rewards. |
325
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
326
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
327
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
328
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
329
+ | `Failed` | The staking operation failed. | */
258
330
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
259
331
  /** The user who initiated the request. */
260
332
  requester: {
@@ -265,7 +337,7 @@ export type CreateStakeActionResponse = ({
265
337
  };
266
338
  requestBody: ({
267
339
  protocol: "Babylon";
268
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
340
+ /** Id of the Dfns wallet making the deposit. */
269
341
  walletId: string;
270
342
  /** Staking Provider */
271
343
  provider: "Figment";
@@ -274,7 +346,7 @@ export type CreateStakeActionResponse = ({
274
346
  duration: number;
275
347
  } | {
276
348
  protocol: "Ethereum";
277
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
349
+ /** Id of the Dfns wallet making the deposit. */
278
350
  walletId: string;
279
351
  /** Staking Provider */
280
352
  provider: "Figment";
@@ -282,7 +354,7 @@ export type CreateStakeActionResponse = ({
282
354
  amount: string;
283
355
  } | {
284
356
  protocol: "Iota";
285
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
357
+ /** Id of the Dfns wallet making the deposit. */
286
358
  walletId: string;
287
359
  validator: string;
288
360
  /** Transaction amount denominated in min units */
@@ -303,8 +375,21 @@ export type CreateStakeActionResponse = ({
303
375
  };
304
376
  } | {
305
377
  id: string;
378
+ /** The staking infrastructure provider used to manage the stake. */
306
379
  provider?: ("Figment") | undefined;
380
+ /** Wallet id. */
307
381
  walletId: string;
382
+ /** Status of the stake position.
383
+
384
+ | Status | Definition |
385
+ | --- | --- |
386
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
387
+ | `Active` | The stake is active and earning rewards. |
388
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
389
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
390
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
391
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
392
+ | `Failed` | The staking operation failed. | */
308
393
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
309
394
  /** The user who initiated the request. */
310
395
  requester: {
@@ -315,7 +400,7 @@ export type CreateStakeActionResponse = ({
315
400
  };
316
401
  requestBody: ({
317
402
  protocol: "Babylon";
318
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
403
+ /** Id of the Dfns wallet making the deposit. */
319
404
  walletId: string;
320
405
  /** Staking Provider */
321
406
  provider: "Figment";
@@ -324,7 +409,7 @@ export type CreateStakeActionResponse = ({
324
409
  duration: number;
325
410
  } | {
326
411
  protocol: "Ethereum";
327
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
412
+ /** Id of the Dfns wallet making the deposit. */
328
413
  walletId: string;
329
414
  /** Staking Provider */
330
415
  provider: "Figment";
@@ -332,7 +417,7 @@ export type CreateStakeActionResponse = ({
332
417
  amount: string;
333
418
  } | {
334
419
  protocol: "Iota";
335
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
420
+ /** Id of the Dfns wallet making the deposit. */
336
421
  walletId: string;
337
422
  validator: string;
338
423
  /** Transaction amount denominated in min units */
@@ -355,8 +440,21 @@ export type CreateStakeActionResponse = ({
355
440
  };
356
441
  } | {
357
442
  id: string;
443
+ /** The staking infrastructure provider used to manage the stake. */
358
444
  provider?: ("Figment") | undefined;
445
+ /** Wallet id. */
359
446
  walletId: string;
447
+ /** Status of the stake position.
448
+
449
+ | Status | Definition |
450
+ | --- | --- |
451
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
452
+ | `Active` | The stake is active and earning rewards. |
453
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
454
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
455
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
456
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
457
+ | `Failed` | The staking operation failed. | */
360
458
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
361
459
  /** The user who initiated the request. */
362
460
  requester: {
@@ -367,7 +465,7 @@ export type CreateStakeActionResponse = ({
367
465
  };
368
466
  requestBody: ({
369
467
  protocol: "Babylon";
370
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
468
+ /** Id of the Dfns wallet making the deposit. */
371
469
  walletId: string;
372
470
  /** Staking Provider */
373
471
  provider: "Figment";
@@ -376,7 +474,7 @@ export type CreateStakeActionResponse = ({
376
474
  duration: number;
377
475
  } | {
378
476
  protocol: "Ethereum";
379
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
477
+ /** Id of the Dfns wallet making the deposit. */
380
478
  walletId: string;
381
479
  /** Staking Provider */
382
480
  provider: "Figment";
@@ -384,7 +482,7 @@ export type CreateStakeActionResponse = ({
384
482
  amount: string;
385
483
  } | {
386
484
  protocol: "Iota";
387
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
485
+ /** Id of the Dfns wallet making the deposit. */
388
486
  walletId: string;
389
487
  validator: string;
390
488
  /** Transaction amount denominated in min units */
@@ -405,10 +503,30 @@ export type CreateStakeActionResponse = ({
405
503
  actions: {
406
504
  id: string;
407
505
  stakeId: string;
506
+ /** Status of the stake action.
507
+
508
+ | Status | Definition |
509
+ | --- | --- |
510
+ | `PendingPolicyApproval` | The action is pending approval due to a policy applied to the wallet. |
511
+ | `InProgress` | The action has been initiated and is being processed. |
512
+ | `Completed` | The action has been successfully completed. |
513
+ | `Failed` | The action has failed. Check failureReason for details. |
514
+ | `Rejected` | The action has been rejected by a policy approval action. | */
408
515
  status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
516
+ /** Deprecated. */
409
517
  transactionId?: string | undefined;
518
+ /** Deprecated. */
410
519
  signatureId?: string | undefined;
520
+ /** Deprecated. */
411
521
  transactionHash?: string | undefined;
522
+ /** The type of staking action being performed.
523
+
524
+ | Kind | Definition |
525
+ | --- | --- |
526
+ | `Stake` | Delegate funds to a validator to begin earning rewards. |
527
+ | `Unbond` | Initiate the unbonding process to release staked funds (subject to cooldown). |
528
+ | `Deposit` | Add additional funds to an existing stake position. |
529
+ | `Withdraw` | Withdraw unbonded funds from the stake position. | */
412
530
  kind: "Stake" | "Unbond" | "Deposit" | "Withdraw";
413
531
  /** The user who initiated the request. */
414
532
  requester: {
@@ -419,7 +537,7 @@ export type CreateStakeActionResponse = ({
419
537
  };
420
538
  requestBody: (({
421
539
  protocol: "Babylon";
422
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
540
+ /** Id of the Dfns wallet making the deposit. */
423
541
  walletId: string;
424
542
  /** Staking Provider */
425
543
  provider: "Figment";
@@ -428,7 +546,7 @@ export type CreateStakeActionResponse = ({
428
546
  duration: number;
429
547
  } | {
430
548
  protocol: "Ethereum";
431
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
549
+ /** Id of the Dfns wallet making the deposit. */
432
550
  walletId: string;
433
551
  /** Staking Provider */
434
552
  provider: "Figment";
@@ -436,7 +554,7 @@ export type CreateStakeActionResponse = ({
436
554
  amount: string;
437
555
  } | {
438
556
  protocol: "Iota";
439
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
557
+ /** Id of the Dfns wallet making the deposit. */
440
558
  walletId: string;
441
559
  validator: string;
442
560
  /** Transaction amount denominated in min units */
@@ -486,8 +604,21 @@ export type GetStakesQuery = {
486
604
  };
487
605
  export type GetStakesResponse = ({
488
606
  id: string;
607
+ /** The staking infrastructure provider used to manage the stake. */
489
608
  provider?: ("Figment") | undefined;
609
+ /** Wallet id. */
490
610
  walletId: string;
611
+ /** Status of the stake position.
612
+
613
+ | Status | Definition |
614
+ | --- | --- |
615
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
616
+ | `Active` | The stake is active and earning rewards. |
617
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
618
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
619
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
620
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
621
+ | `Failed` | The staking operation failed. | */
491
622
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
492
623
  /** The user who initiated the request. */
493
624
  requester: {
@@ -498,7 +629,7 @@ export type GetStakesResponse = ({
498
629
  };
499
630
  requestBody: ({
500
631
  protocol: "Babylon";
501
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
632
+ /** Id of the Dfns wallet making the deposit. */
502
633
  walletId: string;
503
634
  /** Staking Provider */
504
635
  provider: "Figment";
@@ -507,7 +638,7 @@ export type GetStakesResponse = ({
507
638
  duration: number;
508
639
  } | {
509
640
  protocol: "Ethereum";
510
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
641
+ /** Id of the Dfns wallet making the deposit. */
511
642
  walletId: string;
512
643
  /** Staking Provider */
513
644
  provider: "Figment";
@@ -515,7 +646,7 @@ export type GetStakesResponse = ({
515
646
  amount: string;
516
647
  } | {
517
648
  protocol: "Iota";
518
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
649
+ /** Id of the Dfns wallet making the deposit. */
519
650
  walletId: string;
520
651
  validator: string;
521
652
  /** Transaction amount denominated in min units */
@@ -536,8 +667,21 @@ export type GetStakesResponse = ({
536
667
  };
537
668
  } | {
538
669
  id: string;
670
+ /** The staking infrastructure provider used to manage the stake. */
539
671
  provider?: ("Figment") | undefined;
672
+ /** Wallet id. */
540
673
  walletId: string;
674
+ /** Status of the stake position.
675
+
676
+ | Status | Definition |
677
+ | --- | --- |
678
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
679
+ | `Active` | The stake is active and earning rewards. |
680
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
681
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
682
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
683
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
684
+ | `Failed` | The staking operation failed. | */
541
685
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
542
686
  /** The user who initiated the request. */
543
687
  requester: {
@@ -548,7 +692,7 @@ export type GetStakesResponse = ({
548
692
  };
549
693
  requestBody: ({
550
694
  protocol: "Babylon";
551
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
695
+ /** Id of the Dfns wallet making the deposit. */
552
696
  walletId: string;
553
697
  /** Staking Provider */
554
698
  provider: "Figment";
@@ -557,7 +701,7 @@ export type GetStakesResponse = ({
557
701
  duration: number;
558
702
  } | {
559
703
  protocol: "Ethereum";
560
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
704
+ /** Id of the Dfns wallet making the deposit. */
561
705
  walletId: string;
562
706
  /** Staking Provider */
563
707
  provider: "Figment";
@@ -565,7 +709,7 @@ export type GetStakesResponse = ({
565
709
  amount: string;
566
710
  } | {
567
711
  protocol: "Iota";
568
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
712
+ /** Id of the Dfns wallet making the deposit. */
569
713
  walletId: string;
570
714
  validator: string;
571
715
  /** Transaction amount denominated in min units */
@@ -588,8 +732,21 @@ export type GetStakesResponse = ({
588
732
  };
589
733
  } | {
590
734
  id: string;
735
+ /** The staking infrastructure provider used to manage the stake. */
591
736
  provider?: ("Figment") | undefined;
737
+ /** Wallet id. */
592
738
  walletId: string;
739
+ /** Status of the stake position.
740
+
741
+ | Status | Definition |
742
+ | --- | --- |
743
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
744
+ | `Active` | The stake is active and earning rewards. |
745
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
746
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
747
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
748
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
749
+ | `Failed` | The staking operation failed. | */
593
750
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
594
751
  /** The user who initiated the request. */
595
752
  requester: {
@@ -600,7 +757,7 @@ export type GetStakesResponse = ({
600
757
  };
601
758
  requestBody: ({
602
759
  protocol: "Babylon";
603
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
760
+ /** Id of the Dfns wallet making the deposit. */
604
761
  walletId: string;
605
762
  /** Staking Provider */
606
763
  provider: "Figment";
@@ -609,7 +766,7 @@ export type GetStakesResponse = ({
609
766
  duration: number;
610
767
  } | {
611
768
  protocol: "Ethereum";
612
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
769
+ /** Id of the Dfns wallet making the deposit. */
613
770
  walletId: string;
614
771
  /** Staking Provider */
615
772
  provider: "Figment";
@@ -617,7 +774,7 @@ export type GetStakesResponse = ({
617
774
  amount: string;
618
775
  } | {
619
776
  protocol: "Iota";
620
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
777
+ /** Id of the Dfns wallet making the deposit. */
621
778
  walletId: string;
622
779
  validator: string;
623
780
  /** Transaction amount denominated in min units */
@@ -638,10 +795,30 @@ export type GetStakesResponse = ({
638
795
  actions: {
639
796
  id: string;
640
797
  stakeId: string;
798
+ /** Status of the stake action.
799
+
800
+ | Status | Definition |
801
+ | --- | --- |
802
+ | `PendingPolicyApproval` | The action is pending approval due to a policy applied to the wallet. |
803
+ | `InProgress` | The action has been initiated and is being processed. |
804
+ | `Completed` | The action has been successfully completed. |
805
+ | `Failed` | The action has failed. Check failureReason for details. |
806
+ | `Rejected` | The action has been rejected by a policy approval action. | */
641
807
  status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
808
+ /** Deprecated. */
642
809
  transactionId?: string | undefined;
810
+ /** Deprecated. */
643
811
  signatureId?: string | undefined;
812
+ /** Deprecated. */
644
813
  transactionHash?: string | undefined;
814
+ /** The type of staking action being performed.
815
+
816
+ | Kind | Definition |
817
+ | --- | --- |
818
+ | `Stake` | Delegate funds to a validator to begin earning rewards. |
819
+ | `Unbond` | Initiate the unbonding process to release staked funds (subject to cooldown). |
820
+ | `Deposit` | Add additional funds to an existing stake position. |
821
+ | `Withdraw` | Withdraw unbonded funds from the stake position. | */
645
822
  kind: "Stake" | "Unbond" | "Deposit" | "Withdraw";
646
823
  /** The user who initiated the request. */
647
824
  requester: {
@@ -652,7 +829,7 @@ export type GetStakesResponse = ({
652
829
  };
653
830
  requestBody: (({
654
831
  protocol: "Babylon";
655
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
832
+ /** Id of the Dfns wallet making the deposit. */
656
833
  walletId: string;
657
834
  /** Staking Provider */
658
835
  provider: "Figment";
@@ -661,7 +838,7 @@ export type GetStakesResponse = ({
661
838
  duration: number;
662
839
  } | {
663
840
  protocol: "Ethereum";
664
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
841
+ /** Id of the Dfns wallet making the deposit. */
665
842
  walletId: string;
666
843
  /** Staking Provider */
667
844
  provider: "Figment";
@@ -669,7 +846,7 @@ export type GetStakesResponse = ({
669
846
  amount: string;
670
847
  } | {
671
848
  protocol: "Iota";
672
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
849
+ /** Id of the Dfns wallet making the deposit. */
673
850
  walletId: string;
674
851
  validator: string;
675
852
  /** Transaction amount denominated in min units */
@@ -710,13 +887,34 @@ export type ListStakeActionsQuery = {
710
887
  paginationToken?: string | undefined;
711
888
  };
712
889
  export type ListStakeActionsResponse = {
890
+ /** Current page items. */
713
891
  items: {
714
892
  id: string;
715
893
  stakeId: string;
894
+ /** Status of the stake action.
895
+
896
+ | Status | Definition |
897
+ | --- | --- |
898
+ | `PendingPolicyApproval` | The action is pending approval due to a policy applied to the wallet. |
899
+ | `InProgress` | The action has been initiated and is being processed. |
900
+ | `Completed` | The action has been successfully completed. |
901
+ | `Failed` | The action has failed. Check failureReason for details. |
902
+ | `Rejected` | The action has been rejected by a policy approval action. | */
716
903
  status: "PendingPolicyApproval" | "InProgress" | "Completed" | "Failed" | "Rejected";
904
+ /** Deprecated. */
717
905
  transactionId?: string | undefined;
906
+ /** Deprecated. */
718
907
  signatureId?: string | undefined;
908
+ /** Deprecated. */
719
909
  transactionHash?: string | undefined;
910
+ /** The type of staking action being performed.
911
+
912
+ | Kind | Definition |
913
+ | --- | --- |
914
+ | `Stake` | Delegate funds to a validator to begin earning rewards. |
915
+ | `Unbond` | Initiate the unbonding process to release staked funds (subject to cooldown). |
916
+ | `Deposit` | Add additional funds to an existing stake position. |
917
+ | `Withdraw` | Withdraw unbonded funds from the stake position. | */
720
918
  kind: "Stake" | "Unbond" | "Deposit" | "Withdraw";
721
919
  /** The user who initiated the request. */
722
920
  requester: {
@@ -727,7 +925,7 @@ export type ListStakeActionsResponse = {
727
925
  };
728
926
  requestBody: (({
729
927
  protocol: "Babylon";
730
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
928
+ /** Id of the Dfns wallet making the deposit. */
731
929
  walletId: string;
732
930
  /** Staking Provider */
733
931
  provider: "Figment";
@@ -736,7 +934,7 @@ export type ListStakeActionsResponse = {
736
934
  duration: number;
737
935
  } | {
738
936
  protocol: "Ethereum";
739
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
937
+ /** Id of the Dfns wallet making the deposit. */
740
938
  walletId: string;
741
939
  /** Staking Provider */
742
940
  provider: "Figment";
@@ -744,7 +942,7 @@ export type ListStakeActionsResponse = {
744
942
  amount: string;
745
943
  } | {
746
944
  protocol: "Iota";
747
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
945
+ /** Id of the Dfns wallet making the deposit. */
748
946
  walletId: string;
749
947
  validator: string;
750
948
  /** Transaction amount denominated in min units */
@@ -771,6 +969,7 @@ export type ListStakeActionsResponse = {
771
969
  failureReason?: string | undefined;
772
970
  dateCreated: string;
773
971
  }[];
972
+ /** token to use as `paginationToken` to request the next page. */
774
973
  nextPageToken?: string | undefined;
775
974
  };
776
975
  export type ListStakeActionsRequest = ListStakeActionsParams & {
@@ -783,10 +982,24 @@ export type ListStakesQuery = {
783
982
  paginationToken?: string | undefined;
784
983
  };
785
984
  export type ListStakesResponse = {
985
+ /** Current page items. */
786
986
  items: ({
787
987
  id: string;
988
+ /** The staking infrastructure provider used to manage the stake. */
788
989
  provider?: ("Figment") | undefined;
990
+ /** Wallet id. */
789
991
  walletId: string;
992
+ /** Status of the stake position.
993
+
994
+ | Status | Definition |
995
+ | --- | --- |
996
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
997
+ | `Active` | The stake is active and earning rewards. |
998
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
999
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
1000
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
1001
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
1002
+ | `Failed` | The staking operation failed. | */
790
1003
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
791
1004
  /** The user who initiated the request. */
792
1005
  requester: {
@@ -797,7 +1010,7 @@ export type ListStakesResponse = {
797
1010
  };
798
1011
  requestBody: ({
799
1012
  protocol: "Babylon";
800
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1013
+ /** Id of the Dfns wallet making the deposit. */
801
1014
  walletId: string;
802
1015
  /** Staking Provider */
803
1016
  provider: "Figment";
@@ -806,7 +1019,7 @@ export type ListStakesResponse = {
806
1019
  duration: number;
807
1020
  } | {
808
1021
  protocol: "Ethereum";
809
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1022
+ /** Id of the Dfns wallet making the deposit. */
810
1023
  walletId: string;
811
1024
  /** Staking Provider */
812
1025
  provider: "Figment";
@@ -814,7 +1027,7 @@ export type ListStakesResponse = {
814
1027
  amount: string;
815
1028
  } | {
816
1029
  protocol: "Iota";
817
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1030
+ /** Id of the Dfns wallet making the deposit. */
818
1031
  walletId: string;
819
1032
  validator: string;
820
1033
  /** Transaction amount denominated in min units */
@@ -835,8 +1048,21 @@ export type ListStakesResponse = {
835
1048
  };
836
1049
  } | {
837
1050
  id: string;
1051
+ /** The staking infrastructure provider used to manage the stake. */
838
1052
  provider?: ("Figment") | undefined;
1053
+ /** Wallet id. */
839
1054
  walletId: string;
1055
+ /** Status of the stake position.
1056
+
1057
+ | Status | Definition |
1058
+ | --- | --- |
1059
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
1060
+ | `Active` | The stake is active and earning rewards. |
1061
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
1062
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
1063
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
1064
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
1065
+ | `Failed` | The staking operation failed. | */
840
1066
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
841
1067
  /** The user who initiated the request. */
842
1068
  requester: {
@@ -847,7 +1073,7 @@ export type ListStakesResponse = {
847
1073
  };
848
1074
  requestBody: ({
849
1075
  protocol: "Babylon";
850
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1076
+ /** Id of the Dfns wallet making the deposit. */
851
1077
  walletId: string;
852
1078
  /** Staking Provider */
853
1079
  provider: "Figment";
@@ -856,7 +1082,7 @@ export type ListStakesResponse = {
856
1082
  duration: number;
857
1083
  } | {
858
1084
  protocol: "Ethereum";
859
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1085
+ /** Id of the Dfns wallet making the deposit. */
860
1086
  walletId: string;
861
1087
  /** Staking Provider */
862
1088
  provider: "Figment";
@@ -864,7 +1090,7 @@ export type ListStakesResponse = {
864
1090
  amount: string;
865
1091
  } | {
866
1092
  protocol: "Iota";
867
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1093
+ /** Id of the Dfns wallet making the deposit. */
868
1094
  walletId: string;
869
1095
  validator: string;
870
1096
  /** Transaction amount denominated in min units */
@@ -887,8 +1113,21 @@ export type ListStakesResponse = {
887
1113
  };
888
1114
  } | {
889
1115
  id: string;
1116
+ /** The staking infrastructure provider used to manage the stake. */
890
1117
  provider?: ("Figment") | undefined;
1118
+ /** Wallet id. */
891
1119
  walletId: string;
1120
+ /** Status of the stake position.
1121
+
1122
+ | Status | Definition |
1123
+ | --- | --- |
1124
+ | `Staking` | The stake is being created and funds are being delegated to the validator. |
1125
+ | `Active` | The stake is active and earning rewards. |
1126
+ | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
1127
+ | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
1128
+ | `Withdrawing` | The staked funds are in the process of being withdrawn. |
1129
+ | `Withdrawn` | The staked funds have been fully withdrawn. |
1130
+ | `Failed` | The staking operation failed. | */
892
1131
  status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
893
1132
  /** The user who initiated the request. */
894
1133
  requester: {
@@ -899,7 +1138,7 @@ export type ListStakesResponse = {
899
1138
  };
900
1139
  requestBody: ({
901
1140
  protocol: "Babylon";
902
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1141
+ /** Id of the Dfns wallet making the deposit. */
903
1142
  walletId: string;
904
1143
  /** Staking Provider */
905
1144
  provider: "Figment";
@@ -908,7 +1147,7 @@ export type ListStakesResponse = {
908
1147
  duration: number;
909
1148
  } | {
910
1149
  protocol: "Ethereum";
911
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1150
+ /** Id of the Dfns wallet making the deposit. */
912
1151
  walletId: string;
913
1152
  /** Staking Provider */
914
1153
  provider: "Figment";
@@ -916,7 +1155,7 @@ export type ListStakesResponse = {
916
1155
  amount: string;
917
1156
  } | {
918
1157
  protocol: "Iota";
919
- /** Id of the Dfns wallet making the deposit (`wa-...`). */
1158
+ /** Id of the Dfns wallet making the deposit. */
920
1159
  walletId: string;
921
1160
  validator: string;
922
1161
  /** Transaction amount denominated in min units */
@@ -934,6 +1173,7 @@ export type ListStakesResponse = {
934
1173
  };
935
1174
  } | null;
936
1175
  })[];
1176
+ /** token to use as `paginationToken` to request the next page. */
937
1177
  nextPageToken?: string | undefined;
938
1178
  };
939
1179
  export type ListStakesRequest = {