@dfns/sdk 0.7.0 → 0.7.1-rc.1

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.
@@ -4,6 +4,19 @@ export type CreateDepositBody = {
4
4
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
5
5
  createDestinationAccount?: boolean | undefined;
6
6
  externalId?: string | undefined;
7
+ travelRule?: ({
8
+ kind: "Notabene";
9
+ beneficiaryVASPdid: string;
10
+ beneficiaryProof?: {
11
+ [x: string]: any;
12
+ } | undefined;
13
+ originator: {
14
+ [x: string]: any;
15
+ };
16
+ beneficiary: {
17
+ [x: string]: any;
18
+ };
19
+ }) | undefined;
7
20
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
8
21
  feeSponsorId?: string | undefined;
9
22
  walletId: string;
@@ -14,6 +27,19 @@ export type CreateDepositBody = {
14
27
  amount: string;
15
28
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
16
29
  externalId?: string | undefined;
30
+ travelRule?: ({
31
+ kind: "Notabene";
32
+ beneficiaryVASPdid: string;
33
+ beneficiaryProof?: {
34
+ [x: string]: any;
35
+ } | undefined;
36
+ originator: {
37
+ [x: string]: any;
38
+ };
39
+ beneficiary: {
40
+ [x: string]: any;
41
+ };
42
+ }) | undefined;
17
43
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
18
44
  feeSponsorId?: string | undefined;
19
45
  walletId: string;
@@ -23,6 +49,19 @@ export type CreateDepositBody = {
23
49
  tokenId: string;
24
50
  amount: string;
25
51
  externalId?: string | undefined;
52
+ travelRule?: ({
53
+ kind: "Notabene";
54
+ beneficiaryVASPdid: string;
55
+ beneficiaryProof?: {
56
+ [x: string]: any;
57
+ } | undefined;
58
+ originator: {
59
+ [x: string]: any;
60
+ };
61
+ beneficiary: {
62
+ [x: string]: any;
63
+ };
64
+ }) | undefined;
26
65
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
27
66
  feeSponsorId?: string | undefined;
28
67
  walletId: string;
@@ -32,6 +71,19 @@ export type CreateDepositBody = {
32
71
  contract: string;
33
72
  amount: string;
34
73
  externalId?: string | undefined;
74
+ travelRule?: ({
75
+ kind: "Notabene";
76
+ beneficiaryVASPdid: string;
77
+ beneficiaryProof?: {
78
+ [x: string]: any;
79
+ } | undefined;
80
+ originator: {
81
+ [x: string]: any;
82
+ };
83
+ beneficiary: {
84
+ [x: string]: any;
85
+ };
86
+ }) | undefined;
35
87
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
36
88
  feeSponsorId?: string | undefined;
37
89
  walletId: string;
@@ -41,6 +93,19 @@ export type CreateDepositBody = {
41
93
  assetId: string;
42
94
  amount: string;
43
95
  externalId?: string | undefined;
96
+ travelRule?: ({
97
+ kind: "Notabene";
98
+ beneficiaryVASPdid: string;
99
+ beneficiaryProof?: {
100
+ [x: string]: any;
101
+ } | undefined;
102
+ originator: {
103
+ [x: string]: any;
104
+ };
105
+ beneficiary: {
106
+ [x: string]: any;
107
+ };
108
+ }) | undefined;
44
109
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
45
110
  feeSponsorId?: string | undefined;
46
111
  walletId: string;
@@ -51,6 +116,19 @@ export type CreateDepositBody = {
51
116
  assetCode: string;
52
117
  amount: string;
53
118
  externalId?: string | undefined;
119
+ travelRule?: ({
120
+ kind: "Notabene";
121
+ beneficiaryVASPdid: string;
122
+ beneficiaryProof?: {
123
+ [x: string]: any;
124
+ } | undefined;
125
+ originator: {
126
+ [x: string]: any;
127
+ };
128
+ beneficiary: {
129
+ [x: string]: any;
130
+ };
131
+ }) | undefined;
54
132
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
55
133
  feeSponsorId?: string | undefined;
56
134
  walletId: string;
@@ -61,6 +139,19 @@ export type CreateDepositBody = {
61
139
  mint: string;
62
140
  createDestinationAccount?: boolean | undefined;
63
141
  externalId?: string | undefined;
142
+ travelRule?: ({
143
+ kind: "Notabene";
144
+ beneficiaryVASPdid: string;
145
+ beneficiaryProof?: {
146
+ [x: string]: any;
147
+ } | undefined;
148
+ originator: {
149
+ [x: string]: any;
150
+ };
151
+ beneficiary: {
152
+ [x: string]: any;
153
+ };
154
+ }) | undefined;
64
155
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
65
156
  feeSponsorId?: string | undefined;
66
157
  walletId: string;
@@ -70,6 +161,19 @@ export type CreateDepositBody = {
70
161
  master: string;
71
162
  amount: string;
72
163
  externalId?: string | undefined;
164
+ travelRule?: ({
165
+ kind: "Notabene";
166
+ beneficiaryVASPdid: string;
167
+ beneficiaryProof?: {
168
+ [x: string]: any;
169
+ } | undefined;
170
+ originator: {
171
+ [x: string]: any;
172
+ };
173
+ beneficiary: {
174
+ [x: string]: any;
175
+ };
176
+ }) | undefined;
73
177
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
74
178
  feeSponsorId?: string | undefined;
75
179
  walletId: string;
@@ -97,6 +201,19 @@ export type CreateDepositResponse = {
97
201
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
98
202
  createDestinationAccount?: boolean | undefined;
99
203
  externalId?: string | undefined;
204
+ travelRule?: ({
205
+ kind: "Notabene";
206
+ beneficiaryVASPdid: string;
207
+ beneficiaryProof?: {
208
+ [x: string]: any;
209
+ } | undefined;
210
+ originator: {
211
+ [x: string]: any;
212
+ };
213
+ beneficiary: {
214
+ [x: string]: any;
215
+ };
216
+ }) | undefined;
100
217
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
101
218
  feeSponsorId?: string | undefined;
102
219
  walletId: string;
@@ -107,6 +224,19 @@ export type CreateDepositResponse = {
107
224
  amount: string;
108
225
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
109
226
  externalId?: string | undefined;
227
+ travelRule?: ({
228
+ kind: "Notabene";
229
+ beneficiaryVASPdid: string;
230
+ beneficiaryProof?: {
231
+ [x: string]: any;
232
+ } | undefined;
233
+ originator: {
234
+ [x: string]: any;
235
+ };
236
+ beneficiary: {
237
+ [x: string]: any;
238
+ };
239
+ }) | undefined;
110
240
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
111
241
  feeSponsorId?: string | undefined;
112
242
  walletId: string;
@@ -116,6 +246,19 @@ export type CreateDepositResponse = {
116
246
  tokenId: string;
117
247
  amount: string;
118
248
  externalId?: string | undefined;
249
+ travelRule?: ({
250
+ kind: "Notabene";
251
+ beneficiaryVASPdid: string;
252
+ beneficiaryProof?: {
253
+ [x: string]: any;
254
+ } | undefined;
255
+ originator: {
256
+ [x: string]: any;
257
+ };
258
+ beneficiary: {
259
+ [x: string]: any;
260
+ };
261
+ }) | undefined;
119
262
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
120
263
  feeSponsorId?: string | undefined;
121
264
  walletId: string;
@@ -125,6 +268,19 @@ export type CreateDepositResponse = {
125
268
  contract: string;
126
269
  amount: string;
127
270
  externalId?: string | undefined;
271
+ travelRule?: ({
272
+ kind: "Notabene";
273
+ beneficiaryVASPdid: string;
274
+ beneficiaryProof?: {
275
+ [x: string]: any;
276
+ } | undefined;
277
+ originator: {
278
+ [x: string]: any;
279
+ };
280
+ beneficiary: {
281
+ [x: string]: any;
282
+ };
283
+ }) | undefined;
128
284
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
129
285
  feeSponsorId?: string | undefined;
130
286
  walletId: string;
@@ -134,6 +290,19 @@ export type CreateDepositResponse = {
134
290
  assetId: string;
135
291
  amount: string;
136
292
  externalId?: string | undefined;
293
+ travelRule?: ({
294
+ kind: "Notabene";
295
+ beneficiaryVASPdid: string;
296
+ beneficiaryProof?: {
297
+ [x: string]: any;
298
+ } | undefined;
299
+ originator: {
300
+ [x: string]: any;
301
+ };
302
+ beneficiary: {
303
+ [x: string]: any;
304
+ };
305
+ }) | undefined;
137
306
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
138
307
  feeSponsorId?: string | undefined;
139
308
  walletId: string;
@@ -144,6 +313,19 @@ export type CreateDepositResponse = {
144
313
  assetCode: string;
145
314
  amount: string;
146
315
  externalId?: string | undefined;
316
+ travelRule?: ({
317
+ kind: "Notabene";
318
+ beneficiaryVASPdid: string;
319
+ beneficiaryProof?: {
320
+ [x: string]: any;
321
+ } | undefined;
322
+ originator: {
323
+ [x: string]: any;
324
+ };
325
+ beneficiary: {
326
+ [x: string]: any;
327
+ };
328
+ }) | undefined;
147
329
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
148
330
  feeSponsorId?: string | undefined;
149
331
  walletId: string;
@@ -154,6 +336,19 @@ export type CreateDepositResponse = {
154
336
  mint: string;
155
337
  createDestinationAccount?: boolean | undefined;
156
338
  externalId?: string | undefined;
339
+ travelRule?: ({
340
+ kind: "Notabene";
341
+ beneficiaryVASPdid: string;
342
+ beneficiaryProof?: {
343
+ [x: string]: any;
344
+ } | undefined;
345
+ originator: {
346
+ [x: string]: any;
347
+ };
348
+ beneficiary: {
349
+ [x: string]: any;
350
+ };
351
+ }) | undefined;
157
352
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
158
353
  feeSponsorId?: string | undefined;
159
354
  walletId: string;
@@ -163,6 +358,19 @@ export type CreateDepositResponse = {
163
358
  master: string;
164
359
  amount: string;
165
360
  externalId?: string | undefined;
361
+ travelRule?: ({
362
+ kind: "Notabene";
363
+ beneficiaryVASPdid: string;
364
+ beneficiaryProof?: {
365
+ [x: string]: any;
366
+ } | undefined;
367
+ originator: {
368
+ [x: string]: any;
369
+ };
370
+ beneficiary: {
371
+ [x: string]: any;
372
+ };
373
+ }) | undefined;
166
374
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
167
375
  feeSponsorId?: string | undefined;
168
376
  walletId: string;
@@ -204,6 +412,19 @@ export type CreateWithdrawalBody = {
204
412
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
205
413
  createDestinationAccount?: boolean | undefined;
206
414
  externalId?: string | undefined;
415
+ travelRule?: ({
416
+ kind: "Notabene";
417
+ beneficiaryVASPdid: string;
418
+ beneficiaryProof?: {
419
+ [x: string]: any;
420
+ } | undefined;
421
+ originator: {
422
+ [x: string]: any;
423
+ };
424
+ beneficiary: {
425
+ [x: string]: any;
426
+ };
427
+ }) | undefined;
207
428
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
208
429
  feeSponsorId?: string | undefined;
209
430
  walletId: string;
@@ -214,6 +435,19 @@ export type CreateWithdrawalBody = {
214
435
  amount: string;
215
436
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
216
437
  externalId?: string | undefined;
438
+ travelRule?: ({
439
+ kind: "Notabene";
440
+ beneficiaryVASPdid: string;
441
+ beneficiaryProof?: {
442
+ [x: string]: any;
443
+ } | undefined;
444
+ originator: {
445
+ [x: string]: any;
446
+ };
447
+ beneficiary: {
448
+ [x: string]: any;
449
+ };
450
+ }) | undefined;
217
451
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
218
452
  feeSponsorId?: string | undefined;
219
453
  walletId: string;
@@ -223,6 +457,19 @@ export type CreateWithdrawalBody = {
223
457
  tokenId: string;
224
458
  amount: string;
225
459
  externalId?: string | undefined;
460
+ travelRule?: ({
461
+ kind: "Notabene";
462
+ beneficiaryVASPdid: string;
463
+ beneficiaryProof?: {
464
+ [x: string]: any;
465
+ } | undefined;
466
+ originator: {
467
+ [x: string]: any;
468
+ };
469
+ beneficiary: {
470
+ [x: string]: any;
471
+ };
472
+ }) | undefined;
226
473
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
227
474
  feeSponsorId?: string | undefined;
228
475
  walletId: string;
@@ -232,6 +479,19 @@ export type CreateWithdrawalBody = {
232
479
  contract: string;
233
480
  amount: string;
234
481
  externalId?: string | undefined;
482
+ travelRule?: ({
483
+ kind: "Notabene";
484
+ beneficiaryVASPdid: string;
485
+ beneficiaryProof?: {
486
+ [x: string]: any;
487
+ } | undefined;
488
+ originator: {
489
+ [x: string]: any;
490
+ };
491
+ beneficiary: {
492
+ [x: string]: any;
493
+ };
494
+ }) | undefined;
235
495
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
236
496
  feeSponsorId?: string | undefined;
237
497
  walletId: string;
@@ -241,6 +501,19 @@ export type CreateWithdrawalBody = {
241
501
  assetId: string;
242
502
  amount: string;
243
503
  externalId?: string | undefined;
504
+ travelRule?: ({
505
+ kind: "Notabene";
506
+ beneficiaryVASPdid: string;
507
+ beneficiaryProof?: {
508
+ [x: string]: any;
509
+ } | undefined;
510
+ originator: {
511
+ [x: string]: any;
512
+ };
513
+ beneficiary: {
514
+ [x: string]: any;
515
+ };
516
+ }) | undefined;
244
517
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
245
518
  feeSponsorId?: string | undefined;
246
519
  walletId: string;
@@ -251,6 +524,19 @@ export type CreateWithdrawalBody = {
251
524
  assetCode: string;
252
525
  amount: string;
253
526
  externalId?: string | undefined;
527
+ travelRule?: ({
528
+ kind: "Notabene";
529
+ beneficiaryVASPdid: string;
530
+ beneficiaryProof?: {
531
+ [x: string]: any;
532
+ } | undefined;
533
+ originator: {
534
+ [x: string]: any;
535
+ };
536
+ beneficiary: {
537
+ [x: string]: any;
538
+ };
539
+ }) | undefined;
254
540
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
255
541
  feeSponsorId?: string | undefined;
256
542
  walletId: string;
@@ -261,6 +547,19 @@ export type CreateWithdrawalBody = {
261
547
  mint: string;
262
548
  createDestinationAccount?: boolean | undefined;
263
549
  externalId?: string | undefined;
550
+ travelRule?: ({
551
+ kind: "Notabene";
552
+ beneficiaryVASPdid: string;
553
+ beneficiaryProof?: {
554
+ [x: string]: any;
555
+ } | undefined;
556
+ originator: {
557
+ [x: string]: any;
558
+ };
559
+ beneficiary: {
560
+ [x: string]: any;
561
+ };
562
+ }) | undefined;
264
563
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
265
564
  feeSponsorId?: string | undefined;
266
565
  walletId: string;
@@ -270,6 +569,19 @@ export type CreateWithdrawalBody = {
270
569
  master: string;
271
570
  amount: string;
272
571
  externalId?: string | undefined;
572
+ travelRule?: ({
573
+ kind: "Notabene";
574
+ beneficiaryVASPdid: string;
575
+ beneficiaryProof?: {
576
+ [x: string]: any;
577
+ } | undefined;
578
+ originator: {
579
+ [x: string]: any;
580
+ };
581
+ beneficiary: {
582
+ [x: string]: any;
583
+ };
584
+ }) | undefined;
273
585
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
274
586
  feeSponsorId?: string | undefined;
275
587
  walletId: string;
@@ -297,6 +609,19 @@ export type CreateWithdrawalResponse = {
297
609
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
298
610
  createDestinationAccount?: boolean | undefined;
299
611
  externalId?: string | undefined;
612
+ travelRule?: ({
613
+ kind: "Notabene";
614
+ beneficiaryVASPdid: string;
615
+ beneficiaryProof?: {
616
+ [x: string]: any;
617
+ } | undefined;
618
+ originator: {
619
+ [x: string]: any;
620
+ };
621
+ beneficiary: {
622
+ [x: string]: any;
623
+ };
624
+ }) | undefined;
300
625
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
301
626
  feeSponsorId?: string | undefined;
302
627
  walletId: string;
@@ -307,6 +632,19 @@ export type CreateWithdrawalResponse = {
307
632
  amount: string;
308
633
  priority?: ("Slow" | "Standard" | "Fast") | undefined;
309
634
  externalId?: string | undefined;
635
+ travelRule?: ({
636
+ kind: "Notabene";
637
+ beneficiaryVASPdid: string;
638
+ beneficiaryProof?: {
639
+ [x: string]: any;
640
+ } | undefined;
641
+ originator: {
642
+ [x: string]: any;
643
+ };
644
+ beneficiary: {
645
+ [x: string]: any;
646
+ };
647
+ }) | undefined;
310
648
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
311
649
  feeSponsorId?: string | undefined;
312
650
  walletId: string;
@@ -316,6 +654,19 @@ export type CreateWithdrawalResponse = {
316
654
  tokenId: string;
317
655
  amount: string;
318
656
  externalId?: string | undefined;
657
+ travelRule?: ({
658
+ kind: "Notabene";
659
+ beneficiaryVASPdid: string;
660
+ beneficiaryProof?: {
661
+ [x: string]: any;
662
+ } | undefined;
663
+ originator: {
664
+ [x: string]: any;
665
+ };
666
+ beneficiary: {
667
+ [x: string]: any;
668
+ };
669
+ }) | undefined;
319
670
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
320
671
  feeSponsorId?: string | undefined;
321
672
  walletId: string;
@@ -325,6 +676,19 @@ export type CreateWithdrawalResponse = {
325
676
  contract: string;
326
677
  amount: string;
327
678
  externalId?: string | undefined;
679
+ travelRule?: ({
680
+ kind: "Notabene";
681
+ beneficiaryVASPdid: string;
682
+ beneficiaryProof?: {
683
+ [x: string]: any;
684
+ } | undefined;
685
+ originator: {
686
+ [x: string]: any;
687
+ };
688
+ beneficiary: {
689
+ [x: string]: any;
690
+ };
691
+ }) | undefined;
328
692
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
329
693
  feeSponsorId?: string | undefined;
330
694
  walletId: string;
@@ -334,6 +698,19 @@ export type CreateWithdrawalResponse = {
334
698
  assetId: string;
335
699
  amount: string;
336
700
  externalId?: string | undefined;
701
+ travelRule?: ({
702
+ kind: "Notabene";
703
+ beneficiaryVASPdid: string;
704
+ beneficiaryProof?: {
705
+ [x: string]: any;
706
+ } | undefined;
707
+ originator: {
708
+ [x: string]: any;
709
+ };
710
+ beneficiary: {
711
+ [x: string]: any;
712
+ };
713
+ }) | undefined;
337
714
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
338
715
  feeSponsorId?: string | undefined;
339
716
  walletId: string;
@@ -344,6 +721,19 @@ export type CreateWithdrawalResponse = {
344
721
  assetCode: string;
345
722
  amount: string;
346
723
  externalId?: string | undefined;
724
+ travelRule?: ({
725
+ kind: "Notabene";
726
+ beneficiaryVASPdid: string;
727
+ beneficiaryProof?: {
728
+ [x: string]: any;
729
+ } | undefined;
730
+ originator: {
731
+ [x: string]: any;
732
+ };
733
+ beneficiary: {
734
+ [x: string]: any;
735
+ };
736
+ }) | undefined;
347
737
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
348
738
  feeSponsorId?: string | undefined;
349
739
  walletId: string;
@@ -354,6 +744,19 @@ export type CreateWithdrawalResponse = {
354
744
  mint: string;
355
745
  createDestinationAccount?: boolean | undefined;
356
746
  externalId?: string | undefined;
747
+ travelRule?: ({
748
+ kind: "Notabene";
749
+ beneficiaryVASPdid: string;
750
+ beneficiaryProof?: {
751
+ [x: string]: any;
752
+ } | undefined;
753
+ originator: {
754
+ [x: string]: any;
755
+ };
756
+ beneficiary: {
757
+ [x: string]: any;
758
+ };
759
+ }) | undefined;
357
760
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
358
761
  feeSponsorId?: string | undefined;
359
762
  walletId: string;
@@ -363,6 +766,19 @@ export type CreateWithdrawalResponse = {
363
766
  master: string;
364
767
  amount: string;
365
768
  externalId?: string | undefined;
769
+ travelRule?: ({
770
+ kind: "Notabene";
771
+ beneficiaryVASPdid: string;
772
+ beneficiaryProof?: {
773
+ [x: string]: any;
774
+ } | undefined;
775
+ originator: {
776
+ [x: string]: any;
777
+ };
778
+ beneficiary: {
779
+ [x: string]: any;
780
+ };
781
+ }) | undefined;
366
782
  /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
367
783
  feeSponsorId?: string | undefined;
368
784
  walletId: string;