@bsv/wallet-toolbox 1.1.6 → 1.1.7
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/docs/client.md +0 -414
- package/docs/monitor.md +0 -42
- package/docs/services.md +0 -18
- package/docs/setup.md +0 -42
- package/docs/storage.md +0 -84
- package/docs/wallet.md +0 -414
- package/out/src/storage/methods/purgeData.d.ts.map +1 -1
- package/out/src/storage/methods/purgeData.js +4 -2
- package/out/src/storage/methods/purgeData.js.map +1 -1
- package/out/src/storage/methods/reviewStatus.js +1 -1
- package/out/src/storage/methods/reviewStatus.js.map +1 -1
- package/out/test/Wallet/live/walletLive.man.test.d.ts.map +1 -1
- package/out/test/Wallet/live/walletLive.man.test.js +34 -0
- package/out/test/Wallet/live/walletLive.man.test.js.map +1 -1
- package/out/tsconfig.all.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/storage/methods/purgeData.ts +4 -2
- package/src/storage/methods/reviewStatus.ts +1 -1
- package/test/Wallet/live/walletLive.man.test.ts +40 -0
- package/ts2md.json +12 -6
package/docs/client.md
CHANGED
|
@@ -168,10 +168,6 @@ export interface BaseBlockHeader {
|
|
|
168
168
|
}
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
<details>
|
|
172
|
-
|
|
173
|
-
<summary>Interface BaseBlockHeader Details</summary>
|
|
174
|
-
|
|
175
171
|
###### Property bits
|
|
176
172
|
|
|
177
173
|
Block header bits value. Serialized length is 4 bytes.
|
|
@@ -220,8 +216,6 @@ Block header version value. Serialized length is 4 bytes.
|
|
|
220
216
|
version: number
|
|
221
217
|
```
|
|
222
218
|
|
|
223
|
-
</details>
|
|
224
|
-
|
|
225
219
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
226
220
|
|
|
227
221
|
---
|
|
@@ -238,10 +232,6 @@ export interface BlockHeader extends BaseBlockHeader {
|
|
|
238
232
|
|
|
239
233
|
See also: [BaseBlockHeader](#interface-baseblockheader)
|
|
240
234
|
|
|
241
|
-
<details>
|
|
242
|
-
|
|
243
|
-
<summary>Interface BlockHeader Details</summary>
|
|
244
|
-
|
|
245
235
|
###### Property hash
|
|
246
236
|
|
|
247
237
|
The double sha256 hash of the serialized `BaseBlockHeader` fields.
|
|
@@ -258,8 +248,6 @@ Height of the header, starting from zero.
|
|
|
258
248
|
height: number
|
|
259
249
|
```
|
|
260
250
|
|
|
261
|
-
</details>
|
|
262
|
-
|
|
263
251
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
264
252
|
|
|
265
253
|
---
|
|
@@ -656,10 +644,6 @@ export interface GenerateChangeSdkParams {
|
|
|
656
644
|
|
|
657
645
|
See also: [GenerateChangeSdkInput](#interface-generatechangesdkinput), [GenerateChangeSdkOutput](#interface-generatechangesdkoutput), [StorageFeeModel](#interface-storagefeemodel)
|
|
658
646
|
|
|
659
|
-
<details>
|
|
660
|
-
|
|
661
|
-
<summary>Interface GenerateChangeSdkParams Details</summary>
|
|
662
|
-
|
|
663
647
|
###### Property changeFirstSatoshis
|
|
664
648
|
|
|
665
649
|
Lowest amount value to assign to a change output.
|
|
@@ -707,8 +691,6 @@ If undefined, only a single change output will be added if excess fees must be r
|
|
|
707
691
|
targetNetCount?: number
|
|
708
692
|
```
|
|
709
693
|
|
|
710
|
-
</details>
|
|
711
|
-
|
|
712
694
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
713
695
|
|
|
714
696
|
---
|
|
@@ -757,10 +739,6 @@ export interface GetMerklePathResult {
|
|
|
757
739
|
|
|
758
740
|
See also: [BlockHeader](#interface-blockheader), [WalletError](#class-walleterror)
|
|
759
741
|
|
|
760
|
-
<details>
|
|
761
|
-
|
|
762
|
-
<summary>Interface GetMerklePathResult Details</summary>
|
|
763
|
-
|
|
764
742
|
###### Property error
|
|
765
743
|
|
|
766
744
|
The first exception error that occurred during processing, if any.
|
|
@@ -787,8 +765,6 @@ The name of the service returning the proof, or undefined if no proof
|
|
|
787
765
|
name?: string
|
|
788
766
|
```
|
|
789
767
|
|
|
790
|
-
</details>
|
|
791
|
-
|
|
792
768
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
793
769
|
|
|
794
770
|
---
|
|
@@ -807,10 +783,6 @@ export interface GetRawTxResult {
|
|
|
807
783
|
|
|
808
784
|
See also: [WalletError](#class-walleterror)
|
|
809
785
|
|
|
810
|
-
<details>
|
|
811
|
-
|
|
812
|
-
<summary>Interface GetRawTxResult Details</summary>
|
|
813
|
-
|
|
814
786
|
###### Property error
|
|
815
787
|
|
|
816
788
|
The first exception error that occurred during processing, if any.
|
|
@@ -845,8 +817,6 @@ Transaction hash or rawTx (and of initial request)
|
|
|
845
817
|
txid: string
|
|
846
818
|
```
|
|
847
819
|
|
|
848
|
-
</details>
|
|
849
|
-
|
|
850
820
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
851
821
|
|
|
852
822
|
---
|
|
@@ -890,10 +860,6 @@ export interface GetUtxoStatusDetails {
|
|
|
890
860
|
}
|
|
891
861
|
```
|
|
892
862
|
|
|
893
|
-
<details>
|
|
894
|
-
|
|
895
|
-
<summary>Interface GetUtxoStatusDetails Details</summary>
|
|
896
|
-
|
|
897
863
|
###### Property height
|
|
898
864
|
|
|
899
865
|
if isUtxo, the block height containing the matching unspent transaction output
|
|
@@ -934,8 +900,6 @@ typically there will be only one, but future orphans can result in multiple valu
|
|
|
934
900
|
txid?: string
|
|
935
901
|
```
|
|
936
902
|
|
|
937
|
-
</details>
|
|
938
|
-
|
|
939
903
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
940
904
|
|
|
941
905
|
---
|
|
@@ -953,10 +917,6 @@ export interface GetUtxoStatusResult {
|
|
|
953
917
|
|
|
954
918
|
See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails), [WalletError](#class-walleterror)
|
|
955
919
|
|
|
956
|
-
<details>
|
|
957
|
-
|
|
958
|
-
<summary>Interface GetUtxoStatusResult Details</summary>
|
|
959
|
-
|
|
960
920
|
###### Property details
|
|
961
921
|
|
|
962
922
|
Additional details about occurances of this output script as a utxo.
|
|
@@ -1003,8 +963,6 @@ name: string
|
|
|
1003
963
|
status: "success" | "error"
|
|
1004
964
|
```
|
|
1005
965
|
|
|
1006
|
-
</details>
|
|
1007
|
-
|
|
1008
966
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1009
967
|
|
|
1010
968
|
---
|
|
@@ -1038,10 +996,6 @@ export interface MonitorOptions {
|
|
|
1038
996
|
|
|
1039
997
|
See also: [Chain](#type-chain), [MonitorStorage](#type-monitorstorage), [Services](#class-services)
|
|
1040
998
|
|
|
1041
|
-
<details>
|
|
1042
|
-
|
|
1043
|
-
<summary>Interface MonitorOptions Details</summary>
|
|
1044
|
-
|
|
1045
999
|
###### Property msecsWaitPerMerkleProofServiceReq
|
|
1046
1000
|
|
|
1047
1001
|
How many msecs to wait after each getMerkleProof service request.
|
|
@@ -1050,8 +1004,6 @@ How many msecs to wait after each getMerkleProof service request.
|
|
|
1050
1004
|
msecsWaitPerMerkleProofServiceReq: number
|
|
1051
1005
|
```
|
|
1052
1006
|
|
|
1053
|
-
</details>
|
|
1054
|
-
|
|
1055
1007
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1056
1008
|
|
|
1057
1009
|
---
|
|
@@ -1066,10 +1018,6 @@ export interface OutPoint {
|
|
|
1066
1018
|
}
|
|
1067
1019
|
```
|
|
1068
1020
|
|
|
1069
|
-
<details>
|
|
1070
|
-
|
|
1071
|
-
<summary>Interface OutPoint Details</summary>
|
|
1072
|
-
|
|
1073
1021
|
###### Property txid
|
|
1074
1022
|
|
|
1075
1023
|
Transaction double sha256 hash as big endian hex string
|
|
@@ -1086,8 +1034,6 @@ zero based output index within the transaction
|
|
|
1086
1034
|
vout: number
|
|
1087
1035
|
```
|
|
1088
1036
|
|
|
1089
|
-
</details>
|
|
1090
|
-
|
|
1091
1037
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1092
1038
|
|
|
1093
1039
|
---
|
|
@@ -1162,10 +1108,6 @@ export interface PostBeefResultForTxidApi {
|
|
|
1162
1108
|
}
|
|
1163
1109
|
```
|
|
1164
1110
|
|
|
1165
|
-
<details>
|
|
1166
|
-
|
|
1167
|
-
<summary>Interface PostBeefResultForTxidApi Details</summary>
|
|
1168
|
-
|
|
1169
1111
|
###### Property alreadyKnown
|
|
1170
1112
|
|
|
1171
1113
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1184,8 +1126,6 @@ alreadyKnown?: boolean
|
|
|
1184
1126
|
status: "success" | "error"
|
|
1185
1127
|
```
|
|
1186
1128
|
|
|
1187
|
-
</details>
|
|
1188
|
-
|
|
1189
1129
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1190
1130
|
|
|
1191
1131
|
---
|
|
@@ -1238,10 +1178,6 @@ export interface PostTxResultForTxid {
|
|
|
1238
1178
|
}
|
|
1239
1179
|
```
|
|
1240
1180
|
|
|
1241
|
-
<details>
|
|
1242
|
-
|
|
1243
|
-
<summary>Interface PostTxResultForTxid Details</summary>
|
|
1244
|
-
|
|
1245
1181
|
###### Property alreadyKnown
|
|
1246
1182
|
|
|
1247
1183
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1260,8 +1196,6 @@ alreadyKnown?: boolean
|
|
|
1260
1196
|
status: "success" | "error"
|
|
1261
1197
|
```
|
|
1262
1198
|
|
|
1263
|
-
</details>
|
|
1264
|
-
|
|
1265
1199
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1266
1200
|
|
|
1267
1201
|
---
|
|
@@ -1281,10 +1215,6 @@ export interface PostTxsResult {
|
|
|
1281
1215
|
|
|
1282
1216
|
See also: [PostTxResultForTxid](#interface-posttxresultfortxid), [WalletError](#class-walleterror)
|
|
1283
1217
|
|
|
1284
|
-
<details>
|
|
1285
|
-
|
|
1286
|
-
<summary>Interface PostTxsResult Details</summary>
|
|
1287
|
-
|
|
1288
1218
|
###### Property data
|
|
1289
1219
|
|
|
1290
1220
|
Service response object. Use service name and status to infer type of object.
|
|
@@ -1310,8 +1240,6 @@ name: string
|
|
|
1310
1240
|
status: "success" | "error"
|
|
1311
1241
|
```
|
|
1312
1242
|
|
|
1313
|
-
</details>
|
|
1314
|
-
|
|
1315
1243
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1316
1244
|
|
|
1317
1245
|
---
|
|
@@ -1358,10 +1286,6 @@ export interface PurgeParams {
|
|
|
1358
1286
|
}
|
|
1359
1287
|
```
|
|
1360
1288
|
|
|
1361
|
-
<details>
|
|
1362
|
-
|
|
1363
|
-
<summary>Interface PurgeParams Details</summary>
|
|
1364
|
-
|
|
1365
1289
|
###### Property purgeCompletedAge
|
|
1366
1290
|
|
|
1367
1291
|
Minimum age in msecs for transient completed transaction data purge.
|
|
@@ -1389,8 +1313,6 @@ Default is 14 days.
|
|
|
1389
1313
|
purgeSpentAge?: number
|
|
1390
1314
|
```
|
|
1391
1315
|
|
|
1392
|
-
</details>
|
|
1393
|
-
|
|
1394
1316
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1395
1317
|
|
|
1396
1318
|
---
|
|
@@ -1423,10 +1345,6 @@ export interface RequestSyncChunkArgs {
|
|
|
1423
1345
|
}
|
|
1424
1346
|
```
|
|
1425
1347
|
|
|
1426
|
-
<details>
|
|
1427
|
-
|
|
1428
|
-
<summary>Interface RequestSyncChunkArgs Details</summary>
|
|
1429
|
-
|
|
1430
1348
|
###### Property fromStorageIdentityKey
|
|
1431
1349
|
|
|
1432
1350
|
The storageIdentityKey of the storage supplying the update SyncChunk data.
|
|
@@ -1505,8 +1423,6 @@ The storageIdentityKey of the storage consuming the update SyncChunk data.
|
|
|
1505
1423
|
toStorageIdentityKey: string
|
|
1506
1424
|
```
|
|
1507
1425
|
|
|
1508
|
-
</details>
|
|
1509
|
-
|
|
1510
1426
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1511
1427
|
|
|
1512
1428
|
---
|
|
@@ -1556,10 +1472,6 @@ export interface SetupEnv {
|
|
|
1556
1472
|
|
|
1557
1473
|
See also: [Chain](#type-chain)
|
|
1558
1474
|
|
|
1559
|
-
<details>
|
|
1560
|
-
|
|
1561
|
-
<summary>Interface SetupEnv Details</summary>
|
|
1562
|
-
|
|
1563
1475
|
###### Property chain
|
|
1564
1476
|
|
|
1565
1477
|
The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
|
|
@@ -1610,8 +1522,6 @@ A vaild TAAL API key for use by `Services`
|
|
|
1610
1522
|
taalApiKey: string
|
|
1611
1523
|
```
|
|
1612
1524
|
|
|
1613
|
-
</details>
|
|
1614
|
-
|
|
1615
1525
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1616
1526
|
|
|
1617
1527
|
---
|
|
@@ -1638,10 +1548,6 @@ export interface SetupWallet {
|
|
|
1638
1548
|
|
|
1639
1549
|
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
1640
1550
|
|
|
1641
|
-
<details>
|
|
1642
|
-
|
|
1643
|
-
<summary>Interface SetupWallet Details</summary>
|
|
1644
|
-
|
|
1645
1551
|
###### Property chain
|
|
1646
1552
|
|
|
1647
1553
|
The chain ('main' or 'test') which the wallet accesses.
|
|
@@ -1719,8 +1625,6 @@ wallet: Wallet
|
|
|
1719
1625
|
```
|
|
1720
1626
|
See also: [Wallet](#class-wallet)
|
|
1721
1627
|
|
|
1722
|
-
</details>
|
|
1723
|
-
|
|
1724
1628
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1725
1629
|
|
|
1726
1630
|
---
|
|
@@ -1748,10 +1652,6 @@ export interface SetupWalletArgs {
|
|
|
1748
1652
|
|
|
1749
1653
|
See also: [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
|
|
1750
1654
|
|
|
1751
|
-
<details>
|
|
1752
|
-
|
|
1753
|
-
<summary>Interface SetupWalletArgs Details</summary>
|
|
1754
|
-
|
|
1755
1655
|
###### Property active
|
|
1756
1656
|
|
|
1757
1657
|
Optional. Active wallet storage. Can be added later.
|
|
@@ -1797,8 +1697,6 @@ Defaults to `env.devKeys[env.identityKey]
|
|
|
1797
1697
|
rootKeyHex?: string
|
|
1798
1698
|
```
|
|
1799
1699
|
|
|
1800
|
-
</details>
|
|
1801
|
-
|
|
1802
1700
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1803
1701
|
|
|
1804
1702
|
---
|
|
@@ -1814,10 +1712,6 @@ export interface SetupWalletClient extends SetupWallet {
|
|
|
1814
1712
|
|
|
1815
1713
|
See also: [SetupWallet](#interface-setupwallet)
|
|
1816
1714
|
|
|
1817
|
-
<details>
|
|
1818
|
-
|
|
1819
|
-
<summary>Interface SetupWalletClient Details</summary>
|
|
1820
|
-
|
|
1821
1715
|
###### Property endpointUrl
|
|
1822
1716
|
|
|
1823
1717
|
The endpoint URL of the service hosting the `StorageServer` JSON-RPC service to
|
|
@@ -1828,8 +1722,6 @@ the active storage provider of the wallet.
|
|
|
1828
1722
|
endpointUrl: string
|
|
1829
1723
|
```
|
|
1830
1724
|
|
|
1831
|
-
</details>
|
|
1832
|
-
|
|
1833
1725
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1834
1726
|
|
|
1835
1727
|
---
|
|
@@ -1846,10 +1738,6 @@ export interface SetupWalletClientArgs extends SetupWalletArgs {
|
|
|
1846
1738
|
|
|
1847
1739
|
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
1848
1740
|
|
|
1849
|
-
<details>
|
|
1850
|
-
|
|
1851
|
-
<summary>Interface SetupWalletClientArgs Details</summary>
|
|
1852
|
-
|
|
1853
1741
|
###### Property endpointUrl
|
|
1854
1742
|
|
|
1855
1743
|
The endpoint URL of a service hosting the `StorageServer` JSON-RPC service to
|
|
@@ -1860,8 +1748,6 @@ the active storage provider of the newly created wallet.
|
|
|
1860
1748
|
endpointUrl?: string
|
|
1861
1749
|
```
|
|
1862
1750
|
|
|
1863
|
-
</details>
|
|
1864
|
-
|
|
1865
1751
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1866
1752
|
|
|
1867
1753
|
---
|
|
@@ -1936,10 +1822,6 @@ export interface StorageFeeModel {
|
|
|
1936
1822
|
}
|
|
1937
1823
|
```
|
|
1938
1824
|
|
|
1939
|
-
<details>
|
|
1940
|
-
|
|
1941
|
-
<summary>Interface StorageFeeModel Details</summary>
|
|
1942
|
-
|
|
1943
1825
|
###### Property model
|
|
1944
1826
|
|
|
1945
1827
|
Available models. Currently only "sat/kb" is supported.
|
|
@@ -1959,8 +1841,6 @@ If undefined, the default value is used.
|
|
|
1959
1841
|
value?: number
|
|
1960
1842
|
```
|
|
1961
1843
|
|
|
1962
|
-
</details>
|
|
1963
|
-
|
|
1964
1844
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1965
1845
|
|
|
1966
1846
|
---
|
|
@@ -1978,10 +1858,6 @@ export interface StorageGetBeefOptions {
|
|
|
1978
1858
|
}
|
|
1979
1859
|
```
|
|
1980
1860
|
|
|
1981
|
-
<details>
|
|
1982
|
-
|
|
1983
|
-
<summary>Interface StorageGetBeefOptions Details</summary>
|
|
1984
|
-
|
|
1985
1861
|
###### Property ignoreNewProven
|
|
1986
1862
|
|
|
1987
1863
|
optional. Default is false. If true, raw transactions with proofs missing from `storage` and obtained from `getServices` are not inserted to `storage`.
|
|
@@ -2038,8 +1914,6 @@ if 'known', txids known to local storage as valid are included as txidOnly
|
|
|
2038
1914
|
trustSelf?: "known"
|
|
2039
1915
|
```
|
|
2040
1916
|
|
|
2041
|
-
</details>
|
|
2042
|
-
|
|
2043
1917
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2044
1918
|
|
|
2045
1919
|
---
|
|
@@ -2052,10 +1926,6 @@ export interface StorageIdentity {
|
|
|
2052
1926
|
}
|
|
2053
1927
|
```
|
|
2054
1928
|
|
|
2055
|
-
<details>
|
|
2056
|
-
|
|
2057
|
-
<summary>Interface StorageIdentity Details</summary>
|
|
2058
|
-
|
|
2059
1929
|
###### Property storageIdentityKey
|
|
2060
1930
|
|
|
2061
1931
|
The identity key (public key) assigned to this storage
|
|
@@ -2072,8 +1942,6 @@ The human readable name assigned to this storage.
|
|
|
2072
1942
|
storageName: string
|
|
2073
1943
|
```
|
|
2074
1944
|
|
|
2075
|
-
</details>
|
|
2076
|
-
|
|
2077
1945
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2078
1946
|
|
|
2079
1947
|
---
|
|
@@ -2087,10 +1955,6 @@ export interface StorageInternalizeActionResult extends InternalizeActionResult
|
|
|
2087
1955
|
}
|
|
2088
1956
|
```
|
|
2089
1957
|
|
|
2090
|
-
<details>
|
|
2091
|
-
|
|
2092
|
-
<summary>Interface StorageInternalizeActionResult Details</summary>
|
|
2093
|
-
|
|
2094
1958
|
###### Property isMerge
|
|
2095
1959
|
|
|
2096
1960
|
true if internalizing outputs on an existing storage transaction
|
|
@@ -2115,8 +1979,6 @@ txid of transaction being internalized
|
|
|
2115
1979
|
txid: string
|
|
2116
1980
|
```
|
|
2117
1981
|
|
|
2118
|
-
</details>
|
|
2119
|
-
|
|
2120
1982
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2121
1983
|
|
|
2122
1984
|
---
|
|
@@ -2176,10 +2038,6 @@ export interface StorageProviderOptions extends StorageReaderWriterOptions {
|
|
|
2176
2038
|
|
|
2177
2039
|
See also: [Chain](#type-chain), [StorageFeeModel](#interface-storagefeemodel), [StorageReaderWriterOptions](#interface-storagereaderwriteroptions)
|
|
2178
2040
|
|
|
2179
|
-
<details>
|
|
2180
|
-
|
|
2181
|
-
<summary>Interface StorageProviderOptions Details</summary>
|
|
2182
|
-
|
|
2183
2041
|
###### Property commissionPubKeyHex
|
|
2184
2042
|
|
|
2185
2043
|
If commissionSatoshis is greater than zero, must be a valid public key hex string.
|
|
@@ -2199,8 +2057,6 @@ A value of zero disables commission fees.
|
|
|
2199
2057
|
commissionSatoshis: number
|
|
2200
2058
|
```
|
|
2201
2059
|
|
|
2202
|
-
</details>
|
|
2203
|
-
|
|
2204
2060
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2205
2061
|
|
|
2206
2062
|
---
|
|
@@ -2579,10 +2435,6 @@ export interface ValidAcquireDirectCertificateArgs extends ValidWalletSignerArgs
|
|
|
2579
2435
|
|
|
2580
2436
|
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2581
2437
|
|
|
2582
|
-
<details>
|
|
2583
|
-
|
|
2584
|
-
<summary>Interface ValidAcquireDirectCertificateArgs Details</summary>
|
|
2585
|
-
|
|
2586
2438
|
###### Property subject
|
|
2587
2439
|
|
|
2588
2440
|
validated to an empty string, must be provided by wallet and must
|
|
@@ -2592,8 +2444,6 @@ match expectations of keyringForSubject
|
|
|
2592
2444
|
subject: PubKeyHex
|
|
2593
2445
|
```
|
|
2594
2446
|
|
|
2595
|
-
</details>
|
|
2596
|
-
|
|
2597
2447
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2598
2448
|
|
|
2599
2449
|
---
|
|
@@ -2613,10 +2463,6 @@ export interface ValidAcquireIssuanceCertificateArgs extends ValidWalletSignerAr
|
|
|
2613
2463
|
|
|
2614
2464
|
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2615
2465
|
|
|
2616
|
-
<details>
|
|
2617
|
-
|
|
2618
|
-
<summary>Interface ValidAcquireIssuanceCertificateArgs Details</summary>
|
|
2619
|
-
|
|
2620
2466
|
###### Property subject
|
|
2621
2467
|
|
|
2622
2468
|
validated to an empty string, must be provided by wallet and must
|
|
@@ -2626,8 +2472,6 @@ match expectations of keyringForSubject
|
|
|
2626
2472
|
subject: PubKeyHex
|
|
2627
2473
|
```
|
|
2628
2474
|
|
|
2629
|
-
</details>
|
|
2630
|
-
|
|
2631
2475
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2632
2476
|
|
|
2633
2477
|
---
|
|
@@ -3032,10 +2876,6 @@ export interface WalletServices {
|
|
|
3032
2876
|
|
|
3033
2877
|
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [GetMerklePathResult](#interface-getmerklepathresult), [GetRawTxResult](#interface-getrawtxresult), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult), [PostBeefResult](#interface-postbeefresult), [PostTxsResult](#interface-posttxsresult)
|
|
3034
2878
|
|
|
3035
|
-
<details>
|
|
3036
|
-
|
|
3037
|
-
<summary>Interface WalletServices Details</summary>
|
|
3038
|
-
|
|
3039
2879
|
###### Property chain
|
|
3040
2880
|
|
|
3041
2881
|
The chain being serviced.
|
|
@@ -3210,8 +3050,6 @@ Argument Details
|
|
|
3210
3050
|
+ **txOrLockTime**
|
|
3211
3051
|
+ either a bitcoin locktime value or hex, binary, un-encoded Transaction
|
|
3212
3052
|
|
|
3213
|
-
</details>
|
|
3214
|
-
|
|
3215
3053
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3216
3054
|
|
|
3217
3055
|
---
|
|
@@ -3294,10 +3132,6 @@ export interface WalletStorage {
|
|
|
3294
3132
|
|
|
3295
3133
|
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [WalletServices](#interface-walletservices), [createAction](#function-createaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
3296
3134
|
|
|
3297
|
-
<details>
|
|
3298
|
-
|
|
3299
|
-
<summary>Interface WalletStorage Details</summary>
|
|
3300
|
-
|
|
3301
3135
|
###### Method isStorageProvider
|
|
3302
3136
|
|
|
3303
3137
|
```ts
|
|
@@ -3308,8 +3142,6 @@ Returns
|
|
|
3308
3142
|
|
|
3309
3143
|
false
|
|
3310
3144
|
|
|
3311
|
-
</details>
|
|
3312
|
-
|
|
3313
3145
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3314
3146
|
|
|
3315
3147
|
---
|
|
@@ -3327,10 +3159,6 @@ export interface WalletStorageProvider extends WalletStorageSync {
|
|
|
3327
3159
|
|
|
3328
3160
|
See also: [WalletServices](#interface-walletservices), [WalletStorageSync](#interface-walletstoragesync)
|
|
3329
3161
|
|
|
3330
|
-
<details>
|
|
3331
|
-
|
|
3332
|
-
<summary>Interface WalletStorageProvider Details</summary>
|
|
3333
|
-
|
|
3334
3162
|
###### Method isStorageProvider
|
|
3335
3163
|
|
|
3336
3164
|
```ts
|
|
@@ -3341,8 +3169,6 @@ Returns
|
|
|
3341
3169
|
|
|
3342
3170
|
true if this object's interface can be extended to the full `StorageProvider` interface
|
|
3343
3171
|
|
|
3344
|
-
</details>
|
|
3345
|
-
|
|
3346
3172
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3347
3173
|
|
|
3348
3174
|
---
|
|
@@ -3497,10 +3323,6 @@ export class CertOps extends BsvCertificate {
|
|
|
3497
3323
|
|
|
3498
3324
|
See also: [CertOpsWallet](#interface-certopswallet)
|
|
3499
3325
|
|
|
3500
|
-
<details>
|
|
3501
|
-
|
|
3502
|
-
<summary>Class CertOps Details</summary>
|
|
3503
|
-
|
|
3504
3326
|
###### Method createKeyringForVerifier
|
|
3505
3327
|
|
|
3506
3328
|
Creates a verifiable certificate structure for a specific verifier, allowing them access to specified fields.
|
|
@@ -3538,8 +3360,6 @@ update the signature using the certifier's private key.
|
|
|
3538
3360
|
async encryptAndSignNewCertificate(): Promise<void>
|
|
3539
3361
|
```
|
|
3540
3362
|
|
|
3541
|
-
</details>
|
|
3542
|
-
|
|
3543
3363
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3544
3364
|
|
|
3545
3365
|
---
|
|
@@ -3594,10 +3414,6 @@ export class Monitor {
|
|
|
3594
3414
|
|
|
3595
3415
|
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorOptions](#interface-monitoroptions), [MonitorStorage](#type-monitorstorage), [Services](#class-services), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
3596
3416
|
|
|
3597
|
-
<details>
|
|
3598
|
-
|
|
3599
|
-
<summary>Class Monitor Details</summary>
|
|
3600
|
-
|
|
3601
3417
|
###### Property _otherTasks
|
|
3602
3418
|
|
|
3603
3419
|
_otherTasks can be run by runTask but not by scheduler.
|
|
@@ -3661,8 +3477,6 @@ processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader): void
|
|
|
3661
3477
|
```
|
|
3662
3478
|
See also: [BlockHeader](#interface-blockheader)
|
|
3663
3479
|
|
|
3664
|
-
</details>
|
|
3665
|
-
|
|
3666
3480
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3667
3481
|
|
|
3668
3482
|
---
|
|
@@ -3697,10 +3511,6 @@ export class PrivilegedKeyManager implements ProtoWallet {
|
|
|
3697
3511
|
}
|
|
3698
3512
|
```
|
|
3699
3513
|
|
|
3700
|
-
<details>
|
|
3701
|
-
|
|
3702
|
-
<summary>Class PrivilegedKeyManager Details</summary>
|
|
3703
|
-
|
|
3704
3514
|
###### Constructor
|
|
3705
3515
|
|
|
3706
3516
|
```ts
|
|
@@ -3724,8 +3534,6 @@ properties to further confuse an attacker.
|
|
|
3724
3534
|
destroyKey(): void
|
|
3725
3535
|
```
|
|
3726
3536
|
|
|
3727
|
-
</details>
|
|
3728
|
-
|
|
3729
3537
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3730
3538
|
|
|
3731
3539
|
---
|
|
@@ -3751,10 +3559,6 @@ export class ScriptTemplateSABPPP implements ScriptTemplate {
|
|
|
3751
3559
|
|
|
3752
3560
|
See also: [ScriptTemplateParamsSABPPP](#interface-scripttemplateparamssabppp)
|
|
3753
3561
|
|
|
3754
|
-
<details>
|
|
3755
|
-
|
|
3756
|
-
<summary>Class ScriptTemplateSABPPP Details</summary>
|
|
3757
|
-
|
|
3758
3562
|
###### Property unlockLength
|
|
3759
3563
|
|
|
3760
3564
|
P2PKH unlock estimateLength is a constant
|
|
@@ -3763,8 +3567,6 @@ P2PKH unlock estimateLength is a constant
|
|
|
3763
3567
|
unlockLength = 108
|
|
3764
3568
|
```
|
|
3765
3569
|
|
|
3766
|
-
</details>
|
|
3767
|
-
|
|
3768
3570
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3769
3571
|
|
|
3770
3572
|
---
|
|
@@ -3839,10 +3641,6 @@ export class Services implements sdk.WalletServices {
|
|
|
3839
3641
|
|
|
3840
3642
|
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [FiatExchangeRates](#interface-fiatexchangerates), [GetMerklePathResult](#interface-getmerklepathresult), [GetMerklePathService](#type-getmerklepathservice), [GetRawTxResult](#interface-getrawtxresult), [GetRawTxService](#type-getrawtxservice), [GetUtxoStatusOutputFormat](#type-getutxostatusoutputformat), [GetUtxoStatusResult](#interface-getutxostatusresult), [GetUtxoStatusService](#type-getutxostatusservice), [PostBeefResult](#interface-postbeefresult), [PostBeefService](#type-postbeefservice), [PostTxsResult](#interface-posttxsresult), [PostTxsService](#type-posttxsservice), [ServiceCollection](#class-servicecollection), [UpdateFiatExchangeRateService](#type-updatefiatexchangerateservice), [WalletServices](#interface-walletservices), [WalletServicesOptions](#interface-walletservicesoptions)
|
|
3841
3643
|
|
|
3842
|
-
<details>
|
|
3843
|
-
|
|
3844
|
-
<summary>Class Services Details</summary>
|
|
3845
|
-
|
|
3846
3644
|
###### Method postTxs
|
|
3847
3645
|
|
|
3848
3646
|
The beef must contain at least each rawTx for each txid.
|
|
@@ -3854,8 +3652,6 @@ async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
|
3854
3652
|
```
|
|
3855
3653
|
See also: [PostTxsResult](#interface-posttxsresult)
|
|
3856
3654
|
|
|
3857
|
-
</details>
|
|
3858
|
-
|
|
3859
3655
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3860
3656
|
|
|
3861
3657
|
---
|
|
@@ -3967,10 +3763,6 @@ export abstract class SetupClient {
|
|
|
3967
3763
|
|
|
3968
3764
|
See also: [Chain](#type-chain), [KeyPairAddress](#type-keypairaddress), [Monitor](#class-monitor), [PrivilegedKeyManager](#class-privilegedkeymanager), [ScriptTemplateUnlock](#interface-scripttemplateunlock), [Services](#class-services), [SetupEnv](#interface-setupenv), [SetupWallet](#interface-setupwallet), [SetupWalletArgs](#interface-setupwalletargs), [SetupWalletClient](#interface-setupwalletclient), [SetupWalletClientArgs](#interface-setupwalletclientargs), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
3969
3765
|
|
|
3970
|
-
<details>
|
|
3971
|
-
|
|
3972
|
-
<summary>Class SetupClient Details</summary>
|
|
3973
|
-
|
|
3974
3766
|
###### Method createWallet
|
|
3975
3767
|
|
|
3976
3768
|
Create a `Wallet`. Storage can optionally be provided or configured later.
|
|
@@ -4057,8 +3849,6 @@ Private keys should never be included directly in your source code.
|
|
|
4057
3849
|
static makeEnv(): string
|
|
4058
3850
|
```
|
|
4059
3851
|
|
|
4060
|
-
</details>
|
|
4061
|
-
|
|
4062
3852
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4063
3853
|
|
|
4064
3854
|
---
|
|
@@ -4174,10 +3964,6 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
|
|
|
4174
3964
|
|
|
4175
3965
|
See also: [AuthId](#interface-authid), [Chain](#type-chain), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [GetReqsAndBeefResult](#interface-getreqsandbeefresult), [PostReqsToNetworkResult](#interface-postreqstonetworkresult), [ProcessSyncChunkResult](#interface-processsyncchunkresult), [ProvenOrRawTx](#interface-provenorrawtx), [PurgeParams](#interface-purgeparams), [PurgeResults](#interface-purgeresults), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageFeeModel](#interface-storagefeemodel), [StorageGetBeefOptions](#interface-storagegetbeefoptions), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [StorageProvenOrReq](#interface-storageprovenorreq), [StorageProviderOptions](#interface-storageprovideroptions), [StorageReaderWriter](#class-storagereaderwriter), [SyncChunk](#interface-syncchunk), [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken), [UpdateProvenTxReqWithNewProvenTxArgs](#interface-updateproventxreqwithnewproventxargs), [UpdateProvenTxReqWithNewProvenTxResult](#interface-updateproventxreqwithnewproventxresult), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [WalletStorageProvider](#interface-walletstorageprovider), [attemptToPostReqsToNetwork](#function-attempttopostreqstonetwork), [createAction](#function-createaction), [getBeefForTransaction](#function-getbeeffortransaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
4176
3966
|
|
|
4177
|
-
<details>
|
|
4178
|
-
|
|
4179
|
-
<summary>Class StorageProvider Details</summary>
|
|
4180
|
-
|
|
4181
3967
|
###### Method confirmSpendableOutputs
|
|
4182
3968
|
|
|
4183
3969
|
For each spendable output in the 'default' basket of the authenticated user,
|
|
@@ -4250,8 +4036,6 @@ async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: num
|
|
|
4250
4036
|
```
|
|
4251
4037
|
See also: [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken)
|
|
4252
4038
|
|
|
4253
|
-
</details>
|
|
4254
|
-
|
|
4255
4039
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4256
4040
|
|
|
4257
4041
|
---
|
|
@@ -4320,10 +4104,6 @@ export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
|
4320
4104
|
|
|
4321
4105
|
See also: [Chain](#type-chain), [DBType](#type-dbtype), [FindCertificateFieldsArgs](#interface-findcertificatefieldsargs), [FindCertificatesArgs](#interface-findcertificatesargs), [FindCommissionsArgs](#interface-findcommissionsargs), [FindForUserSincePagedArgs](#interface-findforusersincepagedargs), [FindMonitorEventsArgs](#interface-findmonitoreventsargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputTagsArgs](#interface-findoutputtagsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindSyncStatesArgs](#interface-findsyncstatesargs), [FindTransactionsArgs](#interface-findtransactionsargs), [FindTxLabelsArgs](#interface-findtxlabelsargs), [FindUsersArgs](#interface-findusersargs), [RequestSyncChunkArgs](#interface-requestsyncchunkargs), [StorageReaderOptions](#interface-storagereaderoptions), [StorageSyncReader](#class-storagesyncreader), [SyncChunk](#interface-syncchunk), [TrxToken](#interface-trxtoken), [getSyncChunk](#function-getsyncchunk)
|
|
4322
4106
|
|
|
4323
|
-
<details>
|
|
4324
|
-
|
|
4325
|
-
<summary>Class StorageReader Details</summary>
|
|
4326
|
-
|
|
4327
4107
|
###### Method validateEntityDate
|
|
4328
4108
|
|
|
4329
4109
|
Force dates to strings on SQLite and Date objects on MySQL
|
|
@@ -4343,8 +4123,6 @@ Argument Details
|
|
|
4343
4123
|
+ **useNowAsDefault**
|
|
4344
4124
|
+ if true and date is null or undefiend, set to current time.
|
|
4345
4125
|
|
|
4346
|
-
</details>
|
|
4347
|
-
|
|
4348
4126
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4349
4127
|
|
|
4350
4128
|
---
|
|
@@ -4509,10 +4287,6 @@ export class TaskCheckForProofs extends WalletMonitorTask {
|
|
|
4509
4287
|
|
|
4510
4288
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4511
4289
|
|
|
4512
|
-
<details>
|
|
4513
|
-
|
|
4514
|
-
<summary>Class TaskCheckForProofs Details</summary>
|
|
4515
|
-
|
|
4516
4290
|
###### Property checkNow
|
|
4517
4291
|
|
|
4518
4292
|
An external service such as the chaintracks new block header
|
|
@@ -4557,8 +4331,6 @@ trigger(nowMsecsSinceEpoch: number): {
|
|
|
4557
4331
|
}
|
|
4558
4332
|
```
|
|
4559
4333
|
|
|
4560
|
-
</details>
|
|
4561
|
-
|
|
4562
4334
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4563
4335
|
|
|
4564
4336
|
---
|
|
@@ -4643,10 +4415,6 @@ export class TaskPurge extends WalletMonitorTask {
|
|
|
4643
4415
|
|
|
4644
4416
|
See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
4645
4417
|
|
|
4646
|
-
<details>
|
|
4647
|
-
|
|
4648
|
-
<summary>Class TaskPurge Details</summary>
|
|
4649
|
-
|
|
4650
4418
|
###### Property checkNow
|
|
4651
4419
|
|
|
4652
4420
|
Set to true to trigger running this task
|
|
@@ -4655,8 +4423,6 @@ Set to true to trigger running this task
|
|
|
4655
4423
|
static checkNow = false
|
|
4656
4424
|
```
|
|
4657
4425
|
|
|
4658
|
-
</details>
|
|
4659
|
-
|
|
4660
4426
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4661
4427
|
|
|
4662
4428
|
---
|
|
@@ -4684,10 +4450,6 @@ export class TaskReviewStatus extends WalletMonitorTask {
|
|
|
4684
4450
|
|
|
4685
4451
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4686
4452
|
|
|
4687
|
-
<details>
|
|
4688
|
-
|
|
4689
|
-
<summary>Class TaskReviewStatus Details</summary>
|
|
4690
|
-
|
|
4691
4453
|
###### Property checkNow
|
|
4692
4454
|
|
|
4693
4455
|
Set to true to trigger running this task
|
|
@@ -4696,8 +4458,6 @@ Set to true to trigger running this task
|
|
|
4696
4458
|
static checkNow = false
|
|
4697
4459
|
```
|
|
4698
4460
|
|
|
4699
|
-
</details>
|
|
4700
|
-
|
|
4701
4461
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4702
4462
|
|
|
4703
4463
|
---
|
|
@@ -4717,10 +4477,6 @@ export class TaskSendWaiting extends WalletMonitorTask {
|
|
|
4717
4477
|
|
|
4718
4478
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4719
4479
|
|
|
4720
|
-
<details>
|
|
4721
|
-
|
|
4722
|
-
<summary>Class TaskSendWaiting Details</summary>
|
|
4723
|
-
|
|
4724
4480
|
###### Method processUnsent
|
|
4725
4481
|
|
|
4726
4482
|
Process an array of 'unsent' status table.ProvenTxReq
|
|
@@ -4741,8 +4497,6 @@ Increments attempts if sending was attempted.
|
|
|
4741
4497
|
async processUnsent(reqApis: table.ProvenTxReq[], indent = 0): Promise<string>
|
|
4742
4498
|
```
|
|
4743
4499
|
|
|
4744
|
-
</details>
|
|
4745
|
-
|
|
4746
4500
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4747
4501
|
|
|
4748
4502
|
---
|
|
@@ -4794,10 +4548,6 @@ export class WERR_INSUFFICIENT_FUNDS extends WalletError {
|
|
|
4794
4548
|
|
|
4795
4549
|
See also: [WalletError](#class-walleterror)
|
|
4796
4550
|
|
|
4797
|
-
<details>
|
|
4798
|
-
|
|
4799
|
-
<summary>Class WERR_INSUFFICIENT_FUNDS Details</summary>
|
|
4800
|
-
|
|
4801
4551
|
###### Constructor
|
|
4802
4552
|
|
|
4803
4553
|
```ts
|
|
@@ -4811,8 +4561,6 @@ Argument Details
|
|
|
4811
4561
|
+ **moreSatoshisNeeded**
|
|
4812
4562
|
+ Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
|
|
4813
4563
|
|
|
4814
|
-
</details>
|
|
4815
|
-
|
|
4816
4564
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4817
4565
|
|
|
4818
4566
|
---
|
|
@@ -4877,10 +4625,6 @@ export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
|
4877
4625
|
|
|
4878
4626
|
See also: [WalletError](#class-walleterror)
|
|
4879
4627
|
|
|
4880
|
-
<details>
|
|
4881
|
-
|
|
4882
|
-
<summary>Class WERR_INVALID_PUBLIC_KEY Details</summary>
|
|
4883
|
-
|
|
4884
4628
|
###### Constructor
|
|
4885
4629
|
|
|
4886
4630
|
```ts
|
|
@@ -4894,8 +4638,6 @@ Argument Details
|
|
|
4894
4638
|
+ **environment**
|
|
4895
4639
|
+ Optional environment flag to control whether the key is included in the message.
|
|
4896
4640
|
|
|
4897
|
-
</details>
|
|
4898
|
-
|
|
4899
4641
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4900
4642
|
|
|
4901
4643
|
---
|
|
@@ -5034,10 +4776,6 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
5034
4776
|
|
|
5035
4777
|
See also: [Chain](#type-chain), [KeyPair](#interface-keypair), [Monitor](#class-monitor), [PendingSignAction](#interface-pendingsignaction), [PrivilegedKeyManager](#class-privilegedkeymanager), [StorageIdentity](#interface-storageidentity), [WalletArgs](#interface-walletargs), [WalletServices](#interface-walletservices), [WalletSigner](#class-walletsigner), [WalletStorageManager](#class-walletstoragemanager), [createAction](#function-createaction), [getIdentityKey](#function-getidentitykey), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [proveCertificate](#function-provecertificate), [signAction](#function-signaction)
|
|
5036
4778
|
|
|
5037
|
-
<details>
|
|
5038
|
-
|
|
5039
|
-
<summary>Class Wallet Details</summary>
|
|
5040
|
-
|
|
5041
4779
|
###### Property beef
|
|
5042
4780
|
|
|
5043
4781
|
The wallet creates a `BeefParty` when it is created.
|
|
@@ -5076,8 +4814,6 @@ Argument Details
|
|
|
5076
4814
|
+ **newKnownTxids**
|
|
5077
4815
|
+ Optional. Additional new txids known to be valid by the caller to be merged.
|
|
5078
4816
|
|
|
5079
|
-
</details>
|
|
5080
|
-
|
|
5081
4817
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5082
4818
|
|
|
5083
4819
|
---
|
|
@@ -5113,10 +4849,6 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
5113
4849
|
}
|
|
5114
4850
|
```
|
|
5115
4851
|
|
|
5116
|
-
<details>
|
|
5117
|
-
|
|
5118
|
-
<summary>Class WalletError Details</summary>
|
|
5119
|
-
|
|
5120
4852
|
###### Method asStatus
|
|
5121
4853
|
|
|
5122
4854
|
```ts
|
|
@@ -5140,8 +4872,6 @@ static fromUnknown(err: unknown): WalletError
|
|
|
5140
4872
|
```
|
|
5141
4873
|
See also: [WalletError](#class-walleterror)
|
|
5142
4874
|
|
|
5143
|
-
</details>
|
|
5144
|
-
|
|
5145
4875
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5146
4876
|
|
|
5147
4877
|
---
|
|
@@ -5176,10 +4906,6 @@ export abstract class WalletMonitorTask {
|
|
|
5176
4906
|
|
|
5177
4907
|
See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
|
|
5178
4908
|
|
|
5179
|
-
<details>
|
|
5180
|
-
|
|
5181
|
-
<summary>Class WalletMonitorTask Details</summary>
|
|
5182
|
-
|
|
5183
4909
|
###### Property lastRunMsecsSinceEpoch
|
|
5184
4910
|
|
|
5185
4911
|
Set by monitor each time runTask completes
|
|
@@ -5208,8 +4934,6 @@ abstract trigger(nowMsecsSinceEpoch: number): {
|
|
|
5208
4934
|
}
|
|
5209
4935
|
```
|
|
5210
4936
|
|
|
5211
|
-
</details>
|
|
5212
|
-
|
|
5213
4937
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5214
4938
|
|
|
5215
4939
|
---
|
|
@@ -5309,10 +5033,6 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
5309
5033
|
|
|
5310
5034
|
See also: [AuthId](#interface-authid), [FindCertificatesArgs](#interface-findcertificatesargs), [FindOutputBasketsArgs](#interface-findoutputbasketsargs), [FindOutputsArgs](#interface-findoutputsargs), [FindProvenTxReqsArgs](#interface-findproventxreqsargs), [StorageCreateActionResult](#interface-storagecreateactionresult), [StorageProcessActionArgs](#interface-storageprocessactionargs), [StorageProcessActionResults](#interface-storageprocessactionresults), [StorageProvider](#class-storageprovider), [StorageSyncReader](#class-storagesyncreader), [ValidCreateActionArgs](#interface-validcreateactionargs), [ValidListActionsArgs](#interface-validlistactionsargs), [ValidListCertificatesArgs](#interface-validlistcertificatesargs), [ValidListOutputsArgs](#interface-validlistoutputsargs), [WalletServices](#interface-walletservices), [WalletStorage](#interface-walletstorage), [WalletStorageProvider](#interface-walletstorageprovider), [WalletStorageReader](#interface-walletstoragereader), [WalletStorageSync](#interface-walletstoragesync), [WalletStorageWriter](#interface-walletstoragewriter), [createAction](#function-createaction), [internalizeAction](#function-internalizeaction), [listCertificates](#function-listcertificates), [processAction](#function-processaction)
|
|
5311
5035
|
|
|
5312
|
-
<details>
|
|
5313
|
-
|
|
5314
|
-
<summary>Class WalletStorageManager Details</summary>
|
|
5315
|
-
|
|
5316
5036
|
###### Property _isSingleWriter
|
|
5317
5037
|
|
|
5318
5038
|
if true, allow only a single writer to proceed at a time.
|
|
@@ -5377,8 +5097,6 @@ Argument Details
|
|
|
5377
5097
|
+ **storageIdentityKey**
|
|
5378
5098
|
+ of current backup storage provider that is to become the new active provider.
|
|
5379
5099
|
|
|
5380
|
-
</details>
|
|
5381
|
-
|
|
5382
5100
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5383
5101
|
|
|
5384
5102
|
---
|
|
@@ -5466,17 +5184,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5466
5184
|
export function asBsvSdkPrivateKey(privKey: string): PrivateKey
|
|
5467
5185
|
```
|
|
5468
5186
|
|
|
5469
|
-
<details>
|
|
5470
|
-
|
|
5471
|
-
<summary>Function asBsvSdkPrivateKey Details</summary>
|
|
5472
|
-
|
|
5473
5187
|
Argument Details
|
|
5474
5188
|
|
|
5475
5189
|
+ **privKey**
|
|
5476
5190
|
+ bitcoin private key in 32 byte hex string form
|
|
5477
5191
|
|
|
5478
|
-
</details>
|
|
5479
|
-
|
|
5480
5192
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5481
5193
|
|
|
5482
5194
|
---
|
|
@@ -5486,17 +5198,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5486
5198
|
export function asBsvSdkPublickKey(pubKey: string): PublicKey
|
|
5487
5199
|
```
|
|
5488
5200
|
|
|
5489
|
-
<details>
|
|
5490
|
-
|
|
5491
|
-
<summary>Function asBsvSdkPublickKey Details</summary>
|
|
5492
|
-
|
|
5493
5201
|
Argument Details
|
|
5494
5202
|
|
|
5495
5203
|
+ **pubKey**
|
|
5496
5204
|
+ bitcoin public key in standard compressed key hex string form
|
|
5497
5205
|
|
|
5498
|
-
</details>
|
|
5499
|
-
|
|
5500
5206
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5501
5207
|
|
|
5502
5208
|
---
|
|
@@ -5552,10 +5258,6 @@ export function asString(val: string | number[]): string {
|
|
|
5552
5258
|
}
|
|
5553
5259
|
```
|
|
5554
5260
|
|
|
5555
|
-
<details>
|
|
5556
|
-
|
|
5557
|
-
<summary>Function asString Details</summary>
|
|
5558
|
-
|
|
5559
5261
|
Returns
|
|
5560
5262
|
|
|
5561
5263
|
input val if it is a string; or if number[], converts byte values to hex
|
|
@@ -5565,8 +5267,6 @@ Argument Details
|
|
|
5565
5267
|
+ **val**
|
|
5566
5268
|
+ string or number[]. If string, encoding must be hex. If number[], each value must be 0..255.
|
|
5567
5269
|
|
|
5568
|
-
</details>
|
|
5569
|
-
|
|
5570
5270
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5571
5271
|
|
|
5572
5272
|
---
|
|
@@ -5674,10 +5374,6 @@ export function doubleSha256BE(data: number[]): number[] {
|
|
|
5674
5374
|
|
|
5675
5375
|
See also: [doubleSha256HashLE](#function-doublesha256hashle)
|
|
5676
5376
|
|
|
5677
|
-
<details>
|
|
5678
|
-
|
|
5679
|
-
<summary>Function doubleSha256BE Details</summary>
|
|
5680
|
-
|
|
5681
5377
|
Returns
|
|
5682
5378
|
|
|
5683
5379
|
reversed (big-endian) double sha256 hash of data, byte 31 of hash first.
|
|
@@ -5687,8 +5383,6 @@ Argument Details
|
|
|
5687
5383
|
+ **data**
|
|
5688
5384
|
+ is an array of bytes.
|
|
5689
5385
|
|
|
5690
|
-
</details>
|
|
5691
|
-
|
|
5692
5386
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5693
5387
|
|
|
5694
5388
|
---
|
|
@@ -5704,10 +5398,6 @@ export function doubleSha256HashLE(data: number[]): number[] {
|
|
|
5704
5398
|
}
|
|
5705
5399
|
```
|
|
5706
5400
|
|
|
5707
|
-
<details>
|
|
5708
|
-
|
|
5709
|
-
<summary>Function doubleSha256HashLE Details</summary>
|
|
5710
|
-
|
|
5711
5401
|
Returns
|
|
5712
5402
|
|
|
5713
5403
|
double sha256 hash of data, byte 0 of hash first.
|
|
@@ -5717,8 +5407,6 @@ Argument Details
|
|
|
5717
5407
|
+ **data**
|
|
5718
5408
|
+ an array of bytes
|
|
5719
5409
|
|
|
5720
|
-
</details>
|
|
5721
|
-
|
|
5722
5410
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5723
5411
|
|
|
5724
5412
|
---
|
|
@@ -5775,10 +5463,6 @@ export async function getBeefForTransaction(storage: StorageProvider, txid: stri
|
|
|
5775
5463
|
|
|
5776
5464
|
See also: [StorageGetBeefOptions](#interface-storagegetbeefoptions), [StorageProvider](#class-storageprovider)
|
|
5777
5465
|
|
|
5778
|
-
<details>
|
|
5779
|
-
|
|
5780
|
-
<summary>Function getBeefForTransaction Details</summary>
|
|
5781
|
-
|
|
5782
5466
|
Argument Details
|
|
5783
5467
|
|
|
5784
5468
|
+ **storage**
|
|
@@ -5786,8 +5470,6 @@ Argument Details
|
|
|
5786
5470
|
+ **txid**
|
|
5787
5471
|
+ the transaction hash for which an envelope is requested.
|
|
5788
5472
|
|
|
5789
|
-
</details>
|
|
5790
|
-
|
|
5791
5473
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5792
5474
|
|
|
5793
5475
|
---
|
|
@@ -6147,17 +5829,11 @@ export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config:
|
|
|
6147
5829
|
|
|
6148
5830
|
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface-walletservices)
|
|
6149
5831
|
|
|
6150
|
-
<details>
|
|
6151
|
-
|
|
6152
|
-
<summary>Function postTxsToTaalArcMiner Details</summary>
|
|
6153
|
-
|
|
6154
5832
|
Argument Details
|
|
6155
5833
|
|
|
6156
5834
|
+ **txs**
|
|
6157
5835
|
+ All transactions must have source transactions. Will just source locking scripts and satoshis do?? toHexEF() is used.
|
|
6158
5836
|
|
|
6159
|
-
</details>
|
|
6160
|
-
|
|
6161
5837
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6162
5838
|
|
|
6163
5839
|
---
|
|
@@ -6200,16 +5876,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6200
5876
|
export function randomBytes(count: number): number[]
|
|
6201
5877
|
```
|
|
6202
5878
|
|
|
6203
|
-
<details>
|
|
6204
|
-
|
|
6205
|
-
<summary>Function randomBytes Details</summary>
|
|
6206
|
-
|
|
6207
5879
|
Returns
|
|
6208
5880
|
|
|
6209
5881
|
count cryptographically secure random bytes as array of bytes
|
|
6210
5882
|
|
|
6211
|
-
</details>
|
|
6212
|
-
|
|
6213
5883
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6214
5884
|
|
|
6215
5885
|
---
|
|
@@ -6219,16 +5889,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6219
5889
|
export function randomBytesBase64(count: number): string
|
|
6220
5890
|
```
|
|
6221
5891
|
|
|
6222
|
-
<details>
|
|
6223
|
-
|
|
6224
|
-
<summary>Function randomBytesBase64 Details</summary>
|
|
6225
|
-
|
|
6226
5892
|
Returns
|
|
6227
5893
|
|
|
6228
5894
|
count cryptographically secure random bytes as base64 encoded string
|
|
6229
5895
|
|
|
6230
|
-
</details>
|
|
6231
|
-
|
|
6232
5896
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6233
5897
|
|
|
6234
5898
|
---
|
|
@@ -6238,16 +5902,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6238
5902
|
export function randomBytesHex(count: number): string
|
|
6239
5903
|
```
|
|
6240
5904
|
|
|
6241
|
-
<details>
|
|
6242
|
-
|
|
6243
|
-
<summary>Function randomBytesHex Details</summary>
|
|
6244
|
-
|
|
6245
5905
|
Returns
|
|
6246
5906
|
|
|
6247
5907
|
count cryptographically secure random bytes as hex encoded string
|
|
6248
5908
|
|
|
6249
|
-
</details>
|
|
6250
|
-
|
|
6251
5909
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6252
5910
|
|
|
6253
5911
|
---
|
|
@@ -6262,16 +5920,10 @@ export function sha256Hash(data: number[]): number[] {
|
|
|
6262
5920
|
}
|
|
6263
5921
|
```
|
|
6264
5922
|
|
|
6265
|
-
<details>
|
|
6266
|
-
|
|
6267
|
-
<summary>Function sha256Hash Details</summary>
|
|
6268
|
-
|
|
6269
5923
|
Returns
|
|
6270
5924
|
|
|
6271
5925
|
sha256 hash of buffer contents.
|
|
6272
5926
|
|
|
6273
|
-
</details>
|
|
6274
|
-
|
|
6275
5927
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6276
5928
|
|
|
6277
5929
|
---
|
|
@@ -6296,10 +5948,6 @@ export function stampLog(log: string | undefined | {
|
|
|
6296
5948
|
}, lineToAdd: string): string | undefined
|
|
6297
5949
|
```
|
|
6298
5950
|
|
|
6299
|
-
<details>
|
|
6300
|
-
|
|
6301
|
-
<summary>Function stampLog Details</summary>
|
|
6302
|
-
|
|
6303
5951
|
Returns
|
|
6304
5952
|
|
|
6305
5953
|
undefined or log extended by time stamped `lineToAdd` and new line.
|
|
@@ -6311,8 +5959,6 @@ Argument Details
|
|
|
6311
5959
|
+ **lineToAdd**
|
|
6312
5960
|
+ Content to add to line.
|
|
6313
5961
|
|
|
6314
|
-
</details>
|
|
6315
|
-
|
|
6316
5962
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6317
5963
|
|
|
6318
5964
|
---
|
|
@@ -6326,10 +5972,6 @@ Assumes log built by repeated calls to `stampLog`
|
|
|
6326
5972
|
export function stampLogFormat(log?: string): string
|
|
6327
5973
|
```
|
|
6328
5974
|
|
|
6329
|
-
<details>
|
|
6330
|
-
|
|
6331
|
-
<summary>Function stampLogFormat Details</summary>
|
|
6332
|
-
|
|
6333
5975
|
Returns
|
|
6334
5976
|
|
|
6335
5977
|
reformated multi-line event log
|
|
@@ -6339,8 +5981,6 @@ Argument Details
|
|
|
6339
5981
|
+ **log**
|
|
6340
5982
|
+ Each logged event starts with ISO time stamp, space, rest of line, terminated by `\n`.
|
|
6341
5983
|
|
|
6342
|
-
</details>
|
|
6343
|
-
|
|
6344
5984
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6345
5985
|
|
|
6346
5986
|
---
|
|
@@ -6367,16 +6007,10 @@ export function toBinaryBaseBlockHeader(header: sdk.BaseBlockHeader): number[] {
|
|
|
6367
6007
|
|
|
6368
6008
|
See also: [BaseBlockHeader](#interface-baseblockheader), [asArray](#function-asarray)
|
|
6369
6009
|
|
|
6370
|
-
<details>
|
|
6371
|
-
|
|
6372
|
-
<summary>Function toBinaryBaseBlockHeader Details</summary>
|
|
6373
|
-
|
|
6374
6010
|
Returns
|
|
6375
6011
|
|
|
6376
6012
|
80 byte array
|
|
6377
6013
|
|
|
6378
|
-
</details>
|
|
6379
|
-
|
|
6380
6014
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6381
6015
|
|
|
6382
6016
|
---
|
|
@@ -6397,10 +6031,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6397
6031
|
export function transactionInputSize(scriptSize: number): number
|
|
6398
6032
|
```
|
|
6399
6033
|
|
|
6400
|
-
<details>
|
|
6401
|
-
|
|
6402
|
-
<summary>Function transactionInputSize Details</summary>
|
|
6403
|
-
|
|
6404
6034
|
Returns
|
|
6405
6035
|
|
|
6406
6036
|
serialized byte length a transaction input
|
|
@@ -6410,8 +6040,6 @@ Argument Details
|
|
|
6410
6040
|
+ **scriptSize**
|
|
6411
6041
|
+ byte length of input script
|
|
6412
6042
|
|
|
6413
|
-
</details>
|
|
6414
|
-
|
|
6415
6043
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6416
6044
|
|
|
6417
6045
|
---
|
|
@@ -6421,10 +6049,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6421
6049
|
export function transactionOutputSize(scriptSize: number): number
|
|
6422
6050
|
```
|
|
6423
6051
|
|
|
6424
|
-
<details>
|
|
6425
|
-
|
|
6426
|
-
<summary>Function transactionOutputSize Details</summary>
|
|
6427
|
-
|
|
6428
6052
|
Returns
|
|
6429
6053
|
|
|
6430
6054
|
serialized byte length a transaction output
|
|
@@ -6434,8 +6058,6 @@ Argument Details
|
|
|
6434
6058
|
+ **scriptSize**
|
|
6435
6059
|
+ byte length of output script
|
|
6436
6060
|
|
|
6437
|
-
</details>
|
|
6438
|
-
|
|
6439
6061
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6440
6062
|
|
|
6441
6063
|
---
|
|
@@ -6449,10 +6071,6 @@ and the size of each script.
|
|
|
6449
6071
|
export function transactionSize(inputs: number[], outputs: number[]): number
|
|
6450
6072
|
```
|
|
6451
6073
|
|
|
6452
|
-
<details>
|
|
6453
|
-
|
|
6454
|
-
<summary>Function transactionSize Details</summary>
|
|
6455
|
-
|
|
6456
6074
|
Returns
|
|
6457
6075
|
|
|
6458
6076
|
total transaction size in bytes
|
|
@@ -6464,8 +6082,6 @@ Argument Details
|
|
|
6464
6082
|
+ **outputs**
|
|
6465
6083
|
+ array of output script lengths, in bytes
|
|
6466
6084
|
|
|
6467
|
-
</details>
|
|
6468
|
-
|
|
6469
6085
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6470
6086
|
|
|
6471
6087
|
---
|
|
@@ -6521,17 +6137,11 @@ export async function validateAcquireCertificateArgs(args: AcquireCertificateArg
|
|
|
6521
6137
|
|
|
6522
6138
|
See also: [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs)
|
|
6523
6139
|
|
|
6524
|
-
<details>
|
|
6525
|
-
|
|
6526
|
-
<summary>Function validateAcquireCertificateArgs Details</summary>
|
|
6527
|
-
|
|
6528
6140
|
Argument Details
|
|
6529
6141
|
|
|
6530
6142
|
+ **subject**
|
|
6531
6143
|
+ Must be valid for "direct" `acquisitionProtocol`. public key of the certificate subject.
|
|
6532
6144
|
|
|
6533
|
-
</details>
|
|
6534
|
-
|
|
6535
6145
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6536
6146
|
|
|
6537
6147
|
---
|
|
@@ -6703,10 +6313,6 @@ export function validateListActionsArgs(args: ListActionsArgs): ValidListActions
|
|
|
6703
6313
|
|
|
6704
6314
|
See also: [ValidListActionsArgs](#interface-validlistactionsargs)
|
|
6705
6315
|
|
|
6706
|
-
<details>
|
|
6707
|
-
|
|
6708
|
-
<summary>Function validateListActionsArgs Details</summary>
|
|
6709
|
-
|
|
6710
6316
|
Argument Details
|
|
6711
6317
|
|
|
6712
6318
|
+ **args.labels**
|
|
@@ -6732,8 +6338,6 @@ Argument Details
|
|
|
6732
6338
|
+ **args.seekPermission**
|
|
6733
6339
|
+ — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
|
|
6734
6340
|
|
|
6735
|
-
</details>
|
|
6736
|
-
|
|
6737
6341
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6738
6342
|
|
|
6739
6343
|
---
|
|
@@ -6756,10 +6360,6 @@ export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputs
|
|
|
6756
6360
|
|
|
6757
6361
|
See also: [ValidListOutputsArgs](#interface-validlistoutputsargs)
|
|
6758
6362
|
|
|
6759
|
-
<details>
|
|
6760
|
-
|
|
6761
|
-
<summary>Function validateListOutputsArgs Details</summary>
|
|
6762
|
-
|
|
6763
6363
|
Argument Details
|
|
6764
6364
|
|
|
6765
6365
|
+ **args.basket**
|
|
@@ -6785,8 +6385,6 @@ Argument Details
|
|
|
6785
6385
|
+ **args.seekPermission**
|
|
6786
6386
|
+ — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
|
|
6787
6387
|
|
|
6788
|
-
</details>
|
|
6789
|
-
|
|
6790
6388
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6791
6389
|
|
|
6792
6390
|
---
|
|
@@ -7032,10 +6630,6 @@ Helper function.
|
|
|
7032
6630
|
export function verifyOne<T>(results: T[], errorDescrition?: string): T
|
|
7033
6631
|
```
|
|
7034
6632
|
|
|
7035
|
-
<details>
|
|
7036
|
-
|
|
7037
|
-
<summary>Function verifyOne Details</summary>
|
|
7038
|
-
|
|
7039
6633
|
Returns
|
|
7040
6634
|
|
|
7041
6635
|
results[0].
|
|
@@ -7044,8 +6638,6 @@ Throws
|
|
|
7044
6638
|
|
|
7045
6639
|
WERR_BAD_REQUEST if results has length other than one.
|
|
7046
6640
|
|
|
7047
|
-
</details>
|
|
7048
|
-
|
|
7049
6641
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7050
6642
|
|
|
7051
6643
|
---
|
|
@@ -7057,10 +6649,6 @@ Helper function.
|
|
|
7057
6649
|
export function verifyOneOrNone<T>(results: T[]): T | undefined
|
|
7058
6650
|
```
|
|
7059
6651
|
|
|
7060
|
-
<details>
|
|
7061
|
-
|
|
7062
|
-
<summary>Function verifyOneOrNone Details</summary>
|
|
7063
|
-
|
|
7064
6652
|
Returns
|
|
7065
6653
|
|
|
7066
6654
|
results[0] or undefined if length is zero.
|
|
@@ -7069,8 +6657,6 @@ Throws
|
|
|
7069
6657
|
|
|
7070
6658
|
WERR_BAD_REQUEST if results has length greater than one.
|
|
7071
6659
|
|
|
7072
|
-
</details>
|
|
7073
|
-
|
|
7074
6660
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7075
6661
|
|
|
7076
6662
|
---
|