@bsv/sdk 1.6.14 → 1.6.16
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/src/auth/certificates/__tests/CompletedProtoWallet.js +1 -1
- package/dist/cjs/src/auth/certificates/__tests/CompletedProtoWallet.js.map +1 -1
- package/dist/cjs/src/primitives/Point.js +123 -6
- package/dist/cjs/src/primitives/Point.js.map +1 -1
- package/dist/cjs/src/primitives/PrivateKey.js +19 -2
- package/dist/cjs/src/primitives/PrivateKey.js.map +1 -1
- package/dist/cjs/src/primitives/PublicKey.js +19 -2
- package/dist/cjs/src/primitives/PublicKey.js.map +1 -1
- package/dist/cjs/src/wallet/CachedKeyDeriver.js +12 -1
- package/dist/cjs/src/wallet/CachedKeyDeriver.js.map +1 -1
- package/dist/cjs/src/wallet/KeyDeriver.js +8 -5
- package/dist/cjs/src/wallet/KeyDeriver.js.map +1 -1
- package/dist/cjs/src/wallet/ProtoWallet.js +5 -2
- package/dist/cjs/src/wallet/ProtoWallet.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/auth/certificates/__tests/CompletedProtoWallet.js +2 -2
- package/dist/esm/src/auth/certificates/__tests/CompletedProtoWallet.js.map +1 -1
- package/dist/esm/src/primitives/Point.js +123 -6
- package/dist/esm/src/primitives/Point.js.map +1 -1
- package/dist/esm/src/primitives/PrivateKey.js +19 -2
- package/dist/esm/src/primitives/PrivateKey.js.map +1 -1
- package/dist/esm/src/primitives/PublicKey.js +19 -2
- package/dist/esm/src/primitives/PublicKey.js.map +1 -1
- package/dist/esm/src/wallet/CachedKeyDeriver.js +20 -1
- package/dist/esm/src/wallet/CachedKeyDeriver.js.map +1 -1
- package/dist/esm/src/wallet/KeyDeriver.js +11 -5
- package/dist/esm/src/wallet/KeyDeriver.js.map +1 -1
- package/dist/esm/src/wallet/ProtoWallet.js +2 -2
- package/dist/esm/src/wallet/ProtoWallet.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/auth/certificates/__tests/CompletedProtoWallet.d.ts.map +1 -1
- package/dist/types/src/primitives/Point.d.ts.map +1 -1
- package/dist/types/src/primitives/PrivateKey.d.ts +3 -1
- package/dist/types/src/primitives/PrivateKey.d.ts.map +1 -1
- package/dist/types/src/primitives/PublicKey.d.ts +3 -1
- package/dist/types/src/primitives/PublicKey.d.ts.map +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/src/wallet/CachedKeyDeriver.d.ts +10 -2
- package/dist/types/src/wallet/CachedKeyDeriver.d.ts.map +1 -1
- package/dist/types/src/wallet/KeyDeriver.d.ts +5 -2
- package/dist/types/src/wallet/KeyDeriver.d.ts.map +1 -1
- package/dist/types/src/wallet/ProtoWallet.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +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 +404 -577
- 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 +89 -247
- package/package.json +1 -1
- package/src/auth/certificates/__tests/CompletedProtoWallet.ts +3 -2
- package/src/primitives/Point.ts +152 -5
- package/src/primitives/PrivateKey.ts +22 -2
- package/src/primitives/PublicKey.ts +22 -2
- package/src/transaction/http/HttpClient.ts +2 -0
- package/src/wallet/CachedKeyDeriver.ts +32 -8
- package/src/wallet/KeyDeriver.ts +22 -6
- package/src/wallet/ProtoWallet.ts +3 -2
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
|
| | |
|
|
@@ -1656,7 +1549,9 @@ This is useful for optimizing performance when the same keys are derived multipl
|
|
|
1656
1549
|
It supports configurable cache size with sane defaults and maintains cache entries using LRU (Least Recently Used) eviction policy.
|
|
1657
1550
|
|
|
1658
1551
|
```ts
|
|
1659
|
-
export default class CachedKeyDeriver {
|
|
1552
|
+
export default class CachedKeyDeriver implements KeyDeriverApi {
|
|
1553
|
+
rootKey: PrivateKey;
|
|
1554
|
+
identityKey: string;
|
|
1660
1555
|
constructor(rootKey: PrivateKey | "anyone", options?: {
|
|
1661
1556
|
maxCacheSize?: number;
|
|
1662
1557
|
})
|
|
@@ -1668,7 +1563,7 @@ export default class CachedKeyDeriver {
|
|
|
1668
1563
|
}
|
|
1669
1564
|
```
|
|
1670
1565
|
|
|
1671
|
-
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1566
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1672
1567
|
|
|
1673
1568
|
#### Constructor
|
|
1674
1569
|
|
|
@@ -1679,15 +1574,31 @@ constructor(rootKey: PrivateKey | "anyone", options?: {
|
|
|
1679
1574
|
maxCacheSize?: number;
|
|
1680
1575
|
})
|
|
1681
1576
|
```
|
|
1682
|
-
|
|
1683
1577
|
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1684
1578
|
|
|
1685
1579
|
Argument Details
|
|
1686
1580
|
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1581
|
+
+ **rootKey**
|
|
1582
|
+
+ The root private key or the string 'anyone'.
|
|
1583
|
+
+ **options**
|
|
1584
|
+
+ Optional settings for the cache.
|
|
1585
|
+
|
|
1586
|
+
#### Property identityKey
|
|
1587
|
+
|
|
1588
|
+
The identity of this key deriver which is normally the public key associated with the `rootKey`
|
|
1589
|
+
|
|
1590
|
+
```ts
|
|
1591
|
+
identityKey: string
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
#### Property rootKey
|
|
1595
|
+
|
|
1596
|
+
The root key from which all other keys are derived.
|
|
1597
|
+
|
|
1598
|
+
```ts
|
|
1599
|
+
rootKey: PrivateKey
|
|
1600
|
+
```
|
|
1601
|
+
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1691
1602
|
|
|
1692
1603
|
#### Method derivePrivateKey
|
|
1693
1604
|
|
|
@@ -1697,7 +1608,6 @@ Caches the result for future calls with the same parameters.
|
|
|
1697
1608
|
```ts
|
|
1698
1609
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
1699
1610
|
```
|
|
1700
|
-
|
|
1701
1611
|
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1702
1612
|
|
|
1703
1613
|
Returns
|
|
@@ -1706,12 +1616,12 @@ Returns
|
|
|
1706
1616
|
|
|
1707
1617
|
Argument Details
|
|
1708
1618
|
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1619
|
+
+ **protocolID**
|
|
1620
|
+
+ The protocol ID including a security level and protocol name.
|
|
1621
|
+
+ **keyID**
|
|
1622
|
+
+ The key identifier.
|
|
1623
|
+
+ **counterparty**
|
|
1624
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
1715
1625
|
|
|
1716
1626
|
#### Method derivePublicKey
|
|
1717
1627
|
|
|
@@ -1721,7 +1631,6 @@ Caches the result for future calls with the same parameters.
|
|
|
1721
1631
|
```ts
|
|
1722
1632
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
1723
1633
|
```
|
|
1724
|
-
|
|
1725
1634
|
See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1726
1635
|
|
|
1727
1636
|
Returns
|
|
@@ -1730,14 +1639,14 @@ Returns
|
|
|
1730
1639
|
|
|
1731
1640
|
Argument Details
|
|
1732
1641
|
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1642
|
+
+ **protocolID**
|
|
1643
|
+
+ The protocol ID including a security level and protocol name.
|
|
1644
|
+
+ **keyID**
|
|
1645
|
+
+ The key identifier.
|
|
1646
|
+
+ **counterparty**
|
|
1647
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
1648
|
+
+ **forSelf**
|
|
1649
|
+
+ Whether deriving for self.
|
|
1741
1650
|
|
|
1742
1651
|
#### Method deriveSymmetricKey
|
|
1743
1652
|
|
|
@@ -1747,7 +1656,6 @@ Caches the result for future calls with the same parameters.
|
|
|
1747
1656
|
```ts
|
|
1748
1657
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
1749
1658
|
```
|
|
1750
|
-
|
|
1751
1659
|
See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1752
1660
|
|
|
1753
1661
|
Returns
|
|
@@ -1756,12 +1664,12 @@ Returns
|
|
|
1756
1664
|
|
|
1757
1665
|
Argument Details
|
|
1758
1666
|
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1667
|
+
+ **protocolID**
|
|
1668
|
+
+ The protocol ID including a security level and protocol name.
|
|
1669
|
+
+ **keyID**
|
|
1670
|
+
+ The key identifier.
|
|
1671
|
+
+ **counterparty**
|
|
1672
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
1765
1673
|
|
|
1766
1674
|
Throws
|
|
1767
1675
|
|
|
@@ -1775,7 +1683,6 @@ Caches the result for future calls with the same parameters.
|
|
|
1775
1683
|
```ts
|
|
1776
1684
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
1777
1685
|
```
|
|
1778
|
-
|
|
1779
1686
|
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
1780
1687
|
|
|
1781
1688
|
Returns
|
|
@@ -1784,8 +1691,8 @@ Returns
|
|
|
1784
1691
|
|
|
1785
1692
|
Argument Details
|
|
1786
1693
|
|
|
1787
|
-
|
|
1788
|
-
|
|
1694
|
+
+ **counterparty**
|
|
1695
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
1789
1696
|
|
|
1790
1697
|
Throws
|
|
1791
1698
|
|
|
@@ -1799,7 +1706,6 @@ Caches the result for future calls with the same parameters.
|
|
|
1799
1706
|
```ts
|
|
1800
1707
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
1801
1708
|
```
|
|
1802
|
-
|
|
1803
1709
|
See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1804
1710
|
|
|
1805
1711
|
Returns
|
|
@@ -1808,17 +1714,16 @@ Returns
|
|
|
1808
1714
|
|
|
1809
1715
|
Argument Details
|
|
1810
1716
|
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1717
|
+
+ **counterparty**
|
|
1718
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
1719
|
+
+ **protocolID**
|
|
1720
|
+
+ The protocol ID including a security level and protocol name.
|
|
1721
|
+
+ **keyID**
|
|
1722
|
+
+ The key identifier.
|
|
1817
1723
|
|
|
1818
1724
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1819
1725
|
|
|
1820
1726
|
---
|
|
1821
|
-
|
|
1822
1727
|
### Class: HTTPWalletJSON
|
|
1823
1728
|
|
|
1824
1729
|
```ts
|
|
@@ -2043,7 +1948,6 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
|
|
|
2043
1948
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2044
1949
|
|
|
2045
1950
|
---
|
|
2046
|
-
|
|
2047
1951
|
### Class: HTTPWalletWire
|
|
2048
1952
|
|
|
2049
1953
|
```ts
|
|
@@ -2061,7 +1965,6 @@ See also: [WalletWire](./wallet.md#interface-walletwire)
|
|
|
2061
1965
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2062
1966
|
|
|
2063
1967
|
---
|
|
2064
|
-
|
|
2065
1968
|
### Class: KeyDeriver
|
|
2066
1969
|
|
|
2067
1970
|
Class responsible for deriving various types of keys using a root private key.
|
|
@@ -2071,7 +1974,7 @@ It supports deriving public and private keys, symmetric keys, and revealing key
|
|
|
2071
1974
|
export class KeyDeriver implements KeyDeriverApi {
|
|
2072
1975
|
rootKey: PrivateKey;
|
|
2073
1976
|
identityKey: string;
|
|
2074
|
-
constructor(rootKey: PrivateKey | "anyone")
|
|
1977
|
+
constructor(rootKey: PrivateKey | "anyone", private readonly cacheSharedSecret?: ((priv: PrivateKey, pub: Point, point: Point) => void), private readonly retrieveCachedSharedSecret?: ((priv: PrivateKey, pub: Point) => (Point | undefined)))
|
|
2075
1978
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
2076
1979
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
2077
1980
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
@@ -2080,22 +1983,21 @@ export class KeyDeriver implements KeyDeriverApi {
|
|
|
2080
1983
|
}
|
|
2081
1984
|
```
|
|
2082
1985
|
|
|
2083
|
-
See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1986
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2084
1987
|
|
|
2085
1988
|
#### Constructor
|
|
2086
1989
|
|
|
2087
1990
|
Initializes the KeyDeriver instance with a root private key.
|
|
2088
1991
|
|
|
2089
1992
|
```ts
|
|
2090
|
-
constructor(rootKey: PrivateKey | "anyone")
|
|
1993
|
+
constructor(rootKey: PrivateKey | "anyone", private readonly cacheSharedSecret?: ((priv: PrivateKey, pub: Point, point: Point) => void), private readonly retrieveCachedSharedSecret?: ((priv: PrivateKey, pub: Point) => (Point | undefined)))
|
|
2091
1994
|
```
|
|
2092
|
-
|
|
2093
|
-
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1995
|
+
See also: [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey)
|
|
2094
1996
|
|
|
2095
1997
|
Argument Details
|
|
2096
1998
|
|
|
2097
|
-
|
|
2098
|
-
|
|
1999
|
+
+ **rootKey**
|
|
2000
|
+
+ The root private key or the string 'anyone'.
|
|
2099
2001
|
|
|
2100
2002
|
#### Method derivePrivateKey
|
|
2101
2003
|
|
|
@@ -2104,7 +2006,6 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
2104
2006
|
```ts
|
|
2105
2007
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
2106
2008
|
```
|
|
2107
|
-
|
|
2108
2009
|
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2109
2010
|
|
|
2110
2011
|
Returns
|
|
@@ -2113,12 +2014,12 @@ Returns
|
|
|
2113
2014
|
|
|
2114
2015
|
Argument Details
|
|
2115
2016
|
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2017
|
+
+ **protocolID**
|
|
2018
|
+
+ The protocol ID including a security level and protocol name.
|
|
2019
|
+
+ **keyID**
|
|
2020
|
+
+ The key identifier.
|
|
2021
|
+
+ **counterparty**
|
|
2022
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
2122
2023
|
|
|
2123
2024
|
#### Method derivePublicKey
|
|
2124
2025
|
|
|
@@ -2127,7 +2028,6 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
2127
2028
|
```ts
|
|
2128
2029
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
2129
2030
|
```
|
|
2130
|
-
|
|
2131
2031
|
See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2132
2032
|
|
|
2133
2033
|
Returns
|
|
@@ -2136,14 +2036,14 @@ Returns
|
|
|
2136
2036
|
|
|
2137
2037
|
Argument Details
|
|
2138
2038
|
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2039
|
+
+ **protocolID**
|
|
2040
|
+
+ The protocol ID including a security level and protocol name.
|
|
2041
|
+
+ **keyID**
|
|
2042
|
+
+ The key identifier.
|
|
2043
|
+
+ **counterparty**
|
|
2044
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
2045
|
+
+ **forSelf**
|
|
2046
|
+
+ Whether deriving for self.
|
|
2147
2047
|
|
|
2148
2048
|
#### Method deriveSymmetricKey
|
|
2149
2049
|
|
|
@@ -2153,7 +2053,6 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
2153
2053
|
```ts
|
|
2154
2054
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
2155
2055
|
```
|
|
2156
|
-
|
|
2157
2056
|
See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2158
2057
|
|
|
2159
2058
|
Returns
|
|
@@ -2162,12 +2061,12 @@ Returns
|
|
|
2162
2061
|
|
|
2163
2062
|
Argument Details
|
|
2164
2063
|
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2064
|
+
+ **protocolID**
|
|
2065
|
+
+ The protocol ID including a security level and protocol name.
|
|
2066
|
+
+ **keyID**
|
|
2067
|
+
+ The key identifier.
|
|
2068
|
+
+ **counterparty**
|
|
2069
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
2171
2070
|
|
|
2172
2071
|
#### Method revealCounterpartySecret
|
|
2173
2072
|
|
|
@@ -2177,7 +2076,6 @@ Note: This should not be used for 'self'.
|
|
|
2177
2076
|
```ts
|
|
2178
2077
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
2179
2078
|
```
|
|
2180
|
-
|
|
2181
2079
|
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
2182
2080
|
|
|
2183
2081
|
Returns
|
|
@@ -2186,8 +2084,8 @@ Returns
|
|
|
2186
2084
|
|
|
2187
2085
|
Argument Details
|
|
2188
2086
|
|
|
2189
|
-
|
|
2190
|
-
|
|
2087
|
+
+ **counterparty**
|
|
2088
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
2191
2089
|
|
|
2192
2090
|
Throws
|
|
2193
2091
|
|
|
@@ -2200,7 +2098,6 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
2200
2098
|
```ts
|
|
2201
2099
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
2202
2100
|
```
|
|
2203
|
-
|
|
2204
2101
|
See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2205
2102
|
|
|
2206
2103
|
Returns
|
|
@@ -2209,17 +2106,16 @@ Returns
|
|
|
2209
2106
|
|
|
2210
2107
|
Argument Details
|
|
2211
2108
|
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2109
|
+
+ **counterparty**
|
|
2110
|
+
+ The counterparty's public key or a predefined value ('self' or 'anyone').
|
|
2111
|
+
+ **protocolID**
|
|
2112
|
+
+ The protocol ID including a security level and protocol name.
|
|
2113
|
+
+ **keyID**
|
|
2114
|
+
+ The key identifier.
|
|
2218
2115
|
|
|
2219
2116
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2220
2117
|
|
|
2221
2118
|
---
|
|
2222
|
-
|
|
2223
2119
|
### Class: ProtoWallet
|
|
2224
2120
|
|
|
2225
2121
|
A ProtoWallet is precursor to a full wallet, capable of performing all foundational cryptographic operations.
|
|
@@ -2251,7 +2147,6 @@ See also: [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacRes
|
|
|
2251
2147
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2252
2148
|
|
|
2253
2149
|
---
|
|
2254
|
-
|
|
2255
2150
|
### Class: ReactNativeWebView
|
|
2256
2151
|
|
|
2257
2152
|
Facilitates wallet operations over cross-document messaging.
|
|
@@ -2696,7 +2591,6 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
|
|
|
2696
2591
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2697
2592
|
|
|
2698
2593
|
---
|
|
2699
|
-
|
|
2700
2594
|
### Class: WERR_REVIEW_ACTIONS
|
|
2701
2595
|
|
|
2702
2596
|
When a `createAction` or `signAction` is completed in undelayed mode (`acceptDelayedBroadcast`: false),
|
|
@@ -2722,13 +2616,11 @@ which contains more details, particularly for double spend results.
|
|
|
2722
2616
|
```ts
|
|
2723
2617
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
2724
2618
|
```
|
|
2725
|
-
|
|
2726
2619
|
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
2620
|
|
|
2728
2621
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2729
2622
|
|
|
2730
2623
|
---
|
|
2731
|
-
|
|
2732
2624
|
### Class: WalletClient
|
|
2733
2625
|
|
|
2734
2626
|
The SDK is how applications communicate with wallets over a communications substrate.
|
|
@@ -2943,7 +2835,6 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
|
|
|
2943
2835
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2944
2836
|
|
|
2945
2837
|
---
|
|
2946
|
-
|
|
2947
2838
|
### Class: WalletError
|
|
2948
2839
|
|
|
2949
2840
|
```ts
|
|
@@ -2957,7 +2848,6 @@ export class WalletError extends Error {
|
|
|
2957
2848
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2958
2849
|
|
|
2959
2850
|
---
|
|
2960
|
-
|
|
2961
2851
|
### Class: WalletWireProcessor
|
|
2962
2852
|
|
|
2963
2853
|
Processes incoming wallet calls received over a wallet wire, with a given wallet.
|
|
@@ -2975,7 +2865,6 @@ See also: [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire]
|
|
|
2975
2865
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2976
2866
|
|
|
2977
2867
|
---
|
|
2978
|
-
|
|
2979
2868
|
### Class: WalletWireTransceiver
|
|
2980
2869
|
|
|
2981
2870
|
A way to make remote calls to a wallet over a wallet wire.
|
|
@@ -3199,7 +3088,6 @@ See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs)
|
|
|
3199
3088
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3200
3089
|
|
|
3201
3090
|
---
|
|
3202
|
-
|
|
3203
3091
|
### Class: WindowCWISubstrate
|
|
3204
3092
|
|
|
3205
3093
|
Facilitates wallet operations over the window.CWI interface.
|
|
@@ -3643,7 +3531,6 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
|
|
|
3643
3531
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3644
3532
|
|
|
3645
3533
|
---
|
|
3646
|
-
|
|
3647
3534
|
### Class: XDMSubstrate
|
|
3648
3535
|
|
|
3649
3536
|
Facilitates wallet operations over cross-document messaging.
|
|
@@ -4088,7 +3975,6 @@ See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64s
|
|
|
4088
3975
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4089
3976
|
|
|
4090
3977
|
---
|
|
4091
|
-
|
|
4092
3978
|
## Functions
|
|
4093
3979
|
|
|
4094
3980
|
### Function: toOriginHeader
|
|
@@ -4100,7 +3986,6 @@ export function toOriginHeader(originator: string, fallbackScheme = "http"): str
|
|
|
4100
3986
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4101
3987
|
|
|
4102
3988
|
---
|
|
4103
|
-
|
|
4104
3989
|
## Types
|
|
4105
3990
|
|
|
4106
3991
|
| | | |
|
|
@@ -4136,7 +4021,6 @@ See also: [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
|
4136
4021
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4137
4022
|
|
|
4138
4023
|
---
|
|
4139
|
-
|
|
4140
4024
|
### Type: AcquisitionProtocol
|
|
4141
4025
|
|
|
4142
4026
|
```ts
|
|
@@ -4146,7 +4030,6 @@ export type AcquisitionProtocol = "direct" | "issuance"
|
|
|
4146
4030
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4147
4031
|
|
|
4148
4032
|
---
|
|
4149
|
-
|
|
4150
4033
|
### Type: ActionStatus
|
|
4151
4034
|
|
|
4152
4035
|
```ts
|
|
@@ -4156,7 +4039,6 @@ export type ActionStatus = "completed" | "unprocessed" | "sending" | "unproven"
|
|
|
4156
4039
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4157
4040
|
|
|
4158
4041
|
---
|
|
4159
|
-
|
|
4160
4042
|
### Type: AtomicBEEF
|
|
4161
4043
|
|
|
4162
4044
|
```ts
|
|
@@ -4168,7 +4050,6 @@ See also: [Byte](./wallet.md#type-byte)
|
|
|
4168
4050
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4169
4051
|
|
|
4170
4052
|
---
|
|
4171
|
-
|
|
4172
4053
|
### Type: BEEF
|
|
4173
4054
|
|
|
4174
4055
|
```ts
|
|
@@ -4180,7 +4061,6 @@ See also: [Byte](./wallet.md#type-byte)
|
|
|
4180
4061
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4181
4062
|
|
|
4182
4063
|
---
|
|
4183
|
-
|
|
4184
4064
|
### Type: Base64String
|
|
4185
4065
|
|
|
4186
4066
|
```ts
|
|
@@ -4190,7 +4070,6 @@ export type Base64String = string
|
|
|
4190
4070
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4191
4071
|
|
|
4192
4072
|
---
|
|
4193
|
-
|
|
4194
4073
|
### Type: BasketStringUnder300Bytes
|
|
4195
4074
|
|
|
4196
4075
|
```ts
|
|
@@ -4200,7 +4079,6 @@ export type BasketStringUnder300Bytes = string
|
|
|
4200
4079
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4201
4080
|
|
|
4202
4081
|
---
|
|
4203
|
-
|
|
4204
4082
|
### Type: BooleanDefaultFalse
|
|
4205
4083
|
|
|
4206
4084
|
```ts
|
|
@@ -4210,7 +4088,6 @@ export type BooleanDefaultFalse = boolean
|
|
|
4210
4088
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4211
4089
|
|
|
4212
4090
|
---
|
|
4213
|
-
|
|
4214
4091
|
### Type: BooleanDefaultTrue
|
|
4215
4092
|
|
|
4216
4093
|
```ts
|
|
@@ -4220,7 +4097,6 @@ export type BooleanDefaultTrue = boolean
|
|
|
4220
4097
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4221
4098
|
|
|
4222
4099
|
---
|
|
4223
|
-
|
|
4224
4100
|
### Type: Byte
|
|
4225
4101
|
|
|
4226
4102
|
```ts
|
|
@@ -4230,7 +4106,6 @@ export type Byte = number
|
|
|
4230
4106
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4231
4107
|
|
|
4232
4108
|
---
|
|
4233
|
-
|
|
4234
4109
|
### Type: CallType
|
|
4235
4110
|
|
|
4236
4111
|
```ts
|
|
@@ -4240,7 +4115,6 @@ export type CallType = keyof typeof calls
|
|
|
4240
4115
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4241
4116
|
|
|
4242
4117
|
---
|
|
4243
|
-
|
|
4244
4118
|
### Type: CertificateFieldNameUnder50Bytes
|
|
4245
4119
|
|
|
4246
4120
|
```ts
|
|
@@ -4250,7 +4124,6 @@ export type CertificateFieldNameUnder50Bytes = string
|
|
|
4250
4124
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4251
4125
|
|
|
4252
4126
|
---
|
|
4253
|
-
|
|
4254
4127
|
### Type: Counterparty
|
|
4255
4128
|
|
|
4256
4129
|
```ts
|
|
@@ -4262,7 +4135,6 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex), [PublicKey](./primitives.md#c
|
|
|
4262
4135
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4263
4136
|
|
|
4264
4137
|
---
|
|
4265
|
-
|
|
4266
4138
|
### Type: DescriptionString5to50Bytes
|
|
4267
4139
|
|
|
4268
4140
|
```ts
|
|
@@ -4272,7 +4144,6 @@ export type DescriptionString5to50Bytes = string
|
|
|
4272
4144
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4273
4145
|
|
|
4274
4146
|
---
|
|
4275
|
-
|
|
4276
4147
|
### Type: EntityIconURLStringMax500Bytes
|
|
4277
4148
|
|
|
4278
4149
|
```ts
|
|
@@ -4282,7 +4153,6 @@ export type EntityIconURLStringMax500Bytes = string
|
|
|
4282
4153
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4283
4154
|
|
|
4284
4155
|
---
|
|
4285
|
-
|
|
4286
4156
|
### Type: EntityNameStringMax100Bytes
|
|
4287
4157
|
|
|
4288
4158
|
```ts
|
|
@@ -4292,7 +4162,6 @@ export type EntityNameStringMax100Bytes = string
|
|
|
4292
4162
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4293
4163
|
|
|
4294
4164
|
---
|
|
4295
|
-
|
|
4296
4165
|
### Type: ErrorCodeString10To40Bytes
|
|
4297
4166
|
|
|
4298
4167
|
```ts
|
|
@@ -4302,7 +4171,6 @@ export type ErrorCodeString10To40Bytes = string
|
|
|
4302
4171
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4303
4172
|
|
|
4304
4173
|
---
|
|
4305
|
-
|
|
4306
4174
|
### Type: ErrorDescriptionString20To200Bytes
|
|
4307
4175
|
|
|
4308
4176
|
```ts
|
|
@@ -4312,7 +4180,6 @@ export type ErrorDescriptionString20To200Bytes = string
|
|
|
4312
4180
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4313
4181
|
|
|
4314
4182
|
---
|
|
4315
|
-
|
|
4316
4183
|
### Type: HexString
|
|
4317
4184
|
|
|
4318
4185
|
```ts
|
|
@@ -4322,7 +4189,6 @@ export type HexString = string
|
|
|
4322
4189
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4323
4190
|
|
|
4324
4191
|
---
|
|
4325
|
-
|
|
4326
4192
|
### Type: ISOTimestampString
|
|
4327
4193
|
|
|
4328
4194
|
```ts
|
|
@@ -4332,7 +4198,6 @@ export type ISOTimestampString = string
|
|
|
4332
4198
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4333
4199
|
|
|
4334
4200
|
---
|
|
4335
|
-
|
|
4336
4201
|
### Type: KeyIDStringUnder800Bytes
|
|
4337
4202
|
|
|
4338
4203
|
```ts
|
|
@@ -4342,7 +4207,6 @@ export type KeyIDStringUnder800Bytes = string
|
|
|
4342
4207
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4343
4208
|
|
|
4344
4209
|
---
|
|
4345
|
-
|
|
4346
4210
|
### Type: KeyringRevealer
|
|
4347
4211
|
|
|
4348
4212
|
```ts
|
|
@@ -4354,7 +4218,6 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
|
4354
4218
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4355
4219
|
|
|
4356
4220
|
---
|
|
4357
|
-
|
|
4358
4221
|
### Type: LabelStringUnder300Bytes
|
|
4359
4222
|
|
|
4360
4223
|
```ts
|
|
@@ -4364,7 +4227,6 @@ export type LabelStringUnder300Bytes = string
|
|
|
4364
4227
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4365
4228
|
|
|
4366
4229
|
---
|
|
4367
|
-
|
|
4368
4230
|
### Type: OriginatorDomainNameStringUnder250Bytes
|
|
4369
4231
|
|
|
4370
4232
|
```ts
|
|
@@ -4374,7 +4236,6 @@ export type OriginatorDomainNameStringUnder250Bytes = string
|
|
|
4374
4236
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4375
4237
|
|
|
4376
4238
|
---
|
|
4377
|
-
|
|
4378
4239
|
### Type: OutpointString
|
|
4379
4240
|
|
|
4380
4241
|
```ts
|
|
@@ -4384,7 +4245,6 @@ export type OutpointString = string
|
|
|
4384
4245
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4385
4246
|
|
|
4386
4247
|
---
|
|
4387
|
-
|
|
4388
4248
|
### Type: OutputTagStringUnder300Bytes
|
|
4389
4249
|
|
|
4390
4250
|
```ts
|
|
@@ -4394,7 +4254,6 @@ export type OutputTagStringUnder300Bytes = string
|
|
|
4394
4254
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4395
4255
|
|
|
4396
4256
|
---
|
|
4397
|
-
|
|
4398
4257
|
### Type: PositiveInteger
|
|
4399
4258
|
|
|
4400
4259
|
```ts
|
|
@@ -4404,7 +4263,6 @@ export type PositiveInteger = number
|
|
|
4404
4263
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4405
4264
|
|
|
4406
4265
|
---
|
|
4407
|
-
|
|
4408
4266
|
### Type: PositiveIntegerDefault10Max10000
|
|
4409
4267
|
|
|
4410
4268
|
```ts
|
|
@@ -4414,7 +4272,6 @@ export type PositiveIntegerDefault10Max10000 = number
|
|
|
4414
4272
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4415
4273
|
|
|
4416
4274
|
---
|
|
4417
|
-
|
|
4418
4275
|
### Type: PositiveIntegerMax10
|
|
4419
4276
|
|
|
4420
4277
|
```ts
|
|
@@ -4424,7 +4281,6 @@ export type PositiveIntegerMax10 = number
|
|
|
4424
4281
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4425
4282
|
|
|
4426
4283
|
---
|
|
4427
|
-
|
|
4428
4284
|
### Type: PositiveIntegerOrZero
|
|
4429
4285
|
|
|
4430
4286
|
```ts
|
|
@@ -4434,7 +4290,6 @@ export type PositiveIntegerOrZero = number
|
|
|
4434
4290
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4435
4291
|
|
|
4436
4292
|
---
|
|
4437
|
-
|
|
4438
4293
|
### Type: ProtocolString5To400Bytes
|
|
4439
4294
|
|
|
4440
4295
|
```ts
|
|
@@ -4444,7 +4299,6 @@ export type ProtocolString5To400Bytes = string
|
|
|
4444
4299
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4445
4300
|
|
|
4446
4301
|
---
|
|
4447
|
-
|
|
4448
4302
|
### Type: PubKeyHex
|
|
4449
4303
|
|
|
4450
4304
|
```ts
|
|
@@ -4456,7 +4310,6 @@ See also: [HexString](./wallet.md#type-hexstring)
|
|
|
4456
4310
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4457
4311
|
|
|
4458
4312
|
---
|
|
4459
|
-
|
|
4460
4313
|
### Type: ReviewActionResultStatus
|
|
4461
4314
|
|
|
4462
4315
|
Indicates status of a new Action following a `createAction` or `signAction` in immediate mode:
|
|
@@ -4474,7 +4327,6 @@ export type ReviewActionResultStatus = "success" | "doubleSpend" | "serviceError
|
|
|
4474
4327
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4475
4328
|
|
|
4476
4329
|
---
|
|
4477
|
-
|
|
4478
4330
|
### Type: SatoshiValue
|
|
4479
4331
|
|
|
4480
4332
|
```ts
|
|
@@ -4484,9 +4336,9 @@ export type SatoshiValue = number
|
|
|
4484
4336
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4485
4337
|
|
|
4486
4338
|
---
|
|
4487
|
-
|
|
4488
4339
|
### Type: SecurityLevel
|
|
4489
4340
|
|
|
4341
|
+
|
|
4490
4342
|
SecurityLevel for protocols.
|
|
4491
4343
|
0 = Silently grants the request with no user interation.
|
|
4492
4344
|
1 = Requires user approval for every application.
|
|
@@ -4499,7 +4351,6 @@ export type SecurityLevel = 0 | 1 | 2
|
|
|
4499
4351
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4500
4352
|
|
|
4501
4353
|
---
|
|
4502
|
-
|
|
4503
4354
|
### Type: SendWithResultStatus
|
|
4504
4355
|
|
|
4505
4356
|
```ts
|
|
@@ -4509,7 +4360,6 @@ export type SendWithResultStatus = "unproven" | "sending" | "failed"
|
|
|
4509
4360
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4510
4361
|
|
|
4511
4362
|
---
|
|
4512
|
-
|
|
4513
4363
|
### Type: TXIDHexString
|
|
4514
4364
|
|
|
4515
4365
|
```ts
|
|
@@ -4521,7 +4371,6 @@ See also: [HexString](./wallet.md#type-hexstring)
|
|
|
4521
4371
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4522
4372
|
|
|
4523
4373
|
---
|
|
4524
|
-
|
|
4525
4374
|
### Type: TrustSelf
|
|
4526
4375
|
|
|
4527
4376
|
Controls behavior of input BEEF validation.
|
|
@@ -4537,7 +4386,6 @@ export type TrustSelf = "known"
|
|
|
4537
4386
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4538
4387
|
|
|
4539
4388
|
---
|
|
4540
|
-
|
|
4541
4389
|
### Type: VersionString7To30Bytes
|
|
4542
4390
|
|
|
4543
4391
|
```ts
|
|
@@ -4547,7 +4395,6 @@ export type VersionString7To30Bytes = string
|
|
|
4547
4395
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4548
4396
|
|
|
4549
4397
|
---
|
|
4550
|
-
|
|
4551
4398
|
### Type: WalletCounterparty
|
|
4552
4399
|
|
|
4553
4400
|
```ts
|
|
@@ -4559,7 +4406,6 @@ See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
|
4559
4406
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4560
4407
|
|
|
4561
4408
|
---
|
|
4562
|
-
|
|
4563
4409
|
### Type: WalletErrorCode
|
|
4564
4410
|
|
|
4565
4411
|
```ts
|
|
@@ -4571,7 +4417,6 @@ See also: [walletErrors](./wallet.md#enum-walleterrors)
|
|
|
4571
4417
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4572
4418
|
|
|
4573
4419
|
---
|
|
4574
|
-
|
|
4575
4420
|
### Type: WalletNetwork
|
|
4576
4421
|
|
|
4577
4422
|
```ts
|
|
@@ -4581,7 +4426,6 @@ export type WalletNetwork = "mainnet" | "testnet"
|
|
|
4581
4426
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4582
4427
|
|
|
4583
4428
|
---
|
|
4584
|
-
|
|
4585
4429
|
### Type: WalletProtocol
|
|
4586
4430
|
|
|
4587
4431
|
```ts
|
|
@@ -4596,7 +4440,6 @@ See also: [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes
|
|
|
4596
4440
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4597
4441
|
|
|
4598
4442
|
---
|
|
4599
|
-
|
|
4600
4443
|
## Enums
|
|
4601
4444
|
|
|
4602
4445
|
| |
|
|
@@ -4623,7 +4466,6 @@ See also: [Counterparty](./wallet.md#type-counterparty)
|
|
|
4623
4466
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4624
4467
|
|
|
4625
4468
|
---
|
|
4626
|
-
|
|
4627
4469
|
### Enum: walletErrors
|
|
4628
4470
|
|
|
4629
4471
|
```ts
|
|
@@ -4639,5 +4481,5 @@ export enum walletErrors {
|
|
|
4639
4481
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4640
4482
|
|
|
4641
4483
|
---
|
|
4642
|
-
|
|
4643
4484
|
## Variables
|
|
4485
|
+
|