@bsv/sdk 1.2.12 → 1.2.14

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 (23) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/transaction/MerklePath.js +18 -1
  3. package/dist/cjs/src/transaction/MerklePath.js.map +1 -1
  4. package/dist/cjs/src/transaction/Transaction.js +2 -2
  5. package/dist/cjs/src/transaction/Transaction.js.map +1 -1
  6. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  7. package/dist/esm/src/transaction/MerklePath.js +18 -1
  8. package/dist/esm/src/transaction/MerklePath.js.map +1 -1
  9. package/dist/esm/src/transaction/Transaction.js +3 -3
  10. package/dist/esm/src/transaction/Transaction.js.map +1 -1
  11. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  12. package/dist/types/src/transaction/MerklePath.d.ts +12 -0
  13. package/dist/types/src/transaction/MerklePath.d.ts.map +1 -1
  14. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  15. package/dist/umd/bundle.js +1 -1
  16. package/docs/swagger/swagger.yaml +697 -186
  17. package/docs/transaction.md +20 -1
  18. package/package.json +1 -1
  19. package/src/primitives/__tests/PrivateKey.test.ts +2 -2
  20. package/src/transaction/MerklePath.ts +20 -1
  21. package/src/transaction/Transaction.ts +3 -3
  22. package/src/transaction/__tests/MerklePath.test.ts +7 -0
  23. package/src/transaction/__tests/Transaction.test.ts +9 -0
package/docs/swagger/swagger.yaml CHANGED
@@ -18,17 +18,17 @@ paths:
18
18
  content:
19
19
  application/json:
20
20
  schema:
21
- $ref: '#/components/schemas/CreateActionArgs'
21
+ $ref: "#/components/schemas/CreateActionArgs"
22
22
  responses:
23
- '200':
23
+ "200":
24
24
  description: The created transaction result
25
25
  content:
26
26
  application/json:
27
27
  schema:
28
- $ref: '#/components/schemas/CreateActionResult'
29
- '400':
28
+ $ref: "#/components/schemas/CreateActionResult"
29
+ "400":
30
30
  description: Invalid input
31
- '500':
31
+ "500":
32
32
  description: Internal server error
33
33
  /signAction:
34
34
  post:
@@ -40,17 +40,17 @@ paths:
40
40
  content:
41
41
  application/json:
42
42
  schema:
43
- $ref: '#/components/schemas/SignActionArgs'
43
+ $ref: "#/components/schemas/SignActionArgs"
44
44
  responses:
45
- '200':
45
+ "200":
46
46
  description: The signed transaction result
47
47
  content:
48
48
  application/json:
49
49
  schema:
50
- $ref: '#/components/schemas/SignActionResult'
51
- '400':
50
+ $ref: "#/components/schemas/SignActionResult"
51
+ "400":
52
52
  description: Invalid input
53
- '500':
53
+ "500":
54
54
  description: Internal server error
55
55
  /abortAction:
56
56
  post:
@@ -62,17 +62,17 @@ paths:
62
62
  content:
63
63
  application/json:
64
64
  schema:
65
- $ref: '#/components/schemas/AbortActionArgs'
65
+ $ref: "#/components/schemas/AbortActionArgs"
66
66
  responses:
67
- '200':
67
+ "200":
68
68
  description: The abortion result
69
69
  content:
70
70
  application/json:
71
71
  schema:
72
- $ref: '#/components/schemas/AbortActionResult'
73
- '400':
72
+ $ref: "#/components/schemas/AbortActionResult"
73
+ "400":
74
74
  description: Invalid input
75
- '500':
75
+ "500":
76
76
  description: Internal server error
77
77
  /listActions:
78
78
  post:
@@ -84,17 +84,17 @@ paths:
84
84
  content:
85
85
  application/json:
86
86
  schema:
87
- $ref: '#/components/schemas/ListActionsArgs'
87
+ $ref: "#/components/schemas/ListActionsArgs"
88
88
  responses:
89
- '200':
89
+ "200":
90
90
  description: The list of actions
91
91
  content:
92
92
  application/json:
93
93
  schema:
94
- $ref: '#/components/schemas/ListActionsResult'
95
- '400':
94
+ $ref: "#/components/schemas/ListActionsResult"
95
+ "400":
96
96
  description: Invalid input
97
- '500':
97
+ "500":
98
98
  description: Internal server error
99
99
  /internalizeAction:
100
100
  post:
@@ -106,17 +106,17 @@ paths:
106
106
  content:
107
107
  application/json:
108
108
  schema:
109
- $ref: '#/components/schemas/InternalizeActionArgs'
109
+ $ref: "#/components/schemas/InternalizeActionArgs"
110
110
  responses:
111
- '200':
111
+ "200":
112
112
  description: The internalization result
113
113
  content:
114
114
  application/json:
115
115
  schema:
116
- $ref: '#/components/schemas/InternalizeActionResult'
117
- '400':
116
+ $ref: "#/components/schemas/InternalizeActionResult"
117
+ "400":
118
118
  description: Invalid input
119
- '500':
119
+ "500":
120
120
  description: Internal server error
121
121
  /listOutputs:
122
122
  post:
@@ -128,17 +128,17 @@ paths:
128
128
  content:
129
129
  application/json:
130
130
  schema:
131
- $ref: '#/components/schemas/ListOutputsArgs'
131
+ $ref: "#/components/schemas/ListOutputsArgs"
132
132
  responses:
133
- '200':
133
+ "200":
134
134
  description: The list of outputs
135
135
  content:
136
136
  application/json:
137
137
  schema:
138
- $ref: '#/components/schemas/ListOutputsResult'
139
- '400':
138
+ $ref: "#/components/schemas/ListOutputsResult"
139
+ "400":
140
140
  description: Invalid input
141
- '500':
141
+ "500":
142
142
  description: Internal server error
143
143
  /relinquishOutput:
144
144
  post:
@@ -153,11 +153,11 @@ paths:
153
153
  type: object
154
154
  properties:
155
155
  basket:
156
- $ref: '#/components/schemas/BasketStringUnder300Bytes'
156
+ $ref: "#/components/schemas/BasketStringUnder300Bytes"
157
157
  output:
158
- $ref: '#/components/schemas/OutpointString'
158
+ $ref: "#/components/schemas/OutpointString"
159
159
  responses:
160
- '200':
160
+ "200":
161
161
  description: The relinquishment result
162
162
  content:
163
163
  application/json:
@@ -168,9 +168,9 @@ paths:
168
168
  type: boolean
169
169
  examples:
170
170
  - true
171
- '400':
171
+ "400":
172
172
  description: Invalid input
173
- '500':
173
+ "500":
174
174
  description: Internal server error
175
175
  /getPublicKey:
176
176
  post:
@@ -190,26 +190,27 @@ paths:
190
190
  identityKey:
191
191
  type: boolean
192
192
  protocolID:
193
- type: array
194
- prefixItems:
195
- - type: integer
196
- - type: string
197
- minItems: 2
198
- maxItems: 2
193
+ $ref: "#/components/schemas/ProtocolID"
199
194
  keyID:
200
195
  type: string
196
+ examples:
197
+ - "1"
201
198
  privileged:
202
199
  type: boolean
203
200
  default: false
204
201
  privilegedReason:
205
202
  type: string
203
+ examples:
204
+ - "extra secure"
206
205
  counterparty:
207
206
  type: string
207
+ examples:
208
+ - "0200daf17a4b9f7ca9e188a5b0e2b356107bde46d9d358d99e3402bd0e5beffbff"
208
209
  forSelf:
209
210
  type: boolean
210
211
  default: false
211
212
  responses:
212
- '200':
213
+ "200":
213
214
  description: The public key
214
215
  content:
215
216
  application/json:
@@ -218,9 +219,11 @@ paths:
218
219
  properties:
219
220
  publicKey:
220
221
  type: string
221
- '400':
222
+ examples:
223
+ - "027facf8e28228eea25abd69c4f23f15573e1d0f9180718af297e1458827cd5aef"
224
+ "400":
222
225
  description: Invalid input
223
- '500':
226
+ "500":
224
227
  description: Internal server error
225
228
 
226
229
  /revealCounterpartyKeyLinkage:
@@ -237,15 +240,21 @@ paths:
237
240
  properties:
238
241
  counterparty:
239
242
  type: string
243
+ examples:
244
+ - "027facf8e28228eea25abd69c4f23f15573e1d0f9180718af297e1458827cd5aef"
240
245
  verifier:
241
246
  type: string
247
+ examples:
248
+ - "03c378a866d72c391343eddeadf64c4f896637c4160ac6073e7b80b5717310153b"
242
249
  privilegedReason:
243
250
  type: string
251
+ examples:
252
+ - "extra sensitive"
244
253
  privileged:
245
254
  type: boolean
246
255
  default: false
247
256
  responses:
248
- '200':
257
+ "200":
249
258
  description: The counterparty key linkage
250
259
  content:
251
260
  application/json:
@@ -254,12 +263,20 @@ paths:
254
263
  properties:
255
264
  prover:
256
265
  type: string
266
+ examples:
267
+ - "02790ab2d725d04af29e20bf46e1dbc40ba8b49f1355146884c5bd06819273d101"
257
268
  verifier:
258
269
  type: string
270
+ examples:
271
+ - "03c378a866d72c391343eddeadf64c4f896637c4160ac6073e7b80b5717310153b"
259
272
  counterparty:
260
273
  type: string
274
+ examples:
275
+ - "027facf8e28228eea25abd69c4f23f15573e1d0f9180718af297e1458827cd5aef"
261
276
  revelationTime:
262
277
  type: string
278
+ examples:
279
+ - "2024-12-12T12:12:12.120Z"
263
280
  encryptedLinkage:
264
281
  type: array
265
282
  items:
@@ -268,9 +285,9 @@ paths:
268
285
  type: array
269
286
  items:
270
287
  type: integer
271
- '400':
288
+ "400":
272
289
  description: Invalid input
273
- '500':
290
+ "500":
274
291
  description: Internal server error
275
292
 
276
293
  /revealSpecificKeyLinkage:
@@ -287,22 +304,27 @@ paths:
287
304
  properties:
288
305
  counterparty:
289
306
  type: string
307
+ examples:
308
+ - "027facf8e28228eea25abd69c4f23f15573e1d0f9180718af297e1458827cd5aef"
290
309
  verifier:
291
310
  type: string
311
+ examples:
312
+ - "03c378a866d72c391343eddeadf64c4f896637c4160ac6073e7b80b5717310153b"
292
313
  protocolID:
293
- type: array
294
- items:
295
- - type: integer
296
- - type: string
314
+ $ref: "#/components/schemas/ProtocolID"
297
315
  keyID:
298
316
  type: string
317
+ examples:
318
+ - "1"
299
319
  privilegedReason:
300
320
  type: string
321
+ examples:
322
+ - "special stuff"
301
323
  privileged:
302
324
  type: boolean
303
325
  default: false
304
326
  responses:
305
- '200':
327
+ "200":
306
328
  description: The specific key linkage
307
329
  content:
308
330
  application/json:
@@ -311,19 +333,26 @@ paths:
311
333
  properties:
312
334
  prover:
313
335
  type: string
336
+ examples:
337
+ - "02790ab2d725d04af29e20bf46e1dbc40ba8b49f1355146884c5bd06819273d101"
314
338
  verifier:
315
339
  type: string
340
+ examples:
341
+ - "03c378a866d72c391343eddeadf64c4f896637c4160ac6073e7b80b5717310153b"
316
342
  counterparty:
317
343
  type: string
344
+ examples:
345
+ - "027facf8e28228eea25abd69c4f23f15573e1d0f9180718af297e1458827cd5aef"
346
+ revelationTime:
347
+ type: string
348
+ examples:
349
+ - "2024-12-12T12:12:12.120Z"
318
350
  protocolID:
319
- type: array
320
- prefixItems:
321
- - type: integer
322
- - type: string
323
- minItems: 2
324
- maxItems: 2
351
+ $ref: "#/components/schemas/ProtocolID"
325
352
  keyID:
326
353
  type: string
354
+ examples:
355
+ - "1"
327
356
  encryptedLinkage:
328
357
  type: array
329
358
  items:
@@ -334,9 +363,9 @@ paths:
334
363
  type: integer
335
364
  proofType:
336
365
  type: integer
337
- '400':
366
+ "400":
338
367
  description: Invalid input
339
- '500':
368
+ "500":
340
369
  description: Internal server error
341
370
 
342
371
  /encrypt:
@@ -356,24 +385,29 @@ paths:
356
385
  default: true
357
386
  plaintext:
358
387
  type: array
388
+ examples:
389
+ - [115, 101, 99, 114, 101, 116, 115]
359
390
  items:
360
391
  type: integer
361
392
  protocolID:
362
- type: array
363
- items:
364
- - type: integer
365
- - type: string
393
+ $ref: "#/components/schemas/ProtocolID"
366
394
  keyID:
367
395
  type: string
396
+ examples:
397
+ - "1"
368
398
  privilegedReason:
369
399
  type: string
400
+ examples:
401
+ - "extra secure"
370
402
  counterparty:
371
403
  type: string
404
+ examples:
405
+ - "self"
372
406
  privileged:
373
407
  type: boolean
374
408
  default: false
375
409
  responses:
376
- '200':
410
+ "200":
377
411
  description: The encrypted data
378
412
  content:
379
413
  application/json:
@@ -382,11 +416,13 @@ paths:
382
416
  properties:
383
417
  ciphertext:
384
418
  type: array
419
+ examples:
420
+ - [47, 102, 55, 54, 51, 52, 42, 38, 9]
385
421
  items:
386
422
  type: integer
387
- '400':
423
+ "400":
388
424
  description: Invalid input
389
- '500':
425
+ "500":
390
426
  description: Internal server error
391
427
 
392
428
  /decrypt:
@@ -406,24 +442,29 @@ paths:
406
442
  default: true
407
443
  ciphertext:
408
444
  type: array
445
+ examples:
446
+ - [47, 102, 55, 54, 51, 52, 42, 38, 9]
409
447
  items:
410
448
  type: integer
411
449
  protocolID:
412
- type: array
413
- items:
414
- - type: integer
415
- - type: string
450
+ $ref: "#/components/schemas/ProtocolID"
416
451
  keyID:
417
452
  type: string
453
+ examples:
454
+ - "1"
418
455
  privilegedReason:
419
456
  type: string
457
+ examples:
458
+ - "extra secure"
420
459
  counterparty:
421
460
  type: string
461
+ examples:
462
+ - "self"
422
463
  privileged:
423
464
  type: boolean
424
465
  default: false
425
466
  responses:
426
- '200':
467
+ "200":
427
468
  description: The decrypted data
428
469
  content:
429
470
  application/json:
@@ -432,11 +473,13 @@ paths:
432
473
  properties:
433
474
  plaintext:
434
475
  type: array
476
+ examples:
477
+ - [115, 101, 99, 114, 101, 116, 115]
435
478
  items:
436
479
  type: integer
437
- '400':
480
+ "400":
438
481
  description: Invalid input
439
- '500':
482
+ "500":
440
483
  description: Internal server error
441
484
 
442
485
  /createHmac:
@@ -456,24 +499,29 @@ paths:
456
499
  default: true
457
500
  data:
458
501
  type: array
502
+ examples:
503
+ - [115, 101, 99, 114, 101, 116, 115]
459
504
  items:
460
505
  type: integer
461
506
  protocolID:
462
- type: array
463
- items:
464
- - type: integer
465
- - type: string
507
+ $ref: "#/components/schemas/ProtocolID"
466
508
  keyID:
467
509
  type: string
510
+ examples:
511
+ - "2"
468
512
  privilegedReason:
469
513
  type: string
514
+ examples:
515
+ - "special reasons"
470
516
  counterparty:
471
517
  type: string
518
+ examples:
519
+ - "anyone"
472
520
  privileged:
473
521
  type: boolean
474
522
  default: false
475
523
  responses:
476
- '200':
524
+ "200":
477
525
  description: The HMAC
478
526
  content:
479
527
  application/json:
@@ -482,11 +530,46 @@ paths:
482
530
  properties:
483
531
  hmac:
484
532
  type: array
533
+ examples:
534
+ - [
535
+ 114,
536
+ 178,
537
+ 137,
538
+ 236,
539
+ 120,
540
+ 224,
541
+ 169,
542
+ 40,
543
+ 197,
544
+ 101,
545
+ 72,
546
+ 10,
547
+ 67,
548
+ 84,
549
+ 83,
550
+ 227,
551
+ 10,
552
+ 203,
553
+ 146,
554
+ 237,
555
+ 219,
556
+ 59,
557
+ 120,
558
+ 255,
559
+ 22,
560
+ 139,
561
+ 40,
562
+ 115,
563
+ 124,
564
+ 246,
565
+ 168,
566
+ 73,
567
+ ]
485
568
  items:
486
569
  type: integer
487
- '400':
570
+ "400":
488
571
  description: Invalid input
489
- '500':
572
+ "500":
490
573
  description: Internal server error
491
574
 
492
575
  /verifyHmac:
@@ -506,28 +589,68 @@ paths:
506
589
  default: true
507
590
  data:
508
591
  type: array
592
+ examples:
593
+ - [115, 101, 99, 114, 101, 116, 115]
509
594
  items:
510
595
  type: integer
511
596
  hmac:
512
597
  type: array
598
+ examples:
599
+ - [
600
+ 114,
601
+ 178,
602
+ 137,
603
+ 236,
604
+ 120,
605
+ 224,
606
+ 169,
607
+ 40,
608
+ 197,
609
+ 101,
610
+ 72,
611
+ 10,
612
+ 67,
613
+ 84,
614
+ 83,
615
+ 227,
616
+ 10,
617
+ 203,
618
+ 146,
619
+ 237,
620
+ 219,
621
+ 59,
622
+ 120,
623
+ 255,
624
+ 22,
625
+ 139,
626
+ 40,
627
+ 115,
628
+ 124,
629
+ 246,
630
+ 168,
631
+ 73,
632
+ ]
513
633
  items:
514
634
  type: integer
515
635
  protocolID:
516
- type: array
517
- items:
518
- - type: integer
519
- - type: string
636
+ $ref: "#/components/schemas/ProtocolID"
520
637
  keyID:
521
638
  type: string
639
+ examples:
640
+ - "1"
522
641
  privilegedReason:
523
642
  type: string
643
+ examples:
644
+ - "I love to be secure"
524
645
  counterparty:
525
646
  type: string
647
+ examples:
648
+ - "anyone"
526
649
  privileged:
527
650
  type: boolean
528
651
  default: false
529
652
  responses:
530
- '200':
653
+ "200":
531
654
  description: The verification result
532
655
  content:
533
656
  application/json:
@@ -536,9 +659,9 @@ paths:
536
659
  properties:
537
660
  valid:
538
661
  type: boolean
539
- '400':
662
+ "400":
540
663
  description: Invalid input
541
- '500':
664
+ "500":
542
665
  description: Internal server error
543
666
 
544
667
  /createSignature:
@@ -558,28 +681,35 @@ paths:
558
681
  default: true
559
682
  data:
560
683
  type: array
684
+ examples:
685
+ - [115, 101, 99, 114, 101, 116, 115]
561
686
  items:
562
687
  type: integer
563
688
  hashToDirectlySign:
564
689
  type: array
690
+ examples:
691
+ - []
565
692
  items:
566
693
  type: integer
567
694
  protocolID:
568
- type: array
569
- items:
570
- - type: integer
571
- - type: string
695
+ $ref: "#/components/schemas/ProtocolID"
572
696
  keyID:
573
697
  type: string
698
+ examples:
699
+ - "1"
574
700
  privilegedReason:
575
701
  type: string
702
+ examples:
703
+ - "I love to be secure"
576
704
  counterparty:
577
705
  type: string
706
+ examples:
707
+ - "anyone"
578
708
  privileged:
579
709
  type: boolean
580
710
  default: false
581
711
  responses:
582
- '200':
712
+ "200":
583
713
  description: The signature
584
714
  content:
585
715
  application/json:
@@ -590,9 +720,9 @@ paths:
590
720
  type: array
591
721
  items:
592
722
  type: integer
593
- '400':
723
+ "400":
594
724
  description: Invalid input
595
- '500':
725
+ "500":
596
726
  description: Internal server error
597
727
 
598
728
  /verifySignature:
@@ -616,23 +746,136 @@ paths:
616
746
  type: integer
617
747
  hashToDirectlyVerify:
618
748
  type: array
749
+ examples:
750
+ - [
751
+ 114,
752
+ 178,
753
+ 137,
754
+ 236,
755
+ 120,
756
+ 224,
757
+ 169,
758
+ 40,
759
+ 197,
760
+ 101,
761
+ 72,
762
+ 10,
763
+ 67,
764
+ 84,
765
+ 83,
766
+ 227,
767
+ 10,
768
+ 203,
769
+ 146,
770
+ 237,
771
+ 219,
772
+ 59,
773
+ 120,
774
+ 255,
775
+ 22,
776
+ 139,
777
+ 40,
778
+ 115,
779
+ 124,
780
+ 246,
781
+ 168,
782
+ 73,
783
+ ]
619
784
  items:
620
785
  type: integer
621
786
  signature:
622
787
  type: array
788
+ examples:
789
+ - [
790
+ 48,
791
+ 69,
792
+ 2,
793
+ 33,
794
+ 0,
795
+ 189,
796
+ 197,
797
+ 179,
798
+ 187,
799
+ 162,
800
+ 114,
801
+ 42,
802
+ 69,
803
+ 21,
804
+ 51,
805
+ 96,
806
+ 183,
807
+ 226,
808
+ 242,
809
+ 212,
810
+ 49,
811
+ 221,
812
+ 96,
813
+ 197,
814
+ 178,
815
+ 63,
816
+ 241,
817
+ 43,
818
+ 248,
819
+ 36,
820
+ 212,
821
+ 243,
822
+ 226,
823
+ 144,
824
+ 198,
825
+ 47,
826
+ 238,
827
+ 2,
828
+ 32,
829
+ 54,
830
+ 138,
831
+ 29,
832
+ 195,
833
+ 78,
834
+ 4,
835
+ 222,
836
+ 220,
837
+ 219,
838
+ 226,
839
+ 234,
840
+ 189,
841
+ 122,
842
+ 78,
843
+ 27,
844
+ 129,
845
+ 253,
846
+ 196,
847
+ 59,
848
+ 189,
849
+ 167,
850
+ 195,
851
+ 66,
852
+ 73,
853
+ 69,
854
+ 115,
855
+ 126,
856
+ 200,
857
+ 16,
858
+ 65,
859
+ 114,
860
+ 64,
861
+ 65,
862
+ ]
623
863
  items:
624
864
  type: integer
625
865
  protocolID:
626
- type: array
627
- items:
628
- - type: integer
629
- - type: string
866
+ $ref: "#/components/schemas/ProtocolID"
630
867
  keyID:
631
868
  type: string
869
+ examples:
870
+ - "1"
632
871
  privilegedReason:
633
872
  type: string
873
+ examples:
874
+ - "-"
634
875
  counterparty:
635
876
  type: string
877
+ examples:
878
+ - "anyone"
636
879
  forSelf:
637
880
  type: boolean
638
881
  default: false
@@ -640,7 +883,7 @@ paths:
640
883
  type: boolean
641
884
  default: false
642
885
  responses:
643
- '200':
886
+ "200":
644
887
  description: The verification result
645
888
  content:
646
889
  application/json:
@@ -649,9 +892,9 @@ paths:
649
892
  properties:
650
893
  valid:
651
894
  type: boolean
652
- '400':
895
+ "400":
653
896
  description: Invalid input
654
- '500':
897
+ "500":
655
898
  description: Internal server error
656
899
 
657
900
  /acquireCertificate:
@@ -664,17 +907,17 @@ paths:
664
907
  content:
665
908
  application/json:
666
909
  schema:
667
- $ref: '#/components/schemas/AcquireCertificateArgs'
910
+ $ref: "#/components/schemas/AcquireCertificateArgs"
668
911
  responses:
669
- '200':
912
+ "200":
670
913
  description: The acquired certificate
671
914
  content:
672
915
  application/json:
673
916
  schema:
674
- $ref: '#/components/schemas/AcquireCertificateResult'
675
- '400':
917
+ $ref: "#/components/schemas/Certificate"
918
+ "400":
676
919
  description: Invalid input
677
- '500':
920
+ "500":
678
921
  description: Internal server error
679
922
 
680
923
  /listCertificates:
@@ -691,14 +934,23 @@ paths:
691
934
  properties:
692
935
  certifiers:
693
936
  type: array
937
+ examples:
938
+ - - "0322f8f64b95234a4b531109c2c271e01cd2a9ee497e71a788cae384b6aae54d75"
939
+ - "02e3dfb8196c17baab7353e139693a1c0813d60ecd022f5c52779faf2cff341374"
940
+ - "0334b3dd693269d37e0ef35aace5dc07fdd510ff0f1596399ed7bf8b27dc025bdd"
694
941
  items:
695
942
  type: string
696
943
  types:
697
944
  type: array
945
+ examples:
946
+ - - "W/iqV/xaa8VH3s8cxttj8Q3rVaPGxd9JfWMfs9leGr8="
947
+ - "xrhnMvBJoy7tWi92bFzci3cGNhmiC+yU8iK8vSSeZWI="
698
948
  items:
699
949
  type: string
700
950
  limit:
701
951
  type: integer
952
+ examples:
953
+ - 10
702
954
  offset:
703
955
  type: integer
704
956
  privileged:
@@ -706,16 +958,18 @@ paths:
706
958
  default: false
707
959
  privilegedReason:
708
960
  type: string
961
+ examples:
962
+ - "-"
709
963
  responses:
710
- '200':
964
+ "200":
711
965
  description: The list of certificates
712
966
  content:
713
967
  application/json:
714
968
  schema:
715
- $ref: '#/components/schemas/ListCertificatesResult'
716
- '400':
969
+ $ref: "#/components/schemas/ListCertificatesResult"
970
+ "400":
717
971
  description: Invalid input
718
- '500':
972
+ "500":
719
973
  description: Internal server error
720
974
 
721
975
  /proveCertificate:
@@ -728,17 +982,17 @@ paths:
728
982
  content:
729
983
  application/json:
730
984
  schema:
731
- $ref: '#/components/schemas/ProveCertificateArgs'
985
+ $ref: "#/components/schemas/ProveCertificateArgs"
732
986
  responses:
733
- '200':
987
+ "200":
734
988
  description: The proof of the certificate
735
989
  content:
736
990
  application/json:
737
991
  schema:
738
- $ref: '#/components/schemas/ProveCertificateResult'
739
- '400':
992
+ $ref: "#/components/schemas/ProveCertificateResult"
993
+ "400":
740
994
  description: Invalid input
741
- '500':
995
+ "500":
742
996
  description: Internal server error
743
997
 
744
998
  /relinquishCertificate:
@@ -755,12 +1009,18 @@ paths:
755
1009
  properties:
756
1010
  type:
757
1011
  type: string
1012
+ examples:
1013
+ - "W/iqV/xaa8VH3s8cxttj8Q3rVaPGxd9JfWMfs9leGr8="
758
1014
  serialNumber:
759
1015
  type: string
1016
+ examples:
1017
+ - "oXTshKWy209Lv8MFVDxmsFzZQQ"
760
1018
  certifier:
761
1019
  type: string
1020
+ examples:
1021
+ - "03d40063722f77cc57a96bdf963c56fd29085b1297e598471ad63dd51b1b54db6e"
762
1022
  responses:
763
- '200':
1023
+ "200":
764
1024
  description: The relinquishment result
765
1025
  content:
766
1026
  application/json:
@@ -771,9 +1031,9 @@ paths:
771
1031
  type: boolean
772
1032
  examples:
773
1033
  - true
774
- '400':
1034
+ "400":
775
1035
  description: Invalid input
776
- '500':
1036
+ "500":
777
1037
  description: Internal server error
778
1038
 
779
1039
  /discoverByIdentityKey:
@@ -788,25 +1048,29 @@ paths:
788
1048
  schema:
789
1049
  type: object
790
1050
  properties:
791
- seekPermission:
792
- type: boolean
793
- default: true
794
1051
  identityKey:
795
1052
  type: string
1053
+ examples:
1054
+ - "03ed91c6e33a5ef6fc3d927b2d7064af0c78447cfc304c069715ea7bdd2e5c6ea8"
796
1055
  limit:
797
1056
  type: integer
1057
+ examples:
1058
+ - 10
798
1059
  offset:
799
1060
  type: integer
1061
+ seekPermission:
1062
+ type: boolean
1063
+ default: true
800
1064
  responses:
801
- '200':
1065
+ "200":
802
1066
  description: The discovered certificates
803
1067
  content:
804
1068
  application/json:
805
1069
  schema:
806
- $ref: '#/components/schemas/DiscoverCertificatesResult'
807
- '400':
1070
+ $ref: "#/components/schemas/DiscoverCertificatesResult"
1071
+ "400":
808
1072
  description: Invalid input
809
- '500':
1073
+ "500":
810
1074
  description: Internal server error
811
1075
 
812
1076
  /discoverByAttributes:
@@ -821,27 +1085,31 @@ paths:
821
1085
  schema:
822
1086
  type: object
823
1087
  properties:
824
- seekPermission:
825
- type: boolean
826
- default: true
827
1088
  attributes:
828
1089
  type: object
1090
+ examples:
1091
+ - firstName: "David"
829
1092
  additionalProperties:
830
1093
  type: string
831
1094
  limit:
832
1095
  type: integer
1096
+ examples:
1097
+ - 10
833
1098
  offset:
834
1099
  type: integer
1100
+ seekPermission:
1101
+ type: boolean
1102
+ default: true
835
1103
  responses:
836
- '200':
1104
+ "200":
837
1105
  description: The discovered certificates
838
1106
  content:
839
1107
  application/json:
840
1108
  schema:
841
- $ref: '#/components/schemas/DiscoverCertificatesResult'
842
- '400':
1109
+ $ref: "#/components/schemas/DiscoverCertificatesResult"
1110
+ "400":
843
1111
  description: Invalid input
844
- '500':
1112
+ "500":
845
1113
  description: Internal server error
846
1114
 
847
1115
  /isAuthenticated:
@@ -850,7 +1118,7 @@ paths:
850
1118
  - HTTPWalletJSON
851
1119
  summary: Checks if the user is authenticated
852
1120
  responses:
853
- '200':
1121
+ "200":
854
1122
  description: The authentication status
855
1123
  content:
856
1124
  application/json:
@@ -859,9 +1127,9 @@ paths:
859
1127
  properties:
860
1128
  authenticated:
861
1129
  type: boolean
862
- '400':
1130
+ "400":
863
1131
  description: Invalid input
864
- '500':
1132
+ "500":
865
1133
  description: Internal server error
866
1134
 
867
1135
  /waitForAuthentication:
@@ -870,7 +1138,7 @@ paths:
870
1138
  - HTTPWalletJSON
871
1139
  summary: Waits for user authentication
872
1140
  responses:
873
- '200':
1141
+ "200":
874
1142
  description: The authentication result
875
1143
  content:
876
1144
  application/json:
@@ -881,9 +1149,9 @@ paths:
881
1149
  type: boolean
882
1150
  examples:
883
1151
  - true
884
- '400':
1152
+ "400":
885
1153
  description: Invalid input
886
- '500':
1154
+ "500":
887
1155
  description: Internal server error
888
1156
 
889
1157
  /getHeight:
@@ -892,7 +1160,7 @@ paths:
892
1160
  - HTTPWalletJSON
893
1161
  summary: Retrieves the current blockchain height
894
1162
  responses:
895
- '200':
1163
+ "200":
896
1164
  description: The current blockchain height
897
1165
  content:
898
1166
  application/json:
@@ -901,9 +1169,11 @@ paths:
901
1169
  properties:
902
1170
  height:
903
1171
  type: integer
904
- '400':
1172
+ examples:
1173
+ - 875002
1174
+ "400":
905
1175
  description: Invalid input
906
- '500':
1176
+ "500":
907
1177
  description: Internal server error
908
1178
 
909
1179
  /getHeaderForHeight:
@@ -920,8 +1190,10 @@ paths:
920
1190
  properties:
921
1191
  height:
922
1192
  type: integer
1193
+ examples:
1194
+ - 875002
923
1195
  responses:
924
- '200':
1196
+ "200":
925
1197
  description: The block header
926
1198
  content:
927
1199
  application/json:
@@ -930,9 +1202,11 @@ paths:
930
1202
  properties:
931
1203
  header:
932
1204
  type: string
933
- '400':
1205
+ examples:
1206
+ - "0020372d395bfcfc03b467e747f873da7e4f4fd0afcc89301787b10a0000000000000000724ab3c241848b826766b46947e008e022b95877629498ec3e7dd85f1ae0b383f8f8826566280d184b11f02a"
1207
+ "400":
934
1208
  description: Invalid input
935
- '500':
1209
+ "500":
936
1210
  description: Internal server error
937
1211
 
938
1212
  /getNetwork:
@@ -941,7 +1215,7 @@ paths:
941
1215
  - HTTPWalletJSON
942
1216
  summary: Retrieves the current network
943
1217
  responses:
944
- '200':
1218
+ "200":
945
1219
  description: The current network
946
1220
  content:
947
1221
  application/json:
@@ -953,9 +1227,9 @@ paths:
953
1227
  enum:
954
1228
  - mainnet
955
1229
  - testnet
956
- '400':
1230
+ "400":
957
1231
  description: Invalid input
958
- '500':
1232
+ "500":
959
1233
  description: Internal server error
960
1234
 
961
1235
  /getVersion:
@@ -964,7 +1238,7 @@ paths:
964
1238
  - HTTPWalletJSON
965
1239
  summary: Retrieves the current version
966
1240
  responses:
967
- '200':
1241
+ "200":
968
1242
  description: The current version
969
1243
  content:
970
1244
  application/json:
@@ -973,9 +1247,11 @@ paths:
973
1247
  properties:
974
1248
  version:
975
1249
  type: string
976
- '400':
1250
+ examples:
1251
+ - "BSVA-1.0.0"
1252
+ "400":
977
1253
  description: Invalid input
978
- '500':
1254
+ "500":
979
1255
  description: Internal server error
980
1256
  components:
981
1257
  schemas:
@@ -984,76 +1260,109 @@ components:
984
1260
  properties:
985
1261
  description:
986
1262
  type: string
1263
+ examples:
1264
+ - "human readable purpose of this action"
987
1265
  inputBEEF:
988
1266
  type: array
1267
+ examples:
1268
+ - [1, 1, 1, 1]
989
1269
  items:
990
1270
  type: number
991
1271
  inputs:
992
1272
  type: array
993
1273
  items:
994
- $ref: '#/components/schemas/CreateActionInput'
1274
+ $ref: "#/components/schemas/CreateActionInput"
995
1275
  outputs:
996
1276
  type: array
997
1277
  items:
998
- $ref: '#/components/schemas/CreateActionOutput'
1278
+ $ref: "#/components/schemas/CreateActionOutput"
999
1279
  lockTime:
1000
1280
  type: number
1281
+ examples:
1282
+ - 0
1001
1283
  version:
1002
1284
  type: number
1285
+ examples:
1286
+ - 1
1003
1287
  labels:
1004
1288
  type: array
1289
+ examples:
1290
+ - ["todo create"]
1005
1291
  items:
1006
1292
  type: string
1007
1293
  options:
1008
- $ref: '#/components/schemas/CreateActionOptions'
1294
+ $ref: "#/components/schemas/CreateActionOptions"
1009
1295
  CreateActionResult:
1010
1296
  type: object
1011
1297
  properties:
1012
1298
  txid:
1013
1299
  type: string
1300
+ examples:
1301
+ - "16bed6368b8b1542cd6eb87f5bc20dc830b41a2258dde40438a75fa701d24e9a"
1014
1302
  tx:
1015
1303
  type: array
1304
+ examples:
1305
+ - [1, 1, 1, 1]
1016
1306
  items:
1017
1307
  type: number
1018
1308
  noSendChange:
1019
1309
  type: array
1310
+ examples:
1311
+ - [
1312
+ "11df9f39662e276dc2f637f063919ce3ca86cbc2d55ee8d661408d22b1f49018.0",
1313
+ ]
1020
1314
  items:
1021
1315
  type: string
1022
1316
  sendWithResults:
1023
1317
  type: array
1024
1318
  items:
1025
- $ref: '#/components/schemas/SendWithResult'
1319
+ $ref: "#/components/schemas/SendWithResult"
1026
1320
  signableTransaction:
1027
- $ref: '#/components/schemas/SignableTransaction'
1321
+ $ref: "#/components/schemas/SignableTransaction"
1028
1322
  SignActionArgs:
1029
1323
  type: object
1030
1324
  properties:
1031
1325
  spends:
1032
1326
  type: object
1327
+ examples:
1328
+ - 0:
1329
+ unlockingScript: "47304402206ba4a1c0aa4e1ba7f2cd79de36..."
1330
+ sequenceNumber: 4294967295
1331
+ 1:
1332
+ unlockingScript: "473044022031d6c05d21ea4ee96da0fa17ea..."
1333
+ sequenceNumber: 4294967295
1033
1334
  additionalProperties:
1034
- $ref: '#/components/schemas/SignActionSpend'
1335
+ $ref: "#/components/schemas/SignActionSpend"
1035
1336
  reference:
1036
1337
  type: string
1338
+ examples:
1339
+ - "C1HST7xvPKzh66npoiJ5fKwnLtnH3xxQ4ylxaGBTTOA="
1037
1340
  options:
1038
- $ref: '#/components/schemas/SignActionOptions'
1341
+ $ref: "#/components/schemas/SignActionOptions"
1039
1342
  SignActionResult:
1040
1343
  type: object
1041
1344
  properties:
1042
1345
  txid:
1043
1346
  type: string
1347
+ examples:
1348
+ - "cd8345f101b2c6163921d9ff08526d88aa24cb68456f546eec935c6485155838"
1044
1349
  tx:
1045
1350
  type: array
1351
+ examples:
1352
+ - [1, 1, 1, 1]
1046
1353
  items:
1047
1354
  type: number
1048
1355
  sendWithResults:
1049
1356
  type: array
1050
1357
  items:
1051
- $ref: '#/components/schemas/SendWithResult'
1358
+ $ref: "#/components/schemas/SendWithResult"
1052
1359
  AbortActionArgs:
1053
1360
  type: object
1054
1361
  properties:
1055
1362
  reference:
1056
1363
  type: string
1364
+ examples:
1365
+ - "C1HST7xvPKzh66npoiJ5fKwnLtnH3xxQ4ylxaGBTTOA="
1057
1366
  AbortActionResult:
1058
1367
  type: object
1059
1368
  properties:
@@ -1066,6 +1375,8 @@ components:
1066
1375
  properties:
1067
1376
  labels:
1068
1377
  type: array
1378
+ examples:
1379
+ - ["todo create"]
1069
1380
  items:
1070
1381
  type: string
1071
1382
  labelQueryMode:
@@ -1073,6 +1384,8 @@ components:
1073
1384
  enum: [any, all]
1074
1385
  includeLabels:
1075
1386
  type: boolean
1387
+ examples:
1388
+ - false
1076
1389
  includeInputs:
1077
1390
  type: boolean
1078
1391
  includeInputSourceLockingScripts:
@@ -1085,8 +1398,12 @@ components:
1085
1398
  type: boolean
1086
1399
  limit:
1087
1400
  type: number
1401
+ examples:
1402
+ - 10
1088
1403
  offset:
1089
1404
  type: number
1405
+ examples:
1406
+ - 0
1090
1407
  seekPermission:
1091
1408
  type: boolean
1092
1409
  ListActionsResult:
@@ -1094,25 +1411,48 @@ components:
1094
1411
  properties:
1095
1412
  totalActions:
1096
1413
  type: number
1414
+ examples:
1415
+ - 1
1097
1416
  actions:
1098
1417
  type: array
1099
1418
  items:
1100
- $ref: '#/components/schemas/WalletAction'
1419
+ $ref: "#/components/schemas/WalletAction"
1101
1420
  InternalizeActionArgs:
1102
1421
  type: object
1103
1422
  properties:
1104
1423
  tx:
1105
1424
  type: array
1425
+ examples:
1426
+ - [1, 1, 1, 1]
1106
1427
  items:
1107
1428
  type: number
1108
1429
  outputs:
1109
1430
  type: array
1431
+ examples:
1432
+ - - outputIndex: 0
1433
+ protocol: "wallet payment"
1434
+ paymentRemittance:
1435
+ derivationPrefix: "12345678"
1436
+ derivationSuffix: "00000"
1437
+ senderIdentity: "02ffc4f361307f34a82069edbcbe2c9f4bd5498165549f42bdeb698ffdcab1ea38"
1438
+ - outputIndex: 1
1439
+ protocol: "basket insertion"
1440
+ insertionRemittance:
1441
+ basket: "todo token"
1442
+ customInstructions: "3453,3462346,self"
1443
+ tags:
1444
+ - "foose"
1445
+ - "goose"
1110
1446
  items:
1111
- $ref: '#/components/schemas/InternalizeOutput'
1447
+ $ref: "#/components/schemas/InternalizeOutput"
1112
1448
  description:
1113
1449
  type: string
1450
+ examples:
1451
+ - "Creation of a new thing."
1114
1452
  labels:
1115
1453
  type: array
1454
+ examples:
1455
+ - ["todo create", "productivity"]
1116
1456
  items:
1117
1457
  type: string
1118
1458
  seekPermission:
@@ -1129,12 +1469,18 @@ components:
1129
1469
  properties:
1130
1470
  basket:
1131
1471
  type: string
1472
+ examples:
1473
+ - "todo token"
1132
1474
  tags:
1133
1475
  type: array
1476
+ examples:
1477
+ - ["todo create", "todo burn"]
1134
1478
  items:
1135
1479
  type: string
1136
1480
  tagQueryMode:
1137
1481
  type: string
1482
+ examples:
1483
+ - "any"
1138
1484
  enum: [all, any]
1139
1485
  include:
1140
1486
  type: string
@@ -1147,15 +1493,31 @@ components:
1147
1493
  type: boolean
1148
1494
  limit:
1149
1495
  type: number
1496
+ examples:
1497
+ - 10
1150
1498
  offset:
1151
1499
  type: number
1152
1500
  seekPermission:
1153
1501
  type: boolean
1154
1502
  ListOutputsResult:
1155
1503
  type: object
1504
+ examples:
1505
+ - totalOutputs: 1
1506
+ outputs:
1507
+ - satoshis: 1000
1508
+ lockingScript: "76a914dd8b1abde0304820ace0adf1478a3ef2291a833788ac"
1509
+ spendable: true
1510
+ customInstructions: "12,34,023398754239872342354534"
1511
+ tags: ["todo create"]
1512
+ outpoint: "d834139537caeb6abb876e1adcf00064fa7a775cf324a2c3bd8c13a8ec8c888f.34"
1513
+ labels: ["productivity"]
1514
+ - totalOutputs: 1
1515
+ BEEF: [2, 0, 190, 239]
1156
1516
  properties:
1157
1517
  totalOutputs:
1158
1518
  type: number
1519
+ examples:
1520
+ - 1
1159
1521
  BEEF:
1160
1522
  type: array
1161
1523
  items:
@@ -1163,35 +1525,57 @@ components:
1163
1525
  outputs:
1164
1526
  type: array
1165
1527
  items:
1166
- $ref: '#/components/schemas/WalletOutput'
1528
+ $ref: "#/components/schemas/WalletOutput"
1167
1529
  CreateActionInput:
1168
1530
  type: object
1169
1531
  properties:
1170
1532
  outpoint:
1171
1533
  type: string
1534
+ examples:
1535
+ - "ef01fee61a0d00090280027a0ec9df2e605fa46a903dfa1bd249b96aa3001490.0"
1172
1536
  inputDescription:
1173
1537
  type: string
1538
+ examples:
1539
+ - "why this token is being spent"
1174
1540
  unlockingScript:
1175
1541
  type: string
1542
+ examples:
1543
+ - "47304402200aa56a892e310a7575035fb3c0bcf466bbc16e97dae197cc1d40412313f94b89022011944d2b1b0fa72dbe7893c400624a0652a6efcc40d459216c0e00d5d135f7fc412103820b289317fa9ba995ca05bc084a77ae6077dbb424206424d92b51653521bb90"
1176
1544
  unlockingScriptLength:
1177
1545
  type: number
1546
+ examples:
1547
+ - 106
1178
1548
  sequenceNumber:
1179
1549
  type: number
1550
+ examples:
1551
+ - 4294967295
1180
1552
  CreateActionOutput:
1181
1553
  type: object
1182
1554
  properties:
1183
1555
  lockingScript:
1184
1556
  type: string
1557
+ examples:
1558
+ - "76a914978bf440c1ae52331b2e95b641c0041debaa87ce88ac"
1185
1559
  satoshis:
1186
1560
  type: number
1561
+ examples:
1562
+ - 1234
1187
1563
  outputDescription:
1188
1564
  type: string
1565
+ examples:
1566
+ - "why this token is being created"
1189
1567
  basket:
1190
1568
  type: string
1569
+ examples:
1570
+ - "todo token"
1191
1571
  customInstructions:
1192
1572
  type: string
1573
+ examples:
1574
+ - "invoice1234,keyId1,03820b289317fa9ba995ca05bc084a77ae6077dbb424206424d92b51653521bb90"
1193
1575
  tags:
1194
1576
  type: array
1577
+ examples:
1578
+ - ["todo", "productivity"]
1195
1579
  items:
1196
1580
  type: string
1197
1581
  CreateActionOptions:
@@ -1214,10 +1598,18 @@ components:
1214
1598
  type: boolean
1215
1599
  noSendChange:
1216
1600
  type: array
1601
+ examples:
1602
+ - [
1603
+ "11df9f39662e276dc2f637f063919ce3ca86cbc2d55ee8d661408d22b1f49018.0",
1604
+ ]
1217
1605
  items:
1218
1606
  type: string
1219
1607
  sendWith:
1220
1608
  type: array
1609
+ examples:
1610
+ - [
1611
+ "c2d37dd0575766e4deedf7ba072ad35b87e9223af01d2829a81960ba7164f606",
1612
+ ]
1221
1613
  items:
1222
1614
  type: string
1223
1615
  randomizeOutputs:
@@ -1227,6 +1619,8 @@ components:
1227
1619
  properties:
1228
1620
  txid:
1229
1621
  type: string
1622
+ examples:
1623
+ - "a0084f73e13afdcc284cc810b4d22af004a38dcf404d8ddbe43ac9fb1a77a4be"
1230
1624
  status:
1231
1625
  type: string
1232
1626
  enum: [unproven, sending, failed]
@@ -1235,17 +1629,25 @@ components:
1235
1629
  properties:
1236
1630
  tx:
1237
1631
  type: array
1632
+ examples:
1633
+ - [1, 1, 1, 1]
1238
1634
  items:
1239
1635
  type: number
1240
1636
  reference:
1241
1637
  type: string
1638
+ examples:
1639
+ - "C1HST7xvPKzh66npoiJ5fKwnLtnH3xxQ4ylxaGBTTOA="
1242
1640
  SignActionSpend:
1243
1641
  type: object
1244
1642
  properties:
1245
1643
  unlockingScript:
1246
1644
  type: string
1645
+ examples:
1646
+ - "47304402206ba4a1c0aa4e1ba7f2cd79de3617c9b1..."
1247
1647
  sequenceNumber:
1248
1648
  type: number
1649
+ examples:
1650
+ - 4294967295
1249
1651
  SignActionOptions:
1250
1652
  type: object
1251
1653
  properties:
@@ -1257,6 +1659,10 @@ components:
1257
1659
  type: boolean
1258
1660
  sendWith:
1259
1661
  type: array
1662
+ examples:
1663
+ - [
1664
+ "c2d37dd0575766e4deedf7ba072ad35b87e9223af01d2829a81960ba7164f606",
1665
+ ]
1260
1666
  items:
1261
1667
  type: string
1262
1668
  InternalizeOutput:
@@ -1292,67 +1698,112 @@ components:
1292
1698
  properties:
1293
1699
  txid:
1294
1700
  type: string
1701
+ examples:
1702
+ - "ab69c16801e6ea2bb78bde521c6e3654f7e665d0900e4236b5945e47a1482d3c"
1295
1703
  satoshis:
1296
1704
  type: number
1705
+ examples:
1706
+ - 1
1297
1707
  status:
1298
1708
  type: string
1299
- enum: [completed, unprocessed, sending, unproven, unsigned, nosend, nonfinal]
1709
+ enum:
1710
+ [
1711
+ completed,
1712
+ unprocessed,
1713
+ sending,
1714
+ unproven,
1715
+ unsigned,
1716
+ nosend,
1717
+ nonfinal,
1718
+ ]
1300
1719
  isOutgoing:
1301
1720
  type: boolean
1302
1721
  description:
1303
1722
  type: string
1723
+ examples:
1724
+ - "The creation of a token which captures an item of a todo list."
1304
1725
  labels:
1305
1726
  type: array
1727
+ examples:
1728
+ - ["todo create"]
1306
1729
  items:
1307
1730
  type: string
1308
1731
  version:
1309
1732
  type: number
1733
+ examples:
1734
+ - 1
1310
1735
  lockTime:
1311
1736
  type: number
1312
1737
  inputs:
1313
1738
  type: array
1314
1739
  items:
1315
- $ref: '#/components/schemas/WalletActionInput'
1740
+ $ref: "#/components/schemas/WalletActionInput"
1316
1741
  outputs:
1317
1742
  type: array
1318
1743
  items:
1319
- $ref: '#/components/schemas/WalletActionOutput'
1744
+ $ref: "#/components/schemas/WalletActionOutput"
1320
1745
  WalletActionInput:
1321
1746
  type: object
1322
1747
  properties:
1323
1748
  sourceOutpoint:
1324
1749
  type: string
1750
+ examples:
1751
+ - "50e7365af507f6c862b6ca77cef2571ae63544bcd8e19c3c2abc44b20d0aeb6c.3"
1325
1752
  sourceSatoshis:
1326
1753
  type: number
1754
+ examples:
1755
+ - 4000
1327
1756
  sourceLockingScript:
1328
1757
  type: string
1758
+ examples:
1759
+ - "76a9144f427ee5f3099f0ac571f6b723a628e7b08fb64c88ac"
1329
1760
  unlockingScript:
1330
1761
  type: string
1762
+ examples:
1763
+ - "47304402200aa56a892e310a7575035fb3c0bcf4..."
1331
1764
  inputDescription:
1332
1765
  type: string
1766
+ examples:
1767
+ - "spending of a token of some sort"
1333
1768
  sequenceNumber:
1334
1769
  type: number
1770
+ examples:
1771
+ - 4294967295
1335
1772
  WalletActionOutput:
1336
1773
  type: object
1337
1774
  properties:
1338
1775
  satoshis:
1339
1776
  type: number
1777
+ examples:
1778
+ - 1000
1340
1779
  lockingScript:
1341
1780
  type: string
1781
+ examples:
1782
+ - "76a914dd8b1abde0304820ace0adf1478a3ef2291a833788ac"
1342
1783
  spendable:
1343
1784
  type: boolean
1344
1785
  customInstructions:
1345
1786
  type: string
1787
+ examples:
1788
+ - "invoice5678,keyId2,02ffc4f361307f34a82069edbcbe2c9f4bd5498165549f42bdeb698ffdcab1ea38"
1346
1789
  tags:
1347
1790
  type: array
1791
+ examples:
1792
+ - ["todo create", "productivity"]
1348
1793
  items:
1349
1794
  type: string
1350
1795
  outputIndex:
1351
1796
  type: number
1797
+ examples:
1798
+ - 0
1352
1799
  outputDescription:
1353
1800
  type: string
1801
+ examples:
1802
+ - "a special token of some description"
1354
1803
  basket:
1355
1804
  type: string
1805
+ examples:
1806
+ - "todo token"
1356
1807
  WalletOutput:
1357
1808
  type: object
1358
1809
  properties:
@@ -1376,74 +1827,134 @@ components:
1376
1827
  type: string
1377
1828
  BasketStringUnder300Bytes:
1378
1829
  type: string
1830
+ examples:
1831
+ - "todo token"
1379
1832
  OutpointString:
1380
1833
  type: string
1834
+ examples:
1835
+ - "ae9b36d2bad995e5cd9a12e73d02140c163a7932fa37b927de1f031410dbd751.0"
1381
1836
  AcquireCertificateArgs:
1382
1837
  type: object
1383
1838
  properties:
1384
1839
  certifier:
1385
1840
  type: string
1841
+ examples:
1842
+ - "035836f24728af22bdeb3524c35b2e6c6126a45587dd11fcab826c054e170f97b8"
1386
1843
  type:
1387
1844
  type: string
1388
- attributes:
1845
+ examples:
1846
+ - "W/iqV/xaa8VH3s8cxttj8Q3rVaPGxd9JfWMfs9leGr8="
1847
+ fields:
1389
1848
  type: object
1849
+ examples:
1850
+ - firstName: "Michael"
1851
+ lastName: "Huntington"
1852
+ dob: "12/12/2001"
1390
1853
  additionalProperties:
1391
1854
  type: string
1392
1855
  privilegedReason:
1393
1856
  type: string
1857
+ examples:
1858
+ - "-"
1394
1859
  privileged:
1395
1860
  type: boolean
1396
1861
  default: false
1397
- AcquireCertificateResult:
1862
+ Certificate:
1398
1863
  type: object
1399
1864
  properties:
1400
- certifier:
1401
- type: string
1402
1865
  type:
1403
1866
  type: string
1867
+ examples:
1868
+ - "W/iqV/xaa8VH3s8cxttj8Q3rVaPGxd9JfWMfs9leGr8="
1869
+ subject:
1870
+ type: string
1871
+ examples:
1872
+ - "02d292971b665575c90e8183e20d7c528e2ec1734fcb9f69c7e65e5046596767f3"
1404
1873
  serialNumber:
1405
1874
  type: string
1406
- attributes:
1875
+ examples:
1876
+ - "6d4U5qznZnQmWJF3sEqKXsi5pB8sUhD0MWcadrxzKas="
1877
+ certifier:
1878
+ type: string
1879
+ examples:
1880
+ - "035836f24728af22bdeb3524c35b2e6c6126a45587dd11fcab826c054e170f97b8"
1881
+ revocationOutput:
1882
+ type: string
1883
+ examples:
1884
+ - "e38a285d99d8a70448240255b5e92090bef87d7c5abab34a1263966fcde40621.3"
1885
+ signature:
1886
+ type: string
1887
+ examples:
1888
+ - "30450221008a9e150a43dc22652f4b627d08cae1d..."
1889
+ fields:
1407
1890
  type: object
1891
+ examples:
1892
+ - firstName: "Michael"
1893
+ lastName: "Huntington"
1894
+ dob: "12/12/2001"
1408
1895
  additionalProperties:
1409
1896
  type: string
1410
- issuanceTime:
1411
- type: string
1412
- expirationTime:
1413
- type: string
1414
1897
  ListCertificatesResult:
1415
1898
  type: object
1416
1899
  properties:
1417
1900
  totalCertificates:
1418
1901
  type: number
1902
+ examples:
1903
+ - 1
1419
1904
  certificates:
1420
1905
  type: array
1421
1906
  items:
1422
- $ref: '#/components/schemas/AcquireCertificateResult'
1907
+ $ref: "#/components/schemas/Certificate"
1423
1908
  ProveCertificateArgs:
1424
1909
  type: object
1425
1910
  properties:
1426
- certifier:
1427
- type: string
1428
- type:
1429
- type: string
1430
- serialNumber:
1431
- type: string
1432
- proof:
1911
+ certificate:
1912
+ $ref: "#/components/schemas/Certificate"
1913
+ fieldsToReveal:
1433
1914
  type: array
1434
1915
  items:
1435
- type: integer
1916
+ type: string
1917
+ examples:
1918
+ - "dob"
1919
+ verifier:
1920
+ type: string
1921
+ examples:
1922
+ - "02a3ffa2ea5db22192aed65131a6683c0f626fb35a8c717c783587e08a4daec380"
1923
+ privileged:
1924
+ type: boolean
1925
+ default: false
1926
+ privilegedReason:
1927
+ type: string
1928
+ examples:
1929
+ - "-"
1436
1930
  ProveCertificateResult:
1437
1931
  type: object
1438
1932
  properties:
1439
- valid:
1440
- type: boolean
1933
+ keyringForVerifier:
1934
+ type: object
1935
+ examples:
1936
+ - firstName: "ZGF2aWQ="
1937
+ lastName: "SW52ZXJuZXNz"
1938
+ dob: "MTIvMTIvMTk4OA=="
1939
+ additionalProperties:
1940
+ type: string
1441
1941
  DiscoverCertificatesResult:
1442
1942
  type: object
1443
1943
  properties:
1444
1944
  totalCertificates:
1445
1945
  type: number
1946
+ examples:
1947
+ - 1
1446
1948
  certificates:
1447
1949
  type: array
1448
1950
  items:
1449
- $ref: '#/components/schemas/AcquireCertificateResult'
1951
+ $ref: "#/components/schemas/Certificate"
1952
+ ProtocolID:
1953
+ type: array
1954
+ examples:
1955
+ - [0, "todo token"]
1956
+ prefixItems:
1957
+ - type: integer
1958
+ - type: string
1959
+ minItems: 2
1960
+ maxItems: 2