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