@bsv/wallet-toolbox 1.1.5 → 1.1.6

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 (62) hide show
  1. package/docs/README.md +1 -1
  2. package/docs/client.md +698 -442
  3. package/docs/monitor.md +54 -37
  4. package/docs/services.md +53 -34
  5. package/docs/setup.md +295 -38
  6. package/docs/storage.md +115 -103
  7. package/docs/wallet.md +697 -442
  8. package/out/src/Setup.d.ts +3 -3
  9. package/out/src/Setup.js +5 -5
  10. package/out/src/SetupClient.d.ts +105 -12
  11. package/out/src/SetupClient.d.ts.map +1 -1
  12. package/out/src/SetupClient.js +3 -4
  13. package/out/src/SetupClient.js.map +1 -1
  14. package/out/src/Wallet.d.ts +4 -0
  15. package/out/src/Wallet.d.ts.map +1 -1
  16. package/out/src/Wallet.js +7 -0
  17. package/out/src/Wallet.js.map +1 -1
  18. package/out/src/sdk/WalletError.d.ts +0 -1
  19. package/out/src/sdk/WalletError.d.ts.map +1 -1
  20. package/out/src/sdk/WalletError.js +0 -1
  21. package/out/src/sdk/WalletError.js.map +1 -1
  22. package/out/src/sdk/validationHelpers.d.ts +1 -0
  23. package/out/src/sdk/validationHelpers.d.ts.map +1 -1
  24. package/out/src/sdk/validationHelpers.js +2 -1
  25. package/out/src/sdk/validationHelpers.js.map +1 -1
  26. package/out/src/storage/StorageProvider.d.ts +1 -4
  27. package/out/src/storage/StorageProvider.d.ts.map +1 -1
  28. package/out/src/storage/StorageProvider.js +1 -4
  29. package/out/src/storage/StorageProvider.js.map +1 -1
  30. package/out/src/storage/methods/createAction.d.ts.map +1 -1
  31. package/out/src/storage/methods/createAction.js +42 -11
  32. package/out/src/storage/methods/createAction.js.map +1 -1
  33. package/out/src/storage/methods/generateChange.js +1 -1
  34. package/out/src/storage/methods/generateChange.js.map +1 -1
  35. package/out/src/storage/schema/tables/ProvenTxReq.d.ts +4 -4
  36. package/out/test/examples/README.man.test.js +1 -1
  37. package/out/test/utils/TestUtilsWalletStorage.d.ts +2 -1
  38. package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
  39. package/out/test/utils/TestUtilsWalletStorage.js +112 -27
  40. package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
  41. package/out/test/wallet/action/createAction.test.js +31 -5
  42. package/out/test/wallet/action/createAction.test.js.map +1 -1
  43. package/out/test/wallet/action/createAction2.test.d.ts +37 -0
  44. package/out/test/wallet/action/createAction2.test.d.ts.map +1 -0
  45. package/out/test/wallet/action/createAction2.test.js +1145 -0
  46. package/out/test/wallet/action/createAction2.test.js.map +1 -0
  47. package/out/tsconfig.all.tsbuildinfo +1 -1
  48. package/package.json +2 -2
  49. package/src/Setup.ts +5 -5
  50. package/src/SetupClient.ts +107 -15
  51. package/src/Wallet.ts +9 -0
  52. package/src/sdk/WalletError.ts +0 -1
  53. package/src/sdk/validationHelpers.ts +3 -1
  54. package/src/storage/StorageProvider.ts +1 -4
  55. package/src/storage/methods/createAction.ts +48 -12
  56. package/src/storage/methods/generateChange.ts +1 -1
  57. package/src/storage/schema/tables/ProvenTxReq.ts +4 -4
  58. package/test/examples/README.man.test.ts +1 -1
  59. package/test/utils/TestUtilsWalletStorage.ts +131 -35
  60. package/test/wallet/action/createAction.test.ts +36 -5
  61. package/test/wallet/action/createAction2.test.ts +1400 -0
  62. package/ts2md.json +6 -6
package/docs/client.md CHANGED
@@ -1,8 +1,16 @@
1
- # API
1
+ # CLIENT: BSV Wallet Toolbox API Documentation
2
+
3
+ The documentation is split into various pages, this page is the API of the `@bsv/wallet-toolbox-client` package;
4
+ which is the subset of the `@bsv/wallet-toolbox` that is compatible with browser deployment contexts.
5
+
6
+ [Return To Top](./README.md)
7
+
8
+ <!--#region ts2md-api-merged-here-->
9
+ ### API
2
10
 
3
11
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4
12
 
5
- ## Interfaces
13
+ #### Interfaces
6
14
 
7
15
  | | | |
8
16
  | --- | --- | --- |
@@ -53,7 +61,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
53
61
 
54
62
  ---
55
63
 
56
- ### Interface: ArcMinerGetTxData
64
+ ##### Interface: ArcMinerGetTxData
57
65
 
58
66
  ```ts
59
67
  export interface ArcMinerGetTxData {
@@ -73,7 +81,7 @@ export interface ArcMinerGetTxData {
73
81
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
74
82
 
75
83
  ---
76
- ### Interface: ArcMinerPostBeefDataApi
84
+ ##### Interface: ArcMinerPostBeefDataApi
77
85
 
78
86
  ```ts
79
87
  export interface ArcMinerPostBeefDataApi {
@@ -96,7 +104,7 @@ export interface ArcMinerPostBeefDataApi {
96
104
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
97
105
 
98
106
  ---
99
- ### Interface: ArcMinerPostTxsData
107
+ ##### Interface: ArcMinerPostTxsData
100
108
 
101
109
  ```ts
102
110
  export interface ArcMinerPostTxsData {
@@ -116,7 +124,7 @@ export interface ArcMinerPostTxsData {
116
124
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
117
125
 
118
126
  ---
119
- ### Interface: ArcServiceConfig
127
+ ##### Interface: ArcServiceConfig
120
128
 
121
129
  ```ts
122
130
  export interface ArcServiceConfig {
@@ -129,7 +137,7 @@ export interface ArcServiceConfig {
129
137
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
130
138
 
131
139
  ---
132
- ### Interface: AuthId
140
+ ##### Interface: AuthId
133
141
 
134
142
  ```ts
135
143
  export interface AuthId {
@@ -142,7 +150,7 @@ export interface AuthId {
142
150
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
143
151
 
144
152
  ---
145
- ### Interface: BaseBlockHeader
153
+ ##### Interface: BaseBlockHeader
146
154
 
147
155
  These are fields of 80 byte serialized header in order whose double sha256 hash is a block's hash value
148
156
  and the next block's previousHash value.
@@ -164,7 +172,7 @@ export interface BaseBlockHeader {
164
172
 
165
173
  <summary>Interface BaseBlockHeader Details</summary>
166
174
 
167
- #### Property bits
175
+ ###### Property bits
168
176
 
169
177
  Block header bits value. Serialized length is 4 bytes.
170
178
 
@@ -172,7 +180,7 @@ Block header bits value. Serialized length is 4 bytes.
172
180
  bits: number
173
181
  ```
174
182
 
175
- #### Property merkleRoot
183
+ ###### Property merkleRoot
176
184
 
177
185
  Root hash of the merkle tree of all transactions in this block. Serialized length is 32 bytes.
178
186
 
@@ -180,7 +188,7 @@ Root hash of the merkle tree of all transactions in this block. Serialized lengt
180
188
  merkleRoot: string
181
189
  ```
182
190
 
183
- #### Property nonce
191
+ ###### Property nonce
184
192
 
185
193
  Block header nonce value. Serialized length is 4 bytes.
186
194
 
@@ -188,7 +196,7 @@ Block header nonce value. Serialized length is 4 bytes.
188
196
  nonce: number
189
197
  ```
190
198
 
191
- #### Property previousHash
199
+ ###### Property previousHash
192
200
 
193
201
  Hash of previous block's block header. Serialized length is 32 bytes.
194
202
 
@@ -196,7 +204,7 @@ Hash of previous block's block header. Serialized length is 32 bytes.
196
204
  previousHash: string
197
205
  ```
198
206
 
199
- #### Property time
207
+ ###### Property time
200
208
 
201
209
  Block header time value. Serialized length is 4 bytes.
202
210
 
@@ -204,7 +212,7 @@ Block header time value. Serialized length is 4 bytes.
204
212
  time: number
205
213
  ```
206
214
 
207
- #### Property version
215
+ ###### Property version
208
216
 
209
217
  Block header version value. Serialized length is 4 bytes.
210
218
 
@@ -217,7 +225,7 @@ version: number
217
225
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
218
226
 
219
227
  ---
220
- ### Interface: BlockHeader
228
+ ##### Interface: BlockHeader
221
229
 
222
230
  A `BaseBlockHeader` extended with its computed hash and height in its chain.
223
231
 
@@ -234,7 +242,7 @@ See also: [BaseBlockHeader](#interface-baseblockheader)
234
242
 
235
243
  <summary>Interface BlockHeader Details</summary>
236
244
 
237
- #### Property hash
245
+ ###### Property hash
238
246
 
239
247
  The double sha256 hash of the serialized `BaseBlockHeader` fields.
240
248
 
@@ -242,7 +250,7 @@ The double sha256 hash of the serialized `BaseBlockHeader` fields.
242
250
  hash: string
243
251
  ```
244
252
 
245
- #### Property height
253
+ ###### Property height
246
254
 
247
255
  Height of the header, starting from zero.
248
256
 
@@ -255,7 +263,7 @@ height: number
255
263
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
256
264
 
257
265
  ---
258
- ### Interface: BsvExchangeRate
266
+ ##### Interface: BsvExchangeRate
259
267
 
260
268
  ```ts
261
269
  export interface BsvExchangeRate {
@@ -268,7 +276,7 @@ export interface BsvExchangeRate {
268
276
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
269
277
 
270
278
  ---
271
- ### Interface: CertOpsWallet
279
+ ##### Interface: CertOpsWallet
272
280
 
273
281
  ```ts
274
282
  export interface CertOpsWallet {
@@ -281,7 +289,7 @@ export interface CertOpsWallet {
281
289
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
282
290
 
283
291
  ---
284
- ### Interface: CommitNewTxResults
292
+ ##### Interface: CommitNewTxResults
285
293
 
286
294
  ```ts
287
295
  export interface CommitNewTxResults {
@@ -293,7 +301,7 @@ export interface CommitNewTxResults {
293
301
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
294
302
 
295
303
  ---
296
- ### Interface: EntityTimeStamp
304
+ ##### Interface: EntityTimeStamp
297
305
 
298
306
  ```ts
299
307
  export interface EntityTimeStamp {
@@ -305,7 +313,7 @@ export interface EntityTimeStamp {
305
313
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
306
314
 
307
315
  ---
308
- ### Interface: ExchangeRatesIoApi
316
+ ##### Interface: ExchangeRatesIoApi
309
317
 
310
318
  ```ts
311
319
  export interface ExchangeRatesIoApi {
@@ -320,7 +328,7 @@ export interface ExchangeRatesIoApi {
320
328
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
321
329
 
322
330
  ---
323
- ### Interface: FiatExchangeRates
331
+ ##### Interface: FiatExchangeRates
324
332
 
325
333
  ```ts
326
334
  export interface FiatExchangeRates {
@@ -333,7 +341,7 @@ export interface FiatExchangeRates {
333
341
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
334
342
 
335
343
  ---
336
- ### Interface: FindCertificateFieldsArgs
344
+ ##### Interface: FindCertificateFieldsArgs
337
345
 
338
346
  ```ts
339
347
  export interface FindCertificateFieldsArgs extends sdk.FindSincePagedArgs {
@@ -346,7 +354,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
346
354
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
347
355
 
348
356
  ---
349
- ### Interface: FindCertificatesArgs
357
+ ##### Interface: FindCertificatesArgs
350
358
 
351
359
  ```ts
352
360
  export interface FindCertificatesArgs extends FindSincePagedArgs {
@@ -362,7 +370,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
362
370
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
363
371
 
364
372
  ---
365
- ### Interface: FindCommissionsArgs
373
+ ##### Interface: FindCommissionsArgs
366
374
 
367
375
  ```ts
368
376
  export interface FindCommissionsArgs extends sdk.FindSincePagedArgs {
@@ -375,7 +383,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
375
383
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
376
384
 
377
385
  ---
378
- ### Interface: FindForUserSincePagedArgs
386
+ ##### Interface: FindForUserSincePagedArgs
379
387
 
380
388
  ```ts
381
389
  export interface FindForUserSincePagedArgs extends FindSincePagedArgs {
@@ -388,7 +396,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
388
396
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
389
397
 
390
398
  ---
391
- ### Interface: FindMonitorEventsArgs
399
+ ##### Interface: FindMonitorEventsArgs
392
400
 
393
401
  ```ts
394
402
  export interface FindMonitorEventsArgs extends sdk.FindSincePagedArgs {
@@ -401,7 +409,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
401
409
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
402
410
 
403
411
  ---
404
- ### Interface: FindOutputBasketsArgs
412
+ ##### Interface: FindOutputBasketsArgs
405
413
 
406
414
  ```ts
407
415
  export interface FindOutputBasketsArgs extends FindSincePagedArgs {
@@ -414,7 +422,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
414
422
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
415
423
 
416
424
  ---
417
- ### Interface: FindOutputTagMapsArgs
425
+ ##### Interface: FindOutputTagMapsArgs
418
426
 
419
427
  ```ts
420
428
  export interface FindOutputTagMapsArgs extends sdk.FindSincePagedArgs {
@@ -428,7 +436,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
428
436
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
429
437
 
430
438
  ---
431
- ### Interface: FindOutputTagsArgs
439
+ ##### Interface: FindOutputTagsArgs
432
440
 
433
441
  ```ts
434
442
  export interface FindOutputTagsArgs extends sdk.FindSincePagedArgs {
@@ -441,7 +449,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
441
449
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
442
450
 
443
451
  ---
444
- ### Interface: FindOutputsArgs
452
+ ##### Interface: FindOutputsArgs
445
453
 
446
454
  ```ts
447
455
  export interface FindOutputsArgs extends FindSincePagedArgs {
@@ -456,7 +464,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs), [TransactionStatu
456
464
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
457
465
 
458
466
  ---
459
- ### Interface: FindPartialSincePagedArgs
467
+ ##### Interface: FindPartialSincePagedArgs
460
468
 
461
469
  ```ts
462
470
  export interface FindPartialSincePagedArgs<T extends object> extends FindSincePagedArgs {
@@ -469,7 +477,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
469
477
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
470
478
 
471
479
  ---
472
- ### Interface: FindProvenTxReqsArgs
480
+ ##### Interface: FindProvenTxReqsArgs
473
481
 
474
482
  ```ts
475
483
  export interface FindProvenTxReqsArgs extends sdk.FindSincePagedArgs {
@@ -484,7 +492,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs), [ProvenTxReqStatu
484
492
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
485
493
 
486
494
  ---
487
- ### Interface: FindProvenTxsArgs
495
+ ##### Interface: FindProvenTxsArgs
488
496
 
489
497
  ```ts
490
498
  export interface FindProvenTxsArgs extends sdk.FindSincePagedArgs {
@@ -497,7 +505,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
497
505
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
498
506
 
499
507
  ---
500
- ### Interface: FindSincePagedArgs
508
+ ##### Interface: FindSincePagedArgs
501
509
 
502
510
  ```ts
503
511
  export interface FindSincePagedArgs {
@@ -512,7 +520,7 @@ See also: [Paged](#interface-paged), [TrxToken](#interface-trxtoken)
512
520
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
513
521
 
514
522
  ---
515
- ### Interface: FindSyncStatesArgs
523
+ ##### Interface: FindSyncStatesArgs
516
524
 
517
525
  ```ts
518
526
  export interface FindSyncStatesArgs extends sdk.FindSincePagedArgs {
@@ -525,7 +533,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
525
533
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
526
534
 
527
535
  ---
528
- ### Interface: FindTransactionsArgs
536
+ ##### Interface: FindTransactionsArgs
529
537
 
530
538
  ```ts
531
539
  export interface FindTransactionsArgs extends sdk.FindSincePagedArgs {
@@ -540,7 +548,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs), [TransactionStatu
540
548
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
541
549
 
542
550
  ---
543
- ### Interface: FindTxLabelMapsArgs
551
+ ##### Interface: FindTxLabelMapsArgs
544
552
 
545
553
  ```ts
546
554
  export interface FindTxLabelMapsArgs extends sdk.FindSincePagedArgs {
@@ -554,7 +562,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
554
562
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
555
563
 
556
564
  ---
557
- ### Interface: FindTxLabelsArgs
565
+ ##### Interface: FindTxLabelsArgs
558
566
 
559
567
  ```ts
560
568
  export interface FindTxLabelsArgs extends sdk.FindSincePagedArgs {
@@ -567,7 +575,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
567
575
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
568
576
 
569
577
  ---
570
- ### Interface: FindUsersArgs
578
+ ##### Interface: FindUsersArgs
571
579
 
572
580
  ```ts
573
581
  export interface FindUsersArgs extends sdk.FindSincePagedArgs {
@@ -580,7 +588,7 @@ See also: [FindSincePagedArgs](#interface-findsincepagedargs)
580
588
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
581
589
 
582
590
  ---
583
- ### Interface: GenerateChangeSdkChangeInput
591
+ ##### Interface: GenerateChangeSdkChangeInput
584
592
 
585
593
  ```ts
586
594
  export interface GenerateChangeSdkChangeInput {
@@ -592,7 +600,7 @@ export interface GenerateChangeSdkChangeInput {
592
600
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
593
601
 
594
602
  ---
595
- ### Interface: GenerateChangeSdkChangeOutput
603
+ ##### Interface: GenerateChangeSdkChangeOutput
596
604
 
597
605
  ```ts
598
606
  export interface GenerateChangeSdkChangeOutput {
@@ -604,7 +612,7 @@ export interface GenerateChangeSdkChangeOutput {
604
612
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
605
613
 
606
614
  ---
607
- ### Interface: GenerateChangeSdkInput
615
+ ##### Interface: GenerateChangeSdkInput
608
616
 
609
617
  ```ts
610
618
  export interface GenerateChangeSdkInput {
@@ -616,7 +624,7 @@ export interface GenerateChangeSdkInput {
616
624
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
617
625
 
618
626
  ---
619
- ### Interface: GenerateChangeSdkOutput
627
+ ##### Interface: GenerateChangeSdkOutput
620
628
 
621
629
  ```ts
622
630
  export interface GenerateChangeSdkOutput {
@@ -628,7 +636,7 @@ export interface GenerateChangeSdkOutput {
628
636
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
629
637
 
630
638
  ---
631
- ### Interface: GenerateChangeSdkParams
639
+ ##### Interface: GenerateChangeSdkParams
632
640
 
633
641
  ```ts
634
642
  export interface GenerateChangeSdkParams {
@@ -652,7 +660,7 @@ See also: [GenerateChangeSdkInput](#interface-generatechangesdkinput), [Generate
652
660
 
653
661
  <summary>Interface GenerateChangeSdkParams Details</summary>
654
662
 
655
- #### Property changeFirstSatoshis
663
+ ###### Property changeFirstSatoshis
656
664
 
657
665
  Lowest amount value to assign to a change output.
658
666
  Drop the output if unable to satisfy.
@@ -662,7 +670,7 @@ default 285
662
670
  changeFirstSatoshis: number
663
671
  ```
664
672
 
665
- #### Property changeInitialSatoshis
673
+ ###### Property changeInitialSatoshis
666
674
 
667
675
  Satoshi amount to initialize optional new change outputs.
668
676
 
@@ -670,7 +678,7 @@ Satoshi amount to initialize optional new change outputs.
670
678
  changeInitialSatoshis: number
671
679
  ```
672
680
 
673
- #### Property changeLockingScriptLength
681
+ ###### Property changeLockingScriptLength
674
682
 
675
683
  Fixed change locking script length.
676
684
 
@@ -680,7 +688,7 @@ For P2PKH template, 25 bytes
680
688
  changeLockingScriptLength: number
681
689
  ```
682
690
 
683
- #### Property changeUnlockingScriptLength
691
+ ###### Property changeUnlockingScriptLength
684
692
 
685
693
  Fixed change unlocking script length.
686
694
 
@@ -690,7 +698,7 @@ For P2PKH template, 107 bytes
690
698
  changeUnlockingScriptLength: number
691
699
  ```
692
700
 
693
- #### Property targetNetCount
701
+ ###### Property targetNetCount
694
702
 
695
703
  Target for number of new change outputs added minus number of funding change outputs consumed.
696
704
  If undefined, only a single change output will be added if excess fees must be recaptured.
@@ -704,7 +712,7 @@ targetNetCount?: number
704
712
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
705
713
 
706
714
  ---
707
- ### Interface: GenerateChangeSdkResult
715
+ ##### Interface: GenerateChangeSdkResult
708
716
 
709
717
  ```ts
710
718
  export interface GenerateChangeSdkResult {
@@ -721,7 +729,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
721
729
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
722
730
 
723
731
  ---
724
- ### Interface: GenerateChangeSdkStorageChange
732
+ ##### Interface: GenerateChangeSdkStorageChange
725
733
 
726
734
  ```ts
727
735
  export interface GenerateChangeSdkStorageChange extends GenerateChangeSdkChangeInput {
@@ -734,7 +742,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
734
742
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
735
743
 
736
744
  ---
737
- ### Interface: GetMerklePathResult
745
+ ##### Interface: GetMerklePathResult
738
746
 
739
747
  Properties on result returned from `WalletServices` function `getMerkleProof`.
740
748
 
@@ -753,7 +761,7 @@ See also: [BlockHeader](#interface-blockheader), [WalletError](#class-walleterro
753
761
 
754
762
  <summary>Interface GetMerklePathResult Details</summary>
755
763
 
756
- #### Property error
764
+ ###### Property error
757
765
 
758
766
  The first exception error that occurred during processing, if any.
759
767
 
@@ -762,7 +770,7 @@ error?: sdk.WalletError
762
770
  ```
763
771
  See also: [WalletError](#class-walleterror)
764
772
 
765
- #### Property merklePath
773
+ ###### Property merklePath
766
774
 
767
775
  Multiple proofs may be returned when a transaction also appears in
768
776
  one or more orphaned blocks
@@ -771,7 +779,7 @@ one or more orphaned blocks
771
779
  merklePath?: MerklePath
772
780
  ```
773
781
 
774
- #### Property name
782
+ ###### Property name
775
783
 
776
784
  The name of the service returning the proof, or undefined if no proof
777
785
 
@@ -784,7 +792,7 @@ name?: string
784
792
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
785
793
 
786
794
  ---
787
- ### Interface: GetRawTxResult
795
+ ##### Interface: GetRawTxResult
788
796
 
789
797
  Properties on result returned from `WalletServices` function `getRawTx`.
790
798
 
@@ -803,7 +811,7 @@ See also: [WalletError](#class-walleterror)
803
811
 
804
812
  <summary>Interface GetRawTxResult Details</summary>
805
813
 
806
- #### Property error
814
+ ###### Property error
807
815
 
808
816
  The first exception error that occurred during processing, if any.
809
817
 
@@ -812,7 +820,7 @@ error?: sdk.WalletError
812
820
  ```
813
821
  See also: [WalletError](#class-walleterror)
814
822
 
815
- #### Property name
823
+ ###### Property name
816
824
 
817
825
  The name of the service returning the rawTx, or undefined if no rawTx
818
826
 
@@ -820,7 +828,7 @@ The name of the service returning the rawTx, or undefined if no rawTx
820
828
  name?: string
821
829
  ```
822
830
 
823
- #### Property rawTx
831
+ ###### Property rawTx
824
832
 
825
833
  Multiple proofs may be returned when a transaction also appears in
826
834
  one or more orphaned blocks
@@ -829,7 +837,7 @@ one or more orphaned blocks
829
837
  rawTx?: number[]
830
838
  ```
831
839
 
832
- #### Property txid
840
+ ###### Property txid
833
841
 
834
842
  Transaction hash or rawTx (and of initial request)
835
843
 
@@ -842,7 +850,7 @@ txid: string
842
850
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
843
851
 
844
852
  ---
845
- ### Interface: GetReqsAndBeefDetail
853
+ ##### Interface: GetReqsAndBeefDetail
846
854
 
847
855
  ```ts
848
856
  export interface GetReqsAndBeefDetail {
@@ -857,7 +865,7 @@ export interface GetReqsAndBeefDetail {
857
865
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
858
866
 
859
867
  ---
860
- ### Interface: GetReqsAndBeefResult
868
+ ##### Interface: GetReqsAndBeefResult
861
869
 
862
870
  ```ts
863
871
  export interface GetReqsAndBeefResult {
@@ -871,7 +879,7 @@ See also: [GetReqsAndBeefDetail](#interface-getreqsandbeefdetail)
871
879
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
872
880
 
873
881
  ---
874
- ### Interface: GetUtxoStatusDetails
882
+ ##### Interface: GetUtxoStatusDetails
875
883
 
876
884
  ```ts
877
885
  export interface GetUtxoStatusDetails {
@@ -886,7 +894,7 @@ export interface GetUtxoStatusDetails {
886
894
 
887
895
  <summary>Interface GetUtxoStatusDetails Details</summary>
888
896
 
889
- #### Property height
897
+ ###### Property height
890
898
 
891
899
  if isUtxo, the block height containing the matching unspent transaction output
892
900
 
@@ -896,7 +904,7 @@ typically there will be only one, but future orphans can result in multiple valu
896
904
  height?: number
897
905
  ```
898
906
 
899
- #### Property index
907
+ ###### Property index
900
908
 
901
909
  if isUtxo, the output index in the transaction containing of the matching unspent transaction output
902
910
 
@@ -906,7 +914,7 @@ typically there will be only one, but future orphans can result in multiple valu
906
914
  index?: number
907
915
  ```
908
916
 
909
- #### Property satoshis
917
+ ###### Property satoshis
910
918
 
911
919
  if isUtxo, the amount of the matching unspent transaction output
912
920
 
@@ -916,7 +924,7 @@ typically there will be only one, but future orphans can result in multiple valu
916
924
  satoshis?: number
917
925
  ```
918
926
 
919
- #### Property txid
927
+ ###### Property txid
920
928
 
921
929
  if isUtxo, the transaction hash (txid) of the transaction containing the matching unspent transaction output
922
930
 
@@ -931,7 +939,7 @@ txid?: string
931
939
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
932
940
 
933
941
  ---
934
- ### Interface: GetUtxoStatusResult
942
+ ##### Interface: GetUtxoStatusResult
935
943
 
936
944
  ```ts
937
945
  export interface GetUtxoStatusResult {
@@ -949,7 +957,7 @@ See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails), [WalletError]
949
957
 
950
958
  <summary>Interface GetUtxoStatusResult Details</summary>
951
959
 
952
- #### Property details
960
+ ###### Property details
953
961
 
954
962
  Additional details about occurances of this output script as a utxo.
955
963
 
@@ -961,7 +969,7 @@ details: GetUtxoStatusDetails[]
961
969
  ```
962
970
  See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails)
963
971
 
964
- #### Property error
972
+ ###### Property error
965
973
 
966
974
  When status is 'error', provides code and description
967
975
 
@@ -970,7 +978,7 @@ error?: sdk.WalletError
970
978
  ```
971
979
  See also: [WalletError](#class-walleterror)
972
980
 
973
- #### Property isUtxo
981
+ ###### Property isUtxo
974
982
 
975
983
  true if the output is associated with at least one unspent transaction output
976
984
 
@@ -978,7 +986,7 @@ true if the output is associated with at least one unspent transaction output
978
986
  isUtxo?: boolean
979
987
  ```
980
988
 
981
- #### Property name
989
+ ###### Property name
982
990
 
983
991
  The name of the service to which the transaction was submitted for processing
984
992
 
@@ -986,7 +994,7 @@ The name of the service to which the transaction was submitted for processing
986
994
  name: string
987
995
  ```
988
996
 
989
- #### Property status
997
+ ###### Property status
990
998
 
991
999
  'success' - the operation was successful, non-error results are valid.
992
1000
  'error' - the operation failed, error may have relevant information.
@@ -1000,7 +1008,7 @@ status: "success" | "error"
1000
1008
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1001
1009
 
1002
1010
  ---
1003
- ### Interface: KeyPair
1011
+ ##### Interface: KeyPair
1004
1012
 
1005
1013
  ```ts
1006
1014
  export interface KeyPair {
@@ -1012,7 +1020,7 @@ export interface KeyPair {
1012
1020
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1013
1021
 
1014
1022
  ---
1015
- ### Interface: MonitorOptions
1023
+ ##### Interface: MonitorOptions
1016
1024
 
1017
1025
  ```ts
1018
1026
  export interface MonitorOptions {
@@ -1034,7 +1042,7 @@ See also: [Chain](#type-chain), [MonitorStorage](#type-monitorstorage), [Service
1034
1042
 
1035
1043
  <summary>Interface MonitorOptions Details</summary>
1036
1044
 
1037
- #### Property msecsWaitPerMerkleProofServiceReq
1045
+ ###### Property msecsWaitPerMerkleProofServiceReq
1038
1046
 
1039
1047
  How many msecs to wait after each getMerkleProof service request.
1040
1048
 
@@ -1047,7 +1055,7 @@ msecsWaitPerMerkleProofServiceReq: number
1047
1055
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1048
1056
 
1049
1057
  ---
1050
- ### Interface: OutPoint
1058
+ ##### Interface: OutPoint
1051
1059
 
1052
1060
  Identifies a unique transaction output by its `txid` and index `vout`
1053
1061
 
@@ -1062,7 +1070,7 @@ export interface OutPoint {
1062
1070
 
1063
1071
  <summary>Interface OutPoint Details</summary>
1064
1072
 
1065
- #### Property txid
1073
+ ###### Property txid
1066
1074
 
1067
1075
  Transaction double sha256 hash as big endian hex string
1068
1076
 
@@ -1070,7 +1078,7 @@ Transaction double sha256 hash as big endian hex string
1070
1078
  txid: string
1071
1079
  ```
1072
1080
 
1073
- #### Property vout
1081
+ ###### Property vout
1074
1082
 
1075
1083
  zero based output index within the transaction
1076
1084
 
@@ -1083,7 +1091,7 @@ vout: number
1083
1091
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1084
1092
 
1085
1093
  ---
1086
- ### Interface: Paged
1094
+ ##### Interface: Paged
1087
1095
 
1088
1096
  ```ts
1089
1097
  export interface Paged {
@@ -1095,7 +1103,7 @@ export interface Paged {
1095
1103
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1096
1104
 
1097
1105
  ---
1098
- ### Interface: PendingSignAction
1106
+ ##### Interface: PendingSignAction
1099
1107
 
1100
1108
  ```ts
1101
1109
  export interface PendingSignAction {
@@ -1113,7 +1121,7 @@ See also: [PendingStorageInput](#interface-pendingstorageinput), [StorageCreateA
1113
1121
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1114
1122
 
1115
1123
  ---
1116
- ### Interface: PendingStorageInput
1124
+ ##### Interface: PendingStorageInput
1117
1125
 
1118
1126
  ```ts
1119
1127
  export interface PendingStorageInput {
@@ -1129,7 +1137,7 @@ export interface PendingStorageInput {
1129
1137
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1130
1138
 
1131
1139
  ---
1132
- ### Interface: PostBeefResult
1140
+ ##### Interface: PostBeefResult
1133
1141
 
1134
1142
  ```ts
1135
1143
  export interface PostBeefResult extends PostTxsResult {
@@ -1141,7 +1149,7 @@ See also: [PostTxsResult](#interface-posttxsresult)
1141
1149
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1142
1150
 
1143
1151
  ---
1144
- ### Interface: PostBeefResultForTxidApi
1152
+ ##### Interface: PostBeefResultForTxidApi
1145
1153
 
1146
1154
  ```ts
1147
1155
  export interface PostBeefResultForTxidApi {
@@ -1158,7 +1166,7 @@ export interface PostBeefResultForTxidApi {
1158
1166
 
1159
1167
  <summary>Interface PostBeefResultForTxidApi Details</summary>
1160
1168
 
1161
- #### Property alreadyKnown
1169
+ ###### Property alreadyKnown
1162
1170
 
1163
1171
  if true, the transaction was already known to this service. Usually treat as a success.
1164
1172
 
@@ -1168,7 +1176,7 @@ Potentially stop posting to additional transaction processors.
1168
1176
  alreadyKnown?: boolean
1169
1177
  ```
1170
1178
 
1171
- #### Property status
1179
+ ###### Property status
1172
1180
 
1173
1181
  'success' - The transaction was accepted for processing
1174
1182
 
@@ -1181,7 +1189,7 @@ status: "success" | "error"
1181
1189
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1182
1190
 
1183
1191
  ---
1184
- ### Interface: PostReqsToNetworkDetails
1192
+ ##### Interface: PostReqsToNetworkDetails
1185
1193
 
1186
1194
  ```ts
1187
1195
  export interface PostReqsToNetworkDetails {
@@ -1199,7 +1207,7 @@ See also: [PostReqsToNetworkDetailsStatus](#type-postreqstonetworkdetailsstatus)
1199
1207
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1200
1208
 
1201
1209
  ---
1202
- ### Interface: PostReqsToNetworkResult
1210
+ ##### Interface: PostReqsToNetworkResult
1203
1211
 
1204
1212
  ```ts
1205
1213
  export interface PostReqsToNetworkResult {
@@ -1216,7 +1224,7 @@ See also: [PostBeefResult](#interface-postbeefresult), [PostReqsToNetworkDetails
1216
1224
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1217
1225
 
1218
1226
  ---
1219
- ### Interface: PostTxResultForTxid
1227
+ ##### Interface: PostTxResultForTxid
1220
1228
 
1221
1229
  ```ts
1222
1230
  export interface PostTxResultForTxid {
@@ -1234,7 +1242,7 @@ export interface PostTxResultForTxid {
1234
1242
 
1235
1243
  <summary>Interface PostTxResultForTxid Details</summary>
1236
1244
 
1237
- #### Property alreadyKnown
1245
+ ###### Property alreadyKnown
1238
1246
 
1239
1247
  if true, the transaction was already known to this service. Usually treat as a success.
1240
1248
 
@@ -1244,7 +1252,7 @@ Potentially stop posting to additional transaction processors.
1244
1252
  alreadyKnown?: boolean
1245
1253
  ```
1246
1254
 
1247
- #### Property status
1255
+ ###### Property status
1248
1256
 
1249
1257
  'success' - The transaction was accepted for processing
1250
1258
 
@@ -1257,7 +1265,7 @@ status: "success" | "error"
1257
1265
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1258
1266
 
1259
1267
  ---
1260
- ### Interface: PostTxsResult
1268
+ ##### Interface: PostTxsResult
1261
1269
 
1262
1270
  Properties on array items of result returned from `WalletServices` function `postBeef`.
1263
1271
 
@@ -1277,7 +1285,7 @@ See also: [PostTxResultForTxid](#interface-posttxresultfortxid), [WalletError](#
1277
1285
 
1278
1286
  <summary>Interface PostTxsResult Details</summary>
1279
1287
 
1280
- #### Property data
1288
+ ###### Property data
1281
1289
 
1282
1290
  Service response object. Use service name and status to infer type of object.
1283
1291
 
@@ -1285,7 +1293,7 @@ Service response object. Use service name and status to infer type of object.
1285
1293
  data?: object
1286
1294
  ```
1287
1295
 
1288
- #### Property name
1296
+ ###### Property name
1289
1297
 
1290
1298
  The name of the service to which the transaction was submitted for processing
1291
1299
 
@@ -1293,7 +1301,7 @@ The name of the service to which the transaction was submitted for processing
1293
1301
  name: string
1294
1302
  ```
1295
1303
 
1296
- #### Property status
1304
+ ###### Property status
1297
1305
 
1298
1306
  'success' all txids returned status of 'success'
1299
1307
  'error' one or more txids returned status of 'error'. See txidResults for details.
@@ -1307,7 +1315,7 @@ status: "success" | "error"
1307
1315
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1308
1316
 
1309
1317
  ---
1310
- ### Interface: ProcessSyncChunkResult
1318
+ ##### Interface: ProcessSyncChunkResult
1311
1319
 
1312
1320
  ```ts
1313
1321
  export interface ProcessSyncChunkResult {
@@ -1324,7 +1332,7 @@ See also: [WalletError](#class-walleterror)
1324
1332
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1325
1333
 
1326
1334
  ---
1327
- ### Interface: ProvenOrRawTx
1335
+ ##### Interface: ProvenOrRawTx
1328
1336
 
1329
1337
  ```ts
1330
1338
  export interface ProvenOrRawTx {
@@ -1337,7 +1345,7 @@ export interface ProvenOrRawTx {
1337
1345
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1338
1346
 
1339
1347
  ---
1340
- ### Interface: PurgeParams
1348
+ ##### Interface: PurgeParams
1341
1349
 
1342
1350
  ```ts
1343
1351
  export interface PurgeParams {
@@ -1354,7 +1362,7 @@ export interface PurgeParams {
1354
1362
 
1355
1363
  <summary>Interface PurgeParams Details</summary>
1356
1364
 
1357
- #### Property purgeCompletedAge
1365
+ ###### Property purgeCompletedAge
1358
1366
 
1359
1367
  Minimum age in msecs for transient completed transaction data purge.
1360
1368
  Default is 14 days.
@@ -1363,7 +1371,7 @@ Default is 14 days.
1363
1371
  purgeCompletedAge?: number
1364
1372
  ```
1365
1373
 
1366
- #### Property purgeFailedAge
1374
+ ###### Property purgeFailedAge
1367
1375
 
1368
1376
  Minimum age in msecs for failed transaction data purge.
1369
1377
  Default is 14 days.
@@ -1372,7 +1380,7 @@ Default is 14 days.
1372
1380
  purgeFailedAge?: number
1373
1381
  ```
1374
1382
 
1375
- #### Property purgeSpentAge
1383
+ ###### Property purgeSpentAge
1376
1384
 
1377
1385
  Minimum age in msecs for failed transaction data purge.
1378
1386
  Default is 14 days.
@@ -1386,7 +1394,7 @@ purgeSpentAge?: number
1386
1394
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1387
1395
 
1388
1396
  ---
1389
- ### Interface: PurgeResults
1397
+ ##### Interface: PurgeResults
1390
1398
 
1391
1399
  ```ts
1392
1400
  export interface PurgeResults {
@@ -1398,7 +1406,7 @@ export interface PurgeResults {
1398
1406
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1399
1407
 
1400
1408
  ---
1401
- ### Interface: RequestSyncChunkArgs
1409
+ ##### Interface: RequestSyncChunkArgs
1402
1410
 
1403
1411
  ```ts
1404
1412
  export interface RequestSyncChunkArgs {
@@ -1419,7 +1427,7 @@ export interface RequestSyncChunkArgs {
1419
1427
 
1420
1428
  <summary>Interface RequestSyncChunkArgs Details</summary>
1421
1429
 
1422
- #### Property fromStorageIdentityKey
1430
+ ###### Property fromStorageIdentityKey
1423
1431
 
1424
1432
  The storageIdentityKey of the storage supplying the update SyncChunk data.
1425
1433
 
@@ -1427,7 +1435,7 @@ The storageIdentityKey of the storage supplying the update SyncChunk data.
1427
1435
  fromStorageIdentityKey: string
1428
1436
  ```
1429
1437
 
1430
- #### Property identityKey
1438
+ ###### Property identityKey
1431
1439
 
1432
1440
  The identity of whose data is being requested
1433
1441
 
@@ -1435,7 +1443,7 @@ The identity of whose data is being requested
1435
1443
  identityKey: string
1436
1444
  ```
1437
1445
 
1438
- #### Property maxItems
1446
+ ###### Property maxItems
1439
1447
 
1440
1448
  The maximum number of items (records) to be returned.
1441
1449
 
@@ -1443,7 +1451,7 @@ The maximum number of items (records) to be returned.
1443
1451
  maxItems: number
1444
1452
  ```
1445
1453
 
1446
- #### Property maxRoughSize
1454
+ ###### Property maxRoughSize
1447
1455
 
1448
1456
  A rough limit on how large the response should be.
1449
1457
  The item that exceeds the limit is included and ends adding more items.
@@ -1452,7 +1460,7 @@ The item that exceeds the limit is included and ends adding more items.
1452
1460
  maxRoughSize: number
1453
1461
  ```
1454
1462
 
1455
- #### Property offsets
1463
+ ###### Property offsets
1456
1464
 
1457
1465
  For each entity in dependency order, the offset at which to start returning items
1458
1466
  from `since`.
@@ -1478,7 +1486,7 @@ offsets: {
1478
1486
  }[]
1479
1487
  ```
1480
1488
 
1481
- #### Property since
1489
+ ###### Property since
1482
1490
 
1483
1491
  The max updated_at time received from the storage service receiving the request.
1484
1492
  Will be undefiend if this is the first request or if no data was previously sync'ed.
@@ -1489,7 +1497,7 @@ Will be undefiend if this is the first request or if no data was previously sync
1489
1497
  since?: Date
1490
1498
  ```
1491
1499
 
1492
- #### Property toStorageIdentityKey
1500
+ ###### Property toStorageIdentityKey
1493
1501
 
1494
1502
  The storageIdentityKey of the storage consuming the update SyncChunk data.
1495
1503
 
@@ -1502,7 +1510,7 @@ toStorageIdentityKey: string
1502
1510
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1503
1511
 
1504
1512
  ---
1505
- ### Interface: ScriptTemplateParamsSABPPP
1513
+ ##### Interface: ScriptTemplateParamsSABPPP
1506
1514
 
1507
1515
  ```ts
1508
1516
  export interface ScriptTemplateParamsSABPPP {
@@ -1515,7 +1523,7 @@ export interface ScriptTemplateParamsSABPPP {
1515
1523
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1516
1524
 
1517
1525
  ---
1518
- ### Interface: ScriptTemplateUnlock
1526
+ ##### Interface: ScriptTemplateUnlock
1519
1527
 
1520
1528
  ```ts
1521
1529
  export interface ScriptTemplateUnlock {
@@ -1527,7 +1535,13 @@ export interface ScriptTemplateUnlock {
1527
1535
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1528
1536
 
1529
1537
  ---
1530
- ### Interface: SetupEnv
1538
+ ##### Interface: SetupEnv
1539
+
1540
+ `SetupEnv` provides a starting point for managing secrets that
1541
+ must not appear in source code.
1542
+
1543
+ The `makeEnv` and `getEnv` functions of the `Setup` and `SetupClient` classes
1544
+ provide an easy way to create and import these secrets and related properties.
1531
1545
 
1532
1546
  ```ts
1533
1547
  export interface SetupEnv {
@@ -1542,10 +1556,72 @@ export interface SetupEnv {
1542
1556
 
1543
1557
  See also: [Chain](#type-chain)
1544
1558
 
1559
+ <details>
1560
+
1561
+ <summary>Interface SetupEnv Details</summary>
1562
+
1563
+ ###### Property chain
1564
+
1565
+ The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
1566
+
1567
+ ```ts
1568
+ chain: sdk.Chain
1569
+ ```
1570
+ See also: [Chain](#type-chain)
1571
+
1572
+ ###### Property devKeys
1573
+
1574
+ A map of public keys (identity keys, hex strings) to private keys (hex strings).
1575
+
1576
+ ```ts
1577
+ devKeys: Record<string, string>
1578
+ ```
1579
+
1580
+ ###### Property identityKey
1581
+
1582
+ The user's primary identity key (public key).
1583
+
1584
+ ```ts
1585
+ identityKey: string
1586
+ ```
1587
+
1588
+ ###### Property identityKey2
1589
+
1590
+ A secondary identity key (public key), used to test exchanges with other users.
1591
+
1592
+ ```ts
1593
+ identityKey2: string
1594
+ ```
1595
+
1596
+ ###### Property mySQLConnection
1597
+
1598
+ A MySQL connection string including user and password properties.
1599
+ Must be valid to make use of MySQL `Setup` class support.
1600
+
1601
+ ```ts
1602
+ mySQLConnection: string
1603
+ ```
1604
+
1605
+ ###### Property taalApiKey
1606
+
1607
+ A vaild TAAL API key for use by `Services`
1608
+
1609
+ ```ts
1610
+ taalApiKey: string
1611
+ ```
1612
+
1613
+ </details>
1614
+
1545
1615
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1546
1616
 
1547
1617
  ---
1548
- ### Interface: SetupWallet
1618
+ ##### Interface: SetupWallet
1619
+
1620
+ When creating a BRC-100 compatible `Wallet`, many components come into play.
1621
+
1622
+ All of the `createWallet` functions in the `Setup` and `SetupClient` classes return
1623
+ an object with direct access to each component to facilitate experimentation, testing
1624
+ and customization.
1549
1625
 
1550
1626
  ```ts
1551
1627
  export interface SetupWallet {
@@ -1562,17 +1638,107 @@ export interface SetupWallet {
1562
1638
 
1563
1639
  See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
1564
1640
 
1641
+ <details>
1642
+
1643
+ <summary>Interface SetupWallet Details</summary>
1644
+
1645
+ ###### Property chain
1646
+
1647
+ The chain ('main' or 'test') which the wallet accesses.
1648
+
1649
+ ```ts
1650
+ chain: sdk.Chain
1651
+ ```
1652
+ See also: [Chain](#type-chain)
1653
+
1654
+ ###### Property identityKey
1655
+
1656
+ The pubilc key associated with the `rootKey` which also serves as the wallet's identity.
1657
+
1658
+ ```ts
1659
+ identityKey: string
1660
+ ```
1661
+
1662
+ ###### Property keyDeriver
1663
+
1664
+ The `KeyDeriver` component used by the wallet for key derivation and cryptographic functions.
1665
+
1666
+ ```ts
1667
+ keyDeriver: KeyDeriver
1668
+ ```
1669
+
1670
+ ###### Property monitor
1671
+
1672
+ The background task `Monitor` component available to the wallet to offload tasks
1673
+ that speed up wallet operations and maintain data integrity.
1674
+
1675
+ ```ts
1676
+ monitor: Monitor
1677
+ ```
1678
+ See also: [Monitor](#class-monitor)
1679
+
1680
+ ###### Property rootKey
1681
+
1682
+ The rootKey of the `KeyDeriver`. The private key from which other keys are derived.
1683
+
1684
+ ```ts
1685
+ rootKey: PrivateKey
1686
+ ```
1687
+
1688
+ ###### Property services
1689
+
1690
+ The network `Services` component which provides the wallet with access to external services hosted
1691
+ on the public network.
1692
+
1693
+ ```ts
1694
+ services: Services
1695
+ ```
1696
+ See also: [Services](#class-services)
1697
+
1698
+ ###### Property storage
1699
+
1700
+ The `WalletStorageManager` that manages all the configured storage providers (active and backups)
1701
+ accessed by the wallet.
1702
+
1703
+ ```ts
1704
+ storage: WalletStorageManager
1705
+ ```
1706
+ See also: [WalletStorageManager](#class-walletstoragemanager)
1707
+
1708
+ ###### Property wallet
1709
+
1710
+ The actual BRC-100 `Wallet` to which all the other properties and components contribute.
1711
+
1712
+ Note that internally, the wallet is itself linked to all these properties and components.
1713
+ They are included in this interface to facilitate access after wallet construction for
1714
+ experimentation, testing and customization. Any changes made to the configuration of these
1715
+ components after construction may disrupt the normal operation of the wallet.
1716
+
1717
+ ```ts
1718
+ wallet: Wallet
1719
+ ```
1720
+ See also: [Wallet](#class-wallet)
1721
+
1722
+ </details>
1723
+
1565
1724
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1566
1725
 
1567
1726
  ---
1568
- ### Interface: SetupWalletArgs
1727
+ ##### Interface: SetupWalletArgs
1728
+
1729
+ Arguments used by `createWallet` to construct a `SetupWallet`.
1730
+
1731
+ Extension `SetupWalletClientArgs` used by `createWalletClient` to construct a `SetupWalletClient`.
1732
+
1733
+ Extension `SetupWalletKnexArgs` used by `createWalletKnex` to construct a `SetupWalletKnex`.
1569
1734
 
1570
- Arguments used to construct a `Wallet`
1735
+ Extension `SetupWalletMySQLArgs` used by `createWalletMySQL` to construct a `SetupWalletKnex`.
1736
+
1737
+ Extension `SetupWalletSQLiteArgs` used by `createWalletSQLite` to construct a `SetupWalletKnex`.
1571
1738
 
1572
1739
  ```ts
1573
1740
  export interface SetupWalletArgs {
1574
1741
  env: SetupEnv;
1575
- chain?: sdk.Chain;
1576
1742
  rootKeyHex?: string;
1577
1743
  privKeyHex?: string;
1578
1744
  active?: sdk.WalletStorageProvider;
@@ -1580,12 +1746,65 @@ export interface SetupWalletArgs {
1580
1746
  }
1581
1747
  ```
1582
1748
 
1583
- See also: [Chain](#type-chain), [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
1749
+ See also: [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
1750
+
1751
+ <details>
1752
+
1753
+ <summary>Interface SetupWalletArgs Details</summary>
1754
+
1755
+ ###### Property active
1756
+
1757
+ Optional. Active wallet storage. Can be added later.
1758
+
1759
+ ```ts
1760
+ active?: sdk.WalletStorageProvider
1761
+ ```
1762
+ See also: [WalletStorageProvider](#interface-walletstorageprovider)
1763
+
1764
+ ###### Property backups
1765
+
1766
+ Optional. One or more storage providers managed as backup destinations. Can be added later.
1767
+
1768
+ ```ts
1769
+ backups?: sdk.WalletStorageProvider[]
1770
+ ```
1771
+ See also: [WalletStorageProvider](#interface-walletstorageprovider)
1772
+
1773
+ ###### Property env
1774
+
1775
+ Configuration "secrets" typically obtained by `Setup.makeEnv` and `Setup.getEnv` functions.
1776
+
1777
+ ```ts
1778
+ env: SetupEnv
1779
+ ```
1780
+ See also: [SetupEnv](#interface-setupenv)
1781
+
1782
+ ###### Property privKeyHex
1783
+
1784
+ Optional. The privileged private key used to initialize the `PrivilegedKeyManager`.
1785
+ Defaults to undefined.
1786
+
1787
+ ```ts
1788
+ privKeyHex?: string
1789
+ ```
1790
+
1791
+ ###### Property rootKeyHex
1792
+
1793
+ Optional. The non-privileged private key used to initialize the `KeyDeriver` and determine the `identityKey`.
1794
+ Defaults to `env.devKeys[env.identityKey]
1795
+
1796
+ ```ts
1797
+ rootKeyHex?: string
1798
+ ```
1799
+
1800
+ </details>
1584
1801
 
1585
1802
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1586
1803
 
1587
1804
  ---
1588
- ### Interface: SetupWalletClient
1805
+ ##### Interface: SetupWalletClient
1806
+
1807
+ Extension `SetupWalletClient` of `SetupWallet` is returned by `createWalletClient`
1589
1808
 
1590
1809
  ```ts
1591
1810
  export interface SetupWalletClient extends SetupWallet {
@@ -1595,10 +1814,29 @@ export interface SetupWalletClient extends SetupWallet {
1595
1814
 
1596
1815
  See also: [SetupWallet](#interface-setupwallet)
1597
1816
 
1817
+ <details>
1818
+
1819
+ <summary>Interface SetupWalletClient Details</summary>
1820
+
1821
+ ###### Property endpointUrl
1822
+
1823
+ The endpoint URL of the service hosting the `StorageServer` JSON-RPC service to
1824
+ which a `StorageClient` instance is connected to function as
1825
+ the active storage provider of the wallet.
1826
+
1827
+ ```ts
1828
+ endpointUrl: string
1829
+ ```
1830
+
1831
+ </details>
1832
+
1598
1833
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1599
1834
 
1600
1835
  ---
1601
- ### Interface: SetupWalletClientArgs
1836
+ ##### Interface: SetupWalletClientArgs
1837
+
1838
+ Extension `SetupWalletClientArgs` of `SetupWalletArgs` is used by `createWalletClient`
1839
+ to construct a `SetupWalletClient`.
1602
1840
 
1603
1841
  ```ts
1604
1842
  export interface SetupWalletClientArgs extends SetupWalletArgs {
@@ -1608,10 +1846,26 @@ export interface SetupWalletClientArgs extends SetupWalletArgs {
1608
1846
 
1609
1847
  See also: [SetupWalletArgs](#interface-setupwalletargs)
1610
1848
 
1849
+ <details>
1850
+
1851
+ <summary>Interface SetupWalletClientArgs Details</summary>
1852
+
1853
+ ###### Property endpointUrl
1854
+
1855
+ The endpoint URL of a service hosting the `StorageServer` JSON-RPC service to
1856
+ which a `StorageClient` instance should connect to function as
1857
+ the active storage provider of the newly created wallet.
1858
+
1859
+ ```ts
1860
+ endpointUrl?: string
1861
+ ```
1862
+
1863
+ </details>
1864
+
1611
1865
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1612
1866
 
1613
1867
  ---
1614
- ### Interface: StorageCreateActionResult
1868
+ ##### Interface: StorageCreateActionResult
1615
1869
 
1616
1870
  ```ts
1617
1871
  export interface StorageCreateActionResult {
@@ -1631,7 +1885,7 @@ See also: [StorageCreateTransactionSdkInput](#interface-storagecreatetransaction
1631
1885
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1632
1886
 
1633
1887
  ---
1634
- ### Interface: StorageCreateTransactionSdkInput
1888
+ ##### Interface: StorageCreateTransactionSdkInput
1635
1889
 
1636
1890
  ```ts
1637
1891
  export interface StorageCreateTransactionSdkInput {
@@ -1655,7 +1909,7 @@ See also: [StorageProvidedBy](#type-storageprovidedby)
1655
1909
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1656
1910
 
1657
1911
  ---
1658
- ### Interface: StorageCreateTransactionSdkOutput
1912
+ ##### Interface: StorageCreateTransactionSdkOutput
1659
1913
 
1660
1914
  ```ts
1661
1915
  export interface StorageCreateTransactionSdkOutput extends sdk.ValidCreateActionOutput {
@@ -1671,7 +1925,7 @@ See also: [StorageProvidedBy](#type-storageprovidedby), [ValidCreateActionOutput
1671
1925
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1672
1926
 
1673
1927
  ---
1674
- ### Interface: StorageFeeModel
1928
+ ##### Interface: StorageFeeModel
1675
1929
 
1676
1930
  Specifies the available options for computing transaction fees.
1677
1931
 
@@ -1686,7 +1940,7 @@ export interface StorageFeeModel {
1686
1940
 
1687
1941
  <summary>Interface StorageFeeModel Details</summary>
1688
1942
 
1689
- #### Property model
1943
+ ###### Property model
1690
1944
 
1691
1945
  Available models. Currently only "sat/kb" is supported.
1692
1946
 
@@ -1694,7 +1948,7 @@ Available models. Currently only "sat/kb" is supported.
1694
1948
  model: "sat/kb"
1695
1949
  ```
1696
1950
 
1697
- #### Property value
1951
+ ###### Property value
1698
1952
 
1699
1953
  When "fee.model" is "sat/kb", this is an integer representing the number of satoshis per kb of block space
1700
1954
  the transaction will pay in fees.
@@ -1710,7 +1964,7 @@ value?: number
1710
1964
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1711
1965
 
1712
1966
  ---
1713
- ### Interface: StorageGetBeefOptions
1967
+ ##### Interface: StorageGetBeefOptions
1714
1968
 
1715
1969
  ```ts
1716
1970
  export interface StorageGetBeefOptions {
@@ -1728,7 +1982,7 @@ export interface StorageGetBeefOptions {
1728
1982
 
1729
1983
  <summary>Interface StorageGetBeefOptions Details</summary>
1730
1984
 
1731
- #### Property ignoreNewProven
1985
+ ###### Property ignoreNewProven
1732
1986
 
1733
1987
  optional. Default is false. If true, raw transactions with proofs missing from `storage` and obtained from `getServices` are not inserted to `storage`.
1734
1988
 
@@ -1736,7 +1990,7 @@ optional. Default is false. If true, raw transactions with proofs missing from `
1736
1990
  ignoreNewProven?: boolean
1737
1991
  ```
1738
1992
 
1739
- #### Property ignoreServices
1993
+ ###### Property ignoreServices
1740
1994
 
1741
1995
  optional. Default is false. `getServices` is used for raw transaction and merkle proof lookup
1742
1996
 
@@ -1744,7 +1998,7 @@ optional. Default is false. `getServices` is used for raw transaction and merkle
1744
1998
  ignoreServices?: boolean
1745
1999
  ```
1746
2000
 
1747
- #### Property ignoreStorage
2001
+ ###### Property ignoreStorage
1748
2002
 
1749
2003
  optional. Default is false. `storage` is used for raw transaction and merkle proof lookup
1750
2004
 
@@ -1752,7 +2006,7 @@ optional. Default is false. `storage` is used for raw transaction and merkle pro
1752
2006
  ignoreStorage?: boolean
1753
2007
  ```
1754
2008
 
1755
- #### Property knownTxids
2009
+ ###### Property knownTxids
1756
2010
 
1757
2011
  list of txids to be included as txidOnly if referenced. Validity is known to caller.
1758
2012
 
@@ -1760,7 +2014,7 @@ list of txids to be included as txidOnly if referenced. Validity is known to cal
1760
2014
  knownTxids?: string[]
1761
2015
  ```
1762
2016
 
1763
- #### Property mergeToBeef
2017
+ ###### Property mergeToBeef
1764
2018
 
1765
2019
  optional. If defined, raw transactions and merkle paths required by txid are merged to this instance and returned. Otherwise a new Beef is constructed and returned.
1766
2020
 
@@ -1768,7 +2022,7 @@ optional. If defined, raw transactions and merkle paths required by txid are mer
1768
2022
  mergeToBeef?: Beef | number[]
1769
2023
  ```
1770
2024
 
1771
- #### Property minProofLevel
2025
+ ###### Property minProofLevel
1772
2026
 
1773
2027
  optional. Default is zero. Ignores available merkle paths until recursion detpth equals or exceeds value
1774
2028
 
@@ -1776,7 +2030,7 @@ optional. Default is zero. Ignores available merkle paths until recursion detpth
1776
2030
  minProofLevel?: number
1777
2031
  ```
1778
2032
 
1779
- #### Property trustSelf
2033
+ ###### Property trustSelf
1780
2034
 
1781
2035
  if 'known', txids known to local storage as valid are included as txidOnly
1782
2036
 
@@ -1789,7 +2043,7 @@ trustSelf?: "known"
1789
2043
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1790
2044
 
1791
2045
  ---
1792
- ### Interface: StorageIdentity
2046
+ ##### Interface: StorageIdentity
1793
2047
 
1794
2048
  ```ts
1795
2049
  export interface StorageIdentity {
@@ -1802,7 +2056,7 @@ export interface StorageIdentity {
1802
2056
 
1803
2057
  <summary>Interface StorageIdentity Details</summary>
1804
2058
 
1805
- #### Property storageIdentityKey
2059
+ ###### Property storageIdentityKey
1806
2060
 
1807
2061
  The identity key (public key) assigned to this storage
1808
2062
 
@@ -1810,7 +2064,7 @@ The identity key (public key) assigned to this storage
1810
2064
  storageIdentityKey: string
1811
2065
  ```
1812
2066
 
1813
- #### Property storageName
2067
+ ###### Property storageName
1814
2068
 
1815
2069
  The human readable name assigned to this storage.
1816
2070
 
@@ -1823,7 +2077,7 @@ storageName: string
1823
2077
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1824
2078
 
1825
2079
  ---
1826
- ### Interface: StorageInternalizeActionResult
2080
+ ##### Interface: StorageInternalizeActionResult
1827
2081
 
1828
2082
  ```ts
1829
2083
  export interface StorageInternalizeActionResult extends InternalizeActionResult {
@@ -1837,7 +2091,7 @@ export interface StorageInternalizeActionResult extends InternalizeActionResult
1837
2091
 
1838
2092
  <summary>Interface StorageInternalizeActionResult Details</summary>
1839
2093
 
1840
- #### Property isMerge
2094
+ ###### Property isMerge
1841
2095
 
1842
2096
  true if internalizing outputs on an existing storage transaction
1843
2097
 
@@ -1845,7 +2099,7 @@ true if internalizing outputs on an existing storage transaction
1845
2099
  isMerge: boolean
1846
2100
  ```
1847
2101
 
1848
- #### Property satoshis
2102
+ ###### Property satoshis
1849
2103
 
1850
2104
  net change in change balance for user due to this internalization
1851
2105
 
@@ -1853,7 +2107,7 @@ net change in change balance for user due to this internalization
1853
2107
  satoshis: number
1854
2108
  ```
1855
2109
 
1856
- #### Property txid
2110
+ ###### Property txid
1857
2111
 
1858
2112
  txid of transaction being internalized
1859
2113
 
@@ -1866,7 +2120,7 @@ txid: string
1866
2120
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1867
2121
 
1868
2122
  ---
1869
- ### Interface: StorageProcessActionArgs
2123
+ ##### Interface: StorageProcessActionArgs
1870
2124
 
1871
2125
  ```ts
1872
2126
  export interface StorageProcessActionArgs {
@@ -1885,7 +2139,7 @@ export interface StorageProcessActionArgs {
1885
2139
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1886
2140
 
1887
2141
  ---
1888
- ### Interface: StorageProcessActionResults
2142
+ ##### Interface: StorageProcessActionResults
1889
2143
 
1890
2144
  ```ts
1891
2145
  export interface StorageProcessActionResults {
@@ -1897,7 +2151,7 @@ export interface StorageProcessActionResults {
1897
2151
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1898
2152
 
1899
2153
  ---
1900
- ### Interface: StorageProvenOrReq
2154
+ ##### Interface: StorageProvenOrReq
1901
2155
 
1902
2156
  ```ts
1903
2157
  export interface StorageProvenOrReq {
@@ -1909,7 +2163,7 @@ export interface StorageProvenOrReq {
1909
2163
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1910
2164
 
1911
2165
  ---
1912
- ### Interface: StorageProviderOptions
2166
+ ##### Interface: StorageProviderOptions
1913
2167
 
1914
2168
  ```ts
1915
2169
  export interface StorageProviderOptions extends StorageReaderWriterOptions {
@@ -1926,7 +2180,7 @@ See also: [Chain](#type-chain), [StorageFeeModel](#interface-storagefeemodel), [
1926
2180
 
1927
2181
  <summary>Interface StorageProviderOptions Details</summary>
1928
2182
 
1929
- #### Property commissionPubKeyHex
2183
+ ###### Property commissionPubKeyHex
1930
2184
 
1931
2185
  If commissionSatoshis is greater than zero, must be a valid public key hex string.
1932
2186
  The actual locking script for each commission will use a public key derived
@@ -1936,7 +2190,7 @@ from this key by information stored in the commissions table.
1936
2190
  commissionPubKeyHex?: PubKeyHex
1937
2191
  ```
1938
2192
 
1939
- #### Property commissionSatoshis
2193
+ ###### Property commissionSatoshis
1940
2194
 
1941
2195
  Transactions created by this Storage can charge a fee per transaction.
1942
2196
  A value of zero disables commission fees.
@@ -1950,7 +2204,7 @@ commissionSatoshis: number
1950
2204
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1951
2205
 
1952
2206
  ---
1953
- ### Interface: StorageReaderOptions
2207
+ ##### Interface: StorageReaderOptions
1954
2208
 
1955
2209
  ```ts
1956
2210
  export interface StorageReaderOptions {
@@ -1963,7 +2217,7 @@ See also: [Chain](#type-chain)
1963
2217
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1964
2218
 
1965
2219
  ---
1966
- ### Interface: StorageReaderWriterOptions
2220
+ ##### Interface: StorageReaderWriterOptions
1967
2221
 
1968
2222
  ```ts
1969
2223
  export interface StorageReaderWriterOptions extends StorageReaderOptions {
@@ -1975,7 +2229,7 @@ See also: [StorageReaderOptions](#interface-storagereaderoptions)
1975
2229
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
1976
2230
 
1977
2231
  ---
1978
- ### Interface: StorageSyncReader
2232
+ ##### Interface: StorageSyncReader
1979
2233
 
1980
2234
  This is the minimal interface required for a WalletStorageProvider to export data to another provider.
1981
2235
 
@@ -2008,7 +2262,7 @@ See also: [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs), [Fi
2008
2262
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2009
2263
 
2010
2264
  ---
2011
- ### Interface: StorageSyncReaderOptions
2265
+ ##### Interface: StorageSyncReaderOptions
2012
2266
 
2013
2267
  ```ts
2014
2268
  export interface StorageSyncReaderOptions {
@@ -2021,7 +2275,7 @@ See also: [Chain](#type-chain)
2021
2275
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2022
2276
 
2023
2277
  ---
2024
- ### Interface: StorageSyncReaderWriter
2278
+ ##### Interface: StorageSyncReaderWriter
2025
2279
 
2026
2280
  This is the minimal interface required for a WalletStorageProvider to import and export data to another provider.
2027
2281
 
@@ -2117,7 +2371,7 @@ See also: [AuthId](#interface-authid), [FindOutputTagMapsArgs](#interface-findou
2117
2371
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2118
2372
 
2119
2373
  ---
2120
- ### Interface: SyncChunk
2374
+ ##### Interface: SyncChunk
2121
2375
 
2122
2376
  Result received from remote `WalletStorage` in response to a `RequestSyncChunkArgs` request.
2123
2377
 
@@ -2149,7 +2403,7 @@ export interface SyncChunk {
2149
2403
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2150
2404
 
2151
2405
  ---
2152
- ### Interface: TaskPurgeParams
2406
+ ##### Interface: TaskPurgeParams
2153
2407
 
2154
2408
  The database stores a variety of data that may be considered transient.
2155
2409
 
@@ -2185,7 +2439,7 @@ See also: [PurgeParams](#interface-purgeparams)
2185
2439
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2186
2440
 
2187
2441
  ---
2188
- ### Interface: TrxToken
2442
+ ##### Interface: TrxToken
2189
2443
 
2190
2444
  Place holder for the transaction control object used by actual storage provider implementation.
2191
2445
 
@@ -2197,7 +2451,7 @@ export interface TrxToken {
2197
2451
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2198
2452
 
2199
2453
  ---
2200
- ### Interface: TscMerkleProofApi
2454
+ ##### Interface: TscMerkleProofApi
2201
2455
 
2202
2456
  ```ts
2203
2457
  export interface TscMerkleProofApi {
@@ -2210,7 +2464,7 @@ export interface TscMerkleProofApi {
2210
2464
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2211
2465
 
2212
2466
  ---
2213
- ### Interface: TxScriptOffsets
2467
+ ##### Interface: TxScriptOffsets
2214
2468
 
2215
2469
  ```ts
2216
2470
  export interface TxScriptOffsets {
@@ -2230,7 +2484,7 @@ export interface TxScriptOffsets {
2230
2484
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2231
2485
 
2232
2486
  ---
2233
- ### Interface: UpdateProvenTxReqWithNewProvenTxArgs
2487
+ ##### Interface: UpdateProvenTxReqWithNewProvenTxArgs
2234
2488
 
2235
2489
  ```ts
2236
2490
  export interface UpdateProvenTxReqWithNewProvenTxArgs {
@@ -2252,7 +2506,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
2252
2506
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2253
2507
 
2254
2508
  ---
2255
- ### Interface: UpdateProvenTxReqWithNewProvenTxResult
2509
+ ##### Interface: UpdateProvenTxReqWithNewProvenTxResult
2256
2510
 
2257
2511
  ```ts
2258
2512
  export interface UpdateProvenTxReqWithNewProvenTxResult {
@@ -2268,7 +2522,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
2268
2522
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2269
2523
 
2270
2524
  ---
2271
- ### Interface: ValidAbortActionArgs
2525
+ ##### Interface: ValidAbortActionArgs
2272
2526
 
2273
2527
  ```ts
2274
2528
  export interface ValidAbortActionArgs extends ValidWalletSignerArgs {
@@ -2281,7 +2535,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2281
2535
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2282
2536
 
2283
2537
  ---
2284
- ### Interface: ValidAcquireCertificateArgs
2538
+ ##### Interface: ValidAcquireCertificateArgs
2285
2539
 
2286
2540
  ```ts
2287
2541
  export interface ValidAcquireCertificateArgs extends ValidWalletSignerArgs {
@@ -2305,7 +2559,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2305
2559
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2306
2560
 
2307
2561
  ---
2308
- ### Interface: ValidAcquireDirectCertificateArgs
2562
+ ##### Interface: ValidAcquireDirectCertificateArgs
2309
2563
 
2310
2564
  ```ts
2311
2565
  export interface ValidAcquireDirectCertificateArgs extends ValidWalletSignerArgs {
@@ -2329,7 +2583,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2329
2583
 
2330
2584
  <summary>Interface ValidAcquireDirectCertificateArgs Details</summary>
2331
2585
 
2332
- #### Property subject
2586
+ ###### Property subject
2333
2587
 
2334
2588
  validated to an empty string, must be provided by wallet and must
2335
2589
  match expectations of keyringForSubject
@@ -2343,7 +2597,7 @@ subject: PubKeyHex
2343
2597
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2344
2598
 
2345
2599
  ---
2346
- ### Interface: ValidAcquireIssuanceCertificateArgs
2600
+ ##### Interface: ValidAcquireIssuanceCertificateArgs
2347
2601
 
2348
2602
  ```ts
2349
2603
  export interface ValidAcquireIssuanceCertificateArgs extends ValidWalletSignerArgs {
@@ -2363,7 +2617,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2363
2617
 
2364
2618
  <summary>Interface ValidAcquireIssuanceCertificateArgs Details</summary>
2365
2619
 
2366
- #### Property subject
2620
+ ###### Property subject
2367
2621
 
2368
2622
  validated to an empty string, must be provided by wallet and must
2369
2623
  match expectations of keyringForSubject
@@ -2377,7 +2631,7 @@ subject: PubKeyHex
2377
2631
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2378
2632
 
2379
2633
  ---
2380
- ### Interface: ValidBasketInsertion
2634
+ ##### Interface: ValidBasketInsertion
2381
2635
 
2382
2636
  ```ts
2383
2637
  export interface ValidBasketInsertion {
@@ -2390,7 +2644,7 @@ export interface ValidBasketInsertion {
2390
2644
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2391
2645
 
2392
2646
  ---
2393
- ### Interface: ValidCreateActionArgs
2647
+ ##### Interface: ValidCreateActionArgs
2394
2648
 
2395
2649
  ```ts
2396
2650
  export interface ValidCreateActionArgs extends ValidProcessActionArgs {
@@ -2403,6 +2657,7 @@ export interface ValidCreateActionArgs extends ValidProcessActionArgs {
2403
2657
  labels: string[];
2404
2658
  options: ValidCreateActionOptions;
2405
2659
  isSignAction: boolean;
2660
+ randomVals?: number[];
2406
2661
  }
2407
2662
  ```
2408
2663
 
@@ -2411,7 +2666,7 @@ See also: [ValidCreateActionInput](#interface-validcreateactioninput), [ValidCre
2411
2666
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2412
2667
 
2413
2668
  ---
2414
- ### Interface: ValidCreateActionInput
2669
+ ##### Interface: ValidCreateActionInput
2415
2670
 
2416
2671
  ```ts
2417
2672
  export interface ValidCreateActionInput {
@@ -2428,7 +2683,7 @@ See also: [OutPoint](#interface-outpoint)
2428
2683
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2429
2684
 
2430
2685
  ---
2431
- ### Interface: ValidCreateActionOptions
2686
+ ##### Interface: ValidCreateActionOptions
2432
2687
 
2433
2688
  ```ts
2434
2689
  export interface ValidCreateActionOptions extends ValidProcessActionOptions {
@@ -2445,7 +2700,7 @@ See also: [OutPoint](#interface-outpoint), [ValidProcessActionOptions](#interfac
2445
2700
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2446
2701
 
2447
2702
  ---
2448
- ### Interface: ValidCreateActionOutput
2703
+ ##### Interface: ValidCreateActionOutput
2449
2704
 
2450
2705
  ```ts
2451
2706
  export interface ValidCreateActionOutput {
@@ -2461,7 +2716,7 @@ export interface ValidCreateActionOutput {
2461
2716
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2462
2717
 
2463
2718
  ---
2464
- ### Interface: ValidDiscoverByAttributesArgs
2719
+ ##### Interface: ValidDiscoverByAttributesArgs
2465
2720
 
2466
2721
  ```ts
2467
2722
  export interface ValidDiscoverByAttributesArgs extends ValidWalletSignerArgs {
@@ -2477,7 +2732,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2477
2732
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2478
2733
 
2479
2734
  ---
2480
- ### Interface: ValidDiscoverByIdentityKeyArgs
2735
+ ##### Interface: ValidDiscoverByIdentityKeyArgs
2481
2736
 
2482
2737
  ```ts
2483
2738
  export interface ValidDiscoverByIdentityKeyArgs extends ValidWalletSignerArgs {
@@ -2493,7 +2748,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2493
2748
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2494
2749
 
2495
2750
  ---
2496
- ### Interface: ValidInternalizeActionArgs
2751
+ ##### Interface: ValidInternalizeActionArgs
2497
2752
 
2498
2753
  ```ts
2499
2754
  export interface ValidInternalizeActionArgs extends ValidWalletSignerArgs {
@@ -2510,7 +2765,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2510
2765
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2511
2766
 
2512
2767
  ---
2513
- ### Interface: ValidInternalizeOutput
2768
+ ##### Interface: ValidInternalizeOutput
2514
2769
 
2515
2770
  ```ts
2516
2771
  export interface ValidInternalizeOutput {
@@ -2526,7 +2781,7 @@ See also: [ValidBasketInsertion](#interface-validbasketinsertion), [ValidWalletP
2526
2781
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2527
2782
 
2528
2783
  ---
2529
- ### Interface: ValidListActionsArgs
2784
+ ##### Interface: ValidListActionsArgs
2530
2785
 
2531
2786
  ```ts
2532
2787
  export interface ValidListActionsArgs extends ValidWalletSignerArgs {
@@ -2549,7 +2804,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2549
2804
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2550
2805
 
2551
2806
  ---
2552
- ### Interface: ValidListCertificatesArgs
2807
+ ##### Interface: ValidListCertificatesArgs
2553
2808
 
2554
2809
  ```ts
2555
2810
  export interface ValidListCertificatesArgs extends ValidWalletSignerArgs {
@@ -2575,7 +2830,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2575
2830
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2576
2831
 
2577
2832
  ---
2578
- ### Interface: ValidListOutputsArgs
2833
+ ##### Interface: ValidListOutputsArgs
2579
2834
 
2580
2835
  ```ts
2581
2836
  export interface ValidListOutputsArgs extends ValidWalletSignerArgs {
@@ -2599,7 +2854,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2599
2854
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2600
2855
 
2601
2856
  ---
2602
- ### Interface: ValidProcessActionArgs
2857
+ ##### Interface: ValidProcessActionArgs
2603
2858
 
2604
2859
  ```ts
2605
2860
  export interface ValidProcessActionArgs extends ValidWalletSignerArgs {
@@ -2616,7 +2871,7 @@ See also: [ValidProcessActionOptions](#interface-validprocessactionoptions), [Va
2616
2871
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2617
2872
 
2618
2873
  ---
2619
- ### Interface: ValidProcessActionOptions
2874
+ ##### Interface: ValidProcessActionOptions
2620
2875
 
2621
2876
  ```ts
2622
2877
  export interface ValidProcessActionOptions {
@@ -2630,7 +2885,7 @@ export interface ValidProcessActionOptions {
2630
2885
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2631
2886
 
2632
2887
  ---
2633
- ### Interface: ValidProveCertificateArgs
2888
+ ##### Interface: ValidProveCertificateArgs
2634
2889
 
2635
2890
  ```ts
2636
2891
  export interface ValidProveCertificateArgs extends ValidWalletSignerArgs {
@@ -2652,7 +2907,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2652
2907
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2653
2908
 
2654
2909
  ---
2655
- ### Interface: ValidRelinquishCertificateArgs
2910
+ ##### Interface: ValidRelinquishCertificateArgs
2656
2911
 
2657
2912
  ```ts
2658
2913
  export interface ValidRelinquishCertificateArgs extends ValidWalletSignerArgs {
@@ -2667,7 +2922,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2667
2922
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2668
2923
 
2669
2924
  ---
2670
- ### Interface: ValidRelinquishOutputArgs
2925
+ ##### Interface: ValidRelinquishOutputArgs
2671
2926
 
2672
2927
  ```ts
2673
2928
  export interface ValidRelinquishOutputArgs extends ValidWalletSignerArgs {
@@ -2681,7 +2936,7 @@ See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
2681
2936
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2682
2937
 
2683
2938
  ---
2684
- ### Interface: ValidSignActionArgs
2939
+ ##### Interface: ValidSignActionArgs
2685
2940
 
2686
2941
  ```ts
2687
2942
  export interface ValidSignActionArgs extends ValidProcessActionArgs {
@@ -2696,7 +2951,7 @@ See also: [ValidProcessActionArgs](#interface-validprocessactionargs), [ValidSig
2696
2951
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2697
2952
 
2698
2953
  ---
2699
- ### Interface: ValidSignActionOptions
2954
+ ##### Interface: ValidSignActionOptions
2700
2955
 
2701
2956
  ```ts
2702
2957
  export interface ValidSignActionOptions extends ValidProcessActionOptions {
@@ -2712,7 +2967,7 @@ See also: [ValidProcessActionOptions](#interface-validprocessactionoptions)
2712
2967
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2713
2968
 
2714
2969
  ---
2715
- ### Interface: ValidWalletPayment
2970
+ ##### Interface: ValidWalletPayment
2716
2971
 
2717
2972
  ```ts
2718
2973
  export interface ValidWalletPayment {
@@ -2725,7 +2980,7 @@ export interface ValidWalletPayment {
2725
2980
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2726
2981
 
2727
2982
  ---
2728
- ### Interface: ValidWalletSignerArgs
2983
+ ##### Interface: ValidWalletSignerArgs
2729
2984
 
2730
2985
  ```ts
2731
2986
  export interface ValidWalletSignerArgs {
@@ -2735,7 +2990,7 @@ export interface ValidWalletSignerArgs {
2735
2990
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2736
2991
 
2737
2992
  ---
2738
- ### Interface: WalletArgs
2993
+ ##### Interface: WalletArgs
2739
2994
 
2740
2995
  ```ts
2741
2996
  export interface WalletArgs {
@@ -2753,7 +3008,7 @@ See also: [Chain](#type-chain), [Monitor](#class-monitor), [PrivilegedKeyManager
2753
3008
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2754
3009
 
2755
3010
  ---
2756
- ### Interface: WalletServices
3011
+ ##### Interface: WalletServices
2757
3012
 
2758
3013
  Defines standard interfaces to access functionality implemented by external transaction processing services.
2759
3014
 
@@ -2781,7 +3036,7 @@ See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [GetMerkl
2781
3036
 
2782
3037
  <summary>Interface WalletServices Details</summary>
2783
3038
 
2784
- #### Property chain
3039
+ ###### Property chain
2785
3040
 
2786
3041
  The chain being serviced.
2787
3042
 
@@ -2790,7 +3045,7 @@ chain: sdk.Chain
2790
3045
  ```
2791
3046
  See also: [Chain](#type-chain)
2792
3047
 
2793
- #### Method getBsvExchangeRate
3048
+ ###### Method getBsvExchangeRate
2794
3049
 
2795
3050
  Approximate exchange rate US Dollar / BSV, USD / BSV
2796
3051
 
@@ -2800,7 +3055,7 @@ This is the US Dollar price of one BSV
2800
3055
  getBsvExchangeRate(): Promise<number>
2801
3056
  ```
2802
3057
 
2803
- #### Method getChainTracker
3058
+ ###### Method getChainTracker
2804
3059
 
2805
3060
  ```ts
2806
3061
  getChainTracker(): Promise<ChainTracker>
@@ -2810,7 +3065,7 @@ Returns
2810
3065
 
2811
3066
  standard `ChainTracker` service which requires `options.chaintracks` be valid.
2812
3067
 
2813
- #### Method getFiatExchangeRate
3068
+ ###### Method getFiatExchangeRate
2814
3069
 
2815
3070
  Approximate exchange rate currency per base.
2816
3071
 
@@ -2818,7 +3073,7 @@ Approximate exchange rate currency per base.
2818
3073
  getFiatExchangeRate(currency: "USD" | "GBP" | "EUR", base?: "USD" | "GBP" | "EUR"): Promise<number>
2819
3074
  ```
2820
3075
 
2821
- #### Method getHeaderForHeight
3076
+ ###### Method getHeaderForHeight
2822
3077
 
2823
3078
  ```ts
2824
3079
  getHeaderForHeight(height: number): Promise<number[]>
@@ -2828,7 +3083,7 @@ Returns
2828
3083
 
2829
3084
  serialized block header for height on active chain
2830
3085
 
2831
- #### Method getHeight
3086
+ ###### Method getHeight
2832
3087
 
2833
3088
  ```ts
2834
3089
  getHeight(): Promise<number>
@@ -2838,7 +3093,7 @@ Returns
2838
3093
 
2839
3094
  the height of the active chain
2840
3095
 
2841
- #### Method getMerklePath
3096
+ ###### Method getMerklePath
2842
3097
 
2843
3098
  Attempts to obtain the merkle proof associated with a 32 byte transaction hash (txid).
2844
3099
 
@@ -2868,7 +3123,7 @@ Argument Details
2868
3123
  + **useNext**
2869
3124
  + optional, forces skip to next service before starting service requests cycle.
2870
3125
 
2871
- #### Method getRawTx
3126
+ ###### Method getRawTx
2872
3127
 
2873
3128
  Attempts to obtain the raw transaction bytes associated with a 32 byte transaction hash (txid).
2874
3129
 
@@ -2898,7 +3153,7 @@ Argument Details
2898
3153
  + **useNext**
2899
3154
  + optional, forces skip to next service before starting service requests cycle.
2900
3155
 
2901
- #### Method getUtxoStatus
3156
+ ###### Method getUtxoStatus
2902
3157
 
2903
3158
  Attempts to determine the UTXO status of a transaction output.
2904
3159
 
@@ -2924,7 +3179,7 @@ undefined if length of `output` is 32 then 'hashBE`, otherwise 'script'.
2924
3179
  + **useNext**
2925
3180
  + optional, forces skip to next service before starting service requests cycle.
2926
3181
 
2927
- #### Method hashToHeader
3182
+ ###### Method hashToHeader
2928
3183
 
2929
3184
  ```ts
2930
3185
  hashToHeader(hash: string): Promise<sdk.BlockHeader>
@@ -2940,7 +3195,7 @@ Argument Details
2940
3195
  + **hash**
2941
3196
  + block hash
2942
3197
 
2943
- #### Method nLockTimeIsFinal
3198
+ ###### Method nLockTimeIsFinal
2944
3199
 
2945
3200
  ```ts
2946
3201
  nLockTimeIsFinal(txOrLockTime: string | number[] | BsvTransaction | number): Promise<boolean>
@@ -2960,7 +3215,7 @@ Argument Details
2960
3215
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2961
3216
 
2962
3217
  ---
2963
- ### Interface: WalletServicesOptions
3218
+ ##### Interface: WalletServicesOptions
2964
3219
 
2965
3220
  ```ts
2966
3221
  export interface WalletServicesOptions {
@@ -2982,7 +3237,7 @@ See also: [BsvExchangeRate](#interface-bsvexchangerate), [Chain](#type-chain), [
2982
3237
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2983
3238
 
2984
3239
  ---
2985
- ### Interface: WalletSigner
3240
+ ##### Interface: WalletSigner
2986
3241
 
2987
3242
  ```ts
2988
3243
  export interface WalletSigner {
@@ -2997,7 +3252,7 @@ See also: [Chain](#type-chain)
2997
3252
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
2998
3253
 
2999
3254
  ---
3000
- ### Interface: WalletStorage
3255
+ ##### Interface: WalletStorage
3001
3256
 
3002
3257
  This is the `WalletStorage` interface implemented by a class such as `WalletStorageManager`,
3003
3258
  which manges an active and set of backup storage providers.
@@ -3043,7 +3298,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
3043
3298
 
3044
3299
  <summary>Interface WalletStorage Details</summary>
3045
3300
 
3046
- #### Method isStorageProvider
3301
+ ###### Method isStorageProvider
3047
3302
 
3048
3303
  ```ts
3049
3304
  isStorageProvider(): boolean
@@ -3058,7 +3313,7 @@ false
3058
3313
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3059
3314
 
3060
3315
  ---
3061
- ### Interface: WalletStorageProvider
3316
+ ##### Interface: WalletStorageProvider
3062
3317
 
3063
3318
  This is the `WalletStorage` interface implemented with authentication checking and
3064
3319
  is the actual minimal interface implemented by storage and remoted storage providers.
@@ -3076,7 +3331,7 @@ See also: [WalletServices](#interface-walletservices), [WalletStorageSync](#inte
3076
3331
 
3077
3332
  <summary>Interface WalletStorageProvider Details</summary>
3078
3333
 
3079
- #### Method isStorageProvider
3334
+ ###### Method isStorageProvider
3080
3335
 
3081
3336
  ```ts
3082
3337
  isStorageProvider(): boolean
@@ -3091,7 +3346,7 @@ true if this object's interface can be extended to the full `StorageProvider` in
3091
3346
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3092
3347
 
3093
3348
  ---
3094
- ### Interface: WalletStorageReader
3349
+ ##### Interface: WalletStorageReader
3095
3350
 
3096
3351
  ```ts
3097
3352
  export interface WalletStorageReader {
@@ -3113,7 +3368,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
3113
3368
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3114
3369
 
3115
3370
  ---
3116
- ### Interface: WalletStorageSync
3371
+ ##### Interface: WalletStorageSync
3117
3372
 
3118
3373
  ```ts
3119
3374
  export interface WalletStorageSync extends WalletStorageWriter {
@@ -3132,7 +3387,7 @@ See also: [AuthId](#interface-authid), [ProcessSyncChunkResult](#interface-proce
3132
3387
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3133
3388
 
3134
3389
  ---
3135
- ### Interface: WalletStorageWriter
3390
+ ##### Interface: WalletStorageWriter
3136
3391
 
3137
3392
  ```ts
3138
3393
  export interface WalletStorageWriter extends WalletStorageReader {
@@ -3158,7 +3413,7 @@ See also: [AuthId](#interface-authid), [StorageCreateActionResult](#interface-st
3158
3413
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3159
3414
 
3160
3415
  ---
3161
- ### Interface: XValidCreateActionOutput
3416
+ ##### Interface: XValidCreateActionOutput
3162
3417
 
3163
3418
  ```ts
3164
3419
  export interface XValidCreateActionOutput extends sdk.ValidCreateActionOutput {
@@ -3175,7 +3430,7 @@ See also: [StorageProvidedBy](#type-storageprovidedby), [ValidCreateActionOutput
3175
3430
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3176
3431
 
3177
3432
  ---
3178
- ## Classes
3433
+ #### Classes
3179
3434
 
3180
3435
  | | | |
3181
3436
  | --- | --- | --- |
@@ -3196,7 +3451,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
3196
3451
 
3197
3452
  ---
3198
3453
 
3199
- ### Class: CertOps
3454
+ ##### Class: CertOps
3200
3455
 
3201
3456
  ```ts
3202
3457
  export class CertOps extends BsvCertificate {
@@ -3246,7 +3501,7 @@ See also: [CertOpsWallet](#interface-certopswallet)
3246
3501
 
3247
3502
  <summary>Class CertOps Details</summary>
3248
3503
 
3249
- #### Method createKeyringForVerifier
3504
+ ###### Method createKeyringForVerifier
3250
3505
 
3251
3506
  Creates a verifiable certificate structure for a specific verifier, allowing them access to specified fields.
3252
3507
  This method decrypts the master field keys for each field specified in `fieldsToReveal` and re-encrypts them
@@ -3274,7 +3529,7 @@ Throws an error if:
3274
3529
  - fieldsToReveal is empty or a field in `fieldsToReveal` does not exist in the certificate.
3275
3530
  - The decrypted master field key fails to decrypt the corresponding field (indicating an invalid key).
3276
3531
 
3277
- #### Method encryptAndSignNewCertificate
3532
+ ###### Method encryptAndSignNewCertificate
3278
3533
 
3279
3534
  encrypt plaintext field values for the subject
3280
3535
  update the signature using the certifier's private key.
@@ -3288,7 +3543,7 @@ async encryptAndSignNewCertificate(): Promise<void>
3288
3543
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3289
3544
 
3290
3545
  ---
3291
- ### Class: Monitor
3546
+ ##### Class: Monitor
3292
3547
 
3293
3548
  Background task to make sure transactions are processed, transaction proofs are received and propagated,
3294
3549
  and potentially that reorgs update proofs that were already received.
@@ -3343,7 +3598,7 @@ See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorO
3343
3598
 
3344
3599
  <summary>Class Monitor Details</summary>
3345
3600
 
3346
- #### Property _otherTasks
3601
+ ###### Property _otherTasks
3347
3602
 
3348
3603
  _otherTasks can be run by runTask but not by scheduler.
3349
3604
 
@@ -3352,7 +3607,7 @@ _otherTasks: WalletMonitorTask[] = []
3352
3607
  ```
3353
3608
  See also: [WalletMonitorTask](#class-walletmonitortask)
3354
3609
 
3355
- #### Property _tasks
3610
+ ###### Property _tasks
3356
3611
 
3357
3612
  _tasks are typically run by the scheduler but may also be run by runTask.
3358
3613
 
@@ -3361,7 +3616,7 @@ _tasks: WalletMonitorTask[] = []
3361
3616
  ```
3362
3617
  See also: [WalletMonitorTask](#class-walletmonitortask)
3363
3618
 
3364
- #### Method addDefaultTasks
3619
+ ###### Method addDefaultTasks
3365
3620
 
3366
3621
  Default tasks with settings appropriate for a single user storage
3367
3622
  possibly with sync'ing enabled
@@ -3370,7 +3625,7 @@ possibly with sync'ing enabled
3370
3625
  addDefaultTasks(): void
3371
3626
  ```
3372
3627
 
3373
- #### Method addMultiUserTasks
3628
+ ###### Method addMultiUserTasks
3374
3629
 
3375
3630
  Tasks appropriate for multi-user storage
3376
3631
  without sync'ing enabled.
@@ -3379,7 +3634,7 @@ without sync'ing enabled.
3379
3634
  addMultiUserTasks(): void
3380
3635
  ```
3381
3636
 
3382
- #### Method processNewBlockHeader
3637
+ ###### Method processNewBlockHeader
3383
3638
 
3384
3639
  Process new chain header event received from Chaintracks
3385
3640
 
@@ -3390,7 +3645,7 @@ processNewBlockHeader(header: BlockHeader): void
3390
3645
  ```
3391
3646
  See also: [BlockHeader](#interface-blockheader)
3392
3647
 
3393
- #### Method processReorg
3648
+ ###### Method processReorg
3394
3649
 
3395
3650
  Process reorg event received from Chaintracks
3396
3651
 
@@ -3411,7 +3666,7 @@ See also: [BlockHeader](#interface-blockheader)
3411
3666
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3412
3667
 
3413
3668
  ---
3414
- ### Class: PrivilegedKeyManager
3669
+ ##### Class: PrivilegedKeyManager
3415
3670
 
3416
3671
  PrivilegedKeyManager
3417
3672
 
@@ -3446,7 +3701,7 @@ export class PrivilegedKeyManager implements ProtoWallet {
3446
3701
 
3447
3702
  <summary>Class PrivilegedKeyManager Details</summary>
3448
3703
 
3449
- #### Constructor
3704
+ ###### Constructor
3450
3705
 
3451
3706
  ```ts
3452
3707
  constructor(keyGetter: (reason: string) => Promise<PrivateKey>, retentionPeriod = 120000)
@@ -3459,7 +3714,7 @@ Argument Details
3459
3714
  + **retentionPeriod**
3460
3715
  + Time in milliseconds to retain the obfuscated key in memory before zeroizing.
3461
3716
 
3462
- #### Method destroyKey
3717
+ ###### Method destroyKey
3463
3718
 
3464
3719
  Safely destroys the in-memory obfuscated key material by zeroizing
3465
3720
  and deleting related fields. Also destroys some (but not all) decoy
@@ -3474,7 +3729,7 @@ destroyKey(): void
3474
3729
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3475
3730
 
3476
3731
  ---
3477
- ### Class: ScriptTemplateSABPPP
3732
+ ##### Class: ScriptTemplateSABPPP
3478
3733
 
3479
3734
  Simple Authenticated BSV P2PKH Payment Protocol
3480
3735
  https://brc.dev/29
@@ -3500,7 +3755,7 @@ See also: [ScriptTemplateParamsSABPPP](#interface-scripttemplateparamssabppp)
3500
3755
 
3501
3756
  <summary>Class ScriptTemplateSABPPP Details</summary>
3502
3757
 
3503
- #### Property unlockLength
3758
+ ###### Property unlockLength
3504
3759
 
3505
3760
  P2PKH unlock estimateLength is a constant
3506
3761
 
@@ -3513,7 +3768,7 @@ unlockLength = 108
3513
3768
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3514
3769
 
3515
3770
  ---
3516
- ### Class: ServiceCollection
3771
+ ##### Class: ServiceCollection
3517
3772
 
3518
3773
  ```ts
3519
3774
  export class ServiceCollection<T> {
@@ -3545,7 +3800,7 @@ export class ServiceCollection<T> {
3545
3800
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3546
3801
 
3547
3802
  ---
3548
- ### Class: Services
3803
+ ##### Class: Services
3549
3804
 
3550
3805
  ```ts
3551
3806
  export class Services implements sdk.WalletServices {
@@ -3588,7 +3843,7 @@ See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [FiatExch
3588
3843
 
3589
3844
  <summary>Class Services Details</summary>
3590
3845
 
3591
- #### Method postTxs
3846
+ ###### Method postTxs
3592
3847
 
3593
3848
  The beef must contain at least each rawTx for each txid.
3594
3849
  Some services may require input transactions as well.
@@ -3604,7 +3859,7 @@ See also: [PostTxsResult](#interface-posttxsresult)
3604
3859
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3605
3860
 
3606
3861
  ---
3607
- ### Class: SetupClient
3862
+ ##### Class: SetupClient
3608
3863
 
3609
3864
  The `SetupClient` class provides static setup functions to construct BRC-100 compatible
3610
3865
  wallets in a variety of configurations.
@@ -3646,18 +3901,17 @@ export abstract class SetupClient {
3646
3901
  }
3647
3902
  static getEnv(chain: sdk.Chain): SetupEnv
3648
3903
  static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
3649
- args.chain ||= args.env.chain;
3904
+ const chain = args.env.chain;
3650
3905
  args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
3651
3906
  const rootKey = PrivateKey.fromHex(args.rootKeyHex);
3652
3907
  const identityKey = rootKey.toPublicKey().toString();
3653
3908
  const keyDeriver = new KeyDeriver(rootKey);
3654
- const chain = args.chain;
3655
3909
  const storage = new WalletStorageManager(identityKey, args.active, args.backups);
3656
3910
  if (storage.stores.length > 0)
3657
3911
  await storage.makeAvailable();
3658
3912
  const serviceOptions = Services.createDefaultOptions(chain);
3659
3913
  serviceOptions.taalApiKey = args.env.taalApiKey;
3660
- const services = new Services(args.chain);
3914
+ const services = new Services(chain);
3661
3915
  const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
3662
3916
  const monitor = new Monitor(monopts);
3663
3917
  monitor.addDefaultTasks();
@@ -3686,7 +3940,7 @@ export abstract class SetupClient {
3686
3940
  };
3687
3941
  return r;
3688
3942
  }
3689
- static async createWalletWithStorageClient(args: SetupWalletClientArgs): Promise<SetupWalletClient>
3943
+ static async createWalletClient(args: SetupWalletClientArgs): Promise<SetupWalletClient>
3690
3944
  static getKeyPair(priv?: string | PrivateKey): KeyPairAddress
3691
3945
  static getLockP2PKH(address: string)
3692
3946
  static getUnlockP2PKH(priv: PrivateKey, satoshis: number): sdk.ScriptTemplateUnlock
@@ -3717,7 +3971,7 @@ See also: [Chain](#type-chain), [KeyPairAddress](#type-keypairaddress), [Monitor
3717
3971
 
3718
3972
  <summary>Class SetupClient Details</summary>
3719
3973
 
3720
- #### Method createWallet
3974
+ ###### Method createWallet
3721
3975
 
3722
3976
  Create a `Wallet`. Storage can optionally be provided or configured later.
3723
3977
 
@@ -3726,18 +3980,17 @@ Optionally, PrivilegedKeyManager is also configured.
3726
3980
 
3727
3981
  ```ts
3728
3982
  static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
3729
- args.chain ||= args.env.chain;
3983
+ const chain = args.env.chain;
3730
3984
  args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
3731
3985
  const rootKey = PrivateKey.fromHex(args.rootKeyHex);
3732
3986
  const identityKey = rootKey.toPublicKey().toString();
3733
3987
  const keyDeriver = new KeyDeriver(rootKey);
3734
- const chain = args.chain;
3735
3988
  const storage = new WalletStorageManager(identityKey, args.active, args.backups);
3736
3989
  if (storage.stores.length > 0)
3737
3990
  await storage.makeAvailable();
3738
3991
  const serviceOptions = Services.createDefaultOptions(chain);
3739
3992
  serviceOptions.taalApiKey = args.env.taalApiKey;
3740
- const services = new Services(args.chain);
3993
+ const services = new Services(chain);
3741
3994
  const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
3742
3995
  const monitor = new Monitor(monopts);
3743
3996
  monitor.addDefaultTasks();
@@ -3769,7 +4022,7 @@ static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
3769
4022
  ```
3770
4023
  See also: [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [Services](#class-services), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
3771
4024
 
3772
- #### Method getEnv
4025
+ ###### Method getEnv
3773
4026
 
3774
4027
  Reads a .env file of the format created by `makeEnv`.
3775
4028
 
@@ -3791,7 +4044,7 @@ Argument Details
3791
4044
  + **chain**
3792
4045
  + Which chain to use: 'test' or 'main'
3793
4046
 
3794
- #### Method makeEnv
4047
+ ###### Method makeEnv
3795
4048
 
3796
4049
  Creates content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
3797
4050
 
@@ -3809,7 +4062,7 @@ static makeEnv(): string
3809
4062
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3810
4063
 
3811
4064
  ---
3812
- ### Class: StorageClient
4065
+ ##### Class: StorageClient
3813
4066
 
3814
4067
  ```ts
3815
4068
  export class StorageClient implements sdk.WalletStorageProvider {
@@ -3857,7 +4110,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
3857
4110
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
3858
4111
 
3859
4112
  ---
3860
- ### Class: StorageProvider
4113
+ ##### Class: StorageProvider
3861
4114
 
3862
4115
  ```ts
3863
4116
  export abstract class StorageProvider extends StorageReaderWriter implements sdk.WalletStorageProvider {
@@ -3925,7 +4178,7 @@ See also: [AuthId](#interface-authid), [Chain](#type-chain), [FindCertificatesAr
3925
4178
 
3926
4179
  <summary>Class StorageProvider Details</summary>
3927
4180
 
3928
- #### Method confirmSpendableOutputs
4181
+ ###### Method confirmSpendableOutputs
3929
4182
 
3930
4183
  For each spendable output in the 'default' basket of the authenticated user,
3931
4184
  verify that the output script, satoshis, vout and txid match that of an output
@@ -3941,7 +4194,7 @@ Returns
3941
4194
 
3942
4195
  object with invalidSpendableOutputs array. A good result is an empty array.
3943
4196
 
3944
- #### Method getProvenOrReq
4197
+ ###### Method getProvenOrReq
3945
4198
 
3946
4199
  Checks if txid is a known valid ProvenTx and returns it if found.
3947
4200
  Next checks if txid is a current ProvenTxReq and returns that if found.
@@ -3956,10 +4209,10 @@ async getProvenOrReq(txid: string, newReq?: table.ProvenTxReq, trx?: sdk.TrxToke
3956
4209
  ```
3957
4210
  See also: [StorageProvenOrReq](#interface-storageprovenorreq), [TrxToken](#interface-trxtoken)
3958
4211
 
3959
- #### Method getReqsAndBeefToShareWithWorld
4212
+ ###### Method getReqsAndBeefToShareWithWorld
3960
4213
 
3961
4214
  Given an array of transaction txids with current ProvenTxReq ready-to-share status,
3962
- lookup their DojoProvenTxReqApi req records.
4215
+ lookup their ProvenTxReqApi req records.
3963
4216
  For the txids with reqs and status still ready to send construct a single merged beef.
3964
4217
 
3965
4218
  ```ts
@@ -3967,7 +4220,7 @@ async getReqsAndBeefToShareWithWorld(txids: string[], knownTxids: string[], trx?
3967
4220
  ```
3968
4221
  See also: [GetReqsAndBeefResult](#interface-getreqsandbeefresult), [TrxToken](#interface-trxtoken)
3969
4222
 
3970
- #### Method updateProvenTxReqWithNewProvenTx
4223
+ ###### Method updateProvenTxReqWithNewProvenTx
3971
4224
 
3972
4225
  Handles storage changes when a valid MerklePath and mined block header are found for a ProvenTxReq txid.
3973
4226
 
@@ -3986,7 +4239,7 @@ async updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenT
3986
4239
  ```
3987
4240
  See also: [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult)
3988
4241
 
3989
- #### Method updateTransactionStatus
4242
+ ###### Method updateTransactionStatus
3990
4243
 
3991
4244
  For all `status` values besides 'failed', just updates the transaction records status property.
3992
4245
 
@@ -3997,18 +4250,12 @@ async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: num
3997
4250
  ```
3998
4251
  See also: [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken)
3999
4252
 
4000
- Throws
4001
-
4002
- ERR_DOJO_COMPLETED_TX if current status is 'completed' and new status is not 'completed.
4003
-
4004
- ERR_DOJO_PROVEN_TX if transaction has proof or provenTxId and new status is not 'completed'.
4005
-
4006
4253
  </details>
4007
4254
 
4008
4255
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4009
4256
 
4010
4257
  ---
4011
- ### Class: StorageReader
4258
+ ##### Class: StorageReader
4012
4259
 
4013
4260
  The `StorageReader` abstract class is the base of the concrete wallet storage provider classes.
4014
4261
 
@@ -4077,7 +4324,7 @@ See also: [Chain](#type-chain), [DBType](#type-dbtype), [FindCertificateFieldsAr
4077
4324
 
4078
4325
  <summary>Class StorageReader Details</summary>
4079
4326
 
4080
- #### Method validateEntityDate
4327
+ ###### Method validateEntityDate
4081
4328
 
4082
4329
  Force dates to strings on SQLite and Date objects on MySQL
4083
4330
 
@@ -4085,7 +4332,7 @@ Force dates to strings on SQLite and Date objects on MySQL
4085
4332
  validateEntityDate(date: Date | string | number): Date | string
4086
4333
  ```
4087
4334
 
4088
- #### Method validateOptionalEntityDate
4335
+ ###### Method validateOptionalEntityDate
4089
4336
 
4090
4337
  ```ts
4091
4338
  validateOptionalEntityDate(date: Date | string | number | null | undefined, useNowAsDefault?: boolean): Date | string | undefined
@@ -4101,7 +4348,7 @@ Argument Details
4101
4348
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4102
4349
 
4103
4350
  ---
4104
- ### Class: StorageReaderWriter
4351
+ ##### Class: StorageReaderWriter
4105
4352
 
4106
4353
  ```ts
4107
4354
  export abstract class StorageReaderWriter extends StorageReader {
@@ -4193,7 +4440,7 @@ See also: [AuthId](#interface-authid), [FindOutputTagMapsArgs](#interface-findou
4193
4440
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4194
4441
 
4195
4442
  ---
4196
- ### Class: StorageSyncReader
4443
+ ##### Class: StorageSyncReader
4197
4444
 
4198
4445
  The `StorageSyncReader` non-abstract class must be used when authentication checking access to the methods of a `StorageBaseReader` is required.
4199
4446
 
@@ -4230,7 +4477,7 @@ See also: [AuthId](#interface-authid), [FindCertificateFieldsArgs](#interface-fi
4230
4477
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4231
4478
 
4232
4479
  ---
4233
- ### Class: TaskCheckForProofs
4480
+ ##### Class: TaskCheckForProofs
4234
4481
 
4235
4482
  `TaskCheckForProofs` is a WalletMonitor task that retreives merkle proofs for
4236
4483
  transactions.
@@ -4266,7 +4513,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4266
4513
 
4267
4514
  <summary>Class TaskCheckForProofs Details</summary>
4268
4515
 
4269
- #### Property checkNow
4516
+ ###### Property checkNow
4270
4517
 
4271
4518
  An external service such as the chaintracks new block header
4272
4519
  listener can set this true to cause
@@ -4275,7 +4522,7 @@ listener can set this true to cause
4275
4522
  static checkNow = false
4276
4523
  ```
4277
4524
 
4278
- #### Method getProofs
4525
+ ###### Method getProofs
4279
4526
 
4280
4527
  Process an array of table.ProvenTxReq (typically with status 'unmined' or 'unknown')
4281
4528
 
@@ -4300,7 +4547,7 @@ Returns
4300
4547
 
4301
4548
  reqs partitioned by status
4302
4549
 
4303
- #### Method trigger
4550
+ ###### Method trigger
4304
4551
 
4305
4552
  Normally triggered by checkNow getting set by new block header found event from chaintracks
4306
4553
 
@@ -4315,7 +4562,7 @@ trigger(nowMsecsSinceEpoch: number): {
4315
4562
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4316
4563
 
4317
4564
  ---
4318
- ### Class: TaskClock
4565
+ ##### Class: TaskClock
4319
4566
 
4320
4567
  ```ts
4321
4568
  export class TaskClock extends WalletMonitorTask {
@@ -4335,7 +4582,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4335
4582
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4336
4583
 
4337
4584
  ---
4338
- ### Class: TaskFailAbandoned
4585
+ ##### Class: TaskFailAbandoned
4339
4586
 
4340
4587
  Handles transactions which do not have terminal status and have not been
4341
4588
  updated for an extended time period.
@@ -4360,7 +4607,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4360
4607
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4361
4608
 
4362
4609
  ---
4363
- ### Class: TaskNewHeader
4610
+ ##### Class: TaskNewHeader
4364
4611
 
4365
4612
  ```ts
4366
4613
  export class TaskNewHeader extends WalletMonitorTask {
@@ -4380,7 +4627,7 @@ See also: [BlockHeader](#interface-blockheader), [Monitor](#class-monitor), [Wal
4380
4627
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4381
4628
 
4382
4629
  ---
4383
- ### Class: TaskPurge
4630
+ ##### Class: TaskPurge
4384
4631
 
4385
4632
  ```ts
4386
4633
  export class TaskPurge extends WalletMonitorTask {
@@ -4400,7 +4647,7 @@ See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparam
4400
4647
 
4401
4648
  <summary>Class TaskPurge Details</summary>
4402
4649
 
4403
- #### Property checkNow
4650
+ ###### Property checkNow
4404
4651
 
4405
4652
  Set to true to trigger running this task
4406
4653
 
@@ -4413,7 +4660,7 @@ static checkNow = false
4413
4660
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4414
4661
 
4415
4662
  ---
4416
- ### Class: TaskReviewStatus
4663
+ ##### Class: TaskReviewStatus
4417
4664
 
4418
4665
  Notify Transaction records of changes in ProvenTxReq records they may have missed.
4419
4666
 
@@ -4441,7 +4688,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4441
4688
 
4442
4689
  <summary>Class TaskReviewStatus Details</summary>
4443
4690
 
4444
- #### Property checkNow
4691
+ ###### Property checkNow
4445
4692
 
4446
4693
  Set to true to trigger running this task
4447
4694
 
@@ -4454,7 +4701,7 @@ static checkNow = false
4454
4701
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4455
4702
 
4456
4703
  ---
4457
- ### Class: TaskSendWaiting
4704
+ ##### Class: TaskSendWaiting
4458
4705
 
4459
4706
  ```ts
4460
4707
  export class TaskSendWaiting extends WalletMonitorTask {
@@ -4474,7 +4721,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4474
4721
 
4475
4722
  <summary>Class TaskSendWaiting Details</summary>
4476
4723
 
4477
- #### Method processUnsent
4724
+ ###### Method processUnsent
4478
4725
 
4479
4726
  Process an array of 'unsent' status table.ProvenTxReq
4480
4727
 
@@ -4499,7 +4746,7 @@ async processUnsent(reqApis: table.ProvenTxReq[], indent = 0): Promise<string>
4499
4746
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4500
4747
 
4501
4748
  ---
4502
- ### Class: TaskSyncWhenIdle
4749
+ ##### Class: TaskSyncWhenIdle
4503
4750
 
4504
4751
  ```ts
4505
4752
  export class TaskSyncWhenIdle extends WalletMonitorTask {
@@ -4517,7 +4764,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
4517
4764
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4518
4765
 
4519
4766
  ---
4520
- ### Class: WERR_BAD_REQUEST
4767
+ ##### Class: WERR_BAD_REQUEST
4521
4768
 
4522
4769
  The request is invalid.
4523
4770
 
@@ -4532,7 +4779,7 @@ See also: [WalletError](#class-walleterror)
4532
4779
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4533
4780
 
4534
4781
  ---
4535
- ### Class: WERR_INSUFFICIENT_FUNDS
4782
+ ##### Class: WERR_INSUFFICIENT_FUNDS
4536
4783
 
4537
4784
  Insufficient funds in the available inputs to cover the cost of the required outputs
4538
4785
  and the transaction fee (${moreSatoshisNeeded} more satoshis are needed,
@@ -4551,7 +4798,7 @@ See also: [WalletError](#class-walleterror)
4551
4798
 
4552
4799
  <summary>Class WERR_INSUFFICIENT_FUNDS Details</summary>
4553
4800
 
4554
- #### Constructor
4801
+ ###### Constructor
4555
4802
 
4556
4803
  ```ts
4557
4804
  constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number)
@@ -4569,7 +4816,7 @@ Argument Details
4569
4816
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4570
4817
 
4571
4818
  ---
4572
- ### Class: WERR_INTERNAL
4819
+ ##### Class: WERR_INTERNAL
4573
4820
 
4574
4821
  An internal error has occurred.
4575
4822
 
@@ -4586,7 +4833,7 @@ See also: [WalletError](#class-walleterror)
4586
4833
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4587
4834
 
4588
4835
  ---
4589
- ### Class: WERR_INVALID_OPERATION
4836
+ ##### Class: WERR_INVALID_OPERATION
4590
4837
 
4591
4838
  The ${parameter} parameter is invalid.
4592
4839
 
@@ -4603,7 +4850,7 @@ See also: [WalletError](#class-walleterror)
4603
4850
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4604
4851
 
4605
4852
  ---
4606
- ### Class: WERR_INVALID_PARAMETER
4853
+ ##### Class: WERR_INVALID_PARAMETER
4607
4854
 
4608
4855
  The ${parameter} parameter is invalid.
4609
4856
 
@@ -4620,7 +4867,7 @@ See also: [WalletError](#class-walleterror)
4620
4867
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4621
4868
 
4622
4869
  ---
4623
- ### Class: WERR_INVALID_PUBLIC_KEY
4870
+ ##### Class: WERR_INVALID_PUBLIC_KEY
4624
4871
 
4625
4872
  ```ts
4626
4873
  export class WERR_INVALID_PUBLIC_KEY extends WalletError {
@@ -4634,7 +4881,7 @@ See also: [WalletError](#class-walleterror)
4634
4881
 
4635
4882
  <summary>Class WERR_INVALID_PUBLIC_KEY Details</summary>
4636
4883
 
4637
- #### Constructor
4884
+ ###### Constructor
4638
4885
 
4639
4886
  ```ts
4640
4887
  constructor(public key: string, network: WalletNetwork = "mainnet")
@@ -4652,7 +4899,7 @@ Argument Details
4652
4899
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4653
4900
 
4654
4901
  ---
4655
- ### Class: WERR_MISSING_PARAMETER
4902
+ ##### Class: WERR_MISSING_PARAMETER
4656
4903
 
4657
4904
  The required ${parameter} parameter is missing.
4658
4905
 
@@ -4669,7 +4916,7 @@ See also: [WalletError](#class-walleterror)
4669
4916
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4670
4917
 
4671
4918
  ---
4672
- ### Class: WERR_NETWORK_CHAIN
4919
+ ##### Class: WERR_NETWORK_CHAIN
4673
4920
 
4674
4921
  Configured network chain is invalid or does not match across services.
4675
4922
 
@@ -4684,7 +4931,7 @@ See also: [WalletError](#class-walleterror)
4684
4931
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4685
4932
 
4686
4933
  ---
4687
- ### Class: WERR_NOT_ACTIVE
4934
+ ##### Class: WERR_NOT_ACTIVE
4688
4935
 
4689
4936
  WalletStorageManager is not accessing user's active storage.
4690
4937
 
@@ -4699,7 +4946,7 @@ See also: [WalletError](#class-walleterror)
4699
4946
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4700
4947
 
4701
4948
  ---
4702
- ### Class: WERR_NOT_IMPLEMENTED
4949
+ ##### Class: WERR_NOT_IMPLEMENTED
4703
4950
 
4704
4951
  Not implemented.
4705
4952
 
@@ -4714,7 +4961,7 @@ See also: [WalletError](#class-walleterror)
4714
4961
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4715
4962
 
4716
4963
  ---
4717
- ### Class: WERR_UNAUTHORIZED
4964
+ ##### Class: WERR_UNAUTHORIZED
4718
4965
 
4719
4966
  Access is denied due to an authorization error.
4720
4967
 
@@ -4729,7 +4976,7 @@ See also: [WalletError](#class-walleterror)
4729
4976
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4730
4977
 
4731
4978
  ---
4732
- ### Class: Wallet
4979
+ ##### Class: Wallet
4733
4980
 
4734
4981
  ```ts
4735
4982
  export class Wallet implements WalletInterface, ProtoWallet {
@@ -4745,6 +4992,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
4745
4992
  proto: ProtoWallet;
4746
4993
  privilegedKeyManager?: sdk.PrivilegedKeyManager;
4747
4994
  pendingSignActions: Record<string, PendingSignAction>;
4995
+ randomVals?: number[] = undefined;
4748
4996
  constructor(argsOrSigner: WalletArgs | WalletSigner, services?: sdk.WalletServices, monitor?: Monitor, privilegedKeyManager?: sdk.PrivilegedKeyManager)
4749
4997
  async destroy(): Promise<void>
4750
4998
  getClientChangeKeyPair(): sdk.KeyPair
@@ -4790,7 +5038,7 @@ See also: [Chain](#type-chain), [KeyPair](#interface-keypair), [Monitor](#class-
4790
5038
 
4791
5039
  <summary>Class Wallet Details</summary>
4792
5040
 
4793
- #### Property beef
5041
+ ###### Property beef
4794
5042
 
4795
5043
  The wallet creates a `BeefParty` when it is created.
4796
5044
  All the Beefs that pass through the wallet are merged into this beef.
@@ -4805,7 +5053,15 @@ Over time, this allows an active wallet to drastically reduce the amount of data
4805
5053
  beef: BeefParty
4806
5054
  ```
4807
5055
 
4808
- #### Method getKnownTxids
5056
+ ###### Property randomVals
5057
+
5058
+ For repeatability testing, set to an array of random numbers from [0..1).
5059
+
5060
+ ```ts
5061
+ randomVals?: number[] = undefined
5062
+ ```
5063
+
5064
+ ###### Method getKnownTxids
4809
5065
 
4810
5066
  ```ts
4811
5067
  getKnownTxids(newKnownTxids?: string[]): string[]
@@ -4825,7 +5081,7 @@ Argument Details
4825
5081
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4826
5082
 
4827
5083
  ---
4828
- ### Class: WalletError
5084
+ ##### Class: WalletError
4829
5085
 
4830
5086
  Derived class constructors should use the derived class name as the value for `name`,
4831
5087
  and an internationalizable constant string for `message`.
@@ -4861,7 +5117,7 @@ export class WalletError extends Error implements WalletErrorObject {
4861
5117
 
4862
5118
  <summary>Class WalletError Details</summary>
4863
5119
 
4864
- #### Method asStatus
5120
+ ###### Method asStatus
4865
5121
 
4866
5122
  ```ts
4867
5123
  asStatus(): {
@@ -4875,12 +5131,10 @@ Returns
4875
5131
 
4876
5132
  standard HTTP error status object with status property set to 'error'.
4877
5133
 
4878
- #### Method fromUnknown
5134
+ ###### Method fromUnknown
4879
5135
 
4880
5136
  Recovers all public fields from WalletError derived error classes and relevant Error derived errors.
4881
5137
 
4882
- Critical client data fields are preserved across HTTP DojoExpress / DojoExpressClient encoding.
4883
-
4884
5138
  ```ts
4885
5139
  static fromUnknown(err: unknown): WalletError
4886
5140
  ```
@@ -4891,7 +5145,7 @@ See also: [WalletError](#class-walleterror)
4891
5145
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4892
5146
 
4893
5147
  ---
4894
- ### Class: WalletMonitorTask
5148
+ ##### Class: WalletMonitorTask
4895
5149
 
4896
5150
  A monitor task performs some periodic or state triggered maintenance function
4897
5151
  on the data managed by a wallet (Bitcoin UTXO manager, aka wallet)
@@ -4926,7 +5180,7 @@ See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
4926
5180
 
4927
5181
  <summary>Class WalletMonitorTask Details</summary>
4928
5182
 
4929
- #### Property lastRunMsecsSinceEpoch
5183
+ ###### Property lastRunMsecsSinceEpoch
4930
5184
 
4931
5185
  Set by monitor each time runTask completes
4932
5186
 
@@ -4934,7 +5188,7 @@ Set by monitor each time runTask completes
4934
5188
  lastRunMsecsSinceEpoch = 0
4935
5189
  ```
4936
5190
 
4937
- #### Method asyncSetup
5191
+ ###### Method asyncSetup
4938
5192
 
4939
5193
  Override to handle async task setup configuration.
4940
5194
 
@@ -4944,7 +5198,7 @@ Called before first call to `trigger`
4944
5198
  async asyncSetup(): Promise<void>
4945
5199
  ```
4946
5200
 
4947
- #### Method trigger
5201
+ ###### Method trigger
4948
5202
 
4949
5203
  Return true if `runTask` needs to be called now.
4950
5204
 
@@ -4959,7 +5213,7 @@ abstract trigger(nowMsecsSinceEpoch: number): {
4959
5213
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4960
5214
 
4961
5215
  ---
4962
- ### Class: WalletSigner
5216
+ ##### Class: WalletSigner
4963
5217
 
4964
5218
  ```ts
4965
5219
  export class WalletSigner {
@@ -4976,7 +5230,7 @@ See also: [Chain](#type-chain), [WalletStorageManager](#class-walletstoragemanag
4976
5230
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
4977
5231
 
4978
5232
  ---
4979
- ### Class: WalletStorageManager
5233
+ ##### Class: WalletStorageManager
4980
5234
 
4981
5235
  The `WalletStorageManager` class delivers authentication checking storage access to the wallet.
4982
5236
 
@@ -5059,7 +5313,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
5059
5313
 
5060
5314
  <summary>Class WalletStorageManager Details</summary>
5061
5315
 
5062
- #### Property _isSingleWriter
5316
+ ###### Property _isSingleWriter
5063
5317
 
5064
5318
  if true, allow only a single writer to proceed at a time.
5065
5319
  queue the blocked requests so they get executed in order when released.
@@ -5068,7 +5322,7 @@ queue the blocked requests so they get executed in order when released.
5068
5322
  _isSingleWriter: boolean = true
5069
5323
  ```
5070
5324
 
5071
- #### Property _storageProviderLocked
5325
+ ###### Property _storageProviderLocked
5072
5326
 
5073
5327
  if true, allow no new reader or writers or sync to proceed.
5074
5328
  queue the blocked requests so they get executed in order when released.
@@ -5077,7 +5331,7 @@ queue the blocked requests so they get executed in order when released.
5077
5331
  _storageProviderLocked: boolean = false
5078
5332
  ```
5079
5333
 
5080
- #### Property _syncLocked
5334
+ ###### Property _syncLocked
5081
5335
 
5082
5336
  if true, allow no new reader or writers to proceed.
5083
5337
  queue the blocked requests so they get executed in order when released.
@@ -5086,7 +5340,7 @@ queue the blocked requests so they get executed in order when released.
5086
5340
  _syncLocked: boolean = false
5087
5341
  ```
5088
5342
 
5089
- #### Method isActiveStorageProvider
5343
+ ###### Method isActiveStorageProvider
5090
5344
 
5091
5345
  ```ts
5092
5346
  isActiveStorageProvider(): boolean
@@ -5096,7 +5350,7 @@ Returns
5096
5350
 
5097
5351
  true if the active `WalletStorageProvider` also implements `StorageProvider`
5098
5352
 
5099
- #### Method runAsSync
5353
+ ###### Method runAsSync
5100
5354
 
5101
5355
  ```ts
5102
5356
  async runAsSync<R>(sync: (active: sdk.WalletStorageSync) => Promise<R>, activeSync?: sdk.WalletStorageSync): Promise<R>
@@ -5110,7 +5364,7 @@ Argument Details
5110
5364
  + **activeSync**
5111
5365
  + from chained sync functions, active storage already held under sync access lock.
5112
5366
 
5113
- #### Method setActive
5367
+ ###### Method setActive
5114
5368
 
5115
5369
  Updates backups and switches to new active storage provider from among current backup providers.
5116
5370
 
@@ -5128,7 +5382,7 @@ Argument Details
5128
5382
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5129
5383
 
5130
5384
  ---
5131
- ## Functions
5385
+ #### Functions
5132
5386
 
5133
5387
  | | | |
5134
5388
  | --- | --- | --- |
@@ -5175,7 +5429,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
5175
5429
 
5176
5430
  ---
5177
5431
 
5178
- ### Function: acquireDirectCertificate
5432
+ ##### Function: acquireDirectCertificate
5179
5433
 
5180
5434
  ```ts
5181
5435
  export async function acquireDirectCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidAcquireDirectCertificateArgs): Promise<AcquireCertificateResult>
@@ -5186,7 +5440,7 @@ See also: [AuthId](#interface-authid), [ValidAcquireDirectCertificateArgs](#inte
5186
5440
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5187
5441
 
5188
5442
  ---
5189
- ### Function: arraysEqual
5443
+ ##### Function: arraysEqual
5190
5444
 
5191
5445
  Compares lengths and direct equality of values.
5192
5446
 
@@ -5197,7 +5451,7 @@ export function arraysEqual(arr1: Number[], arr2: Number[])
5197
5451
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5198
5452
 
5199
5453
  ---
5200
- ### Function: asArray
5454
+ ##### Function: asArray
5201
5455
 
5202
5456
  ```ts
5203
5457
  export function asArray(val: string | number[]): number[]
@@ -5206,7 +5460,7 @@ export function asArray(val: string | number[]): number[]
5206
5460
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5207
5461
 
5208
5462
  ---
5209
- ### Function: asBsvSdkPrivateKey
5463
+ ##### Function: asBsvSdkPrivateKey
5210
5464
 
5211
5465
  ```ts
5212
5466
  export function asBsvSdkPrivateKey(privKey: string): PrivateKey
@@ -5226,7 +5480,7 @@ Argument Details
5226
5480
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5227
5481
 
5228
5482
  ---
5229
- ### Function: asBsvSdkPublickKey
5483
+ ##### Function: asBsvSdkPublickKey
5230
5484
 
5231
5485
  ```ts
5232
5486
  export function asBsvSdkPublickKey(pubKey: string): PublicKey
@@ -5246,7 +5500,7 @@ Argument Details
5246
5500
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5247
5501
 
5248
5502
  ---
5249
- ### Function: asBsvSdkScript
5503
+ ##### Function: asBsvSdkScript
5250
5504
 
5251
5505
  Coerce a bsv script encoded as a hex string, serialized array, or Script to Script
5252
5506
  If script is already a Script, just return it.
@@ -5266,7 +5520,7 @@ export function asBsvSdkScript(script: HexString | number[] | Script): Script {
5266
5520
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5267
5521
 
5268
5522
  ---
5269
- ### Function: asBsvSdkTx
5523
+ ##### Function: asBsvSdkTx
5270
5524
 
5271
5525
  Coerce a bsv transaction encoded as a hex string, serialized array, or Transaction to Transaction
5272
5526
  If tx is already a Transaction, just return it.
@@ -5286,7 +5540,7 @@ export function asBsvSdkTx(tx: HexString | number[] | Transaction): Transaction
5286
5540
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5287
5541
 
5288
5542
  ---
5289
- ### Function: asString
5543
+ ##### Function: asString
5290
5544
 
5291
5545
  Coerce a value to a hex encoded string if currently a hex encoded string or number[]
5292
5546
 
@@ -5316,7 +5570,7 @@ Argument Details
5316
5570
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5317
5571
 
5318
5572
  ---
5319
- ### Function: attemptToPostReqsToNetwork
5573
+ ##### Function: attemptToPostReqsToNetwork
5320
5574
 
5321
5575
  Attempt to post one or more `ProvenTxReq` with status 'unsent'
5322
5576
  to the bitcoin network.
@@ -5330,7 +5584,7 @@ See also: [PostReqsToNetworkResult](#interface-postreqstonetworkresult), [Storag
5330
5584
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5331
5585
 
5332
5586
  ---
5333
- ### Function: completeSignedTransaction
5587
+ ##### Function: completeSignedTransaction
5334
5588
 
5335
5589
  ```ts
5336
5590
  export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<Transaction>
@@ -5341,7 +5595,7 @@ See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wal
5341
5595
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5342
5596
 
5343
5597
  ---
5344
- ### Function: completeSignedTransaction
5598
+ ##### Function: completeSignedTransaction
5345
5599
 
5346
5600
  ```ts
5347
5601
  export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<BsvTransaction>
@@ -5352,7 +5606,7 @@ See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wal
5352
5606
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5353
5607
 
5354
5608
  ---
5355
- ### Function: convertProofToMerklePath
5609
+ ##### Function: convertProofToMerklePath
5356
5610
 
5357
5611
  ```ts
5358
5612
  export function convertProofToMerklePath(txid: string, proof: TscMerkleProofApi): MerklePath
@@ -5363,7 +5617,7 @@ See also: [TscMerkleProofApi](#interface-tscmerkleproofapi)
5363
5617
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5364
5618
 
5365
5619
  ---
5366
- ### Function: createAction
5620
+ ##### Function: createAction
5367
5621
 
5368
5622
  ```ts
5369
5623
  export async function createAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs): Promise<CreateActionResult>
@@ -5374,7 +5628,7 @@ See also: [AuthId](#interface-authid), [ValidCreateActionArgs](#interface-validc
5374
5628
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5375
5629
 
5376
5630
  ---
5377
- ### Function: createAction
5631
+ ##### Function: createAction
5378
5632
 
5379
5633
  ```ts
5380
5634
  export async function createAction(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<sdk.StorageCreateActionResult>
@@ -5385,7 +5639,7 @@ See also: [AuthId](#interface-authid), [StorageCreateActionResult](#interface-st
5385
5639
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5386
5640
 
5387
5641
  ---
5388
- ### Function: createDefaultWalletServicesOptions
5642
+ ##### Function: createDefaultWalletServicesOptions
5389
5643
 
5390
5644
  ```ts
5391
5645
  export function createDefaultWalletServicesOptions(chain: sdk.Chain): sdk.WalletServicesOptions
@@ -5396,7 +5650,7 @@ See also: [Chain](#type-chain), [WalletServicesOptions](#interface-walletservice
5396
5650
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5397
5651
 
5398
5652
  ---
5399
- ### Function: createStorageServiceChargeScript
5653
+ ##### Function: createStorageServiceChargeScript
5400
5654
 
5401
5655
  ```ts
5402
5656
  export function createStorageServiceChargeScript(pubKeyHex: PubKeyHex): {
@@ -5408,7 +5662,7 @@ export function createStorageServiceChargeScript(pubKeyHex: PubKeyHex): {
5408
5662
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5409
5663
 
5410
5664
  ---
5411
- ### Function: doubleSha256BE
5665
+ ##### Function: doubleSha256BE
5412
5666
 
5413
5667
  Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
5414
5668
 
@@ -5438,7 +5692,7 @@ Argument Details
5438
5692
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5439
5693
 
5440
5694
  ---
5441
- ### Function: doubleSha256HashLE
5695
+ ##### Function: doubleSha256HashLE
5442
5696
 
5443
5697
  Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
5444
5698
 
@@ -5468,7 +5722,7 @@ Argument Details
5468
5722
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5469
5723
 
5470
5724
  ---
5471
- ### Function: generateChangeSdk
5725
+ ##### Function: generateChangeSdk
5472
5726
 
5473
5727
  Simplifications:
5474
5728
  - only support one change type with fixed length scripts.
@@ -5485,7 +5739,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
5485
5739
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5486
5740
 
5487
5741
  ---
5488
- ### Function: generateChangeSdkMakeStorage
5742
+ ##### Function: generateChangeSdkMakeStorage
5489
5743
 
5490
5744
  ```ts
5491
5745
  export function generateChangeSdkMakeStorage(availableChange: GenerateChangeSdkChangeInput[]): {
@@ -5500,7 +5754,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
5500
5754
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5501
5755
 
5502
5756
  ---
5503
- ### Function: getBeefForTransaction
5757
+ ##### Function: getBeefForTransaction
5504
5758
 
5505
5759
  Creates a `Beef` to support the validity of a transaction identified by its `txid`.
5506
5760
 
@@ -5537,7 +5791,7 @@ Argument Details
5537
5791
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5538
5792
 
5539
5793
  ---
5540
- ### Function: getExchangeRatesIo
5794
+ ##### Function: getExchangeRatesIo
5541
5795
 
5542
5796
  ```ts
5543
5797
  export async function getExchangeRatesIo(key: string): Promise<ExchangeRatesIoApi>
@@ -5548,7 +5802,7 @@ See also: [ExchangeRatesIoApi](#interface-exchangeratesioapi)
5548
5802
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5549
5803
 
5550
5804
  ---
5551
- ### Function: getIdentityKey
5805
+ ##### Function: getIdentityKey
5552
5806
 
5553
5807
  ```ts
5554
5808
  export async function getIdentityKey(wallet: CertOpsWallet): Promise<PubKeyHex>
@@ -5559,7 +5813,7 @@ See also: [CertOpsWallet](#interface-certopswallet)
5559
5813
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5560
5814
 
5561
5815
  ---
5562
- ### Function: getMerklePathFromTaalARC
5816
+ ##### Function: getMerklePathFromTaalARC
5563
5817
 
5564
5818
  ```ts
5565
5819
  export async function getMerklePathFromTaalARC(txid: string, config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
@@ -5570,7 +5824,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathResult]
5570
5824
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5571
5825
 
5572
5826
  ---
5573
- ### Function: getMerklePathFromWhatsOnChainTsc
5827
+ ##### Function: getMerklePathFromWhatsOnChainTsc
5574
5828
 
5575
5829
  WhatOnChain.com has their own "hash/pos/R/L" proof format and a more TSC compliant proof format.
5576
5830
 
@@ -5587,7 +5841,7 @@ See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathre
5587
5841
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5588
5842
 
5589
5843
  ---
5590
- ### Function: getRawTxFromWhatsOnChain
5844
+ ##### Function: getRawTxFromWhatsOnChain
5591
5845
 
5592
5846
  ```ts
5593
5847
  export async function getRawTxFromWhatsOnChain(txid: string, chain: sdk.Chain): Promise<sdk.GetRawTxResult>
@@ -5598,7 +5852,7 @@ See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
5598
5852
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5599
5853
 
5600
5854
  ---
5601
- ### Function: getSyncChunk
5855
+ ##### Function: getSyncChunk
5602
5856
 
5603
5857
  Gets the next sync chunk of updated data from un-remoted storage (could be using a remote DB connection).
5604
5858
 
@@ -5611,7 +5865,7 @@ See also: [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReade
5611
5865
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5612
5866
 
5613
5867
  ---
5614
- ### Function: getTaalArcServiceConfig
5868
+ ##### Function: getTaalArcServiceConfig
5615
5869
 
5616
5870
  ```ts
5617
5871
  export function getTaalArcServiceConfig(chain: sdk.Chain, apiKey: string): ArcServiceConfig
@@ -5622,7 +5876,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [Chain](#type-chain)
5622
5876
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5623
5877
 
5624
5878
  ---
5625
- ### Function: getUtxoStatusFromWhatsOnChain
5879
+ ##### Function: getUtxoStatusFromWhatsOnChain
5626
5880
 
5627
5881
  ```ts
5628
5882
  export async function getUtxoStatusFromWhatsOnChain(output: string, chain: sdk.Chain, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
@@ -5633,7 +5887,7 @@ See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatuso
5633
5887
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5634
5888
 
5635
5889
  ---
5636
- ### Function: internalizeAction
5890
+ ##### Function: internalizeAction
5637
5891
 
5638
5892
  Internalize Action allows a wallet to take ownership of outputs in a pre-existing transaction.
5639
5893
  The transaction may, or may not already be known to both the storage and user.
@@ -5669,7 +5923,7 @@ See also: [AuthId](#interface-authid), [Wallet](#class-wallet)
5669
5923
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5670
5924
 
5671
5925
  ---
5672
- ### Function: internalizeAction
5926
+ ##### Function: internalizeAction
5673
5927
 
5674
5928
  Internalize Action allows a wallet to take ownership of outputs in a pre-existing transaction.
5675
5929
  The transaction may, or may not already be known to both the storage and user.
@@ -5705,7 +5959,7 @@ See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider)
5705
5959
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5706
5960
 
5707
5961
  ---
5708
- ### Function: isHexString
5962
+ ##### Function: isHexString
5709
5963
 
5710
5964
  ```ts
5711
5965
  export function isHexString(s: string): boolean
@@ -5714,7 +5968,7 @@ export function isHexString(s: string): boolean
5714
5968
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5715
5969
 
5716
5970
  ---
5717
- ### Function: listCertificates
5971
+ ##### Function: listCertificates
5718
5972
 
5719
5973
  ```ts
5720
5974
  export async function listCertificates(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListCertificatesResult>
@@ -5725,7 +5979,7 @@ See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider)
5725
5979
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5726
5980
 
5727
5981
  ---
5728
- ### Function: lockScriptWithKeyOffsetFromPubKey
5982
+ ##### Function: lockScriptWithKeyOffsetFromPubKey
5729
5983
 
5730
5984
  ```ts
5731
5985
  export function lockScriptWithKeyOffsetFromPubKey(pubKey: string, keyOffset?: string): {
@@ -5737,7 +5991,7 @@ export function lockScriptWithKeyOffsetFromPubKey(pubKey: string, keyOffset?: st
5737
5991
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5738
5992
 
5739
5993
  ---
5740
- ### Function: makeAtomicBeef
5994
+ ##### Function: makeAtomicBeef
5741
5995
 
5742
5996
  ```ts
5743
5997
  export function makeAtomicBeef(tx: Transaction, beef: number[] | Beef): number[]
@@ -5746,7 +6000,7 @@ export function makeAtomicBeef(tx: Transaction, beef: number[] | Beef): number[]
5746
6000
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5747
6001
 
5748
6002
  ---
5749
- ### Function: makeAtomicBeef
6003
+ ##### Function: makeAtomicBeef
5750
6004
 
5751
6005
  ```ts
5752
6006
  export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): number[]
@@ -5755,7 +6009,7 @@ export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): numbe
5755
6009
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5756
6010
 
5757
6011
  ---
5758
- ### Function: makeErrorResult
6012
+ ##### Function: makeErrorResult
5759
6013
 
5760
6014
  ```ts
5761
6015
  export function makeErrorResult(error: sdk.WalletError, miner: ArcServiceConfig, beef: number[], txids: string[], dd?: ArcMinerPostBeefDataApi): sdk.PostBeefResult
@@ -5766,7 +6020,7 @@ See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcSer
5766
6020
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5767
6021
 
5768
6022
  ---
5769
- ### Function: makeGetMerklePathFromTaalARC
6023
+ ##### Function: makeGetMerklePathFromTaalARC
5770
6024
 
5771
6025
  ```ts
5772
6026
  export function makeGetMerklePathFromTaalARC(config: ArcServiceConfig): sdk.GetMerklePathService
@@ -5777,7 +6031,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathService
5777
6031
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5778
6032
 
5779
6033
  ---
5780
- ### Function: makePostBeefResult
6034
+ ##### Function: makePostBeefResult
5781
6035
 
5782
6036
  ```ts
5783
6037
  export function makePostBeefResult(dd: ArcMinerPostBeefDataApi, miner: ArcServiceConfig, beef: number[], txids: string[]): sdk.PostBeefResult
@@ -5788,7 +6042,7 @@ See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcSer
5788
6042
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5789
6043
 
5790
6044
  ---
5791
- ### Function: makePostBeefToTaalARC
6045
+ ##### Function: makePostBeefToTaalARC
5792
6046
 
5793
6047
  ```ts
5794
6048
  export function makePostBeefToTaalARC(config: ArcServiceConfig): sdk.PostBeefService
@@ -5799,7 +6053,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefService](#ty
5799
6053
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5800
6054
 
5801
6055
  ---
5802
- ### Function: makePostTxsToTaalARC
6056
+ ##### Function: makePostTxsToTaalARC
5803
6057
 
5804
6058
  ```ts
5805
6059
  export function makePostTxsToTaalARC(config: ArcServiceConfig): sdk.PostTxsService
@@ -5810,7 +6064,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsService](#typ
5810
6064
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5811
6065
 
5812
6066
  ---
5813
- ### Function: maxDate
6067
+ ##### Function: maxDate
5814
6068
 
5815
6069
  ```ts
5816
6070
  export function maxDate(d1?: Date, d2?: Date): Date | undefined
@@ -5819,7 +6073,7 @@ export function maxDate(d1?: Date, d2?: Date): Date | undefined
5819
6073
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5820
6074
 
5821
6075
  ---
5822
- ### Function: offsetPubKey
6076
+ ##### Function: offsetPubKey
5823
6077
 
5824
6078
  ```ts
5825
6079
  export function offsetPubKey(pubKey: string, keyOffset?: string): {
@@ -5831,7 +6085,7 @@ export function offsetPubKey(pubKey: string, keyOffset?: string): {
5831
6085
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5832
6086
 
5833
6087
  ---
5834
- ### Function: optionalArraysEqual
6088
+ ##### Function: optionalArraysEqual
5835
6089
 
5836
6090
  ```ts
5837
6091
  export function optionalArraysEqual(arr1?: Number[], arr2?: Number[])
@@ -5840,7 +6094,7 @@ export function optionalArraysEqual(arr1?: Number[], arr2?: Number[])
5840
6094
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5841
6095
 
5842
6096
  ---
5843
- ### Function: parseTxScriptOffsets
6097
+ ##### Function: parseTxScriptOffsets
5844
6098
 
5845
6099
  ```ts
5846
6100
  export function parseTxScriptOffsets(rawTx: number[]): TxScriptOffsets
@@ -5851,7 +6105,7 @@ See also: [TxScriptOffsets](#interface-txscriptoffsets)
5851
6105
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5852
6106
 
5853
6107
  ---
5854
- ### Function: parseWalletOutpoint
6108
+ ##### Function: parseWalletOutpoint
5855
6109
 
5856
6110
  ```ts
5857
6111
  export function parseWalletOutpoint(outpoint: string): {
@@ -5863,7 +6117,7 @@ export function parseWalletOutpoint(outpoint: string): {
5863
6117
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5864
6118
 
5865
6119
  ---
5866
- ### Function: postBeefToArcMiner
6120
+ ##### Function: postBeefToArcMiner
5867
6121
 
5868
6122
  ```ts
5869
6123
  export async function postBeefToArcMiner(beef: Beef | number[], txids: string[], config: ArcServiceConfig): Promise<sdk.PostBeefResult>
@@ -5874,7 +6128,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#int
5874
6128
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5875
6129
 
5876
6130
  ---
5877
- ### Function: postBeefToTaalArcMiner
6131
+ ##### Function: postBeefToTaalArcMiner
5878
6132
 
5879
6133
  ```ts
5880
6134
  export async function postBeefToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostBeefResult>
@@ -5885,7 +6139,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#int
5885
6139
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5886
6140
 
5887
6141
  ---
5888
- ### Function: postTxsToTaalArcMiner
6142
+ ##### Function: postTxsToTaalArcMiner
5889
6143
 
5890
6144
  ```ts
5891
6145
  export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostTxsResult>
@@ -5907,7 +6161,7 @@ Argument Details
5907
6161
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5908
6162
 
5909
6163
  ---
5910
- ### Function: processAction
6164
+ ##### Function: processAction
5911
6165
 
5912
6166
  ```ts
5913
6167
  export async function processAction(prior: PendingSignAction | undefined, wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProcessActionArgs): Promise<SendWithResult[] | undefined>
@@ -5918,7 +6172,7 @@ See also: [AuthId](#interface-authid), [PendingSignAction](#interface-pendingsig
5918
6172
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5919
6173
 
5920
6174
  ---
5921
- ### Function: processAction
6175
+ ##### Function: processAction
5922
6176
 
5923
6177
  ```ts
5924
6178
  export async function processAction(storage: StorageProvider, auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
@@ -5929,7 +6183,7 @@ See also: [AuthId](#interface-authid), [StorageProcessActionArgs](#interface-sto
5929
6183
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5930
6184
 
5931
6185
  ---
5932
- ### Function: proveCertificate
6186
+ ##### Function: proveCertificate
5933
6187
 
5934
6188
  ```ts
5935
6189
  export async function proveCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProveCertificateArgs): Promise<ProveCertificateResult>
@@ -5940,7 +6194,7 @@ See also: [AuthId](#interface-authid), [ValidProveCertificateArgs](#interface-va
5940
6194
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5941
6195
 
5942
6196
  ---
5943
- ### Function: randomBytes
6197
+ ##### Function: randomBytes
5944
6198
 
5945
6199
  ```ts
5946
6200
  export function randomBytes(count: number): number[]
@@ -5959,7 +6213,7 @@ count cryptographically secure random bytes as array of bytes
5959
6213
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5960
6214
 
5961
6215
  ---
5962
- ### Function: randomBytesBase64
6216
+ ##### Function: randomBytesBase64
5963
6217
 
5964
6218
  ```ts
5965
6219
  export function randomBytesBase64(count: number): string
@@ -5978,7 +6232,7 @@ count cryptographically secure random bytes as base64 encoded string
5978
6232
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5979
6233
 
5980
6234
  ---
5981
- ### Function: randomBytesHex
6235
+ ##### Function: randomBytesHex
5982
6236
 
5983
6237
  ```ts
5984
6238
  export function randomBytesHex(count: number): string
@@ -5997,7 +6251,7 @@ count cryptographically secure random bytes as hex encoded string
5997
6251
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
5998
6252
 
5999
6253
  ---
6000
- ### Function: sha256Hash
6254
+ ##### Function: sha256Hash
6001
6255
 
6002
6256
  Calculate the SHA256 hash of an array of bytes
6003
6257
 
@@ -6021,7 +6275,7 @@ sha256 hash of buffer contents.
6021
6275
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6022
6276
 
6023
6277
  ---
6024
- ### Function: signAction
6278
+ ##### Function: signAction
6025
6279
 
6026
6280
  ```ts
6027
6281
  export async function signAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidSignActionArgs): Promise<SignActionResult>
@@ -6032,7 +6286,7 @@ See also: [AuthId](#interface-authid), [ValidSignActionArgs](#interface-validsig
6032
6286
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6033
6287
 
6034
6288
  ---
6035
- ### Function: stampLog
6289
+ ##### Function: stampLog
6036
6290
 
6037
6291
  If a log is being kept, add a time stamped line.
6038
6292
 
@@ -6062,7 +6316,7 @@ Argument Details
6062
6316
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6063
6317
 
6064
6318
  ---
6065
- ### Function: stampLogFormat
6319
+ ##### Function: stampLogFormat
6066
6320
 
6067
6321
  Replaces individual timestamps with delta msecs.
6068
6322
  Looks for two network crossings and adjusts clock for clock skew if found.
@@ -6090,7 +6344,7 @@ Argument Details
6090
6344
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6091
6345
 
6092
6346
  ---
6093
- ### Function: toBinaryBaseBlockHeader
6347
+ ##### Function: toBinaryBaseBlockHeader
6094
6348
 
6095
6349
  Serializes a block header as an 80 byte array.
6096
6350
  The exact serialized format is defined in the Bitcoin White Paper
@@ -6126,7 +6380,7 @@ Returns
6126
6380
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6127
6381
 
6128
6382
  ---
6129
- ### Function: toWalletNetwork
6383
+ ##### Function: toWalletNetwork
6130
6384
 
6131
6385
  ```ts
6132
6386
  export function toWalletNetwork(chain: Chain): WalletNetwork
@@ -6137,7 +6391,7 @@ See also: [Chain](#type-chain)
6137
6391
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6138
6392
 
6139
6393
  ---
6140
- ### Function: transactionInputSize
6394
+ ##### Function: transactionInputSize
6141
6395
 
6142
6396
  ```ts
6143
6397
  export function transactionInputSize(scriptSize: number): number
@@ -6161,7 +6415,7 @@ Argument Details
6161
6415
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6162
6416
 
6163
6417
  ---
6164
- ### Function: transactionOutputSize
6418
+ ##### Function: transactionOutputSize
6165
6419
 
6166
6420
  ```ts
6167
6421
  export function transactionOutputSize(scriptSize: number): number
@@ -6185,7 +6439,7 @@ Argument Details
6185
6439
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6186
6440
 
6187
6441
  ---
6188
- ### Function: transactionSize
6442
+ ##### Function: transactionSize
6189
6443
 
6190
6444
  Compute the serialized binary transaction size in bytes
6191
6445
  given the number of inputs and outputs,
@@ -6215,7 +6469,7 @@ Argument Details
6215
6469
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6216
6470
 
6217
6471
  ---
6218
- ### Function: updateBsvExchangeRate
6472
+ ##### Function: updateBsvExchangeRate
6219
6473
 
6220
6474
  ```ts
6221
6475
  export async function updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
@@ -6226,7 +6480,7 @@ See also: [BsvExchangeRate](#interface-bsvexchangerate)
6226
6480
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6227
6481
 
6228
6482
  ---
6229
- ### Function: updateChaintracksFiatExchangeRates
6483
+ ##### Function: updateChaintracksFiatExchangeRates
6230
6484
 
6231
6485
  ```ts
6232
6486
  export async function updateChaintracksFiatExchangeRates(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
@@ -6237,7 +6491,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
6237
6491
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6238
6492
 
6239
6493
  ---
6240
- ### Function: updateExchangeratesapi
6494
+ ##### Function: updateExchangeratesapi
6241
6495
 
6242
6496
  ```ts
6243
6497
  export async function updateExchangeratesapi(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
@@ -6248,7 +6502,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
6248
6502
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6249
6503
 
6250
6504
  ---
6251
- ### Function: validateAbortActionArgs
6505
+ ##### Function: validateAbortActionArgs
6252
6506
 
6253
6507
  ```ts
6254
6508
  export function validateAbortActionArgs(args: AbortActionArgs): ValidAbortActionArgs
@@ -6259,7 +6513,7 @@ See also: [ValidAbortActionArgs](#interface-validabortactionargs)
6259
6513
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6260
6514
 
6261
6515
  ---
6262
- ### Function: validateAcquireCertificateArgs
6516
+ ##### Function: validateAcquireCertificateArgs
6263
6517
 
6264
6518
  ```ts
6265
6519
  export async function validateAcquireCertificateArgs(args: AcquireCertificateArgs): Promise<ValidAcquireCertificateArgs>
@@ -6281,7 +6535,7 @@ Argument Details
6281
6535
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6282
6536
 
6283
6537
  ---
6284
- ### Function: validateAcquireDirectCertificateArgs
6538
+ ##### Function: validateAcquireDirectCertificateArgs
6285
6539
 
6286
6540
  ```ts
6287
6541
  export function validateAcquireDirectCertificateArgs(args: AcquireCertificateArgs): ValidAcquireDirectCertificateArgs
@@ -6292,7 +6546,7 @@ See also: [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcerti
6292
6546
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6293
6547
 
6294
6548
  ---
6295
- ### Function: validateAcquireIssuanceCertificateArgs
6549
+ ##### Function: validateAcquireIssuanceCertificateArgs
6296
6550
 
6297
6551
  ```ts
6298
6552
  export function validateAcquireIssuanceCertificateArgs(args: AcquireCertificateArgs): ValidAcquireIssuanceCertificateArgs
@@ -6303,7 +6557,7 @@ See also: [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancec
6303
6557
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6304
6558
 
6305
6559
  ---
6306
- ### Function: validateBasketInsertion
6560
+ ##### Function: validateBasketInsertion
6307
6561
 
6308
6562
  ```ts
6309
6563
  export function validateBasketInsertion(args?: BasketInsertion): ValidBasketInsertion | undefined
@@ -6314,7 +6568,7 @@ See also: [ValidBasketInsertion](#interface-validbasketinsertion)
6314
6568
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6315
6569
 
6316
6570
  ---
6317
- ### Function: validateCreateActionArgs
6571
+ ##### Function: validateCreateActionArgs
6318
6572
 
6319
6573
  ```ts
6320
6574
  export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs
@@ -6325,7 +6579,7 @@ See also: [ValidCreateActionArgs](#interface-validcreateactionargs)
6325
6579
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6326
6580
 
6327
6581
  ---
6328
- ### Function: validateCreateActionInput
6582
+ ##### Function: validateCreateActionInput
6329
6583
 
6330
6584
  ```ts
6331
6585
  export function validateCreateActionInput(i: CreateActionInput): ValidCreateActionInput
@@ -6336,7 +6590,7 @@ See also: [ValidCreateActionInput](#interface-validcreateactioninput)
6336
6590
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6337
6591
 
6338
6592
  ---
6339
- ### Function: validateCreateActionOptions
6593
+ ##### Function: validateCreateActionOptions
6340
6594
 
6341
6595
  Set all default true/false booleans to true or false if undefined.
6342
6596
  Set all possibly undefined numbers to their default values.
@@ -6352,7 +6606,7 @@ See also: [ValidCreateActionOptions](#interface-validcreateactionoptions)
6352
6606
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6353
6607
 
6354
6608
  ---
6355
- ### Function: validateCreateActionOutput
6609
+ ##### Function: validateCreateActionOutput
6356
6610
 
6357
6611
  ```ts
6358
6612
  export function validateCreateActionOutput(o: CreateActionOutput): ValidCreateActionOutput
@@ -6363,7 +6617,7 @@ See also: [ValidCreateActionOutput](#interface-validcreateactionoutput)
6363
6617
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6364
6618
 
6365
6619
  ---
6366
- ### Function: validateDiscoverByAttributesArgs
6620
+ ##### Function: validateDiscoverByAttributesArgs
6367
6621
 
6368
6622
  ```ts
6369
6623
  export function validateDiscoverByAttributesArgs(args: DiscoverByAttributesArgs): ValidDiscoverByAttributesArgs
@@ -6374,7 +6628,7 @@ See also: [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesar
6374
6628
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6375
6629
 
6376
6630
  ---
6377
- ### Function: validateDiscoverByIdentityKeyArgs
6631
+ ##### Function: validateDiscoverByIdentityKeyArgs
6378
6632
 
6379
6633
  ```ts
6380
6634
  export function validateDiscoverByIdentityKeyArgs(args: DiscoverByIdentityKeyArgs): ValidDiscoverByIdentityKeyArgs
@@ -6385,7 +6639,7 @@ See also: [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykey
6385
6639
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6386
6640
 
6387
6641
  ---
6388
- ### Function: validateGenerateChangeSdkParams
6642
+ ##### Function: validateGenerateChangeSdkParams
6389
6643
 
6390
6644
  ```ts
6391
6645
  export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams)
@@ -6396,7 +6650,7 @@ See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams)
6396
6650
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6397
6651
 
6398
6652
  ---
6399
- ### Function: validateGenerateChangeSdkResult
6653
+ ##### Function: validateGenerateChangeSdkResult
6400
6654
 
6401
6655
  ```ts
6402
6656
  export function validateGenerateChangeSdkResult(params: GenerateChangeSdkParams, r: GenerateChangeSdkResult): {
@@ -6410,7 +6664,7 @@ See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams), [Genera
6410
6664
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6411
6665
 
6412
6666
  ---
6413
- ### Function: validateInteger
6667
+ ##### Function: validateInteger
6414
6668
 
6415
6669
  ```ts
6416
6670
  export function validateInteger(v: number | undefined, name: string, defaultValue?: number, min?: number, max?: number): number
@@ -6419,7 +6673,7 @@ export function validateInteger(v: number | undefined, name: string, defaultValu
6419
6673
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6420
6674
 
6421
6675
  ---
6422
- ### Function: validateInternalizeActionArgs
6676
+ ##### Function: validateInternalizeActionArgs
6423
6677
 
6424
6678
  ```ts
6425
6679
  export function validateInternalizeActionArgs(args: InternalizeActionArgs): ValidInternalizeActionArgs
@@ -6430,7 +6684,7 @@ See also: [ValidInternalizeActionArgs](#interface-validinternalizeactionargs)
6430
6684
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6431
6685
 
6432
6686
  ---
6433
- ### Function: validateInternalizeOutput
6687
+ ##### Function: validateInternalizeOutput
6434
6688
 
6435
6689
  ```ts
6436
6690
  export function validateInternalizeOutput(args: InternalizeOutput): ValidInternalizeOutput
@@ -6441,7 +6695,7 @@ See also: [ValidInternalizeOutput](#interface-validinternalizeoutput)
6441
6695
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6442
6696
 
6443
6697
  ---
6444
- ### Function: validateListActionsArgs
6698
+ ##### Function: validateListActionsArgs
6445
6699
 
6446
6700
  ```ts
6447
6701
  export function validateListActionsArgs(args: ListActionsArgs): ValidListActionsArgs
@@ -6483,7 +6737,7 @@ Argument Details
6483
6737
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6484
6738
 
6485
6739
  ---
6486
- ### Function: validateListCertificatesArgs
6740
+ ##### Function: validateListCertificatesArgs
6487
6741
 
6488
6742
  ```ts
6489
6743
  export function validateListCertificatesArgs(args: ListCertificatesArgs): ValidListCertificatesArgs
@@ -6494,7 +6748,7 @@ See also: [ValidListCertificatesArgs](#interface-validlistcertificatesargs)
6494
6748
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6495
6749
 
6496
6750
  ---
6497
- ### Function: validateListOutputsArgs
6751
+ ##### Function: validateListOutputsArgs
6498
6752
 
6499
6753
  ```ts
6500
6754
  export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputsArgs
@@ -6536,7 +6790,7 @@ Argument Details
6536
6790
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6537
6791
 
6538
6792
  ---
6539
- ### Function: validateOptionalInteger
6793
+ ##### Function: validateOptionalInteger
6540
6794
 
6541
6795
  ```ts
6542
6796
  export function validateOptionalInteger(v: number | undefined, name: string, min?: number, max?: number): number | undefined
@@ -6545,7 +6799,7 @@ export function validateOptionalInteger(v: number | undefined, name: string, min
6545
6799
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6546
6800
 
6547
6801
  ---
6548
- ### Function: validateOptionalOutpointString
6802
+ ##### Function: validateOptionalOutpointString
6549
6803
 
6550
6804
  ```ts
6551
6805
  export function validateOptionalOutpointString(outpoint: string | undefined, name: string): string | undefined
@@ -6554,7 +6808,7 @@ export function validateOptionalOutpointString(outpoint: string | undefined, nam
6554
6808
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6555
6809
 
6556
6810
  ---
6557
- ### Function: validateOriginator
6811
+ ##### Function: validateOriginator
6558
6812
 
6559
6813
  ```ts
6560
6814
  export function validateOriginator(s?: string): string | undefined
@@ -6563,7 +6817,7 @@ export function validateOriginator(s?: string): string | undefined
6563
6817
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6564
6818
 
6565
6819
  ---
6566
- ### Function: validateOutpointString
6820
+ ##### Function: validateOutpointString
6567
6821
 
6568
6822
  ```ts
6569
6823
  export function validateOutpointString(outpoint: string, name: string): string
@@ -6572,7 +6826,7 @@ export function validateOutpointString(outpoint: string, name: string): string
6572
6826
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6573
6827
 
6574
6828
  ---
6575
- ### Function: validatePositiveIntegerOrZero
6829
+ ##### Function: validatePositiveIntegerOrZero
6576
6830
 
6577
6831
  ```ts
6578
6832
  export function validatePositiveIntegerOrZero(v: number, name: string): number
@@ -6581,7 +6835,7 @@ export function validatePositiveIntegerOrZero(v: number, name: string): number
6581
6835
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6582
6836
 
6583
6837
  ---
6584
- ### Function: validateProveCertificateArgs
6838
+ ##### Function: validateProveCertificateArgs
6585
6839
 
6586
6840
  ```ts
6587
6841
  export function validateProveCertificateArgs(args: ProveCertificateArgs): ValidProveCertificateArgs
@@ -6592,7 +6846,7 @@ See also: [ValidProveCertificateArgs](#interface-validprovecertificateargs)
6592
6846
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6593
6847
 
6594
6848
  ---
6595
- ### Function: validateRelinquishCertificateArgs
6849
+ ##### Function: validateRelinquishCertificateArgs
6596
6850
 
6597
6851
  ```ts
6598
6852
  export function validateRelinquishCertificateArgs(args: RelinquishCertificateArgs): ValidRelinquishCertificateArgs
@@ -6603,7 +6857,7 @@ See also: [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificate
6603
6857
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6604
6858
 
6605
6859
  ---
6606
- ### Function: validateRelinquishOutputArgs
6860
+ ##### Function: validateRelinquishOutputArgs
6607
6861
 
6608
6862
  ```ts
6609
6863
  export function validateRelinquishOutputArgs(args: RelinquishOutputArgs): ValidRelinquishOutputArgs
@@ -6614,7 +6868,7 @@ See also: [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs)
6614
6868
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6615
6869
 
6616
6870
  ---
6617
- ### Function: validateSatoshis
6871
+ ##### Function: validateSatoshis
6618
6872
 
6619
6873
  ```ts
6620
6874
  export function validateSatoshis(v: number | undefined, name: string, min?: number): number
@@ -6623,7 +6877,7 @@ export function validateSatoshis(v: number | undefined, name: string, min?: numb
6623
6877
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6624
6878
 
6625
6879
  ---
6626
- ### Function: validateScriptHash
6880
+ ##### Function: validateScriptHash
6627
6881
 
6628
6882
  ```ts
6629
6883
  export function validateScriptHash(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): string
@@ -6634,7 +6888,7 @@ See also: [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat)
6634
6888
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6635
6889
 
6636
6890
  ---
6637
- ### Function: validateSecondsSinceEpoch
6891
+ ##### Function: validateSecondsSinceEpoch
6638
6892
 
6639
6893
  ```ts
6640
6894
  export function validateSecondsSinceEpoch(time: number): Date
@@ -6643,7 +6897,7 @@ export function validateSecondsSinceEpoch(time: number): Date
6643
6897
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6644
6898
 
6645
6899
  ---
6646
- ### Function: validateSignActionArgs
6900
+ ##### Function: validateSignActionArgs
6647
6901
 
6648
6902
  ```ts
6649
6903
  export function validateSignActionArgs(args: SignActionArgs): ValidSignActionArgs
@@ -6654,7 +6908,7 @@ See also: [ValidSignActionArgs](#interface-validsignactionargs)
6654
6908
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6655
6909
 
6656
6910
  ---
6657
- ### Function: validateSignActionOptions
6911
+ ##### Function: validateSignActionOptions
6658
6912
 
6659
6913
  Set all default true/false booleans to true or false if undefined.
6660
6914
  Set all possibly undefined numbers to their default values.
@@ -6670,7 +6924,7 @@ See also: [ValidSignActionOptions](#interface-validsignactionoptions)
6670
6924
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6671
6925
 
6672
6926
  ---
6673
- ### Function: validateStorageFeeModel
6927
+ ##### Function: validateStorageFeeModel
6674
6928
 
6675
6929
  ```ts
6676
6930
  export function validateStorageFeeModel(v?: sdk.StorageFeeModel): sdk.StorageFeeModel
@@ -6681,7 +6935,7 @@ See also: [StorageFeeModel](#interface-storagefeemodel)
6681
6935
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6682
6936
 
6683
6937
  ---
6684
- ### Function: validateStringLength
6938
+ ##### Function: validateStringLength
6685
6939
 
6686
6940
  ```ts
6687
6941
  export function validateStringLength(s: string, name: string, min?: number, max?: number): string
@@ -6690,7 +6944,7 @@ export function validateStringLength(s: string, name: string, min?: number, max?
6690
6944
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6691
6945
 
6692
6946
  ---
6693
- ### Function: validateWalletPayment
6947
+ ##### Function: validateWalletPayment
6694
6948
 
6695
6949
  ```ts
6696
6950
  export function validateWalletPayment(args?: WalletPayment): ValidWalletPayment | undefined
@@ -6701,7 +6955,7 @@ See also: [ValidWalletPayment](#interface-validwalletpayment)
6701
6955
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6702
6956
 
6703
6957
  ---
6704
- ### Function: varUintSize
6958
+ ##### Function: varUintSize
6705
6959
 
6706
6960
  Returns the byte size required to encode number as Bitcoin VarUint
6707
6961
 
@@ -6718,7 +6972,7 @@ See also: [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter)
6718
6972
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6719
6973
 
6720
6974
  ---
6721
- ### Function: verifyHexString
6975
+ ##### Function: verifyHexString
6722
6976
 
6723
6977
  Helper function.
6724
6978
 
@@ -6731,7 +6985,7 @@ export function verifyHexString(v: string): string
6731
6985
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6732
6986
 
6733
6987
  ---
6734
- ### Function: verifyId
6988
+ ##### Function: verifyId
6735
6989
 
6736
6990
  Helper function.
6737
6991
 
@@ -6744,7 +6998,7 @@ export function verifyId(id: number | undefined | null): number
6744
6998
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6745
6999
 
6746
7000
  ---
6747
- ### Function: verifyInteger
7001
+ ##### Function: verifyInteger
6748
7002
 
6749
7003
  Helper function.
6750
7004
 
@@ -6757,7 +7011,7 @@ export function verifyInteger(v: number | null | undefined): number
6757
7011
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6758
7012
 
6759
7013
  ---
6760
- ### Function: verifyNumber
7014
+ ##### Function: verifyNumber
6761
7015
 
6762
7016
  Helper function.
6763
7017
 
@@ -6770,7 +7024,7 @@ export function verifyNumber(v: number | null | undefined): number
6770
7024
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6771
7025
 
6772
7026
  ---
6773
- ### Function: verifyOne
7027
+ ##### Function: verifyOne
6774
7028
 
6775
7029
  Helper function.
6776
7030
 
@@ -6795,7 +7049,7 @@ WERR_BAD_REQUEST if results has length other than one.
6795
7049
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6796
7050
 
6797
7051
  ---
6798
- ### Function: verifyOneOrNone
7052
+ ##### Function: verifyOneOrNone
6799
7053
 
6800
7054
  Helper function.
6801
7055
 
@@ -6820,7 +7074,7 @@ WERR_BAD_REQUEST if results has length greater than one.
6820
7074
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6821
7075
 
6822
7076
  ---
6823
- ### Function: verifyOptionalHexString
7077
+ ##### Function: verifyOptionalHexString
6824
7078
 
6825
7079
  Helper function.
6826
7080
 
@@ -6833,7 +7087,7 @@ export function verifyOptionalHexString(v?: string | null): string | undefined
6833
7087
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6834
7088
 
6835
7089
  ---
6836
- ### Function: verifyTruthy
7090
+ ##### Function: verifyTruthy
6837
7091
 
6838
7092
  Helper function.
6839
7093
 
@@ -6846,7 +7100,7 @@ export function verifyTruthy<T>(v: T | null | undefined, description?: string):
6846
7100
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6847
7101
 
6848
7102
  ---
6849
- ### Function: wait
7103
+ ##### Function: wait
6850
7104
 
6851
7105
  Returns an await'able Promise that resolves in the given number of msecs.
6852
7106
 
@@ -6859,7 +7113,7 @@ export function wait(msecs: number): Promise<void> {
6859
7113
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6860
7114
 
6861
7115
  ---
6862
- ## Types
7116
+ #### Types
6863
7117
 
6864
7118
  | | |
6865
7119
  | --- | --- |
@@ -6877,7 +7131,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
6877
7131
 
6878
7132
  ---
6879
7133
 
6880
- ### Type: Chain
7134
+ ##### Type: Chain
6881
7135
 
6882
7136
  ```ts
6883
7137
  export type Chain = "main" | "test"
@@ -6886,7 +7140,7 @@ export type Chain = "main" | "test"
6886
7140
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6887
7141
 
6888
7142
  ---
6889
- ### Type: DBType
7143
+ ##### Type: DBType
6890
7144
 
6891
7145
  ```ts
6892
7146
  export type DBType = "SQLite" | "MySQL"
@@ -6895,7 +7149,7 @@ export type DBType = "SQLite" | "MySQL"
6895
7149
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6896
7150
 
6897
7151
  ---
6898
- ### Type: GetMerklePathService
7152
+ ##### Type: GetMerklePathService
6899
7153
 
6900
7154
  ```ts
6901
7155
  export type GetMerklePathService = (txid: string, chain: sdk.Chain, services: WalletServices) => Promise<GetMerklePathResult>
@@ -6906,7 +7160,7 @@ See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathre
6906
7160
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6907
7161
 
6908
7162
  ---
6909
- ### Type: GetRawTxService
7163
+ ##### Type: GetRawTxService
6910
7164
 
6911
7165
  ```ts
6912
7166
  export type GetRawTxService = (txid: string, chain: sdk.Chain) => Promise<GetRawTxResult>
@@ -6917,7 +7171,7 @@ See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
6917
7171
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6918
7172
 
6919
7173
  ---
6920
- ### Type: GetUtxoStatusOutputFormat
7174
+ ##### Type: GetUtxoStatusOutputFormat
6921
7175
 
6922
7176
  ```ts
6923
7177
  export type GetUtxoStatusOutputFormat = "hashLE" | "hashBE" | "script"
@@ -6926,7 +7180,7 @@ export type GetUtxoStatusOutputFormat = "hashLE" | "hashBE" | "script"
6926
7180
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6927
7181
 
6928
7182
  ---
6929
- ### Type: GetUtxoStatusService
7183
+ ##### Type: GetUtxoStatusService
6930
7184
 
6931
7185
  ```ts
6932
7186
  export type GetUtxoStatusService = (output: string, chain: sdk.Chain, outputFormat?: GetUtxoStatusOutputFormat) => Promise<GetUtxoStatusResult>
@@ -6937,7 +7191,7 @@ See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatuso
6937
7191
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6938
7192
 
6939
7193
  ---
6940
- ### Type: KeyPairAddress
7194
+ ##### Type: KeyPairAddress
6941
7195
 
6942
7196
  ```ts
6943
7197
  export type KeyPairAddress = {
@@ -6950,7 +7204,7 @@ export type KeyPairAddress = {
6950
7204
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6951
7205
 
6952
7206
  ---
6953
- ### Type: MonitorStorage
7207
+ ##### Type: MonitorStorage
6954
7208
 
6955
7209
  ```ts
6956
7210
  export type MonitorStorage = WalletStorageManager
@@ -6961,7 +7215,7 @@ See also: [WalletStorageManager](#class-walletstoragemanager)
6961
7215
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6962
7216
 
6963
7217
  ---
6964
- ### Type: PostBeefService
7218
+ ##### Type: PostBeefService
6965
7219
 
6966
7220
  ```ts
6967
7221
  export type PostBeefService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostBeefResult>
@@ -6972,7 +7226,7 @@ See also: [PostBeefResult](#interface-postbeefresult), [WalletServices](#interfa
6972
7226
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6973
7227
 
6974
7228
  ---
6975
- ### Type: PostReqsToNetworkDetailsStatus
7229
+ ##### Type: PostReqsToNetworkDetailsStatus
6976
7230
 
6977
7231
  ```ts
6978
7232
  export type PostReqsToNetworkDetailsStatus = "success" | "doubleSpend" | "unknown"
@@ -6981,7 +7235,7 @@ export type PostReqsToNetworkDetailsStatus = "success" | "doubleSpend" | "unknow
6981
7235
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6982
7236
 
6983
7237
  ---
6984
- ### Type: PostTxsService
7238
+ ##### Type: PostTxsService
6985
7239
 
6986
7240
  ```ts
6987
7241
  export type PostTxsService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostTxsResult>
@@ -6992,7 +7246,7 @@ See also: [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface
6992
7246
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
6993
7247
 
6994
7248
  ---
6995
- ### Type: ProvenTxReqStatus
7249
+ ##### Type: ProvenTxReqStatus
6996
7250
 
6997
7251
  Initial status (attempts === 0):
6998
7252
 
@@ -7033,7 +7287,7 @@ export type ProvenTxReqStatus = "sending" | "unsent" | "nosend" | "unknown" | "n
7033
7287
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7034
7288
 
7035
7289
  ---
7036
- ### Type: StorageProvidedBy
7290
+ ##### Type: StorageProvidedBy
7037
7291
 
7038
7292
  ```ts
7039
7293
  export type StorageProvidedBy = "you" | "storage" | "you-and-storage"
@@ -7042,7 +7296,7 @@ export type StorageProvidedBy = "you" | "storage" | "you-and-storage"
7042
7296
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7043
7297
 
7044
7298
  ---
7045
- ### Type: SyncProtocolVersion
7299
+ ##### Type: SyncProtocolVersion
7046
7300
 
7047
7301
  ```ts
7048
7302
  export type SyncProtocolVersion = "0.1.0"
@@ -7051,7 +7305,7 @@ export type SyncProtocolVersion = "0.1.0"
7051
7305
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7052
7306
 
7053
7307
  ---
7054
- ### Type: SyncStatus
7308
+ ##### Type: SyncStatus
7055
7309
 
7056
7310
  success: Last sync of this user from this storage was successful.
7057
7311
 
@@ -7068,7 +7322,7 @@ export type SyncStatus = "success" | "error" | "identified" | "updated" | "unkno
7068
7322
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7069
7323
 
7070
7324
  ---
7071
- ### Type: TransactionStatus
7325
+ ##### Type: TransactionStatus
7072
7326
 
7073
7327
  ```ts
7074
7328
  export type TransactionStatus = "completed" | "failed" | "unprocessed" | "sending" | "unproven" | "unsigned" | "nosend"
@@ -7077,7 +7331,7 @@ export type TransactionStatus = "completed" | "failed" | "unprocessed" | "sendin
7077
7331
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7078
7332
 
7079
7333
  ---
7080
- ### Type: UpdateFiatExchangeRateService
7334
+ ##### Type: UpdateFiatExchangeRateService
7081
7335
 
7082
7336
  ```ts
7083
7337
  export type UpdateFiatExchangeRateService = (targetCurrencies: string[], options: WalletServicesOptions) => Promise<FiatExchangeRates>
@@ -7088,7 +7342,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
7088
7342
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7089
7343
 
7090
7344
  ---
7091
- ## Variables
7345
+ #### Variables
7092
7346
 
7093
7347
  | |
7094
7348
  | --- |
@@ -7100,7 +7354,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
7100
7354
 
7101
7355
  ---
7102
7356
 
7103
- ### Variable: ProvenTxReqNonTerminalStatus
7357
+ ##### Variable: ProvenTxReqNonTerminalStatus
7104
7358
 
7105
7359
  ```ts
7106
7360
  ProvenTxReqNonTerminalStatus: ProvenTxReqStatus[] = [
@@ -7121,7 +7375,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
7121
7375
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7122
7376
 
7123
7377
  ---
7124
- ### Variable: ProvenTxReqTerminalStatus
7378
+ ##### Variable: ProvenTxReqTerminalStatus
7125
7379
 
7126
7380
  ```ts
7127
7381
  ProvenTxReqTerminalStatus: ProvenTxReqStatus[] = [
@@ -7136,7 +7390,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
7136
7390
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7137
7391
 
7138
7392
  ---
7139
- ### Variable: brc29ProtocolID
7393
+ ##### Variable: brc29ProtocolID
7140
7394
 
7141
7395
  ```ts
7142
7396
  brc29ProtocolID: WalletProtocol = [2, "3241645161d8"]
@@ -7145,3 +7399,5 @@ brc29ProtocolID: WalletProtocol = [2, "3241645161d8"]
7145
7399
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
7146
7400
 
7147
7401
  ---
7402
+
7403
+ <!--#endregion ts2md-api-merged-here-->