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