@bsv/sdk 1.6.12 → 1.6.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 (82) hide show
  1. package/README.md +4 -4
  2. package/dist/cjs/package.json +1 -1
  3. package/dist/cjs/src/transaction/broadcasters/DefaultBroadcaster.js +1 -1
  4. package/dist/cjs/src/transaction/broadcasters/DefaultBroadcaster.js.map +1 -1
  5. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  6. package/dist/esm/src/transaction/broadcasters/DefaultBroadcaster.js +1 -1
  7. package/dist/esm/src/transaction/broadcasters/DefaultBroadcaster.js.map +1 -1
  8. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  9. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  10. package/dist/umd/bundle.js +1 -1
  11. package/docs/MARKDOWN_VALIDATION_GUIDE.md +175 -0
  12. package/docs/concepts/beef.md +8 -0
  13. package/docs/concepts/chain-tracking.md +12 -0
  14. package/docs/concepts/decentralized-identity.md +37 -0
  15. package/docs/concepts/fees.md +32 -0
  16. package/docs/concepts/identity-certificates.md +53 -1
  17. package/docs/concepts/index.md +15 -0
  18. package/docs/concepts/key-management.md +9 -0
  19. package/docs/concepts/script-templates.md +13 -0
  20. package/docs/concepts/sdk-philosophy.md +8 -0
  21. package/docs/concepts/signatures.md +15 -0
  22. package/docs/concepts/spv-verification.md +12 -0
  23. package/docs/concepts/transaction-encoding.md +19 -0
  24. package/docs/concepts/transaction-structure.md +4 -0
  25. package/docs/concepts/trust-model.md +16 -0
  26. package/docs/concepts/verification.md +31 -0
  27. package/docs/concepts/wallet-integration.md +6 -0
  28. package/docs/guides/development-wallet-setup.md +374 -0
  29. package/docs/guides/direct-transaction-creation.md +12 -2
  30. package/docs/guides/http-client-configuration.md +122 -48
  31. package/docs/guides/index.md +117 -9
  32. package/docs/guides/large-transactions.md +448 -0
  33. package/docs/guides/multisig-transactions.md +792 -0
  34. package/docs/guides/security-best-practices.md +494 -0
  35. package/docs/guides/transaction-batching.md +132 -0
  36. package/docs/guides/transaction-signing-methods.md +230 -79
  37. package/docs/index.md +0 -2
  38. package/docs/reference/auth.md +212 -159
  39. package/docs/reference/compat.md +120 -96
  40. package/docs/reference/configuration.md +6 -0
  41. package/docs/reference/debugging.md +5 -0
  42. package/docs/reference/errors.md +50 -0
  43. package/docs/reference/identity.md +21 -12
  44. package/docs/reference/index.md +14 -1
  45. package/docs/reference/kvstore.md +21 -19
  46. package/docs/reference/messages.md +3 -0
  47. package/docs/reference/op-codes.md +20 -1
  48. package/docs/reference/overlay-tools.md +46 -18
  49. package/docs/reference/primitives.md +571 -390
  50. package/docs/reference/registry.md +43 -20
  51. package/docs/reference/script.md +140 -105
  52. package/docs/reference/storage.md +32 -12
  53. package/docs/reference/totp.md +16 -11
  54. package/docs/reference/transaction-signatures.md +2 -1
  55. package/docs/reference/transaction.md +201 -120
  56. package/docs/reference/wallet.md +241 -64
  57. package/docs/tutorials/advanced-transaction.md +1 -4
  58. package/docs/tutorials/aes-encryption.md +3 -1
  59. package/docs/tutorials/authfetch-tutorial.md +29 -0
  60. package/docs/tutorials/ecdh-key-exchange.md +2 -0
  61. package/docs/tutorials/elliptic-curve-fundamentals.md +3 -0
  62. package/docs/tutorials/error-handling.md +1 -0
  63. package/docs/tutorials/first-transaction-low-level.md +1 -0
  64. package/docs/tutorials/first-transaction.md +5 -8
  65. package/docs/tutorials/hashes-and-hmacs.md +5 -31
  66. package/docs/tutorials/identity-management.md +27 -0
  67. package/docs/tutorials/index.md +114 -77
  68. package/docs/tutorials/key-management.md +5 -3
  69. package/docs/tutorials/protowallet-development.md +27 -0
  70. package/docs/tutorials/spv-merkle-proofs.md +9 -6
  71. package/docs/tutorials/testnet-transactions-low-level.md +25 -18
  72. package/docs/tutorials/transaction-broadcasting.md +10 -7
  73. package/docs/tutorials/transaction-types.md +5 -4
  74. package/docs/tutorials/type-42.md +0 -14
  75. package/docs/tutorials/uhrp-storage.md +23 -3
  76. package/package.json +1 -1
  77. package/src/identity/README.md +0 -1
  78. package/src/primitives/__tests/SymmetricKey.test.ts +45 -0
  79. package/src/primitives/__tests/SymmetricKeyCompatibility.test.ts +150 -0
  80. package/src/transaction/__tests/Transaction.test.ts +1 -1
  81. package/src/transaction/broadcasters/DefaultBroadcaster.ts +1 -1
  82. package/src/transaction/broadcasters/__tests/ARC.test.ts +1 -1
@@ -49,6 +49,7 @@ See also: [Base64String](./wallet.md#type-base64string)
49
49
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
50
50
 
51
51
  ---
52
+
52
53
  ### Interface: AbortActionResult
53
54
 
54
55
  ```ts
@@ -60,6 +61,7 @@ export interface AbortActionResult {
60
61
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
61
62
 
62
63
  ---
64
+
63
65
  ### Interface: AcquireCertificateArgs
64
66
 
65
67
  ```ts
@@ -84,6 +86,7 @@ See also: [AcquisitionProtocol](./wallet.md#type-acquisitionprotocol), [Base64St
84
86
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
85
87
 
86
88
  ---
89
+
87
90
  ### Interface: AuthenticatedResult
88
91
 
89
92
  ```ts
@@ -95,6 +98,7 @@ export interface AuthenticatedResult {
95
98
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
96
99
 
97
100
  ---
101
+
98
102
  ### Interface: BasketInsertion
99
103
 
100
104
  ```ts
@@ -110,6 +114,7 @@ See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes
110
114
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
111
115
 
112
116
  ---
117
+
113
118
  ### Interface: CertificateResult
114
119
 
115
120
  ```ts
@@ -124,6 +129,7 @@ See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUn
124
129
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
125
130
 
126
131
  ---
132
+
127
133
  ### Interface: CreateActionArgs
128
134
 
129
135
  ```ts
@@ -144,6 +150,7 @@ See also: [BEEF](./wallet.md#type-beef), [CreateActionInput](./wallet.md#interfa
144
150
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
145
151
 
146
152
  ---
153
+
147
154
  ### Interface: CreateActionInput
148
155
 
149
156
  ```ts
@@ -161,6 +168,7 @@ See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50b
161
168
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
162
169
 
163
170
  ---
171
+
164
172
  ### Interface: CreateActionOptions
165
173
 
166
174
  ```ts
@@ -182,6 +190,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanD
182
190
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
183
191
 
184
192
  ---
193
+
185
194
  ### Interface: CreateActionOutput
186
195
 
187
196
  ```ts
@@ -200,6 +209,7 @@ See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes
200
209
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
201
210
 
202
211
  ---
212
+
203
213
  ### Interface: CreateActionResult
204
214
 
205
215
  ```ts
@@ -217,6 +227,7 @@ See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [OutpointString](./wallet.m
217
227
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
218
228
 
219
229
  ---
230
+
220
231
  ### Interface: CreateHmacArgs
221
232
 
222
233
  ```ts
@@ -230,6 +241,7 @@ See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#inte
230
241
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
231
242
 
232
243
  ---
244
+
233
245
  ### Interface: CreateHmacResult
234
246
 
235
247
  ```ts
@@ -243,6 +255,7 @@ See also: [Byte](./wallet.md#type-byte)
243
255
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
244
256
 
245
257
  ---
258
+
246
259
  ### Interface: CreateSignatureArgs
247
260
 
248
261
  ```ts
@@ -257,6 +270,7 @@ See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#inte
257
270
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
258
271
 
259
272
  ---
273
+
260
274
  ### Interface: CreateSignatureResult
261
275
 
262
276
  ```ts
@@ -270,6 +284,7 @@ See also: [Byte](./wallet.md#type-byte)
270
284
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
271
285
 
272
286
  ---
287
+
273
288
  ### Interface: DiscoverByAttributesArgs
274
289
 
275
290
  ```ts
@@ -286,6 +301,7 @@ See also: [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Certificat
286
301
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
287
302
 
288
303
  ---
304
+
289
305
  ### Interface: DiscoverByIdentityKeyArgs
290
306
 
291
307
  ```ts
@@ -302,6 +318,7 @@ See also: [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [PositiveIn
302
318
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
303
319
 
304
320
  ---
321
+
305
322
  ### Interface: DiscoverCertificatesResult
306
323
 
307
324
  ```ts
@@ -316,6 +333,7 @@ See also: [IdentityCertificate](./wallet.md#interface-identitycertificate), [Pos
316
333
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
317
334
 
318
335
  ---
336
+
319
337
  ### Interface: GetHeaderArgs
320
338
 
321
339
  ```ts
@@ -329,6 +347,7 @@ See also: [PositiveInteger](./wallet.md#type-positiveinteger)
329
347
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
330
348
 
331
349
  ---
350
+
332
351
  ### Interface: GetHeaderResult
333
352
 
334
353
  ```ts
@@ -342,6 +361,7 @@ See also: [HexString](./wallet.md#type-hexstring)
342
361
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
343
362
 
344
363
  ---
364
+
345
365
  ### Interface: GetHeightResult
346
366
 
347
367
  ```ts
@@ -355,6 +375,7 @@ See also: [PositiveInteger](./wallet.md#type-positiveinteger)
355
375
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
356
376
 
357
377
  ---
378
+
358
379
  ### Interface: GetNetworkResult
359
380
 
360
381
  ```ts
@@ -368,6 +389,7 @@ See also: [WalletNetwork](./wallet.md#type-walletnetwork)
368
389
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
369
390
 
370
391
  ---
392
+
371
393
  ### Interface: GetPublicKeyArgs
372
394
 
373
395
  When `identityKey` is true, `WalletEncryptionArgs` are not used.
@@ -386,6 +408,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [WalletEn
386
408
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
387
409
 
388
410
  ---
411
+
389
412
  ### Interface: GetPublicKeyResult
390
413
 
391
414
  ```ts
@@ -399,6 +422,7 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
399
422
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
400
423
 
401
424
  ---
425
+
402
426
  ### Interface: GetVersionResult
403
427
 
404
428
  ```ts
@@ -412,6 +436,7 @@ See also: [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes)
412
436
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
413
437
 
414
438
  ---
439
+
415
440
  ### Interface: IdentityCertificate
416
441
 
417
442
  ```ts
@@ -427,6 +452,7 @@ See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUn
427
452
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
428
453
 
429
454
  ---
455
+
430
456
  ### Interface: IdentityCertifier
431
457
 
432
458
  ```ts
@@ -443,6 +469,7 @@ See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50b
443
469
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
444
470
 
445
471
  ---
472
+
446
473
  ### Interface: InternalizeActionArgs
447
474
 
448
475
  ```ts
@@ -460,6 +487,7 @@ See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [BooleanDefaultTrue](./wall
460
487
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
461
488
 
462
489
  ---
490
+
463
491
  ### Interface: InternalizeActionResult
464
492
 
465
493
  ```ts
@@ -471,6 +499,7 @@ export interface InternalizeActionResult {
471
499
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
472
500
 
473
501
  ---
502
+
474
503
  ### Interface: InternalizeOutput
475
504
 
476
505
  ```ts
@@ -487,6 +516,7 @@ See also: [BasketInsertion](./wallet.md#interface-basketinsertion), [PositiveInt
487
516
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
488
517
 
489
518
  ---
519
+
490
520
  ### Interface: KeyDeriverApi
491
521
 
492
522
  ```ts
@@ -510,6 +540,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
510
540
  ```ts
511
541
  derivePrivateKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => PrivateKey
512
542
  ```
543
+
513
544
  See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
514
545
 
515
546
  #### Property derivePublicKey
@@ -519,6 +550,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
519
550
  ```ts
520
551
  derivePublicKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean) => PublicKey
521
552
  ```
553
+
522
554
  See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
523
555
 
524
556
  #### Property deriveSymmetricKey
@@ -529,6 +561,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
529
561
  ```ts
530
562
  deriveSymmetricKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => SymmetricKey
531
563
  ```
564
+
532
565
  See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
533
566
 
534
567
  #### Property identityKey
@@ -547,6 +580,7 @@ Note: This should not be used for 'self'.
547
580
  ```ts
548
581
  revealCounterpartySecret: (counterparty: Counterparty) => number[]
549
582
  ```
583
+
550
584
  See also: [Counterparty](./wallet.md#type-counterparty)
551
585
 
552
586
  #### Property revealSpecificSecret
@@ -556,6 +590,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
556
590
  ```ts
557
591
  revealSpecificSecret: (counterparty: Counterparty, protocolID: WalletProtocol, keyID: string) => number[]
558
592
  ```
593
+
559
594
  See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
560
595
 
561
596
  #### Property rootKey
@@ -565,11 +600,13 @@ The root key from which all other keys are derived.
565
600
  ```ts
566
601
  rootKey: PrivateKey
567
602
  ```
603
+
568
604
  See also: [PrivateKey](./primitives.md#class-privatekey)
569
605
 
570
606
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
571
607
 
572
608
  ---
609
+
573
610
  ### Interface: KeyLinkageResult
574
611
 
575
612
  ```ts
@@ -587,6 +624,7 @@ See also: [Byte](./wallet.md#type-byte), [PubKeyHex](./wallet.md#type-pubkeyhex)
587
624
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
588
625
 
589
626
  ---
627
+
590
628
  ### Interface: ListActionsArgs
591
629
 
592
630
  ```ts
@@ -610,6 +648,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanD
610
648
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
611
649
 
612
650
  ---
651
+
613
652
  ### Interface: ListActionsResult
614
653
 
615
654
  ```ts
@@ -624,6 +663,7 @@ See also: [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [Wall
624
663
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
625
664
 
626
665
  ---
666
+
627
667
  ### Interface: ListCertificatesArgs
628
668
 
629
669
  ```ts
@@ -642,6 +682,7 @@ See also: [Base64String](./wallet.md#type-base64string), [BooleanDefaultFalse](.
642
682
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
643
683
 
644
684
  ---
685
+
645
686
  ### Interface: ListCertificatesResult
646
687
 
647
688
  ```ts
@@ -656,6 +697,7 @@ See also: [CertificateResult](./wallet.md#interface-certificateresult), [Positiv
656
697
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
657
698
 
658
699
  ---
700
+
659
701
  ### Interface: ListOutputsArgs
660
702
 
661
703
  ```ts
@@ -678,6 +720,7 @@ See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes
678
720
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
679
721
 
680
722
  ---
723
+
681
724
  ### Interface: ListOutputsResult
682
725
 
683
726
  ```ts
@@ -693,6 +736,7 @@ See also: [BEEF](./wallet.md#type-beef), [PositiveIntegerOrZero](./wallet.md#typ
693
736
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
694
737
 
695
738
  ---
739
+
696
740
  ### Interface: ProveCertificateArgs
697
741
 
698
742
  ```ts
@@ -710,6 +754,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Certific
710
754
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
711
755
 
712
756
  ---
757
+
713
758
  ### Interface: ProveCertificateResult
714
759
 
715
760
  ```ts
@@ -725,6 +770,7 @@ See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUn
725
770
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
726
771
 
727
772
  ---
773
+
728
774
  ### Interface: RelinquishCertificateArgs
729
775
 
730
776
  ```ts
@@ -740,6 +786,7 @@ See also: [Base64String](./wallet.md#type-base64string), [PubKeyHex](./wallet.md
740
786
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
741
787
 
742
788
  ---
789
+
743
790
  ### Interface: RelinquishCertificateResult
744
791
 
745
792
  ```ts
@@ -751,6 +798,7 @@ export interface RelinquishCertificateResult {
751
798
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
752
799
 
753
800
  ---
801
+
754
802
  ### Interface: RelinquishOutputArgs
755
803
 
756
804
  ```ts
@@ -765,6 +813,7 @@ See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes
765
813
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
766
814
 
767
815
  ---
816
+
768
817
  ### Interface: RelinquishOutputResult
769
818
 
770
819
  ```ts
@@ -776,6 +825,7 @@ export interface RelinquishOutputResult {
776
825
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
777
826
 
778
827
  ---
828
+
779
829
  ### Interface: RevealCounterpartyKeyLinkageArgs
780
830
 
781
831
  ```ts
@@ -792,6 +842,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Descript
792
842
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
793
843
 
794
844
  ---
845
+
795
846
  ### Interface: RevealCounterpartyKeyLinkageResult
796
847
 
797
848
  ```ts
@@ -805,6 +856,7 @@ See also: [ISOTimestampString](./wallet.md#type-isotimestampstring), [KeyLinkage
805
856
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
806
857
 
807
858
  ---
859
+
808
860
  ### Interface: RevealSpecificKeyLinkageArgs
809
861
 
810
862
  ```ts
@@ -823,6 +875,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Descript
823
875
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
824
876
 
825
877
  ---
878
+
826
879
  ### Interface: RevealSpecificKeyLinkageResult
827
880
 
828
881
  ```ts
@@ -838,6 +891,7 @@ See also: [Byte](./wallet.md#type-byte), [KeyIDStringUnder800Bytes](./wallet.md#
838
891
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
839
892
 
840
893
  ---
894
+
841
895
  ### Interface: ReviewActionResult
842
896
 
843
897
  ```ts
@@ -870,6 +924,7 @@ competingTxs?: string[]
870
924
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
871
925
 
872
926
  ---
927
+
873
928
  ### Interface: SendWithResult
874
929
 
875
930
  ```ts
@@ -884,6 +939,7 @@ See also: [SendWithResultStatus](./wallet.md#type-sendwithresultstatus), [TXIDHe
884
939
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
885
940
 
886
941
  ---
942
+
887
943
  ### Interface: SignActionArgs
888
944
 
889
945
  ```ts
@@ -899,6 +955,7 @@ See also: [Base64String](./wallet.md#type-base64string), [PositiveIntegerOrZero]
899
955
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
900
956
 
901
957
  ---
958
+
902
959
  ### Interface: SignActionOptions
903
960
 
904
961
  ```ts
@@ -915,6 +972,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanD
915
972
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
916
973
 
917
974
  ---
975
+
918
976
  ### Interface: SignActionResult
919
977
 
920
978
  ```ts
@@ -930,6 +988,7 @@ See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [SendWithResult](./wallet.m
930
988
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
931
989
 
932
990
  ---
991
+
933
992
  ### Interface: SignActionSpend
934
993
 
935
994
  ```ts
@@ -944,6 +1003,7 @@ See also: [HexString](./wallet.md#type-hexstring), [PositiveIntegerOrZero](./wal
944
1003
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
945
1004
 
946
1005
  ---
1006
+
947
1007
  ### Interface: SignableTransaction
948
1008
 
949
1009
  ```ts
@@ -958,6 +1018,7 @@ See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [Base64String](./wallet.md#
958
1018
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
959
1019
 
960
1020
  ---
1021
+
961
1022
  ### Interface: VerifyHmacArgs
962
1023
 
963
1024
  ```ts
@@ -972,6 +1033,7 @@ See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#inte
972
1033
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
973
1034
 
974
1035
  ---
1036
+
975
1037
  ### Interface: VerifyHmacResult
976
1038
 
977
1039
  ```ts
@@ -983,6 +1045,7 @@ export interface VerifyHmacResult {
983
1045
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
984
1046
 
985
1047
  ---
1048
+
986
1049
  ### Interface: VerifySignatureArgs
987
1050
 
988
1051
  ```ts
@@ -999,6 +1062,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Byte](./
999
1062
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1000
1063
 
1001
1064
  ---
1065
+
1002
1066
  ### Interface: VerifySignatureResult
1003
1067
 
1004
1068
  ```ts
@@ -1010,6 +1074,7 @@ export interface VerifySignatureResult {
1010
1074
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1011
1075
 
1012
1076
  ---
1077
+
1013
1078
  ### Interface: WalletAction
1014
1079
 
1015
1080
  ```ts
@@ -1032,6 +1097,7 @@ See also: [ActionStatus](./wallet.md#type-actionstatus), [DescriptionString5to50
1032
1097
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1033
1098
 
1034
1099
  ---
1100
+
1035
1101
  ### Interface: WalletActionInput
1036
1102
 
1037
1103
  ```ts
@@ -1050,6 +1116,7 @@ See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50b
1050
1116
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1051
1117
 
1052
1118
  ---
1119
+
1053
1120
  ### Interface: WalletActionOutput
1054
1121
 
1055
1122
  ```ts
@@ -1070,6 +1137,7 @@ See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes
1070
1137
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1071
1138
 
1072
1139
  ---
1140
+
1073
1141
  ### Interface: WalletCertificate
1074
1142
 
1075
1143
  ```ts
@@ -1089,6 +1157,7 @@ See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUn
1089
1157
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1090
1158
 
1091
1159
  ---
1160
+
1092
1161
  ### Interface: WalletDecryptArgs
1093
1162
 
1094
1163
  ```ts
@@ -1102,6 +1171,7 @@ See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#inte
1102
1171
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1103
1172
 
1104
1173
  ---
1174
+
1105
1175
  ### Interface: WalletDecryptResult
1106
1176
 
1107
1177
  ```ts
@@ -1115,6 +1185,7 @@ See also: [Byte](./wallet.md#type-byte)
1115
1185
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1116
1186
 
1117
1187
  ---
1188
+
1118
1189
  ### Interface: WalletEncryptArgs
1119
1190
 
1120
1191
  ```ts
@@ -1128,6 +1199,7 @@ See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#inte
1128
1199
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1129
1200
 
1130
1201
  ---
1202
+
1131
1203
  ### Interface: WalletEncryptResult
1132
1204
 
1133
1205
  ```ts
@@ -1141,6 +1213,7 @@ See also: [Byte](./wallet.md#type-byte)
1141
1213
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1142
1214
 
1143
1215
  ---
1216
+
1144
1217
  ### Interface: WalletEncryptionArgs
1145
1218
 
1146
1219
  ```ts
@@ -1159,6 +1232,7 @@ See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanD
1159
1232
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1160
1233
 
1161
1234
  ---
1235
+
1162
1236
  ### Interface: WalletErrorObject
1163
1237
 
1164
1238
  Every method of the `Wallet` interface has a return value of the form `Promise<object>`.
@@ -1175,6 +1249,7 @@ export interface WalletErrorObject extends Error {
1175
1249
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1176
1250
 
1177
1251
  ---
1252
+
1178
1253
  ### Interface: WalletInterface
1179
1254
 
1180
1255
  The Wallet interface defines a wallet capable of various tasks including transaction creation and signing,
@@ -1231,6 +1306,7 @@ Aborts a transaction that is in progress and has not yet been finalized or sent
1231
1306
  ```ts
1232
1307
  abortAction: (args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AbortActionResult>
1233
1308
  ```
1309
+
1234
1310
  See also: [AbortActionArgs](./wallet.md#interface-abortactionargs), [AbortActionResult](./wallet.md#interface-abortactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1235
1311
 
1236
1312
  #### Property acquireCertificate
@@ -1240,6 +1316,7 @@ Acquires an identity certificate, whether by acquiring one from the certifier or
1240
1316
  ```ts
1241
1317
  acquireCertificate: (args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletCertificate>
1242
1318
  ```
1319
+
1243
1320
  See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletCertificate](./wallet.md#interface-walletcertificate)
1244
1321
 
1245
1322
  #### Property createAction
@@ -1249,6 +1326,7 @@ Creates a new Bitcoin transaction based on the provided inputs, outputs, labels,
1249
1326
  ```ts
1250
1327
  createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateActionResult>
1251
1328
  ```
1329
+
1252
1330
  See also: [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1253
1331
 
1254
1332
  #### Property createHmac
@@ -1258,6 +1336,7 @@ Creates an HMAC (Hash-based Message Authentication Code) based on the provided d
1258
1336
  ```ts
1259
1337
  createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
1260
1338
  ```
1339
+
1261
1340
  See also: [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1262
1341
 
1263
1342
  #### Property createSignature
@@ -1267,6 +1346,7 @@ Creates a digital signature for the provided data or hash using a specific proto
1267
1346
  ```ts
1268
1347
  createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
1269
1348
  ```
1349
+
1270
1350
  See also: [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1271
1351
 
1272
1352
  #### Property decrypt
@@ -1276,6 +1356,7 @@ Decrypts the provided ciphertext using derived keys, based on the protocol ID, k
1276
1356
  ```ts
1277
1357
  decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
1278
1358
  ```
1359
+
1279
1360
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult)
1280
1361
 
1281
1362
  #### Property discoverByAttributes
@@ -1285,6 +1366,7 @@ Discovers identity certificates belonging to other users, where the documents co
1285
1366
  ```ts
1286
1367
  discoverByAttributes: (args: DiscoverByAttributesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
1287
1368
  ```
1369
+
1288
1370
  See also: [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1289
1371
 
1290
1372
  #### Property discoverByIdentityKey
@@ -1294,6 +1376,7 @@ Discovers identity certificates, issued to a given identity key by a trusted ent
1294
1376
  ```ts
1295
1377
  discoverByIdentityKey: (args: DiscoverByIdentityKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
1296
1378
  ```
1379
+
1297
1380
  See also: [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1298
1381
 
1299
1382
  #### Property encrypt
@@ -1303,6 +1386,7 @@ Encrypts the provided plaintext data using derived keys, based on the protocol I
1303
1386
  ```ts
1304
1387
  encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
1305
1388
  ```
1389
+
1306
1390
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult)
1307
1391
 
1308
1392
  #### Property getHeaderForHeight
@@ -1312,6 +1396,7 @@ Retrieves the block header of a block at a specified height.
1312
1396
  ```ts
1313
1397
  getHeaderForHeight: (args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeaderResult>
1314
1398
  ```
1399
+
1315
1400
  See also: [GetHeaderArgs](./wallet.md#interface-getheaderargs), [GetHeaderResult](./wallet.md#interface-getheaderresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1316
1401
 
1317
1402
  #### Property getHeight
@@ -1321,6 +1406,7 @@ Retrieves the current height of the blockchain.
1321
1406
  ```ts
1322
1407
  getHeight: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeightResult>
1323
1408
  ```
1409
+
1324
1410
  See also: [GetHeightResult](./wallet.md#interface-getheightresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1325
1411
 
1326
1412
  #### Property getNetwork
@@ -1330,6 +1416,7 @@ Retrieves the Bitcoin network the client is using (mainnet or testnet).
1330
1416
  ```ts
1331
1417
  getNetwork: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetNetworkResult>
1332
1418
  ```
1419
+
1333
1420
  See also: [GetNetworkResult](./wallet.md#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1334
1421
 
1335
1422
  #### Property getPublicKey
@@ -1339,6 +1426,7 @@ Retrieves a derived or identity public key based on the requested protocol, key
1339
1426
  ```ts
1340
1427
  getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
1341
1428
  ```
1429
+
1342
1430
  See also: [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetPublicKeyResult](./wallet.md#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1343
1431
 
1344
1432
  #### Property getVersion
@@ -1348,6 +1436,7 @@ Retrieves the current version string of the wallet.
1348
1436
  ```ts
1349
1437
  getVersion: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetVersionResult>
1350
1438
  ```
1439
+
1351
1440
  See also: [GetVersionResult](./wallet.md#interface-getversionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1352
1441
 
1353
1442
  #### Property internalizeAction
@@ -1357,6 +1446,7 @@ Submits a transaction to be internalized and optionally labeled, outputs paid to
1357
1446
  ```ts
1358
1447
  internalizeAction: (args: InternalizeActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<InternalizeActionResult>
1359
1448
  ```
1449
+
1360
1450
  See also: [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1361
1451
 
1362
1452
  #### Property isAuthenticated
@@ -1366,6 +1456,7 @@ Checks the authentication status of the user.
1366
1456
  ```ts
1367
1457
  isAuthenticated: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
1368
1458
  ```
1459
+
1369
1460
  See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1370
1461
 
1371
1462
  #### Property listActions
@@ -1375,6 +1466,7 @@ Lists all transactions matching the specified labels.
1375
1466
  ```ts
1376
1467
  listActions: (args: ListActionsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListActionsResult>
1377
1468
  ```
1469
+
1378
1470
  See also: [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1379
1471
 
1380
1472
  #### Property listCertificates
@@ -1384,6 +1476,7 @@ Lists identity certificates belonging to the user, filtered by certifier(s) and
1384
1476
  ```ts
1385
1477
  listCertificates: (args: ListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListCertificatesResult>
1386
1478
  ```
1479
+
1387
1480
  See also: [ListCertificatesArgs](./wallet.md#interface-listcertificatesargs), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1388
1481
 
1389
1482
  #### Property listOutputs
@@ -1393,6 +1486,7 @@ Lists the spendable outputs kept within a specific basket, optionally tagged wit
1393
1486
  ```ts
1394
1487
  listOutputs: (args: ListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListOutputsResult>
1395
1488
  ```
1489
+
1396
1490
  See also: [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1397
1491
 
1398
1492
  #### Property proveCertificate
@@ -1402,6 +1496,7 @@ Proves select fields of an identity certificate, as specified, when requested by
1402
1496
  ```ts
1403
1497
  proveCertificate: (args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ProveCertificateResult>
1404
1498
  ```
1499
+
1405
1500
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult)
1406
1501
 
1407
1502
  #### Property relinquishCertificate
@@ -1411,6 +1506,7 @@ Relinquishes an identity certificate, removing it from the wallet regardless of
1411
1506
  ```ts
1412
1507
  relinquishCertificate: (args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishCertificateResult>
1413
1508
  ```
1509
+
1414
1510
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RelinquishCertificateArgs](./wallet.md#interface-relinquishcertificateargs), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult)
1415
1511
 
1416
1512
  #### Property relinquishOutput
@@ -1420,6 +1516,7 @@ Relinquish an output out of a basket, removing it from tracking without spending
1420
1516
  ```ts
1421
1517
  relinquishOutput: (args: RelinquishOutputArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishOutputResult>
1422
1518
  ```
1519
+
1423
1520
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](./wallet.md#interface-relinquishoutputargs), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult)
1424
1521
 
1425
1522
  #### Property revealCounterpartyKeyLinkage
@@ -1429,6 +1526,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
1429
1526
  ```ts
1430
1527
  revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
1431
1528
  ```
1529
+
1432
1530
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult)
1433
1531
 
1434
1532
  #### Property revealSpecificKeyLinkage
@@ -1438,6 +1536,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
1438
1536
  ```ts
1439
1537
  revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
1440
1538
  ```
1539
+
1441
1540
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult)
1442
1541
 
1443
1542
  #### Property signAction
@@ -1447,6 +1546,7 @@ Signs a transaction previously created using `createAction`.
1447
1546
  ```ts
1448
1547
  signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
1449
1548
  ```
1549
+
1450
1550
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult)
1451
1551
 
1452
1552
  #### Property verifyHmac
@@ -1456,6 +1556,7 @@ Verifies an HMAC (Hash-based Message Authentication Code) based on the provided
1456
1556
  ```ts
1457
1557
  verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
1458
1558
  ```
1559
+
1459
1560
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult)
1460
1561
 
1461
1562
  #### Property verifySignature
@@ -1465,6 +1566,7 @@ Verifies a digital signature for the provided data or hash using a specific prot
1465
1566
  ```ts
1466
1567
  verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
1467
1568
  ```
1569
+
1468
1570
  See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult)
1469
1571
 
1470
1572
  #### Property waitForAuthentication
@@ -1474,11 +1576,13 @@ Continuously waits until the user is authenticated, returning the result once co
1474
1576
  ```ts
1475
1577
  waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
1476
1578
  ```
1579
+
1477
1580
  See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
1478
1581
 
1479
1582
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1480
1583
 
1481
1584
  ---
1585
+
1482
1586
  ### Interface: WalletOutput
1483
1587
 
1484
1588
  ```ts
@@ -1498,6 +1602,7 @@ See also: [HexString](./wallet.md#type-hexstring), [LabelStringUnder300Bytes](./
1498
1602
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1499
1603
 
1500
1604
  ---
1605
+
1501
1606
  ### Interface: WalletPayment
1502
1607
 
1503
1608
  ```ts
@@ -1513,6 +1618,7 @@ See also: [Base64String](./wallet.md#type-base64string), [PubKeyHex](./wallet.md
1513
1618
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1514
1619
 
1515
1620
  ---
1621
+
1516
1622
  ### Interface: WalletWire
1517
1623
 
1518
1624
  A Wallet Wire is an abstraction over a raw transport medium where binary data can be sent to and subsequently received from a wallet.
@@ -1526,6 +1632,7 @@ export default interface WalletWire {
1526
1632
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1527
1633
 
1528
1634
  ---
1635
+
1529
1636
  ## Classes
1530
1637
 
1531
1638
  | | |
@@ -1572,14 +1679,15 @@ constructor(rootKey: PrivateKey | "anyone", options?: {
1572
1679
  maxCacheSize?: number;
1573
1680
  })
1574
1681
  ```
1682
+
1575
1683
  See also: [PrivateKey](./primitives.md#class-privatekey)
1576
1684
 
1577
1685
  Argument Details
1578
1686
 
1579
- + **rootKey**
1580
- + The root private key or the string 'anyone'.
1581
- + **options**
1582
- + Optional settings for the cache.
1687
+ - **rootKey**
1688
+ - The root private key or the string 'anyone'.
1689
+ - **options**
1690
+ - Optional settings for the cache.
1583
1691
 
1584
1692
  #### Method derivePrivateKey
1585
1693
 
@@ -1589,6 +1697,7 @@ Caches the result for future calls with the same parameters.
1589
1697
  ```ts
1590
1698
  derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
1591
1699
  ```
1700
+
1592
1701
  See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
1593
1702
 
1594
1703
  Returns
@@ -1597,12 +1706,12 @@ Returns
1597
1706
 
1598
1707
  Argument Details
1599
1708
 
1600
- + **protocolID**
1601
- + The protocol ID including a security level and protocol name.
1602
- + **keyID**
1603
- + The key identifier.
1604
- + **counterparty**
1605
- + The counterparty's public key or a predefined value ('self' or 'anyone').
1709
+ - **protocolID**
1710
+ - The protocol ID including a security level and protocol name.
1711
+ - **keyID**
1712
+ - The key identifier.
1713
+ - **counterparty**
1714
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
1606
1715
 
1607
1716
  #### Method derivePublicKey
1608
1717
 
@@ -1612,6 +1721,7 @@ Caches the result for future calls with the same parameters.
1612
1721
  ```ts
1613
1722
  derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
1614
1723
  ```
1724
+
1615
1725
  See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
1616
1726
 
1617
1727
  Returns
@@ -1620,14 +1730,14 @@ Returns
1620
1730
 
1621
1731
  Argument Details
1622
1732
 
1623
- + **protocolID**
1624
- + The protocol ID including a security level and protocol name.
1625
- + **keyID**
1626
- + The key identifier.
1627
- + **counterparty**
1628
- + The counterparty's public key or a predefined value ('self' or 'anyone').
1629
- + **forSelf**
1630
- + Whether deriving for self.
1733
+ - **protocolID**
1734
+ - The protocol ID including a security level and protocol name.
1735
+ - **keyID**
1736
+ - The key identifier.
1737
+ - **counterparty**
1738
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
1739
+ - **forSelf**
1740
+ - Whether deriving for self.
1631
1741
 
1632
1742
  #### Method deriveSymmetricKey
1633
1743
 
@@ -1637,6 +1747,7 @@ Caches the result for future calls with the same parameters.
1637
1747
  ```ts
1638
1748
  deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
1639
1749
  ```
1750
+
1640
1751
  See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
1641
1752
 
1642
1753
  Returns
@@ -1645,12 +1756,12 @@ Returns
1645
1756
 
1646
1757
  Argument Details
1647
1758
 
1648
- + **protocolID**
1649
- + The protocol ID including a security level and protocol name.
1650
- + **keyID**
1651
- + The key identifier.
1652
- + **counterparty**
1653
- + The counterparty's public key or a predefined value ('self' or 'anyone').
1759
+ - **protocolID**
1760
+ - The protocol ID including a security level and protocol name.
1761
+ - **keyID**
1762
+ - The key identifier.
1763
+ - **counterparty**
1764
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
1654
1765
 
1655
1766
  Throws
1656
1767
 
@@ -1664,6 +1775,7 @@ Caches the result for future calls with the same parameters.
1664
1775
  ```ts
1665
1776
  revealCounterpartySecret(counterparty: Counterparty): number[]
1666
1777
  ```
1778
+
1667
1779
  See also: [Counterparty](./wallet.md#type-counterparty)
1668
1780
 
1669
1781
  Returns
@@ -1672,8 +1784,8 @@ Returns
1672
1784
 
1673
1785
  Argument Details
1674
1786
 
1675
- + **counterparty**
1676
- + The counterparty's public key or a predefined value ('self' or 'anyone').
1787
+ - **counterparty**
1788
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
1677
1789
 
1678
1790
  Throws
1679
1791
 
@@ -1687,6 +1799,7 @@ Caches the result for future calls with the same parameters.
1687
1799
  ```ts
1688
1800
  revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
1689
1801
  ```
1802
+
1690
1803
  See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
1691
1804
 
1692
1805
  Returns
@@ -1695,16 +1808,17 @@ Returns
1695
1808
 
1696
1809
  Argument Details
1697
1810
 
1698
- + **counterparty**
1699
- + The counterparty's public key or a predefined value ('self' or 'anyone').
1700
- + **protocolID**
1701
- + The protocol ID including a security level and protocol name.
1702
- + **keyID**
1703
- + The key identifier.
1811
+ - **counterparty**
1812
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
1813
+ - **protocolID**
1814
+ - The protocol ID including a security level and protocol name.
1815
+ - **keyID**
1816
+ - The key identifier.
1704
1817
 
1705
1818
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1706
1819
 
1707
1820
  ---
1821
+
1708
1822
  ### Class: HTTPWalletJSON
1709
1823
 
1710
1824
  ```ts
@@ -1929,6 +2043,7 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
1929
2043
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1930
2044
 
1931
2045
  ---
2046
+
1932
2047
  ### Class: HTTPWalletWire
1933
2048
 
1934
2049
  ```ts
@@ -1946,6 +2061,7 @@ See also: [WalletWire](./wallet.md#interface-walletwire)
1946
2061
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
1947
2062
 
1948
2063
  ---
2064
+
1949
2065
  ### Class: KeyDeriver
1950
2066
 
1951
2067
  Class responsible for deriving various types of keys using a root private key.
@@ -1973,12 +2089,13 @@ Initializes the KeyDeriver instance with a root private key.
1973
2089
  ```ts
1974
2090
  constructor(rootKey: PrivateKey | "anyone")
1975
2091
  ```
2092
+
1976
2093
  See also: [PrivateKey](./primitives.md#class-privatekey)
1977
2094
 
1978
2095
  Argument Details
1979
2096
 
1980
- + **rootKey**
1981
- + The root private key or the string 'anyone'.
2097
+ - **rootKey**
2098
+ - The root private key or the string 'anyone'.
1982
2099
 
1983
2100
  #### Method derivePrivateKey
1984
2101
 
@@ -1987,6 +2104,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
1987
2104
  ```ts
1988
2105
  derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
1989
2106
  ```
2107
+
1990
2108
  See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
1991
2109
 
1992
2110
  Returns
@@ -1995,12 +2113,12 @@ Returns
1995
2113
 
1996
2114
  Argument Details
1997
2115
 
1998
- + **protocolID**
1999
- + The protocol ID including a security level and protocol name.
2000
- + **keyID**
2001
- + The key identifier.
2002
- + **counterparty**
2003
- + The counterparty's public key or a predefined value ('self' or 'anyone').
2116
+ - **protocolID**
2117
+ - The protocol ID including a security level and protocol name.
2118
+ - **keyID**
2119
+ - The key identifier.
2120
+ - **counterparty**
2121
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
2004
2122
 
2005
2123
  #### Method derivePublicKey
2006
2124
 
@@ -2009,6 +2127,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
2009
2127
  ```ts
2010
2128
  derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
2011
2129
  ```
2130
+
2012
2131
  See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
2013
2132
 
2014
2133
  Returns
@@ -2017,14 +2136,14 @@ Returns
2017
2136
 
2018
2137
  Argument Details
2019
2138
 
2020
- + **protocolID**
2021
- + The protocol ID including a security level and protocol name.
2022
- + **keyID**
2023
- + The key identifier.
2024
- + **counterparty**
2025
- + The counterparty's public key or a predefined value ('self' or 'anyone').
2026
- + **forSelf**
2027
- + Whether deriving for self.
2139
+ - **protocolID**
2140
+ - The protocol ID including a security level and protocol name.
2141
+ - **keyID**
2142
+ - The key identifier.
2143
+ - **counterparty**
2144
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
2145
+ - **forSelf**
2146
+ - Whether deriving for self.
2028
2147
 
2029
2148
  #### Method deriveSymmetricKey
2030
2149
 
@@ -2034,6 +2153,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
2034
2153
  ```ts
2035
2154
  deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
2036
2155
  ```
2156
+
2037
2157
  See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
2038
2158
 
2039
2159
  Returns
@@ -2042,12 +2162,12 @@ Returns
2042
2162
 
2043
2163
  Argument Details
2044
2164
 
2045
- + **protocolID**
2046
- + The protocol ID including a security level and protocol name.
2047
- + **keyID**
2048
- + The key identifier.
2049
- + **counterparty**
2050
- + The counterparty's public key or a predefined value ('self' or 'anyone').
2165
+ - **protocolID**
2166
+ - The protocol ID including a security level and protocol name.
2167
+ - **keyID**
2168
+ - The key identifier.
2169
+ - **counterparty**
2170
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
2051
2171
 
2052
2172
  #### Method revealCounterpartySecret
2053
2173
 
@@ -2057,6 +2177,7 @@ Note: This should not be used for 'self'.
2057
2177
  ```ts
2058
2178
  revealCounterpartySecret(counterparty: Counterparty): number[]
2059
2179
  ```
2180
+
2060
2181
  See also: [Counterparty](./wallet.md#type-counterparty)
2061
2182
 
2062
2183
  Returns
@@ -2065,8 +2186,8 @@ Returns
2065
2186
 
2066
2187
  Argument Details
2067
2188
 
2068
- + **counterparty**
2069
- + The counterparty's public key or a predefined value ('self' or 'anyone').
2189
+ - **counterparty**
2190
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
2070
2191
 
2071
2192
  Throws
2072
2193
 
@@ -2079,6 +2200,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
2079
2200
  ```ts
2080
2201
  revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
2081
2202
  ```
2203
+
2082
2204
  See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
2083
2205
 
2084
2206
  Returns
@@ -2087,16 +2209,17 @@ Returns
2087
2209
 
2088
2210
  Argument Details
2089
2211
 
2090
- + **counterparty**
2091
- + The counterparty's public key or a predefined value ('self' or 'anyone').
2092
- + **protocolID**
2093
- + The protocol ID including a security level and protocol name.
2094
- + **keyID**
2095
- + The key identifier.
2212
+ - **counterparty**
2213
+ - The counterparty's public key or a predefined value ('self' or 'anyone').
2214
+ - **protocolID**
2215
+ - The protocol ID including a security level and protocol name.
2216
+ - **keyID**
2217
+ - The key identifier.
2096
2218
 
2097
2219
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2098
2220
 
2099
2221
  ---
2222
+
2100
2223
  ### Class: ProtoWallet
2101
2224
 
2102
2225
  A ProtoWallet is precursor to a full wallet, capable of performing all foundational cryptographic operations.
@@ -2128,6 +2251,7 @@ See also: [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacRes
2128
2251
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2129
2252
 
2130
2253
  ---
2254
+
2131
2255
  ### Class: ReactNativeWebView
2132
2256
 
2133
2257
  Facilitates wallet operations over cross-document messaging.
@@ -2572,6 +2696,7 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
2572
2696
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2573
2697
 
2574
2698
  ---
2699
+
2575
2700
  ### Class: WERR_REVIEW_ACTIONS
2576
2701
 
2577
2702
  When a `createAction` or `signAction` is completed in undelayed mode (`acceptDelayedBroadcast`: false),
@@ -2597,11 +2722,13 @@ which contains more details, particularly for double spend results.
2597
2722
  ```ts
2598
2723
  constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
2599
2724
  ```
2725
+
2600
2726
  See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [OutpointString](./wallet.md#type-outpointstring), [ReviewActionResult](./wallet.md#interface-reviewactionresult), [SendWithResult](./wallet.md#interface-sendwithresult), [TXIDHexString](./wallet.md#type-txidhexstring)
2601
2727
 
2602
2728
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2603
2729
 
2604
2730
  ---
2731
+
2605
2732
  ### Class: WalletClient
2606
2733
 
2607
2734
  The SDK is how applications communicate with wallets over a communications substrate.
@@ -2816,6 +2943,7 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
2816
2943
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2817
2944
 
2818
2945
  ---
2946
+
2819
2947
  ### Class: WalletError
2820
2948
 
2821
2949
  ```ts
@@ -2829,6 +2957,7 @@ export class WalletError extends Error {
2829
2957
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2830
2958
 
2831
2959
  ---
2960
+
2832
2961
  ### Class: WalletWireProcessor
2833
2962
 
2834
2963
  Processes incoming wallet calls received over a wallet wire, with a given wallet.
@@ -2846,6 +2975,7 @@ See also: [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire]
2846
2975
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
2847
2976
 
2848
2977
  ---
2978
+
2849
2979
  ### Class: WalletWireTransceiver
2850
2980
 
2851
2981
  A way to make remote calls to a wallet over a wallet wire.
@@ -3069,6 +3199,7 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
3069
3199
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3070
3200
 
3071
3201
  ---
3202
+
3072
3203
  ### Class: WindowCWISubstrate
3073
3204
 
3074
3205
  Facilitates wallet operations over the window.CWI interface.
@@ -3512,6 +3643,7 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
3512
3643
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3513
3644
 
3514
3645
  ---
3646
+
3515
3647
  ### Class: XDMSubstrate
3516
3648
 
3517
3649
  Facilitates wallet operations over cross-document messaging.
@@ -3956,6 +4088,7 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
3956
4088
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3957
4089
 
3958
4090
  ---
4091
+
3959
4092
  ## Functions
3960
4093
 
3961
4094
  ### Function: toOriginHeader
@@ -3967,6 +4100,7 @@ export function toOriginHeader(originator: string, fallbackScheme = "http"): str
3967
4100
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3968
4101
 
3969
4102
  ---
4103
+
3970
4104
  ## Types
3971
4105
 
3972
4106
  | | | |
@@ -4002,6 +4136,7 @@ See also: [WalletCertificate](./wallet.md#interface-walletcertificate)
4002
4136
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4003
4137
 
4004
4138
  ---
4139
+
4005
4140
  ### Type: AcquisitionProtocol
4006
4141
 
4007
4142
  ```ts
@@ -4011,6 +4146,7 @@ export type AcquisitionProtocol = "direct" | "issuance"
4011
4146
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4012
4147
 
4013
4148
  ---
4149
+
4014
4150
  ### Type: ActionStatus
4015
4151
 
4016
4152
  ```ts
@@ -4020,6 +4156,7 @@ export type ActionStatus = "completed" | "unprocessed" | "sending" | "unproven"
4020
4156
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4021
4157
 
4022
4158
  ---
4159
+
4023
4160
  ### Type: AtomicBEEF
4024
4161
 
4025
4162
  ```ts
@@ -4031,6 +4168,7 @@ See also: [Byte](./wallet.md#type-byte)
4031
4168
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4032
4169
 
4033
4170
  ---
4171
+
4034
4172
  ### Type: BEEF
4035
4173
 
4036
4174
  ```ts
@@ -4042,6 +4180,7 @@ See also: [Byte](./wallet.md#type-byte)
4042
4180
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4043
4181
 
4044
4182
  ---
4183
+
4045
4184
  ### Type: Base64String
4046
4185
 
4047
4186
  ```ts
@@ -4051,6 +4190,7 @@ export type Base64String = string
4051
4190
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4052
4191
 
4053
4192
  ---
4193
+
4054
4194
  ### Type: BasketStringUnder300Bytes
4055
4195
 
4056
4196
  ```ts
@@ -4060,6 +4200,7 @@ export type BasketStringUnder300Bytes = string
4060
4200
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4061
4201
 
4062
4202
  ---
4203
+
4063
4204
  ### Type: BooleanDefaultFalse
4064
4205
 
4065
4206
  ```ts
@@ -4069,6 +4210,7 @@ export type BooleanDefaultFalse = boolean
4069
4210
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4070
4211
 
4071
4212
  ---
4213
+
4072
4214
  ### Type: BooleanDefaultTrue
4073
4215
 
4074
4216
  ```ts
@@ -4078,6 +4220,7 @@ export type BooleanDefaultTrue = boolean
4078
4220
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4079
4221
 
4080
4222
  ---
4223
+
4081
4224
  ### Type: Byte
4082
4225
 
4083
4226
  ```ts
@@ -4087,6 +4230,7 @@ export type Byte = number
4087
4230
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4088
4231
 
4089
4232
  ---
4233
+
4090
4234
  ### Type: CallType
4091
4235
 
4092
4236
  ```ts
@@ -4096,6 +4240,7 @@ export type CallType = keyof typeof calls
4096
4240
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4097
4241
 
4098
4242
  ---
4243
+
4099
4244
  ### Type: CertificateFieldNameUnder50Bytes
4100
4245
 
4101
4246
  ```ts
@@ -4105,6 +4250,7 @@ export type CertificateFieldNameUnder50Bytes = string
4105
4250
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4106
4251
 
4107
4252
  ---
4253
+
4108
4254
  ### Type: Counterparty
4109
4255
 
4110
4256
  ```ts
@@ -4116,6 +4262,7 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex), [PublicKey](./primitives.md#c
4116
4262
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4117
4263
 
4118
4264
  ---
4265
+
4119
4266
  ### Type: DescriptionString5to50Bytes
4120
4267
 
4121
4268
  ```ts
@@ -4125,6 +4272,7 @@ export type DescriptionString5to50Bytes = string
4125
4272
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4126
4273
 
4127
4274
  ---
4275
+
4128
4276
  ### Type: EntityIconURLStringMax500Bytes
4129
4277
 
4130
4278
  ```ts
@@ -4134,6 +4282,7 @@ export type EntityIconURLStringMax500Bytes = string
4134
4282
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4135
4283
 
4136
4284
  ---
4285
+
4137
4286
  ### Type: EntityNameStringMax100Bytes
4138
4287
 
4139
4288
  ```ts
@@ -4143,6 +4292,7 @@ export type EntityNameStringMax100Bytes = string
4143
4292
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4144
4293
 
4145
4294
  ---
4295
+
4146
4296
  ### Type: ErrorCodeString10To40Bytes
4147
4297
 
4148
4298
  ```ts
@@ -4152,6 +4302,7 @@ export type ErrorCodeString10To40Bytes = string
4152
4302
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4153
4303
 
4154
4304
  ---
4305
+
4155
4306
  ### Type: ErrorDescriptionString20To200Bytes
4156
4307
 
4157
4308
  ```ts
@@ -4161,6 +4312,7 @@ export type ErrorDescriptionString20To200Bytes = string
4161
4312
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4162
4313
 
4163
4314
  ---
4315
+
4164
4316
  ### Type: HexString
4165
4317
 
4166
4318
  ```ts
@@ -4170,6 +4322,7 @@ export type HexString = string
4170
4322
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4171
4323
 
4172
4324
  ---
4325
+
4173
4326
  ### Type: ISOTimestampString
4174
4327
 
4175
4328
  ```ts
@@ -4179,6 +4332,7 @@ export type ISOTimestampString = string
4179
4332
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4180
4333
 
4181
4334
  ---
4335
+
4182
4336
  ### Type: KeyIDStringUnder800Bytes
4183
4337
 
4184
4338
  ```ts
@@ -4188,6 +4342,7 @@ export type KeyIDStringUnder800Bytes = string
4188
4342
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4189
4343
 
4190
4344
  ---
4345
+
4191
4346
  ### Type: KeyringRevealer
4192
4347
 
4193
4348
  ```ts
@@ -4199,6 +4354,7 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
4199
4354
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4200
4355
 
4201
4356
  ---
4357
+
4202
4358
  ### Type: LabelStringUnder300Bytes
4203
4359
 
4204
4360
  ```ts
@@ -4208,6 +4364,7 @@ export type LabelStringUnder300Bytes = string
4208
4364
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4209
4365
 
4210
4366
  ---
4367
+
4211
4368
  ### Type: OriginatorDomainNameStringUnder250Bytes
4212
4369
 
4213
4370
  ```ts
@@ -4217,6 +4374,7 @@ export type OriginatorDomainNameStringUnder250Bytes = string
4217
4374
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4218
4375
 
4219
4376
  ---
4377
+
4220
4378
  ### Type: OutpointString
4221
4379
 
4222
4380
  ```ts
@@ -4226,6 +4384,7 @@ export type OutpointString = string
4226
4384
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4227
4385
 
4228
4386
  ---
4387
+
4229
4388
  ### Type: OutputTagStringUnder300Bytes
4230
4389
 
4231
4390
  ```ts
@@ -4235,6 +4394,7 @@ export type OutputTagStringUnder300Bytes = string
4235
4394
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4236
4395
 
4237
4396
  ---
4397
+
4238
4398
  ### Type: PositiveInteger
4239
4399
 
4240
4400
  ```ts
@@ -4244,6 +4404,7 @@ export type PositiveInteger = number
4244
4404
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4245
4405
 
4246
4406
  ---
4407
+
4247
4408
  ### Type: PositiveIntegerDefault10Max10000
4248
4409
 
4249
4410
  ```ts
@@ -4253,6 +4414,7 @@ export type PositiveIntegerDefault10Max10000 = number
4253
4414
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4254
4415
 
4255
4416
  ---
4417
+
4256
4418
  ### Type: PositiveIntegerMax10
4257
4419
 
4258
4420
  ```ts
@@ -4262,6 +4424,7 @@ export type PositiveIntegerMax10 = number
4262
4424
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4263
4425
 
4264
4426
  ---
4427
+
4265
4428
  ### Type: PositiveIntegerOrZero
4266
4429
 
4267
4430
  ```ts
@@ -4271,6 +4434,7 @@ export type PositiveIntegerOrZero = number
4271
4434
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4272
4435
 
4273
4436
  ---
4437
+
4274
4438
  ### Type: ProtocolString5To400Bytes
4275
4439
 
4276
4440
  ```ts
@@ -4280,6 +4444,7 @@ export type ProtocolString5To400Bytes = string
4280
4444
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4281
4445
 
4282
4446
  ---
4447
+
4283
4448
  ### Type: PubKeyHex
4284
4449
 
4285
4450
  ```ts
@@ -4291,6 +4456,7 @@ See also: [HexString](./wallet.md#type-hexstring)
4291
4456
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4292
4457
 
4293
4458
  ---
4459
+
4294
4460
  ### Type: ReviewActionResultStatus
4295
4461
 
4296
4462
  Indicates status of a new Action following a `createAction` or `signAction` in immediate mode:
@@ -4308,6 +4474,7 @@ export type ReviewActionResultStatus = "success" | "doubleSpend" | "serviceError
4308
4474
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4309
4475
 
4310
4476
  ---
4477
+
4311
4478
  ### Type: SatoshiValue
4312
4479
 
4313
4480
  ```ts
@@ -4317,8 +4484,8 @@ export type SatoshiValue = number
4317
4484
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4318
4485
 
4319
4486
  ---
4320
- ### Type: SecurityLevel
4321
4487
 
4488
+ ### Type: SecurityLevel
4322
4489
 
4323
4490
  SecurityLevel for protocols.
4324
4491
  0 = Silently grants the request with no user interation.
@@ -4332,6 +4499,7 @@ export type SecurityLevel = 0 | 1 | 2
4332
4499
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4333
4500
 
4334
4501
  ---
4502
+
4335
4503
  ### Type: SendWithResultStatus
4336
4504
 
4337
4505
  ```ts
@@ -4341,6 +4509,7 @@ export type SendWithResultStatus = "unproven" | "sending" | "failed"
4341
4509
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4342
4510
 
4343
4511
  ---
4512
+
4344
4513
  ### Type: TXIDHexString
4345
4514
 
4346
4515
  ```ts
@@ -4352,6 +4521,7 @@ See also: [HexString](./wallet.md#type-hexstring)
4352
4521
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4353
4522
 
4354
4523
  ---
4524
+
4355
4525
  ### Type: TrustSelf
4356
4526
 
4357
4527
  Controls behavior of input BEEF validation.
@@ -4367,6 +4537,7 @@ export type TrustSelf = "known"
4367
4537
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4368
4538
 
4369
4539
  ---
4540
+
4370
4541
  ### Type: VersionString7To30Bytes
4371
4542
 
4372
4543
  ```ts
@@ -4376,6 +4547,7 @@ export type VersionString7To30Bytes = string
4376
4547
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4377
4548
 
4378
4549
  ---
4550
+
4379
4551
  ### Type: WalletCounterparty
4380
4552
 
4381
4553
  ```ts
@@ -4387,6 +4559,7 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
4387
4559
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4388
4560
 
4389
4561
  ---
4562
+
4390
4563
  ### Type: WalletErrorCode
4391
4564
 
4392
4565
  ```ts
@@ -4398,6 +4571,7 @@ See also: [walletErrors](./wallet.md#enum-walleterrors)
4398
4571
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4399
4572
 
4400
4573
  ---
4574
+
4401
4575
  ### Type: WalletNetwork
4402
4576
 
4403
4577
  ```ts
@@ -4407,6 +4581,7 @@ export type WalletNetwork = "mainnet" | "testnet"
4407
4581
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4408
4582
 
4409
4583
  ---
4584
+
4410
4585
  ### Type: WalletProtocol
4411
4586
 
4412
4587
  ```ts
@@ -4421,6 +4596,7 @@ See also: [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes
4421
4596
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4422
4597
 
4423
4598
  ---
4599
+
4424
4600
  ## Enums
4425
4601
 
4426
4602
  | |
@@ -4447,6 +4623,7 @@ See also: [Counterparty](./wallet.md#type-counterparty)
4447
4623
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4448
4624
 
4449
4625
  ---
4626
+
4450
4627
  ### Enum: walletErrors
4451
4628
 
4452
4629
  ```ts
@@ -4462,5 +4639,5 @@ export enum walletErrors {
4462
4639
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4463
4640
 
4464
4641
  ---
4465
- ## Variables
4466
4642
 
4643
+ ## Variables