@bsv/wallet-toolbox 1.1.4 → 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.
- package/docs/README.md +1 -1
- package/docs/client.md +714 -470
- package/docs/monitor.md +54 -37
- package/docs/services.md +53 -34
- package/docs/setup.md +326 -53
- package/docs/storage.md +116 -104
- package/docs/wallet.md +713 -470
- package/license.md +28 -1
- package/out/src/Setup.d.ts +27 -3
- package/out/src/Setup.d.ts.map +1 -1
- package/out/src/Setup.js +17 -5
- package/out/src/Setup.js.map +1 -1
- package/out/src/SetupClient.d.ts +130 -15
- package/out/src/SetupClient.d.ts.map +1 -1
- package/out/src/SetupClient.js +29 -15
- package/out/src/SetupClient.js.map +1 -1
- package/out/src/Wallet.d.ts +4 -0
- package/out/src/Wallet.d.ts.map +1 -1
- package/out/src/Wallet.js +7 -0
- package/out/src/Wallet.js.map +1 -1
- package/out/src/sdk/WalletError.d.ts +0 -1
- package/out/src/sdk/WalletError.d.ts.map +1 -1
- package/out/src/sdk/WalletError.js +0 -1
- package/out/src/sdk/WalletError.js.map +1 -1
- package/out/src/sdk/validationHelpers.d.ts +1 -0
- package/out/src/sdk/validationHelpers.d.ts.map +1 -1
- package/out/src/sdk/validationHelpers.js +2 -1
- package/out/src/sdk/validationHelpers.js.map +1 -1
- package/out/src/storage/StorageProvider.d.ts +1 -4
- package/out/src/storage/StorageProvider.d.ts.map +1 -1
- package/out/src/storage/StorageProvider.js +1 -4
- package/out/src/storage/StorageProvider.js.map +1 -1
- package/out/src/storage/WalletStorageManager.d.ts +1 -1
- package/out/src/storage/WalletStorageManager.js +1 -1
- package/out/src/storage/methods/createAction.d.ts.map +1 -1
- package/out/src/storage/methods/createAction.js +42 -11
- package/out/src/storage/methods/createAction.js.map +1 -1
- package/out/src/storage/methods/generateChange.js +1 -1
- package/out/src/storage/methods/generateChange.js.map +1 -1
- package/out/src/storage/methods/listOutputs.d.ts.map +1 -1
- package/out/src/storage/methods/listOutputs.js +4 -2
- package/out/src/storage/methods/listOutputs.js.map +1 -1
- package/out/src/storage/schema/tables/ProvenTxReq.d.ts +4 -4
- package/out/src/utility/ScriptTemplateSABPPP.d.ts +4 -0
- package/out/src/utility/ScriptTemplateSABPPP.d.ts.map +1 -1
- package/out/src/utility/ScriptTemplateSABPPP.js +4 -0
- package/out/src/utility/ScriptTemplateSABPPP.js.map +1 -1
- package/out/test/examples/README.man.test.js +1 -1
- package/out/test/utils/TestUtilsWalletStorage.d.ts +2 -1
- package/out/test/utils/TestUtilsWalletStorage.d.ts.map +1 -1
- package/out/test/utils/TestUtilsWalletStorage.js +112 -27
- package/out/test/utils/TestUtilsWalletStorage.js.map +1 -1
- package/out/test/wallet/action/createAction.test.js +31 -5
- package/out/test/wallet/action/createAction.test.js.map +1 -1
- package/out/test/wallet/action/createAction2.test.d.ts +37 -0
- package/out/test/wallet/action/createAction2.test.d.ts.map +1 -0
- package/out/test/wallet/action/createAction2.test.js +1145 -0
- package/out/test/wallet/action/createAction2.test.js.map +1 -0
- package/out/test/wallet/list/listOutputs.test.js +8 -12
- package/out/test/wallet/list/listOutputs.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/Setup.ts +29 -5
- package/src/SetupClient.ts +136 -22
- package/src/Wallet.ts +9 -0
- package/src/sdk/WalletError.ts +0 -1
- package/src/sdk/validationHelpers.ts +3 -1
- package/src/storage/StorageProvider.ts +1 -4
- package/src/storage/WalletStorageManager.ts +1 -1
- package/src/storage/methods/createAction.ts +48 -12
- package/src/storage/methods/generateChange.ts +1 -1
- package/src/storage/methods/listOutputs.ts +4 -2
- package/src/storage/schema/tables/ProvenTxReq.ts +4 -4
- package/src/utility/ScriptTemplateSABPPP.ts +4 -0
- package/test/examples/README.man.test.ts +1 -1
- package/test/utils/TestUtilsWalletStorage.ts +131 -35
- package/test/wallet/action/createAction.test.ts +36 -5
- package/test/wallet/action/createAction2.test.ts +1400 -0
- package/test/wallet/list/listOutputs.test.ts +7 -13
- package/ts2md.json +6 -6
- package/tsconfig.all.json +1 -1
- package/LICENSE.txt +0 -28
- package/dev.sqlite3 +0 -0
- package/knexfile.js +0 -9
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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: [
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
3415
|
+
##### Interface: XValidCreateActionOutput
|
|
3162
3416
|
|
|
3163
3417
|
```ts
|
|
3164
3418
|
export interface XValidCreateActionOutput extends sdk.ValidCreateActionOutput {
|
|
@@ -3175,29 +3429,28 @@ 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
|
-
|
|
3432
|
+
#### Classes
|
|
3179
3433
|
|
|
3180
3434
|
| | | |
|
|
3181
3435
|
| --- | --- | --- |
|
|
3182
|
-
| [CertOps](#class-certops) | [TaskCheckForProofs](#class-taskcheckforproofs) | [
|
|
3183
|
-
| [Monitor](#class-monitor) | [TaskClock](#class-taskclock) | [
|
|
3184
|
-
| [PrivilegedKeyManager](#class-privilegedkeymanager) | [TaskFailAbandoned](#class-taskfailabandoned) | [
|
|
3185
|
-
| [ScriptTemplateSABPPP](#class-scripttemplatesabppp) | [TaskNewHeader](#class-tasknewheader) | [
|
|
3186
|
-
| [ServiceCollection](#class-servicecollection) | [TaskPurge](#class-taskpurge) | [
|
|
3187
|
-
| [Services](#class-services) | [TaskReviewStatus](#class-taskreviewstatus) | [
|
|
3188
|
-
| [
|
|
3189
|
-
| [
|
|
3190
|
-
| [
|
|
3191
|
-
| [
|
|
3192
|
-
| [
|
|
3193
|
-
| [
|
|
3194
|
-
| [StorageSyncReader](#class-storagesyncreader) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) | |
|
|
3436
|
+
| [CertOps](#class-certops) | [TaskCheckForProofs](#class-taskcheckforproofs) | [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter) |
|
|
3437
|
+
| [Monitor](#class-monitor) | [TaskClock](#class-taskclock) | [WERR_INVALID_PUBLIC_KEY](#class-werr_invalid_public_key) |
|
|
3438
|
+
| [PrivilegedKeyManager](#class-privilegedkeymanager) | [TaskFailAbandoned](#class-taskfailabandoned) | [WERR_MISSING_PARAMETER](#class-werr_missing_parameter) |
|
|
3439
|
+
| [ScriptTemplateSABPPP](#class-scripttemplatesabppp) | [TaskNewHeader](#class-tasknewheader) | [WERR_NETWORK_CHAIN](#class-werr_network_chain) |
|
|
3440
|
+
| [ServiceCollection](#class-servicecollection) | [TaskPurge](#class-taskpurge) | [WERR_NOT_ACTIVE](#class-werr_not_active) |
|
|
3441
|
+
| [Services](#class-services) | [TaskReviewStatus](#class-taskreviewstatus) | [WERR_NOT_IMPLEMENTED](#class-werr_not_implemented) |
|
|
3442
|
+
| [SetupClient](#class-setupclient) | [TaskSendWaiting](#class-tasksendwaiting) | [WERR_UNAUTHORIZED](#class-werr_unauthorized) |
|
|
3443
|
+
| [StorageClient](#class-storageclient) | [TaskSyncWhenIdle](#class-tasksyncwhenidle) | [Wallet](#class-wallet) |
|
|
3444
|
+
| [StorageProvider](#class-storageprovider) | [WERR_BAD_REQUEST](#class-werr_bad_request) | [WalletError](#class-walleterror) |
|
|
3445
|
+
| [StorageReader](#class-storagereader) | [WERR_INSUFFICIENT_FUNDS](#class-werr_insufficient_funds) | [WalletMonitorTask](#class-walletmonitortask) |
|
|
3446
|
+
| [StorageReaderWriter](#class-storagereaderwriter) | [WERR_INTERNAL](#class-werr_internal) | [WalletSigner](#class-walletsigner) |
|
|
3447
|
+
| [StorageSyncReader](#class-storagesyncreader) | [WERR_INVALID_OPERATION](#class-werr_invalid_operation) | [WalletStorageManager](#class-walletstoragemanager) |
|
|
3195
3448
|
|
|
3196
3449
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3197
3450
|
|
|
3198
3451
|
---
|
|
3199
3452
|
|
|
3200
|
-
|
|
3453
|
+
##### Class: CertOps
|
|
3201
3454
|
|
|
3202
3455
|
```ts
|
|
3203
3456
|
export class CertOps extends BsvCertificate {
|
|
@@ -3247,7 +3500,7 @@ See also: [CertOpsWallet](#interface-certopswallet)
|
|
|
3247
3500
|
|
|
3248
3501
|
<summary>Class CertOps Details</summary>
|
|
3249
3502
|
|
|
3250
|
-
|
|
3503
|
+
###### Method createKeyringForVerifier
|
|
3251
3504
|
|
|
3252
3505
|
Creates a verifiable certificate structure for a specific verifier, allowing them access to specified fields.
|
|
3253
3506
|
This method decrypts the master field keys for each field specified in `fieldsToReveal` and re-encrypts them
|
|
@@ -3275,7 +3528,7 @@ Throws an error if:
|
|
|
3275
3528
|
- fieldsToReveal is empty or a field in `fieldsToReveal` does not exist in the certificate.
|
|
3276
3529
|
- The decrypted master field key fails to decrypt the corresponding field (indicating an invalid key).
|
|
3277
3530
|
|
|
3278
|
-
|
|
3531
|
+
###### Method encryptAndSignNewCertificate
|
|
3279
3532
|
|
|
3280
3533
|
encrypt plaintext field values for the subject
|
|
3281
3534
|
update the signature using the certifier's private key.
|
|
@@ -3289,7 +3542,7 @@ async encryptAndSignNewCertificate(): Promise<void>
|
|
|
3289
3542
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3290
3543
|
|
|
3291
3544
|
---
|
|
3292
|
-
|
|
3545
|
+
##### Class: Monitor
|
|
3293
3546
|
|
|
3294
3547
|
Background task to make sure transactions are processed, transaction proofs are received and propagated,
|
|
3295
3548
|
and potentially that reorgs update proofs that were already received.
|
|
@@ -3344,7 +3597,7 @@ See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorO
|
|
|
3344
3597
|
|
|
3345
3598
|
<summary>Class Monitor Details</summary>
|
|
3346
3599
|
|
|
3347
|
-
|
|
3600
|
+
###### Property _otherTasks
|
|
3348
3601
|
|
|
3349
3602
|
_otherTasks can be run by runTask but not by scheduler.
|
|
3350
3603
|
|
|
@@ -3353,7 +3606,7 @@ _otherTasks: WalletMonitorTask[] = []
|
|
|
3353
3606
|
```
|
|
3354
3607
|
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
3355
3608
|
|
|
3356
|
-
|
|
3609
|
+
###### Property _tasks
|
|
3357
3610
|
|
|
3358
3611
|
_tasks are typically run by the scheduler but may also be run by runTask.
|
|
3359
3612
|
|
|
@@ -3362,7 +3615,7 @@ _tasks: WalletMonitorTask[] = []
|
|
|
3362
3615
|
```
|
|
3363
3616
|
See also: [WalletMonitorTask](#class-walletmonitortask)
|
|
3364
3617
|
|
|
3365
|
-
|
|
3618
|
+
###### Method addDefaultTasks
|
|
3366
3619
|
|
|
3367
3620
|
Default tasks with settings appropriate for a single user storage
|
|
3368
3621
|
possibly with sync'ing enabled
|
|
@@ -3371,7 +3624,7 @@ possibly with sync'ing enabled
|
|
|
3371
3624
|
addDefaultTasks(): void
|
|
3372
3625
|
```
|
|
3373
3626
|
|
|
3374
|
-
|
|
3627
|
+
###### Method addMultiUserTasks
|
|
3375
3628
|
|
|
3376
3629
|
Tasks appropriate for multi-user storage
|
|
3377
3630
|
without sync'ing enabled.
|
|
@@ -3380,7 +3633,7 @@ without sync'ing enabled.
|
|
|
3380
3633
|
addMultiUserTasks(): void
|
|
3381
3634
|
```
|
|
3382
3635
|
|
|
3383
|
-
|
|
3636
|
+
###### Method processNewBlockHeader
|
|
3384
3637
|
|
|
3385
3638
|
Process new chain header event received from Chaintracks
|
|
3386
3639
|
|
|
@@ -3391,7 +3644,7 @@ processNewBlockHeader(header: BlockHeader): void
|
|
|
3391
3644
|
```
|
|
3392
3645
|
See also: [BlockHeader](#interface-blockheader)
|
|
3393
3646
|
|
|
3394
|
-
|
|
3647
|
+
###### Method processReorg
|
|
3395
3648
|
|
|
3396
3649
|
Process reorg event received from Chaintracks
|
|
3397
3650
|
|
|
@@ -3412,7 +3665,7 @@ See also: [BlockHeader](#interface-blockheader)
|
|
|
3412
3665
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3413
3666
|
|
|
3414
3667
|
---
|
|
3415
|
-
|
|
3668
|
+
##### Class: PrivilegedKeyManager
|
|
3416
3669
|
|
|
3417
3670
|
PrivilegedKeyManager
|
|
3418
3671
|
|
|
@@ -3447,7 +3700,7 @@ export class PrivilegedKeyManager implements ProtoWallet {
|
|
|
3447
3700
|
|
|
3448
3701
|
<summary>Class PrivilegedKeyManager Details</summary>
|
|
3449
3702
|
|
|
3450
|
-
|
|
3703
|
+
###### Constructor
|
|
3451
3704
|
|
|
3452
3705
|
```ts
|
|
3453
3706
|
constructor(keyGetter: (reason: string) => Promise<PrivateKey>, retentionPeriod = 120000)
|
|
@@ -3460,7 +3713,7 @@ Argument Details
|
|
|
3460
3713
|
+ **retentionPeriod**
|
|
3461
3714
|
+ Time in milliseconds to retain the obfuscated key in memory before zeroizing.
|
|
3462
3715
|
|
|
3463
|
-
|
|
3716
|
+
###### Method destroyKey
|
|
3464
3717
|
|
|
3465
3718
|
Safely destroys the in-memory obfuscated key material by zeroizing
|
|
3466
3719
|
and deleting related fields. Also destroys some (but not all) decoy
|
|
@@ -3475,7 +3728,10 @@ destroyKey(): void
|
|
|
3475
3728
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3476
3729
|
|
|
3477
3730
|
---
|
|
3478
|
-
|
|
3731
|
+
##### Class: ScriptTemplateSABPPP
|
|
3732
|
+
|
|
3733
|
+
Simple Authenticated BSV P2PKH Payment Protocol
|
|
3734
|
+
https://brc.dev/29
|
|
3479
3735
|
|
|
3480
3736
|
```ts
|
|
3481
3737
|
export class ScriptTemplateSABPPP implements ScriptTemplate {
|
|
@@ -3498,7 +3754,7 @@ See also: [ScriptTemplateParamsSABPPP](#interface-scripttemplateparamssabppp)
|
|
|
3498
3754
|
|
|
3499
3755
|
<summary>Class ScriptTemplateSABPPP Details</summary>
|
|
3500
3756
|
|
|
3501
|
-
|
|
3757
|
+
###### Property unlockLength
|
|
3502
3758
|
|
|
3503
3759
|
P2PKH unlock estimateLength is a constant
|
|
3504
3760
|
|
|
@@ -3511,7 +3767,7 @@ unlockLength = 108
|
|
|
3511
3767
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3512
3768
|
|
|
3513
3769
|
---
|
|
3514
|
-
|
|
3770
|
+
##### Class: ServiceCollection
|
|
3515
3771
|
|
|
3516
3772
|
```ts
|
|
3517
3773
|
export class ServiceCollection<T> {
|
|
@@ -3543,7 +3799,7 @@ export class ServiceCollection<T> {
|
|
|
3543
3799
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3544
3800
|
|
|
3545
3801
|
---
|
|
3546
|
-
|
|
3802
|
+
##### Class: Services
|
|
3547
3803
|
|
|
3548
3804
|
```ts
|
|
3549
3805
|
export class Services implements sdk.WalletServices {
|
|
@@ -3586,7 +3842,7 @@ See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [FiatExch
|
|
|
3586
3842
|
|
|
3587
3843
|
<summary>Class Services Details</summary>
|
|
3588
3844
|
|
|
3589
|
-
|
|
3845
|
+
###### Method postTxs
|
|
3590
3846
|
|
|
3591
3847
|
The beef must contain at least each rawTx for each txid.
|
|
3592
3848
|
Some services may require input transactions as well.
|
|
@@ -3602,21 +3858,7 @@ See also: [PostTxsResult](#interface-posttxsresult)
|
|
|
3602
3858
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3603
3859
|
|
|
3604
3860
|
---
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
Enables code that imports only from `SetupClient` to still reference everything as just `Setup`
|
|
3608
|
-
|
|
3609
|
-
```ts
|
|
3610
|
-
export class Setup extends SetupClient {
|
|
3611
|
-
}
|
|
3612
|
-
```
|
|
3613
|
-
|
|
3614
|
-
See also: [SetupClient](#class-setupclient)
|
|
3615
|
-
|
|
3616
|
-
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3617
|
-
|
|
3618
|
-
---
|
|
3619
|
-
### Class: SetupClient
|
|
3861
|
+
##### Class: SetupClient
|
|
3620
3862
|
|
|
3621
3863
|
The `SetupClient` class provides static setup functions to construct BRC-100 compatible
|
|
3622
3864
|
wallets in a variety of configurations.
|
|
@@ -3658,18 +3900,17 @@ export abstract class SetupClient {
|
|
|
3658
3900
|
}
|
|
3659
3901
|
static getEnv(chain: sdk.Chain): SetupEnv
|
|
3660
3902
|
static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
3661
|
-
|
|
3903
|
+
const chain = args.env.chain;
|
|
3662
3904
|
args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
|
|
3663
3905
|
const rootKey = PrivateKey.fromHex(args.rootKeyHex);
|
|
3664
3906
|
const identityKey = rootKey.toPublicKey().toString();
|
|
3665
3907
|
const keyDeriver = new KeyDeriver(rootKey);
|
|
3666
|
-
const chain = args.chain;
|
|
3667
3908
|
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
3668
3909
|
if (storage.stores.length > 0)
|
|
3669
3910
|
await storage.makeAvailable();
|
|
3670
3911
|
const serviceOptions = Services.createDefaultOptions(chain);
|
|
3671
3912
|
serviceOptions.taalApiKey = args.env.taalApiKey;
|
|
3672
|
-
const services = new Services(
|
|
3913
|
+
const services = new Services(chain);
|
|
3673
3914
|
const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
|
|
3674
3915
|
const monitor = new Monitor(monopts);
|
|
3675
3916
|
monitor.addDefaultTasks();
|
|
@@ -3698,7 +3939,7 @@ export abstract class SetupClient {
|
|
|
3698
3939
|
};
|
|
3699
3940
|
return r;
|
|
3700
3941
|
}
|
|
3701
|
-
static async
|
|
3942
|
+
static async createWalletClient(args: SetupWalletClientArgs): Promise<SetupWalletClient>
|
|
3702
3943
|
static getKeyPair(priv?: string | PrivateKey): KeyPairAddress
|
|
3703
3944
|
static getLockP2PKH(address: string)
|
|
3704
3945
|
static getUnlockP2PKH(priv: PrivateKey, satoshis: number): sdk.ScriptTemplateUnlock
|
|
@@ -3729,7 +3970,7 @@ See also: [Chain](#type-chain), [KeyPairAddress](#type-keypairaddress), [Monitor
|
|
|
3729
3970
|
|
|
3730
3971
|
<summary>Class SetupClient Details</summary>
|
|
3731
3972
|
|
|
3732
|
-
|
|
3973
|
+
###### Method createWallet
|
|
3733
3974
|
|
|
3734
3975
|
Create a `Wallet`. Storage can optionally be provided or configured later.
|
|
3735
3976
|
|
|
@@ -3738,18 +3979,17 @@ Optionally, PrivilegedKeyManager is also configured.
|
|
|
3738
3979
|
|
|
3739
3980
|
```ts
|
|
3740
3981
|
static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
3741
|
-
|
|
3982
|
+
const chain = args.env.chain;
|
|
3742
3983
|
args.rootKeyHex ||= args.env.devKeys[args.env.identityKey];
|
|
3743
3984
|
const rootKey = PrivateKey.fromHex(args.rootKeyHex);
|
|
3744
3985
|
const identityKey = rootKey.toPublicKey().toString();
|
|
3745
3986
|
const keyDeriver = new KeyDeriver(rootKey);
|
|
3746
|
-
const chain = args.chain;
|
|
3747
3987
|
const storage = new WalletStorageManager(identityKey, args.active, args.backups);
|
|
3748
3988
|
if (storage.stores.length > 0)
|
|
3749
3989
|
await storage.makeAvailable();
|
|
3750
3990
|
const serviceOptions = Services.createDefaultOptions(chain);
|
|
3751
3991
|
serviceOptions.taalApiKey = args.env.taalApiKey;
|
|
3752
|
-
const services = new Services(
|
|
3992
|
+
const services = new Services(chain);
|
|
3753
3993
|
const monopts = Monitor.createDefaultWalletMonitorOptions(chain, storage, services);
|
|
3754
3994
|
const monitor = new Monitor(monopts);
|
|
3755
3995
|
monitor.addDefaultTasks();
|
|
@@ -3781,7 +4021,7 @@ static async createWallet(args: SetupWalletArgs): Promise<SetupWallet> {
|
|
|
3781
4021
|
```
|
|
3782
4022
|
See also: [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [Services](#class-services), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
3783
4023
|
|
|
3784
|
-
|
|
4024
|
+
###### Method getEnv
|
|
3785
4025
|
|
|
3786
4026
|
Reads a .env file of the format created by `makeEnv`.
|
|
3787
4027
|
|
|
@@ -3803,7 +4043,7 @@ Argument Details
|
|
|
3803
4043
|
+ **chain**
|
|
3804
4044
|
+ Which chain to use: 'test' or 'main'
|
|
3805
4045
|
|
|
3806
|
-
|
|
4046
|
+
###### Method makeEnv
|
|
3807
4047
|
|
|
3808
4048
|
Creates content for .env file with some private keys, identity keys, sample API keys, and sample MySQL connection string.
|
|
3809
4049
|
|
|
@@ -3821,7 +4061,7 @@ static makeEnv(): string
|
|
|
3821
4061
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3822
4062
|
|
|
3823
4063
|
---
|
|
3824
|
-
|
|
4064
|
+
##### Class: StorageClient
|
|
3825
4065
|
|
|
3826
4066
|
```ts
|
|
3827
4067
|
export class StorageClient implements sdk.WalletStorageProvider {
|
|
@@ -3869,7 +4109,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
|
|
|
3869
4109
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3870
4110
|
|
|
3871
4111
|
---
|
|
3872
|
-
|
|
4112
|
+
##### Class: StorageProvider
|
|
3873
4113
|
|
|
3874
4114
|
```ts
|
|
3875
4115
|
export abstract class StorageProvider extends StorageReaderWriter implements sdk.WalletStorageProvider {
|
|
@@ -3937,7 +4177,7 @@ See also: [AuthId](#interface-authid), [Chain](#type-chain), [FindCertificatesAr
|
|
|
3937
4177
|
|
|
3938
4178
|
<summary>Class StorageProvider Details</summary>
|
|
3939
4179
|
|
|
3940
|
-
|
|
4180
|
+
###### Method confirmSpendableOutputs
|
|
3941
4181
|
|
|
3942
4182
|
For each spendable output in the 'default' basket of the authenticated user,
|
|
3943
4183
|
verify that the output script, satoshis, vout and txid match that of an output
|
|
@@ -3953,7 +4193,7 @@ Returns
|
|
|
3953
4193
|
|
|
3954
4194
|
object with invalidSpendableOutputs array. A good result is an empty array.
|
|
3955
4195
|
|
|
3956
|
-
|
|
4196
|
+
###### Method getProvenOrReq
|
|
3957
4197
|
|
|
3958
4198
|
Checks if txid is a known valid ProvenTx and returns it if found.
|
|
3959
4199
|
Next checks if txid is a current ProvenTxReq and returns that if found.
|
|
@@ -3968,10 +4208,10 @@ async getProvenOrReq(txid: string, newReq?: table.ProvenTxReq, trx?: sdk.TrxToke
|
|
|
3968
4208
|
```
|
|
3969
4209
|
See also: [StorageProvenOrReq](#interface-storageprovenorreq), [TrxToken](#interface-trxtoken)
|
|
3970
4210
|
|
|
3971
|
-
|
|
4211
|
+
###### Method getReqsAndBeefToShareWithWorld
|
|
3972
4212
|
|
|
3973
4213
|
Given an array of transaction txids with current ProvenTxReq ready-to-share status,
|
|
3974
|
-
lookup their
|
|
4214
|
+
lookup their ProvenTxReqApi req records.
|
|
3975
4215
|
For the txids with reqs and status still ready to send construct a single merged beef.
|
|
3976
4216
|
|
|
3977
4217
|
```ts
|
|
@@ -3979,7 +4219,7 @@ async getReqsAndBeefToShareWithWorld(txids: string[], knownTxids: string[], trx?
|
|
|
3979
4219
|
```
|
|
3980
4220
|
See also: [GetReqsAndBeefResult](#interface-getreqsandbeefresult), [TrxToken](#interface-trxtoken)
|
|
3981
4221
|
|
|
3982
|
-
|
|
4222
|
+
###### Method updateProvenTxReqWithNewProvenTx
|
|
3983
4223
|
|
|
3984
4224
|
Handles storage changes when a valid MerklePath and mined block header are found for a ProvenTxReq txid.
|
|
3985
4225
|
|
|
@@ -3998,7 +4238,7 @@ async updateProvenTxReqWithNewProvenTx(args: sdk.UpdateProvenTxReqWithNewProvenT
|
|
|
3998
4238
|
```
|
|
3999
4239
|
See also: [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult)
|
|
4000
4240
|
|
|
4001
|
-
|
|
4241
|
+
###### Method updateTransactionStatus
|
|
4002
4242
|
|
|
4003
4243
|
For all `status` values besides 'failed', just updates the transaction records status property.
|
|
4004
4244
|
|
|
@@ -4009,18 +4249,12 @@ async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: num
|
|
|
4009
4249
|
```
|
|
4010
4250
|
See also: [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken)
|
|
4011
4251
|
|
|
4012
|
-
Throws
|
|
4013
|
-
|
|
4014
|
-
ERR_DOJO_COMPLETED_TX if current status is 'completed' and new status is not 'completed.
|
|
4015
|
-
|
|
4016
|
-
ERR_DOJO_PROVEN_TX if transaction has proof or provenTxId and new status is not 'completed'.
|
|
4017
|
-
|
|
4018
4252
|
</details>
|
|
4019
4253
|
|
|
4020
4254
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4021
4255
|
|
|
4022
4256
|
---
|
|
4023
|
-
|
|
4257
|
+
##### Class: StorageReader
|
|
4024
4258
|
|
|
4025
4259
|
The `StorageReader` abstract class is the base of the concrete wallet storage provider classes.
|
|
4026
4260
|
|
|
@@ -4089,7 +4323,7 @@ See also: [Chain](#type-chain), [DBType](#type-dbtype), [FindCertificateFieldsAr
|
|
|
4089
4323
|
|
|
4090
4324
|
<summary>Class StorageReader Details</summary>
|
|
4091
4325
|
|
|
4092
|
-
|
|
4326
|
+
###### Method validateEntityDate
|
|
4093
4327
|
|
|
4094
4328
|
Force dates to strings on SQLite and Date objects on MySQL
|
|
4095
4329
|
|
|
@@ -4097,7 +4331,7 @@ Force dates to strings on SQLite and Date objects on MySQL
|
|
|
4097
4331
|
validateEntityDate(date: Date | string | number): Date | string
|
|
4098
4332
|
```
|
|
4099
4333
|
|
|
4100
|
-
|
|
4334
|
+
###### Method validateOptionalEntityDate
|
|
4101
4335
|
|
|
4102
4336
|
```ts
|
|
4103
4337
|
validateOptionalEntityDate(date: Date | string | number | null | undefined, useNowAsDefault?: boolean): Date | string | undefined
|
|
@@ -4113,7 +4347,7 @@ Argument Details
|
|
|
4113
4347
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4114
4348
|
|
|
4115
4349
|
---
|
|
4116
|
-
|
|
4350
|
+
##### Class: StorageReaderWriter
|
|
4117
4351
|
|
|
4118
4352
|
```ts
|
|
4119
4353
|
export abstract class StorageReaderWriter extends StorageReader {
|
|
@@ -4205,7 +4439,7 @@ See also: [AuthId](#interface-authid), [FindOutputTagMapsArgs](#interface-findou
|
|
|
4205
4439
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4206
4440
|
|
|
4207
4441
|
---
|
|
4208
|
-
|
|
4442
|
+
##### Class: StorageSyncReader
|
|
4209
4443
|
|
|
4210
4444
|
The `StorageSyncReader` non-abstract class must be used when authentication checking access to the methods of a `StorageBaseReader` is required.
|
|
4211
4445
|
|
|
@@ -4242,7 +4476,7 @@ See also: [AuthId](#interface-authid), [FindCertificateFieldsArgs](#interface-fi
|
|
|
4242
4476
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4243
4477
|
|
|
4244
4478
|
---
|
|
4245
|
-
|
|
4479
|
+
##### Class: TaskCheckForProofs
|
|
4246
4480
|
|
|
4247
4481
|
`TaskCheckForProofs` is a WalletMonitor task that retreives merkle proofs for
|
|
4248
4482
|
transactions.
|
|
@@ -4278,7 +4512,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4278
4512
|
|
|
4279
4513
|
<summary>Class TaskCheckForProofs Details</summary>
|
|
4280
4514
|
|
|
4281
|
-
|
|
4515
|
+
###### Property checkNow
|
|
4282
4516
|
|
|
4283
4517
|
An external service such as the chaintracks new block header
|
|
4284
4518
|
listener can set this true to cause
|
|
@@ -4287,7 +4521,7 @@ listener can set this true to cause
|
|
|
4287
4521
|
static checkNow = false
|
|
4288
4522
|
```
|
|
4289
4523
|
|
|
4290
|
-
|
|
4524
|
+
###### Method getProofs
|
|
4291
4525
|
|
|
4292
4526
|
Process an array of table.ProvenTxReq (typically with status 'unmined' or 'unknown')
|
|
4293
4527
|
|
|
@@ -4312,7 +4546,7 @@ Returns
|
|
|
4312
4546
|
|
|
4313
4547
|
reqs partitioned by status
|
|
4314
4548
|
|
|
4315
|
-
|
|
4549
|
+
###### Method trigger
|
|
4316
4550
|
|
|
4317
4551
|
Normally triggered by checkNow getting set by new block header found event from chaintracks
|
|
4318
4552
|
|
|
@@ -4327,7 +4561,7 @@ trigger(nowMsecsSinceEpoch: number): {
|
|
|
4327
4561
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4328
4562
|
|
|
4329
4563
|
---
|
|
4330
|
-
|
|
4564
|
+
##### Class: TaskClock
|
|
4331
4565
|
|
|
4332
4566
|
```ts
|
|
4333
4567
|
export class TaskClock extends WalletMonitorTask {
|
|
@@ -4347,7 +4581,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4347
4581
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4348
4582
|
|
|
4349
4583
|
---
|
|
4350
|
-
|
|
4584
|
+
##### Class: TaskFailAbandoned
|
|
4351
4585
|
|
|
4352
4586
|
Handles transactions which do not have terminal status and have not been
|
|
4353
4587
|
updated for an extended time period.
|
|
@@ -4372,7 +4606,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4372
4606
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4373
4607
|
|
|
4374
4608
|
---
|
|
4375
|
-
|
|
4609
|
+
##### Class: TaskNewHeader
|
|
4376
4610
|
|
|
4377
4611
|
```ts
|
|
4378
4612
|
export class TaskNewHeader extends WalletMonitorTask {
|
|
@@ -4392,7 +4626,7 @@ See also: [BlockHeader](#interface-blockheader), [Monitor](#class-monitor), [Wal
|
|
|
4392
4626
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4393
4627
|
|
|
4394
4628
|
---
|
|
4395
|
-
|
|
4629
|
+
##### Class: TaskPurge
|
|
4396
4630
|
|
|
4397
4631
|
```ts
|
|
4398
4632
|
export class TaskPurge extends WalletMonitorTask {
|
|
@@ -4412,7 +4646,7 @@ See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparam
|
|
|
4412
4646
|
|
|
4413
4647
|
<summary>Class TaskPurge Details</summary>
|
|
4414
4648
|
|
|
4415
|
-
|
|
4649
|
+
###### Property checkNow
|
|
4416
4650
|
|
|
4417
4651
|
Set to true to trigger running this task
|
|
4418
4652
|
|
|
@@ -4425,7 +4659,7 @@ static checkNow = false
|
|
|
4425
4659
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4426
4660
|
|
|
4427
4661
|
---
|
|
4428
|
-
|
|
4662
|
+
##### Class: TaskReviewStatus
|
|
4429
4663
|
|
|
4430
4664
|
Notify Transaction records of changes in ProvenTxReq records they may have missed.
|
|
4431
4665
|
|
|
@@ -4453,7 +4687,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4453
4687
|
|
|
4454
4688
|
<summary>Class TaskReviewStatus Details</summary>
|
|
4455
4689
|
|
|
4456
|
-
|
|
4690
|
+
###### Property checkNow
|
|
4457
4691
|
|
|
4458
4692
|
Set to true to trigger running this task
|
|
4459
4693
|
|
|
@@ -4466,7 +4700,7 @@ static checkNow = false
|
|
|
4466
4700
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4467
4701
|
|
|
4468
4702
|
---
|
|
4469
|
-
|
|
4703
|
+
##### Class: TaskSendWaiting
|
|
4470
4704
|
|
|
4471
4705
|
```ts
|
|
4472
4706
|
export class TaskSendWaiting extends WalletMonitorTask {
|
|
@@ -4486,7 +4720,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4486
4720
|
|
|
4487
4721
|
<summary>Class TaskSendWaiting Details</summary>
|
|
4488
4722
|
|
|
4489
|
-
|
|
4723
|
+
###### Method processUnsent
|
|
4490
4724
|
|
|
4491
4725
|
Process an array of 'unsent' status table.ProvenTxReq
|
|
4492
4726
|
|
|
@@ -4511,7 +4745,7 @@ async processUnsent(reqApis: table.ProvenTxReq[], indent = 0): Promise<string>
|
|
|
4511
4745
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4512
4746
|
|
|
4513
4747
|
---
|
|
4514
|
-
|
|
4748
|
+
##### Class: TaskSyncWhenIdle
|
|
4515
4749
|
|
|
4516
4750
|
```ts
|
|
4517
4751
|
export class TaskSyncWhenIdle extends WalletMonitorTask {
|
|
@@ -4529,7 +4763,7 @@ See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortas
|
|
|
4529
4763
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4530
4764
|
|
|
4531
4765
|
---
|
|
4532
|
-
|
|
4766
|
+
##### Class: WERR_BAD_REQUEST
|
|
4533
4767
|
|
|
4534
4768
|
The request is invalid.
|
|
4535
4769
|
|
|
@@ -4544,7 +4778,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4544
4778
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4545
4779
|
|
|
4546
4780
|
---
|
|
4547
|
-
|
|
4781
|
+
##### Class: WERR_INSUFFICIENT_FUNDS
|
|
4548
4782
|
|
|
4549
4783
|
Insufficient funds in the available inputs to cover the cost of the required outputs
|
|
4550
4784
|
and the transaction fee (${moreSatoshisNeeded} more satoshis are needed,
|
|
@@ -4563,7 +4797,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4563
4797
|
|
|
4564
4798
|
<summary>Class WERR_INSUFFICIENT_FUNDS Details</summary>
|
|
4565
4799
|
|
|
4566
|
-
|
|
4800
|
+
###### Constructor
|
|
4567
4801
|
|
|
4568
4802
|
```ts
|
|
4569
4803
|
constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number)
|
|
@@ -4581,7 +4815,7 @@ Argument Details
|
|
|
4581
4815
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4582
4816
|
|
|
4583
4817
|
---
|
|
4584
|
-
|
|
4818
|
+
##### Class: WERR_INTERNAL
|
|
4585
4819
|
|
|
4586
4820
|
An internal error has occurred.
|
|
4587
4821
|
|
|
@@ -4598,7 +4832,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4598
4832
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4599
4833
|
|
|
4600
4834
|
---
|
|
4601
|
-
|
|
4835
|
+
##### Class: WERR_INVALID_OPERATION
|
|
4602
4836
|
|
|
4603
4837
|
The ${parameter} parameter is invalid.
|
|
4604
4838
|
|
|
@@ -4615,7 +4849,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4615
4849
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4616
4850
|
|
|
4617
4851
|
---
|
|
4618
|
-
|
|
4852
|
+
##### Class: WERR_INVALID_PARAMETER
|
|
4619
4853
|
|
|
4620
4854
|
The ${parameter} parameter is invalid.
|
|
4621
4855
|
|
|
@@ -4632,7 +4866,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4632
4866
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4633
4867
|
|
|
4634
4868
|
---
|
|
4635
|
-
|
|
4869
|
+
##### Class: WERR_INVALID_PUBLIC_KEY
|
|
4636
4870
|
|
|
4637
4871
|
```ts
|
|
4638
4872
|
export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
@@ -4646,7 +4880,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4646
4880
|
|
|
4647
4881
|
<summary>Class WERR_INVALID_PUBLIC_KEY Details</summary>
|
|
4648
4882
|
|
|
4649
|
-
|
|
4883
|
+
###### Constructor
|
|
4650
4884
|
|
|
4651
4885
|
```ts
|
|
4652
4886
|
constructor(public key: string, network: WalletNetwork = "mainnet")
|
|
@@ -4664,7 +4898,7 @@ Argument Details
|
|
|
4664
4898
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4665
4899
|
|
|
4666
4900
|
---
|
|
4667
|
-
|
|
4901
|
+
##### Class: WERR_MISSING_PARAMETER
|
|
4668
4902
|
|
|
4669
4903
|
The required ${parameter} parameter is missing.
|
|
4670
4904
|
|
|
@@ -4681,7 +4915,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4681
4915
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4682
4916
|
|
|
4683
4917
|
---
|
|
4684
|
-
|
|
4918
|
+
##### Class: WERR_NETWORK_CHAIN
|
|
4685
4919
|
|
|
4686
4920
|
Configured network chain is invalid or does not match across services.
|
|
4687
4921
|
|
|
@@ -4696,7 +4930,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4696
4930
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4697
4931
|
|
|
4698
4932
|
---
|
|
4699
|
-
|
|
4933
|
+
##### Class: WERR_NOT_ACTIVE
|
|
4700
4934
|
|
|
4701
4935
|
WalletStorageManager is not accessing user's active storage.
|
|
4702
4936
|
|
|
@@ -4711,7 +4945,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4711
4945
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4712
4946
|
|
|
4713
4947
|
---
|
|
4714
|
-
|
|
4948
|
+
##### Class: WERR_NOT_IMPLEMENTED
|
|
4715
4949
|
|
|
4716
4950
|
Not implemented.
|
|
4717
4951
|
|
|
@@ -4726,7 +4960,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4726
4960
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4727
4961
|
|
|
4728
4962
|
---
|
|
4729
|
-
|
|
4963
|
+
##### Class: WERR_UNAUTHORIZED
|
|
4730
4964
|
|
|
4731
4965
|
Access is denied due to an authorization error.
|
|
4732
4966
|
|
|
@@ -4741,7 +4975,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4741
4975
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4742
4976
|
|
|
4743
4977
|
---
|
|
4744
|
-
|
|
4978
|
+
##### Class: Wallet
|
|
4745
4979
|
|
|
4746
4980
|
```ts
|
|
4747
4981
|
export class Wallet implements WalletInterface, ProtoWallet {
|
|
@@ -4757,6 +4991,7 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
4757
4991
|
proto: ProtoWallet;
|
|
4758
4992
|
privilegedKeyManager?: sdk.PrivilegedKeyManager;
|
|
4759
4993
|
pendingSignActions: Record<string, PendingSignAction>;
|
|
4994
|
+
randomVals?: number[] = undefined;
|
|
4760
4995
|
constructor(argsOrSigner: WalletArgs | WalletSigner, services?: sdk.WalletServices, monitor?: Monitor, privilegedKeyManager?: sdk.PrivilegedKeyManager)
|
|
4761
4996
|
async destroy(): Promise<void>
|
|
4762
4997
|
getClientChangeKeyPair(): sdk.KeyPair
|
|
@@ -4802,7 +5037,7 @@ See also: [Chain](#type-chain), [KeyPair](#interface-keypair), [Monitor](#class-
|
|
|
4802
5037
|
|
|
4803
5038
|
<summary>Class Wallet Details</summary>
|
|
4804
5039
|
|
|
4805
|
-
|
|
5040
|
+
###### Property beef
|
|
4806
5041
|
|
|
4807
5042
|
The wallet creates a `BeefParty` when it is created.
|
|
4808
5043
|
All the Beefs that pass through the wallet are merged into this beef.
|
|
@@ -4817,7 +5052,15 @@ Over time, this allows an active wallet to drastically reduce the amount of data
|
|
|
4817
5052
|
beef: BeefParty
|
|
4818
5053
|
```
|
|
4819
5054
|
|
|
4820
|
-
|
|
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
|
|
4821
5064
|
|
|
4822
5065
|
```ts
|
|
4823
5066
|
getKnownTxids(newKnownTxids?: string[]): string[]
|
|
@@ -4837,7 +5080,7 @@ Argument Details
|
|
|
4837
5080
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4838
5081
|
|
|
4839
5082
|
---
|
|
4840
|
-
|
|
5083
|
+
##### Class: WalletError
|
|
4841
5084
|
|
|
4842
5085
|
Derived class constructors should use the derived class name as the value for `name`,
|
|
4843
5086
|
and an internationalizable constant string for `message`.
|
|
@@ -4873,7 +5116,7 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
4873
5116
|
|
|
4874
5117
|
<summary>Class WalletError Details</summary>
|
|
4875
5118
|
|
|
4876
|
-
|
|
5119
|
+
###### Method asStatus
|
|
4877
5120
|
|
|
4878
5121
|
```ts
|
|
4879
5122
|
asStatus(): {
|
|
@@ -4887,12 +5130,10 @@ Returns
|
|
|
4887
5130
|
|
|
4888
5131
|
standard HTTP error status object with status property set to 'error'.
|
|
4889
5132
|
|
|
4890
|
-
|
|
5133
|
+
###### Method fromUnknown
|
|
4891
5134
|
|
|
4892
5135
|
Recovers all public fields from WalletError derived error classes and relevant Error derived errors.
|
|
4893
5136
|
|
|
4894
|
-
Critical client data fields are preserved across HTTP DojoExpress / DojoExpressClient encoding.
|
|
4895
|
-
|
|
4896
5137
|
```ts
|
|
4897
5138
|
static fromUnknown(err: unknown): WalletError
|
|
4898
5139
|
```
|
|
@@ -4903,7 +5144,7 @@ See also: [WalletError](#class-walleterror)
|
|
|
4903
5144
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4904
5145
|
|
|
4905
5146
|
---
|
|
4906
|
-
|
|
5147
|
+
##### Class: WalletMonitorTask
|
|
4907
5148
|
|
|
4908
5149
|
A monitor task performs some periodic or state triggered maintenance function
|
|
4909
5150
|
on the data managed by a wallet (Bitcoin UTXO manager, aka wallet)
|
|
@@ -4938,7 +5179,7 @@ See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
|
|
|
4938
5179
|
|
|
4939
5180
|
<summary>Class WalletMonitorTask Details</summary>
|
|
4940
5181
|
|
|
4941
|
-
|
|
5182
|
+
###### Property lastRunMsecsSinceEpoch
|
|
4942
5183
|
|
|
4943
5184
|
Set by monitor each time runTask completes
|
|
4944
5185
|
|
|
@@ -4946,7 +5187,7 @@ Set by monitor each time runTask completes
|
|
|
4946
5187
|
lastRunMsecsSinceEpoch = 0
|
|
4947
5188
|
```
|
|
4948
5189
|
|
|
4949
|
-
|
|
5190
|
+
###### Method asyncSetup
|
|
4950
5191
|
|
|
4951
5192
|
Override to handle async task setup configuration.
|
|
4952
5193
|
|
|
@@ -4956,7 +5197,7 @@ Called before first call to `trigger`
|
|
|
4956
5197
|
async asyncSetup(): Promise<void>
|
|
4957
5198
|
```
|
|
4958
5199
|
|
|
4959
|
-
|
|
5200
|
+
###### Method trigger
|
|
4960
5201
|
|
|
4961
5202
|
Return true if `runTask` needs to be called now.
|
|
4962
5203
|
|
|
@@ -4971,7 +5212,7 @@ abstract trigger(nowMsecsSinceEpoch: number): {
|
|
|
4971
5212
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4972
5213
|
|
|
4973
5214
|
---
|
|
4974
|
-
|
|
5215
|
+
##### Class: WalletSigner
|
|
4975
5216
|
|
|
4976
5217
|
```ts
|
|
4977
5218
|
export class WalletSigner {
|
|
@@ -4988,9 +5229,9 @@ See also: [Chain](#type-chain), [WalletStorageManager](#class-walletstoragemanag
|
|
|
4988
5229
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4989
5230
|
|
|
4990
5231
|
---
|
|
4991
|
-
|
|
5232
|
+
##### Class: WalletStorageManager
|
|
4992
5233
|
|
|
4993
|
-
The `
|
|
5234
|
+
The `WalletStorageManager` class delivers authentication checking storage access to the wallet.
|
|
4994
5235
|
|
|
4995
5236
|
If manages multiple `StorageBase` derived storage services: one actice, the rest as backups.
|
|
4996
5237
|
|
|
@@ -5071,7 +5312,7 @@ See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcer
|
|
|
5071
5312
|
|
|
5072
5313
|
<summary>Class WalletStorageManager Details</summary>
|
|
5073
5314
|
|
|
5074
|
-
|
|
5315
|
+
###### Property _isSingleWriter
|
|
5075
5316
|
|
|
5076
5317
|
if true, allow only a single writer to proceed at a time.
|
|
5077
5318
|
queue the blocked requests so they get executed in order when released.
|
|
@@ -5080,7 +5321,7 @@ queue the blocked requests so they get executed in order when released.
|
|
|
5080
5321
|
_isSingleWriter: boolean = true
|
|
5081
5322
|
```
|
|
5082
5323
|
|
|
5083
|
-
|
|
5324
|
+
###### Property _storageProviderLocked
|
|
5084
5325
|
|
|
5085
5326
|
if true, allow no new reader or writers or sync to proceed.
|
|
5086
5327
|
queue the blocked requests so they get executed in order when released.
|
|
@@ -5089,7 +5330,7 @@ queue the blocked requests so they get executed in order when released.
|
|
|
5089
5330
|
_storageProviderLocked: boolean = false
|
|
5090
5331
|
```
|
|
5091
5332
|
|
|
5092
|
-
|
|
5333
|
+
###### Property _syncLocked
|
|
5093
5334
|
|
|
5094
5335
|
if true, allow no new reader or writers to proceed.
|
|
5095
5336
|
queue the blocked requests so they get executed in order when released.
|
|
@@ -5098,7 +5339,7 @@ queue the blocked requests so they get executed in order when released.
|
|
|
5098
5339
|
_syncLocked: boolean = false
|
|
5099
5340
|
```
|
|
5100
5341
|
|
|
5101
|
-
|
|
5342
|
+
###### Method isActiveStorageProvider
|
|
5102
5343
|
|
|
5103
5344
|
```ts
|
|
5104
5345
|
isActiveStorageProvider(): boolean
|
|
@@ -5108,7 +5349,7 @@ Returns
|
|
|
5108
5349
|
|
|
5109
5350
|
true if the active `WalletStorageProvider` also implements `StorageProvider`
|
|
5110
5351
|
|
|
5111
|
-
|
|
5352
|
+
###### Method runAsSync
|
|
5112
5353
|
|
|
5113
5354
|
```ts
|
|
5114
5355
|
async runAsSync<R>(sync: (active: sdk.WalletStorageSync) => Promise<R>, activeSync?: sdk.WalletStorageSync): Promise<R>
|
|
@@ -5122,7 +5363,7 @@ Argument Details
|
|
|
5122
5363
|
+ **activeSync**
|
|
5123
5364
|
+ from chained sync functions, active storage already held under sync access lock.
|
|
5124
5365
|
|
|
5125
|
-
|
|
5366
|
+
###### Method setActive
|
|
5126
5367
|
|
|
5127
5368
|
Updates backups and switches to new active storage provider from among current backup providers.
|
|
5128
5369
|
|
|
@@ -5140,7 +5381,7 @@ Argument Details
|
|
|
5140
5381
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5141
5382
|
|
|
5142
5383
|
---
|
|
5143
|
-
|
|
5384
|
+
#### Functions
|
|
5144
5385
|
|
|
5145
5386
|
| | | |
|
|
5146
5387
|
| --- | --- | --- |
|
|
@@ -5187,7 +5428,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5187
5428
|
|
|
5188
5429
|
---
|
|
5189
5430
|
|
|
5190
|
-
|
|
5431
|
+
##### Function: acquireDirectCertificate
|
|
5191
5432
|
|
|
5192
5433
|
```ts
|
|
5193
5434
|
export async function acquireDirectCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidAcquireDirectCertificateArgs): Promise<AcquireCertificateResult>
|
|
@@ -5198,7 +5439,7 @@ See also: [AuthId](#interface-authid), [ValidAcquireDirectCertificateArgs](#inte
|
|
|
5198
5439
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5199
5440
|
|
|
5200
5441
|
---
|
|
5201
|
-
|
|
5442
|
+
##### Function: arraysEqual
|
|
5202
5443
|
|
|
5203
5444
|
Compares lengths and direct equality of values.
|
|
5204
5445
|
|
|
@@ -5209,7 +5450,7 @@ export function arraysEqual(arr1: Number[], arr2: Number[])
|
|
|
5209
5450
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5210
5451
|
|
|
5211
5452
|
---
|
|
5212
|
-
|
|
5453
|
+
##### Function: asArray
|
|
5213
5454
|
|
|
5214
5455
|
```ts
|
|
5215
5456
|
export function asArray(val: string | number[]): number[]
|
|
@@ -5218,7 +5459,7 @@ export function asArray(val: string | number[]): number[]
|
|
|
5218
5459
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5219
5460
|
|
|
5220
5461
|
---
|
|
5221
|
-
|
|
5462
|
+
##### Function: asBsvSdkPrivateKey
|
|
5222
5463
|
|
|
5223
5464
|
```ts
|
|
5224
5465
|
export function asBsvSdkPrivateKey(privKey: string): PrivateKey
|
|
@@ -5238,7 +5479,7 @@ Argument Details
|
|
|
5238
5479
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5239
5480
|
|
|
5240
5481
|
---
|
|
5241
|
-
|
|
5482
|
+
##### Function: asBsvSdkPublickKey
|
|
5242
5483
|
|
|
5243
5484
|
```ts
|
|
5244
5485
|
export function asBsvSdkPublickKey(pubKey: string): PublicKey
|
|
@@ -5258,7 +5499,7 @@ Argument Details
|
|
|
5258
5499
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5259
5500
|
|
|
5260
5501
|
---
|
|
5261
|
-
|
|
5502
|
+
##### Function: asBsvSdkScript
|
|
5262
5503
|
|
|
5263
5504
|
Coerce a bsv script encoded as a hex string, serialized array, or Script to Script
|
|
5264
5505
|
If script is already a Script, just return it.
|
|
@@ -5278,7 +5519,7 @@ export function asBsvSdkScript(script: HexString | number[] | Script): Script {
|
|
|
5278
5519
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5279
5520
|
|
|
5280
5521
|
---
|
|
5281
|
-
|
|
5522
|
+
##### Function: asBsvSdkTx
|
|
5282
5523
|
|
|
5283
5524
|
Coerce a bsv transaction encoded as a hex string, serialized array, or Transaction to Transaction
|
|
5284
5525
|
If tx is already a Transaction, just return it.
|
|
@@ -5298,7 +5539,7 @@ export function asBsvSdkTx(tx: HexString | number[] | Transaction): Transaction
|
|
|
5298
5539
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5299
5540
|
|
|
5300
5541
|
---
|
|
5301
|
-
|
|
5542
|
+
##### Function: asString
|
|
5302
5543
|
|
|
5303
5544
|
Coerce a value to a hex encoded string if currently a hex encoded string or number[]
|
|
5304
5545
|
|
|
@@ -5328,7 +5569,7 @@ Argument Details
|
|
|
5328
5569
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5329
5570
|
|
|
5330
5571
|
---
|
|
5331
|
-
|
|
5572
|
+
##### Function: attemptToPostReqsToNetwork
|
|
5332
5573
|
|
|
5333
5574
|
Attempt to post one or more `ProvenTxReq` with status 'unsent'
|
|
5334
5575
|
to the bitcoin network.
|
|
@@ -5342,7 +5583,7 @@ See also: [PostReqsToNetworkResult](#interface-postreqstonetworkresult), [Storag
|
|
|
5342
5583
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5343
5584
|
|
|
5344
5585
|
---
|
|
5345
|
-
|
|
5586
|
+
##### Function: completeSignedTransaction
|
|
5346
5587
|
|
|
5347
5588
|
```ts
|
|
5348
5589
|
export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<Transaction>
|
|
@@ -5353,7 +5594,7 @@ See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wal
|
|
|
5353
5594
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5354
5595
|
|
|
5355
5596
|
---
|
|
5356
|
-
|
|
5597
|
+
##### Function: completeSignedTransaction
|
|
5357
5598
|
|
|
5358
5599
|
```ts
|
|
5359
5600
|
export async function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, SignActionSpend>, wallet: Wallet): Promise<BsvTransaction>
|
|
@@ -5364,7 +5605,7 @@ See also: [PendingSignAction](#interface-pendingsignaction), [Wallet](#class-wal
|
|
|
5364
5605
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5365
5606
|
|
|
5366
5607
|
---
|
|
5367
|
-
|
|
5608
|
+
##### Function: convertProofToMerklePath
|
|
5368
5609
|
|
|
5369
5610
|
```ts
|
|
5370
5611
|
export function convertProofToMerklePath(txid: string, proof: TscMerkleProofApi): MerklePath
|
|
@@ -5375,7 +5616,7 @@ See also: [TscMerkleProofApi](#interface-tscmerkleproofapi)
|
|
|
5375
5616
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5376
5617
|
|
|
5377
5618
|
---
|
|
5378
|
-
|
|
5619
|
+
##### Function: createAction
|
|
5379
5620
|
|
|
5380
5621
|
```ts
|
|
5381
5622
|
export async function createAction(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<sdk.StorageCreateActionResult>
|
|
@@ -5386,7 +5627,7 @@ See also: [AuthId](#interface-authid), [StorageCreateActionResult](#interface-st
|
|
|
5386
5627
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5387
5628
|
|
|
5388
5629
|
---
|
|
5389
|
-
|
|
5630
|
+
##### Function: createAction
|
|
5390
5631
|
|
|
5391
5632
|
```ts
|
|
5392
5633
|
export async function createAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidCreateActionArgs): Promise<CreateActionResult>
|
|
@@ -5397,7 +5638,7 @@ See also: [AuthId](#interface-authid), [ValidCreateActionArgs](#interface-validc
|
|
|
5397
5638
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5398
5639
|
|
|
5399
5640
|
---
|
|
5400
|
-
|
|
5641
|
+
##### Function: createDefaultWalletServicesOptions
|
|
5401
5642
|
|
|
5402
5643
|
```ts
|
|
5403
5644
|
export function createDefaultWalletServicesOptions(chain: sdk.Chain): sdk.WalletServicesOptions
|
|
@@ -5408,7 +5649,7 @@ See also: [Chain](#type-chain), [WalletServicesOptions](#interface-walletservice
|
|
|
5408
5649
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5409
5650
|
|
|
5410
5651
|
---
|
|
5411
|
-
|
|
5652
|
+
##### Function: createStorageServiceChargeScript
|
|
5412
5653
|
|
|
5413
5654
|
```ts
|
|
5414
5655
|
export function createStorageServiceChargeScript(pubKeyHex: PubKeyHex): {
|
|
@@ -5420,7 +5661,7 @@ export function createStorageServiceChargeScript(pubKeyHex: PubKeyHex): {
|
|
|
5420
5661
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5421
5662
|
|
|
5422
5663
|
---
|
|
5423
|
-
|
|
5664
|
+
##### Function: doubleSha256BE
|
|
5424
5665
|
|
|
5425
5666
|
Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
|
|
5426
5667
|
|
|
@@ -5450,7 +5691,7 @@ Argument Details
|
|
|
5450
5691
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5451
5692
|
|
|
5452
5693
|
---
|
|
5453
|
-
|
|
5694
|
+
##### Function: doubleSha256HashLE
|
|
5454
5695
|
|
|
5455
5696
|
Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
|
|
5456
5697
|
|
|
@@ -5480,7 +5721,7 @@ Argument Details
|
|
|
5480
5721
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5481
5722
|
|
|
5482
5723
|
---
|
|
5483
|
-
|
|
5724
|
+
##### Function: generateChangeSdk
|
|
5484
5725
|
|
|
5485
5726
|
Simplifications:
|
|
5486
5727
|
- only support one change type with fixed length scripts.
|
|
@@ -5497,7 +5738,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
|
|
|
5497
5738
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5498
5739
|
|
|
5499
5740
|
---
|
|
5500
|
-
|
|
5741
|
+
##### Function: generateChangeSdkMakeStorage
|
|
5501
5742
|
|
|
5502
5743
|
```ts
|
|
5503
5744
|
export function generateChangeSdkMakeStorage(availableChange: GenerateChangeSdkChangeInput[]): {
|
|
@@ -5512,7 +5753,7 @@ See also: [GenerateChangeSdkChangeInput](#interface-generatechangesdkchangeinput
|
|
|
5512
5753
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5513
5754
|
|
|
5514
5755
|
---
|
|
5515
|
-
|
|
5756
|
+
##### Function: getBeefForTransaction
|
|
5516
5757
|
|
|
5517
5758
|
Creates a `Beef` to support the validity of a transaction identified by its `txid`.
|
|
5518
5759
|
|
|
@@ -5549,7 +5790,7 @@ Argument Details
|
|
|
5549
5790
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5550
5791
|
|
|
5551
5792
|
---
|
|
5552
|
-
|
|
5793
|
+
##### Function: getExchangeRatesIo
|
|
5553
5794
|
|
|
5554
5795
|
```ts
|
|
5555
5796
|
export async function getExchangeRatesIo(key: string): Promise<ExchangeRatesIoApi>
|
|
@@ -5560,7 +5801,7 @@ See also: [ExchangeRatesIoApi](#interface-exchangeratesioapi)
|
|
|
5560
5801
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5561
5802
|
|
|
5562
5803
|
---
|
|
5563
|
-
|
|
5804
|
+
##### Function: getIdentityKey
|
|
5564
5805
|
|
|
5565
5806
|
```ts
|
|
5566
5807
|
export async function getIdentityKey(wallet: CertOpsWallet): Promise<PubKeyHex>
|
|
@@ -5571,7 +5812,7 @@ See also: [CertOpsWallet](#interface-certopswallet)
|
|
|
5571
5812
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5572
5813
|
|
|
5573
5814
|
---
|
|
5574
|
-
|
|
5815
|
+
##### Function: getMerklePathFromTaalARC
|
|
5575
5816
|
|
|
5576
5817
|
```ts
|
|
5577
5818
|
export async function getMerklePathFromTaalARC(txid: string, config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.GetMerklePathResult>
|
|
@@ -5582,7 +5823,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathResult]
|
|
|
5582
5823
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5583
5824
|
|
|
5584
5825
|
---
|
|
5585
|
-
|
|
5826
|
+
##### Function: getMerklePathFromWhatsOnChainTsc
|
|
5586
5827
|
|
|
5587
5828
|
WhatOnChain.com has their own "hash/pos/R/L" proof format and a more TSC compliant proof format.
|
|
5588
5829
|
|
|
@@ -5599,7 +5840,7 @@ See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathre
|
|
|
5599
5840
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5600
5841
|
|
|
5601
5842
|
---
|
|
5602
|
-
|
|
5843
|
+
##### Function: getRawTxFromWhatsOnChain
|
|
5603
5844
|
|
|
5604
5845
|
```ts
|
|
5605
5846
|
export async function getRawTxFromWhatsOnChain(txid: string, chain: sdk.Chain): Promise<sdk.GetRawTxResult>
|
|
@@ -5610,7 +5851,7 @@ See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
|
|
|
5610
5851
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5611
5852
|
|
|
5612
5853
|
---
|
|
5613
|
-
|
|
5854
|
+
##### Function: getSyncChunk
|
|
5614
5855
|
|
|
5615
5856
|
Gets the next sync chunk of updated data from un-remoted storage (could be using a remote DB connection).
|
|
5616
5857
|
|
|
@@ -5623,7 +5864,7 @@ See also: [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReade
|
|
|
5623
5864
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5624
5865
|
|
|
5625
5866
|
---
|
|
5626
|
-
|
|
5867
|
+
##### Function: getTaalArcServiceConfig
|
|
5627
5868
|
|
|
5628
5869
|
```ts
|
|
5629
5870
|
export function getTaalArcServiceConfig(chain: sdk.Chain, apiKey: string): ArcServiceConfig
|
|
@@ -5634,7 +5875,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [Chain](#type-chain)
|
|
|
5634
5875
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5635
5876
|
|
|
5636
5877
|
---
|
|
5637
|
-
|
|
5878
|
+
##### Function: getUtxoStatusFromWhatsOnChain
|
|
5638
5879
|
|
|
5639
5880
|
```ts
|
|
5640
5881
|
export async function getUtxoStatusFromWhatsOnChain(output: string, chain: sdk.Chain, outputFormat?: sdk.GetUtxoStatusOutputFormat): Promise<sdk.GetUtxoStatusResult>
|
|
@@ -5645,7 +5886,7 @@ See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatuso
|
|
|
5645
5886
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5646
5887
|
|
|
5647
5888
|
---
|
|
5648
|
-
|
|
5889
|
+
##### Function: internalizeAction
|
|
5649
5890
|
|
|
5650
5891
|
Internalize Action allows a wallet to take ownership of outputs in a pre-existing transaction.
|
|
5651
5892
|
The transaction may, or may not already be known to both the storage and user.
|
|
@@ -5681,7 +5922,7 @@ See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider)
|
|
|
5681
5922
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5682
5923
|
|
|
5683
5924
|
---
|
|
5684
|
-
|
|
5925
|
+
##### Function: internalizeAction
|
|
5685
5926
|
|
|
5686
5927
|
Internalize Action allows a wallet to take ownership of outputs in a pre-existing transaction.
|
|
5687
5928
|
The transaction may, or may not already be known to both the storage and user.
|
|
@@ -5717,7 +5958,7 @@ See also: [AuthId](#interface-authid), [Wallet](#class-wallet)
|
|
|
5717
5958
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5718
5959
|
|
|
5719
5960
|
---
|
|
5720
|
-
|
|
5961
|
+
##### Function: isHexString
|
|
5721
5962
|
|
|
5722
5963
|
```ts
|
|
5723
5964
|
export function isHexString(s: string): boolean
|
|
@@ -5726,7 +5967,7 @@ export function isHexString(s: string): boolean
|
|
|
5726
5967
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5727
5968
|
|
|
5728
5969
|
---
|
|
5729
|
-
|
|
5970
|
+
##### Function: listCertificates
|
|
5730
5971
|
|
|
5731
5972
|
```ts
|
|
5732
5973
|
export async function listCertificates(storage: StorageProvider, auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListCertificatesResult>
|
|
@@ -5737,7 +5978,7 @@ See also: [AuthId](#interface-authid), [StorageProvider](#class-storageprovider)
|
|
|
5737
5978
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5738
5979
|
|
|
5739
5980
|
---
|
|
5740
|
-
|
|
5981
|
+
##### Function: lockScriptWithKeyOffsetFromPubKey
|
|
5741
5982
|
|
|
5742
5983
|
```ts
|
|
5743
5984
|
export function lockScriptWithKeyOffsetFromPubKey(pubKey: string, keyOffset?: string): {
|
|
@@ -5749,7 +5990,7 @@ export function lockScriptWithKeyOffsetFromPubKey(pubKey: string, keyOffset?: st
|
|
|
5749
5990
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5750
5991
|
|
|
5751
5992
|
---
|
|
5752
|
-
|
|
5993
|
+
##### Function: makeAtomicBeef
|
|
5753
5994
|
|
|
5754
5995
|
```ts
|
|
5755
5996
|
export function makeAtomicBeef(tx: Transaction, beef: number[] | Beef): number[]
|
|
@@ -5758,7 +5999,7 @@ export function makeAtomicBeef(tx: Transaction, beef: number[] | Beef): number[]
|
|
|
5758
5999
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5759
6000
|
|
|
5760
6001
|
---
|
|
5761
|
-
|
|
6002
|
+
##### Function: makeAtomicBeef
|
|
5762
6003
|
|
|
5763
6004
|
```ts
|
|
5764
6005
|
export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): number[]
|
|
@@ -5767,7 +6008,7 @@ export function makeAtomicBeef(tx: BsvTransaction, beef: number[] | Beef): numbe
|
|
|
5767
6008
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5768
6009
|
|
|
5769
6010
|
---
|
|
5770
|
-
|
|
6011
|
+
##### Function: makeErrorResult
|
|
5771
6012
|
|
|
5772
6013
|
```ts
|
|
5773
6014
|
export function makeErrorResult(error: sdk.WalletError, miner: ArcServiceConfig, beef: number[], txids: string[], dd?: ArcMinerPostBeefDataApi): sdk.PostBeefResult
|
|
@@ -5778,7 +6019,7 @@ See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcSer
|
|
|
5778
6019
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5779
6020
|
|
|
5780
6021
|
---
|
|
5781
|
-
|
|
6022
|
+
##### Function: makeGetMerklePathFromTaalARC
|
|
5782
6023
|
|
|
5783
6024
|
```ts
|
|
5784
6025
|
export function makeGetMerklePathFromTaalARC(config: ArcServiceConfig): sdk.GetMerklePathService
|
|
@@ -5789,7 +6030,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [GetMerklePathService
|
|
|
5789
6030
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5790
6031
|
|
|
5791
6032
|
---
|
|
5792
|
-
|
|
6033
|
+
##### Function: makePostBeefResult
|
|
5793
6034
|
|
|
5794
6035
|
```ts
|
|
5795
6036
|
export function makePostBeefResult(dd: ArcMinerPostBeefDataApi, miner: ArcServiceConfig, beef: number[], txids: string[]): sdk.PostBeefResult
|
|
@@ -5800,7 +6041,7 @@ See also: [ArcMinerPostBeefDataApi](#interface-arcminerpostbeefdataapi), [ArcSer
|
|
|
5800
6041
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5801
6042
|
|
|
5802
6043
|
---
|
|
5803
|
-
|
|
6044
|
+
##### Function: makePostBeefToTaalARC
|
|
5804
6045
|
|
|
5805
6046
|
```ts
|
|
5806
6047
|
export function makePostBeefToTaalARC(config: ArcServiceConfig): sdk.PostBeefService
|
|
@@ -5811,7 +6052,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefService](#ty
|
|
|
5811
6052
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5812
6053
|
|
|
5813
6054
|
---
|
|
5814
|
-
|
|
6055
|
+
##### Function: makePostTxsToTaalARC
|
|
5815
6056
|
|
|
5816
6057
|
```ts
|
|
5817
6058
|
export function makePostTxsToTaalARC(config: ArcServiceConfig): sdk.PostTxsService
|
|
@@ -5822,7 +6063,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsService](#typ
|
|
|
5822
6063
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5823
6064
|
|
|
5824
6065
|
---
|
|
5825
|
-
|
|
6066
|
+
##### Function: maxDate
|
|
5826
6067
|
|
|
5827
6068
|
```ts
|
|
5828
6069
|
export function maxDate(d1?: Date, d2?: Date): Date | undefined
|
|
@@ -5831,7 +6072,7 @@ export function maxDate(d1?: Date, d2?: Date): Date | undefined
|
|
|
5831
6072
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5832
6073
|
|
|
5833
6074
|
---
|
|
5834
|
-
|
|
6075
|
+
##### Function: offsetPubKey
|
|
5835
6076
|
|
|
5836
6077
|
```ts
|
|
5837
6078
|
export function offsetPubKey(pubKey: string, keyOffset?: string): {
|
|
@@ -5843,7 +6084,7 @@ export function offsetPubKey(pubKey: string, keyOffset?: string): {
|
|
|
5843
6084
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5844
6085
|
|
|
5845
6086
|
---
|
|
5846
|
-
|
|
6087
|
+
##### Function: optionalArraysEqual
|
|
5847
6088
|
|
|
5848
6089
|
```ts
|
|
5849
6090
|
export function optionalArraysEqual(arr1?: Number[], arr2?: Number[])
|
|
@@ -5852,7 +6093,7 @@ export function optionalArraysEqual(arr1?: Number[], arr2?: Number[])
|
|
|
5852
6093
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5853
6094
|
|
|
5854
6095
|
---
|
|
5855
|
-
|
|
6096
|
+
##### Function: parseTxScriptOffsets
|
|
5856
6097
|
|
|
5857
6098
|
```ts
|
|
5858
6099
|
export function parseTxScriptOffsets(rawTx: number[]): TxScriptOffsets
|
|
@@ -5863,7 +6104,7 @@ See also: [TxScriptOffsets](#interface-txscriptoffsets)
|
|
|
5863
6104
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5864
6105
|
|
|
5865
6106
|
---
|
|
5866
|
-
|
|
6107
|
+
##### Function: parseWalletOutpoint
|
|
5867
6108
|
|
|
5868
6109
|
```ts
|
|
5869
6110
|
export function parseWalletOutpoint(outpoint: string): {
|
|
@@ -5875,7 +6116,7 @@ export function parseWalletOutpoint(outpoint: string): {
|
|
|
5875
6116
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5876
6117
|
|
|
5877
6118
|
---
|
|
5878
|
-
|
|
6119
|
+
##### Function: postBeefToArcMiner
|
|
5879
6120
|
|
|
5880
6121
|
```ts
|
|
5881
6122
|
export async function postBeefToArcMiner(beef: Beef | number[], txids: string[], config: ArcServiceConfig): Promise<sdk.PostBeefResult>
|
|
@@ -5886,7 +6127,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#int
|
|
|
5886
6127
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5887
6128
|
|
|
5888
6129
|
---
|
|
5889
|
-
|
|
6130
|
+
##### Function: postBeefToTaalArcMiner
|
|
5890
6131
|
|
|
5891
6132
|
```ts
|
|
5892
6133
|
export async function postBeefToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostBeefResult>
|
|
@@ -5897,7 +6138,7 @@ See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostBeefResult](#int
|
|
|
5897
6138
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5898
6139
|
|
|
5899
6140
|
---
|
|
5900
|
-
|
|
6141
|
+
##### Function: postTxsToTaalArcMiner
|
|
5901
6142
|
|
|
5902
6143
|
```ts
|
|
5903
6144
|
export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config: ArcServiceConfig, services: sdk.WalletServices): Promise<sdk.PostTxsResult>
|
|
@@ -5919,7 +6160,7 @@ Argument Details
|
|
|
5919
6160
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5920
6161
|
|
|
5921
6162
|
---
|
|
5922
|
-
|
|
6163
|
+
##### Function: processAction
|
|
5923
6164
|
|
|
5924
6165
|
```ts
|
|
5925
6166
|
export async function processAction(storage: StorageProvider, auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>
|
|
@@ -5930,7 +6171,7 @@ See also: [AuthId](#interface-authid), [StorageProcessActionArgs](#interface-sto
|
|
|
5930
6171
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5931
6172
|
|
|
5932
6173
|
---
|
|
5933
|
-
|
|
6174
|
+
##### Function: processAction
|
|
5934
6175
|
|
|
5935
6176
|
```ts
|
|
5936
6177
|
export async function processAction(prior: PendingSignAction | undefined, wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProcessActionArgs): Promise<SendWithResult[] | undefined>
|
|
@@ -5941,7 +6182,7 @@ See also: [AuthId](#interface-authid), [PendingSignAction](#interface-pendingsig
|
|
|
5941
6182
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5942
6183
|
|
|
5943
6184
|
---
|
|
5944
|
-
|
|
6185
|
+
##### Function: proveCertificate
|
|
5945
6186
|
|
|
5946
6187
|
```ts
|
|
5947
6188
|
export async function proveCertificate(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidProveCertificateArgs): Promise<ProveCertificateResult>
|
|
@@ -5952,7 +6193,7 @@ See also: [AuthId](#interface-authid), [ValidProveCertificateArgs](#interface-va
|
|
|
5952
6193
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5953
6194
|
|
|
5954
6195
|
---
|
|
5955
|
-
|
|
6196
|
+
##### Function: randomBytes
|
|
5956
6197
|
|
|
5957
6198
|
```ts
|
|
5958
6199
|
export function randomBytes(count: number): number[]
|
|
@@ -5971,7 +6212,7 @@ count cryptographically secure random bytes as array of bytes
|
|
|
5971
6212
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5972
6213
|
|
|
5973
6214
|
---
|
|
5974
|
-
|
|
6215
|
+
##### Function: randomBytesBase64
|
|
5975
6216
|
|
|
5976
6217
|
```ts
|
|
5977
6218
|
export function randomBytesBase64(count: number): string
|
|
@@ -5990,7 +6231,7 @@ count cryptographically secure random bytes as base64 encoded string
|
|
|
5990
6231
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5991
6232
|
|
|
5992
6233
|
---
|
|
5993
|
-
|
|
6234
|
+
##### Function: randomBytesHex
|
|
5994
6235
|
|
|
5995
6236
|
```ts
|
|
5996
6237
|
export function randomBytesHex(count: number): string
|
|
@@ -6009,7 +6250,7 @@ count cryptographically secure random bytes as hex encoded string
|
|
|
6009
6250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6010
6251
|
|
|
6011
6252
|
---
|
|
6012
|
-
|
|
6253
|
+
##### Function: sha256Hash
|
|
6013
6254
|
|
|
6014
6255
|
Calculate the SHA256 hash of an array of bytes
|
|
6015
6256
|
|
|
@@ -6033,7 +6274,7 @@ sha256 hash of buffer contents.
|
|
|
6033
6274
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6034
6275
|
|
|
6035
6276
|
---
|
|
6036
|
-
|
|
6277
|
+
##### Function: signAction
|
|
6037
6278
|
|
|
6038
6279
|
```ts
|
|
6039
6280
|
export async function signAction(wallet: Wallet, auth: sdk.AuthId, vargs: sdk.ValidSignActionArgs): Promise<SignActionResult>
|
|
@@ -6044,7 +6285,7 @@ See also: [AuthId](#interface-authid), [ValidSignActionArgs](#interface-validsig
|
|
|
6044
6285
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6045
6286
|
|
|
6046
6287
|
---
|
|
6047
|
-
|
|
6288
|
+
##### Function: stampLog
|
|
6048
6289
|
|
|
6049
6290
|
If a log is being kept, add a time stamped line.
|
|
6050
6291
|
|
|
@@ -6074,7 +6315,7 @@ Argument Details
|
|
|
6074
6315
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6075
6316
|
|
|
6076
6317
|
---
|
|
6077
|
-
|
|
6318
|
+
##### Function: stampLogFormat
|
|
6078
6319
|
|
|
6079
6320
|
Replaces individual timestamps with delta msecs.
|
|
6080
6321
|
Looks for two network crossings and adjusts clock for clock skew if found.
|
|
@@ -6102,7 +6343,7 @@ Argument Details
|
|
|
6102
6343
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6103
6344
|
|
|
6104
6345
|
---
|
|
6105
|
-
|
|
6346
|
+
##### Function: toBinaryBaseBlockHeader
|
|
6106
6347
|
|
|
6107
6348
|
Serializes a block header as an 80 byte array.
|
|
6108
6349
|
The exact serialized format is defined in the Bitcoin White Paper
|
|
@@ -6138,7 +6379,7 @@ Returns
|
|
|
6138
6379
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6139
6380
|
|
|
6140
6381
|
---
|
|
6141
|
-
|
|
6382
|
+
##### Function: toWalletNetwork
|
|
6142
6383
|
|
|
6143
6384
|
```ts
|
|
6144
6385
|
export function toWalletNetwork(chain: Chain): WalletNetwork
|
|
@@ -6149,7 +6390,7 @@ See also: [Chain](#type-chain)
|
|
|
6149
6390
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6150
6391
|
|
|
6151
6392
|
---
|
|
6152
|
-
|
|
6393
|
+
##### Function: transactionInputSize
|
|
6153
6394
|
|
|
6154
6395
|
```ts
|
|
6155
6396
|
export function transactionInputSize(scriptSize: number): number
|
|
@@ -6173,7 +6414,7 @@ Argument Details
|
|
|
6173
6414
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6174
6415
|
|
|
6175
6416
|
---
|
|
6176
|
-
|
|
6417
|
+
##### Function: transactionOutputSize
|
|
6177
6418
|
|
|
6178
6419
|
```ts
|
|
6179
6420
|
export function transactionOutputSize(scriptSize: number): number
|
|
@@ -6197,7 +6438,7 @@ Argument Details
|
|
|
6197
6438
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6198
6439
|
|
|
6199
6440
|
---
|
|
6200
|
-
|
|
6441
|
+
##### Function: transactionSize
|
|
6201
6442
|
|
|
6202
6443
|
Compute the serialized binary transaction size in bytes
|
|
6203
6444
|
given the number of inputs and outputs,
|
|
@@ -6227,7 +6468,7 @@ Argument Details
|
|
|
6227
6468
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6228
6469
|
|
|
6229
6470
|
---
|
|
6230
|
-
|
|
6471
|
+
##### Function: updateBsvExchangeRate
|
|
6231
6472
|
|
|
6232
6473
|
```ts
|
|
6233
6474
|
export async function updateBsvExchangeRate(rate?: sdk.BsvExchangeRate, updateMsecs?: number): Promise<sdk.BsvExchangeRate>
|
|
@@ -6238,7 +6479,7 @@ See also: [BsvExchangeRate](#interface-bsvexchangerate)
|
|
|
6238
6479
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6239
6480
|
|
|
6240
6481
|
---
|
|
6241
|
-
|
|
6482
|
+
##### Function: updateChaintracksFiatExchangeRates
|
|
6242
6483
|
|
|
6243
6484
|
```ts
|
|
6244
6485
|
export async function updateChaintracksFiatExchangeRates(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
@@ -6249,7 +6490,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
|
|
|
6249
6490
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6250
6491
|
|
|
6251
6492
|
---
|
|
6252
|
-
|
|
6493
|
+
##### Function: updateExchangeratesapi
|
|
6253
6494
|
|
|
6254
6495
|
```ts
|
|
6255
6496
|
export async function updateExchangeratesapi(targetCurrencies: string[], options: sdk.WalletServicesOptions): Promise<sdk.FiatExchangeRates>
|
|
@@ -6260,7 +6501,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
|
|
|
6260
6501
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6261
6502
|
|
|
6262
6503
|
---
|
|
6263
|
-
|
|
6504
|
+
##### Function: validateAbortActionArgs
|
|
6264
6505
|
|
|
6265
6506
|
```ts
|
|
6266
6507
|
export function validateAbortActionArgs(args: AbortActionArgs): ValidAbortActionArgs
|
|
@@ -6271,7 +6512,7 @@ See also: [ValidAbortActionArgs](#interface-validabortactionargs)
|
|
|
6271
6512
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6272
6513
|
|
|
6273
6514
|
---
|
|
6274
|
-
|
|
6515
|
+
##### Function: validateAcquireCertificateArgs
|
|
6275
6516
|
|
|
6276
6517
|
```ts
|
|
6277
6518
|
export async function validateAcquireCertificateArgs(args: AcquireCertificateArgs): Promise<ValidAcquireCertificateArgs>
|
|
@@ -6293,7 +6534,7 @@ Argument Details
|
|
|
6293
6534
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6294
6535
|
|
|
6295
6536
|
---
|
|
6296
|
-
|
|
6537
|
+
##### Function: validateAcquireDirectCertificateArgs
|
|
6297
6538
|
|
|
6298
6539
|
```ts
|
|
6299
6540
|
export function validateAcquireDirectCertificateArgs(args: AcquireCertificateArgs): ValidAcquireDirectCertificateArgs
|
|
@@ -6304,7 +6545,7 @@ See also: [ValidAcquireDirectCertificateArgs](#interface-validacquiredirectcerti
|
|
|
6304
6545
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6305
6546
|
|
|
6306
6547
|
---
|
|
6307
|
-
|
|
6548
|
+
##### Function: validateAcquireIssuanceCertificateArgs
|
|
6308
6549
|
|
|
6309
6550
|
```ts
|
|
6310
6551
|
export function validateAcquireIssuanceCertificateArgs(args: AcquireCertificateArgs): ValidAcquireIssuanceCertificateArgs
|
|
@@ -6315,7 +6556,7 @@ See also: [ValidAcquireIssuanceCertificateArgs](#interface-validacquireissuancec
|
|
|
6315
6556
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6316
6557
|
|
|
6317
6558
|
---
|
|
6318
|
-
|
|
6559
|
+
##### Function: validateBasketInsertion
|
|
6319
6560
|
|
|
6320
6561
|
```ts
|
|
6321
6562
|
export function validateBasketInsertion(args?: BasketInsertion): ValidBasketInsertion | undefined
|
|
@@ -6326,7 +6567,7 @@ See also: [ValidBasketInsertion](#interface-validbasketinsertion)
|
|
|
6326
6567
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6327
6568
|
|
|
6328
6569
|
---
|
|
6329
|
-
|
|
6570
|
+
##### Function: validateCreateActionArgs
|
|
6330
6571
|
|
|
6331
6572
|
```ts
|
|
6332
6573
|
export function validateCreateActionArgs(args: CreateActionArgs): ValidCreateActionArgs
|
|
@@ -6337,7 +6578,7 @@ See also: [ValidCreateActionArgs](#interface-validcreateactionargs)
|
|
|
6337
6578
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6338
6579
|
|
|
6339
6580
|
---
|
|
6340
|
-
|
|
6581
|
+
##### Function: validateCreateActionInput
|
|
6341
6582
|
|
|
6342
6583
|
```ts
|
|
6343
6584
|
export function validateCreateActionInput(i: CreateActionInput): ValidCreateActionInput
|
|
@@ -6348,7 +6589,7 @@ See also: [ValidCreateActionInput](#interface-validcreateactioninput)
|
|
|
6348
6589
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6349
6590
|
|
|
6350
6591
|
---
|
|
6351
|
-
|
|
6592
|
+
##### Function: validateCreateActionOptions
|
|
6352
6593
|
|
|
6353
6594
|
Set all default true/false booleans to true or false if undefined.
|
|
6354
6595
|
Set all possibly undefined numbers to their default values.
|
|
@@ -6364,7 +6605,7 @@ See also: [ValidCreateActionOptions](#interface-validcreateactionoptions)
|
|
|
6364
6605
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6365
6606
|
|
|
6366
6607
|
---
|
|
6367
|
-
|
|
6608
|
+
##### Function: validateCreateActionOutput
|
|
6368
6609
|
|
|
6369
6610
|
```ts
|
|
6370
6611
|
export function validateCreateActionOutput(o: CreateActionOutput): ValidCreateActionOutput
|
|
@@ -6375,7 +6616,7 @@ See also: [ValidCreateActionOutput](#interface-validcreateactionoutput)
|
|
|
6375
6616
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6376
6617
|
|
|
6377
6618
|
---
|
|
6378
|
-
|
|
6619
|
+
##### Function: validateDiscoverByAttributesArgs
|
|
6379
6620
|
|
|
6380
6621
|
```ts
|
|
6381
6622
|
export function validateDiscoverByAttributesArgs(args: DiscoverByAttributesArgs): ValidDiscoverByAttributesArgs
|
|
@@ -6386,7 +6627,7 @@ See also: [ValidDiscoverByAttributesArgs](#interface-validdiscoverbyattributesar
|
|
|
6386
6627
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6387
6628
|
|
|
6388
6629
|
---
|
|
6389
|
-
|
|
6630
|
+
##### Function: validateDiscoverByIdentityKeyArgs
|
|
6390
6631
|
|
|
6391
6632
|
```ts
|
|
6392
6633
|
export function validateDiscoverByIdentityKeyArgs(args: DiscoverByIdentityKeyArgs): ValidDiscoverByIdentityKeyArgs
|
|
@@ -6397,7 +6638,7 @@ See also: [ValidDiscoverByIdentityKeyArgs](#interface-validdiscoverbyidentitykey
|
|
|
6397
6638
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6398
6639
|
|
|
6399
6640
|
---
|
|
6400
|
-
|
|
6641
|
+
##### Function: validateGenerateChangeSdkParams
|
|
6401
6642
|
|
|
6402
6643
|
```ts
|
|
6403
6644
|
export function validateGenerateChangeSdkParams(params: GenerateChangeSdkParams)
|
|
@@ -6408,7 +6649,7 @@ See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams)
|
|
|
6408
6649
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6409
6650
|
|
|
6410
6651
|
---
|
|
6411
|
-
|
|
6652
|
+
##### Function: validateGenerateChangeSdkResult
|
|
6412
6653
|
|
|
6413
6654
|
```ts
|
|
6414
6655
|
export function validateGenerateChangeSdkResult(params: GenerateChangeSdkParams, r: GenerateChangeSdkResult): {
|
|
@@ -6422,7 +6663,7 @@ See also: [GenerateChangeSdkParams](#interface-generatechangesdkparams), [Genera
|
|
|
6422
6663
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6423
6664
|
|
|
6424
6665
|
---
|
|
6425
|
-
|
|
6666
|
+
##### Function: validateInteger
|
|
6426
6667
|
|
|
6427
6668
|
```ts
|
|
6428
6669
|
export function validateInteger(v: number | undefined, name: string, defaultValue?: number, min?: number, max?: number): number
|
|
@@ -6431,7 +6672,7 @@ export function validateInteger(v: number | undefined, name: string, defaultValu
|
|
|
6431
6672
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6432
6673
|
|
|
6433
6674
|
---
|
|
6434
|
-
|
|
6675
|
+
##### Function: validateInternalizeActionArgs
|
|
6435
6676
|
|
|
6436
6677
|
```ts
|
|
6437
6678
|
export function validateInternalizeActionArgs(args: InternalizeActionArgs): ValidInternalizeActionArgs
|
|
@@ -6442,7 +6683,7 @@ See also: [ValidInternalizeActionArgs](#interface-validinternalizeactionargs)
|
|
|
6442
6683
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6443
6684
|
|
|
6444
6685
|
---
|
|
6445
|
-
|
|
6686
|
+
##### Function: validateInternalizeOutput
|
|
6446
6687
|
|
|
6447
6688
|
```ts
|
|
6448
6689
|
export function validateInternalizeOutput(args: InternalizeOutput): ValidInternalizeOutput
|
|
@@ -6453,7 +6694,7 @@ See also: [ValidInternalizeOutput](#interface-validinternalizeoutput)
|
|
|
6453
6694
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6454
6695
|
|
|
6455
6696
|
---
|
|
6456
|
-
|
|
6697
|
+
##### Function: validateListActionsArgs
|
|
6457
6698
|
|
|
6458
6699
|
```ts
|
|
6459
6700
|
export function validateListActionsArgs(args: ListActionsArgs): ValidListActionsArgs
|
|
@@ -6495,7 +6736,7 @@ Argument Details
|
|
|
6495
6736
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6496
6737
|
|
|
6497
6738
|
---
|
|
6498
|
-
|
|
6739
|
+
##### Function: validateListCertificatesArgs
|
|
6499
6740
|
|
|
6500
6741
|
```ts
|
|
6501
6742
|
export function validateListCertificatesArgs(args: ListCertificatesArgs): ValidListCertificatesArgs
|
|
@@ -6506,7 +6747,7 @@ See also: [ValidListCertificatesArgs](#interface-validlistcertificatesargs)
|
|
|
6506
6747
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6507
6748
|
|
|
6508
6749
|
---
|
|
6509
|
-
|
|
6750
|
+
##### Function: validateListOutputsArgs
|
|
6510
6751
|
|
|
6511
6752
|
```ts
|
|
6512
6753
|
export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputsArgs
|
|
@@ -6548,7 +6789,7 @@ Argument Details
|
|
|
6548
6789
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6549
6790
|
|
|
6550
6791
|
---
|
|
6551
|
-
|
|
6792
|
+
##### Function: validateOptionalInteger
|
|
6552
6793
|
|
|
6553
6794
|
```ts
|
|
6554
6795
|
export function validateOptionalInteger(v: number | undefined, name: string, min?: number, max?: number): number | undefined
|
|
@@ -6557,7 +6798,7 @@ export function validateOptionalInteger(v: number | undefined, name: string, min
|
|
|
6557
6798
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6558
6799
|
|
|
6559
6800
|
---
|
|
6560
|
-
|
|
6801
|
+
##### Function: validateOptionalOutpointString
|
|
6561
6802
|
|
|
6562
6803
|
```ts
|
|
6563
6804
|
export function validateOptionalOutpointString(outpoint: string | undefined, name: string): string | undefined
|
|
@@ -6566,7 +6807,7 @@ export function validateOptionalOutpointString(outpoint: string | undefined, nam
|
|
|
6566
6807
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6567
6808
|
|
|
6568
6809
|
---
|
|
6569
|
-
|
|
6810
|
+
##### Function: validateOriginator
|
|
6570
6811
|
|
|
6571
6812
|
```ts
|
|
6572
6813
|
export function validateOriginator(s?: string): string | undefined
|
|
@@ -6575,7 +6816,7 @@ export function validateOriginator(s?: string): string | undefined
|
|
|
6575
6816
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6576
6817
|
|
|
6577
6818
|
---
|
|
6578
|
-
|
|
6819
|
+
##### Function: validateOutpointString
|
|
6579
6820
|
|
|
6580
6821
|
```ts
|
|
6581
6822
|
export function validateOutpointString(outpoint: string, name: string): string
|
|
@@ -6584,7 +6825,7 @@ export function validateOutpointString(outpoint: string, name: string): string
|
|
|
6584
6825
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6585
6826
|
|
|
6586
6827
|
---
|
|
6587
|
-
|
|
6828
|
+
##### Function: validatePositiveIntegerOrZero
|
|
6588
6829
|
|
|
6589
6830
|
```ts
|
|
6590
6831
|
export function validatePositiveIntegerOrZero(v: number, name: string): number
|
|
@@ -6593,7 +6834,7 @@ export function validatePositiveIntegerOrZero(v: number, name: string): number
|
|
|
6593
6834
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6594
6835
|
|
|
6595
6836
|
---
|
|
6596
|
-
|
|
6837
|
+
##### Function: validateProveCertificateArgs
|
|
6597
6838
|
|
|
6598
6839
|
```ts
|
|
6599
6840
|
export function validateProveCertificateArgs(args: ProveCertificateArgs): ValidProveCertificateArgs
|
|
@@ -6604,7 +6845,7 @@ See also: [ValidProveCertificateArgs](#interface-validprovecertificateargs)
|
|
|
6604
6845
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6605
6846
|
|
|
6606
6847
|
---
|
|
6607
|
-
|
|
6848
|
+
##### Function: validateRelinquishCertificateArgs
|
|
6608
6849
|
|
|
6609
6850
|
```ts
|
|
6610
6851
|
export function validateRelinquishCertificateArgs(args: RelinquishCertificateArgs): ValidRelinquishCertificateArgs
|
|
@@ -6615,7 +6856,7 @@ See also: [ValidRelinquishCertificateArgs](#interface-validrelinquishcertificate
|
|
|
6615
6856
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6616
6857
|
|
|
6617
6858
|
---
|
|
6618
|
-
|
|
6859
|
+
##### Function: validateRelinquishOutputArgs
|
|
6619
6860
|
|
|
6620
6861
|
```ts
|
|
6621
6862
|
export function validateRelinquishOutputArgs(args: RelinquishOutputArgs): ValidRelinquishOutputArgs
|
|
@@ -6626,7 +6867,7 @@ See also: [ValidRelinquishOutputArgs](#interface-validrelinquishoutputargs)
|
|
|
6626
6867
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6627
6868
|
|
|
6628
6869
|
---
|
|
6629
|
-
|
|
6870
|
+
##### Function: validateSatoshis
|
|
6630
6871
|
|
|
6631
6872
|
```ts
|
|
6632
6873
|
export function validateSatoshis(v: number | undefined, name: string, min?: number): number
|
|
@@ -6635,7 +6876,7 @@ export function validateSatoshis(v: number | undefined, name: string, min?: numb
|
|
|
6635
6876
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6636
6877
|
|
|
6637
6878
|
---
|
|
6638
|
-
|
|
6879
|
+
##### Function: validateScriptHash
|
|
6639
6880
|
|
|
6640
6881
|
```ts
|
|
6641
6882
|
export function validateScriptHash(output: string, outputFormat?: sdk.GetUtxoStatusOutputFormat): string
|
|
@@ -6646,7 +6887,7 @@ See also: [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat)
|
|
|
6646
6887
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6647
6888
|
|
|
6648
6889
|
---
|
|
6649
|
-
|
|
6890
|
+
##### Function: validateSecondsSinceEpoch
|
|
6650
6891
|
|
|
6651
6892
|
```ts
|
|
6652
6893
|
export function validateSecondsSinceEpoch(time: number): Date
|
|
@@ -6655,7 +6896,7 @@ export function validateSecondsSinceEpoch(time: number): Date
|
|
|
6655
6896
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6656
6897
|
|
|
6657
6898
|
---
|
|
6658
|
-
|
|
6899
|
+
##### Function: validateSignActionArgs
|
|
6659
6900
|
|
|
6660
6901
|
```ts
|
|
6661
6902
|
export function validateSignActionArgs(args: SignActionArgs): ValidSignActionArgs
|
|
@@ -6666,7 +6907,7 @@ See also: [ValidSignActionArgs](#interface-validsignactionargs)
|
|
|
6666
6907
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6667
6908
|
|
|
6668
6909
|
---
|
|
6669
|
-
|
|
6910
|
+
##### Function: validateSignActionOptions
|
|
6670
6911
|
|
|
6671
6912
|
Set all default true/false booleans to true or false if undefined.
|
|
6672
6913
|
Set all possibly undefined numbers to their default values.
|
|
@@ -6682,7 +6923,7 @@ See also: [ValidSignActionOptions](#interface-validsignactionoptions)
|
|
|
6682
6923
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6683
6924
|
|
|
6684
6925
|
---
|
|
6685
|
-
|
|
6926
|
+
##### Function: validateStorageFeeModel
|
|
6686
6927
|
|
|
6687
6928
|
```ts
|
|
6688
6929
|
export function validateStorageFeeModel(v?: sdk.StorageFeeModel): sdk.StorageFeeModel
|
|
@@ -6693,7 +6934,7 @@ See also: [StorageFeeModel](#interface-storagefeemodel)
|
|
|
6693
6934
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6694
6935
|
|
|
6695
6936
|
---
|
|
6696
|
-
|
|
6937
|
+
##### Function: validateStringLength
|
|
6697
6938
|
|
|
6698
6939
|
```ts
|
|
6699
6940
|
export function validateStringLength(s: string, name: string, min?: number, max?: number): string
|
|
@@ -6702,7 +6943,7 @@ export function validateStringLength(s: string, name: string, min?: number, max?
|
|
|
6702
6943
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6703
6944
|
|
|
6704
6945
|
---
|
|
6705
|
-
|
|
6946
|
+
##### Function: validateWalletPayment
|
|
6706
6947
|
|
|
6707
6948
|
```ts
|
|
6708
6949
|
export function validateWalletPayment(args?: WalletPayment): ValidWalletPayment | undefined
|
|
@@ -6713,7 +6954,7 @@ See also: [ValidWalletPayment](#interface-validwalletpayment)
|
|
|
6713
6954
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6714
6955
|
|
|
6715
6956
|
---
|
|
6716
|
-
|
|
6957
|
+
##### Function: varUintSize
|
|
6717
6958
|
|
|
6718
6959
|
Returns the byte size required to encode number as Bitcoin VarUint
|
|
6719
6960
|
|
|
@@ -6730,7 +6971,7 @@ See also: [WERR_INVALID_PARAMETER](#class-werr_invalid_parameter)
|
|
|
6730
6971
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6731
6972
|
|
|
6732
6973
|
---
|
|
6733
|
-
|
|
6974
|
+
##### Function: verifyHexString
|
|
6734
6975
|
|
|
6735
6976
|
Helper function.
|
|
6736
6977
|
|
|
@@ -6743,7 +6984,7 @@ export function verifyHexString(v: string): string
|
|
|
6743
6984
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6744
6985
|
|
|
6745
6986
|
---
|
|
6746
|
-
|
|
6987
|
+
##### Function: verifyId
|
|
6747
6988
|
|
|
6748
6989
|
Helper function.
|
|
6749
6990
|
|
|
@@ -6756,7 +6997,7 @@ export function verifyId(id: number | undefined | null): number
|
|
|
6756
6997
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6757
6998
|
|
|
6758
6999
|
---
|
|
6759
|
-
|
|
7000
|
+
##### Function: verifyInteger
|
|
6760
7001
|
|
|
6761
7002
|
Helper function.
|
|
6762
7003
|
|
|
@@ -6769,7 +7010,7 @@ export function verifyInteger(v: number | null | undefined): number
|
|
|
6769
7010
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6770
7011
|
|
|
6771
7012
|
---
|
|
6772
|
-
|
|
7013
|
+
##### Function: verifyNumber
|
|
6773
7014
|
|
|
6774
7015
|
Helper function.
|
|
6775
7016
|
|
|
@@ -6782,7 +7023,7 @@ export function verifyNumber(v: number | null | undefined): number
|
|
|
6782
7023
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6783
7024
|
|
|
6784
7025
|
---
|
|
6785
|
-
|
|
7026
|
+
##### Function: verifyOne
|
|
6786
7027
|
|
|
6787
7028
|
Helper function.
|
|
6788
7029
|
|
|
@@ -6807,7 +7048,7 @@ WERR_BAD_REQUEST if results has length other than one.
|
|
|
6807
7048
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6808
7049
|
|
|
6809
7050
|
---
|
|
6810
|
-
|
|
7051
|
+
##### Function: verifyOneOrNone
|
|
6811
7052
|
|
|
6812
7053
|
Helper function.
|
|
6813
7054
|
|
|
@@ -6832,7 +7073,7 @@ WERR_BAD_REQUEST if results has length greater than one.
|
|
|
6832
7073
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6833
7074
|
|
|
6834
7075
|
---
|
|
6835
|
-
|
|
7076
|
+
##### Function: verifyOptionalHexString
|
|
6836
7077
|
|
|
6837
7078
|
Helper function.
|
|
6838
7079
|
|
|
@@ -6845,7 +7086,7 @@ export function verifyOptionalHexString(v?: string | null): string | undefined
|
|
|
6845
7086
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6846
7087
|
|
|
6847
7088
|
---
|
|
6848
|
-
|
|
7089
|
+
##### Function: verifyTruthy
|
|
6849
7090
|
|
|
6850
7091
|
Helper function.
|
|
6851
7092
|
|
|
@@ -6858,7 +7099,7 @@ export function verifyTruthy<T>(v: T | null | undefined, description?: string):
|
|
|
6858
7099
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6859
7100
|
|
|
6860
7101
|
---
|
|
6861
|
-
|
|
7102
|
+
##### Function: wait
|
|
6862
7103
|
|
|
6863
7104
|
Returns an await'able Promise that resolves in the given number of msecs.
|
|
6864
7105
|
|
|
@@ -6871,7 +7112,7 @@ export function wait(msecs: number): Promise<void> {
|
|
|
6871
7112
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6872
7113
|
|
|
6873
7114
|
---
|
|
6874
|
-
|
|
7115
|
+
#### Types
|
|
6875
7116
|
|
|
6876
7117
|
| | |
|
|
6877
7118
|
| --- | --- |
|
|
@@ -6889,7 +7130,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6889
7130
|
|
|
6890
7131
|
---
|
|
6891
7132
|
|
|
6892
|
-
|
|
7133
|
+
##### Type: Chain
|
|
6893
7134
|
|
|
6894
7135
|
```ts
|
|
6895
7136
|
export type Chain = "main" | "test"
|
|
@@ -6898,7 +7139,7 @@ export type Chain = "main" | "test"
|
|
|
6898
7139
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6899
7140
|
|
|
6900
7141
|
---
|
|
6901
|
-
|
|
7142
|
+
##### Type: DBType
|
|
6902
7143
|
|
|
6903
7144
|
```ts
|
|
6904
7145
|
export type DBType = "SQLite" | "MySQL"
|
|
@@ -6907,7 +7148,7 @@ export type DBType = "SQLite" | "MySQL"
|
|
|
6907
7148
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6908
7149
|
|
|
6909
7150
|
---
|
|
6910
|
-
|
|
7151
|
+
##### Type: GetMerklePathService
|
|
6911
7152
|
|
|
6912
7153
|
```ts
|
|
6913
7154
|
export type GetMerklePathService = (txid: string, chain: sdk.Chain, services: WalletServices) => Promise<GetMerklePathResult>
|
|
@@ -6918,7 +7159,7 @@ See also: [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathre
|
|
|
6918
7159
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6919
7160
|
|
|
6920
7161
|
---
|
|
6921
|
-
|
|
7162
|
+
##### Type: GetRawTxService
|
|
6922
7163
|
|
|
6923
7164
|
```ts
|
|
6924
7165
|
export type GetRawTxService = (txid: string, chain: sdk.Chain) => Promise<GetRawTxResult>
|
|
@@ -6929,7 +7170,7 @@ See also: [Chain](#type-chain), [GetRawTxResult](#interface-getrawtxresult)
|
|
|
6929
7170
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6930
7171
|
|
|
6931
7172
|
---
|
|
6932
|
-
|
|
7173
|
+
##### Type: GetUtxoStatusOutputFormat
|
|
6933
7174
|
|
|
6934
7175
|
```ts
|
|
6935
7176
|
export type GetUtxoStatusOutputFormat = "hashLE" | "hashBE" | "script"
|
|
@@ -6938,7 +7179,7 @@ export type GetUtxoStatusOutputFormat = "hashLE" | "hashBE" | "script"
|
|
|
6938
7179
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6939
7180
|
|
|
6940
7181
|
---
|
|
6941
|
-
|
|
7182
|
+
##### Type: GetUtxoStatusService
|
|
6942
7183
|
|
|
6943
7184
|
```ts
|
|
6944
7185
|
export type GetUtxoStatusService = (output: string, chain: sdk.Chain, outputFormat?: GetUtxoStatusOutputFormat) => Promise<GetUtxoStatusResult>
|
|
@@ -6949,7 +7190,7 @@ See also: [Chain](#type-chain), [GetUtxoStatusOutputFormat](#type-getutxostatuso
|
|
|
6949
7190
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6950
7191
|
|
|
6951
7192
|
---
|
|
6952
|
-
|
|
7193
|
+
##### Type: KeyPairAddress
|
|
6953
7194
|
|
|
6954
7195
|
```ts
|
|
6955
7196
|
export type KeyPairAddress = {
|
|
@@ -6962,7 +7203,7 @@ export type KeyPairAddress = {
|
|
|
6962
7203
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6963
7204
|
|
|
6964
7205
|
---
|
|
6965
|
-
|
|
7206
|
+
##### Type: MonitorStorage
|
|
6966
7207
|
|
|
6967
7208
|
```ts
|
|
6968
7209
|
export type MonitorStorage = WalletStorageManager
|
|
@@ -6973,7 +7214,7 @@ See also: [WalletStorageManager](#class-walletstoragemanager)
|
|
|
6973
7214
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6974
7215
|
|
|
6975
7216
|
---
|
|
6976
|
-
|
|
7217
|
+
##### Type: PostBeefService
|
|
6977
7218
|
|
|
6978
7219
|
```ts
|
|
6979
7220
|
export type PostBeefService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostBeefResult>
|
|
@@ -6984,7 +7225,7 @@ See also: [PostBeefResult](#interface-postbeefresult), [WalletServices](#interfa
|
|
|
6984
7225
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6985
7226
|
|
|
6986
7227
|
---
|
|
6987
|
-
|
|
7228
|
+
##### Type: PostReqsToNetworkDetailsStatus
|
|
6988
7229
|
|
|
6989
7230
|
```ts
|
|
6990
7231
|
export type PostReqsToNetworkDetailsStatus = "success" | "doubleSpend" | "unknown"
|
|
@@ -6993,7 +7234,7 @@ export type PostReqsToNetworkDetailsStatus = "success" | "doubleSpend" | "unknow
|
|
|
6993
7234
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6994
7235
|
|
|
6995
7236
|
---
|
|
6996
|
-
|
|
7237
|
+
##### Type: PostTxsService
|
|
6997
7238
|
|
|
6998
7239
|
```ts
|
|
6999
7240
|
export type PostTxsService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostTxsResult>
|
|
@@ -7004,7 +7245,7 @@ See also: [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface
|
|
|
7004
7245
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7005
7246
|
|
|
7006
7247
|
---
|
|
7007
|
-
|
|
7248
|
+
##### Type: ProvenTxReqStatus
|
|
7008
7249
|
|
|
7009
7250
|
Initial status (attempts === 0):
|
|
7010
7251
|
|
|
@@ -7045,7 +7286,7 @@ export type ProvenTxReqStatus = "sending" | "unsent" | "nosend" | "unknown" | "n
|
|
|
7045
7286
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7046
7287
|
|
|
7047
7288
|
---
|
|
7048
|
-
|
|
7289
|
+
##### Type: StorageProvidedBy
|
|
7049
7290
|
|
|
7050
7291
|
```ts
|
|
7051
7292
|
export type StorageProvidedBy = "you" | "storage" | "you-and-storage"
|
|
@@ -7054,7 +7295,7 @@ export type StorageProvidedBy = "you" | "storage" | "you-and-storage"
|
|
|
7054
7295
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7055
7296
|
|
|
7056
7297
|
---
|
|
7057
|
-
|
|
7298
|
+
##### Type: SyncProtocolVersion
|
|
7058
7299
|
|
|
7059
7300
|
```ts
|
|
7060
7301
|
export type SyncProtocolVersion = "0.1.0"
|
|
@@ -7063,7 +7304,7 @@ export type SyncProtocolVersion = "0.1.0"
|
|
|
7063
7304
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7064
7305
|
|
|
7065
7306
|
---
|
|
7066
|
-
|
|
7307
|
+
##### Type: SyncStatus
|
|
7067
7308
|
|
|
7068
7309
|
success: Last sync of this user from this storage was successful.
|
|
7069
7310
|
|
|
@@ -7080,7 +7321,7 @@ export type SyncStatus = "success" | "error" | "identified" | "updated" | "unkno
|
|
|
7080
7321
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7081
7322
|
|
|
7082
7323
|
---
|
|
7083
|
-
|
|
7324
|
+
##### Type: TransactionStatus
|
|
7084
7325
|
|
|
7085
7326
|
```ts
|
|
7086
7327
|
export type TransactionStatus = "completed" | "failed" | "unprocessed" | "sending" | "unproven" | "unsigned" | "nosend"
|
|
@@ -7089,7 +7330,7 @@ export type TransactionStatus = "completed" | "failed" | "unprocessed" | "sendin
|
|
|
7089
7330
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7090
7331
|
|
|
7091
7332
|
---
|
|
7092
|
-
|
|
7333
|
+
##### Type: UpdateFiatExchangeRateService
|
|
7093
7334
|
|
|
7094
7335
|
```ts
|
|
7095
7336
|
export type UpdateFiatExchangeRateService = (targetCurrencies: string[], options: WalletServicesOptions) => Promise<FiatExchangeRates>
|
|
@@ -7100,7 +7341,7 @@ See also: [FiatExchangeRates](#interface-fiatexchangerates), [WalletServicesOpti
|
|
|
7100
7341
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7101
7342
|
|
|
7102
7343
|
---
|
|
7103
|
-
|
|
7344
|
+
#### Variables
|
|
7104
7345
|
|
|
7105
7346
|
| |
|
|
7106
7347
|
| --- |
|
|
@@ -7112,7 +7353,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
7112
7353
|
|
|
7113
7354
|
---
|
|
7114
7355
|
|
|
7115
|
-
|
|
7356
|
+
##### Variable: ProvenTxReqNonTerminalStatus
|
|
7116
7357
|
|
|
7117
7358
|
```ts
|
|
7118
7359
|
ProvenTxReqNonTerminalStatus: ProvenTxReqStatus[] = [
|
|
@@ -7133,7 +7374,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
|
7133
7374
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7134
7375
|
|
|
7135
7376
|
---
|
|
7136
|
-
|
|
7377
|
+
##### Variable: ProvenTxReqTerminalStatus
|
|
7137
7378
|
|
|
7138
7379
|
```ts
|
|
7139
7380
|
ProvenTxReqTerminalStatus: ProvenTxReqStatus[] = [
|
|
@@ -7148,7 +7389,7 @@ See also: [ProvenTxReqStatus](#type-proventxreqstatus)
|
|
|
7148
7389
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7149
7390
|
|
|
7150
7391
|
---
|
|
7151
|
-
|
|
7392
|
+
##### Variable: brc29ProtocolID
|
|
7152
7393
|
|
|
7153
7394
|
```ts
|
|
7154
7395
|
brc29ProtocolID: WalletProtocol = [2, "3241645161d8"]
|
|
@@ -7157,3 +7398,5 @@ brc29ProtocolID: WalletProtocol = [2, "3241645161d8"]
|
|
|
7157
7398
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7158
7399
|
|
|
7159
7400
|
---
|
|
7401
|
+
|
|
7402
|
+
<!--#endregion ts2md-api-merged-here-->
|