@bsv/sdk 1.8.1 → 1.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/src/kvstore/index.js +3 -1
- package/dist/cjs/src/kvstore/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/kvstore/index.js +1 -0
- package/dist/esm/src/kvstore/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/kvstore/index.d.ts +1 -0
- package/dist/types/src/kvstore/index.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +3 -3
- package/dist/umd/bundle.js.map +1 -1
- package/docs/reference/compat.md +15 -27
- package/docs/reference/identity.md +12 -16
- package/docs/reference/kvstore.md +471 -4
- package/docs/reference/messages.md +0 -8
- package/docs/reference/overlay-tools.md +15 -22
- package/docs/reference/primitives.md +168 -168
- package/docs/reference/registry.md +9 -19
- package/docs/reference/script.md +31 -32
- package/docs/reference/storage.md +10 -14
- package/docs/reference/totp.md +5 -5
- package/docs/reference/transaction.md +67 -70
- package/docs/reference/wallet.md +131 -135
- package/package.json +1 -1
- package/src/kvstore/index.ts +1 -0
|
@@ -34,7 +34,7 @@ export interface ArcConfig {
|
|
|
34
34
|
}
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
See also: [HttpClient](
|
|
37
|
+
See also: [HttpClient](#interface-httpclient)
|
|
38
38
|
|
|
39
39
|
#### Property apiKey
|
|
40
40
|
|
|
@@ -83,7 +83,7 @@ The HTTP client used to make requests to the ARC API.
|
|
|
83
83
|
```ts
|
|
84
84
|
httpClient?: HttpClient
|
|
85
85
|
```
|
|
86
|
-
See also: [HttpClient](
|
|
86
|
+
See also: [HttpClient](#interface-httpclient)
|
|
87
87
|
|
|
88
88
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
89
89
|
|
|
@@ -133,7 +133,7 @@ export interface Broadcaster {
|
|
|
133
133
|
}
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
See also: [BroadcastFailure](
|
|
136
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
|
|
137
137
|
|
|
138
138
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
139
139
|
|
|
@@ -181,7 +181,7 @@ export default interface FeeModel {
|
|
|
181
181
|
}
|
|
182
182
|
```
|
|
183
183
|
|
|
184
|
-
See also: [Transaction](
|
|
184
|
+
See also: [Transaction](#class-transaction)
|
|
185
185
|
|
|
186
186
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
187
187
|
|
|
@@ -236,7 +236,7 @@ export interface HttpClient {
|
|
|
236
236
|
}
|
|
237
237
|
```
|
|
238
238
|
|
|
239
|
-
See also: [HttpClientRequestOptions](
|
|
239
|
+
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
240
240
|
|
|
241
241
|
#### Property request
|
|
242
242
|
|
|
@@ -245,7 +245,7 @@ Makes a request to the server.
|
|
|
245
245
|
```ts
|
|
246
246
|
request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) => Promise<HttpClientResponse<T>>
|
|
247
247
|
```
|
|
248
|
-
See also: [HttpClientRequestOptions](
|
|
248
|
+
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
249
249
|
|
|
250
250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
251
251
|
|
|
@@ -308,7 +308,7 @@ export interface HttpsNodejs {
|
|
|
308
308
|
}
|
|
309
309
|
```
|
|
310
310
|
|
|
311
|
-
See also: [HttpClientRequestOptions](
|
|
311
|
+
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [NodejsHttpClientRequest](#interface-nodejshttpclientrequest)
|
|
312
312
|
|
|
313
313
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
314
314
|
|
|
@@ -379,7 +379,7 @@ export default interface TransactionInput {
|
|
|
379
379
|
}
|
|
380
380
|
```
|
|
381
381
|
|
|
382
|
-
See also: [Transaction](
|
|
382
|
+
See also: [Transaction](#class-transaction)
|
|
383
383
|
|
|
384
384
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
385
385
|
|
|
@@ -409,8 +409,6 @@ export default interface TransactionOutput {
|
|
|
409
409
|
}
|
|
410
410
|
```
|
|
411
411
|
|
|
412
|
-
See also: [LockingScript](./script.md#class-lockingscript)
|
|
413
|
-
|
|
414
412
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
415
413
|
|
|
416
414
|
---
|
|
@@ -425,7 +423,7 @@ export interface WhatsOnChainConfig {
|
|
|
425
423
|
}
|
|
426
424
|
```
|
|
427
425
|
|
|
428
|
-
See also: [HttpClient](
|
|
426
|
+
See also: [HttpClient](#interface-httpclient)
|
|
429
427
|
|
|
430
428
|
#### Property apiKey
|
|
431
429
|
|
|
@@ -442,7 +440,7 @@ The HTTP client used to make requests to the API.
|
|
|
442
440
|
```ts
|
|
443
441
|
httpClient?: HttpClient
|
|
444
442
|
```
|
|
445
|
-
See also: [HttpClient](
|
|
443
|
+
See also: [HttpClient](#interface-httpclient)
|
|
446
444
|
|
|
447
445
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
448
446
|
|
|
@@ -487,7 +485,7 @@ export default class ARC implements Broadcaster {
|
|
|
487
485
|
}
|
|
488
486
|
```
|
|
489
487
|
|
|
490
|
-
See also: [ArcConfig](
|
|
488
|
+
See also: [ArcConfig](#interface-arcconfig), [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [Transaction](#class-transaction)
|
|
491
489
|
|
|
492
490
|
#### Constructor
|
|
493
491
|
|
|
@@ -496,7 +494,7 @@ Constructs an instance of the ARC broadcaster.
|
|
|
496
494
|
```ts
|
|
497
495
|
constructor(URL: string, config?: ArcConfig)
|
|
498
496
|
```
|
|
499
|
-
See also: [ArcConfig](
|
|
497
|
+
See also: [ArcConfig](#interface-arcconfig)
|
|
500
498
|
|
|
501
499
|
Argument Details
|
|
502
500
|
|
|
@@ -527,7 +525,7 @@ Broadcasts a transaction via ARC.
|
|
|
527
525
|
```ts
|
|
528
526
|
async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>
|
|
529
527
|
```
|
|
530
|
-
See also: [BroadcastFailure](
|
|
528
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
|
|
531
529
|
|
|
532
530
|
Returns
|
|
533
531
|
|
|
@@ -546,7 +544,7 @@ Handles mixed responses where some transactions succeed and others fail.
|
|
|
546
544
|
```ts
|
|
547
545
|
async broadcastMany(txs: Transaction[]): Promise<object[]>
|
|
548
546
|
```
|
|
549
|
-
See also: [Transaction](
|
|
547
|
+
See also: [Transaction](#class-transaction)
|
|
550
548
|
|
|
551
549
|
Returns
|
|
552
550
|
|
|
@@ -609,7 +607,7 @@ export class Beef {
|
|
|
609
607
|
}
|
|
610
608
|
```
|
|
611
609
|
|
|
612
|
-
See also: [BEEF_V2](
|
|
610
|
+
See also: [BEEF_V2](#variable-beef_v2), [BeefTx](#class-beeftx), [ChainTracker](#interface-chaintracker), [MerklePath](#class-merklepath), [Transaction](#class-transaction)
|
|
613
611
|
|
|
614
612
|
#### Method addComputedLeaves
|
|
615
613
|
|
|
@@ -625,7 +623,7 @@ addComputedLeaves(): void
|
|
|
625
623
|
```ts
|
|
626
624
|
clone(): Beef
|
|
627
625
|
```
|
|
628
|
-
See also: [Beef](
|
|
626
|
+
See also: [Beef](#class-beef)
|
|
629
627
|
|
|
630
628
|
Returns
|
|
631
629
|
|
|
@@ -640,7 +638,7 @@ To succeed, the Beef must contain all the required transaction and merkle path d
|
|
|
640
638
|
```ts
|
|
641
639
|
findAtomicTransaction(txid: string): Transaction | undefined
|
|
642
640
|
```
|
|
643
|
-
See also: [Transaction](
|
|
641
|
+
See also: [Transaction](#class-transaction)
|
|
644
642
|
|
|
645
643
|
Returns
|
|
646
644
|
|
|
@@ -656,7 +654,7 @@ Argument Details
|
|
|
656
654
|
```ts
|
|
657
655
|
findBump(txid: string): MerklePath | undefined
|
|
658
656
|
```
|
|
659
|
-
See also: [MerklePath](
|
|
657
|
+
See also: [MerklePath](#class-merklepath)
|
|
660
658
|
|
|
661
659
|
Returns
|
|
662
660
|
|
|
@@ -672,7 +670,7 @@ The result is suitable for signing.
|
|
|
672
670
|
```ts
|
|
673
671
|
findTransactionForSigning(txid: string): Transaction | undefined
|
|
674
672
|
```
|
|
675
|
-
See also: [Transaction](
|
|
673
|
+
See also: [Transaction](#class-transaction)
|
|
676
674
|
|
|
677
675
|
Returns
|
|
678
676
|
|
|
@@ -688,7 +686,7 @@ Argument Details
|
|
|
688
686
|
```ts
|
|
689
687
|
findTxid(txid: string): BeefTx | undefined
|
|
690
688
|
```
|
|
691
|
-
See also: [BeefTx](
|
|
689
|
+
See also: [BeefTx](#class-beeftx)
|
|
692
690
|
|
|
693
691
|
Returns
|
|
694
692
|
|
|
@@ -706,7 +704,7 @@ Constructs an instance of the Beef class based on the provided binary array
|
|
|
706
704
|
```ts
|
|
707
705
|
static fromBinary(bin: number[]): Beef
|
|
708
706
|
```
|
|
709
|
-
See also: [Beef](
|
|
707
|
+
See also: [Beef](#class-beef)
|
|
710
708
|
|
|
711
709
|
Returns
|
|
712
710
|
|
|
@@ -724,7 +722,7 @@ Constructs an instance of the Beef class based on the provided string
|
|
|
724
722
|
```ts
|
|
725
723
|
static fromString(s: string, enc: "hex" | "utf8" | "base64" = "hex"): Beef
|
|
726
724
|
```
|
|
727
|
-
See also: [Beef](
|
|
725
|
+
See also: [Beef](#class-beef)
|
|
728
726
|
|
|
729
727
|
Returns
|
|
730
728
|
|
|
@@ -779,7 +777,7 @@ original.
|
|
|
779
777
|
```ts
|
|
780
778
|
makeTxidOnly(txid: string): BeefTx | undefined
|
|
781
779
|
```
|
|
782
|
-
See also: [BeefTx](
|
|
780
|
+
See also: [BeefTx](#class-beeftx)
|
|
783
781
|
|
|
784
782
|
Returns
|
|
785
783
|
|
|
@@ -792,7 +790,7 @@ Merge a MerklePath that is assumed to be fully valid.
|
|
|
792
790
|
```ts
|
|
793
791
|
mergeBump(bump: MerklePath): number
|
|
794
792
|
```
|
|
795
|
-
See also: [MerklePath](
|
|
793
|
+
See also: [MerklePath](#class-merklepath)
|
|
796
794
|
|
|
797
795
|
Returns
|
|
798
796
|
|
|
@@ -809,7 +807,7 @@ Replaces existing transaction with same txid.
|
|
|
809
807
|
```ts
|
|
810
808
|
mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx
|
|
811
809
|
```
|
|
812
|
-
See also: [BeefTx](
|
|
810
|
+
See also: [BeefTx](#class-beeftx)
|
|
813
811
|
|
|
814
812
|
Returns
|
|
815
813
|
|
|
@@ -831,7 +829,7 @@ Attempts to match an existing bump to the new transaction.
|
|
|
831
829
|
```ts
|
|
832
830
|
mergeTransaction(tx: Transaction): BeefTx
|
|
833
831
|
```
|
|
834
|
-
See also: [BeefTx](
|
|
832
|
+
See also: [BeefTx](#class-beeftx), [Transaction](#class-transaction)
|
|
835
833
|
|
|
836
834
|
Returns
|
|
837
835
|
|
|
@@ -930,7 +928,6 @@ Serializes this data to `writer`
|
|
|
930
928
|
```ts
|
|
931
929
|
toWriter(writer: Writer): void
|
|
932
930
|
```
|
|
933
|
-
See also: [Writer](./primitives.md#class-writer)
|
|
934
931
|
|
|
935
932
|
#### Method trimKnownTxids
|
|
936
933
|
|
|
@@ -955,7 +952,7 @@ Validity requirements:
|
|
|
955
952
|
```ts
|
|
956
953
|
async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean>
|
|
957
954
|
```
|
|
958
|
-
See also: [ChainTracker](
|
|
955
|
+
See also: [ChainTracker](#interface-chaintracker)
|
|
959
956
|
|
|
960
957
|
Argument Details
|
|
961
958
|
|
|
@@ -1031,7 +1028,7 @@ export class BeefParty extends Beef {
|
|
|
1031
1028
|
}
|
|
1032
1029
|
```
|
|
1033
1030
|
|
|
1034
|
-
See also: [Beef](
|
|
1031
|
+
See also: [Beef](#class-beef)
|
|
1035
1032
|
|
|
1036
1033
|
#### Constructor
|
|
1037
1034
|
|
|
@@ -1089,7 +1086,7 @@ Array of txids "known" to `party`.
|
|
|
1089
1086
|
```ts
|
|
1090
1087
|
getTrimmedBeefForParty(party: string): Beef
|
|
1091
1088
|
```
|
|
1092
|
-
See also: [Beef](
|
|
1089
|
+
See also: [Beef](#class-beef)
|
|
1093
1090
|
|
|
1094
1091
|
Returns
|
|
1095
1092
|
|
|
@@ -1116,7 +1113,7 @@ has raw transaction and validity proof data.
|
|
|
1116
1113
|
```ts
|
|
1117
1114
|
mergeBeefFromParty(party: string, beef: number[] | Beef): void
|
|
1118
1115
|
```
|
|
1119
|
-
See also: [Beef](
|
|
1116
|
+
See also: [Beef](#class-beef)
|
|
1120
1117
|
|
|
1121
1118
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1122
1119
|
|
|
@@ -1155,14 +1152,14 @@ export default class BeefTx {
|
|
|
1155
1152
|
}
|
|
1156
1153
|
```
|
|
1157
1154
|
|
|
1158
|
-
See also: [
|
|
1155
|
+
See also: [Transaction](#class-transaction)
|
|
1159
1156
|
|
|
1160
1157
|
#### Constructor
|
|
1161
1158
|
|
|
1162
1159
|
```ts
|
|
1163
1160
|
constructor(tx: Transaction | number[] | string, bumpIndex?: number)
|
|
1164
1161
|
```
|
|
1165
|
-
See also: [Transaction](
|
|
1162
|
+
See also: [Transaction](#class-transaction)
|
|
1166
1163
|
|
|
1167
1164
|
Argument Details
|
|
1168
1165
|
|
|
@@ -1195,7 +1192,7 @@ export class FetchHttpClient implements HttpClient {
|
|
|
1195
1192
|
}
|
|
1196
1193
|
```
|
|
1197
1194
|
|
|
1198
|
-
See also: [Fetch](
|
|
1195
|
+
See also: [Fetch](#type-fetch), [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
1199
1196
|
|
|
1200
1197
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1201
1198
|
|
|
@@ -1213,7 +1210,7 @@ export default class LivePolicy extends SatoshisPerKilobyte {
|
|
|
1213
1210
|
}
|
|
1214
1211
|
```
|
|
1215
1212
|
|
|
1216
|
-
See also: [SatoshisPerKilobyte](
|
|
1213
|
+
See also: [SatoshisPerKilobyte](#class-satoshisperkilobyte), [Transaction](#class-transaction)
|
|
1217
1214
|
|
|
1218
1215
|
#### Constructor
|
|
1219
1216
|
|
|
@@ -1236,7 +1233,7 @@ Overrides the parent method to use dynamic rate fetching.
|
|
|
1236
1233
|
```ts
|
|
1237
1234
|
async computeFee(tx: Transaction): Promise<number>
|
|
1238
1235
|
```
|
|
1239
|
-
See also: [Transaction](
|
|
1236
|
+
See also: [Transaction](#class-transaction)
|
|
1240
1237
|
|
|
1241
1238
|
Returns
|
|
1242
1239
|
|
|
@@ -1254,7 +1251,7 @@ Gets the singleton instance of LivePolicy to ensure cache sharing across the app
|
|
|
1254
1251
|
```ts
|
|
1255
1252
|
static getInstance(cacheValidityMs: number = 5 * 60 * 1000): LivePolicy
|
|
1256
1253
|
```
|
|
1257
|
-
See also: [LivePolicy](
|
|
1254
|
+
See also: [LivePolicy](#class-livepolicy)
|
|
1258
1255
|
|
|
1259
1256
|
Returns
|
|
1260
1257
|
|
|
@@ -1311,7 +1308,7 @@ export default class MerklePath {
|
|
|
1311
1308
|
}
|
|
1312
1309
|
```
|
|
1313
1310
|
|
|
1314
|
-
See also: [ChainTracker](
|
|
1311
|
+
See also: [ChainTracker](#interface-chaintracker), [MerklePathLeaf](#interface-merklepathleaf)
|
|
1315
1312
|
|
|
1316
1313
|
#### Method combine
|
|
1317
1314
|
|
|
@@ -1320,7 +1317,7 @@ Combines this MerklePath with another to create a compound proof.
|
|
|
1320
1317
|
```ts
|
|
1321
1318
|
combine(other: MerklePath): void
|
|
1322
1319
|
```
|
|
1323
|
-
See also: [MerklePath](
|
|
1320
|
+
See also: [MerklePath](#class-merklepath)
|
|
1324
1321
|
|
|
1325
1322
|
Argument Details
|
|
1326
1323
|
|
|
@@ -1361,7 +1358,7 @@ Does not add computed leaves to path.
|
|
|
1361
1358
|
```ts
|
|
1362
1359
|
findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined
|
|
1363
1360
|
```
|
|
1364
|
-
See also: [MerklePathLeaf](
|
|
1361
|
+
See also: [MerklePathLeaf](#interface-merklepathleaf)
|
|
1365
1362
|
|
|
1366
1363
|
#### Method fromBinary
|
|
1367
1364
|
|
|
@@ -1370,7 +1367,7 @@ Creates a MerklePath instance from a binary array.
|
|
|
1370
1367
|
```ts
|
|
1371
1368
|
static fromBinary(bump: number[]): MerklePath
|
|
1372
1369
|
```
|
|
1373
|
-
See also: [MerklePath](
|
|
1370
|
+
See also: [MerklePath](#class-merklepath)
|
|
1374
1371
|
|
|
1375
1372
|
Returns
|
|
1376
1373
|
|
|
@@ -1386,7 +1383,7 @@ Argument Details
|
|
|
1386
1383
|
```ts
|
|
1387
1384
|
static fromCoinbaseTxidAndHeight(txid: string, height: number): MerklePath
|
|
1388
1385
|
```
|
|
1389
|
-
See also: [MerklePath](
|
|
1386
|
+
See also: [MerklePath](#class-merklepath)
|
|
1390
1387
|
|
|
1391
1388
|
Returns
|
|
1392
1389
|
|
|
@@ -1406,7 +1403,7 @@ Creates a MerklePath instance from a hexadecimal string.
|
|
|
1406
1403
|
```ts
|
|
1407
1404
|
static fromHex(hex: string): MerklePath
|
|
1408
1405
|
```
|
|
1409
|
-
See also: [MerklePath](
|
|
1406
|
+
See also: [MerklePath](#class-merklepath)
|
|
1410
1407
|
|
|
1411
1408
|
Returns
|
|
1412
1409
|
|
|
@@ -1458,7 +1455,7 @@ Verifies if the given transaction ID is part of the Merkle tree at the specified
|
|
|
1458
1455
|
```ts
|
|
1459
1456
|
async verify(txid: string, chainTracker: ChainTracker): Promise<boolean>
|
|
1460
1457
|
```
|
|
1461
|
-
See also: [ChainTracker](
|
|
1458
|
+
See also: [ChainTracker](#interface-chaintracker)
|
|
1462
1459
|
|
|
1463
1460
|
Returns
|
|
1464
1461
|
|
|
@@ -1485,7 +1482,7 @@ export class NodejsHttpClient implements HttpClient {
|
|
|
1485
1482
|
}
|
|
1486
1483
|
```
|
|
1487
1484
|
|
|
1488
|
-
See also: [HttpClient](
|
|
1485
|
+
See also: [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse), [HttpsNodejs](#interface-httpsnodejs)
|
|
1489
1486
|
|
|
1490
1487
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1491
1488
|
|
|
@@ -1502,7 +1499,7 @@ export default class SatoshisPerKilobyte implements FeeModel {
|
|
|
1502
1499
|
}
|
|
1503
1500
|
```
|
|
1504
1501
|
|
|
1505
|
-
See also: [FeeModel](
|
|
1502
|
+
See also: [FeeModel](#interface-feemodel), [Transaction](#class-transaction)
|
|
1506
1503
|
|
|
1507
1504
|
#### Constructor
|
|
1508
1505
|
|
|
@@ -1524,7 +1521,7 @@ Computes the fee for a given transaction.
|
|
|
1524
1521
|
```ts
|
|
1525
1522
|
async computeFee(tx: Transaction): Promise<number>
|
|
1526
1523
|
```
|
|
1527
|
-
See also: [Transaction](
|
|
1524
|
+
See also: [Transaction](#class-transaction)
|
|
1528
1525
|
|
|
1529
1526
|
Returns
|
|
1530
1527
|
|
|
@@ -1609,7 +1606,7 @@ export default class Transaction {
|
|
|
1609
1606
|
}
|
|
1610
1607
|
```
|
|
1611
1608
|
|
|
1612
|
-
See also: [BroadcastFailure](
|
|
1609
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [LivePolicy](#class-livepolicy), [MerklePath](#class-merklepath), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput), [defaultBroadcaster](#function-defaultbroadcaster), [defaultChainTracker](#function-defaultchaintracker)
|
|
1613
1610
|
|
|
1614
1611
|
#### Method addInput
|
|
1615
1612
|
|
|
@@ -1618,7 +1615,7 @@ Adds a new input to the transaction.
|
|
|
1618
1615
|
```ts
|
|
1619
1616
|
addInput(input: TransactionInput): void
|
|
1620
1617
|
```
|
|
1621
|
-
See also: [TransactionInput](
|
|
1618
|
+
See also: [TransactionInput](#interface-transactioninput)
|
|
1622
1619
|
|
|
1623
1620
|
Argument Details
|
|
1624
1621
|
|
|
@@ -1636,7 +1633,7 @@ Adds a new output to the transaction.
|
|
|
1636
1633
|
```ts
|
|
1637
1634
|
addOutput(output: TransactionOutput): void
|
|
1638
1635
|
```
|
|
1639
|
-
See also: [TransactionOutput](
|
|
1636
|
+
See also: [TransactionOutput](#interface-transactionoutput)
|
|
1640
1637
|
|
|
1641
1638
|
Argument Details
|
|
1642
1639
|
|
|
@@ -1665,7 +1662,7 @@ Broadcasts a transaction.
|
|
|
1665
1662
|
```ts
|
|
1666
1663
|
async broadcast(broadcaster: Broadcaster = defaultBroadcaster()): Promise<BroadcastResponse | BroadcastFailure>
|
|
1667
1664
|
```
|
|
1668
|
-
See also: [BroadcastFailure](
|
|
1665
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [defaultBroadcaster](#function-defaultbroadcaster)
|
|
1669
1666
|
|
|
1670
1667
|
Returns
|
|
1671
1668
|
|
|
@@ -1685,7 +1682,7 @@ If fee is a number, the transaction uses that value as fee.
|
|
|
1685
1682
|
```ts
|
|
1686
1683
|
async fee(modelOrFee: FeeModel | number = LivePolicy.getInstance(), changeDistribution: "equal" | "random" = "equal"): Promise<void>
|
|
1687
1684
|
```
|
|
1688
|
-
See also: [FeeModel](
|
|
1685
|
+
See also: [FeeModel](#interface-feemodel), [LivePolicy](#class-livepolicy)
|
|
1689
1686
|
|
|
1690
1687
|
Argument Details
|
|
1691
1688
|
|
|
@@ -1703,7 +1700,7 @@ Extracts the subject transaction and supporting merkle path and source transacti
|
|
|
1703
1700
|
```ts
|
|
1704
1701
|
static fromAtomicBEEF(beef: number[]): Transaction
|
|
1705
1702
|
```
|
|
1706
|
-
See also: [Transaction](
|
|
1703
|
+
See also: [Transaction](#class-transaction)
|
|
1707
1704
|
|
|
1708
1705
|
Returns
|
|
1709
1706
|
|
|
@@ -1724,7 +1721,7 @@ If no TXID is provided, the last transaction in the BEEF data is returned, or th
|
|
|
1724
1721
|
```ts
|
|
1725
1722
|
static fromBEEF(beef: number[], txid?: string): Transaction
|
|
1726
1723
|
```
|
|
1727
|
-
See also: [Transaction](
|
|
1724
|
+
See also: [Transaction](#class-transaction)
|
|
1728
1725
|
|
|
1729
1726
|
Returns
|
|
1730
1727
|
|
|
@@ -1744,7 +1741,7 @@ Creates a Transaction instance from a binary array.
|
|
|
1744
1741
|
```ts
|
|
1745
1742
|
static fromBinary(bin: number[]): Transaction
|
|
1746
1743
|
```
|
|
1747
|
-
See also: [Transaction](
|
|
1744
|
+
See also: [Transaction](#class-transaction)
|
|
1748
1745
|
|
|
1749
1746
|
Returns
|
|
1750
1747
|
|
|
@@ -1762,7 +1759,7 @@ Creates a new transaction, linked to its inputs and their associated merkle path
|
|
|
1762
1759
|
```ts
|
|
1763
1760
|
static fromEF(ef: number[]): Transaction
|
|
1764
1761
|
```
|
|
1765
|
-
See also: [Transaction](
|
|
1762
|
+
See also: [Transaction](#class-transaction)
|
|
1766
1763
|
|
|
1767
1764
|
Returns
|
|
1768
1765
|
|
|
@@ -1780,7 +1777,7 @@ Creates a Transaction instance from a hexadecimal string.
|
|
|
1780
1777
|
```ts
|
|
1781
1778
|
static fromHex(hex: string): Transaction
|
|
1782
1779
|
```
|
|
1783
|
-
See also: [Transaction](
|
|
1780
|
+
See also: [Transaction](#class-transaction)
|
|
1784
1781
|
|
|
1785
1782
|
Returns
|
|
1786
1783
|
|
|
@@ -1801,7 +1798,7 @@ If no TXID is provided, the last transaction in the BEEF data is returned.
|
|
|
1801
1798
|
```ts
|
|
1802
1799
|
static fromHexBEEF(hex: string, txid?: string): Transaction
|
|
1803
1800
|
```
|
|
1804
|
-
See also: [Transaction](
|
|
1801
|
+
See also: [Transaction](#class-transaction)
|
|
1805
1802
|
|
|
1806
1803
|
Returns
|
|
1807
1804
|
|
|
@@ -1821,7 +1818,7 @@ Creates a Transaction instance from a hexadecimal string encoded EF.
|
|
|
1821
1818
|
```ts
|
|
1822
1819
|
static fromHexEF(hex: string): Transaction
|
|
1823
1820
|
```
|
|
1824
|
-
See also: [Transaction](
|
|
1821
|
+
See also: [Transaction](#class-transaction)
|
|
1825
1822
|
|
|
1826
1823
|
Returns
|
|
1827
1824
|
|
|
@@ -2088,7 +2085,7 @@ Verifies the legitimacy of the Bitcoin transaction according to the rules of SPV
|
|
|
2088
2085
|
```ts
|
|
2089
2086
|
async verify(chainTracker: ChainTracker | "scripts only" = defaultChainTracker(), feeModel?: FeeModel, memoryLimit?: number): Promise<boolean>
|
|
2090
2087
|
```
|
|
2091
|
-
See also: [ChainTracker](
|
|
2088
|
+
See also: [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [defaultChainTracker](#function-defaultchaintracker)
|
|
2092
2089
|
|
|
2093
2090
|
Returns
|
|
2094
2091
|
|
|
@@ -2129,7 +2126,7 @@ export default class WhatsOnChain implements ChainTracker {
|
|
|
2129
2126
|
}
|
|
2130
2127
|
```
|
|
2131
2128
|
|
|
2132
|
-
See also: [ChainTracker](
|
|
2129
|
+
See also: [ChainTracker](#interface-chaintracker), [HttpClient](#interface-httpclient), [WhatsOnChainConfig](#interface-whatsonchainconfig)
|
|
2133
2130
|
|
|
2134
2131
|
#### Constructor
|
|
2135
2132
|
|
|
@@ -2138,7 +2135,7 @@ Constructs an instance of the WhatsOnChain ChainTracker.
|
|
|
2138
2135
|
```ts
|
|
2139
2136
|
constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {})
|
|
2140
2137
|
```
|
|
2141
|
-
See also: [WhatsOnChainConfig](
|
|
2138
|
+
See also: [WhatsOnChainConfig](#interface-whatsonchainconfig)
|
|
2142
2139
|
|
|
2143
2140
|
Argument Details
|
|
2144
2141
|
|
|
@@ -2170,7 +2167,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
2170
2167
|
export function defaultBroadcaster(isTestnet: boolean = false, config: ArcConfig = {}): Broadcaster
|
|
2171
2168
|
```
|
|
2172
2169
|
|
|
2173
|
-
See also: [ArcConfig](
|
|
2170
|
+
See also: [ArcConfig](#interface-arcconfig), [Broadcaster](#interface-broadcaster)
|
|
2174
2171
|
|
|
2175
2172
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2176
2173
|
|
|
@@ -2181,7 +2178,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
2181
2178
|
export function defaultChainTracker(): ChainTracker
|
|
2182
2179
|
```
|
|
2183
2180
|
|
|
2184
|
-
See also: [ChainTracker](
|
|
2181
|
+
See also: [ChainTracker](#interface-chaintracker)
|
|
2185
2182
|
|
|
2186
2183
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2187
2184
|
|
|
@@ -2196,7 +2193,7 @@ If running in a Node environment, it falls back to using the Node `https` module
|
|
|
2196
2193
|
export function defaultHttpClient(): HttpClient
|
|
2197
2194
|
```
|
|
2198
2195
|
|
|
2199
|
-
See also: [HttpClient](
|
|
2196
|
+
See also: [HttpClient](#interface-httpclient)
|
|
2200
2197
|
|
|
2201
2198
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2202
2199
|
|
|
@@ -2209,7 +2206,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
|
|
|
2209
2206
|
export function isBroadcastFailure(r: BroadcastResponse | BroadcastFailure): r is BroadcastFailure
|
|
2210
2207
|
```
|
|
2211
2208
|
|
|
2212
|
-
See also: [BroadcastFailure](
|
|
2209
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
|
|
2213
2210
|
|
|
2214
2211
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2215
2212
|
|
|
@@ -2222,7 +2219,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
|
|
|
2222
2219
|
export function isBroadcastResponse(r: BroadcastResponse | BroadcastFailure): r is BroadcastResponse
|
|
2223
2220
|
```
|
|
2224
2221
|
|
|
2225
|
-
See also: [BroadcastFailure](
|
|
2222
|
+
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
|
|
2226
2223
|
|
|
2227
2224
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2228
2225
|
|
|
@@ -2248,7 +2245,7 @@ Makes a request to the server.
|
|
|
2248
2245
|
export type Fetch = (url: string, options: FetchOptions) => Promise<Response>
|
|
2249
2246
|
```
|
|
2250
2247
|
|
|
2251
|
-
See also: [FetchOptions](
|
|
2248
|
+
See also: [FetchOptions](#interface-fetchoptions)
|
|
2252
2249
|
|
|
2253
2250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2254
2251
|
|