@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/transaction.md
CHANGED
|
@@ -34,11 +34,7 @@ export interface ArcConfig {
|
|
|
34
34
|
}
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
See also: [HttpClient](#interface-httpclient)
|
|
38
|
-
|
|
39
|
-
<details>
|
|
40
|
-
|
|
41
|
-
<summary>Interface ArcConfig Details</summary>
|
|
37
|
+
See also: [HttpClient](./transaction.md#interface-httpclient)
|
|
42
38
|
|
|
43
39
|
#### Property apiKey
|
|
44
40
|
|
|
@@ -87,9 +83,7 @@ The HTTP client used to make requests to the ARC API.
|
|
|
87
83
|
```ts
|
|
88
84
|
httpClient?: HttpClient
|
|
89
85
|
```
|
|
90
|
-
See also: [HttpClient](#interface-httpclient)
|
|
91
|
-
|
|
92
|
-
</details>
|
|
86
|
+
See also: [HttpClient](./transaction.md#interface-httpclient)
|
|
93
87
|
|
|
94
88
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
95
89
|
|
|
@@ -139,7 +133,7 @@ export interface Broadcaster {
|
|
|
139
133
|
}
|
|
140
134
|
```
|
|
141
135
|
|
|
142
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
|
|
136
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
|
|
143
137
|
|
|
144
138
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
145
139
|
|
|
@@ -187,7 +181,7 @@ export default interface FeeModel {
|
|
|
187
181
|
}
|
|
188
182
|
```
|
|
189
183
|
|
|
190
|
-
See also: [Transaction](#class-transaction)
|
|
184
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
191
185
|
|
|
192
186
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
193
187
|
|
|
@@ -205,10 +199,6 @@ export interface FetchOptions {
|
|
|
205
199
|
}
|
|
206
200
|
```
|
|
207
201
|
|
|
208
|
-
<details>
|
|
209
|
-
|
|
210
|
-
<summary>Interface FetchOptions Details</summary>
|
|
211
|
-
|
|
212
202
|
#### Property body
|
|
213
203
|
|
|
214
204
|
An object or null to set request's body.
|
|
@@ -233,8 +223,6 @@ A string to set request's method.
|
|
|
233
223
|
method?: string
|
|
234
224
|
```
|
|
235
225
|
|
|
236
|
-
</details>
|
|
237
|
-
|
|
238
226
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
239
227
|
|
|
240
228
|
---
|
|
@@ -248,11 +236,7 @@ export interface HttpClient {
|
|
|
248
236
|
}
|
|
249
237
|
```
|
|
250
238
|
|
|
251
|
-
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
252
|
-
|
|
253
|
-
<details>
|
|
254
|
-
|
|
255
|
-
<summary>Interface HttpClient Details</summary>
|
|
239
|
+
See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
|
|
256
240
|
|
|
257
241
|
#### Property request
|
|
258
242
|
|
|
@@ -261,9 +245,7 @@ Makes a request to the server.
|
|
|
261
245
|
```ts
|
|
262
246
|
request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) => Promise<HttpClientResponse<T>>
|
|
263
247
|
```
|
|
264
|
-
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
265
|
-
|
|
266
|
-
</details>
|
|
248
|
+
See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
|
|
267
249
|
|
|
268
250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
269
251
|
|
|
@@ -280,10 +262,6 @@ export interface HttpClientRequestOptions<Data = any> {
|
|
|
280
262
|
}
|
|
281
263
|
```
|
|
282
264
|
|
|
283
|
-
<details>
|
|
284
|
-
|
|
285
|
-
<summary>Interface HttpClientRequestOptions Details</summary>
|
|
286
|
-
|
|
287
265
|
#### Property data
|
|
288
266
|
|
|
289
267
|
An object or null to set request's body.
|
|
@@ -308,8 +286,6 @@ A string to set request's method.
|
|
|
308
286
|
method?: string
|
|
309
287
|
```
|
|
310
288
|
|
|
311
|
-
</details>
|
|
312
|
-
|
|
313
289
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
314
290
|
|
|
315
291
|
---
|
|
@@ -323,7 +299,7 @@ export interface HttpsNodejs {
|
|
|
323
299
|
}
|
|
324
300
|
```
|
|
325
301
|
|
|
326
|
-
See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [NodejsHttpClientRequest](#interface-nodejshttpclientrequest)
|
|
302
|
+
See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [NodejsHttpClientRequest](./transaction.md#interface-nodejshttpclientrequest)
|
|
327
303
|
|
|
328
304
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
329
305
|
|
|
@@ -394,7 +370,7 @@ export default interface TransactionInput {
|
|
|
394
370
|
}
|
|
395
371
|
```
|
|
396
372
|
|
|
397
|
-
See also: [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
|
|
373
|
+
See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
|
|
398
374
|
|
|
399
375
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
400
376
|
|
|
@@ -424,7 +400,7 @@ export default interface TransactionOutput {
|
|
|
424
400
|
}
|
|
425
401
|
```
|
|
426
402
|
|
|
427
|
-
See also: [LockingScript](#class-lockingscript)
|
|
403
|
+
See also: [LockingScript](./script.md#class-lockingscript)
|
|
428
404
|
|
|
429
405
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
430
406
|
|
|
@@ -440,11 +416,7 @@ export interface WhatsOnChainConfig {
|
|
|
440
416
|
}
|
|
441
417
|
```
|
|
442
418
|
|
|
443
|
-
See also: [HttpClient](#interface-httpclient)
|
|
444
|
-
|
|
445
|
-
<details>
|
|
446
|
-
|
|
447
|
-
<summary>Interface WhatsOnChainConfig Details</summary>
|
|
419
|
+
See also: [HttpClient](./transaction.md#interface-httpclient)
|
|
448
420
|
|
|
449
421
|
#### Property apiKey
|
|
450
422
|
|
|
@@ -461,9 +433,7 @@ The HTTP client used to make requests to the API.
|
|
|
461
433
|
```ts
|
|
462
434
|
httpClient?: HttpClient
|
|
463
435
|
```
|
|
464
|
-
See also: [HttpClient](#interface-httpclient)
|
|
465
|
-
|
|
466
|
-
</details>
|
|
436
|
+
See also: [HttpClient](./transaction.md#interface-httpclient)
|
|
467
437
|
|
|
468
438
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
469
439
|
|
|
@@ -507,11 +477,7 @@ export default class ARC implements Broadcaster {
|
|
|
507
477
|
}
|
|
508
478
|
```
|
|
509
479
|
|
|
510
|
-
See also: [ArcConfig](#interface-arcconfig), [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [Transaction](#class-transaction)
|
|
511
|
-
|
|
512
|
-
<details>
|
|
513
|
-
|
|
514
|
-
<summary>Class ARC Details</summary>
|
|
480
|
+
See also: [ArcConfig](./transaction.md#interface-arcconfig), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [Transaction](./transaction.md#class-transaction)
|
|
515
481
|
|
|
516
482
|
#### Constructor
|
|
517
483
|
|
|
@@ -520,7 +486,7 @@ Constructs an instance of the ARC broadcaster.
|
|
|
520
486
|
```ts
|
|
521
487
|
constructor(URL: string, config?: ArcConfig)
|
|
522
488
|
```
|
|
523
|
-
See also: [ArcConfig](#interface-arcconfig)
|
|
489
|
+
See also: [ArcConfig](./transaction.md#interface-arcconfig)
|
|
524
490
|
|
|
525
491
|
Argument Details
|
|
526
492
|
|
|
@@ -551,7 +517,7 @@ Broadcasts a transaction via ARC.
|
|
|
551
517
|
```ts
|
|
552
518
|
async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>
|
|
553
519
|
```
|
|
554
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
|
|
520
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
|
|
555
521
|
|
|
556
522
|
Returns
|
|
557
523
|
|
|
@@ -570,7 +536,7 @@ Handles mixed responses where some transactions succeed and others fail.
|
|
|
570
536
|
```ts
|
|
571
537
|
async broadcastMany(txs: Transaction[]): Promise<object[]>
|
|
572
538
|
```
|
|
573
|
-
See also: [Transaction](#class-transaction)
|
|
539
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
574
540
|
|
|
575
541
|
Returns
|
|
576
542
|
|
|
@@ -581,8 +547,6 @@ Argument Details
|
|
|
581
547
|
+ **txs**
|
|
582
548
|
+ Array of transactions to be broadcasted.
|
|
583
549
|
|
|
584
|
-
</details>
|
|
585
|
-
|
|
586
550
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
587
551
|
|
|
588
552
|
---
|
|
@@ -631,11 +595,7 @@ export class Beef {
|
|
|
631
595
|
}
|
|
632
596
|
```
|
|
633
597
|
|
|
634
|
-
See also: [BEEF_V2](#variable-beef_v2), [BeefTx](#class-beeftx), [ChainTracker](#interface-chaintracker), [MerklePath](#class-merklepath), [Reader](#class-reader), [Transaction](#class-transaction), [Writer](#class-writer), [toHex](#variable-tohex), [verify](#variable-verify)
|
|
635
|
-
|
|
636
|
-
<details>
|
|
637
|
-
|
|
638
|
-
<summary>Class Beef Details</summary>
|
|
598
|
+
See also: [BEEF_V2](./transaction.md#variable-beef_v2), [BeefTx](./transaction.md#class-beeftx), [ChainTracker](./transaction.md#interface-chaintracker), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
|
|
639
599
|
|
|
640
600
|
#### Method addComputedLeaves
|
|
641
601
|
|
|
@@ -651,7 +611,7 @@ addComputedLeaves(): void
|
|
|
651
611
|
```ts
|
|
652
612
|
clone(): Beef
|
|
653
613
|
```
|
|
654
|
-
See also: [Beef](#class-beef)
|
|
614
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
655
615
|
|
|
656
616
|
Returns
|
|
657
617
|
|
|
@@ -666,7 +626,7 @@ To succeed, the Beef must contain all the required transaction and merkle path d
|
|
|
666
626
|
```ts
|
|
667
627
|
findAtomicTransaction(txid: string): Transaction | undefined
|
|
668
628
|
```
|
|
669
|
-
See also: [Transaction](#class-transaction)
|
|
629
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
670
630
|
|
|
671
631
|
Returns
|
|
672
632
|
|
|
@@ -682,7 +642,7 @@ Argument Details
|
|
|
682
642
|
```ts
|
|
683
643
|
findBump(txid: string): MerklePath | undefined
|
|
684
644
|
```
|
|
685
|
-
See also: [MerklePath](#class-merklepath)
|
|
645
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
686
646
|
|
|
687
647
|
Returns
|
|
688
648
|
|
|
@@ -698,7 +658,7 @@ The result is suitable for signing.
|
|
|
698
658
|
```ts
|
|
699
659
|
findTransactionForSigning(txid: string): Transaction | undefined
|
|
700
660
|
```
|
|
701
|
-
See also: [Transaction](#class-transaction)
|
|
661
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
702
662
|
|
|
703
663
|
Returns
|
|
704
664
|
|
|
@@ -714,7 +674,7 @@ Argument Details
|
|
|
714
674
|
```ts
|
|
715
675
|
findTxid(txid: string): BeefTx | undefined
|
|
716
676
|
```
|
|
717
|
-
See also: [BeefTx](#class-beeftx)
|
|
677
|
+
See also: [BeefTx](./transaction.md#class-beeftx)
|
|
718
678
|
|
|
719
679
|
Returns
|
|
720
680
|
|
|
@@ -732,7 +692,7 @@ Constructs an instance of the Beef class based on the provided binary array
|
|
|
732
692
|
```ts
|
|
733
693
|
static fromBinary(bin: number[]): Beef
|
|
734
694
|
```
|
|
735
|
-
See also: [Beef](#class-beef)
|
|
695
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
736
696
|
|
|
737
697
|
Returns
|
|
738
698
|
|
|
@@ -750,7 +710,7 @@ Constructs an instance of the Beef class based on the provided string
|
|
|
750
710
|
```ts
|
|
751
711
|
static fromString(s: string, enc: "hex" | "utf8" | "base64" = "hex"): Beef
|
|
752
712
|
```
|
|
753
|
-
See also: [Beef](#class-beef)
|
|
713
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
754
714
|
|
|
755
715
|
Returns
|
|
756
716
|
|
|
@@ -805,7 +765,7 @@ original.
|
|
|
805
765
|
```ts
|
|
806
766
|
makeTxidOnly(txid: string): BeefTx | undefined
|
|
807
767
|
```
|
|
808
|
-
See also: [BeefTx](#class-beeftx)
|
|
768
|
+
See also: [BeefTx](./transaction.md#class-beeftx)
|
|
809
769
|
|
|
810
770
|
Returns
|
|
811
771
|
|
|
@@ -818,7 +778,7 @@ Merge a MerklePath that is assumed to be fully valid.
|
|
|
818
778
|
```ts
|
|
819
779
|
mergeBump(bump: MerklePath): number
|
|
820
780
|
```
|
|
821
|
-
See also: [MerklePath](#class-merklepath)
|
|
781
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
822
782
|
|
|
823
783
|
Returns
|
|
824
784
|
|
|
@@ -835,7 +795,7 @@ Replaces existing transaction with same txid.
|
|
|
835
795
|
```ts
|
|
836
796
|
mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx
|
|
837
797
|
```
|
|
838
|
-
See also: [BeefTx](#class-beeftx)
|
|
798
|
+
See also: [BeefTx](./transaction.md#class-beeftx)
|
|
839
799
|
|
|
840
800
|
Returns
|
|
841
801
|
|
|
@@ -857,7 +817,7 @@ Attempts to match an existing bump to the new transaction.
|
|
|
857
817
|
```ts
|
|
858
818
|
mergeTransaction(tx: Transaction): BeefTx
|
|
859
819
|
```
|
|
860
|
-
See also: [BeefTx](#class-beeftx), [Transaction](#class-transaction)
|
|
820
|
+
See also: [BeefTx](./transaction.md#class-beeftx), [Transaction](./transaction.md#class-transaction)
|
|
861
821
|
|
|
862
822
|
Returns
|
|
863
823
|
|
|
@@ -956,7 +916,7 @@ Serializes this data to `writer`
|
|
|
956
916
|
```ts
|
|
957
917
|
toWriter(writer: Writer): void
|
|
958
918
|
```
|
|
959
|
-
See also: [Writer](#class-writer)
|
|
919
|
+
See also: [Writer](./primitives.md#class-writer)
|
|
960
920
|
|
|
961
921
|
#### Method trimKnownTxids
|
|
962
922
|
|
|
@@ -981,7 +941,7 @@ Validity requirements:
|
|
|
981
941
|
```ts
|
|
982
942
|
async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean>
|
|
983
943
|
```
|
|
984
|
-
See also: [ChainTracker](#interface-chaintracker)
|
|
944
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker)
|
|
985
945
|
|
|
986
946
|
Argument Details
|
|
987
947
|
|
|
@@ -990,8 +950,6 @@ Argument Details
|
|
|
990
950
|
+ **allowTxidOnly**
|
|
991
951
|
+ optional. If true, transaction txid is assumed valid
|
|
992
952
|
|
|
993
|
-
</details>
|
|
994
|
-
|
|
995
953
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
996
954
|
|
|
997
955
|
---
|
|
@@ -1029,11 +987,7 @@ export class BeefParty extends Beef {
|
|
|
1029
987
|
}
|
|
1030
988
|
```
|
|
1031
989
|
|
|
1032
|
-
See also: [Beef](#class-beef)
|
|
1033
|
-
|
|
1034
|
-
<details>
|
|
1035
|
-
|
|
1036
|
-
<summary>Class BeefParty Details</summary>
|
|
990
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
1037
991
|
|
|
1038
992
|
#### Constructor
|
|
1039
993
|
|
|
@@ -1091,7 +1045,7 @@ Array of txids "known" to `party`.
|
|
|
1091
1045
|
```ts
|
|
1092
1046
|
getTrimmedBeefForParty(party: string): Beef
|
|
1093
1047
|
```
|
|
1094
|
-
See also: [Beef](#class-beef)
|
|
1048
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
1095
1049
|
|
|
1096
1050
|
Returns
|
|
1097
1051
|
|
|
@@ -1118,9 +1072,7 @@ has raw transaction and validity proof data.
|
|
|
1118
1072
|
```ts
|
|
1119
1073
|
mergeBeefFromParty(party: string, beef: number[] | Beef): void
|
|
1120
1074
|
```
|
|
1121
|
-
See also: [Beef](#class-beef)
|
|
1122
|
-
|
|
1123
|
-
</details>
|
|
1075
|
+
See also: [Beef](./transaction.md#class-beef)
|
|
1124
1076
|
|
|
1125
1077
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1126
1078
|
|
|
@@ -1159,18 +1111,14 @@ export default class BeefTx {
|
|
|
1159
1111
|
}
|
|
1160
1112
|
```
|
|
1161
1113
|
|
|
1162
|
-
See also: [Reader](#class-reader), [Transaction](#class-transaction), [Writer](#class-writer)
|
|
1163
|
-
|
|
1164
|
-
<details>
|
|
1165
|
-
|
|
1166
|
-
<summary>Class BeefTx Details</summary>
|
|
1114
|
+
See also: [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer)
|
|
1167
1115
|
|
|
1168
1116
|
#### Constructor
|
|
1169
1117
|
|
|
1170
1118
|
```ts
|
|
1171
1119
|
constructor(tx: Transaction | number[] | string, bumpIndex?: number)
|
|
1172
1120
|
```
|
|
1173
|
-
See also: [Transaction](#class-transaction)
|
|
1121
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1174
1122
|
|
|
1175
1123
|
Argument Details
|
|
1176
1124
|
|
|
@@ -1189,8 +1137,6 @@ Typically set by sorting transactions by proven dependency chains.
|
|
|
1189
1137
|
isValid?: boolean = undefined
|
|
1190
1138
|
```
|
|
1191
1139
|
|
|
1192
|
-
</details>
|
|
1193
|
-
|
|
1194
1140
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1195
1141
|
|
|
1196
1142
|
---
|
|
@@ -1205,7 +1151,7 @@ export class FetchHttpClient implements HttpClient {
|
|
|
1205
1151
|
}
|
|
1206
1152
|
```
|
|
1207
1153
|
|
|
1208
|
-
See also: [Fetch](#type-fetch), [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
|
|
1154
|
+
See also: [Fetch](./transaction.md#type-fetch), [HttpClient](./transaction.md#interface-httpclient), [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
|
|
1209
1155
|
|
|
1210
1156
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1211
1157
|
|
|
@@ -1253,11 +1199,7 @@ export default class MerklePath {
|
|
|
1253
1199
|
}
|
|
1254
1200
|
```
|
|
1255
1201
|
|
|
1256
|
-
See also: [ChainTracker](#interface-chaintracker), [MerklePathLeaf](#interface-merklepathleaf), [Reader](#class-reader), [toHex](#variable-tohex), [verify](#variable-verify)
|
|
1257
|
-
|
|
1258
|
-
<details>
|
|
1259
|
-
|
|
1260
|
-
<summary>Class MerklePath Details</summary>
|
|
1202
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker), [MerklePathLeaf](./transaction.md#interface-merklepathleaf), [Reader](./primitives.md#class-reader), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
|
|
1261
1203
|
|
|
1262
1204
|
#### Method combine
|
|
1263
1205
|
|
|
@@ -1266,7 +1208,7 @@ Combines this MerklePath with another to create a compound proof.
|
|
|
1266
1208
|
```ts
|
|
1267
1209
|
combine(other: MerklePath): void
|
|
1268
1210
|
```
|
|
1269
|
-
See also: [MerklePath](#class-merklepath)
|
|
1211
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
1270
1212
|
|
|
1271
1213
|
Argument Details
|
|
1272
1214
|
|
|
@@ -1307,7 +1249,7 @@ Does not add computed leaves to path.
|
|
|
1307
1249
|
```ts
|
|
1308
1250
|
findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined
|
|
1309
1251
|
```
|
|
1310
|
-
See also: [MerklePathLeaf](#interface-merklepathleaf)
|
|
1252
|
+
See also: [MerklePathLeaf](./transaction.md#interface-merklepathleaf)
|
|
1311
1253
|
|
|
1312
1254
|
#### Method fromBinary
|
|
1313
1255
|
|
|
@@ -1316,7 +1258,7 @@ Creates a MerklePath instance from a binary array.
|
|
|
1316
1258
|
```ts
|
|
1317
1259
|
static fromBinary(bump: number[]): MerklePath
|
|
1318
1260
|
```
|
|
1319
|
-
See also: [MerklePath](#class-merklepath)
|
|
1261
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
1320
1262
|
|
|
1321
1263
|
Returns
|
|
1322
1264
|
|
|
@@ -1332,7 +1274,7 @@ Argument Details
|
|
|
1332
1274
|
```ts
|
|
1333
1275
|
static fromCoinbaseTxidAndHeight(txid: string, height: number): MerklePath
|
|
1334
1276
|
```
|
|
1335
|
-
See also: [MerklePath](#class-merklepath)
|
|
1277
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
1336
1278
|
|
|
1337
1279
|
Returns
|
|
1338
1280
|
|
|
@@ -1352,7 +1294,7 @@ Creates a MerklePath instance from a hexadecimal string.
|
|
|
1352
1294
|
```ts
|
|
1353
1295
|
static fromHex(hex: string): MerklePath
|
|
1354
1296
|
```
|
|
1355
|
-
See also: [MerklePath](#class-merklepath)
|
|
1297
|
+
See also: [MerklePath](./transaction.md#class-merklepath)
|
|
1356
1298
|
|
|
1357
1299
|
Returns
|
|
1358
1300
|
|
|
@@ -1404,7 +1346,7 @@ Verifies if the given transaction ID is part of the Merkle tree at the specified
|
|
|
1404
1346
|
```ts
|
|
1405
1347
|
async verify(txid: string, chainTracker: ChainTracker): Promise<boolean>
|
|
1406
1348
|
```
|
|
1407
|
-
See also: [ChainTracker](#interface-chaintracker)
|
|
1349
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker)
|
|
1408
1350
|
|
|
1409
1351
|
Returns
|
|
1410
1352
|
|
|
@@ -1417,8 +1359,6 @@ Argument Details
|
|
|
1417
1359
|
+ **chainTracker**
|
|
1418
1360
|
+ The ChainTracker instance used to verify the Merkle root.
|
|
1419
1361
|
|
|
1420
|
-
</details>
|
|
1421
|
-
|
|
1422
1362
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1423
1363
|
|
|
1424
1364
|
---
|
|
@@ -1433,7 +1373,7 @@ export class NodejsHttpClient implements HttpClient {
|
|
|
1433
1373
|
}
|
|
1434
1374
|
```
|
|
1435
1375
|
|
|
1436
|
-
See also: [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse), [HttpsNodejs](#interface-httpsnodejs)
|
|
1376
|
+
See also: [HttpClient](./transaction.md#interface-httpclient), [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse), [HttpsNodejs](./transaction.md#interface-httpsnodejs)
|
|
1437
1377
|
|
|
1438
1378
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1439
1379
|
|
|
@@ -1450,11 +1390,7 @@ export default class SatoshisPerKilobyte implements FeeModel {
|
|
|
1450
1390
|
}
|
|
1451
1391
|
```
|
|
1452
1392
|
|
|
1453
|
-
See also: [FeeModel](#interface-feemodel), [Transaction](#class-transaction)
|
|
1454
|
-
|
|
1455
|
-
<details>
|
|
1456
|
-
|
|
1457
|
-
<summary>Class SatoshisPerKilobyte Details</summary>
|
|
1393
|
+
See also: [FeeModel](./transaction.md#interface-feemodel), [Transaction](./transaction.md#class-transaction)
|
|
1458
1394
|
|
|
1459
1395
|
#### Constructor
|
|
1460
1396
|
|
|
@@ -1476,7 +1412,7 @@ Computes the fee for a given transaction.
|
|
|
1476
1412
|
```ts
|
|
1477
1413
|
async computeFee(tx: Transaction): Promise<number>
|
|
1478
1414
|
```
|
|
1479
|
-
See also: [Transaction](#class-transaction)
|
|
1415
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1480
1416
|
|
|
1481
1417
|
Returns
|
|
1482
1418
|
|
|
@@ -1487,8 +1423,6 @@ Argument Details
|
|
|
1487
1423
|
+ **tx**
|
|
1488
1424
|
+ The transaction for which a fee is to be computed.
|
|
1489
1425
|
|
|
1490
|
-
</details>
|
|
1491
|
-
|
|
1492
1426
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
1493
1427
|
|
|
1494
1428
|
---
|
|
@@ -1563,11 +1497,7 @@ export default class Transaction {
|
|
|
1563
1497
|
}
|
|
1564
1498
|
```
|
|
1565
1499
|
|
|
1566
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [MerklePath](#class-merklepath), [Reader](#class-reader), [SatoshisPerKilobyte](#class-satoshisperkilobyte), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput), [defaultBroadcaster](#function-defaultbroadcaster), [defaultChainTracker](#function-defaultchaintracker), [sign](#variable-sign), [toHex](#variable-tohex), [verify](#variable-verify)
|
|
1567
|
-
|
|
1568
|
-
<details>
|
|
1569
|
-
|
|
1570
|
-
<summary>Class Transaction Details</summary>
|
|
1500
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
|
|
1571
1501
|
|
|
1572
1502
|
#### Method addInput
|
|
1573
1503
|
|
|
@@ -1576,7 +1506,7 @@ Adds a new input to the transaction.
|
|
|
1576
1506
|
```ts
|
|
1577
1507
|
addInput(input: TransactionInput): void
|
|
1578
1508
|
```
|
|
1579
|
-
See also: [TransactionInput](#interface-transactioninput)
|
|
1509
|
+
See also: [TransactionInput](./transaction.md#interface-transactioninput)
|
|
1580
1510
|
|
|
1581
1511
|
Argument Details
|
|
1582
1512
|
|
|
@@ -1594,7 +1524,7 @@ Adds a new output to the transaction.
|
|
|
1594
1524
|
```ts
|
|
1595
1525
|
addOutput(output: TransactionOutput): void
|
|
1596
1526
|
```
|
|
1597
|
-
See also: [TransactionOutput](#interface-transactionoutput)
|
|
1527
|
+
See also: [TransactionOutput](./transaction.md#interface-transactionoutput)
|
|
1598
1528
|
|
|
1599
1529
|
Argument Details
|
|
1600
1530
|
|
|
@@ -1623,7 +1553,7 @@ Broadcasts a transaction.
|
|
|
1623
1553
|
```ts
|
|
1624
1554
|
async broadcast(broadcaster: Broadcaster = defaultBroadcaster()): Promise<BroadcastResponse | BroadcastFailure>
|
|
1625
1555
|
```
|
|
1626
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [defaultBroadcaster](#function-defaultbroadcaster)
|
|
1556
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster)
|
|
1627
1557
|
|
|
1628
1558
|
Returns
|
|
1629
1559
|
|
|
@@ -1643,7 +1573,7 @@ If fee is a number, the transaction uses that value as fee.
|
|
|
1643
1573
|
```ts
|
|
1644
1574
|
async fee(modelOrFee: FeeModel | number = new SatoshisPerKilobyte(1), changeDistribution: "equal" | "random" = "equal"): Promise<void>
|
|
1645
1575
|
```
|
|
1646
|
-
See also: [FeeModel](#interface-feemodel), [SatoshisPerKilobyte](#class-satoshisperkilobyte)
|
|
1576
|
+
See also: [FeeModel](./transaction.md#interface-feemodel), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte)
|
|
1647
1577
|
|
|
1648
1578
|
Argument Details
|
|
1649
1579
|
|
|
@@ -1661,7 +1591,7 @@ Extracts the subject transaction and supporting merkle path and source transacti
|
|
|
1661
1591
|
```ts
|
|
1662
1592
|
static fromAtomicBEEF(beef: number[]): Transaction
|
|
1663
1593
|
```
|
|
1664
|
-
See also: [Transaction](#class-transaction)
|
|
1594
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1665
1595
|
|
|
1666
1596
|
Returns
|
|
1667
1597
|
|
|
@@ -1682,7 +1612,7 @@ If no TXID is provided, the last transaction in the BEEF data is returned, or th
|
|
|
1682
1612
|
```ts
|
|
1683
1613
|
static fromBEEF(beef: number[], txid?: string): Transaction
|
|
1684
1614
|
```
|
|
1685
|
-
See also: [Transaction](#class-transaction)
|
|
1615
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1686
1616
|
|
|
1687
1617
|
Returns
|
|
1688
1618
|
|
|
@@ -1702,7 +1632,7 @@ Creates a Transaction instance from a binary array.
|
|
|
1702
1632
|
```ts
|
|
1703
1633
|
static fromBinary(bin: number[]): Transaction
|
|
1704
1634
|
```
|
|
1705
|
-
See also: [Transaction](#class-transaction)
|
|
1635
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1706
1636
|
|
|
1707
1637
|
Returns
|
|
1708
1638
|
|
|
@@ -1720,7 +1650,7 @@ Creates a new transaction, linked to its inputs and their associated merkle path
|
|
|
1720
1650
|
```ts
|
|
1721
1651
|
static fromEF(ef: number[]): Transaction
|
|
1722
1652
|
```
|
|
1723
|
-
See also: [Transaction](#class-transaction)
|
|
1653
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1724
1654
|
|
|
1725
1655
|
Returns
|
|
1726
1656
|
|
|
@@ -1738,7 +1668,7 @@ Creates a Transaction instance from a hexadecimal string.
|
|
|
1738
1668
|
```ts
|
|
1739
1669
|
static fromHex(hex: string): Transaction
|
|
1740
1670
|
```
|
|
1741
|
-
See also: [Transaction](#class-transaction)
|
|
1671
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1742
1672
|
|
|
1743
1673
|
Returns
|
|
1744
1674
|
|
|
@@ -1759,7 +1689,7 @@ If no TXID is provided, the last transaction in the BEEF data is returned.
|
|
|
1759
1689
|
```ts
|
|
1760
1690
|
static fromHexBEEF(hex: string, txid?: string): Transaction
|
|
1761
1691
|
```
|
|
1762
|
-
See also: [Transaction](#class-transaction)
|
|
1692
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1763
1693
|
|
|
1764
1694
|
Returns
|
|
1765
1695
|
|
|
@@ -1779,7 +1709,7 @@ Creates a Transaction instance from a hexadecimal string encoded EF.
|
|
|
1779
1709
|
```ts
|
|
1780
1710
|
static fromHexEF(hex: string): Transaction
|
|
1781
1711
|
```
|
|
1782
|
-
See also: [Transaction](#class-transaction)
|
|
1712
|
+
See also: [Transaction](./transaction.md#class-transaction)
|
|
1783
1713
|
|
|
1784
1714
|
Returns
|
|
1785
1715
|
|
|
@@ -2046,7 +1976,7 @@ Verifies the legitimacy of the Bitcoin transaction according to the rules of SPV
|
|
|
2046
1976
|
```ts
|
|
2047
1977
|
async verify(chainTracker: ChainTracker | "scripts only" = defaultChainTracker(), feeModel?: FeeModel, memoryLimit?: number): Promise<boolean>
|
|
2048
1978
|
```
|
|
2049
|
-
See also: [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [defaultChainTracker](#function-defaultchaintracker)
|
|
1979
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [defaultChainTracker](./transaction.md#function-defaultchaintracker)
|
|
2050
1980
|
|
|
2051
1981
|
Returns
|
|
2052
1982
|
|
|
@@ -2067,8 +1997,6 @@ Example
|
|
|
2067
1997
|
tx.verify(new WhatsOnChain(), new SatoshisPerKilobyte(1))
|
|
2068
1998
|
```
|
|
2069
1999
|
|
|
2070
|
-
</details>
|
|
2071
|
-
|
|
2072
2000
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2073
2001
|
|
|
2074
2002
|
---
|
|
@@ -2089,11 +2017,7 @@ export default class WhatsOnChain implements ChainTracker {
|
|
|
2089
2017
|
}
|
|
2090
2018
|
```
|
|
2091
2019
|
|
|
2092
|
-
See also: [ChainTracker](#interface-chaintracker), [HttpClient](#interface-httpclient), [WhatsOnChainConfig](#interface-whatsonchainconfig)
|
|
2093
|
-
|
|
2094
|
-
<details>
|
|
2095
|
-
|
|
2096
|
-
<summary>Class WhatsOnChain Details</summary>
|
|
2020
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker), [HttpClient](./transaction.md#interface-httpclient), [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig)
|
|
2097
2021
|
|
|
2098
2022
|
#### Constructor
|
|
2099
2023
|
|
|
@@ -2102,7 +2026,7 @@ Constructs an instance of the WhatsOnChain ChainTracker.
|
|
|
2102
2026
|
```ts
|
|
2103
2027
|
constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {})
|
|
2104
2028
|
```
|
|
2105
|
-
See also: [WhatsOnChainConfig](#interface-whatsonchainconfig)
|
|
2029
|
+
See also: [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig)
|
|
2106
2030
|
|
|
2107
2031
|
Argument Details
|
|
2108
2032
|
|
|
@@ -2111,8 +2035,6 @@ Argument Details
|
|
|
2111
2035
|
+ **config**
|
|
2112
2036
|
+ Configuration options for the WhatsOnChain ChainTracker.
|
|
2113
2037
|
|
|
2114
|
-
</details>
|
|
2115
|
-
|
|
2116
2038
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2117
2039
|
|
|
2118
2040
|
---
|
|
@@ -2136,7 +2058,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
2136
2058
|
export function defaultBroadcaster(isTestnet: boolean = false, config: ArcConfig = {}): Broadcaster
|
|
2137
2059
|
```
|
|
2138
2060
|
|
|
2139
|
-
See also: [ArcConfig](#interface-arcconfig), [Broadcaster](#interface-broadcaster)
|
|
2061
|
+
See also: [ArcConfig](./transaction.md#interface-arcconfig), [Broadcaster](./transaction.md#interface-broadcaster)
|
|
2140
2062
|
|
|
2141
2063
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2142
2064
|
|
|
@@ -2147,7 +2069,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
2147
2069
|
export function defaultChainTracker(): ChainTracker
|
|
2148
2070
|
```
|
|
2149
2071
|
|
|
2150
|
-
See also: [ChainTracker](#interface-chaintracker)
|
|
2072
|
+
See also: [ChainTracker](./transaction.md#interface-chaintracker)
|
|
2151
2073
|
|
|
2152
2074
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2153
2075
|
|
|
@@ -2162,7 +2084,7 @@ If running in a Node environment, it falls back to using the Node `https` module
|
|
|
2162
2084
|
export function defaultHttpClient(): HttpClient
|
|
2163
2085
|
```
|
|
2164
2086
|
|
|
2165
|
-
See also: [HttpClient](#interface-httpclient)
|
|
2087
|
+
See also: [HttpClient](./transaction.md#interface-httpclient)
|
|
2166
2088
|
|
|
2167
2089
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2168
2090
|
|
|
@@ -2175,7 +2097,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
|
|
|
2175
2097
|
export function isBroadcastFailure(r: BroadcastResponse | BroadcastFailure): r is BroadcastFailure
|
|
2176
2098
|
```
|
|
2177
2099
|
|
|
2178
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
|
|
2100
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse)
|
|
2179
2101
|
|
|
2180
2102
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2181
2103
|
|
|
@@ -2188,7 +2110,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
|
|
|
2188
2110
|
export function isBroadcastResponse(r: BroadcastResponse | BroadcastFailure): r is BroadcastResponse
|
|
2189
2111
|
```
|
|
2190
2112
|
|
|
2191
|
-
See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
|
|
2113
|
+
See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse)
|
|
2192
2114
|
|
|
2193
2115
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2194
2116
|
|
|
@@ -2214,7 +2136,7 @@ Makes a request to the server.
|
|
|
2214
2136
|
export type Fetch = (url: string, options: FetchOptions) => Promise<Response>
|
|
2215
2137
|
```
|
|
2216
2138
|
|
|
2217
|
-
See also: [FetchOptions](#interface-fetchoptions)
|
|
2139
|
+
See also: [FetchOptions](./transaction.md#interface-fetchoptions)
|
|
2218
2140
|
|
|
2219
2141
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
|
|
2220
2142
|
|