@bsv/sdk 1.4.23 → 1.4.24
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/transaction/broadcasters/Teranode.js +64 -0
- package/dist/cjs/src/transaction/broadcasters/Teranode.js.map +1 -0
- package/dist/cjs/src/transaction/broadcasters/index.js +3 -1
- package/dist/cjs/src/transaction/broadcasters/index.js.map +1 -1
- package/dist/cjs/src/transaction/http/BinaryFetchClient.js +94 -0
- package/dist/cjs/src/transaction/http/BinaryFetchClient.js.map +1 -0
- package/dist/cjs/src/transaction/http/NodejsHttpClient.js.map +1 -1
- package/dist/cjs/src/transaction/http/index.js +3 -1
- package/dist/cjs/src/transaction/http/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/transaction/broadcasters/Teranode.js +62 -0
- package/dist/esm/src/transaction/broadcasters/Teranode.js.map +1 -0
- package/dist/esm/src/transaction/broadcasters/index.js +1 -0
- package/dist/esm/src/transaction/broadcasters/index.js.map +1 -1
- package/dist/esm/src/transaction/http/BinaryFetchClient.js +90 -0
- package/dist/esm/src/transaction/http/BinaryFetchClient.js.map +1 -0
- package/dist/esm/src/transaction/http/NodejsHttpClient.js.map +1 -1
- package/dist/esm/src/transaction/http/index.js +1 -0
- package/dist/esm/src/transaction/http/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/transaction/broadcasters/Teranode.d.ts +25 -0
- package/dist/types/src/transaction/broadcasters/Teranode.d.ts.map +1 -0
- package/dist/types/src/transaction/broadcasters/index.d.ts +1 -0
- package/dist/types/src/transaction/broadcasters/index.d.ts.map +1 -1
- package/dist/types/src/transaction/http/BinaryFetchClient.d.ts +50 -0
- package/dist/types/src/transaction/http/BinaryFetchClient.d.ts.map +1 -0
- package/dist/types/src/transaction/http/index.d.ts +1 -0
- package/dist/types/src/transaction/http/index.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +1 -1
- package/docs/auth.md +101 -47
- package/docs/compat.md +48 -24
- package/docs/identity.md +14 -8
- package/docs/kvstore.md +9 -3
- package/docs/messages.md +4 -4
- package/docs/overlay-tools.md +69 -21
- package/docs/primitives.md +379 -235
- package/docs/registry.md +20 -14
- package/docs/script.md +80 -32
- package/docs/storage.md +17 -11
- package/docs/totp.md +11 -5
- package/docs/transaction.md +144 -66
- package/docs/wallet.md +169 -133
- package/package.json +1 -1
- package/src/transaction/broadcasters/Teranode.ts +77 -0
- package/src/transaction/broadcasters/index.ts +1 -0
- package/src/transaction/http/BinaryFetchClient.ts +141 -0
- package/src/transaction/http/NodejsHttpClient.ts +1 -1
- package/src/transaction/http/index.ts +1 -0
package/docs/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,11 @@ export interface KeyDeriverApi {
|
|
|
501
501
|
}
|
|
502
502
|
```
|
|
503
503
|
|
|
504
|
-
See also: [Counterparty](
|
|
504
|
+
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
505
|
+
|
|
506
|
+
<details>
|
|
507
|
+
|
|
508
|
+
<summary>Interface KeyDeriverApi Details</summary>
|
|
505
509
|
|
|
506
510
|
#### Property derivePrivateKey
|
|
507
511
|
|
|
@@ -510,7 +514,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
510
514
|
```ts
|
|
511
515
|
derivePrivateKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => PrivateKey
|
|
512
516
|
```
|
|
513
|
-
See also: [Counterparty](
|
|
517
|
+
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
514
518
|
|
|
515
519
|
#### Property derivePublicKey
|
|
516
520
|
|
|
@@ -519,7 +523,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
519
523
|
```ts
|
|
520
524
|
derivePublicKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean) => PublicKey
|
|
521
525
|
```
|
|
522
|
-
See also: [Counterparty](
|
|
526
|
+
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
523
527
|
|
|
524
528
|
#### Property deriveSymmetricKey
|
|
525
529
|
|
|
@@ -529,7 +533,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
529
533
|
```ts
|
|
530
534
|
deriveSymmetricKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => SymmetricKey
|
|
531
535
|
```
|
|
532
|
-
See also: [Counterparty](
|
|
536
|
+
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
533
537
|
|
|
534
538
|
#### Property identityKey
|
|
535
539
|
|
|
@@ -547,7 +551,7 @@ Note: This should not be used for 'self'.
|
|
|
547
551
|
```ts
|
|
548
552
|
revealCounterpartySecret: (counterparty: Counterparty) => number[]
|
|
549
553
|
```
|
|
550
|
-
See also: [Counterparty](
|
|
554
|
+
See also: [Counterparty](#type-counterparty)
|
|
551
555
|
|
|
552
556
|
#### Property revealSpecificSecret
|
|
553
557
|
|
|
@@ -556,7 +560,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
556
560
|
```ts
|
|
557
561
|
revealSpecificSecret: (counterparty: Counterparty, protocolID: WalletProtocol, keyID: string) => number[]
|
|
558
562
|
```
|
|
559
|
-
See also: [Counterparty](
|
|
563
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
560
564
|
|
|
561
565
|
#### Property rootKey
|
|
562
566
|
|
|
@@ -565,7 +569,9 @@ The root key from which all other keys are derived.
|
|
|
565
569
|
```ts
|
|
566
570
|
rootKey: PrivateKey
|
|
567
571
|
```
|
|
568
|
-
See also: [PrivateKey](
|
|
572
|
+
See also: [PrivateKey](#class-privatekey)
|
|
573
|
+
|
|
574
|
+
</details>
|
|
569
575
|
|
|
570
576
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
571
577
|
|
|
@@ -582,7 +588,7 @@ export interface KeyLinkageResult {
|
|
|
582
588
|
}
|
|
583
589
|
```
|
|
584
590
|
|
|
585
|
-
See also: [Byte](
|
|
591
|
+
See also: [Byte](#type-byte), [PubKeyHex](#type-pubkeyhex)
|
|
586
592
|
|
|
587
593
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
588
594
|
|
|
@@ -605,7 +611,7 @@ export interface ListActionsArgs {
|
|
|
605
611
|
}
|
|
606
612
|
```
|
|
607
613
|
|
|
608
|
-
See also: [BooleanDefaultFalse](
|
|
614
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
609
615
|
|
|
610
616
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
611
617
|
|
|
@@ -619,7 +625,7 @@ export interface ListActionsResult {
|
|
|
619
625
|
}
|
|
620
626
|
```
|
|
621
627
|
|
|
622
|
-
See also: [PositiveIntegerOrZero](
|
|
628
|
+
See also: [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletAction](#interface-walletaction)
|
|
623
629
|
|
|
624
630
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
625
631
|
|
|
@@ -637,7 +643,7 @@ export interface ListCertificatesArgs {
|
|
|
637
643
|
}
|
|
638
644
|
```
|
|
639
645
|
|
|
640
|
-
See also: [Base64String](
|
|
646
|
+
See also: [Base64String](#type-base64string), [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [PubKeyHex](#type-pubkeyhex)
|
|
641
647
|
|
|
642
648
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
643
649
|
|
|
@@ -651,7 +657,7 @@ export interface ListCertificatesResult {
|
|
|
651
657
|
}
|
|
652
658
|
```
|
|
653
659
|
|
|
654
|
-
See also: [CertificateResult](
|
|
660
|
+
See also: [CertificateResult](#interface-certificateresult), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
655
661
|
|
|
656
662
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
657
663
|
|
|
@@ -673,7 +679,7 @@ export interface ListOutputsArgs {
|
|
|
673
679
|
}
|
|
674
680
|
```
|
|
675
681
|
|
|
676
|
-
See also: [BasketStringUnder300Bytes](
|
|
682
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
677
683
|
|
|
678
684
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
679
685
|
|
|
@@ -688,7 +694,7 @@ export interface ListOutputsResult {
|
|
|
688
694
|
}
|
|
689
695
|
```
|
|
690
696
|
|
|
691
|
-
See also: [BEEF](
|
|
697
|
+
See also: [BEEF](#type-beef), [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletOutput](#interface-walletoutput)
|
|
692
698
|
|
|
693
699
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
694
700
|
|
|
@@ -705,7 +711,7 @@ export interface ProveCertificateArgs {
|
|
|
705
711
|
}
|
|
706
712
|
```
|
|
707
713
|
|
|
708
|
-
See also: [BooleanDefaultFalse](
|
|
714
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
709
715
|
|
|
710
716
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
711
717
|
|
|
@@ -720,7 +726,7 @@ export interface ProveCertificateResult {
|
|
|
720
726
|
}
|
|
721
727
|
```
|
|
722
728
|
|
|
723
|
-
See also: [Base64String](
|
|
729
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
724
730
|
|
|
725
731
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
726
732
|
|
|
@@ -735,7 +741,7 @@ export interface RelinquishCertificateArgs {
|
|
|
735
741
|
}
|
|
736
742
|
```
|
|
737
743
|
|
|
738
|
-
See also: [Base64String](
|
|
744
|
+
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
739
745
|
|
|
740
746
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
741
747
|
|
|
@@ -760,7 +766,7 @@ export interface RelinquishOutputArgs {
|
|
|
760
766
|
}
|
|
761
767
|
```
|
|
762
768
|
|
|
763
|
-
See also: [BasketStringUnder300Bytes](
|
|
769
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [OutpointString](#type-outpointstring)
|
|
764
770
|
|
|
765
771
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
766
772
|
|
|
@@ -787,7 +793,7 @@ export interface RevealCounterpartyKeyLinkageArgs {
|
|
|
787
793
|
}
|
|
788
794
|
```
|
|
789
795
|
|
|
790
|
-
See also: [BooleanDefaultFalse](
|
|
796
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex)
|
|
791
797
|
|
|
792
798
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
793
799
|
|
|
@@ -800,7 +806,7 @@ export interface RevealCounterpartyKeyLinkageResult extends KeyLinkageResult {
|
|
|
800
806
|
}
|
|
801
807
|
```
|
|
802
808
|
|
|
803
|
-
See also: [ISOTimestampString](
|
|
809
|
+
See also: [ISOTimestampString](#type-isotimestampstring), [KeyLinkageResult](#interface-keylinkageresult)
|
|
804
810
|
|
|
805
811
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
806
812
|
|
|
@@ -818,7 +824,7 @@ export interface RevealSpecificKeyLinkageArgs {
|
|
|
818
824
|
}
|
|
819
825
|
```
|
|
820
826
|
|
|
821
|
-
See also: [BooleanDefaultFalse](
|
|
827
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [PubKeyHex](#type-pubkeyhex), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
822
828
|
|
|
823
829
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
824
830
|
|
|
@@ -833,7 +839,7 @@ export interface RevealSpecificKeyLinkageResult extends KeyLinkageResult {
|
|
|
833
839
|
}
|
|
834
840
|
```
|
|
835
841
|
|
|
836
|
-
See also: [Byte](
|
|
842
|
+
See also: [Byte](#type-byte), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [KeyLinkageResult](#interface-keylinkageresult), [WalletProtocol](#type-walletprotocol)
|
|
837
843
|
|
|
838
844
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
839
845
|
|
|
@@ -849,7 +855,11 @@ export interface ReviewActionResult {
|
|
|
849
855
|
}
|
|
850
856
|
```
|
|
851
857
|
|
|
852
|
-
See also: [ReviewActionResultStatus](
|
|
858
|
+
See also: [ReviewActionResultStatus](#type-reviewactionresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
859
|
+
|
|
860
|
+
<details>
|
|
861
|
+
|
|
862
|
+
<summary>Interface ReviewActionResult Details</summary>
|
|
853
863
|
|
|
854
864
|
#### Property competingBeef
|
|
855
865
|
|
|
@@ -867,6 +877,8 @@ Any competing txids reported for this txid, valid when status is 'doubleSpend'.
|
|
|
867
877
|
competingTxs?: string[]
|
|
868
878
|
```
|
|
869
879
|
|
|
880
|
+
</details>
|
|
881
|
+
|
|
870
882
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
871
883
|
|
|
872
884
|
---
|
|
@@ -879,7 +891,7 @@ export interface SendWithResult {
|
|
|
879
891
|
}
|
|
880
892
|
```
|
|
881
893
|
|
|
882
|
-
See also: [SendWithResultStatus](
|
|
894
|
+
See also: [SendWithResultStatus](#type-sendwithresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
883
895
|
|
|
884
896
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
885
897
|
|
|
@@ -894,7 +906,7 @@ export interface SignActionArgs {
|
|
|
894
906
|
}
|
|
895
907
|
```
|
|
896
908
|
|
|
897
|
-
See also: [Base64String](
|
|
909
|
+
See also: [Base64String](#type-base64string), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SignActionOptions](#interface-signactionoptions), [SignActionSpend](#interface-signactionspend)
|
|
898
910
|
|
|
899
911
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
900
912
|
|
|
@@ -910,7 +922,7 @@ export interface SignActionOptions {
|
|
|
910
922
|
}
|
|
911
923
|
```
|
|
912
924
|
|
|
913
|
-
See also: [BooleanDefaultFalse](
|
|
925
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [TXIDHexString](#type-txidhexstring)
|
|
914
926
|
|
|
915
927
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
916
928
|
|
|
@@ -925,7 +937,7 @@ export interface SignActionResult {
|
|
|
925
937
|
}
|
|
926
938
|
```
|
|
927
939
|
|
|
928
|
-
See also: [AtomicBEEF](
|
|
940
|
+
See also: [AtomicBEEF](#type-atomicbeef), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
929
941
|
|
|
930
942
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
931
943
|
|
|
@@ -939,7 +951,7 @@ export interface SignActionSpend {
|
|
|
939
951
|
}
|
|
940
952
|
```
|
|
941
953
|
|
|
942
|
-
See also: [HexString](
|
|
954
|
+
See also: [HexString](#type-hexstring), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
943
955
|
|
|
944
956
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
945
957
|
|
|
@@ -953,7 +965,7 @@ export interface SignableTransaction {
|
|
|
953
965
|
}
|
|
954
966
|
```
|
|
955
967
|
|
|
956
|
-
See also: [AtomicBEEF](
|
|
968
|
+
See also: [AtomicBEEF](#type-atomicbeef), [Base64String](#type-base64string)
|
|
957
969
|
|
|
958
970
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
959
971
|
|
|
@@ -967,7 +979,7 @@ export interface VerifyHmacArgs extends WalletEncryptionArgs {
|
|
|
967
979
|
}
|
|
968
980
|
```
|
|
969
981
|
|
|
970
|
-
See also: [Byte](
|
|
982
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
971
983
|
|
|
972
984
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
973
985
|
|
|
@@ -994,7 +1006,7 @@ export interface VerifySignatureArgs extends WalletEncryptionArgs {
|
|
|
994
1006
|
}
|
|
995
1007
|
```
|
|
996
1008
|
|
|
997
|
-
See also: [BooleanDefaultFalse](
|
|
1009
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
998
1010
|
|
|
999
1011
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1000
1012
|
|
|
@@ -1027,7 +1039,7 @@ export interface WalletAction {
|
|
|
1027
1039
|
}
|
|
1028
1040
|
```
|
|
1029
1041
|
|
|
1030
|
-
See also: [ActionStatus](
|
|
1042
|
+
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
1043
|
|
|
1032
1044
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1033
1045
|
|
|
@@ -1045,7 +1057,7 @@ export interface WalletActionInput {
|
|
|
1045
1057
|
}
|
|
1046
1058
|
```
|
|
1047
1059
|
|
|
1048
|
-
See also: [DescriptionString5to50Bytes](
|
|
1060
|
+
See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1049
1061
|
|
|
1050
1062
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1051
1063
|
|
|
@@ -1065,7 +1077,7 @@ export interface WalletActionOutput {
|
|
|
1065
1077
|
}
|
|
1066
1078
|
```
|
|
1067
1079
|
|
|
1068
|
-
See also: [BasketStringUnder300Bytes](
|
|
1080
|
+
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1069
1081
|
|
|
1070
1082
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1071
1083
|
|
|
@@ -1084,7 +1096,7 @@ export interface WalletCertificate {
|
|
|
1084
1096
|
}
|
|
1085
1097
|
```
|
|
1086
1098
|
|
|
1087
|
-
See also: [Base64String](
|
|
1099
|
+
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
|
|
1088
1100
|
|
|
1089
1101
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1090
1102
|
|
|
@@ -1097,7 +1109,7 @@ export interface WalletDecryptArgs extends WalletEncryptionArgs {
|
|
|
1097
1109
|
}
|
|
1098
1110
|
```
|
|
1099
1111
|
|
|
1100
|
-
See also: [Byte](
|
|
1112
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1101
1113
|
|
|
1102
1114
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1103
1115
|
|
|
@@ -1110,7 +1122,7 @@ export interface WalletDecryptResult {
|
|
|
1110
1122
|
}
|
|
1111
1123
|
```
|
|
1112
1124
|
|
|
1113
|
-
See also: [Byte](
|
|
1125
|
+
See also: [Byte](#type-byte)
|
|
1114
1126
|
|
|
1115
1127
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1116
1128
|
|
|
@@ -1123,7 +1135,7 @@ export interface WalletEncryptArgs extends WalletEncryptionArgs {
|
|
|
1123
1135
|
}
|
|
1124
1136
|
```
|
|
1125
1137
|
|
|
1126
|
-
See also: [Byte](
|
|
1138
|
+
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1127
1139
|
|
|
1128
1140
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1129
1141
|
|
|
@@ -1136,7 +1148,7 @@ export interface WalletEncryptResult {
|
|
|
1136
1148
|
}
|
|
1137
1149
|
```
|
|
1138
1150
|
|
|
1139
|
-
See also: [Byte](
|
|
1151
|
+
See also: [Byte](#type-byte)
|
|
1140
1152
|
|
|
1141
1153
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1142
1154
|
|
|
@@ -1154,7 +1166,7 @@ export interface WalletEncryptionArgs {
|
|
|
1154
1166
|
}
|
|
1155
1167
|
```
|
|
1156
1168
|
|
|
1157
|
-
See also: [BooleanDefaultFalse](
|
|
1169
|
+
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
1158
1170
|
|
|
1159
1171
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1160
1172
|
|
|
@@ -1222,7 +1234,11 @@ export interface WalletInterface {
|
|
|
1222
1234
|
}
|
|
1223
1235
|
```
|
|
1224
1236
|
|
|
1225
|
-
See also: [AbortActionArgs](
|
|
1237
|
+
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)
|
|
1238
|
+
|
|
1239
|
+
<details>
|
|
1240
|
+
|
|
1241
|
+
<summary>Interface WalletInterface Details</summary>
|
|
1226
1242
|
|
|
1227
1243
|
#### Property abortAction
|
|
1228
1244
|
|
|
@@ -1231,7 +1247,7 @@ Aborts a transaction that is in progress and has not yet been finalized or sent
|
|
|
1231
1247
|
```ts
|
|
1232
1248
|
abortAction: (args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AbortActionResult>
|
|
1233
1249
|
```
|
|
1234
|
-
See also: [AbortActionArgs](
|
|
1250
|
+
See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1235
1251
|
|
|
1236
1252
|
#### Property acquireCertificate
|
|
1237
1253
|
|
|
@@ -1240,7 +1256,7 @@ Acquires an identity certificate, whether by acquiring one from the certifier or
|
|
|
1240
1256
|
```ts
|
|
1241
1257
|
acquireCertificate: (args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletCertificate>
|
|
1242
1258
|
```
|
|
1243
|
-
See also: [AcquireCertificateArgs](
|
|
1259
|
+
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletCertificate](#interface-walletcertificate)
|
|
1244
1260
|
|
|
1245
1261
|
#### Property createAction
|
|
1246
1262
|
|
|
@@ -1249,7 +1265,7 @@ Creates a new Bitcoin transaction based on the provided inputs, outputs, labels,
|
|
|
1249
1265
|
```ts
|
|
1250
1266
|
createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateActionResult>
|
|
1251
1267
|
```
|
|
1252
|
-
See also: [CreateActionArgs](
|
|
1268
|
+
See also: [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1253
1269
|
|
|
1254
1270
|
#### Property createHmac
|
|
1255
1271
|
|
|
@@ -1258,7 +1274,7 @@ Creates an HMAC (Hash-based Message Authentication Code) based on the provided d
|
|
|
1258
1274
|
```ts
|
|
1259
1275
|
createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
|
|
1260
1276
|
```
|
|
1261
|
-
See also: [CreateHmacArgs](
|
|
1277
|
+
See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1262
1278
|
|
|
1263
1279
|
#### Property createSignature
|
|
1264
1280
|
|
|
@@ -1267,7 +1283,7 @@ Creates a digital signature for the provided data or hash using a specific proto
|
|
|
1267
1283
|
```ts
|
|
1268
1284
|
createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
|
|
1269
1285
|
```
|
|
1270
|
-
See also: [CreateSignatureArgs](
|
|
1286
|
+
See also: [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1271
1287
|
|
|
1272
1288
|
#### Property decrypt
|
|
1273
1289
|
|
|
@@ -1276,7 +1292,7 @@ Decrypts the provided ciphertext using derived keys, based on the protocol ID, k
|
|
|
1276
1292
|
```ts
|
|
1277
1293
|
decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
|
|
1278
1294
|
```
|
|
1279
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1295
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult)
|
|
1280
1296
|
|
|
1281
1297
|
#### Property discoverByAttributes
|
|
1282
1298
|
|
|
@@ -1285,7 +1301,7 @@ Discovers identity certificates belonging to other users, where the documents co
|
|
|
1285
1301
|
```ts
|
|
1286
1302
|
discoverByAttributes: (args: DiscoverByAttributesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1287
1303
|
```
|
|
1288
|
-
See also: [DiscoverByAttributesArgs](
|
|
1304
|
+
See also: [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1289
1305
|
|
|
1290
1306
|
#### Property discoverByIdentityKey
|
|
1291
1307
|
|
|
@@ -1294,7 +1310,7 @@ Discovers identity certificates, issued to a given identity key by a trusted ent
|
|
|
1294
1310
|
```ts
|
|
1295
1311
|
discoverByIdentityKey: (args: DiscoverByIdentityKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1296
1312
|
```
|
|
1297
|
-
See also: [DiscoverByIdentityKeyArgs](
|
|
1313
|
+
See also: [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1298
1314
|
|
|
1299
1315
|
#### Property encrypt
|
|
1300
1316
|
|
|
@@ -1303,7 +1319,7 @@ Encrypts the provided plaintext data using derived keys, based on the protocol I
|
|
|
1303
1319
|
```ts
|
|
1304
1320
|
encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
|
|
1305
1321
|
```
|
|
1306
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1322
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
|
|
1307
1323
|
|
|
1308
1324
|
#### Property getHeaderForHeight
|
|
1309
1325
|
|
|
@@ -1312,7 +1328,7 @@ Retrieves the block header of a block at a specified height.
|
|
|
1312
1328
|
```ts
|
|
1313
1329
|
getHeaderForHeight: (args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeaderResult>
|
|
1314
1330
|
```
|
|
1315
|
-
See also: [GetHeaderArgs](
|
|
1331
|
+
See also: [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1316
1332
|
|
|
1317
1333
|
#### Property getHeight
|
|
1318
1334
|
|
|
@@ -1321,7 +1337,7 @@ Retrieves the current height of the blockchain.
|
|
|
1321
1337
|
```ts
|
|
1322
1338
|
getHeight: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeightResult>
|
|
1323
1339
|
```
|
|
1324
|
-
See also: [GetHeightResult](
|
|
1340
|
+
See also: [GetHeightResult](#interface-getheightresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1325
1341
|
|
|
1326
1342
|
#### Property getNetwork
|
|
1327
1343
|
|
|
@@ -1330,7 +1346,7 @@ Retrieves the Bitcoin network the client is using (mainnet or testnet).
|
|
|
1330
1346
|
```ts
|
|
1331
1347
|
getNetwork: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetNetworkResult>
|
|
1332
1348
|
```
|
|
1333
|
-
See also: [GetNetworkResult](
|
|
1349
|
+
See also: [GetNetworkResult](#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1334
1350
|
|
|
1335
1351
|
#### Property getPublicKey
|
|
1336
1352
|
|
|
@@ -1339,7 +1355,7 @@ Retrieves a derived or identity public key based on the requested protocol, key
|
|
|
1339
1355
|
```ts
|
|
1340
1356
|
getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
|
|
1341
1357
|
```
|
|
1342
|
-
See also: [GetPublicKeyArgs](
|
|
1358
|
+
See also: [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1343
1359
|
|
|
1344
1360
|
#### Property getVersion
|
|
1345
1361
|
|
|
@@ -1348,7 +1364,7 @@ Retrieves the current version string of the wallet.
|
|
|
1348
1364
|
```ts
|
|
1349
1365
|
getVersion: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetVersionResult>
|
|
1350
1366
|
```
|
|
1351
|
-
See also: [GetVersionResult](
|
|
1367
|
+
See also: [GetVersionResult](#interface-getversionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1352
1368
|
|
|
1353
1369
|
#### Property internalizeAction
|
|
1354
1370
|
|
|
@@ -1357,7 +1373,7 @@ Submits a transaction to be internalized and optionally labeled, outputs paid to
|
|
|
1357
1373
|
```ts
|
|
1358
1374
|
internalizeAction: (args: InternalizeActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<InternalizeActionResult>
|
|
1359
1375
|
```
|
|
1360
|
-
See also: [InternalizeActionArgs](
|
|
1376
|
+
See also: [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1361
1377
|
|
|
1362
1378
|
#### Property isAuthenticated
|
|
1363
1379
|
|
|
@@ -1366,7 +1382,7 @@ Checks the authentication status of the user.
|
|
|
1366
1382
|
```ts
|
|
1367
1383
|
isAuthenticated: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1368
1384
|
```
|
|
1369
|
-
See also: [AuthenticatedResult](
|
|
1385
|
+
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1370
1386
|
|
|
1371
1387
|
#### Property listActions
|
|
1372
1388
|
|
|
@@ -1375,7 +1391,7 @@ Lists all transactions matching the specified labels.
|
|
|
1375
1391
|
```ts
|
|
1376
1392
|
listActions: (args: ListActionsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListActionsResult>
|
|
1377
1393
|
```
|
|
1378
|
-
See also: [ListActionsArgs](
|
|
1394
|
+
See also: [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1379
1395
|
|
|
1380
1396
|
#### Property listCertificates
|
|
1381
1397
|
|
|
@@ -1384,7 +1400,7 @@ Lists identity certificates belonging to the user, filtered by certifier(s) and
|
|
|
1384
1400
|
```ts
|
|
1385
1401
|
listCertificates: (args: ListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListCertificatesResult>
|
|
1386
1402
|
```
|
|
1387
|
-
See also: [ListCertificatesArgs](
|
|
1403
|
+
See also: [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1388
1404
|
|
|
1389
1405
|
#### Property listOutputs
|
|
1390
1406
|
|
|
@@ -1393,7 +1409,7 @@ Lists the spendable outputs kept within a specific basket, optionally tagged wit
|
|
|
1393
1409
|
```ts
|
|
1394
1410
|
listOutputs: (args: ListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListOutputsResult>
|
|
1395
1411
|
```
|
|
1396
|
-
See also: [ListOutputsArgs](
|
|
1412
|
+
See also: [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1397
1413
|
|
|
1398
1414
|
#### Property proveCertificate
|
|
1399
1415
|
|
|
@@ -1402,7 +1418,7 @@ Proves select fields of an identity certificate, as specified, when requested by
|
|
|
1402
1418
|
```ts
|
|
1403
1419
|
proveCertificate: (args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ProveCertificateResult>
|
|
1404
1420
|
```
|
|
1405
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1421
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult)
|
|
1406
1422
|
|
|
1407
1423
|
#### Property relinquishCertificate
|
|
1408
1424
|
|
|
@@ -1411,7 +1427,7 @@ Relinquishes an identity certificate, removing it from the wallet regardless of
|
|
|
1411
1427
|
```ts
|
|
1412
1428
|
relinquishCertificate: (args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishCertificateResult>
|
|
1413
1429
|
```
|
|
1414
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1430
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult)
|
|
1415
1431
|
|
|
1416
1432
|
#### Property relinquishOutput
|
|
1417
1433
|
|
|
@@ -1420,7 +1436,7 @@ Relinquish an output out of a basket, removing it from tracking without spending
|
|
|
1420
1436
|
```ts
|
|
1421
1437
|
relinquishOutput: (args: RelinquishOutputArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishOutputResult>
|
|
1422
1438
|
```
|
|
1423
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1439
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult)
|
|
1424
1440
|
|
|
1425
1441
|
#### Property revealCounterpartyKeyLinkage
|
|
1426
1442
|
|
|
@@ -1429,7 +1445,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1429
1445
|
```ts
|
|
1430
1446
|
revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
|
|
1431
1447
|
```
|
|
1432
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1448
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult)
|
|
1433
1449
|
|
|
1434
1450
|
#### Property revealSpecificKeyLinkage
|
|
1435
1451
|
|
|
@@ -1438,7 +1454,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1438
1454
|
```ts
|
|
1439
1455
|
revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
|
|
1440
1456
|
```
|
|
1441
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1457
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult)
|
|
1442
1458
|
|
|
1443
1459
|
#### Property signAction
|
|
1444
1460
|
|
|
@@ -1447,7 +1463,7 @@ Signs a transaction previously created using `createAction`.
|
|
|
1447
1463
|
```ts
|
|
1448
1464
|
signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
|
|
1449
1465
|
```
|
|
1450
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1466
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
|
|
1451
1467
|
|
|
1452
1468
|
#### Property verifyHmac
|
|
1453
1469
|
|
|
@@ -1456,7 +1472,7 @@ Verifies an HMAC (Hash-based Message Authentication Code) based on the provided
|
|
|
1456
1472
|
```ts
|
|
1457
1473
|
verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
|
|
1458
1474
|
```
|
|
1459
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1475
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult)
|
|
1460
1476
|
|
|
1461
1477
|
#### Property verifySignature
|
|
1462
1478
|
|
|
@@ -1465,7 +1481,7 @@ Verifies a digital signature for the provided data or hash using a specific prot
|
|
|
1465
1481
|
```ts
|
|
1466
1482
|
verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
|
|
1467
1483
|
```
|
|
1468
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](
|
|
1484
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult)
|
|
1469
1485
|
|
|
1470
1486
|
#### Property waitForAuthentication
|
|
1471
1487
|
|
|
@@ -1474,7 +1490,9 @@ Continuously waits until the user is authenticated, returning the result once co
|
|
|
1474
1490
|
```ts
|
|
1475
1491
|
waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1476
1492
|
```
|
|
1477
|
-
See also: [AuthenticatedResult](
|
|
1493
|
+
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1494
|
+
|
|
1495
|
+
</details>
|
|
1478
1496
|
|
|
1479
1497
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1480
1498
|
|
|
@@ -1493,7 +1511,7 @@ export interface WalletOutput {
|
|
|
1493
1511
|
}
|
|
1494
1512
|
```
|
|
1495
1513
|
|
|
1496
|
-
See also: [HexString](
|
|
1514
|
+
See also: [HexString](#type-hexstring), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [SatoshiValue](#type-satoshivalue)
|
|
1497
1515
|
|
|
1498
1516
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1499
1517
|
|
|
@@ -1508,7 +1526,7 @@ export interface WalletPayment {
|
|
|
1508
1526
|
}
|
|
1509
1527
|
```
|
|
1510
1528
|
|
|
1511
|
-
See also: [Base64String](
|
|
1529
|
+
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
1512
1530
|
|
|
1513
1531
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1514
1532
|
|
|
@@ -1566,7 +1584,11 @@ export default class CachedKeyDeriver {
|
|
|
1566
1584
|
}
|
|
1567
1585
|
```
|
|
1568
1586
|
|
|
1569
|
-
See also: [Counterparty](
|
|
1587
|
+
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
1588
|
+
|
|
1589
|
+
<details>
|
|
1590
|
+
|
|
1591
|
+
<summary>Class CachedKeyDeriver Details</summary>
|
|
1570
1592
|
|
|
1571
1593
|
#### Constructor
|
|
1572
1594
|
|
|
@@ -1577,7 +1599,7 @@ constructor(rootKey: PrivateKey | "anyone", options?: {
|
|
|
1577
1599
|
maxCacheSize?: number;
|
|
1578
1600
|
})
|
|
1579
1601
|
```
|
|
1580
|
-
See also: [PrivateKey](
|
|
1602
|
+
See also: [PrivateKey](#class-privatekey)
|
|
1581
1603
|
|
|
1582
1604
|
Argument Details
|
|
1583
1605
|
|
|
@@ -1594,7 +1616,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1594
1616
|
```ts
|
|
1595
1617
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
1596
1618
|
```
|
|
1597
|
-
See also: [Counterparty](
|
|
1619
|
+
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
1598
1620
|
|
|
1599
1621
|
Returns
|
|
1600
1622
|
|
|
@@ -1617,7 +1639,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1617
1639
|
```ts
|
|
1618
1640
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
1619
1641
|
```
|
|
1620
|
-
See also: [Counterparty](
|
|
1642
|
+
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
1621
1643
|
|
|
1622
1644
|
Returns
|
|
1623
1645
|
|
|
@@ -1642,7 +1664,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1642
1664
|
```ts
|
|
1643
1665
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
1644
1666
|
```
|
|
1645
|
-
See also: [Counterparty](
|
|
1667
|
+
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
1646
1668
|
|
|
1647
1669
|
Returns
|
|
1648
1670
|
|
|
@@ -1669,7 +1691,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1669
1691
|
```ts
|
|
1670
1692
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
1671
1693
|
```
|
|
1672
|
-
See also: [Counterparty](
|
|
1694
|
+
See also: [Counterparty](#type-counterparty)
|
|
1673
1695
|
|
|
1674
1696
|
Returns
|
|
1675
1697
|
|
|
@@ -1692,7 +1714,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1692
1714
|
```ts
|
|
1693
1715
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
1694
1716
|
```
|
|
1695
|
-
See also: [Counterparty](
|
|
1717
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1696
1718
|
|
|
1697
1719
|
Returns
|
|
1698
1720
|
|
|
@@ -1707,6 +1729,8 @@ Argument Details
|
|
|
1707
1729
|
+ **keyID**
|
|
1708
1730
|
+ The key identifier.
|
|
1709
1731
|
|
|
1732
|
+
</details>
|
|
1733
|
+
|
|
1710
1734
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1711
1735
|
|
|
1712
1736
|
---
|
|
@@ -1929,7 +1953,7 @@ export default class HTTPWalletJSON implements WalletInterface {
|
|
|
1929
1953
|
}
|
|
1930
1954
|
```
|
|
1931
1955
|
|
|
1932
|
-
See also: [AcquireCertificateArgs](
|
|
1956
|
+
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)
|
|
1933
1957
|
|
|
1934
1958
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1935
1959
|
|
|
@@ -1946,7 +1970,7 @@ export default class HTTPWalletWire implements WalletWire {
|
|
|
1946
1970
|
}
|
|
1947
1971
|
```
|
|
1948
1972
|
|
|
1949
|
-
See also: [WalletWire](
|
|
1973
|
+
See also: [WalletWire](#interface-walletwire)
|
|
1950
1974
|
|
|
1951
1975
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1952
1976
|
|
|
@@ -1969,7 +1993,11 @@ export class KeyDeriver implements KeyDeriverApi {
|
|
|
1969
1993
|
}
|
|
1970
1994
|
```
|
|
1971
1995
|
|
|
1972
|
-
See also: [Counterparty](
|
|
1996
|
+
See also: [Counterparty](#type-counterparty), [KeyDeriverApi](#interface-keyderiverapi), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
1997
|
+
|
|
1998
|
+
<details>
|
|
1999
|
+
|
|
2000
|
+
<summary>Class KeyDeriver Details</summary>
|
|
1973
2001
|
|
|
1974
2002
|
#### Constructor
|
|
1975
2003
|
|
|
@@ -1978,7 +2006,7 @@ Initializes the KeyDeriver instance with a root private key.
|
|
|
1978
2006
|
```ts
|
|
1979
2007
|
constructor(rootKey: PrivateKey | "anyone")
|
|
1980
2008
|
```
|
|
1981
|
-
See also: [PrivateKey](
|
|
2009
|
+
See also: [PrivateKey](#class-privatekey)
|
|
1982
2010
|
|
|
1983
2011
|
Argument Details
|
|
1984
2012
|
|
|
@@ -1992,7 +2020,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
1992
2020
|
```ts
|
|
1993
2021
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
1994
2022
|
```
|
|
1995
|
-
See also: [Counterparty](
|
|
2023
|
+
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
1996
2024
|
|
|
1997
2025
|
Returns
|
|
1998
2026
|
|
|
@@ -2014,7 +2042,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
2014
2042
|
```ts
|
|
2015
2043
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
2016
2044
|
```
|
|
2017
|
-
See also: [Counterparty](
|
|
2045
|
+
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
2018
2046
|
|
|
2019
2047
|
Returns
|
|
2020
2048
|
|
|
@@ -2039,7 +2067,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
2039
2067
|
```ts
|
|
2040
2068
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
2041
2069
|
```
|
|
2042
|
-
See also: [Counterparty](
|
|
2070
|
+
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
2043
2071
|
|
|
2044
2072
|
Returns
|
|
2045
2073
|
|
|
@@ -2062,7 +2090,7 @@ Note: This should not be used for 'self'.
|
|
|
2062
2090
|
```ts
|
|
2063
2091
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
2064
2092
|
```
|
|
2065
|
-
See also: [Counterparty](
|
|
2093
|
+
See also: [Counterparty](#type-counterparty)
|
|
2066
2094
|
|
|
2067
2095
|
Returns
|
|
2068
2096
|
|
|
@@ -2084,7 +2112,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
2084
2112
|
```ts
|
|
2085
2113
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
2086
2114
|
```
|
|
2087
|
-
See also: [Counterparty](
|
|
2115
|
+
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2088
2116
|
|
|
2089
2117
|
Returns
|
|
2090
2118
|
|
|
@@ -2099,6 +2127,8 @@ Argument Details
|
|
|
2099
2127
|
+ **keyID**
|
|
2100
2128
|
+ The key identifier.
|
|
2101
2129
|
|
|
2130
|
+
</details>
|
|
2131
|
+
|
|
2102
2132
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2103
2133
|
|
|
2104
2134
|
---
|
|
@@ -2128,7 +2158,7 @@ export class ProtoWallet {
|
|
|
2128
2158
|
}
|
|
2129
2159
|
```
|
|
2130
2160
|
|
|
2131
|
-
See also: [CreateHmacArgs](
|
|
2161
|
+
See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [GetPublicKeyArgs](#interface-getpublickeyargs), [KeyDeriverApi](#interface-keyderiverapi), [PrivateKey](#class-privatekey), [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)
|
|
2132
2162
|
|
|
2133
2163
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2134
2164
|
|
|
@@ -2147,7 +2177,11 @@ export class WERR_REVIEW_ACTIONS extends Error {
|
|
|
2147
2177
|
}
|
|
2148
2178
|
```
|
|
2149
2179
|
|
|
2150
|
-
See also: [AtomicBEEF](
|
|
2180
|
+
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [ReviewActionResult](#interface-reviewactionresult), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
2181
|
+
|
|
2182
|
+
<details>
|
|
2183
|
+
|
|
2184
|
+
<summary>Class WERR_REVIEW_ACTIONS Details</summary>
|
|
2151
2185
|
|
|
2152
2186
|
#### Constructor
|
|
2153
2187
|
|
|
@@ -2158,7 +2192,9 @@ which contains more details, particularly for double spend results.
|
|
|
2158
2192
|
```ts
|
|
2159
2193
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
2160
2194
|
```
|
|
2161
|
-
See also: [AtomicBEEF](
|
|
2195
|
+
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [ReviewActionResult](#interface-reviewactionresult), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
2196
|
+
|
|
2197
|
+
</details>
|
|
2162
2198
|
|
|
2163
2199
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2164
2200
|
|
|
@@ -2372,7 +2408,7 @@ export default class WalletClient implements WalletInterface {
|
|
|
2372
2408
|
}
|
|
2373
2409
|
```
|
|
2374
2410
|
|
|
2375
|
-
See also: [AcquireCertificateArgs](
|
|
2411
|
+
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)
|
|
2376
2412
|
|
|
2377
2413
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2378
2414
|
|
|
@@ -2402,7 +2438,7 @@ export default class WalletWireProcessor implements WalletWire {
|
|
|
2402
2438
|
}
|
|
2403
2439
|
```
|
|
2404
2440
|
|
|
2405
|
-
See also: [WalletInterface](
|
|
2441
|
+
See also: [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire)
|
|
2406
2442
|
|
|
2407
2443
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2408
2444
|
|
|
@@ -2625,7 +2661,7 @@ export default class WalletWireTransceiver implements WalletInterface {
|
|
|
2625
2661
|
}
|
|
2626
2662
|
```
|
|
2627
2663
|
|
|
2628
|
-
See also: [AcquireCertificateArgs](
|
|
2664
|
+
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)
|
|
2629
2665
|
|
|
2630
2666
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2631
2667
|
|
|
@@ -3068,7 +3104,7 @@ export default class WindowCWISubstrate implements WalletInterface {
|
|
|
3068
3104
|
}
|
|
3069
3105
|
```
|
|
3070
3106
|
|
|
3071
|
-
See also: [BEEF](
|
|
3107
|
+
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)
|
|
3072
3108
|
|
|
3073
3109
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3074
3110
|
|
|
@@ -3512,7 +3548,7 @@ export default class XDMSubstrate implements WalletInterface {
|
|
|
3512
3548
|
}
|
|
3513
3549
|
```
|
|
3514
3550
|
|
|
3515
|
-
See also: [BEEF](
|
|
3551
|
+
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)
|
|
3516
3552
|
|
|
3517
3553
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3518
3554
|
|
|
@@ -3549,7 +3585,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3549
3585
|
export type AcquireCertificateResult = WalletCertificate
|
|
3550
3586
|
```
|
|
3551
3587
|
|
|
3552
|
-
See also: [WalletCertificate](
|
|
3588
|
+
See also: [WalletCertificate](#interface-walletcertificate)
|
|
3553
3589
|
|
|
3554
3590
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3555
3591
|
|
|
@@ -3578,7 +3614,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3578
3614
|
export type AtomicBEEF = Byte[]
|
|
3579
3615
|
```
|
|
3580
3616
|
|
|
3581
|
-
See also: [Byte](
|
|
3617
|
+
See also: [Byte](#type-byte)
|
|
3582
3618
|
|
|
3583
3619
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3584
3620
|
|
|
@@ -3589,7 +3625,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3589
3625
|
export type BEEF = Byte[]
|
|
3590
3626
|
```
|
|
3591
3627
|
|
|
3592
|
-
See also: [Byte](
|
|
3628
|
+
See also: [Byte](#type-byte)
|
|
3593
3629
|
|
|
3594
3630
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3595
3631
|
|
|
@@ -3663,7 +3699,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3663
3699
|
export type Counterparty = PublicKey | PubKeyHex | "self" | "anyone"
|
|
3664
3700
|
```
|
|
3665
3701
|
|
|
3666
|
-
See also: [PubKeyHex](
|
|
3702
|
+
See also: [PubKeyHex](#type-pubkeyhex), [PublicKey](#class-publickey)
|
|
3667
3703
|
|
|
3668
3704
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3669
3705
|
|
|
@@ -3746,7 +3782,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3746
3782
|
export type KeyringRevealer = PubKeyHex | "certifier"
|
|
3747
3783
|
```
|
|
3748
3784
|
|
|
3749
|
-
See also: [PubKeyHex](
|
|
3785
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
3750
3786
|
|
|
3751
3787
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3752
3788
|
|
|
@@ -3838,7 +3874,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3838
3874
|
export type PubKeyHex = HexString
|
|
3839
3875
|
```
|
|
3840
3876
|
|
|
3841
|
-
See also: [HexString](
|
|
3877
|
+
See also: [HexString](#type-hexstring)
|
|
3842
3878
|
|
|
3843
3879
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3844
3880
|
|
|
@@ -3899,7 +3935,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3899
3935
|
export type TXIDHexString = HexString
|
|
3900
3936
|
```
|
|
3901
3937
|
|
|
3902
|
-
See also: [HexString](
|
|
3938
|
+
See also: [HexString](#type-hexstring)
|
|
3903
3939
|
|
|
3904
3940
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3905
3941
|
|
|
@@ -3934,7 +3970,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3934
3970
|
export type WalletCounterparty = PubKeyHex | "self" | "anyone"
|
|
3935
3971
|
```
|
|
3936
3972
|
|
|
3937
|
-
See also: [PubKeyHex](
|
|
3973
|
+
See also: [PubKeyHex](#type-pubkeyhex)
|
|
3938
3974
|
|
|
3939
3975
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3940
3976
|
|
|
@@ -3945,7 +3981,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3945
3981
|
export type WalletErrorCode = keyof typeof walletErrors
|
|
3946
3982
|
```
|
|
3947
3983
|
|
|
3948
|
-
See also: [walletErrors](
|
|
3984
|
+
See also: [walletErrors](#enum-walleterrors)
|
|
3949
3985
|
|
|
3950
3986
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3951
3987
|
|
|
@@ -3968,7 +4004,7 @@ export type WalletProtocol = [
|
|
|
3968
4004
|
]
|
|
3969
4005
|
```
|
|
3970
4006
|
|
|
3971
|
-
See also: [ProtocolString5To400Bytes](
|
|
4007
|
+
See also: [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [SecurityLevel](#type-securitylevel)
|
|
3972
4008
|
|
|
3973
4009
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3974
4010
|
|
|
@@ -3994,7 +4030,7 @@ export enum SecurityLevels {
|
|
|
3994
4030
|
}
|
|
3995
4031
|
```
|
|
3996
4032
|
|
|
3997
|
-
See also: [Counterparty](
|
|
4033
|
+
See also: [Counterparty](#type-counterparty)
|
|
3998
4034
|
|
|
3999
4035
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4000
4036
|
|