@bsv/sdk 1.4.24 → 1.5.1
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/README.md +14 -0
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/src/script/Script.js +21 -1
- package/dist/cjs/src/script/Script.js.map +1 -1
- package/dist/cjs/src/wallet/WalletClient.js +12 -2
- package/dist/cjs/src/wallet/WalletClient.js.map +1 -1
- package/dist/cjs/src/wallet/substrates/ReactNativeWebView.js +165 -0
- package/dist/cjs/src/wallet/substrates/ReactNativeWebView.js.map +1 -0
- package/dist/cjs/src/wallet/substrates/index.js +3 -1
- package/dist/cjs/src/wallet/substrates/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/script/Script.js +21 -1
- package/dist/esm/src/script/Script.js.map +1 -1
- package/dist/esm/src/wallet/WalletClient.js +12 -2
- package/dist/esm/src/wallet/WalletClient.js.map +1 -1
- package/dist/esm/src/wallet/substrates/ReactNativeWebView.js +137 -0
- package/dist/esm/src/wallet/substrates/ReactNativeWebView.js.map +1 -0
- package/dist/esm/src/wallet/substrates/index.js +1 -0
- package/dist/esm/src/wallet/substrates/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/script/Script.d.ts.map +1 -1
- package/dist/types/src/wallet/WalletClient.d.ts.map +1 -1
- package/dist/types/src/wallet/substrates/ReactNativeWebView.d.ts +412 -0
- package/dist/types/src/wallet/substrates/ReactNativeWebView.d.ts.map +1 -0
- package/dist/types/src/wallet/substrates/index.d.ts +1 -0
- package/dist/types/src/wallet/substrates/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 +47 -101
- package/docs/compat.md +24 -48
- package/docs/identity.md +8 -14
- package/docs/kvstore.md +3 -9
- package/docs/messages.md +4 -4
- package/docs/overlay-tools.md +21 -69
- package/docs/primitives.md +235 -379
- package/docs/registry.md +14 -20
- package/docs/script.md +32 -80
- package/docs/storage.md +11 -17
- package/docs/totp.md +5 -11
- package/docs/transaction.md +66 -144
- package/docs/wallet.md +586 -183
- package/package.json +1 -1
- package/src/script/Script.ts +22 -1
- package/src/wallet/WalletClient.ts +13 -4
- package/src/wallet/substrates/ReactNativeWebView.ts +560 -0
- package/src/wallet/substrates/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](#type-base64string)
|
|
47
|
+
See also: [Base64String](./wallet.md#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](#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)
|
|
82
|
+
See also: [AcquisitionProtocol](./wallet.md#type-acquisitionprotocol), [Base64String](./wallet.md#type-base64string), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [HexString](./wallet.md#type-hexstring), [KeyringRevealer](./wallet.md#type-keyringrevealer), [OutpointString](./wallet.md#type-outpointstring), [PubKeyHex](./wallet.md#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](#type-basketstringunder300bytes), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes)
|
|
108
|
+
See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [OutputTagStringUnder300Bytes](./wallet.md#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](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [WalletCertificate](#interface-walletcertificate)
|
|
122
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [WalletCertificate](./wallet.md#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](#type-beef), [CreateActionInput](#interface-createactioninput), [CreateActionOptions](#interface-createactionoptions), [CreateActionOutput](#interface-createactionoutput), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
142
|
+
See also: [BEEF](./wallet.md#type-beef), [CreateActionInput](./wallet.md#interface-createactioninput), [CreateActionOptions](./wallet.md#interface-createactionoptions), [CreateActionOutput](./wallet.md#interface-createactionoutput), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [PositiveIntegerOrZero](./wallet.md#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](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveInteger](#type-positiveinteger), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
159
|
+
See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerOrZero](./wallet.md#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](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [OutpointString](#type-outpointstring), [TXIDHexString](#type-txidhexstring), [TrustSelf](#type-trustself)
|
|
180
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [OutpointString](./wallet.md#type-outpointstring), [TXIDHexString](./wallet.md#type-txidhexstring), [TrustSelf](./wallet.md#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](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [SatoshiValue](#type-satoshivalue)
|
|
198
|
+
See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [HexString](./wallet.md#type-hexstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [SatoshiValue](./wallet.md#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](#type-atomicbeef), [OutpointString](#type-outpointstring), [SendWithResult](#interface-sendwithresult), [SignableTransaction](#interface-signabletransaction), [TXIDHexString](#type-txidhexstring)
|
|
215
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [OutpointString](./wallet.md#type-outpointstring), [SendWithResult](./wallet.md#interface-sendwithresult), [SignableTransaction](./wallet.md#interface-signabletransaction), [TXIDHexString](./wallet.md#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](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
228
|
+
See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#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](#type-byte)
|
|
241
|
+
See also: [Byte](./wallet.md#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](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
255
|
+
See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#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](#type-byte)
|
|
268
|
+
See also: [Byte](./wallet.md#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](#type-booleandefaulttrue), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
284
|
+
See also: [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#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](#type-booleandefaulttrue), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [PubKeyHex](#type-pubkeyhex)
|
|
300
|
+
See also: [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [PubKeyHex](./wallet.md#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](#interface-identitycertificate), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
314
|
+
See also: [IdentityCertificate](./wallet.md#interface-identitycertificate), [PositiveIntegerOrZero](./wallet.md#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](#type-positiveinteger)
|
|
327
|
+
See also: [PositiveInteger](./wallet.md#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](#type-hexstring)
|
|
340
|
+
See also: [HexString](./wallet.md#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](#type-positiveinteger)
|
|
353
|
+
See also: [PositiveInteger](./wallet.md#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](#type-walletnetwork)
|
|
366
|
+
See also: [WalletNetwork](./wallet.md#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](#type-booleandefaultfalse), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
384
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [WalletEncryptionArgs](./wallet.md#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](#type-pubkeyhex)
|
|
397
|
+
See also: [PubKeyHex](./wallet.md#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](#type-versionstring7to30bytes)
|
|
410
|
+
See also: [VersionString7To30Bytes](./wallet.md#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](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [IdentityCertifier](#interface-identitycertifier), [WalletCertificate](#interface-walletcertificate)
|
|
425
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [IdentityCertifier](./wallet.md#interface-identitycertifier), [WalletCertificate](./wallet.md#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](#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](#type-entitynamestringmax100bytes), [PositiveIntegerMax10](#type-positiveintegermax10)
|
|
441
|
+
See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](./wallet.md#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](./wallet.md#type-entitynamestringmax100bytes), [PositiveIntegerMax10](./wallet.md#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](#type-atomicbeef), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [InternalizeOutput](#interface-internalizeoutput), [LabelStringUnder300Bytes](#type-labelstringunder300bytes)
|
|
458
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [InternalizeOutput](./wallet.md#interface-internalizeoutput), [LabelStringUnder300Bytes](./wallet.md#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](#interface-basketinsertion), [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletPayment](#interface-walletpayment)
|
|
485
|
+
See also: [BasketInsertion](./wallet.md#interface-basketinsertion), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [WalletPayment](./wallet.md#interface-walletpayment)
|
|
486
486
|
|
|
487
487
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
488
488
|
|
|
@@ -501,11 +501,7 @@ export interface KeyDeriverApi {
|
|
|
501
501
|
}
|
|
502
502
|
```
|
|
503
503
|
|
|
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>
|
|
504
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
509
505
|
|
|
510
506
|
#### Property derivePrivateKey
|
|
511
507
|
|
|
@@ -514,7 +510,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
514
510
|
```ts
|
|
515
511
|
derivePrivateKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => PrivateKey
|
|
516
512
|
```
|
|
517
|
-
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
513
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
518
514
|
|
|
519
515
|
#### Property derivePublicKey
|
|
520
516
|
|
|
@@ -523,7 +519,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
523
519
|
```ts
|
|
524
520
|
derivePublicKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean) => PublicKey
|
|
525
521
|
```
|
|
526
|
-
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
522
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
527
523
|
|
|
528
524
|
#### Property deriveSymmetricKey
|
|
529
525
|
|
|
@@ -533,7 +529,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
533
529
|
```ts
|
|
534
530
|
deriveSymmetricKey: (protocolID: WalletProtocol, keyID: string, counterparty: Counterparty) => SymmetricKey
|
|
535
531
|
```
|
|
536
|
-
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
532
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
537
533
|
|
|
538
534
|
#### Property identityKey
|
|
539
535
|
|
|
@@ -551,7 +547,7 @@ Note: This should not be used for 'self'.
|
|
|
551
547
|
```ts
|
|
552
548
|
revealCounterpartySecret: (counterparty: Counterparty) => number[]
|
|
553
549
|
```
|
|
554
|
-
See also: [Counterparty](#type-counterparty)
|
|
550
|
+
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
555
551
|
|
|
556
552
|
#### Property revealSpecificSecret
|
|
557
553
|
|
|
@@ -560,7 +556,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
560
556
|
```ts
|
|
561
557
|
revealSpecificSecret: (counterparty: Counterparty, protocolID: WalletProtocol, keyID: string) => number[]
|
|
562
558
|
```
|
|
563
|
-
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
559
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
564
560
|
|
|
565
561
|
#### Property rootKey
|
|
566
562
|
|
|
@@ -569,9 +565,7 @@ The root key from which all other keys are derived.
|
|
|
569
565
|
```ts
|
|
570
566
|
rootKey: PrivateKey
|
|
571
567
|
```
|
|
572
|
-
See also: [PrivateKey](#class-privatekey)
|
|
573
|
-
|
|
574
|
-
</details>
|
|
568
|
+
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
575
569
|
|
|
576
570
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
577
571
|
|
|
@@ -588,7 +582,7 @@ export interface KeyLinkageResult {
|
|
|
588
582
|
}
|
|
589
583
|
```
|
|
590
584
|
|
|
591
|
-
See also: [Byte](#type-byte), [PubKeyHex](#type-pubkeyhex)
|
|
585
|
+
See also: [Byte](./wallet.md#type-byte), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
592
586
|
|
|
593
587
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
594
588
|
|
|
@@ -611,7 +605,7 @@ export interface ListActionsArgs {
|
|
|
611
605
|
}
|
|
612
606
|
```
|
|
613
607
|
|
|
614
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
608
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero)
|
|
615
609
|
|
|
616
610
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
617
611
|
|
|
@@ -625,7 +619,7 @@ export interface ListActionsResult {
|
|
|
625
619
|
}
|
|
626
620
|
```
|
|
627
621
|
|
|
628
|
-
See also: [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletAction](#interface-walletaction)
|
|
622
|
+
See also: [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [WalletAction](./wallet.md#interface-walletaction)
|
|
629
623
|
|
|
630
624
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
631
625
|
|
|
@@ -643,7 +637,7 @@ export interface ListCertificatesArgs {
|
|
|
643
637
|
}
|
|
644
638
|
```
|
|
645
639
|
|
|
646
|
-
See also: [Base64String](#type-base64string), [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero), [PubKeyHex](#type-pubkeyhex)
|
|
640
|
+
See also: [Base64String](./wallet.md#type-base64string), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
647
641
|
|
|
648
642
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
649
643
|
|
|
@@ -657,7 +651,7 @@ export interface ListCertificatesResult {
|
|
|
657
651
|
}
|
|
658
652
|
```
|
|
659
653
|
|
|
660
|
-
See also: [CertificateResult](#interface-certificateresult), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
654
|
+
See also: [CertificateResult](./wallet.md#interface-certificateresult), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero)
|
|
661
655
|
|
|
662
656
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
663
657
|
|
|
@@ -679,7 +673,7 @@ export interface ListOutputsArgs {
|
|
|
679
673
|
}
|
|
680
674
|
```
|
|
681
675
|
|
|
682
|
-
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerDefault10Max10000](#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
676
|
+
See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero)
|
|
683
677
|
|
|
684
678
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
685
679
|
|
|
@@ -694,7 +688,7 @@ export interface ListOutputsResult {
|
|
|
694
688
|
}
|
|
695
689
|
```
|
|
696
690
|
|
|
697
|
-
See also: [BEEF](#type-beef), [PositiveIntegerOrZero](#type-positiveintegerorzero), [WalletOutput](#interface-walletoutput)
|
|
691
|
+
See also: [BEEF](./wallet.md#type-beef), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [WalletOutput](./wallet.md#interface-walletoutput)
|
|
698
692
|
|
|
699
693
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
700
694
|
|
|
@@ -711,7 +705,7 @@ export interface ProveCertificateArgs {
|
|
|
711
705
|
}
|
|
712
706
|
```
|
|
713
707
|
|
|
714
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
708
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
715
709
|
|
|
716
710
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
717
711
|
|
|
@@ -726,7 +720,7 @@ export interface ProveCertificateResult {
|
|
|
726
720
|
}
|
|
727
721
|
```
|
|
728
722
|
|
|
729
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [PubKeyHex](#type-pubkeyhex), [WalletCertificate](#interface-walletcertificate)
|
|
723
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
730
724
|
|
|
731
725
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
732
726
|
|
|
@@ -741,7 +735,7 @@ export interface RelinquishCertificateArgs {
|
|
|
741
735
|
}
|
|
742
736
|
```
|
|
743
737
|
|
|
744
|
-
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
738
|
+
See also: [Base64String](./wallet.md#type-base64string), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
745
739
|
|
|
746
740
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
747
741
|
|
|
@@ -766,7 +760,7 @@ export interface RelinquishOutputArgs {
|
|
|
766
760
|
}
|
|
767
761
|
```
|
|
768
762
|
|
|
769
|
-
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [OutpointString](#type-outpointstring)
|
|
763
|
+
See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [OutpointString](./wallet.md#type-outpointstring)
|
|
770
764
|
|
|
771
765
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
772
766
|
|
|
@@ -793,7 +787,7 @@ export interface RevealCounterpartyKeyLinkageArgs {
|
|
|
793
787
|
}
|
|
794
788
|
```
|
|
795
789
|
|
|
796
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [PubKeyHex](#type-pubkeyhex)
|
|
790
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
797
791
|
|
|
798
792
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
799
793
|
|
|
@@ -806,7 +800,7 @@ export interface RevealCounterpartyKeyLinkageResult extends KeyLinkageResult {
|
|
|
806
800
|
}
|
|
807
801
|
```
|
|
808
802
|
|
|
809
|
-
See also: [ISOTimestampString](#type-isotimestampstring), [KeyLinkageResult](#interface-keylinkageresult)
|
|
803
|
+
See also: [ISOTimestampString](./wallet.md#type-isotimestampstring), [KeyLinkageResult](./wallet.md#interface-keylinkageresult)
|
|
810
804
|
|
|
811
805
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
812
806
|
|
|
@@ -824,7 +818,7 @@ export interface RevealSpecificKeyLinkageArgs {
|
|
|
824
818
|
}
|
|
825
819
|
```
|
|
826
820
|
|
|
827
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [PubKeyHex](#type-pubkeyhex), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
821
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
828
822
|
|
|
829
823
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
830
824
|
|
|
@@ -839,7 +833,7 @@ export interface RevealSpecificKeyLinkageResult extends KeyLinkageResult {
|
|
|
839
833
|
}
|
|
840
834
|
```
|
|
841
835
|
|
|
842
|
-
See also: [Byte](#type-byte), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [KeyLinkageResult](#interface-keylinkageresult), [WalletProtocol](#type-walletprotocol)
|
|
836
|
+
See also: [Byte](./wallet.md#type-byte), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [KeyLinkageResult](./wallet.md#interface-keylinkageresult), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
843
837
|
|
|
844
838
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
845
839
|
|
|
@@ -855,11 +849,7 @@ export interface ReviewActionResult {
|
|
|
855
849
|
}
|
|
856
850
|
```
|
|
857
851
|
|
|
858
|
-
See also: [ReviewActionResultStatus](#type-reviewactionresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
859
|
-
|
|
860
|
-
<details>
|
|
861
|
-
|
|
862
|
-
<summary>Interface ReviewActionResult Details</summary>
|
|
852
|
+
See also: [ReviewActionResultStatus](./wallet.md#type-reviewactionresultstatus), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
863
853
|
|
|
864
854
|
#### Property competingBeef
|
|
865
855
|
|
|
@@ -877,8 +867,6 @@ Any competing txids reported for this txid, valid when status is 'doubleSpend'.
|
|
|
877
867
|
competingTxs?: string[]
|
|
878
868
|
```
|
|
879
869
|
|
|
880
|
-
</details>
|
|
881
|
-
|
|
882
870
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
883
871
|
|
|
884
872
|
---
|
|
@@ -891,7 +879,7 @@ export interface SendWithResult {
|
|
|
891
879
|
}
|
|
892
880
|
```
|
|
893
881
|
|
|
894
|
-
See also: [SendWithResultStatus](#type-sendwithresultstatus), [TXIDHexString](#type-txidhexstring)
|
|
882
|
+
See also: [SendWithResultStatus](./wallet.md#type-sendwithresultstatus), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
895
883
|
|
|
896
884
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
897
885
|
|
|
@@ -906,7 +894,7 @@ export interface SignActionArgs {
|
|
|
906
894
|
}
|
|
907
895
|
```
|
|
908
896
|
|
|
909
|
-
See also: [Base64String](#type-base64string), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SignActionOptions](#interface-signactionoptions), [SignActionSpend](#interface-signactionspend)
|
|
897
|
+
See also: [Base64String](./wallet.md#type-base64string), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [SignActionOptions](./wallet.md#interface-signactionoptions), [SignActionSpend](./wallet.md#interface-signactionspend)
|
|
910
898
|
|
|
911
899
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
912
900
|
|
|
@@ -922,7 +910,7 @@ export interface SignActionOptions {
|
|
|
922
910
|
}
|
|
923
911
|
```
|
|
924
912
|
|
|
925
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [TXIDHexString](#type-txidhexstring)
|
|
913
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
926
914
|
|
|
927
915
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
928
916
|
|
|
@@ -937,7 +925,7 @@ export interface SignActionResult {
|
|
|
937
925
|
}
|
|
938
926
|
```
|
|
939
927
|
|
|
940
|
-
See also: [AtomicBEEF](#type-atomicbeef), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
928
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [SendWithResult](./wallet.md#interface-sendwithresult), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
941
929
|
|
|
942
930
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
943
931
|
|
|
@@ -951,7 +939,7 @@ export interface SignActionSpend {
|
|
|
951
939
|
}
|
|
952
940
|
```
|
|
953
941
|
|
|
954
|
-
See also: [HexString](#type-hexstring), [PositiveIntegerOrZero](#type-positiveintegerorzero)
|
|
942
|
+
See also: [HexString](./wallet.md#type-hexstring), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero)
|
|
955
943
|
|
|
956
944
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
957
945
|
|
|
@@ -965,7 +953,7 @@ export interface SignableTransaction {
|
|
|
965
953
|
}
|
|
966
954
|
```
|
|
967
955
|
|
|
968
|
-
See also: [AtomicBEEF](#type-atomicbeef), [Base64String](#type-base64string)
|
|
956
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [Base64String](./wallet.md#type-base64string)
|
|
969
957
|
|
|
970
958
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
971
959
|
|
|
@@ -979,7 +967,7 @@ export interface VerifyHmacArgs extends WalletEncryptionArgs {
|
|
|
979
967
|
}
|
|
980
968
|
```
|
|
981
969
|
|
|
982
|
-
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
970
|
+
See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#interface-walletencryptionargs)
|
|
983
971
|
|
|
984
972
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
985
973
|
|
|
@@ -1006,7 +994,7 @@ export interface VerifySignatureArgs extends WalletEncryptionArgs {
|
|
|
1006
994
|
}
|
|
1007
995
|
```
|
|
1008
996
|
|
|
1009
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
997
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#interface-walletencryptionargs)
|
|
1010
998
|
|
|
1011
999
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1012
1000
|
|
|
@@ -1039,7 +1027,7 @@ export interface WalletAction {
|
|
|
1039
1027
|
}
|
|
1040
1028
|
```
|
|
1041
1029
|
|
|
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)
|
|
1030
|
+
See also: [ActionStatus](./wallet.md#type-actionstatus), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [SatoshiValue](./wallet.md#type-satoshivalue), [TXIDHexString](./wallet.md#type-txidhexstring), [WalletActionInput](./wallet.md#interface-walletactioninput), [WalletActionOutput](./wallet.md#interface-walletactionoutput)
|
|
1043
1031
|
|
|
1044
1032
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1045
1033
|
|
|
@@ -1057,7 +1045,7 @@ export interface WalletActionInput {
|
|
|
1057
1045
|
}
|
|
1058
1046
|
```
|
|
1059
1047
|
|
|
1060
|
-
See also: [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1048
|
+
See also: [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [SatoshiValue](./wallet.md#type-satoshivalue)
|
|
1061
1049
|
|
|
1062
1050
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1063
1051
|
|
|
@@ -1077,7 +1065,7 @@ export interface WalletActionOutput {
|
|
|
1077
1065
|
}
|
|
1078
1066
|
```
|
|
1079
1067
|
|
|
1080
|
-
See also: [BasketStringUnder300Bytes](#type-basketstringunder300bytes), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [HexString](#type-hexstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](#type-positiveintegerorzero), [SatoshiValue](#type-satoshivalue)
|
|
1068
|
+
See also: [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [HexString](./wallet.md#type-hexstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [SatoshiValue](./wallet.md#type-satoshivalue)
|
|
1081
1069
|
|
|
1082
1070
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1083
1071
|
|
|
@@ -1096,7 +1084,7 @@ export interface WalletCertificate {
|
|
|
1096
1084
|
}
|
|
1097
1085
|
```
|
|
1098
1086
|
|
|
1099
|
-
See also: [Base64String](#type-base64string), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [HexString](#type-hexstring), [OutpointString](#type-outpointstring), [PubKeyHex](#type-pubkeyhex)
|
|
1087
|
+
See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
1100
1088
|
|
|
1101
1089
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1102
1090
|
|
|
@@ -1109,7 +1097,7 @@ export interface WalletDecryptArgs extends WalletEncryptionArgs {
|
|
|
1109
1097
|
}
|
|
1110
1098
|
```
|
|
1111
1099
|
|
|
1112
|
-
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1100
|
+
See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#interface-walletencryptionargs)
|
|
1113
1101
|
|
|
1114
1102
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1115
1103
|
|
|
@@ -1122,7 +1110,7 @@ export interface WalletDecryptResult {
|
|
|
1122
1110
|
}
|
|
1123
1111
|
```
|
|
1124
1112
|
|
|
1125
|
-
See also: [Byte](#type-byte)
|
|
1113
|
+
See also: [Byte](./wallet.md#type-byte)
|
|
1126
1114
|
|
|
1127
1115
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1128
1116
|
|
|
@@ -1135,7 +1123,7 @@ export interface WalletEncryptArgs extends WalletEncryptionArgs {
|
|
|
1135
1123
|
}
|
|
1136
1124
|
```
|
|
1137
1125
|
|
|
1138
|
-
See also: [Byte](#type-byte), [WalletEncryptionArgs](#interface-walletencryptionargs)
|
|
1126
|
+
See also: [Byte](./wallet.md#type-byte), [WalletEncryptionArgs](./wallet.md#interface-walletencryptionargs)
|
|
1139
1127
|
|
|
1140
1128
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1141
1129
|
|
|
@@ -1148,7 +1136,7 @@ export interface WalletEncryptResult {
|
|
|
1148
1136
|
}
|
|
1149
1137
|
```
|
|
1150
1138
|
|
|
1151
|
-
See also: [Byte](#type-byte)
|
|
1139
|
+
See also: [Byte](./wallet.md#type-byte)
|
|
1152
1140
|
|
|
1153
1141
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1154
1142
|
|
|
@@ -1166,7 +1154,7 @@ export interface WalletEncryptionArgs {
|
|
|
1166
1154
|
}
|
|
1167
1155
|
```
|
|
1168
1156
|
|
|
1169
|
-
See also: [BooleanDefaultFalse](#type-booleandefaultfalse), [BooleanDefaultTrue](#type-booleandefaulttrue), [DescriptionString5to50Bytes](#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](#type-keyidstringunder800bytes), [WalletCounterparty](#type-walletcounterparty), [WalletProtocol](#type-walletprotocol)
|
|
1157
|
+
See also: [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1170
1158
|
|
|
1171
1159
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1172
1160
|
|
|
@@ -1234,11 +1222,7 @@ export interface WalletInterface {
|
|
|
1234
1222
|
}
|
|
1235
1223
|
```
|
|
1236
1224
|
|
|
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>
|
|
1225
|
+
See also: [AbortActionArgs](./wallet.md#interface-abortactionargs), [AbortActionResult](./wallet.md#interface-abortactionresult), [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [GetHeaderArgs](./wallet.md#interface-getheaderargs), [GetHeaderResult](./wallet.md#interface-getheaderresult), [GetHeightResult](./wallet.md#interface-getheightresult), [GetNetworkResult](./wallet.md#interface-getnetworkresult), [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetPublicKeyResult](./wallet.md#interface-getpublickeyresult), [GetVersionResult](./wallet.md#interface-getversionresult), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesArgs](./wallet.md#interface-listcertificatesargs), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [RelinquishCertificateArgs](./wallet.md#interface-relinquishcertificateargs), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult), [RelinquishOutputArgs](./wallet.md#interface-relinquishoutputargs), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
1242
1226
|
|
|
1243
1227
|
#### Property abortAction
|
|
1244
1228
|
|
|
@@ -1247,7 +1231,7 @@ Aborts a transaction that is in progress and has not yet been finalized or sent
|
|
|
1247
1231
|
```ts
|
|
1248
1232
|
abortAction: (args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AbortActionResult>
|
|
1249
1233
|
```
|
|
1250
|
-
See also: [AbortActionArgs](#interface-abortactionargs), [AbortActionResult](#interface-abortactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1234
|
+
See also: [AbortActionArgs](./wallet.md#interface-abortactionargs), [AbortActionResult](./wallet.md#interface-abortactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1251
1235
|
|
|
1252
1236
|
#### Property acquireCertificate
|
|
1253
1237
|
|
|
@@ -1256,7 +1240,7 @@ Acquires an identity certificate, whether by acquiring one from the certifier or
|
|
|
1256
1240
|
```ts
|
|
1257
1241
|
acquireCertificate: (args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletCertificate>
|
|
1258
1242
|
```
|
|
1259
|
-
See also: [AcquireCertificateArgs](#interface-acquirecertificateargs), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletCertificate](#interface-walletcertificate)
|
|
1243
|
+
See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
1260
1244
|
|
|
1261
1245
|
#### Property createAction
|
|
1262
1246
|
|
|
@@ -1265,7 +1249,7 @@ Creates a new Bitcoin transaction based on the provided inputs, outputs, labels,
|
|
|
1265
1249
|
```ts
|
|
1266
1250
|
createAction: (args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateActionResult>
|
|
1267
1251
|
```
|
|
1268
|
-
See also: [CreateActionArgs](#interface-createactionargs), [CreateActionResult](#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1252
|
+
See also: [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1269
1253
|
|
|
1270
1254
|
#### Property createHmac
|
|
1271
1255
|
|
|
@@ -1274,7 +1258,7 @@ Creates an HMAC (Hash-based Message Authentication Code) based on the provided d
|
|
|
1274
1258
|
```ts
|
|
1275
1259
|
createHmac: (args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateHmacResult>
|
|
1276
1260
|
```
|
|
1277
|
-
See also: [CreateHmacArgs](#interface-createhmacargs), [CreateHmacResult](#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1261
|
+
See also: [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1278
1262
|
|
|
1279
1263
|
#### Property createSignature
|
|
1280
1264
|
|
|
@@ -1283,7 +1267,7 @@ Creates a digital signature for the provided data or hash using a specific proto
|
|
|
1283
1267
|
```ts
|
|
1284
1268
|
createSignature: (args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<CreateSignatureResult>
|
|
1285
1269
|
```
|
|
1286
|
-
See also: [CreateSignatureArgs](#interface-createsignatureargs), [CreateSignatureResult](#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1270
|
+
See also: [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1287
1271
|
|
|
1288
1272
|
#### Property decrypt
|
|
1289
1273
|
|
|
@@ -1292,7 +1276,7 @@ Decrypts the provided ciphertext using derived keys, based on the protocol ID, k
|
|
|
1292
1276
|
```ts
|
|
1293
1277
|
decrypt: (args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletDecryptResult>
|
|
1294
1278
|
```
|
|
1295
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](#interface-walletdecryptargs), [WalletDecryptResult](#interface-walletdecryptresult)
|
|
1279
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult)
|
|
1296
1280
|
|
|
1297
1281
|
#### Property discoverByAttributes
|
|
1298
1282
|
|
|
@@ -1301,7 +1285,7 @@ Discovers identity certificates belonging to other users, where the documents co
|
|
|
1301
1285
|
```ts
|
|
1302
1286
|
discoverByAttributes: (args: DiscoverByAttributesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1303
1287
|
```
|
|
1304
|
-
See also: [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1288
|
+
See also: [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1305
1289
|
|
|
1306
1290
|
#### Property discoverByIdentityKey
|
|
1307
1291
|
|
|
@@ -1310,7 +1294,7 @@ Discovers identity certificates, issued to a given identity key by a trusted ent
|
|
|
1310
1294
|
```ts
|
|
1311
1295
|
discoverByIdentityKey: (args: DiscoverByIdentityKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<DiscoverCertificatesResult>
|
|
1312
1296
|
```
|
|
1313
|
-
See also: [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1297
|
+
See also: [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1314
1298
|
|
|
1315
1299
|
#### Property encrypt
|
|
1316
1300
|
|
|
@@ -1319,7 +1303,7 @@ Encrypts the provided plaintext data using derived keys, based on the protocol I
|
|
|
1319
1303
|
```ts
|
|
1320
1304
|
encrypt: (args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<WalletEncryptResult>
|
|
1321
1305
|
```
|
|
1322
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](#interface-walletencryptargs), [WalletEncryptResult](#interface-walletencryptresult)
|
|
1306
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult)
|
|
1323
1307
|
|
|
1324
1308
|
#### Property getHeaderForHeight
|
|
1325
1309
|
|
|
@@ -1328,7 +1312,7 @@ Retrieves the block header of a block at a specified height.
|
|
|
1328
1312
|
```ts
|
|
1329
1313
|
getHeaderForHeight: (args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeaderResult>
|
|
1330
1314
|
```
|
|
1331
|
-
See also: [GetHeaderArgs](#interface-getheaderargs), [GetHeaderResult](#interface-getheaderresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1315
|
+
See also: [GetHeaderArgs](./wallet.md#interface-getheaderargs), [GetHeaderResult](./wallet.md#interface-getheaderresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1332
1316
|
|
|
1333
1317
|
#### Property getHeight
|
|
1334
1318
|
|
|
@@ -1337,7 +1321,7 @@ Retrieves the current height of the blockchain.
|
|
|
1337
1321
|
```ts
|
|
1338
1322
|
getHeight: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetHeightResult>
|
|
1339
1323
|
```
|
|
1340
|
-
See also: [GetHeightResult](#interface-getheightresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1324
|
+
See also: [GetHeightResult](./wallet.md#interface-getheightresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1341
1325
|
|
|
1342
1326
|
#### Property getNetwork
|
|
1343
1327
|
|
|
@@ -1346,7 +1330,7 @@ Retrieves the Bitcoin network the client is using (mainnet or testnet).
|
|
|
1346
1330
|
```ts
|
|
1347
1331
|
getNetwork: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetNetworkResult>
|
|
1348
1332
|
```
|
|
1349
|
-
See also: [GetNetworkResult](#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1333
|
+
See also: [GetNetworkResult](./wallet.md#interface-getnetworkresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1350
1334
|
|
|
1351
1335
|
#### Property getPublicKey
|
|
1352
1336
|
|
|
@@ -1355,7 +1339,7 @@ Retrieves a derived or identity public key based on the requested protocol, key
|
|
|
1355
1339
|
```ts
|
|
1356
1340
|
getPublicKey: (args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetPublicKeyResult>
|
|
1357
1341
|
```
|
|
1358
|
-
See also: [GetPublicKeyArgs](#interface-getpublickeyargs), [GetPublicKeyResult](#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1342
|
+
See also: [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetPublicKeyResult](./wallet.md#interface-getpublickeyresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1359
1343
|
|
|
1360
1344
|
#### Property getVersion
|
|
1361
1345
|
|
|
@@ -1364,7 +1348,7 @@ Retrieves the current version string of the wallet.
|
|
|
1364
1348
|
```ts
|
|
1365
1349
|
getVersion: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<GetVersionResult>
|
|
1366
1350
|
```
|
|
1367
|
-
See also: [GetVersionResult](#interface-getversionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1351
|
+
See also: [GetVersionResult](./wallet.md#interface-getversionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1368
1352
|
|
|
1369
1353
|
#### Property internalizeAction
|
|
1370
1354
|
|
|
@@ -1373,7 +1357,7 @@ Submits a transaction to be internalized and optionally labeled, outputs paid to
|
|
|
1373
1357
|
```ts
|
|
1374
1358
|
internalizeAction: (args: InternalizeActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<InternalizeActionResult>
|
|
1375
1359
|
```
|
|
1376
|
-
See also: [InternalizeActionArgs](#interface-internalizeactionargs), [InternalizeActionResult](#interface-internalizeactionresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1360
|
+
See also: [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1377
1361
|
|
|
1378
1362
|
#### Property isAuthenticated
|
|
1379
1363
|
|
|
@@ -1382,7 +1366,7 @@ Checks the authentication status of the user.
|
|
|
1382
1366
|
```ts
|
|
1383
1367
|
isAuthenticated: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1384
1368
|
```
|
|
1385
|
-
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1369
|
+
See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1386
1370
|
|
|
1387
1371
|
#### Property listActions
|
|
1388
1372
|
|
|
@@ -1391,7 +1375,7 @@ Lists all transactions matching the specified labels.
|
|
|
1391
1375
|
```ts
|
|
1392
1376
|
listActions: (args: ListActionsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListActionsResult>
|
|
1393
1377
|
```
|
|
1394
|
-
See also: [ListActionsArgs](#interface-listactionsargs), [ListActionsResult](#interface-listactionsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1378
|
+
See also: [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1395
1379
|
|
|
1396
1380
|
#### Property listCertificates
|
|
1397
1381
|
|
|
@@ -1400,7 +1384,7 @@ Lists identity certificates belonging to the user, filtered by certifier(s) and
|
|
|
1400
1384
|
```ts
|
|
1401
1385
|
listCertificates: (args: ListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListCertificatesResult>
|
|
1402
1386
|
```
|
|
1403
|
-
See also: [ListCertificatesArgs](#interface-listcertificatesargs), [ListCertificatesResult](#interface-listcertificatesresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1387
|
+
See also: [ListCertificatesArgs](./wallet.md#interface-listcertificatesargs), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1404
1388
|
|
|
1405
1389
|
#### Property listOutputs
|
|
1406
1390
|
|
|
@@ -1409,7 +1393,7 @@ Lists the spendable outputs kept within a specific basket, optionally tagged wit
|
|
|
1409
1393
|
```ts
|
|
1410
1394
|
listOutputs: (args: ListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ListOutputsResult>
|
|
1411
1395
|
```
|
|
1412
|
-
See also: [ListOutputsArgs](#interface-listoutputsargs), [ListOutputsResult](#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1396
|
+
See also: [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1413
1397
|
|
|
1414
1398
|
#### Property proveCertificate
|
|
1415
1399
|
|
|
@@ -1418,7 +1402,7 @@ Proves select fields of an identity certificate, as specified, when requested by
|
|
|
1418
1402
|
```ts
|
|
1419
1403
|
proveCertificate: (args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<ProveCertificateResult>
|
|
1420
1404
|
```
|
|
1421
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](#interface-provecertificateargs), [ProveCertificateResult](#interface-provecertificateresult)
|
|
1405
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult)
|
|
1422
1406
|
|
|
1423
1407
|
#### Property relinquishCertificate
|
|
1424
1408
|
|
|
@@ -1427,7 +1411,7 @@ Relinquishes an identity certificate, removing it from the wallet regardless of
|
|
|
1427
1411
|
```ts
|
|
1428
1412
|
relinquishCertificate: (args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishCertificateResult>
|
|
1429
1413
|
```
|
|
1430
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishCertificateArgs](#interface-relinquishcertificateargs), [RelinquishCertificateResult](#interface-relinquishcertificateresult)
|
|
1414
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RelinquishCertificateArgs](./wallet.md#interface-relinquishcertificateargs), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult)
|
|
1431
1415
|
|
|
1432
1416
|
#### Property relinquishOutput
|
|
1433
1417
|
|
|
@@ -1436,7 +1420,7 @@ Relinquish an output out of a basket, removing it from tracking without spending
|
|
|
1436
1420
|
```ts
|
|
1437
1421
|
relinquishOutput: (args: RelinquishOutputArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RelinquishOutputResult>
|
|
1438
1422
|
```
|
|
1439
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](#interface-relinquishoutputargs), [RelinquishOutputResult](#interface-relinquishoutputresult)
|
|
1423
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RelinquishOutputArgs](./wallet.md#interface-relinquishoutputargs), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult)
|
|
1440
1424
|
|
|
1441
1425
|
#### Property revealCounterpartyKeyLinkage
|
|
1442
1426
|
|
|
@@ -1445,7 +1429,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1445
1429
|
```ts
|
|
1446
1430
|
revealCounterpartyKeyLinkage: (args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealCounterpartyKeyLinkageResult>
|
|
1447
1431
|
```
|
|
1448
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](#interface-revealcounterpartykeylinkageresult)
|
|
1432
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult)
|
|
1449
1433
|
|
|
1450
1434
|
#### Property revealSpecificKeyLinkage
|
|
1451
1435
|
|
|
@@ -1454,7 +1438,7 @@ Reveals the key linkage between ourselves and a counterparty, to a particular ve
|
|
|
1454
1438
|
```ts
|
|
1455
1439
|
revealSpecificKeyLinkage: (args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<RevealSpecificKeyLinkageResult>
|
|
1456
1440
|
```
|
|
1457
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](#interface-revealspecifickeylinkageresult)
|
|
1441
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult)
|
|
1458
1442
|
|
|
1459
1443
|
#### Property signAction
|
|
1460
1444
|
|
|
@@ -1463,7 +1447,7 @@ Signs a transaction previously created using `createAction`.
|
|
|
1463
1447
|
```ts
|
|
1464
1448
|
signAction: (args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<SignActionResult>
|
|
1465
1449
|
```
|
|
1466
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [SignActionArgs](#interface-signactionargs), [SignActionResult](#interface-signactionresult)
|
|
1450
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult)
|
|
1467
1451
|
|
|
1468
1452
|
#### Property verifyHmac
|
|
1469
1453
|
|
|
@@ -1472,7 +1456,7 @@ Verifies an HMAC (Hash-based Message Authentication Code) based on the provided
|
|
|
1472
1456
|
```ts
|
|
1473
1457
|
verifyHmac: (args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifyHmacResult>
|
|
1474
1458
|
```
|
|
1475
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](#interface-verifyhmacargs), [VerifyHmacResult](#interface-verifyhmacresult)
|
|
1459
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult)
|
|
1476
1460
|
|
|
1477
1461
|
#### Property verifySignature
|
|
1478
1462
|
|
|
@@ -1481,7 +1465,7 @@ Verifies a digital signature for the provided data or hash using a specific prot
|
|
|
1481
1465
|
```ts
|
|
1482
1466
|
verifySignature: (args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<VerifySignatureResult>
|
|
1483
1467
|
```
|
|
1484
|
-
See also: [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](#interface-verifysignatureargs), [VerifySignatureResult](#interface-verifysignatureresult)
|
|
1468
|
+
See also: [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult)
|
|
1485
1469
|
|
|
1486
1470
|
#### Property waitForAuthentication
|
|
1487
1471
|
|
|
@@ -1490,9 +1474,7 @@ Continuously waits until the user is authenticated, returning the result once co
|
|
|
1490
1474
|
```ts
|
|
1491
1475
|
waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnder250Bytes) => Promise<AuthenticatedResult>
|
|
1492
1476
|
```
|
|
1493
|
-
See also: [AuthenticatedResult](#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes)
|
|
1494
|
-
|
|
1495
|
-
</details>
|
|
1477
|
+
See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
|
|
1496
1478
|
|
|
1497
1479
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1498
1480
|
|
|
@@ -1511,7 +1493,7 @@ export interface WalletOutput {
|
|
|
1511
1493
|
}
|
|
1512
1494
|
```
|
|
1513
1495
|
|
|
1514
|
-
See also: [HexString](#type-hexstring), [LabelStringUnder300Bytes](#type-labelstringunder300bytes), [OutpointString](#type-outpointstring), [OutputTagStringUnder300Bytes](#type-outputtagstringunder300bytes), [SatoshiValue](#type-satoshivalue)
|
|
1496
|
+
See also: [HexString](./wallet.md#type-hexstring), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [OutpointString](./wallet.md#type-outpointstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [SatoshiValue](./wallet.md#type-satoshivalue)
|
|
1515
1497
|
|
|
1516
1498
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1517
1499
|
|
|
@@ -1526,7 +1508,7 @@ export interface WalletPayment {
|
|
|
1526
1508
|
}
|
|
1527
1509
|
```
|
|
1528
1510
|
|
|
1529
|
-
See also: [Base64String](#type-base64string), [PubKeyHex](#type-pubkeyhex)
|
|
1511
|
+
See also: [Base64String](./wallet.md#type-base64string), [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
1530
1512
|
|
|
1531
1513
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1532
1514
|
|
|
@@ -1546,20 +1528,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
1546
1528
|
---
|
|
1547
1529
|
## Classes
|
|
1548
1530
|
|
|
1549
|
-
| |
|
|
1550
|
-
| --- |
|
|
1551
|
-
| [CachedKeyDeriver](#class-cachedkeyderiver) |
|
|
1552
|
-
| [HTTPWalletJSON](#class-httpwalletjson) |
|
|
1553
|
-
| [HTTPWalletWire](#class-httpwalletwire) |
|
|
1554
|
-
| [KeyDeriver](#class-keyderiver) |
|
|
1555
|
-
| [ProtoWallet](#class-protowallet) |
|
|
1556
|
-
| [
|
|
1557
|
-
| [
|
|
1558
|
-
| [WalletError](#class-walleterror) |
|
|
1559
|
-
| [WalletWireProcessor](#class-walletwireprocessor) |
|
|
1560
|
-
| [WalletWireTransceiver](#class-walletwiretransceiver) |
|
|
1561
|
-
| [WindowCWISubstrate](#class-windowcwisubstrate) |
|
|
1562
|
-
| [XDMSubstrate](#class-xdmsubstrate) |
|
|
1531
|
+
| | |
|
|
1532
|
+
| --- | --- |
|
|
1533
|
+
| [CachedKeyDeriver](#class-cachedkeyderiver) | [WalletClient](#class-walletclient) |
|
|
1534
|
+
| [HTTPWalletJSON](#class-httpwalletjson) | [WalletError](#class-walleterror) |
|
|
1535
|
+
| [HTTPWalletWire](#class-httpwalletwire) | [WalletWireProcessor](#class-walletwireprocessor) |
|
|
1536
|
+
| [KeyDeriver](#class-keyderiver) | [WalletWireTransceiver](#class-walletwiretransceiver) |
|
|
1537
|
+
| [ProtoWallet](#class-protowallet) | [WindowCWISubstrate](#class-windowcwisubstrate) |
|
|
1538
|
+
| [ReactNativeWebView](#class-reactnativewebview) | [XDMSubstrate](#class-xdmsubstrate) |
|
|
1539
|
+
| [WERR_REVIEW_ACTIONS](#class-werr_review_actions) | |
|
|
1563
1540
|
|
|
1564
1541
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1565
1542
|
|
|
@@ -1584,11 +1561,7 @@ export default class CachedKeyDeriver {
|
|
|
1584
1561
|
}
|
|
1585
1562
|
```
|
|
1586
1563
|
|
|
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>
|
|
1564
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1592
1565
|
|
|
1593
1566
|
#### Constructor
|
|
1594
1567
|
|
|
@@ -1599,7 +1572,7 @@ constructor(rootKey: PrivateKey | "anyone", options?: {
|
|
|
1599
1572
|
maxCacheSize?: number;
|
|
1600
1573
|
})
|
|
1601
1574
|
```
|
|
1602
|
-
See also: [PrivateKey](#class-privatekey)
|
|
1575
|
+
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
1603
1576
|
|
|
1604
1577
|
Argument Details
|
|
1605
1578
|
|
|
@@ -1616,7 +1589,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1616
1589
|
```ts
|
|
1617
1590
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
1618
1591
|
```
|
|
1619
|
-
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
1592
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1620
1593
|
|
|
1621
1594
|
Returns
|
|
1622
1595
|
|
|
@@ -1639,7 +1612,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1639
1612
|
```ts
|
|
1640
1613
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
1641
1614
|
```
|
|
1642
|
-
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
1615
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1643
1616
|
|
|
1644
1617
|
Returns
|
|
1645
1618
|
|
|
@@ -1664,7 +1637,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1664
1637
|
```ts
|
|
1665
1638
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
1666
1639
|
```
|
|
1667
|
-
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
1640
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1668
1641
|
|
|
1669
1642
|
Returns
|
|
1670
1643
|
|
|
@@ -1691,7 +1664,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1691
1664
|
```ts
|
|
1692
1665
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
1693
1666
|
```
|
|
1694
|
-
See also: [Counterparty](#type-counterparty)
|
|
1667
|
+
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
1695
1668
|
|
|
1696
1669
|
Returns
|
|
1697
1670
|
|
|
@@ -1714,7 +1687,7 @@ Caches the result for future calls with the same parameters.
|
|
|
1714
1687
|
```ts
|
|
1715
1688
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
1716
1689
|
```
|
|
1717
|
-
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
1690
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
1718
1691
|
|
|
1719
1692
|
Returns
|
|
1720
1693
|
|
|
@@ -1729,8 +1702,6 @@ Argument Details
|
|
|
1729
1702
|
+ **keyID**
|
|
1730
1703
|
+ The key identifier.
|
|
1731
1704
|
|
|
1732
|
-
</details>
|
|
1733
|
-
|
|
1734
1705
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1735
1706
|
|
|
1736
1707
|
---
|
|
@@ -1953,7 +1924,7 @@ export default class HTTPWalletJSON implements WalletInterface {
|
|
|
1953
1924
|
}
|
|
1954
1925
|
```
|
|
1955
1926
|
|
|
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)
|
|
1927
|
+
See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
1957
1928
|
|
|
1958
1929
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1959
1930
|
|
|
@@ -1970,7 +1941,7 @@ export default class HTTPWalletWire implements WalletWire {
|
|
|
1970
1941
|
}
|
|
1971
1942
|
```
|
|
1972
1943
|
|
|
1973
|
-
See also: [WalletWire](#interface-walletwire)
|
|
1944
|
+
See also: [WalletWire](./wallet.md#interface-walletwire)
|
|
1974
1945
|
|
|
1975
1946
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1976
1947
|
|
|
@@ -1993,11 +1964,7 @@ export class KeyDeriver implements KeyDeriverApi {
|
|
|
1993
1964
|
}
|
|
1994
1965
|
```
|
|
1995
1966
|
|
|
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>
|
|
1967
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2001
1968
|
|
|
2002
1969
|
#### Constructor
|
|
2003
1970
|
|
|
@@ -2006,7 +1973,7 @@ Initializes the KeyDeriver instance with a root private key.
|
|
|
2006
1973
|
```ts
|
|
2007
1974
|
constructor(rootKey: PrivateKey | "anyone")
|
|
2008
1975
|
```
|
|
2009
|
-
See also: [PrivateKey](#class-privatekey)
|
|
1976
|
+
See also: [PrivateKey](./primitives.md#class-privatekey)
|
|
2010
1977
|
|
|
2011
1978
|
Argument Details
|
|
2012
1979
|
|
|
@@ -2020,7 +1987,7 @@ Derives a private key based on protocol ID, key ID, and counterparty.
|
|
|
2020
1987
|
```ts
|
|
2021
1988
|
derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey
|
|
2022
1989
|
```
|
|
2023
|
-
See also: [Counterparty](#type-counterparty), [PrivateKey](#class-privatekey), [WalletProtocol](#type-walletprotocol)
|
|
1990
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2024
1991
|
|
|
2025
1992
|
Returns
|
|
2026
1993
|
|
|
@@ -2042,7 +2009,7 @@ Derives a public key based on protocol ID, key ID, and counterparty.
|
|
|
2042
2009
|
```ts
|
|
2043
2010
|
derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf: boolean = false): PublicKey
|
|
2044
2011
|
```
|
|
2045
|
-
See also: [Counterparty](#type-counterparty), [PublicKey](#class-publickey), [WalletProtocol](#type-walletprotocol)
|
|
2012
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [PublicKey](./primitives.md#class-publickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2046
2013
|
|
|
2047
2014
|
Returns
|
|
2048
2015
|
|
|
@@ -2067,7 +2034,7 @@ Note: Symmetric keys should not be derivable by everyone due to security risks.
|
|
|
2067
2034
|
```ts
|
|
2068
2035
|
deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey
|
|
2069
2036
|
```
|
|
2070
|
-
See also: [Counterparty](#type-counterparty), [SymmetricKey](#class-symmetrickey), [WalletProtocol](#type-walletprotocol)
|
|
2037
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2071
2038
|
|
|
2072
2039
|
Returns
|
|
2073
2040
|
|
|
@@ -2090,7 +2057,7 @@ Note: This should not be used for 'self'.
|
|
|
2090
2057
|
```ts
|
|
2091
2058
|
revealCounterpartySecret(counterparty: Counterparty): number[]
|
|
2092
2059
|
```
|
|
2093
|
-
See also: [Counterparty](#type-counterparty)
|
|
2060
|
+
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
2094
2061
|
|
|
2095
2062
|
Returns
|
|
2096
2063
|
|
|
@@ -2112,7 +2079,7 @@ Reveals the specific key association for a given protocol ID, key ID, and counte
|
|
|
2112
2079
|
```ts
|
|
2113
2080
|
revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[]
|
|
2114
2081
|
```
|
|
2115
|
-
See also: [Counterparty](#type-counterparty), [WalletProtocol](#type-walletprotocol)
|
|
2082
|
+
See also: [Counterparty](./wallet.md#type-counterparty), [WalletProtocol](./wallet.md#type-walletprotocol)
|
|
2116
2083
|
|
|
2117
2084
|
Returns
|
|
2118
2085
|
|
|
@@ -2127,8 +2094,6 @@ Argument Details
|
|
|
2127
2094
|
+ **keyID**
|
|
2128
2095
|
+ The key identifier.
|
|
2129
2096
|
|
|
2130
|
-
</details>
|
|
2131
|
-
|
|
2132
2097
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2133
2098
|
|
|
2134
2099
|
---
|
|
@@ -2158,7 +2123,451 @@ export class ProtoWallet {
|
|
|
2158
2123
|
}
|
|
2159
2124
|
```
|
|
2160
2125
|
|
|
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)
|
|
2126
|
+
See also: [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PubKeyHex](./wallet.md#type-pubkeyhex), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
2127
|
+
|
|
2128
|
+
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2129
|
+
|
|
2130
|
+
---
|
|
2131
|
+
### Class: ReactNativeWebView
|
|
2132
|
+
|
|
2133
|
+
Facilitates wallet operations over cross-document messaging.
|
|
2134
|
+
|
|
2135
|
+
```ts
|
|
2136
|
+
export default class ReactNativeWebView implements WalletInterface {
|
|
2137
|
+
constructor(domain: string = "*")
|
|
2138
|
+
async invoke(call: CallType, args: any): Promise<any>
|
|
2139
|
+
async createAction(args: {
|
|
2140
|
+
description: DescriptionString5to50Bytes;
|
|
2141
|
+
inputs?: Array<{
|
|
2142
|
+
tx?: BEEF;
|
|
2143
|
+
outpoint: OutpointString;
|
|
2144
|
+
unlockingScript?: HexString;
|
|
2145
|
+
unlockingScriptLength?: PositiveInteger;
|
|
2146
|
+
inputDescription: DescriptionString5to50Bytes;
|
|
2147
|
+
sequenceNumber?: PositiveIntegerOrZero;
|
|
2148
|
+
}>;
|
|
2149
|
+
outputs?: Array<{
|
|
2150
|
+
lockingScript: HexString;
|
|
2151
|
+
satoshis: SatoshiValue;
|
|
2152
|
+
outputDescription: DescriptionString5to50Bytes;
|
|
2153
|
+
basket?: BasketStringUnder300Bytes;
|
|
2154
|
+
customInstructions?: string;
|
|
2155
|
+
tags?: OutputTagStringUnder300Bytes[];
|
|
2156
|
+
}>;
|
|
2157
|
+
lockTime?: PositiveIntegerOrZero;
|
|
2158
|
+
version?: PositiveIntegerOrZero;
|
|
2159
|
+
labels?: LabelStringUnder300Bytes[];
|
|
2160
|
+
options?: {
|
|
2161
|
+
signAndProcess?: BooleanDefaultTrue;
|
|
2162
|
+
acceptDelayedBroadcast?: BooleanDefaultTrue;
|
|
2163
|
+
trustSelf?: "known";
|
|
2164
|
+
knownTxids?: TXIDHexString[];
|
|
2165
|
+
returnTXIDOnly?: BooleanDefaultFalse;
|
|
2166
|
+
noSend?: BooleanDefaultFalse;
|
|
2167
|
+
noSendChange?: OutpointString[];
|
|
2168
|
+
sendWith?: TXIDHexString[];
|
|
2169
|
+
};
|
|
2170
|
+
}): Promise<{
|
|
2171
|
+
txid?: TXIDHexString;
|
|
2172
|
+
tx?: BEEF;
|
|
2173
|
+
noSendChange?: OutpointString[];
|
|
2174
|
+
sendWithResults?: Array<{
|
|
2175
|
+
txid: TXIDHexString;
|
|
2176
|
+
status: "unproven" | "sending" | "failed";
|
|
2177
|
+
}>;
|
|
2178
|
+
signableTransaction?: {
|
|
2179
|
+
tx: BEEF;
|
|
2180
|
+
reference: Base64String;
|
|
2181
|
+
};
|
|
2182
|
+
}>
|
|
2183
|
+
async signAction(args: {
|
|
2184
|
+
spends: Record<PositiveIntegerOrZero, {
|
|
2185
|
+
unlockingScript: HexString;
|
|
2186
|
+
sequenceNumber?: PositiveIntegerOrZero;
|
|
2187
|
+
}>;
|
|
2188
|
+
reference: Base64String;
|
|
2189
|
+
options?: {
|
|
2190
|
+
acceptDelayedBroadcast?: BooleanDefaultTrue;
|
|
2191
|
+
returnTXIDOnly?: BooleanDefaultFalse;
|
|
2192
|
+
noSend?: BooleanDefaultFalse;
|
|
2193
|
+
noSendChange?: OutpointString[];
|
|
2194
|
+
sendWith: TXIDHexString[];
|
|
2195
|
+
};
|
|
2196
|
+
}): Promise<{
|
|
2197
|
+
txid?: TXIDHexString;
|
|
2198
|
+
tx?: BEEF;
|
|
2199
|
+
noSendChange?: OutpointString[];
|
|
2200
|
+
sendWithResults?: Array<{
|
|
2201
|
+
txid: TXIDHexString;
|
|
2202
|
+
status: "unproven" | "sending" | "failed";
|
|
2203
|
+
}>;
|
|
2204
|
+
}>
|
|
2205
|
+
async abortAction(args: {
|
|
2206
|
+
reference: Base64String;
|
|
2207
|
+
}): Promise<{
|
|
2208
|
+
aborted: true;
|
|
2209
|
+
}>
|
|
2210
|
+
async listActions(args: {
|
|
2211
|
+
labels: LabelStringUnder300Bytes[];
|
|
2212
|
+
labelQueryMode?: "any" | "all";
|
|
2213
|
+
includeLabels?: BooleanDefaultFalse;
|
|
2214
|
+
includeInputs?: BooleanDefaultFalse;
|
|
2215
|
+
includeInputSourceLockingScripts?: BooleanDefaultFalse;
|
|
2216
|
+
includeInputUnlockingScripts?: BooleanDefaultFalse;
|
|
2217
|
+
includeOutputs?: BooleanDefaultFalse;
|
|
2218
|
+
includeOutputLockingScripts?: BooleanDefaultFalse;
|
|
2219
|
+
limit?: PositiveIntegerDefault10Max10000;
|
|
2220
|
+
offset?: PositiveIntegerOrZero;
|
|
2221
|
+
}): Promise<{
|
|
2222
|
+
totalActions: PositiveIntegerOrZero;
|
|
2223
|
+
actions: Array<{
|
|
2224
|
+
txid: TXIDHexString;
|
|
2225
|
+
satoshis: SatoshiValue;
|
|
2226
|
+
status: "completed" | "unprocessed" | "sending" | "unproven" | "unsigned" | "nosend" | "nonfinal";
|
|
2227
|
+
isOutgoing: boolean;
|
|
2228
|
+
description: DescriptionString5to50Bytes;
|
|
2229
|
+
labels?: LabelStringUnder300Bytes[];
|
|
2230
|
+
version: PositiveIntegerOrZero;
|
|
2231
|
+
lockTime: PositiveIntegerOrZero;
|
|
2232
|
+
inputs?: Array<{
|
|
2233
|
+
sourceOutpoint: OutpointString;
|
|
2234
|
+
sourceSatoshis: SatoshiValue;
|
|
2235
|
+
sourceLockingScript?: HexString;
|
|
2236
|
+
unlockingScript?: HexString;
|
|
2237
|
+
inputDescription: DescriptionString5to50Bytes;
|
|
2238
|
+
sequenceNumber: PositiveIntegerOrZero;
|
|
2239
|
+
}>;
|
|
2240
|
+
outputs?: Array<{
|
|
2241
|
+
outputIndex: PositiveIntegerOrZero;
|
|
2242
|
+
satoshis: SatoshiValue;
|
|
2243
|
+
lockingScript?: HexString;
|
|
2244
|
+
spendable: boolean;
|
|
2245
|
+
outputDescription: DescriptionString5to50Bytes;
|
|
2246
|
+
basket: BasketStringUnder300Bytes;
|
|
2247
|
+
tags: OutputTagStringUnder300Bytes[];
|
|
2248
|
+
customInstructions?: string;
|
|
2249
|
+
}>;
|
|
2250
|
+
}>;
|
|
2251
|
+
}>
|
|
2252
|
+
async internalizeAction(args: {
|
|
2253
|
+
tx: BEEF;
|
|
2254
|
+
outputs: Array<{
|
|
2255
|
+
outputIndex: PositiveIntegerOrZero;
|
|
2256
|
+
protocol: "wallet payment" | "basket insertion";
|
|
2257
|
+
paymentRemittance?: {
|
|
2258
|
+
derivationPrefix: Base64String;
|
|
2259
|
+
derivationSuffix: Base64String;
|
|
2260
|
+
senderIdentityKey: PubKeyHex;
|
|
2261
|
+
};
|
|
2262
|
+
insertionRemittance?: {
|
|
2263
|
+
basket: BasketStringUnder300Bytes;
|
|
2264
|
+
customInstructions?: string;
|
|
2265
|
+
tags?: OutputTagStringUnder300Bytes[];
|
|
2266
|
+
};
|
|
2267
|
+
}>;
|
|
2268
|
+
description: DescriptionString5to50Bytes;
|
|
2269
|
+
labels?: LabelStringUnder300Bytes[];
|
|
2270
|
+
}): Promise<{
|
|
2271
|
+
accepted: true;
|
|
2272
|
+
}>
|
|
2273
|
+
async listOutputs(args: {
|
|
2274
|
+
basket: BasketStringUnder300Bytes;
|
|
2275
|
+
tags?: OutputTagStringUnder300Bytes[];
|
|
2276
|
+
tagQueryMode?: "all" | "any";
|
|
2277
|
+
include?: "locking scripts" | "entire transactions";
|
|
2278
|
+
includeCustomInstructions?: BooleanDefaultFalse;
|
|
2279
|
+
includeTags?: BooleanDefaultFalse;
|
|
2280
|
+
includeLabels?: BooleanDefaultFalse;
|
|
2281
|
+
limit?: PositiveIntegerDefault10Max10000;
|
|
2282
|
+
offset?: PositiveIntegerOrZero;
|
|
2283
|
+
}): Promise<{
|
|
2284
|
+
totalOutputs: PositiveIntegerOrZero;
|
|
2285
|
+
outputs: Array<{
|
|
2286
|
+
outpoint: OutpointString;
|
|
2287
|
+
satoshis: SatoshiValue;
|
|
2288
|
+
lockingScript?: HexString;
|
|
2289
|
+
tx?: BEEF;
|
|
2290
|
+
spendable: boolean;
|
|
2291
|
+
customInstructions?: string;
|
|
2292
|
+
tags?: OutputTagStringUnder300Bytes[];
|
|
2293
|
+
labels?: LabelStringUnder300Bytes[];
|
|
2294
|
+
}>;
|
|
2295
|
+
}>
|
|
2296
|
+
async relinquishOutput(args: {
|
|
2297
|
+
basket: BasketStringUnder300Bytes;
|
|
2298
|
+
output: OutpointString;
|
|
2299
|
+
}): Promise<{
|
|
2300
|
+
relinquished: true;
|
|
2301
|
+
}>
|
|
2302
|
+
async getPublicKey(args: {
|
|
2303
|
+
identityKey?: true;
|
|
2304
|
+
protocolID?: [
|
|
2305
|
+
SecurityLevel,
|
|
2306
|
+
ProtocolString5To400Bytes
|
|
2307
|
+
];
|
|
2308
|
+
keyID?: KeyIDStringUnder800Bytes;
|
|
2309
|
+
privileged?: BooleanDefaultFalse;
|
|
2310
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2311
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2312
|
+
forSelf?: BooleanDefaultFalse;
|
|
2313
|
+
}): Promise<{
|
|
2314
|
+
publicKey: PubKeyHex;
|
|
2315
|
+
}>
|
|
2316
|
+
async revealCounterpartyKeyLinkage(args: {
|
|
2317
|
+
counterparty: PubKeyHex;
|
|
2318
|
+
verifier: PubKeyHex;
|
|
2319
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2320
|
+
privileged?: BooleanDefaultFalse;
|
|
2321
|
+
}): Promise<{
|
|
2322
|
+
prover: PubKeyHex;
|
|
2323
|
+
verifier: PubKeyHex;
|
|
2324
|
+
counterparty: PubKeyHex;
|
|
2325
|
+
revelationTime: ISOTimestampString;
|
|
2326
|
+
encryptedLinkage: Byte[];
|
|
2327
|
+
encryptedLinkageProof: Byte[];
|
|
2328
|
+
}>
|
|
2329
|
+
async revealSpecificKeyLinkage(args: {
|
|
2330
|
+
counterparty: PubKeyHex;
|
|
2331
|
+
verifier: PubKeyHex;
|
|
2332
|
+
protocolID: [
|
|
2333
|
+
SecurityLevel,
|
|
2334
|
+
ProtocolString5To400Bytes
|
|
2335
|
+
];
|
|
2336
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2337
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2338
|
+
privileged?: BooleanDefaultFalse;
|
|
2339
|
+
}): Promise<{
|
|
2340
|
+
prover: PubKeyHex;
|
|
2341
|
+
verifier: PubKeyHex;
|
|
2342
|
+
counterparty: PubKeyHex;
|
|
2343
|
+
protocolID: [
|
|
2344
|
+
SecurityLevel,
|
|
2345
|
+
ProtocolString5To400Bytes
|
|
2346
|
+
];
|
|
2347
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2348
|
+
encryptedLinkage: Byte[];
|
|
2349
|
+
encryptedLinkageProof: Byte[];
|
|
2350
|
+
proofType: Byte;
|
|
2351
|
+
}>
|
|
2352
|
+
async encrypt(args: {
|
|
2353
|
+
plaintext: Byte[];
|
|
2354
|
+
protocolID: [
|
|
2355
|
+
SecurityLevel,
|
|
2356
|
+
ProtocolString5To400Bytes
|
|
2357
|
+
];
|
|
2358
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2359
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2360
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2361
|
+
privileged?: BooleanDefaultFalse;
|
|
2362
|
+
}): Promise<{
|
|
2363
|
+
ciphertext: Byte[];
|
|
2364
|
+
}>
|
|
2365
|
+
async decrypt(args: {
|
|
2366
|
+
ciphertext: Byte[];
|
|
2367
|
+
protocolID: [
|
|
2368
|
+
SecurityLevel,
|
|
2369
|
+
ProtocolString5To400Bytes
|
|
2370
|
+
];
|
|
2371
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2372
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2373
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2374
|
+
privileged?: BooleanDefaultFalse;
|
|
2375
|
+
}): Promise<{
|
|
2376
|
+
plaintext: Byte[];
|
|
2377
|
+
}>
|
|
2378
|
+
async createHmac(args: {
|
|
2379
|
+
data: Byte[];
|
|
2380
|
+
protocolID: [
|
|
2381
|
+
SecurityLevel,
|
|
2382
|
+
ProtocolString5To400Bytes
|
|
2383
|
+
];
|
|
2384
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2385
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2386
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2387
|
+
privileged?: BooleanDefaultFalse;
|
|
2388
|
+
}): Promise<{
|
|
2389
|
+
hmac: Byte[];
|
|
2390
|
+
}>
|
|
2391
|
+
async verifyHmac(args: {
|
|
2392
|
+
data: Byte[];
|
|
2393
|
+
hmac: Byte[];
|
|
2394
|
+
protocolID: [
|
|
2395
|
+
SecurityLevel,
|
|
2396
|
+
ProtocolString5To400Bytes
|
|
2397
|
+
];
|
|
2398
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2399
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2400
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2401
|
+
privileged?: BooleanDefaultFalse;
|
|
2402
|
+
}): Promise<{
|
|
2403
|
+
valid: true;
|
|
2404
|
+
}>
|
|
2405
|
+
async createSignature(args: {
|
|
2406
|
+
data?: Byte[];
|
|
2407
|
+
hashToDirectlySign?: Byte[];
|
|
2408
|
+
protocolID: [
|
|
2409
|
+
SecurityLevel,
|
|
2410
|
+
ProtocolString5To400Bytes
|
|
2411
|
+
];
|
|
2412
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2413
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2414
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2415
|
+
privileged?: BooleanDefaultFalse;
|
|
2416
|
+
}): Promise<{
|
|
2417
|
+
signature: Byte[];
|
|
2418
|
+
}>
|
|
2419
|
+
async verifySignature(args: {
|
|
2420
|
+
data?: Byte[];
|
|
2421
|
+
hashToDirectlyVerify?: Byte[];
|
|
2422
|
+
signature: Byte[];
|
|
2423
|
+
protocolID: [
|
|
2424
|
+
SecurityLevel,
|
|
2425
|
+
ProtocolString5To400Bytes
|
|
2426
|
+
];
|
|
2427
|
+
keyID: KeyIDStringUnder800Bytes;
|
|
2428
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2429
|
+
counterparty?: PubKeyHex | "self" | "anyone";
|
|
2430
|
+
forSelf?: BooleanDefaultFalse;
|
|
2431
|
+
privileged?: BooleanDefaultFalse;
|
|
2432
|
+
}): Promise<{
|
|
2433
|
+
valid: true;
|
|
2434
|
+
}>
|
|
2435
|
+
async acquireCertificate(args: {
|
|
2436
|
+
type: Base64String;
|
|
2437
|
+
subject: PubKeyHex;
|
|
2438
|
+
serialNumber: Base64String;
|
|
2439
|
+
revocationOutpoint: OutpointString;
|
|
2440
|
+
signature: HexString;
|
|
2441
|
+
fields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2442
|
+
certifier: PubKeyHex;
|
|
2443
|
+
keyringRevealer: PubKeyHex | "certifier";
|
|
2444
|
+
keyringForSubject: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2445
|
+
acquisitionProtocol: "direct" | "issuance";
|
|
2446
|
+
certifierUrl?: string;
|
|
2447
|
+
}): Promise<{
|
|
2448
|
+
type: Base64String;
|
|
2449
|
+
subject: PubKeyHex;
|
|
2450
|
+
serialNumber: Base64String;
|
|
2451
|
+
certifier: PubKeyHex;
|
|
2452
|
+
revocationOutpoint: OutpointString;
|
|
2453
|
+
signature: HexString;
|
|
2454
|
+
fields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2455
|
+
}>
|
|
2456
|
+
async listCertificates(args: {
|
|
2457
|
+
certifiers: PubKeyHex[];
|
|
2458
|
+
types: Base64String[];
|
|
2459
|
+
limit?: PositiveIntegerDefault10Max10000;
|
|
2460
|
+
offset?: PositiveIntegerOrZero;
|
|
2461
|
+
privileged?: BooleanDefaultFalse;
|
|
2462
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2463
|
+
}): Promise<{
|
|
2464
|
+
totalCertificates: PositiveIntegerOrZero;
|
|
2465
|
+
certificates: Array<{
|
|
2466
|
+
type: Base64String;
|
|
2467
|
+
subject: PubKeyHex;
|
|
2468
|
+
serialNumber: Base64String;
|
|
2469
|
+
certifier: PubKeyHex;
|
|
2470
|
+
revocationOutpoint: OutpointString;
|
|
2471
|
+
signature: HexString;
|
|
2472
|
+
fields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2473
|
+
}>;
|
|
2474
|
+
}>
|
|
2475
|
+
async proveCertificate(args: {
|
|
2476
|
+
certificate: {
|
|
2477
|
+
type: Base64String;
|
|
2478
|
+
subject: PubKeyHex;
|
|
2479
|
+
serialNumber: Base64String;
|
|
2480
|
+
certifier: PubKeyHex;
|
|
2481
|
+
revocationOutpoint: OutpointString;
|
|
2482
|
+
signature: HexString;
|
|
2483
|
+
fields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2484
|
+
};
|
|
2485
|
+
fieldsToReveal: CertificateFieldNameUnder50Bytes[];
|
|
2486
|
+
verifier: PubKeyHex;
|
|
2487
|
+
privileged?: BooleanDefaultFalse;
|
|
2488
|
+
privilegedReason?: DescriptionString5to50Bytes;
|
|
2489
|
+
}): Promise<{
|
|
2490
|
+
keyringForVerifier: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2491
|
+
}>
|
|
2492
|
+
async relinquishCertificate(args: {
|
|
2493
|
+
type: Base64String;
|
|
2494
|
+
serialNumber: Base64String;
|
|
2495
|
+
certifier: PubKeyHex;
|
|
2496
|
+
}): Promise<{
|
|
2497
|
+
relinquished: true;
|
|
2498
|
+
}>
|
|
2499
|
+
async discoverByIdentityKey(args: {
|
|
2500
|
+
identityKey: PubKeyHex;
|
|
2501
|
+
limit?: PositiveIntegerDefault10Max10000;
|
|
2502
|
+
offset?: PositiveIntegerOrZero;
|
|
2503
|
+
}): Promise<{
|
|
2504
|
+
totalCertificates: PositiveIntegerOrZero;
|
|
2505
|
+
certificates: Array<{
|
|
2506
|
+
type: Base64String;
|
|
2507
|
+
subject: PubKeyHex;
|
|
2508
|
+
serialNumber: Base64String;
|
|
2509
|
+
certifier: PubKeyHex;
|
|
2510
|
+
revocationOutpoint: OutpointString;
|
|
2511
|
+
signature: HexString;
|
|
2512
|
+
fields: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2513
|
+
certifierInfo: {
|
|
2514
|
+
name: EntityNameStringMax100Bytes;
|
|
2515
|
+
iconUrl: EntityIconURLStringMax500Bytes;
|
|
2516
|
+
description: DescriptionString5to50Bytes;
|
|
2517
|
+
trust: PositiveIntegerMax10;
|
|
2518
|
+
};
|
|
2519
|
+
publiclyRevealedKeyring: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2520
|
+
decryptedFields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2521
|
+
}>;
|
|
2522
|
+
}>
|
|
2523
|
+
async discoverByAttributes(args: {
|
|
2524
|
+
attributes: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2525
|
+
limit?: PositiveIntegerDefault10Max10000;
|
|
2526
|
+
offset?: PositiveIntegerOrZero;
|
|
2527
|
+
}): Promise<{
|
|
2528
|
+
totalCertificates: PositiveIntegerOrZero;
|
|
2529
|
+
certificates: Array<{
|
|
2530
|
+
type: Base64String;
|
|
2531
|
+
subject: PubKeyHex;
|
|
2532
|
+
serialNumber: Base64String;
|
|
2533
|
+
certifier: PubKeyHex;
|
|
2534
|
+
revocationOutpoint: OutpointString;
|
|
2535
|
+
signature: HexString;
|
|
2536
|
+
fields: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2537
|
+
certifierInfo: {
|
|
2538
|
+
name: EntityNameStringMax100Bytes;
|
|
2539
|
+
iconUrl: EntityIconURLStringMax500Bytes;
|
|
2540
|
+
description: DescriptionString5to50Bytes;
|
|
2541
|
+
trust: PositiveIntegerMax10;
|
|
2542
|
+
};
|
|
2543
|
+
publiclyRevealedKeyring: Record<CertificateFieldNameUnder50Bytes, Base64String>;
|
|
2544
|
+
decryptedFields: Record<CertificateFieldNameUnder50Bytes, string>;
|
|
2545
|
+
}>;
|
|
2546
|
+
}>
|
|
2547
|
+
async isAuthenticated(args: {}): Promise<{
|
|
2548
|
+
authenticated: true;
|
|
2549
|
+
}>
|
|
2550
|
+
async waitForAuthentication(args: {}): Promise<{
|
|
2551
|
+
authenticated: true;
|
|
2552
|
+
}>
|
|
2553
|
+
async getHeight(args: {}): Promise<{
|
|
2554
|
+
height: PositiveInteger;
|
|
2555
|
+
}>
|
|
2556
|
+
async getHeaderForHeight(args: {
|
|
2557
|
+
height: PositiveInteger;
|
|
2558
|
+
}): Promise<{
|
|
2559
|
+
header: HexString;
|
|
2560
|
+
}>
|
|
2561
|
+
async getNetwork(args: {}): Promise<{
|
|
2562
|
+
network: "mainnet" | "testnet";
|
|
2563
|
+
}>
|
|
2564
|
+
async getVersion(args: {}): Promise<{
|
|
2565
|
+
version: VersionString7To30Bytes;
|
|
2566
|
+
}>
|
|
2567
|
+
}
|
|
2568
|
+
```
|
|
2569
|
+
|
|
2570
|
+
See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CallType](./wallet.md#type-calltype), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](./wallet.md#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](./wallet.md#type-entitynamestringmax100bytes), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [OutpointString](./wallet.md#type-outpointstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](./wallet.md#type-positiveintegermax10), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [SatoshiValue](./wallet.md#type-satoshivalue), [SecurityLevel](./wallet.md#type-securitylevel), [TXIDHexString](./wallet.md#type-txidhexstring), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
2162
2571
|
|
|
2163
2572
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2164
2573
|
|
|
@@ -2177,11 +2586,7 @@ export class WERR_REVIEW_ACTIONS extends Error {
|
|
|
2177
2586
|
}
|
|
2178
2587
|
```
|
|
2179
2588
|
|
|
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>
|
|
2589
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [OutpointString](./wallet.md#type-outpointstring), [ReviewActionResult](./wallet.md#interface-reviewactionresult), [SendWithResult](./wallet.md#interface-sendwithresult), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
2185
2590
|
|
|
2186
2591
|
#### Constructor
|
|
2187
2592
|
|
|
@@ -2192,9 +2597,7 @@ which contains more details, particularly for double spend results.
|
|
|
2192
2597
|
```ts
|
|
2193
2598
|
constructor(public reviewActionResults: ReviewActionResult[], public sendWithResults: SendWithResult[], public txid?: TXIDHexString, public tx?: AtomicBEEF, public noSendChange?: OutpointString[])
|
|
2194
2599
|
```
|
|
2195
|
-
See also: [AtomicBEEF](#type-atomicbeef), [OutpointString](#type-outpointstring), [ReviewActionResult](#interface-reviewactionresult), [SendWithResult](#interface-sendwithresult), [TXIDHexString](#type-txidhexstring)
|
|
2196
|
-
|
|
2197
|
-
</details>
|
|
2600
|
+
See also: [AtomicBEEF](./wallet.md#type-atomicbeef), [OutpointString](./wallet.md#type-outpointstring), [ReviewActionResult](./wallet.md#interface-reviewactionresult), [SendWithResult](./wallet.md#interface-sendwithresult), [TXIDHexString](./wallet.md#type-txidhexstring)
|
|
2198
2601
|
|
|
2199
2602
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2200
2603
|
|
|
@@ -2408,7 +2811,7 @@ export default class WalletClient implements WalletInterface {
|
|
|
2408
2811
|
}
|
|
2409
2812
|
```
|
|
2410
2813
|
|
|
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)
|
|
2814
|
+
See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
2412
2815
|
|
|
2413
2816
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2414
2817
|
|
|
@@ -2438,7 +2841,7 @@ export default class WalletWireProcessor implements WalletWire {
|
|
|
2438
2841
|
}
|
|
2439
2842
|
```
|
|
2440
2843
|
|
|
2441
|
-
See also: [WalletInterface](#interface-walletinterface), [WalletWire](#interface-walletwire)
|
|
2844
|
+
See also: [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire](./wallet.md#interface-walletwire)
|
|
2442
2845
|
|
|
2443
2846
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2444
2847
|
|
|
@@ -2661,7 +3064,7 @@ export default class WalletWireTransceiver implements WalletInterface {
|
|
|
2661
3064
|
}
|
|
2662
3065
|
```
|
|
2663
3066
|
|
|
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)
|
|
3067
|
+
See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire](./wallet.md#interface-walletwire), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
2665
3068
|
|
|
2666
3069
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2667
3070
|
|
|
@@ -3104,7 +3507,7 @@ export default class WindowCWISubstrate implements WalletInterface {
|
|
|
3104
3507
|
}
|
|
3105
3508
|
```
|
|
3106
3509
|
|
|
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)
|
|
3510
|
+
See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](./wallet.md#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](./wallet.md#type-entitynamestringmax100bytes), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](./wallet.md#type-positiveintegermax10), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [SatoshiValue](./wallet.md#type-satoshivalue), [SecurityLevel](./wallet.md#type-securitylevel), [TXIDHexString](./wallet.md#type-txidhexstring), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
3108
3511
|
|
|
3109
3512
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3110
3513
|
|
|
@@ -3548,7 +3951,7 @@ export default class XDMSubstrate implements WalletInterface {
|
|
|
3548
3951
|
}
|
|
3549
3952
|
```
|
|
3550
3953
|
|
|
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)
|
|
3954
|
+
See also: [BEEF](./wallet.md#type-beef), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CallType](./wallet.md#type-calltype), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [EntityIconURLStringMax500Bytes](./wallet.md#type-entityiconurlstringmax500bytes), [EntityNameStringMax100Bytes](./wallet.md#type-entitynamestringmax100bytes), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [LabelStringUnder300Bytes](./wallet.md#type-labelstringunder300bytes), [OutpointString](./wallet.md#type-outpointstring), [OutputTagStringUnder300Bytes](./wallet.md#type-outputtagstringunder300bytes), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerMax10](./wallet.md#type-positiveintegermax10), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [SatoshiValue](./wallet.md#type-satoshivalue), [SecurityLevel](./wallet.md#type-securitylevel), [TXIDHexString](./wallet.md#type-txidhexstring), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
|
|
3552
3955
|
|
|
3553
3956
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3554
3957
|
|
|
@@ -3585,7 +3988,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3585
3988
|
export type AcquireCertificateResult = WalletCertificate
|
|
3586
3989
|
```
|
|
3587
3990
|
|
|
3588
|
-
See also: [WalletCertificate](#interface-walletcertificate)
|
|
3991
|
+
See also: [WalletCertificate](./wallet.md#interface-walletcertificate)
|
|
3589
3992
|
|
|
3590
3993
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3591
3994
|
|
|
@@ -3614,7 +4017,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3614
4017
|
export type AtomicBEEF = Byte[]
|
|
3615
4018
|
```
|
|
3616
4019
|
|
|
3617
|
-
See also: [Byte](#type-byte)
|
|
4020
|
+
See also: [Byte](./wallet.md#type-byte)
|
|
3618
4021
|
|
|
3619
4022
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3620
4023
|
|
|
@@ -3625,7 +4028,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3625
4028
|
export type BEEF = Byte[]
|
|
3626
4029
|
```
|
|
3627
4030
|
|
|
3628
|
-
See also: [Byte](#type-byte)
|
|
4031
|
+
See also: [Byte](./wallet.md#type-byte)
|
|
3629
4032
|
|
|
3630
4033
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3631
4034
|
|
|
@@ -3699,7 +4102,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3699
4102
|
export type Counterparty = PublicKey | PubKeyHex | "self" | "anyone"
|
|
3700
4103
|
```
|
|
3701
4104
|
|
|
3702
|
-
See also: [PubKeyHex](#type-pubkeyhex), [PublicKey](#class-publickey)
|
|
4105
|
+
See also: [PubKeyHex](./wallet.md#type-pubkeyhex), [PublicKey](./primitives.md#class-publickey)
|
|
3703
4106
|
|
|
3704
4107
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3705
4108
|
|
|
@@ -3782,7 +4185,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3782
4185
|
export type KeyringRevealer = PubKeyHex | "certifier"
|
|
3783
4186
|
```
|
|
3784
4187
|
|
|
3785
|
-
See also: [PubKeyHex](#type-pubkeyhex)
|
|
4188
|
+
See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
3786
4189
|
|
|
3787
4190
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3788
4191
|
|
|
@@ -3874,7 +4277,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3874
4277
|
export type PubKeyHex = HexString
|
|
3875
4278
|
```
|
|
3876
4279
|
|
|
3877
|
-
See also: [HexString](#type-hexstring)
|
|
4280
|
+
See also: [HexString](./wallet.md#type-hexstring)
|
|
3878
4281
|
|
|
3879
4282
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3880
4283
|
|
|
@@ -3935,7 +4338,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3935
4338
|
export type TXIDHexString = HexString
|
|
3936
4339
|
```
|
|
3937
4340
|
|
|
3938
|
-
See also: [HexString](#type-hexstring)
|
|
4341
|
+
See also: [HexString](./wallet.md#type-hexstring)
|
|
3939
4342
|
|
|
3940
4343
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3941
4344
|
|
|
@@ -3970,7 +4373,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3970
4373
|
export type WalletCounterparty = PubKeyHex | "self" | "anyone"
|
|
3971
4374
|
```
|
|
3972
4375
|
|
|
3973
|
-
See also: [PubKeyHex](#type-pubkeyhex)
|
|
4376
|
+
See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
|
|
3974
4377
|
|
|
3975
4378
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3976
4379
|
|
|
@@ -3981,7 +4384,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
3981
4384
|
export type WalletErrorCode = keyof typeof walletErrors
|
|
3982
4385
|
```
|
|
3983
4386
|
|
|
3984
|
-
See also: [walletErrors](#enum-walleterrors)
|
|
4387
|
+
See also: [walletErrors](./wallet.md#enum-walleterrors)
|
|
3985
4388
|
|
|
3986
4389
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
3987
4390
|
|
|
@@ -4004,7 +4407,7 @@ export type WalletProtocol = [
|
|
|
4004
4407
|
]
|
|
4005
4408
|
```
|
|
4006
4409
|
|
|
4007
|
-
See also: [ProtocolString5To400Bytes](#type-protocolstring5to400bytes), [SecurityLevel](#type-securitylevel)
|
|
4410
|
+
See also: [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [SecurityLevel](./wallet.md#type-securitylevel)
|
|
4008
4411
|
|
|
4009
4412
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4010
4413
|
|
|
@@ -4030,7 +4433,7 @@ export enum SecurityLevels {
|
|
|
4030
4433
|
}
|
|
4031
4434
|
```
|
|
4032
4435
|
|
|
4033
|
-
See also: [Counterparty](#type-counterparty)
|
|
4436
|
+
See also: [Counterparty](./wallet.md#type-counterparty)
|
|
4034
4437
|
|
|
4035
4438
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
4036
4439
|
|