@bsv/sdk 1.8.1 → 1.8.2
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/kvstore/index.js +3 -1
- package/dist/cjs/src/kvstore/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/kvstore/index.js +1 -0
- package/dist/esm/src/kvstore/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/kvstore/index.d.ts +1 -0
- package/dist/types/src/kvstore/index.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +3 -3
- package/dist/umd/bundle.js.map +1 -1
- package/docs/reference/compat.md +15 -27
- package/docs/reference/identity.md +12 -16
- package/docs/reference/kvstore.md +471 -4
- package/docs/reference/messages.md +0 -8
- package/docs/reference/overlay-tools.md +15 -22
- package/docs/reference/primitives.md +168 -168
- package/docs/reference/registry.md +9 -19
- package/docs/reference/script.md +31 -32
- package/docs/reference/storage.md +10 -14
- package/docs/reference/totp.md +5 -5
- package/docs/reference/transaction.md +67 -70
- package/docs/reference/wallet.md +131 -135
- package/package.json +1 -1
- package/src/kvstore/index.ts +1 -0
package/docs/reference/wallet.md
CHANGED
|
@@ -44,7 +44,7 @@ export interface AbortActionArgs {
|
|
|
44
44
|
}
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
See also: [Base64String](
|
|
47
|
+
See also: [Base64String](#type-base64string)
|
|
48
48
|
|
|
49
49
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
50
50
|
|
|
@@ -79,7 +79,7 @@ export interface AcquireCertificateArgs {
|
|
|
79
79
|
}
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
See also: [AcquisitionProtocol](
|
|
82
|
+
See also: [AcquisitionProtocol](#type-acquisitionprotocol), [Base64String](#type-base64string), [BooleanDefaultFalse](#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [KeyringRevealer](#type-keyringrevealer), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
|
|
83
83
|
|
|
84
84
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
85
85
|
|
|
@@ -105,7 +105,7 @@ export interface BasketInsertion {
|
|
|
105
105
|
}
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
See also: [BasketStringUnder300Bytes](
|
|
108
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes)
|
|
109
109
|
|
|
110
110
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
111
111
|
|
|
@@ -119,7 +119,7 @@ export interface CertificateResult extends WalletCertificate {
|
|
|
119
119
|
}
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
See also: [Base64String](
|
|
122
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [WalletCertificate](#interface-walletcertificate)
|
|
123
123
|
|
|
124
124
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
125
125
|
|
|
@@ -139,7 +139,7 @@ export interface CreateActionArgs {
|
|
|
139
139
|
}
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
-
See also: [BEEF](
|
|
142
|
+
See also: [BEEF](#type-beef), [CreateActionInput](#interface-createactioninput), [CreateActionOptions](#interface-createactionoptions), [CreateActionOutput](#interface-createactionoutput), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
143
143
|
|
|
144
144
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
145
145
|
|
|
@@ -156,7 +156,7 @@ export interface CreateActionInput {
|
|
|
156
156
|
}
|
|
157
157
|
```
|
|
158
158
|
|
|
159
|
-
See also: [DescriptionString5to50Bytes](
|
|
159
|
+
See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
160
160
|
|
|
161
161
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
162
162
|
|
|
@@ -177,7 +177,7 @@ export interface CreateActionOptions {
|
|
|
177
177
|
}
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
See also: [BooleanDefaultFalse](
|
|
180
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [OutpointString](#type-outpointstring), [TXIDHexString](#type-txidhexstring), [TrustSelf](#type-trustself)
|
|
181
181
|
|
|
182
182
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
183
183
|
|
|
@@ -195,7 +195,7 @@ export interface CreateActionOutput {
|
|
|
195
195
|
}
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
See also: [BasketStringUnder300Bytes](
|
|
198
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [SatoshiValue](#type-satoshivalue)
|
|
199
199
|
|
|
200
200
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
201
201
|
|
|
@@ -212,7 +212,7 @@ export interface CreateActionResult {
|
|
|
212
212
|
}
|
|
213
213
|
```
|
|
214
214
|
|
|
215
|
-
See also: [AtomicBEEF](
|
|
215
|
+
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [SendWithResult](#interface-sendwithresult), [SignableTransaction](#interface-signabletransaction), [TXIDHexString](#type-txidhexstring)
|
|
216
216
|
|
|
217
217
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
218
218
|
|
|
@@ -225,7 +225,7 @@ export interface CreateHmacArgs extends WalletEncryptionArgs {
|
|
|
225
225
|
}
|
|
226
226
|
```
|
|
227
227
|
|
|
228
|
-
See also: [Byte](
|
|
228
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
229
229
|
|
|
230
230
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
231
231
|
|
|
@@ -238,7 +238,7 @@ export interface CreateHmacResult {
|
|
|
238
238
|
}
|
|
239
239
|
```
|
|
240
240
|
|
|
241
|
-
See also: [Byte](
|
|
241
|
+
See also: [Byte](#type-byte)
|
|
242
242
|
|
|
243
243
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
244
244
|
|
|
@@ -252,7 +252,7 @@ export interface CreateSignatureArgs extends WalletEncryptionArgs {
|
|
|
252
252
|
}
|
|
253
253
|
```
|
|
254
254
|
|
|
255
|
-
See also: [Byte](
|
|
255
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
256
256
|
|
|
257
257
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
258
258
|
|
|
@@ -265,7 +265,7 @@ export interface CreateSignatureResult {
|
|
|
265
265
|
}
|
|
266
266
|
```
|
|
267
267
|
|
|
268
|
-
See also: [Byte](
|
|
268
|
+
See also: [Byte](#type-byte)
|
|
269
269
|
|
|
270
270
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
271
271
|
|
|
@@ -281,7 +281,7 @@ export interface DiscoverByAttributesArgs {
|
|
|
281
281
|
}
|
|
282
282
|
```
|
|
283
283
|
|
|
284
|
-
See also: [BooleanDefaultTrue](
|
|
284
|
+
See also: [BooleanDefaultTrue](#type-booleandefaulttrue), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
285
285
|
|
|
286
286
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
287
287
|
|
|
@@ -297,7 +297,7 @@ export interface DiscoverByIdentityKeyArgs {
|
|
|
297
297
|
}
|
|
298
298
|
```
|
|
299
299
|
|
|
300
|
-
See also: [BooleanDefaultTrue](
|
|
300
|
+
See also: [BooleanDefaultTrue](#type-booleandefaulttrue), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [PubKeyHex](#type-pubkeyhex)
|
|
301
301
|
|
|
302
302
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
303
303
|
|
|
@@ -311,7 +311,7 @@ export interface DiscoverCertificatesResult {
|
|
|
311
311
|
}
|
|
312
312
|
```
|
|
313
313
|
|
|
314
|
-
See also: [IdentityCertificate](
|
|
314
|
+
See also: [IdentityCertificate](#interface-identitycertificate), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
315
315
|
|
|
316
316
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
317
317
|
|
|
@@ -324,7 +324,7 @@ export interface GetHeaderArgs {
|
|
|
324
324
|
}
|
|
325
325
|
```
|
|
326
326
|
|
|
327
|
-
See also: [PositiveInteger](
|
|
327
|
+
See also: [PositiveInteger](#type-positiveinteger)
|
|
328
328
|
|
|
329
329
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
330
330
|
|
|
@@ -337,7 +337,7 @@ export interface GetHeaderResult {
|
|
|
337
337
|
}
|
|
338
338
|
```
|
|
339
339
|
|
|
340
|
-
See also: [HexString](
|
|
340
|
+
See also: [HexString](#type-hexstring)
|
|
341
341
|
|
|
342
342
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
343
343
|
|
|
@@ -350,7 +350,7 @@ export interface GetHeightResult {
|
|
|
350
350
|
}
|
|
351
351
|
```
|
|
352
352
|
|
|
353
|
-
See also: [PositiveInteger](
|
|
353
|
+
See also: [PositiveInteger](#type-positiveinteger)
|
|
354
354
|
|
|
355
355
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
356
356
|
|
|
@@ -363,7 +363,7 @@ export interface GetNetworkResult {
|
|
|
363
363
|
}
|
|
364
364
|
```
|
|
365
365
|
|
|
366
|
-
See also: [WalletNetwork](
|
|
366
|
+
See also: [WalletNetwork](#type-walletnetwork)
|
|
367
367
|
|
|
368
368
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
369
369
|
|
|
@@ -381,7 +381,7 @@ export interface GetPublicKeyArgs extends Partial<WalletEncryptionArgs> {
|
|
|
381
381
|
}
|
|
382
382
|
```
|
|
383
383
|
|
|
384
|
-
See also: [BooleanDefaultFalse](
|
|
384
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
385
385
|
|
|
386
386
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
387
387
|
|
|
@@ -394,7 +394,7 @@ export interface GetPublicKeyResult {
|
|
|
394
394
|
}
|
|
395
395
|
```
|
|
396
396
|
|
|
397
|
-
See also: [PubKeyHex](
|
|
397
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
398
398
|
|
|
399
399
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
400
400
|
|
|
@@ -407,7 +407,7 @@ export interface GetVersionResult {
|
|
|
407
407
|
}
|
|
408
408
|
```
|
|
409
409
|
|
|
410
|
-
See also: [VersionString7To30Bytes](
|
|
410
|
+
See also: [VersionString7To30Bytes](#type-versionstring7to30bytes)
|
|
411
411
|
|
|
412
412
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
413
413
|
|
|
@@ -422,7 +422,7 @@ export interface IdentityCertificate extends WalletCertificate {
|
|
|
422
422
|
}
|
|
423
423
|
```
|
|
424
424
|
|
|
425
|
-
See also: [Base64String](
|
|
425
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [IdentityCertifier](#interface-identitycertifier), [WalletCertificate](#interface-walletcertificate)
|
|
426
426
|
|
|
427
427
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
428
428
|
|
|
@@ -438,7 +438,7 @@ export interface IdentityCertifier {
|
|
|
438
438
|
}
|
|
439
439
|
```
|
|
440
440
|
|
|
441
|
-
See also: [DescriptionString5to50Bytes](
|
|
441
|
+
See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [PositiveIntegerMax10](#type-positiveintegermax10)
|
|
442
442
|
|
|
443
443
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
444
444
|
|
|
@@ -455,7 +455,7 @@ export interface InternalizeActionArgs {
|
|
|
455
455
|
}
|
|
456
456
|
```
|
|
457
457
|
|
|
458
|
-
See also: [AtomicBEEF](
|
|
458
|
+
See also: [AtomicBEEF](#type-atomicbeef), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [InternalizeOutput](#interface-internalizeoutput), [LabelStringUnder300Bytes](#type-labelstringunder300bytes)
|
|
459
459
|
|
|
460
460
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
461
461
|
|
|
@@ -482,7 +482,7 @@ export interface InternalizeOutput {
|
|
|
482
482
|
}
|
|
483
483
|
```
|
|
484
484
|
|
|
485
|
-
See also: [BasketInsertion](
|
|
485
|
+
See also: [BasketInsertion](#interface-basketinsertion), [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletPayment](#interface-walletpayment)
|
|
486
486
|
|
|
487
487
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
488
488
|
|
|
@@ -501,7 +501,7 @@ export interface KeyDeriverApi {
|
|
|
501
501
|
}
|
|
502
502
|
```
|
|
503
503
|
|
|
504
|
-
See also: [Counterparty](
|
|
504
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
505
505
|
|
|
506
506
|
#### Property derivePrivateKey
|
|
507
507
|
|
|
@@ -510,7 +510,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
510
510
|
```ts
|
|
511
511
|
derivePrivateKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => PrivateKey
|
|
512
512
|
```
|
|
513
|
-
See also: [Counterparty](
|
|
513
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
514
514
|
|
|
515
515
|
#### Property derivePublicKey
|
|
516
516
|
|
|
@@ -519,7 +519,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
519
519
|
```ts
|
|
520
520
|
derivePublicKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean) => PublicKey
|
|
521
521
|
```
|
|
522
|
-
See also: [Counterparty](
|
|
522
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
523
523
|
|
|
524
524
|
#### Property deriveSymmetricKey
|
|
525
525
|
|
|
@@ -529,7 +529,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
529
529
|
```ts
|
|
530
530
|
deriveSymmetricKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => SymmetricKey
|
|
531
531
|
```
|
|
532
|
-
See also: [Counterparty](
|
|
532
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
533
533
|
|
|
534
534
|
#### Property identityKey
|
|
535
535
|
|
|
@@ -547,7 +547,7 @@ Note: This should not be used for 'self'.
|
|
|
547
547
|
```ts
|
|
548
548
|
revealCounterpartySecret: (counterparty: Counterparty) => number[]
|
|
549
549
|
```
|
|
550
|
-
See also: [Counterparty](
|
|
550
|
+
See also: [Counterparty](#type-counterparty)
|
|
551
551
|
|
|
552
552
|
#### Property revealSpecificSecret
|
|
553
553
|
|
|
@@ -556,7 +556,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
556
556
|
```ts
|
|
557
557
|
revealSpecificSecret: (counterparty: Counterparty, protocolID: WalletProtocol, keyID: string) => number[]
|
|
558
558
|
```
|
|
559
|
-
See also: [Counterparty](
|
|
559
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
560
560
|
|
|
561
561
|
#### Property rootKey
|
|
562
562
|
|
|
@@ -565,7 +565,6 @@ The root key from which all other keys are derived.
|
|
|
565
565
|
```ts
|
|
566
566
|
rootKey: PrivateKey
|
|
567
567
|
```
|
|
568
|
-
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
569
568
|
|
|
570
569
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
571
570
|
|
|
@@ -582,7 +581,7 @@ export interface KeyLinkageResult {
|
|
|
582
581
|
}
|
|
583
582
|
```
|
|
584
583
|
|
|
585
|
-
See also: [Byte](
|
|
584
|
+
See also: [Byte](#type-byte), [PubKeyHex](#type-pubkeyhex)
|
|
586
585
|
|
|
587
586
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
588
587
|
|
|
@@ -605,7 +604,7 @@ export interface ListActionsArgs {
|
|
|
605
604
|
}
|
|
606
605
|
```
|
|
607
606
|
|
|
608
|
-
See also: [BooleanDefaultFalse](
|
|
607
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
609
608
|
|
|
610
609
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
611
610
|
|
|
@@ -619,7 +618,7 @@ export interface ListActionsResult {
|
|
|
619
618
|
}
|
|
620
619
|
```
|
|
621
620
|
|
|
622
|
-
See also: [PositiveIntegerOrZero](
|
|
621
|
+
See also: [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletAction](#interface-walletaction)
|
|
623
622
|
|
|
624
623
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
625
624
|
|
|
@@ -637,7 +636,7 @@ export interface ListCertificatesArgs {
|
|
|
637
636
|
}
|
|
638
637
|
```
|
|
639
638
|
|
|
640
|
-
See also: [Base64String](
|
|
639
|
+
See also: [Base64String](#type-base64string), [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [PubKeyHex](#type-pubkeyhex)
|
|
641
640
|
|
|
642
641
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
643
642
|
|
|
@@ -651,7 +650,7 @@ export interface ListCertificatesResult {
|
|
|
651
650
|
}
|
|
652
651
|
```
|
|
653
652
|
|
|
654
|
-
See also: [CertificateResult](
|
|
653
|
+
See also: [CertificateResult](#interface-certificateresult), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
655
654
|
|
|
656
655
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
657
656
|
|
|
@@ -673,7 +672,7 @@ export interface ListOutputsArgs {
|
|
|
673
672
|
}
|
|
674
673
|
```
|
|
675
674
|
|
|
676
|
-
See also: [BasketStringUnder300Bytes](
|
|
675
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000)
|
|
677
676
|
|
|
678
677
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
679
678
|
|
|
@@ -688,7 +687,7 @@ export interface ListOutputsResult {
|
|
|
688
687
|
}
|
|
689
688
|
```
|
|
690
689
|
|
|
691
|
-
See also: [BEEF](
|
|
690
|
+
See also: [BEEF](#type-beef), [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletOutput](#interface-walletoutput)
|
|
692
691
|
|
|
693
692
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
694
693
|
|
|
@@ -705,7 +704,7 @@ export interface ProveCertificateArgs {
|
|
|
705
704
|
}
|
|
706
705
|
```
|
|
707
706
|
|
|
708
|
-
See also: [BooleanDefaultFalse](
|
|
707
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
709
708
|
|
|
710
709
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
711
710
|
|
|
@@ -720,7 +719,7 @@ export interface ProveCertificateResult {
|
|
|
720
719
|
}
|
|
721
720
|
```
|
|
722
721
|
|
|
723
|
-
See also: [Base64String](
|
|
722
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
724
723
|
|
|
725
724
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
726
725
|
|
|
@@ -735,7 +734,7 @@ export interface RelinquishCertificateArgs {
|
|
|
735
734
|
}
|
|
736
735
|
```
|
|
737
736
|
|
|
738
|
-
See also: [Base64String](
|
|
737
|
+
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
739
738
|
|
|
740
739
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
741
740
|
|
|
@@ -760,7 +759,7 @@ export interface RelinquishOutputArgs {
|
|
|
760
759
|
}
|
|
761
760
|
```
|
|
762
761
|
|
|
763
|
-
See also: [BasketStringUnder300Bytes](
|
|
762
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [OutpointString](#type-outpointstring)
|
|
764
763
|
|
|
765
764
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
766
765
|
|
|
@@ -787,7 +786,7 @@ export interface RevealCounterpartyKeyLinkageArgs {
|
|
|
787
786
|
}
|
|
788
787
|
```
|
|
789
788
|
|
|
790
|
-
See also: [BooleanDefaultFalse](
|
|
789
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex)
|
|
791
790
|
|
|
792
791
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
793
792
|
|
|
@@ -800,7 +799,7 @@ export interface RevealCounterpartyKeyLinkageResult extends KeyLinkageResult {
|
|
|
800
799
|
}
|
|
801
800
|
```
|
|
802
801
|
|
|
803
|
-
See also: [ISOTimestampString](
|
|
802
|
+
See also: [ISOTimestampString](#type-isotimestampstring), [KeyLinkageResult](#interface-keylinkageresult)
|
|
804
803
|
|
|
805
804
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
806
805
|
|
|
@@ -818,7 +817,7 @@ export interface RevealSpecificKeyLinkageArgs {
|
|
|
818
817
|
}
|
|
819
818
|
```
|
|
820
819
|
|
|
821
|
-
See also: [BooleanDefaultFalse](
|
|
820
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [PubKeyHex](#type-pubkeyhex), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
822
821
|
|
|
823
822
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
824
823
|
|
|
@@ -833,7 +832,7 @@ export interface RevealSpecificKeyLinkageResult extends KeyLinkageResult {
|
|
|
833
832
|
}
|
|
834
833
|
```
|
|
835
834
|
|
|
836
|
-
See also: [Byte](
|
|
835
|
+
See also: [Byte](#type-byte), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [KeyLinkageResult](#interface-keylinkageresult), [WalletProtocol](#type-walletprotocol)
|
|
837
836
|
|
|
838
837
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
839
838
|
|
|
@@ -849,7 +848,7 @@ export interface ReviewActionResult {
|
|
|
849
848
|
}
|
|
850
849
|
```
|
|
851
850
|
|
|
852
|
-
See also: [ReviewActionResultStatus](
|
|
851
|
+
See also: [ReviewActionResultStatus](#type-reviewactionresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
853
852
|
|
|
854
853
|
#### Property competingBeef
|
|
855
854
|
|
|
@@ -879,7 +878,7 @@ export interface SendWithResult {
|
|
|
879
878
|
}
|
|
880
879
|
```
|
|
881
880
|
|
|
882
|
-
See also: [SendWithResultStatus](
|
|
881
|
+
See also: [SendWithResultStatus](#type-sendwithresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
883
882
|
|
|
884
883
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
885
884
|
|
|
@@ -894,7 +893,7 @@ export interface SignActionArgs {
|
|
|
894
893
|
}
|
|
895
894
|
```
|
|
896
895
|
|
|
897
|
-
See also: [Base64String](
|
|
896
|
+
See also: [Base64String](#type-base64string), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SignActionOptions](#interface-signactionoptions), [SignActionSpend](#interface-signactionspend)
|
|
898
897
|
|
|
899
898
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
900
899
|
|
|
@@ -910,7 +909,7 @@ export interface SignActionOptions {
|
|
|
910
909
|
}
|
|
911
910
|
```
|
|
912
911
|
|
|
913
|
-
See also: [BooleanDefaultFalse](
|
|
912
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [TXIDHexString](#type-txidhexstring)
|
|
914
913
|
|
|
915
914
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
916
915
|
|
|
@@ -925,7 +924,7 @@ export interface SignActionResult {
|
|
|
925
924
|
}
|
|
926
925
|
```
|
|
927
926
|
|
|
928
|
-
See also: [AtomicBEEF](
|
|
927
|
+
See also: [AtomicBEEF](#type-atomicbeef), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
929
928
|
|
|
930
929
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
931
930
|
|
|
@@ -939,7 +938,7 @@ export interface SignActionSpend {
|
|
|
939
938
|
}
|
|
940
939
|
```
|
|
941
940
|
|
|
942
|
-
See also: [HexString](
|
|
941
|
+
See also: [HexString](#type-hexstring), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
943
942
|
|
|
944
943
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
945
944
|
|
|
@@ -953,7 +952,7 @@ export interface SignableTransaction {
|
|
|
953
952
|
}
|
|
954
953
|
```
|
|
955
954
|
|
|
956
|
-
See also: [AtomicBEEF](
|
|
955
|
+
See also: [AtomicBEEF](#type-atomicbeef), [Base64String](#type-base64string)
|
|
957
956
|
|
|
958
957
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
959
958
|
|
|
@@ -967,7 +966,7 @@ export interface VerifyHmacArgs extends WalletEncryptionArgs {
|
|
|
967
966
|
}
|
|
968
967
|
```
|
|
969
968
|
|
|
970
|
-
See also: [Byte](
|
|
969
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
971
970
|
|
|
972
971
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
973
972
|
|
|
@@ -994,7 +993,7 @@ export interface VerifySignatureArgs extends WalletEncryptionArgs {
|
|
|
994
993
|
}
|
|
995
994
|
```
|
|
996
995
|
|
|
997
|
-
See also: [BooleanDefaultFalse](
|
|
996
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
998
997
|
|
|
999
998
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1000
999
|
|
|
@@ -1027,7 +1026,7 @@ export interface WalletAction {
|
|
|
1027
1026
|
}
|
|
1028
1027
|
```
|
|
1029
1028
|
|
|
1030
|
-
See also: [ActionStatus](
|
|
1029
|
+
See also: [ActionStatus](#type-actionstatus), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue), [TXIDHexString](#type-txidhexstring), [WalletActionInput](#interface-walletactioninput), [WalletActionOutput](#interface-walletactionoutput)
|
|
1031
1030
|
|
|
1032
1031
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1033
1032
|
|
|
@@ -1045,7 +1044,7 @@ export interface WalletActionInput {
|
|
|
1045
1044
|
}
|
|
1046
1045
|
```
|
|
1047
1046
|
|
|
1048
|
-
See also: [DescriptionString5to50Bytes](
|
|
1047
|
+
See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1049
1048
|
|
|
1050
1049
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1051
1050
|
|
|
@@ -1065,7 +1064,7 @@ export interface WalletActionOutput {
|
|
|
1065
1064
|
}
|
|
1066
1065
|
```
|
|
1067
1066
|
|
|
1068
|
-
See also: [BasketStringUnder300Bytes](
|
|
1067
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1069
1068
|
|
|
1070
1069
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1071
1070
|
|
|
@@ -1084,7 +1083,7 @@ export interface WalletCertificate {
|
|
|
1084
1083
|
}
|
|
1085
1084
|
```
|
|
1086
1085
|
|
|
1087
|
-
See also: [Base64String](
|
|
1086
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
|
|
1088
1087
|
|
|
1089
1088
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1090
1089
|
|
|
@@ -1097,7 +1096,7 @@ export interface WalletDecryptArgs extends WalletEncryptionArgs {
|
|
|
1097
1096
|
}
|
|
1098
1097
|
```
|
|
1099
1098
|
|
|
1100
|
-
See also: [Byte](
|
|
1099
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1101
1100
|
|
|
1102
1101
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1103
1102
|
|
|
@@ -1110,7 +1109,7 @@ export interface WalletDecryptResult {
|
|
|
1110
1109
|
}
|
|
1111
1110
|
```
|
|
1112
1111
|
|
|
1113
|
-
See also: [Byte](
|
|
1112
|
+
See also: [Byte](#type-byte)
|
|
1114
1113
|
|
|
1115
1114
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1116
1115
|
|
|
@@ -1123,7 +1122,7 @@ export interface WalletEncryptArgs extends WalletEncryptionArgs {
|
|
|
1123
1122
|
}
|
|
1124
1123
|
```
|
|
1125
1124
|
|
|
1126
|
-
See also: [Byte](
|
|
1125
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1127
1126
|
|
|
1128
1127
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1129
1128
|
|
|
@@ -1136,7 +1135,7 @@ export interface WalletEncryptResult {
|
|
|
1136
1135
|
}
|
|
1137
1136
|
```
|
|
1138
1137
|
|
|
1139
|
-
See also: [Byte](
|
|
1138
|
+
See also: [Byte](#type-byte)
|
|
1140
1139
|
|
|
1141
1140
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1142
1141
|
|
|
@@ -1154,7 +1153,7 @@ export interface WalletEncryptionArgs {
|
|
|
1154
1153
|
}
|
|
1155
1154
|
```
|
|
1156
1155
|
|
|
1157
|
-
See also: [BooleanDefaultFalse](
|
|
1156
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
1158
1157
|
|
|
1159
1158
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1160
1159
|
|
|
@@ -1222,7 +1221,7 @@ export interface WalletInterface {
|
|
|
1222
1221
|
}
|
|
1223
1222
|
```
|
|
1224
1223
|
|
|
1225
|
-
See also: [AbortActionArgs](
|
|
1224
|
+
See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [AcquireCertificateArgs](#interface-acquirecertificateargs), [AuthenticatedResult](#interface-authenticatedresult), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [GetHeightResult](#interface-getheightresult), [GetNetworkResult](#interface-getnetworkresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [GetVersionResult](#interface-getversionresult), [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletCertificate](#interface-walletcertificate), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
|
|
1226
1225
|
|
|
1227
1226
|
#### Property abortAction
|
|
1228
1227
|
|
|
@@ -1231,7 +1230,7 @@ Aborts a transaction that is in progress and has not yet been finalized or sent
|
|
|
1231
1230
|
```ts
|
|
1232
1231
|
abortAction: (args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AbortActionResult>
|
|
1233
1232
|
```
|
|
1234
|
-
See also: [AbortActionArgs](
|
|
1233
|
+
See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1235
1234
|
|
|
1236
1235
|
#### Property acquireCertificate
|
|
1237
1236
|
|
|
@@ -1240,7 +1239,7 @@ Acquires an identity certificate, whether by acquiring one from the certifier or
|
|
|
1240
1239
|
```ts
|
|
1241
1240
|
acquireCertificate: (args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletCertificate>
|
|
1242
1241
|
```
|
|
1243
|
-
See also: [AcquireCertificateArgs](
|
|
1242
|
+
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletCertificate](#interface-walletcertificate)
|
|
1244
1243
|
|
|
1245
1244
|
#### Property createAction
|
|
1246
1245
|
|
|
@@ -1249,7 +1248,7 @@ Creates a new Bitcoin transaction based on the provided inputs, outputs, labels,
|
|
|
1249
1248
|
```ts
|
|
1250
1249
|
createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateActionResult>
|
|
1251
1250
|
```
|
|
1252
|
-
See also: [CreateActionArgs](
|
|
1251
|
+
See also: [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1253
1252
|
|
|
1254
1253
|
#### Property createHmac
|
|
1255
1254
|
|
|
@@ -1258,7 +1257,7 @@ Creates an HMAC (Hash-based Message Authentication Code) based on the provided d
|
|
|
1258
1257
|
```ts
|
|
1259
1258
|
createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
|
|
1260
1259
|
```
|
|
1261
|
-
See also: [CreateHmacArgs](
|
|
1260
|
+
See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1262
1261
|
|
|
1263
1262
|
#### Property createSignature
|
|
1264
1263
|
|
|
@@ -1267,7 +1266,7 @@ Creates a digital signature for the provided data or hash using a specific proto
|
|
|
1267
1266
|
```ts
|
|
1268
1267
|
createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
|
|
1269
1268
|
```
|
|
1270
|
-
See also: [CreateSignatureArgs](
|
|
1269
|
+
See also: [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1271
1270
|
|
|
1272
1271
|
#### Property decrypt
|
|
1273
1272
|
|
|
@@ -1276,7 +1275,7 @@ Decrypts the provided ciphertext using derived keys, based on the protocol ID, k
|
|
|
1276
1275
|
```ts
|
|
1277
1276
|
decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
|
|
1278
1277
|
```
|
|
1279
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1278
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult)
|
|
1280
1279
|
|
|
1281
1280
|
#### Property discoverByAttributes
|
|
1282
1281
|
|
|
@@ -1285,7 +1284,7 @@ Discovers identity certificates belonging to other users, where the documents co
|
|
|
1285
1284
|
```ts
|
|
1286
1285
|
discoverByAttributes: (args: DiscoverByAttributesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1287
1286
|
```
|
|
1288
|
-
See also: [DiscoverByAttributesArgs](
|
|
1287
|
+
See also: [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1289
1288
|
|
|
1290
1289
|
#### Property discoverByIdentityKey
|
|
1291
1290
|
|
|
@@ -1294,7 +1293,7 @@ Discovers identity certificates, issued to a given identity key by a trusted ent
|
|
|
1294
1293
|
```ts
|
|
1295
1294
|
discoverByIdentityKey: (args: DiscoverByIdentityKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1296
1295
|
```
|
|
1297
|
-
See also: [DiscoverByIdentityKeyArgs](
|
|
1296
|
+
See also: [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1298
1297
|
|
|
1299
1298
|
#### Property encrypt
|
|
1300
1299
|
|
|
@@ -1303,7 +1302,7 @@ Encrypts the provided plaintext data using derived keys, based on the protocol I
|
|
|
1303
1302
|
```ts
|
|
1304
1303
|
encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
|
|
1305
1304
|
```
|
|
1306
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1305
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
|
|
1307
1306
|
|
|
1308
1307
|
#### Property getHeaderForHeight
|
|
1309
1308
|
|
|
@@ -1312,7 +1311,7 @@ Retrieves the block header of a block at a specified height.
|
|
|
1312
1311
|
```ts
|
|
1313
1312
|
getHeaderForHeight: (args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeaderResult>
|
|
1314
1313
|
```
|
|
1315
|
-
See also: [GetHeaderArgs](
|
|
1314
|
+
See also: [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1316
1315
|
|
|
1317
1316
|
#### Property getHeight
|
|
1318
1317
|
|
|
@@ -1321,7 +1320,7 @@ Retrieves the current height of the blockchain.
|
|
|
1321
1320
|
```ts
|
|
1322
1321
|
getHeight: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeightResult>
|
|
1323
1322
|
```
|
|
1324
|
-
See also: [GetHeightResult](
|
|
1323
|
+
See also: [GetHeightResult](#interface-getheightresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1325
1324
|
|
|
1326
1325
|
#### Property getNetwork
|
|
1327
1326
|
|
|
@@ -1330,7 +1329,7 @@ Retrieves the Bitcoin network the client is using (mainnet or testnet).
|
|
|
1330
1329
|
```ts
|
|
1331
1330
|
getNetwork: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetNetworkResult>
|
|
1332
1331
|
```
|
|
1333
|
-
See also: [GetNetworkResult](
|
|
1332
|
+
See also: [GetNetworkResult](#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1334
1333
|
|
|
1335
1334
|
#### Property getPublicKey
|
|
1336
1335
|
|
|
@@ -1339,7 +1338,7 @@ Retrieves a derived or identity public key based on the requested protocol, key
|
|
|
1339
1338
|
```ts
|
|
1340
1339
|
getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
|
|
1341
1340
|
```
|
|
1342
|
-
See also: [GetPublicKeyArgs](
|
|
1341
|
+
See also: [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1343
1342
|
|
|
1344
1343
|
#### Property getVersion
|
|
1345
1344
|
|
|
@@ -1348,7 +1347,7 @@ Retrieves the current version string of the wallet.
|
|
|
1348
1347
|
```ts
|
|
1349
1348
|
getVersion: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetVersionResult>
|
|
1350
1349
|
```
|
|
1351
|
-
See also: [GetVersionResult](
|
|
1350
|
+
See also: [GetVersionResult](#interface-getversionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1352
1351
|
|
|
1353
1352
|
#### Property internalizeAction
|
|
1354
1353
|
|
|
@@ -1357,7 +1356,7 @@ Submits a transaction to be internalized and optionally labeled, outputs paid to
|
|
|
1357
1356
|
```ts
|
|
1358
1357
|
internalizeAction: (args: InternalizeActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<InternalizeActionResult>
|
|
1359
1358
|
```
|
|
1360
|
-
See also: [InternalizeActionArgs](
|
|
1359
|
+
See also: [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1361
1360
|
|
|
1362
1361
|
#### Property isAuthenticated
|
|
1363
1362
|
|
|
@@ -1366,7 +1365,7 @@ Checks the authentication status of the user.
|
|
|
1366
1365
|
```ts
|
|
1367
1366
|
isAuthenticated: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1368
1367
|
```
|
|
1369
|
-
See also: [AuthenticatedResult](
|
|
1368
|
+
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1370
1369
|
|
|
1371
1370
|
#### Property listActions
|
|
1372
1371
|
|
|
@@ -1375,7 +1374,7 @@ Lists all transactions matching the specified labels.
|
|
|
1375
1374
|
```ts
|
|
1376
1375
|
listActions: (args: ListActionsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListActionsResult>
|
|
1377
1376
|
```
|
|
1378
|
-
See also: [ListActionsArgs](
|
|
1377
|
+
See also: [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1379
1378
|
|
|
1380
1379
|
#### Property listCertificates
|
|
1381
1380
|
|
|
@@ -1384,7 +1383,7 @@ Lists identity certificates belonging to the user, filtered by certifier(s) and
|
|
|
1384
1383
|
```ts
|
|
1385
1384
|
listCertificates: (args: ListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListCertificatesResult>
|
|
1386
1385
|
```
|
|
1387
|
-
See also: [ListCertificatesArgs](
|
|
1386
|
+
See also: [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1388
1387
|
|
|
1389
1388
|
#### Property listOutputs
|
|
1390
1389
|
|
|
@@ -1393,7 +1392,7 @@ Lists the spendable outputs kept within a specific basket, optionally tagged wit
|
|
|
1393
1392
|
```ts
|
|
1394
1393
|
listOutputs: (args: ListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListOutputsResult>
|
|
1395
1394
|
```
|
|
1396
|
-
See also: [ListOutputsArgs](
|
|
1395
|
+
See also: [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1397
1396
|
|
|
1398
1397
|
#### Property proveCertificate
|
|
1399
1398
|
|
|
@@ -1402,7 +1401,7 @@ Proves select fields of an identity certificate, as specified, when requested by
|
|
|
1402
1401
|
```ts
|
|
1403
1402
|
proveCertificate: (args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ProveCertificateResult>
|
|
1404
1403
|
```
|
|
1405
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1404
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult)
|
|
1406
1405
|
|
|
1407
1406
|
#### Property relinquishCertificate
|
|
1408
1407
|
|
|
@@ -1411,7 +1410,7 @@ Relinquishes an identity certificate, removing it from the wallet regardless of
|
|
|
1411
1410
|
```ts
|
|
1412
1411
|
relinquishCertificate: (args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishCertificateResult>
|
|
1413
1412
|
```
|
|
1414
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1413
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult)
|
|
1415
1414
|
|
|
1416
1415
|
#### Property relinquishOutput
|
|
1417
1416
|
|
|
@@ -1420,7 +1419,7 @@ Relinquish an output out of a basket, removing it from tracking without spending
|
|
|
1420
1419
|
```ts
|
|
1421
1420
|
relinquishOutput: (args: RelinquishOutputArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishOutputResult>
|
|
1422
1421
|
```
|
|
1423
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1422
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult)
|
|
1424
1423
|
|
|
1425
1424
|
#### Property revealCounterpartyKeyLinkage
|
|
1426
1425
|
|
|
@@ -1429,7 +1428,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1429
1428
|
```ts
|
|
1430
1429
|
revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
|
|
1431
1430
|
```
|
|
1432
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1431
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult)
|
|
1433
1432
|
|
|
1434
1433
|
#### Property revealSpecificKeyLinkage
|
|
1435
1434
|
|
|
@@ -1438,7 +1437,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1438
1437
|
```ts
|
|
1439
1438
|
revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
|
|
1440
1439
|
```
|
|
1441
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1440
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult)
|
|
1442
1441
|
|
|
1443
1442
|
#### Property signAction
|
|
1444
1443
|
|
|
@@ -1447,7 +1446,7 @@ Signs a transaction previously created using `createAction`.
|
|
|
1447
1446
|
```ts
|
|
1448
1447
|
signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
|
|
1449
1448
|
```
|
|
1450
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1449
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
|
|
1451
1450
|
|
|
1452
1451
|
#### Property verifyHmac
|
|
1453
1452
|
|
|
@@ -1456,7 +1455,7 @@ Verifies an HMAC (Hash-based Message Authentication Code) based on the provided
|
|
|
1456
1455
|
```ts
|
|
1457
1456
|
verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
|
|
1458
1457
|
```
|
|
1459
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1458
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult)
|
|
1460
1459
|
|
|
1461
1460
|
#### Property verifySignature
|
|
1462
1461
|
|
|
@@ -1465,7 +1464,7 @@ Verifies a digital signature for the provided data or hash using a specific prot
|
|
|
1465
1464
|
```ts
|
|
1466
1465
|
verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
|
|
1467
1466
|
```
|
|
1468
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1467
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult)
|
|
1469
1468
|
|
|
1470
1469
|
#### Property waitForAuthentication
|
|
1471
1470
|
|
|
@@ -1474,7 +1473,7 @@ Continuously waits until the user is authenticated, returning the result once co
|
|
|
1474
1473
|
```ts
|
|
1475
1474
|
waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1476
1475
|
```
|
|
1477
|
-
See also: [AuthenticatedResult](
|
|
1476
|
+
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1478
1477
|
|
|
1479
1478
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1480
1479
|
|
|
@@ -1493,7 +1492,7 @@ export interface WalletOutput {
|
|
|
1493
1492
|
}
|
|
1494
1493
|
```
|
|
1495
1494
|
|
|
1496
|
-
See also: [HexString](
|
|
1495
|
+
See also: [HexString](#type-hexstring), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [SatoshiValue](#type-satoshivalue)
|
|
1497
1496
|
|
|
1498
1497
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1499
1498
|
|
|
@@ -1508,7 +1507,7 @@ export interface WalletPayment {
|
|
|
1508
1507
|
}
|
|
1509
1508
|
```
|
|
1510
1509
|
|
|
1511
|
-
See also: [Base64String](
|
|
1510
|
+
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
1512
1511
|
|
|
1513
1512
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1514
1513
|
|
|
@@ -1563,7 +1562,7 @@ export default class CachedKeyDeriver implements KeyDeriverApi {
|
|
|
1563
1562
|
}
|
|
1564
1563
|
```
|
|
1565
1564
|
|
|
1566
|
-
See also: [Counterparty](
|
|
1565
|
+
See also: [Counterparty](#type-counterparty), [KeyDeriverApi](#interface-keyderiverapi), [WalletProtocol](#type-walletprotocol)
|
|
1567
1566
|
|
|
1568
1567
|
#### Constructor
|
|
1569
1568
|
|
|
@@ -1574,7 +1573,6 @@ constructor(rootKey: PrivateKey | "anyone", options?: {
|
|
|
1574
1573
|
maxCacheSize?: number;
|
|
1575
1574
|
})
|
|
1576
1575
|
```
|
|
1577
|
-
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1578
1576
|
|
|
1579
1577
|
Argument Details
|
|
1580
1578
|
|
|
@@ -1598,7 +1596,6 @@ The root key from which all other keys are derived.
|
|
|
1598
1596
|
```ts
|
|
1599
1597
|
rootKey: PrivateKey
|
|
1600
1598
|
```
|
|
1601
|
-
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1602
1599
|
|
|
1603
1600
|
#### Method derivePrivateKey
|
|
1604
1601
|
|
|
@@ -1608,7 +1605,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1608
1605
|
```ts
|
|
1609
1606
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
1610
1607
|
```
|
|
1611
|
-
See also: [Counterparty](
|
|
1608
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1612
1609
|
|
|
1613
1610
|
Returns
|
|
1614
1611
|
|
|
@@ -1631,7 +1628,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1631
1628
|
```ts
|
|
1632
1629
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
1633
1630
|
```
|
|
1634
|
-
See also: [Counterparty](
|
|
1631
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1635
1632
|
|
|
1636
1633
|
Returns
|
|
1637
1634
|
|
|
@@ -1656,7 +1653,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1656
1653
|
```ts
|
|
1657
1654
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
1658
1655
|
```
|
|
1659
|
-
See also: [Counterparty](
|
|
1656
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1660
1657
|
|
|
1661
1658
|
Returns
|
|
1662
1659
|
|
|
@@ -1683,7 +1680,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1683
1680
|
```ts
|
|
1684
1681
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
1685
1682
|
```
|
|
1686
|
-
See also: [Counterparty](
|
|
1683
|
+
See also: [Counterparty](#type-counterparty)
|
|
1687
1684
|
|
|
1688
1685
|
Returns
|
|
1689
1686
|
|
|
@@ -1706,7 +1703,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1706
1703
|
```ts
|
|
1707
1704
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
1708
1705
|
```
|
|
1709
|
-
See also: [Counterparty](
|
|
1706
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1710
1707
|
|
|
1711
1708
|
Returns
|
|
1712
1709
|
|
|
@@ -1943,7 +1940,7 @@ export default class HTTPWalletJSON implements WalletInterface {
|
|
|
1943
1940
|
}
|
|
1944
1941
|
```
|
|
1945
1942
|
|
|
1946
|
-
See also: [AcquireCertificateArgs](
|
|
1943
|
+
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#type-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface)
|
|
1947
1944
|
|
|
1948
1945
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1949
1946
|
|
|
@@ -1960,7 +1957,7 @@ export default class HTTPWalletWire implements WalletWire {
|
|
|
1960
1957
|
}
|
|
1961
1958
|
```
|
|
1962
1959
|
|
|
1963
|
-
See also: [WalletWire](
|
|
1960
|
+
See also: [WalletWire](#interface-walletwire)
|
|
1964
1961
|
|
|
1965
1962
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1966
1963
|
|
|
@@ -1983,7 +1980,7 @@ export class KeyDeriver implements KeyDeriverApi {
|
|
|
1983
1980
|
}
|
|
1984
1981
|
```
|
|
1985
1982
|
|
|
1986
|
-
See also: [Counterparty](
|
|
1983
|
+
See also: [Counterparty](#type-counterparty), [KeyDeriverApi](#interface-keyderiverapi), [WalletProtocol](#type-walletprotocol)
|
|
1987
1984
|
|
|
1988
1985
|
#### Constructor
|
|
1989
1986
|
|
|
@@ -1992,7 +1989,6 @@ Initializes the KeyDeriver instance with a root private key.
|
|
|
1992
1989
|
```ts
|
|
1993
1990
|
constructor(rootKey: PrivateKey | "anyone", private readonly cacheSharedSecret?: ((priv: PrivateKey, pub: Point, point: Point) => void), private readonly retrieveCachedSharedSecret?: ((priv: PrivateKey, pub: Point) => (Point | undefined)))
|
|
1994
1991
|
```
|
|
1995
|
-
See also: [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey)
|
|
1996
1992
|
|
|
1997
1993
|
Argument Details
|
|
1998
1994
|
|
|
@@ -2006,7 +2002,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
2006
2002
|
```ts
|
|
2007
2003
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
2008
2004
|
```
|
|
2009
|
-
See also: [Counterparty](
|
|
2005
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2010
2006
|
|
|
2011
2007
|
Returns
|
|
2012
2008
|
|
|
@@ -2028,7 +2024,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
2028
2024
|
```ts
|
|
2029
2025
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
2030
2026
|
```
|
|
2031
|
-
See also: [Counterparty](
|
|
2027
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2032
2028
|
|
|
2033
2029
|
Returns
|
|
2034
2030
|
|
|
@@ -2053,7 +2049,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
2053
2049
|
```ts
|
|
2054
2050
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
2055
2051
|
```
|
|
2056
|
-
See also: [Counterparty](
|
|
2052
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2057
2053
|
|
|
2058
2054
|
Returns
|
|
2059
2055
|
|
|
@@ -2076,7 +2072,7 @@ Note: This should not be used for 'self'.
|
|
|
2076
2072
|
```ts
|
|
2077
2073
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
2078
2074
|
```
|
|
2079
|
-
See also: [Counterparty](
|
|
2075
|
+
See also: [Counterparty](#type-counterparty)
|
|
2080
2076
|
|
|
2081
2077
|
Returns
|
|
2082
2078
|
|
|
@@ -2098,7 +2094,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
2098
2094
|
```ts
|
|
2099
2095
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
2100
2096
|
```
|
|
2101
|
-
See also: [Counterparty](
|
|
2097
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2102
2098
|
|
|
2103
2099
|
Returns
|
|
2104
2100
|
|
|
@@ -2142,7 +2138,7 @@ export class ProtoWallet {
|
|
|
2142
2138
|
}
|
|
2143
2139
|
```
|
|
2144
2140
|
|
|
2145
|
-
See also: [CreateHmacArgs](
|
|
2141
|
+
See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [KeyDeriverApi](#interface-keyderiverapi), [PubKeyHex](#type-pubkeyhex), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
|
|
2146
2142
|
|
|
2147
2143
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2148
2144
|
|
|
@@ -2586,7 +2582,7 @@ export default class ReactNativeWebView implements WalletInterface {
|
|
|
2586
2582
|
}
|
|
2587
2583
|
```
|
|
2588
2584
|
|
|
2589
|
-
See also: [BEEF](
|
|
2585
|
+
See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CallType](#type-calltype), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface)
|
|
2590
2586
|
|
|
2591
2587
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2592
2588
|
|
|
@@ -2605,7 +2601,7 @@ export class WERR_REVIEW_ACTIONS extends Error {
|
|
|
2605
2601
|
}
|
|
2606
2602
|
```
|
|
2607
2603
|
|
|
2608
|
-
See also: [AtomicBEEF](
|
|
2604
|
+
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [ReviewActionResult](#interface-reviewactionresult), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
2609
2605
|
|
|
2610
2606
|
#### Constructor
|
|
2611
2607
|
|
|
@@ -2616,7 +2612,7 @@ which contains more details, particularly for double spend results.
|
|
|
2616
2612
|
```ts
|
|
2617
2613
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
2618
2614
|
```
|
|
2619
|
-
See also: [AtomicBEEF](
|
|
2615
|
+
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [ReviewActionResult](#interface-reviewactionresult), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
2620
2616
|
|
|
2621
2617
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2622
2618
|
|
|
@@ -2830,7 +2826,7 @@ export default class WalletClient implements WalletInterface {
|
|
|
2830
2826
|
}
|
|
2831
2827
|
```
|
|
2832
2828
|
|
|
2833
|
-
See also: [AcquireCertificateArgs](
|
|
2829
|
+
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#type-acquirecertificateresult), [AuthenticatedResult](#interface-authenticatedresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface)
|
|
2834
2830
|
|
|
2835
2831
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2836
2832
|
|
|
@@ -2860,7 +2856,7 @@ export default class WalletWireProcessor implements WalletWire {
|
|
|
2860
2856
|
}
|
|
2861
2857
|
```
|
|
2862
2858
|
|
|
2863
|
-
See also: [WalletInterface](
|
|
2859
|
+
See also: [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire)
|
|
2864
2860
|
|
|
2865
2861
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2866
2862
|
|
|
@@ -3083,7 +3079,7 @@ export default class WalletWireTransceiver implements WalletInterface {
|
|
|
3083
3079
|
}
|
|
3084
3080
|
```
|
|
3085
3081
|
|
|
3086
|
-
See also: [AcquireCertificateArgs](
|
|
3082
|
+
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [AcquireCertificateResult](#type-acquirecertificateresult), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [InternalizeActionArgs](#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [ListCertificatesResult](#interface-listcertificatesresult), [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult), [PubKeyHex](#type-pubkeyhex), [SecurityLevel](#type-securitylevel), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire)
|
|
3087
3083
|
|
|
3088
3084
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3089
3085
|
|
|
@@ -3526,7 +3522,7 @@ export default class WindowCWISubstrate implements WalletInterface {
|
|
|
3526
3522
|
}
|
|
3527
3523
|
```
|
|
3528
3524
|
|
|
3529
|
-
See also: [BEEF](
|
|
3525
|
+
See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface)
|
|
3530
3526
|
|
|
3531
3527
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3532
3528
|
|
|
@@ -3970,7 +3966,7 @@ export default class XDMSubstrate implements WalletInterface {
|
|
|
3970
3966
|
}
|
|
3971
3967
|
```
|
|
3972
3968
|
|
|
3973
|
-
See also: [BEEF](
|
|
3969
|
+
See also: [BEEF](#type-beef), [Base64String](#type-base64string), [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [Byte](#type-byte), [CallType](#type-calltype), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [HexString](#type-hexstring), [ISOTimestampString](#type-isotimestampstring), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveInteger](#type-positiveinteger), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](#type-positiveintegermax10), [PositiveIntegerOrZero](#type-positiveintegerorzero), [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [PubKeyHex](#type-pubkeyhex), [SatoshiValue](#type-satoshivalue), [SecurityLevel](#type-securitylevel), [TXIDHexString](#type-txidhexstring), [VersionString7To30Bytes](#type-versionstring7to30bytes), [WalletInterface](#interface-walletinterface)
|
|
3974
3970
|
|
|
3975
3971
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3976
3972
|
|
|
@@ -4016,7 +4012,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4016
4012
|
export type AcquireCertificateResult = WalletCertificate
|
|
4017
4013
|
```
|
|
4018
4014
|
|
|
4019
|
-
See also: [WalletCertificate](
|
|
4015
|
+
See also: [WalletCertificate](#interface-walletcertificate)
|
|
4020
4016
|
|
|
4021
4017
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4022
4018
|
|
|
@@ -4045,7 +4041,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4045
4041
|
export type AtomicBEEF = Byte[]
|
|
4046
4042
|
```
|
|
4047
4043
|
|
|
4048
|
-
See also: [Byte](
|
|
4044
|
+
See also: [Byte](#type-byte)
|
|
4049
4045
|
|
|
4050
4046
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4051
4047
|
|
|
@@ -4056,7 +4052,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4056
4052
|
export type BEEF = Byte[]
|
|
4057
4053
|
```
|
|
4058
4054
|
|
|
4059
|
-
See also: [Byte](
|
|
4055
|
+
See also: [Byte](#type-byte)
|
|
4060
4056
|
|
|
4061
4057
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4062
4058
|
|
|
@@ -4130,7 +4126,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4130
4126
|
export type Counterparty = PublicKey | PubKeyHex | "self" | "anyone"
|
|
4131
4127
|
```
|
|
4132
4128
|
|
|
4133
|
-
See also: [PubKeyHex](
|
|
4129
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
4134
4130
|
|
|
4135
4131
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4136
4132
|
|
|
@@ -4213,7 +4209,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4213
4209
|
export type KeyringRevealer = PubKeyHex | "certifier"
|
|
4214
4210
|
```
|
|
4215
4211
|
|
|
4216
|
-
See also: [PubKeyHex](
|
|
4212
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
4217
4213
|
|
|
4218
4214
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4219
4215
|
|
|
@@ -4305,7 +4301,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4305
4301
|
export type PubKeyHex = HexString
|
|
4306
4302
|
```
|
|
4307
4303
|
|
|
4308
|
-
See also: [HexString](
|
|
4304
|
+
See also: [HexString](#type-hexstring)
|
|
4309
4305
|
|
|
4310
4306
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4311
4307
|
|
|
@@ -4366,7 +4362,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4366
4362
|
export type TXIDHexString = HexString
|
|
4367
4363
|
```
|
|
4368
4364
|
|
|
4369
|
-
See also: [HexString](
|
|
4365
|
+
See also: [HexString](#type-hexstring)
|
|
4370
4366
|
|
|
4371
4367
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4372
4368
|
|
|
@@ -4401,7 +4397,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4401
4397
|
export type WalletCounterparty = PubKeyHex | "self" | "anyone"
|
|
4402
4398
|
```
|
|
4403
4399
|
|
|
4404
|
-
See also: [PubKeyHex](
|
|
4400
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
4405
4401
|
|
|
4406
4402
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4407
4403
|
|
|
@@ -4412,7 +4408,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
4412
4408
|
export type WalletErrorCode = keyof typeof walletErrors
|
|
4413
4409
|
```
|
|
4414
4410
|
|
|
4415
|
-
See also: [walletErrors](
|
|
4411
|
+
See also: [walletErrors](#enum-walleterrors)
|
|
4416
4412
|
|
|
4417
4413
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4418
4414
|
|
|
@@ -4435,7 +4431,7 @@ export type WalletProtocol = [
|
|
|
4435
4431
|
]
|
|
4436
4432
|
```
|
|
4437
4433
|
|
|
4438
|
-
See also: [ProtocolString5To400Bytes](
|
|
4434
|
+
See also: [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [SecurityLevel](#type-securitylevel)
|
|
4439
4435
|
|
|
4440
4436
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4441
4437
|
|
|
@@ -4461,7 +4457,7 @@ export enum SecurityLevels {
|
|
|
4461
4457
|
}
|
|
4462
4458
|
```
|
|
4463
4459
|
|
|
4464
|
-
See also: [Counterparty](
|
|
4460
|
+
See also: [Counterparty](#type-counterparty)
|
|
4465
4461
|
|
|
4466
4462
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4467
4463
|
|