@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/wallet.md
CHANGED
|
@@ -167,10 +167,6 @@ export interface BaseBlockHeader {
|
|
|
167
167
|
}
|
|
168
168
|
```
|
|
169
169
|
|
|
170
|
-
<details>
|
|
171
|
-
|
|
172
|
-
<summary>Interface BaseBlockHeader Details</summary>
|
|
173
|
-
|
|
174
170
|
###### Property bits
|
|
175
171
|
|
|
176
172
|
Block header bits value. Serialized length is 4 bytes.
|
|
@@ -219,8 +215,6 @@ Block header version value. Serialized length is 4 bytes.
|
|
|
219
215
|
version: number
|
|
220
216
|
```
|
|
221
217
|
|
|
222
|
-
</details>
|
|
223
|
-
|
|
224
218
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
225
219
|
|
|
226
220
|
---
|
|
@@ -237,10 +231,6 @@ export interface BlockHeader extends BaseBlockHeader {
|
|
|
237
231
|
|
|
238
232
|
See also: [BaseBlockHeader](#interface-baseblockheader)
|
|
239
233
|
|
|
240
|
-
<details>
|
|
241
|
-
|
|
242
|
-
<summary>Interface BlockHeader Details</summary>
|
|
243
|
-
|
|
244
234
|
###### Property hash
|
|
245
235
|
|
|
246
236
|
The double sha256 hash of the serialized `BaseBlockHeader` fields.
|
|
@@ -257,8 +247,6 @@ Height of the header, starting from zero.
|
|
|
257
247
|
height: number
|
|
258
248
|
```
|
|
259
249
|
|
|
260
|
-
</details>
|
|
261
|
-
|
|
262
250
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
263
251
|
|
|
264
252
|
---
|
|
@@ -655,10 +643,6 @@ export interface GenerateChangeSdkParams {
|
|
|
655
643
|
|
|
656
644
|
See also: [GenerateChangeSdkInput](#interface-generatechangesdkinput), [GenerateChangeSdkOutput](#interface-generatechangesdkoutput), [StorageFeeModel](#interface-storagefeemodel)
|
|
657
645
|
|
|
658
|
-
<details>
|
|
659
|
-
|
|
660
|
-
<summary>Interface GenerateChangeSdkParams Details</summary>
|
|
661
|
-
|
|
662
646
|
###### Property changeFirstSatoshis
|
|
663
647
|
|
|
664
648
|
Lowest amount value to assign to a change output.
|
|
@@ -706,8 +690,6 @@ If undefined, only a single change output will be added if excess fees must be r
|
|
|
706
690
|
targetNetCount?: number
|
|
707
691
|
```
|
|
708
692
|
|
|
709
|
-
</details>
|
|
710
|
-
|
|
711
693
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
712
694
|
|
|
713
695
|
---
|
|
@@ -756,10 +738,6 @@ export interface GetMerklePathResult {
|
|
|
756
738
|
|
|
757
739
|
See also: [BlockHeader](#interface-blockheader), [WalletError](#class-walleterror)
|
|
758
740
|
|
|
759
|
-
<details>
|
|
760
|
-
|
|
761
|
-
<summary>Interface GetMerklePathResult Details</summary>
|
|
762
|
-
|
|
763
741
|
###### Property error
|
|
764
742
|
|
|
765
743
|
The first exception error that occurred during processing, if any.
|
|
@@ -786,8 +764,6 @@ The name of the service returning the proof, or undefined if no proof
|
|
|
786
764
|
name?: string
|
|
787
765
|
```
|
|
788
766
|
|
|
789
|
-
</details>
|
|
790
|
-
|
|
791
767
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
792
768
|
|
|
793
769
|
---
|
|
@@ -806,10 +782,6 @@ export interface GetRawTxResult {
|
|
|
806
782
|
|
|
807
783
|
See also: [WalletError](#class-walleterror)
|
|
808
784
|
|
|
809
|
-
<details>
|
|
810
|
-
|
|
811
|
-
<summary>Interface GetRawTxResult Details</summary>
|
|
812
|
-
|
|
813
785
|
###### Property error
|
|
814
786
|
|
|
815
787
|
The first exception error that occurred during processing, if any.
|
|
@@ -844,8 +816,6 @@ Transaction hash or rawTx (and of initial request)
|
|
|
844
816
|
txid: string
|
|
845
817
|
```
|
|
846
818
|
|
|
847
|
-
</details>
|
|
848
|
-
|
|
849
819
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
850
820
|
|
|
851
821
|
---
|
|
@@ -889,10 +859,6 @@ export interface GetUtxoStatusDetails {
|
|
|
889
859
|
}
|
|
890
860
|
```
|
|
891
861
|
|
|
892
|
-
<details>
|
|
893
|
-
|
|
894
|
-
<summary>Interface GetUtxoStatusDetails Details</summary>
|
|
895
|
-
|
|
896
862
|
###### Property height
|
|
897
863
|
|
|
898
864
|
if isUtxo, the block height containing the matching unspent transaction output
|
|
@@ -933,8 +899,6 @@ typically there will be only one, but future orphans can result in multiple valu
|
|
|
933
899
|
txid?: string
|
|
934
900
|
```
|
|
935
901
|
|
|
936
|
-
</details>
|
|
937
|
-
|
|
938
902
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
939
903
|
|
|
940
904
|
---
|
|
@@ -952,10 +916,6 @@ export interface GetUtxoStatusResult {
|
|
|
952
916
|
|
|
953
917
|
See also: [GetUtxoStatusDetails](#interface-getutxostatusdetails), [WalletError](#class-walleterror)
|
|
954
918
|
|
|
955
|
-
<details>
|
|
956
|
-
|
|
957
|
-
<summary>Interface GetUtxoStatusResult Details</summary>
|
|
958
|
-
|
|
959
919
|
###### Property details
|
|
960
920
|
|
|
961
921
|
Additional details about occurances of this output script as a utxo.
|
|
@@ -1002,8 +962,6 @@ name: string
|
|
|
1002
962
|
status: "success" | "error"
|
|
1003
963
|
```
|
|
1004
964
|
|
|
1005
|
-
</details>
|
|
1006
|
-
|
|
1007
965
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1008
966
|
|
|
1009
967
|
---
|
|
@@ -1037,10 +995,6 @@ export interface MonitorOptions {
|
|
|
1037
995
|
|
|
1038
996
|
See also: [Chain](#type-chain), [MonitorStorage](#type-monitorstorage), [Services](#class-services)
|
|
1039
997
|
|
|
1040
|
-
<details>
|
|
1041
|
-
|
|
1042
|
-
<summary>Interface MonitorOptions Details</summary>
|
|
1043
|
-
|
|
1044
998
|
###### Property msecsWaitPerMerkleProofServiceReq
|
|
1045
999
|
|
|
1046
1000
|
How many msecs to wait after each getMerkleProof service request.
|
|
@@ -1049,8 +1003,6 @@ How many msecs to wait after each getMerkleProof service request.
|
|
|
1049
1003
|
msecsWaitPerMerkleProofServiceReq: number
|
|
1050
1004
|
```
|
|
1051
1005
|
|
|
1052
|
-
</details>
|
|
1053
|
-
|
|
1054
1006
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1055
1007
|
|
|
1056
1008
|
---
|
|
@@ -1065,10 +1017,6 @@ export interface OutPoint {
|
|
|
1065
1017
|
}
|
|
1066
1018
|
```
|
|
1067
1019
|
|
|
1068
|
-
<details>
|
|
1069
|
-
|
|
1070
|
-
<summary>Interface OutPoint Details</summary>
|
|
1071
|
-
|
|
1072
1020
|
###### Property txid
|
|
1073
1021
|
|
|
1074
1022
|
Transaction double sha256 hash as big endian hex string
|
|
@@ -1085,8 +1033,6 @@ zero based output index within the transaction
|
|
|
1085
1033
|
vout: number
|
|
1086
1034
|
```
|
|
1087
1035
|
|
|
1088
|
-
</details>
|
|
1089
|
-
|
|
1090
1036
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1091
1037
|
|
|
1092
1038
|
---
|
|
@@ -1161,10 +1107,6 @@ export interface PostBeefResultForTxidApi {
|
|
|
1161
1107
|
}
|
|
1162
1108
|
```
|
|
1163
1109
|
|
|
1164
|
-
<details>
|
|
1165
|
-
|
|
1166
|
-
<summary>Interface PostBeefResultForTxidApi Details</summary>
|
|
1167
|
-
|
|
1168
1110
|
###### Property alreadyKnown
|
|
1169
1111
|
|
|
1170
1112
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1183,8 +1125,6 @@ alreadyKnown?: boolean
|
|
|
1183
1125
|
status: "success" | "error"
|
|
1184
1126
|
```
|
|
1185
1127
|
|
|
1186
|
-
</details>
|
|
1187
|
-
|
|
1188
1128
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1189
1129
|
|
|
1190
1130
|
---
|
|
@@ -1237,10 +1177,6 @@ export interface PostTxResultForTxid {
|
|
|
1237
1177
|
}
|
|
1238
1178
|
```
|
|
1239
1179
|
|
|
1240
|
-
<details>
|
|
1241
|
-
|
|
1242
|
-
<summary>Interface PostTxResultForTxid Details</summary>
|
|
1243
|
-
|
|
1244
1180
|
###### Property alreadyKnown
|
|
1245
1181
|
|
|
1246
1182
|
if true, the transaction was already known to this service. Usually treat as a success.
|
|
@@ -1259,8 +1195,6 @@ alreadyKnown?: boolean
|
|
|
1259
1195
|
status: "success" | "error"
|
|
1260
1196
|
```
|
|
1261
1197
|
|
|
1262
|
-
</details>
|
|
1263
|
-
|
|
1264
1198
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1265
1199
|
|
|
1266
1200
|
---
|
|
@@ -1280,10 +1214,6 @@ export interface PostTxsResult {
|
|
|
1280
1214
|
|
|
1281
1215
|
See also: [PostTxResultForTxid](#interface-posttxresultfortxid), [WalletError](#class-walleterror)
|
|
1282
1216
|
|
|
1283
|
-
<details>
|
|
1284
|
-
|
|
1285
|
-
<summary>Interface PostTxsResult Details</summary>
|
|
1286
|
-
|
|
1287
1217
|
###### Property data
|
|
1288
1218
|
|
|
1289
1219
|
Service response object. Use service name and status to infer type of object.
|
|
@@ -1309,8 +1239,6 @@ name: string
|
|
|
1309
1239
|
status: "success" | "error"
|
|
1310
1240
|
```
|
|
1311
1241
|
|
|
1312
|
-
</details>
|
|
1313
|
-
|
|
1314
1242
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1315
1243
|
|
|
1316
1244
|
---
|
|
@@ -1357,10 +1285,6 @@ export interface PurgeParams {
|
|
|
1357
1285
|
}
|
|
1358
1286
|
```
|
|
1359
1287
|
|
|
1360
|
-
<details>
|
|
1361
|
-
|
|
1362
|
-
<summary>Interface PurgeParams Details</summary>
|
|
1363
|
-
|
|
1364
1288
|
###### Property purgeCompletedAge
|
|
1365
1289
|
|
|
1366
1290
|
Minimum age in msecs for transient completed transaction data purge.
|
|
@@ -1388,8 +1312,6 @@ Default is 14 days.
|
|
|
1388
1312
|
purgeSpentAge?: number
|
|
1389
1313
|
```
|
|
1390
1314
|
|
|
1391
|
-
</details>
|
|
1392
|
-
|
|
1393
1315
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1394
1316
|
|
|
1395
1317
|
---
|
|
@@ -1422,10 +1344,6 @@ export interface RequestSyncChunkArgs {
|
|
|
1422
1344
|
}
|
|
1423
1345
|
```
|
|
1424
1346
|
|
|
1425
|
-
<details>
|
|
1426
|
-
|
|
1427
|
-
<summary>Interface RequestSyncChunkArgs Details</summary>
|
|
1428
|
-
|
|
1429
1347
|
###### Property fromStorageIdentityKey
|
|
1430
1348
|
|
|
1431
1349
|
The storageIdentityKey of the storage supplying the update SyncChunk data.
|
|
@@ -1504,8 +1422,6 @@ The storageIdentityKey of the storage consuming the update SyncChunk data.
|
|
|
1504
1422
|
toStorageIdentityKey: string
|
|
1505
1423
|
```
|
|
1506
1424
|
|
|
1507
|
-
</details>
|
|
1508
|
-
|
|
1509
1425
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1510
1426
|
|
|
1511
1427
|
---
|
|
@@ -1555,10 +1471,6 @@ export interface SetupEnv {
|
|
|
1555
1471
|
|
|
1556
1472
|
See also: [Chain](#type-chain)
|
|
1557
1473
|
|
|
1558
|
-
<details>
|
|
1559
|
-
|
|
1560
|
-
<summary>Interface SetupEnv Details</summary>
|
|
1561
|
-
|
|
1562
1474
|
###### Property chain
|
|
1563
1475
|
|
|
1564
1476
|
The chan being accessed: 'main' for mainnet, 'test' for 'testnet'.
|
|
@@ -1609,8 +1521,6 @@ A vaild TAAL API key for use by `Services`
|
|
|
1609
1521
|
taalApiKey: string
|
|
1610
1522
|
```
|
|
1611
1523
|
|
|
1612
|
-
</details>
|
|
1613
|
-
|
|
1614
1524
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1615
1525
|
|
|
1616
1526
|
---
|
|
@@ -1637,10 +1547,6 @@ export interface SetupWallet {
|
|
|
1637
1547
|
|
|
1638
1548
|
See also: [Chain](#type-chain), [Monitor](#class-monitor), [Services](#class-services), [Wallet](#class-wallet), [WalletStorageManager](#class-walletstoragemanager)
|
|
1639
1549
|
|
|
1640
|
-
<details>
|
|
1641
|
-
|
|
1642
|
-
<summary>Interface SetupWallet Details</summary>
|
|
1643
|
-
|
|
1644
1550
|
###### Property chain
|
|
1645
1551
|
|
|
1646
1552
|
The chain ('main' or 'test') which the wallet accesses.
|
|
@@ -1718,8 +1624,6 @@ wallet: Wallet
|
|
|
1718
1624
|
```
|
|
1719
1625
|
See also: [Wallet](#class-wallet)
|
|
1720
1626
|
|
|
1721
|
-
</details>
|
|
1722
|
-
|
|
1723
1627
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1724
1628
|
|
|
1725
1629
|
---
|
|
@@ -1747,10 +1651,6 @@ export interface SetupWalletArgs {
|
|
|
1747
1651
|
|
|
1748
1652
|
See also: [SetupEnv](#interface-setupenv), [WalletStorageProvider](#interface-walletstorageprovider)
|
|
1749
1653
|
|
|
1750
|
-
<details>
|
|
1751
|
-
|
|
1752
|
-
<summary>Interface SetupWalletArgs Details</summary>
|
|
1753
|
-
|
|
1754
1654
|
###### Property active
|
|
1755
1655
|
|
|
1756
1656
|
Optional. Active wallet storage. Can be added later.
|
|
@@ -1796,8 +1696,6 @@ Defaults to `env.devKeys[env.identityKey]
|
|
|
1796
1696
|
rootKeyHex?: string
|
|
1797
1697
|
```
|
|
1798
1698
|
|
|
1799
|
-
</details>
|
|
1800
|
-
|
|
1801
1699
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1802
1700
|
|
|
1803
1701
|
---
|
|
@@ -1813,10 +1711,6 @@ export interface SetupWalletClient extends SetupWallet {
|
|
|
1813
1711
|
|
|
1814
1712
|
See also: [SetupWallet](#interface-setupwallet)
|
|
1815
1713
|
|
|
1816
|
-
<details>
|
|
1817
|
-
|
|
1818
|
-
<summary>Interface SetupWalletClient Details</summary>
|
|
1819
|
-
|
|
1820
1714
|
###### Property endpointUrl
|
|
1821
1715
|
|
|
1822
1716
|
The endpoint URL of the service hosting the `StorageServer` JSON-RPC service to
|
|
@@ -1827,8 +1721,6 @@ the active storage provider of the wallet.
|
|
|
1827
1721
|
endpointUrl: string
|
|
1828
1722
|
```
|
|
1829
1723
|
|
|
1830
|
-
</details>
|
|
1831
|
-
|
|
1832
1724
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1833
1725
|
|
|
1834
1726
|
---
|
|
@@ -1845,10 +1737,6 @@ export interface SetupWalletClientArgs extends SetupWalletArgs {
|
|
|
1845
1737
|
|
|
1846
1738
|
See also: [SetupWalletArgs](#interface-setupwalletargs)
|
|
1847
1739
|
|
|
1848
|
-
<details>
|
|
1849
|
-
|
|
1850
|
-
<summary>Interface SetupWalletClientArgs Details</summary>
|
|
1851
|
-
|
|
1852
1740
|
###### Property endpointUrl
|
|
1853
1741
|
|
|
1854
1742
|
The endpoint URL of a service hosting the `StorageServer` JSON-RPC service to
|
|
@@ -1859,8 +1747,6 @@ the active storage provider of the newly created wallet.
|
|
|
1859
1747
|
endpointUrl?: string
|
|
1860
1748
|
```
|
|
1861
1749
|
|
|
1862
|
-
</details>
|
|
1863
|
-
|
|
1864
1750
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1865
1751
|
|
|
1866
1752
|
---
|
|
@@ -1935,10 +1821,6 @@ export interface StorageFeeModel {
|
|
|
1935
1821
|
}
|
|
1936
1822
|
```
|
|
1937
1823
|
|
|
1938
|
-
<details>
|
|
1939
|
-
|
|
1940
|
-
<summary>Interface StorageFeeModel Details</summary>
|
|
1941
|
-
|
|
1942
1824
|
###### Property model
|
|
1943
1825
|
|
|
1944
1826
|
Available models. Currently only "sat/kb" is supported.
|
|
@@ -1958,8 +1840,6 @@ If undefined, the default value is used.
|
|
|
1958
1840
|
value?: number
|
|
1959
1841
|
```
|
|
1960
1842
|
|
|
1961
|
-
</details>
|
|
1962
|
-
|
|
1963
1843
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
1964
1844
|
|
|
1965
1845
|
---
|
|
@@ -1977,10 +1857,6 @@ export interface StorageGetBeefOptions {
|
|
|
1977
1857
|
}
|
|
1978
1858
|
```
|
|
1979
1859
|
|
|
1980
|
-
<details>
|
|
1981
|
-
|
|
1982
|
-
<summary>Interface StorageGetBeefOptions Details</summary>
|
|
1983
|
-
|
|
1984
1860
|
###### Property ignoreNewProven
|
|
1985
1861
|
|
|
1986
1862
|
optional. Default is false. If true, raw transactions with proofs missing from `storage` and obtained from `getServices` are not inserted to `storage`.
|
|
@@ -2037,8 +1913,6 @@ if 'known', txids known to local storage as valid are included as txidOnly
|
|
|
2037
1913
|
trustSelf?: "known"
|
|
2038
1914
|
```
|
|
2039
1915
|
|
|
2040
|
-
</details>
|
|
2041
|
-
|
|
2042
1916
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2043
1917
|
|
|
2044
1918
|
---
|
|
@@ -2051,10 +1925,6 @@ export interface StorageIdentity {
|
|
|
2051
1925
|
}
|
|
2052
1926
|
```
|
|
2053
1927
|
|
|
2054
|
-
<details>
|
|
2055
|
-
|
|
2056
|
-
<summary>Interface StorageIdentity Details</summary>
|
|
2057
|
-
|
|
2058
1928
|
###### Property storageIdentityKey
|
|
2059
1929
|
|
|
2060
1930
|
The identity key (public key) assigned to this storage
|
|
@@ -2071,8 +1941,6 @@ The human readable name assigned to this storage.
|
|
|
2071
1941
|
storageName: string
|
|
2072
1942
|
```
|
|
2073
1943
|
|
|
2074
|
-
</details>
|
|
2075
|
-
|
|
2076
1944
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2077
1945
|
|
|
2078
1946
|
---
|
|
@@ -2086,10 +1954,6 @@ export interface StorageInternalizeActionResult extends InternalizeActionResult
|
|
|
2086
1954
|
}
|
|
2087
1955
|
```
|
|
2088
1956
|
|
|
2089
|
-
<details>
|
|
2090
|
-
|
|
2091
|
-
<summary>Interface StorageInternalizeActionResult Details</summary>
|
|
2092
|
-
|
|
2093
1957
|
###### Property isMerge
|
|
2094
1958
|
|
|
2095
1959
|
true if internalizing outputs on an existing storage transaction
|
|
@@ -2114,8 +1978,6 @@ txid of transaction being internalized
|
|
|
2114
1978
|
txid: string
|
|
2115
1979
|
```
|
|
2116
1980
|
|
|
2117
|
-
</details>
|
|
2118
|
-
|
|
2119
1981
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2120
1982
|
|
|
2121
1983
|
---
|
|
@@ -2175,10 +2037,6 @@ export interface StorageProviderOptions extends StorageReaderWriterOptions {
|
|
|
2175
2037
|
|
|
2176
2038
|
See also: [Chain](#type-chain), [StorageFeeModel](#interface-storagefeemodel), [StorageReaderWriterOptions](#interface-storagereaderwriteroptions)
|
|
2177
2039
|
|
|
2178
|
-
<details>
|
|
2179
|
-
|
|
2180
|
-
<summary>Interface StorageProviderOptions Details</summary>
|
|
2181
|
-
|
|
2182
2040
|
###### Property commissionPubKeyHex
|
|
2183
2041
|
|
|
2184
2042
|
If commissionSatoshis is greater than zero, must be a valid public key hex string.
|
|
@@ -2198,8 +2056,6 @@ A value of zero disables commission fees.
|
|
|
2198
2056
|
commissionSatoshis: number
|
|
2199
2057
|
```
|
|
2200
2058
|
|
|
2201
|
-
</details>
|
|
2202
|
-
|
|
2203
2059
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2204
2060
|
|
|
2205
2061
|
---
|
|
@@ -2578,10 +2434,6 @@ export interface ValidAcquireDirectCertificateArgs extends ValidWalletSignerArgs
|
|
|
2578
2434
|
|
|
2579
2435
|
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2580
2436
|
|
|
2581
|
-
<details>
|
|
2582
|
-
|
|
2583
|
-
<summary>Interface ValidAcquireDirectCertificateArgs Details</summary>
|
|
2584
|
-
|
|
2585
2437
|
###### Property subject
|
|
2586
2438
|
|
|
2587
2439
|
validated to an empty string, must be provided by wallet and must
|
|
@@ -2591,8 +2443,6 @@ match expectations of keyringForSubject
|
|
|
2591
2443
|
subject: PubKeyHex
|
|
2592
2444
|
```
|
|
2593
2445
|
|
|
2594
|
-
</details>
|
|
2595
|
-
|
|
2596
2446
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2597
2447
|
|
|
2598
2448
|
---
|
|
@@ -2612,10 +2462,6 @@ export interface ValidAcquireIssuanceCertificateArgs extends ValidWalletSignerAr
|
|
|
2612
2462
|
|
|
2613
2463
|
See also: [ValidWalletSignerArgs](#interface-validwalletsignerargs)
|
|
2614
2464
|
|
|
2615
|
-
<details>
|
|
2616
|
-
|
|
2617
|
-
<summary>Interface ValidAcquireIssuanceCertificateArgs Details</summary>
|
|
2618
|
-
|
|
2619
2465
|
###### Property subject
|
|
2620
2466
|
|
|
2621
2467
|
validated to an empty string, must be provided by wallet and must
|
|
@@ -2625,8 +2471,6 @@ match expectations of keyringForSubject
|
|
|
2625
2471
|
subject: PubKeyHex
|
|
2626
2472
|
```
|
|
2627
2473
|
|
|
2628
|
-
</details>
|
|
2629
|
-
|
|
2630
2474
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
2631
2475
|
|
|
2632
2476
|
---
|
|
@@ -3031,10 +2875,6 @@ export interface WalletServices {
|
|
|
3031
2875
|
|
|
3032
2876
|
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)
|
|
3033
2877
|
|
|
3034
|
-
<details>
|
|
3035
|
-
|
|
3036
|
-
<summary>Interface WalletServices Details</summary>
|
|
3037
|
-
|
|
3038
2878
|
###### Property chain
|
|
3039
2879
|
|
|
3040
2880
|
The chain being serviced.
|
|
@@ -3209,8 +3049,6 @@ Argument Details
|
|
|
3209
3049
|
+ **txOrLockTime**
|
|
3210
3050
|
+ either a bitcoin locktime value or hex, binary, un-encoded Transaction
|
|
3211
3051
|
|
|
3212
|
-
</details>
|
|
3213
|
-
|
|
3214
3052
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3215
3053
|
|
|
3216
3054
|
---
|
|
@@ -3293,10 +3131,6 @@ export interface WalletStorage {
|
|
|
3293
3131
|
|
|
3294
3132
|
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)
|
|
3295
3133
|
|
|
3296
|
-
<details>
|
|
3297
|
-
|
|
3298
|
-
<summary>Interface WalletStorage Details</summary>
|
|
3299
|
-
|
|
3300
3134
|
###### Method isStorageProvider
|
|
3301
3135
|
|
|
3302
3136
|
```ts
|
|
@@ -3307,8 +3141,6 @@ Returns
|
|
|
3307
3141
|
|
|
3308
3142
|
false
|
|
3309
3143
|
|
|
3310
|
-
</details>
|
|
3311
|
-
|
|
3312
3144
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3313
3145
|
|
|
3314
3146
|
---
|
|
@@ -3326,10 +3158,6 @@ export interface WalletStorageProvider extends WalletStorageSync {
|
|
|
3326
3158
|
|
|
3327
3159
|
See also: [WalletServices](#interface-walletservices), [WalletStorageSync](#interface-walletstoragesync)
|
|
3328
3160
|
|
|
3329
|
-
<details>
|
|
3330
|
-
|
|
3331
|
-
<summary>Interface WalletStorageProvider Details</summary>
|
|
3332
|
-
|
|
3333
3161
|
###### Method isStorageProvider
|
|
3334
3162
|
|
|
3335
3163
|
```ts
|
|
@@ -3340,8 +3168,6 @@ Returns
|
|
|
3340
3168
|
|
|
3341
3169
|
true if this object's interface can be extended to the full `StorageProvider` interface
|
|
3342
3170
|
|
|
3343
|
-
</details>
|
|
3344
|
-
|
|
3345
3171
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3346
3172
|
|
|
3347
3173
|
---
|
|
@@ -3496,10 +3322,6 @@ export class CertOps extends BsvCertificate {
|
|
|
3496
3322
|
|
|
3497
3323
|
See also: [CertOpsWallet](#interface-certopswallet)
|
|
3498
3324
|
|
|
3499
|
-
<details>
|
|
3500
|
-
|
|
3501
|
-
<summary>Class CertOps Details</summary>
|
|
3502
|
-
|
|
3503
3325
|
###### Method createKeyringForVerifier
|
|
3504
3326
|
|
|
3505
3327
|
Creates a verifiable certificate structure for a specific verifier, allowing them access to specified fields.
|
|
@@ -3537,8 +3359,6 @@ update the signature using the certifier's private key.
|
|
|
3537
3359
|
async encryptAndSignNewCertificate(): Promise<void>
|
|
3538
3360
|
```
|
|
3539
3361
|
|
|
3540
|
-
</details>
|
|
3541
|
-
|
|
3542
3362
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3543
3363
|
|
|
3544
3364
|
---
|
|
@@ -3593,10 +3413,6 @@ export class Monitor {
|
|
|
3593
3413
|
|
|
3594
3414
|
See also: [BlockHeader](#interface-blockheader), [Chain](#type-chain), [MonitorOptions](#interface-monitoroptions), [MonitorStorage](#type-monitorstorage), [Services](#class-services), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
3595
3415
|
|
|
3596
|
-
<details>
|
|
3597
|
-
|
|
3598
|
-
<summary>Class Monitor Details</summary>
|
|
3599
|
-
|
|
3600
3416
|
###### Property _otherTasks
|
|
3601
3417
|
|
|
3602
3418
|
_otherTasks can be run by runTask but not by scheduler.
|
|
@@ -3660,8 +3476,6 @@ processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader): void
|
|
|
3660
3476
|
```
|
|
3661
3477
|
See also: [BlockHeader](#interface-blockheader)
|
|
3662
3478
|
|
|
3663
|
-
</details>
|
|
3664
|
-
|
|
3665
3479
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3666
3480
|
|
|
3667
3481
|
---
|
|
@@ -3696,10 +3510,6 @@ export class PrivilegedKeyManager implements ProtoWallet {
|
|
|
3696
3510
|
}
|
|
3697
3511
|
```
|
|
3698
3512
|
|
|
3699
|
-
<details>
|
|
3700
|
-
|
|
3701
|
-
<summary>Class PrivilegedKeyManager Details</summary>
|
|
3702
|
-
|
|
3703
3513
|
###### Constructor
|
|
3704
3514
|
|
|
3705
3515
|
```ts
|
|
@@ -3723,8 +3533,6 @@ properties to further confuse an attacker.
|
|
|
3723
3533
|
destroyKey(): void
|
|
3724
3534
|
```
|
|
3725
3535
|
|
|
3726
|
-
</details>
|
|
3727
|
-
|
|
3728
3536
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3729
3537
|
|
|
3730
3538
|
---
|
|
@@ -3750,10 +3558,6 @@ export class ScriptTemplateSABPPP implements ScriptTemplate {
|
|
|
3750
3558
|
|
|
3751
3559
|
See also: [ScriptTemplateParamsSABPPP](#interface-scripttemplateparamssabppp)
|
|
3752
3560
|
|
|
3753
|
-
<details>
|
|
3754
|
-
|
|
3755
|
-
<summary>Class ScriptTemplateSABPPP Details</summary>
|
|
3756
|
-
|
|
3757
3561
|
###### Property unlockLength
|
|
3758
3562
|
|
|
3759
3563
|
P2PKH unlock estimateLength is a constant
|
|
@@ -3762,8 +3566,6 @@ P2PKH unlock estimateLength is a constant
|
|
|
3762
3566
|
unlockLength = 108
|
|
3763
3567
|
```
|
|
3764
3568
|
|
|
3765
|
-
</details>
|
|
3766
|
-
|
|
3767
3569
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3768
3570
|
|
|
3769
3571
|
---
|
|
@@ -3838,10 +3640,6 @@ export class Services implements sdk.WalletServices {
|
|
|
3838
3640
|
|
|
3839
3641
|
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)
|
|
3840
3642
|
|
|
3841
|
-
<details>
|
|
3842
|
-
|
|
3843
|
-
<summary>Class Services Details</summary>
|
|
3844
|
-
|
|
3845
3643
|
###### Method postTxs
|
|
3846
3644
|
|
|
3847
3645
|
The beef must contain at least each rawTx for each txid.
|
|
@@ -3853,8 +3651,6 @@ async postTxs(beef: Beef, txids: string[]): Promise<sdk.PostTxsResult[]>
|
|
|
3853
3651
|
```
|
|
3854
3652
|
See also: [PostTxsResult](#interface-posttxsresult)
|
|
3855
3653
|
|
|
3856
|
-
</details>
|
|
3857
|
-
|
|
3858
3654
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
3859
3655
|
|
|
3860
3656
|
---
|
|
@@ -3966,10 +3762,6 @@ export abstract class SetupClient {
|
|
|
3966
3762
|
|
|
3967
3763
|
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)
|
|
3968
3764
|
|
|
3969
|
-
<details>
|
|
3970
|
-
|
|
3971
|
-
<summary>Class SetupClient Details</summary>
|
|
3972
|
-
|
|
3973
3765
|
###### Method createWallet
|
|
3974
3766
|
|
|
3975
3767
|
Create a `Wallet`. Storage can optionally be provided or configured later.
|
|
@@ -4056,8 +3848,6 @@ Private keys should never be included directly in your source code.
|
|
|
4056
3848
|
static makeEnv(): string
|
|
4057
3849
|
```
|
|
4058
3850
|
|
|
4059
|
-
</details>
|
|
4060
|
-
|
|
4061
3851
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4062
3852
|
|
|
4063
3853
|
---
|
|
@@ -4173,10 +3963,6 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
|
|
|
4173
3963
|
|
|
4174
3964
|
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)
|
|
4175
3965
|
|
|
4176
|
-
<details>
|
|
4177
|
-
|
|
4178
|
-
<summary>Class StorageProvider Details</summary>
|
|
4179
|
-
|
|
4180
3966
|
###### Method confirmSpendableOutputs
|
|
4181
3967
|
|
|
4182
3968
|
For each spendable output in the 'default' basket of the authenticated user,
|
|
@@ -4249,8 +4035,6 @@ async updateTransactionStatus(status: sdk.TransactionStatus, transactionId?: num
|
|
|
4249
4035
|
```
|
|
4250
4036
|
See also: [TransactionStatus](#type-transactionstatus), [TrxToken](#interface-trxtoken)
|
|
4251
4037
|
|
|
4252
|
-
</details>
|
|
4253
|
-
|
|
4254
4038
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4255
4039
|
|
|
4256
4040
|
---
|
|
@@ -4319,10 +4103,6 @@ export abstract class StorageReader implements sdk.StorageSyncReader {
|
|
|
4319
4103
|
|
|
4320
4104
|
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)
|
|
4321
4105
|
|
|
4322
|
-
<details>
|
|
4323
|
-
|
|
4324
|
-
<summary>Class StorageReader Details</summary>
|
|
4325
|
-
|
|
4326
4106
|
###### Method validateEntityDate
|
|
4327
4107
|
|
|
4328
4108
|
Force dates to strings on SQLite and Date objects on MySQL
|
|
@@ -4342,8 +4122,6 @@ Argument Details
|
|
|
4342
4122
|
+ **useNowAsDefault**
|
|
4343
4123
|
+ if true and date is null or undefiend, set to current time.
|
|
4344
4124
|
|
|
4345
|
-
</details>
|
|
4346
|
-
|
|
4347
4125
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4348
4126
|
|
|
4349
4127
|
---
|
|
@@ -4508,10 +4286,6 @@ export class TaskCheckForProofs extends WalletMonitorTask {
|
|
|
4508
4286
|
|
|
4509
4287
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4510
4288
|
|
|
4511
|
-
<details>
|
|
4512
|
-
|
|
4513
|
-
<summary>Class TaskCheckForProofs Details</summary>
|
|
4514
|
-
|
|
4515
4289
|
###### Property checkNow
|
|
4516
4290
|
|
|
4517
4291
|
An external service such as the chaintracks new block header
|
|
@@ -4556,8 +4330,6 @@ trigger(nowMsecsSinceEpoch: number): {
|
|
|
4556
4330
|
}
|
|
4557
4331
|
```
|
|
4558
4332
|
|
|
4559
|
-
</details>
|
|
4560
|
-
|
|
4561
4333
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4562
4334
|
|
|
4563
4335
|
---
|
|
@@ -4642,10 +4414,6 @@ export class TaskPurge extends WalletMonitorTask {
|
|
|
4642
4414
|
|
|
4643
4415
|
See also: [Monitor](#class-monitor), [TaskPurgeParams](#interface-taskpurgeparams), [WalletMonitorTask](#class-walletmonitortask)
|
|
4644
4416
|
|
|
4645
|
-
<details>
|
|
4646
|
-
|
|
4647
|
-
<summary>Class TaskPurge Details</summary>
|
|
4648
|
-
|
|
4649
4417
|
###### Property checkNow
|
|
4650
4418
|
|
|
4651
4419
|
Set to true to trigger running this task
|
|
@@ -4654,8 +4422,6 @@ Set to true to trigger running this task
|
|
|
4654
4422
|
static checkNow = false
|
|
4655
4423
|
```
|
|
4656
4424
|
|
|
4657
|
-
</details>
|
|
4658
|
-
|
|
4659
4425
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4660
4426
|
|
|
4661
4427
|
---
|
|
@@ -4683,10 +4449,6 @@ export class TaskReviewStatus extends WalletMonitorTask {
|
|
|
4683
4449
|
|
|
4684
4450
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4685
4451
|
|
|
4686
|
-
<details>
|
|
4687
|
-
|
|
4688
|
-
<summary>Class TaskReviewStatus Details</summary>
|
|
4689
|
-
|
|
4690
4452
|
###### Property checkNow
|
|
4691
4453
|
|
|
4692
4454
|
Set to true to trigger running this task
|
|
@@ -4695,8 +4457,6 @@ Set to true to trigger running this task
|
|
|
4695
4457
|
static checkNow = false
|
|
4696
4458
|
```
|
|
4697
4459
|
|
|
4698
|
-
</details>
|
|
4699
|
-
|
|
4700
4460
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4701
4461
|
|
|
4702
4462
|
---
|
|
@@ -4716,10 +4476,6 @@ export class TaskSendWaiting extends WalletMonitorTask {
|
|
|
4716
4476
|
|
|
4717
4477
|
See also: [Monitor](#class-monitor), [WalletMonitorTask](#class-walletmonitortask)
|
|
4718
4478
|
|
|
4719
|
-
<details>
|
|
4720
|
-
|
|
4721
|
-
<summary>Class TaskSendWaiting Details</summary>
|
|
4722
|
-
|
|
4723
4479
|
###### Method processUnsent
|
|
4724
4480
|
|
|
4725
4481
|
Process an array of 'unsent' status table.ProvenTxReq
|
|
@@ -4740,8 +4496,6 @@ Increments attempts if sending was attempted.
|
|
|
4740
4496
|
async processUnsent(reqApis: table.ProvenTxReq[], indent = 0): Promise<string>
|
|
4741
4497
|
```
|
|
4742
4498
|
|
|
4743
|
-
</details>
|
|
4744
|
-
|
|
4745
4499
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4746
4500
|
|
|
4747
4501
|
---
|
|
@@ -4793,10 +4547,6 @@ export class WERR_INSUFFICIENT_FUNDS extends WalletError {
|
|
|
4793
4547
|
|
|
4794
4548
|
See also: [WalletError](#class-walleterror)
|
|
4795
4549
|
|
|
4796
|
-
<details>
|
|
4797
|
-
|
|
4798
|
-
<summary>Class WERR_INSUFFICIENT_FUNDS Details</summary>
|
|
4799
|
-
|
|
4800
4550
|
###### Constructor
|
|
4801
4551
|
|
|
4802
4552
|
```ts
|
|
@@ -4810,8 +4560,6 @@ Argument Details
|
|
|
4810
4560
|
+ **moreSatoshisNeeded**
|
|
4811
4561
|
+ Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
|
|
4812
4562
|
|
|
4813
|
-
</details>
|
|
4814
|
-
|
|
4815
4563
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4816
4564
|
|
|
4817
4565
|
---
|
|
@@ -4876,10 +4624,6 @@ export class WERR_INVALID_PUBLIC_KEY extends WalletError {
|
|
|
4876
4624
|
|
|
4877
4625
|
See also: [WalletError](#class-walleterror)
|
|
4878
4626
|
|
|
4879
|
-
<details>
|
|
4880
|
-
|
|
4881
|
-
<summary>Class WERR_INVALID_PUBLIC_KEY Details</summary>
|
|
4882
|
-
|
|
4883
4627
|
###### Constructor
|
|
4884
4628
|
|
|
4885
4629
|
```ts
|
|
@@ -4893,8 +4637,6 @@ Argument Details
|
|
|
4893
4637
|
+ **environment**
|
|
4894
4638
|
+ Optional environment flag to control whether the key is included in the message.
|
|
4895
4639
|
|
|
4896
|
-
</details>
|
|
4897
|
-
|
|
4898
4640
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
4899
4641
|
|
|
4900
4642
|
---
|
|
@@ -5033,10 +4775,6 @@ export class Wallet implements WalletInterface, ProtoWallet {
|
|
|
5033
4775
|
|
|
5034
4776
|
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)
|
|
5035
4777
|
|
|
5036
|
-
<details>
|
|
5037
|
-
|
|
5038
|
-
<summary>Class Wallet Details</summary>
|
|
5039
|
-
|
|
5040
4778
|
###### Property beef
|
|
5041
4779
|
|
|
5042
4780
|
The wallet creates a `BeefParty` when it is created.
|
|
@@ -5075,8 +4813,6 @@ Argument Details
|
|
|
5075
4813
|
+ **newKnownTxids**
|
|
5076
4814
|
+ Optional. Additional new txids known to be valid by the caller to be merged.
|
|
5077
4815
|
|
|
5078
|
-
</details>
|
|
5079
|
-
|
|
5080
4816
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5081
4817
|
|
|
5082
4818
|
---
|
|
@@ -5112,10 +4848,6 @@ export class WalletError extends Error implements WalletErrorObject {
|
|
|
5112
4848
|
}
|
|
5113
4849
|
```
|
|
5114
4850
|
|
|
5115
|
-
<details>
|
|
5116
|
-
|
|
5117
|
-
<summary>Class WalletError Details</summary>
|
|
5118
|
-
|
|
5119
4851
|
###### Method asStatus
|
|
5120
4852
|
|
|
5121
4853
|
```ts
|
|
@@ -5139,8 +4871,6 @@ static fromUnknown(err: unknown): WalletError
|
|
|
5139
4871
|
```
|
|
5140
4872
|
See also: [WalletError](#class-walleterror)
|
|
5141
4873
|
|
|
5142
|
-
</details>
|
|
5143
|
-
|
|
5144
4874
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5145
4875
|
|
|
5146
4876
|
---
|
|
@@ -5175,10 +4905,6 @@ export abstract class WalletMonitorTask {
|
|
|
5175
4905
|
|
|
5176
4906
|
See also: [Monitor](#class-monitor), [MonitorStorage](#type-monitorstorage)
|
|
5177
4907
|
|
|
5178
|
-
<details>
|
|
5179
|
-
|
|
5180
|
-
<summary>Class WalletMonitorTask Details</summary>
|
|
5181
|
-
|
|
5182
4908
|
###### Property lastRunMsecsSinceEpoch
|
|
5183
4909
|
|
|
5184
4910
|
Set by monitor each time runTask completes
|
|
@@ -5207,8 +4933,6 @@ abstract trigger(nowMsecsSinceEpoch: number): {
|
|
|
5207
4933
|
}
|
|
5208
4934
|
```
|
|
5209
4935
|
|
|
5210
|
-
</details>
|
|
5211
|
-
|
|
5212
4936
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5213
4937
|
|
|
5214
4938
|
---
|
|
@@ -5308,10 +5032,6 @@ export class WalletStorageManager implements sdk.WalletStorage {
|
|
|
5308
5032
|
|
|
5309
5033
|
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)
|
|
5310
5034
|
|
|
5311
|
-
<details>
|
|
5312
|
-
|
|
5313
|
-
<summary>Class WalletStorageManager Details</summary>
|
|
5314
|
-
|
|
5315
5035
|
###### Property _isSingleWriter
|
|
5316
5036
|
|
|
5317
5037
|
if true, allow only a single writer to proceed at a time.
|
|
@@ -5376,8 +5096,6 @@ Argument Details
|
|
|
5376
5096
|
+ **storageIdentityKey**
|
|
5377
5097
|
+ of current backup storage provider that is to become the new active provider.
|
|
5378
5098
|
|
|
5379
|
-
</details>
|
|
5380
|
-
|
|
5381
5099
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5382
5100
|
|
|
5383
5101
|
---
|
|
@@ -5465,17 +5183,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5465
5183
|
export function asBsvSdkPrivateKey(privKey: string): PrivateKey
|
|
5466
5184
|
```
|
|
5467
5185
|
|
|
5468
|
-
<details>
|
|
5469
|
-
|
|
5470
|
-
<summary>Function asBsvSdkPrivateKey Details</summary>
|
|
5471
|
-
|
|
5472
5186
|
Argument Details
|
|
5473
5187
|
|
|
5474
5188
|
+ **privKey**
|
|
5475
5189
|
+ bitcoin private key in 32 byte hex string form
|
|
5476
5190
|
|
|
5477
|
-
</details>
|
|
5478
|
-
|
|
5479
5191
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5480
5192
|
|
|
5481
5193
|
---
|
|
@@ -5485,17 +5197,11 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
5485
5197
|
export function asBsvSdkPublickKey(pubKey: string): PublicKey
|
|
5486
5198
|
```
|
|
5487
5199
|
|
|
5488
|
-
<details>
|
|
5489
|
-
|
|
5490
|
-
<summary>Function asBsvSdkPublickKey Details</summary>
|
|
5491
|
-
|
|
5492
5200
|
Argument Details
|
|
5493
5201
|
|
|
5494
5202
|
+ **pubKey**
|
|
5495
5203
|
+ bitcoin public key in standard compressed key hex string form
|
|
5496
5204
|
|
|
5497
|
-
</details>
|
|
5498
|
-
|
|
5499
5205
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5500
5206
|
|
|
5501
5207
|
---
|
|
@@ -5551,10 +5257,6 @@ export function asString(val: string | number[]): string {
|
|
|
5551
5257
|
}
|
|
5552
5258
|
```
|
|
5553
5259
|
|
|
5554
|
-
<details>
|
|
5555
|
-
|
|
5556
|
-
<summary>Function asString Details</summary>
|
|
5557
|
-
|
|
5558
5260
|
Returns
|
|
5559
5261
|
|
|
5560
5262
|
input val if it is a string; or if number[], converts byte values to hex
|
|
@@ -5564,8 +5266,6 @@ Argument Details
|
|
|
5564
5266
|
+ **val**
|
|
5565
5267
|
+ string or number[]. If string, encoding must be hex. If number[], each value must be 0..255.
|
|
5566
5268
|
|
|
5567
|
-
</details>
|
|
5568
|
-
|
|
5569
5269
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5570
5270
|
|
|
5571
5271
|
---
|
|
@@ -5673,10 +5373,6 @@ export function doubleSha256BE(data: number[]): number[] {
|
|
|
5673
5373
|
|
|
5674
5374
|
See also: [doubleSha256HashLE](#function-doublesha256hashle)
|
|
5675
5375
|
|
|
5676
|
-
<details>
|
|
5677
|
-
|
|
5678
|
-
<summary>Function doubleSha256BE Details</summary>
|
|
5679
|
-
|
|
5680
5376
|
Returns
|
|
5681
5377
|
|
|
5682
5378
|
reversed (big-endian) double sha256 hash of data, byte 31 of hash first.
|
|
@@ -5686,8 +5382,6 @@ Argument Details
|
|
|
5686
5382
|
+ **data**
|
|
5687
5383
|
+ is an array of bytes.
|
|
5688
5384
|
|
|
5689
|
-
</details>
|
|
5690
|
-
|
|
5691
5385
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5692
5386
|
|
|
5693
5387
|
---
|
|
@@ -5703,10 +5397,6 @@ export function doubleSha256HashLE(data: number[]): number[] {
|
|
|
5703
5397
|
}
|
|
5704
5398
|
```
|
|
5705
5399
|
|
|
5706
|
-
<details>
|
|
5707
|
-
|
|
5708
|
-
<summary>Function doubleSha256HashLE Details</summary>
|
|
5709
|
-
|
|
5710
5400
|
Returns
|
|
5711
5401
|
|
|
5712
5402
|
double sha256 hash of data, byte 0 of hash first.
|
|
@@ -5716,8 +5406,6 @@ Argument Details
|
|
|
5716
5406
|
+ **data**
|
|
5717
5407
|
+ an array of bytes
|
|
5718
5408
|
|
|
5719
|
-
</details>
|
|
5720
|
-
|
|
5721
5409
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5722
5410
|
|
|
5723
5411
|
---
|
|
@@ -5774,10 +5462,6 @@ export async function getBeefForTransaction(storage: StorageProvider, txid: stri
|
|
|
5774
5462
|
|
|
5775
5463
|
See also: [StorageGetBeefOptions](#interface-storagegetbeefoptions), [StorageProvider](#class-storageprovider)
|
|
5776
5464
|
|
|
5777
|
-
<details>
|
|
5778
|
-
|
|
5779
|
-
<summary>Function getBeefForTransaction Details</summary>
|
|
5780
|
-
|
|
5781
5465
|
Argument Details
|
|
5782
5466
|
|
|
5783
5467
|
+ **storage**
|
|
@@ -5785,8 +5469,6 @@ Argument Details
|
|
|
5785
5469
|
+ **txid**
|
|
5786
5470
|
+ the transaction hash for which an envelope is requested.
|
|
5787
5471
|
|
|
5788
|
-
</details>
|
|
5789
|
-
|
|
5790
5472
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
5791
5473
|
|
|
5792
5474
|
---
|
|
@@ -6146,17 +5828,11 @@ export async function postTxsToTaalArcMiner(beef: Beef, txids: string[], config:
|
|
|
6146
5828
|
|
|
6147
5829
|
See also: [ArcServiceConfig](#interface-arcserviceconfig), [PostTxsResult](#interface-posttxsresult), [WalletServices](#interface-walletservices)
|
|
6148
5830
|
|
|
6149
|
-
<details>
|
|
6150
|
-
|
|
6151
|
-
<summary>Function postTxsToTaalArcMiner Details</summary>
|
|
6152
|
-
|
|
6153
5831
|
Argument Details
|
|
6154
5832
|
|
|
6155
5833
|
+ **txs**
|
|
6156
5834
|
+ All transactions must have source transactions. Will just source locking scripts and satoshis do?? toHexEF() is used.
|
|
6157
5835
|
|
|
6158
|
-
</details>
|
|
6159
|
-
|
|
6160
5836
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6161
5837
|
|
|
6162
5838
|
---
|
|
@@ -6199,16 +5875,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6199
5875
|
export function randomBytes(count: number): number[]
|
|
6200
5876
|
```
|
|
6201
5877
|
|
|
6202
|
-
<details>
|
|
6203
|
-
|
|
6204
|
-
<summary>Function randomBytes Details</summary>
|
|
6205
|
-
|
|
6206
5878
|
Returns
|
|
6207
5879
|
|
|
6208
5880
|
count cryptographically secure random bytes as array of bytes
|
|
6209
5881
|
|
|
6210
|
-
</details>
|
|
6211
|
-
|
|
6212
5882
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6213
5883
|
|
|
6214
5884
|
---
|
|
@@ -6218,16 +5888,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6218
5888
|
export function randomBytesBase64(count: number): string
|
|
6219
5889
|
```
|
|
6220
5890
|
|
|
6221
|
-
<details>
|
|
6222
|
-
|
|
6223
|
-
<summary>Function randomBytesBase64 Details</summary>
|
|
6224
|
-
|
|
6225
5891
|
Returns
|
|
6226
5892
|
|
|
6227
5893
|
count cryptographically secure random bytes as base64 encoded string
|
|
6228
5894
|
|
|
6229
|
-
</details>
|
|
6230
|
-
|
|
6231
5895
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6232
5896
|
|
|
6233
5897
|
---
|
|
@@ -6237,16 +5901,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6237
5901
|
export function randomBytesHex(count: number): string
|
|
6238
5902
|
```
|
|
6239
5903
|
|
|
6240
|
-
<details>
|
|
6241
|
-
|
|
6242
|
-
<summary>Function randomBytesHex Details</summary>
|
|
6243
|
-
|
|
6244
5904
|
Returns
|
|
6245
5905
|
|
|
6246
5906
|
count cryptographically secure random bytes as hex encoded string
|
|
6247
5907
|
|
|
6248
|
-
</details>
|
|
6249
|
-
|
|
6250
5908
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6251
5909
|
|
|
6252
5910
|
---
|
|
@@ -6261,16 +5919,10 @@ export function sha256Hash(data: number[]): number[] {
|
|
|
6261
5919
|
}
|
|
6262
5920
|
```
|
|
6263
5921
|
|
|
6264
|
-
<details>
|
|
6265
|
-
|
|
6266
|
-
<summary>Function sha256Hash Details</summary>
|
|
6267
|
-
|
|
6268
5922
|
Returns
|
|
6269
5923
|
|
|
6270
5924
|
sha256 hash of buffer contents.
|
|
6271
5925
|
|
|
6272
|
-
</details>
|
|
6273
|
-
|
|
6274
5926
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6275
5927
|
|
|
6276
5928
|
---
|
|
@@ -6295,10 +5947,6 @@ export function stampLog(log: string | undefined | {
|
|
|
6295
5947
|
}, lineToAdd: string): string | undefined
|
|
6296
5948
|
```
|
|
6297
5949
|
|
|
6298
|
-
<details>
|
|
6299
|
-
|
|
6300
|
-
<summary>Function stampLog Details</summary>
|
|
6301
|
-
|
|
6302
5950
|
Returns
|
|
6303
5951
|
|
|
6304
5952
|
undefined or log extended by time stamped `lineToAdd` and new line.
|
|
@@ -6310,8 +5958,6 @@ Argument Details
|
|
|
6310
5958
|
+ **lineToAdd**
|
|
6311
5959
|
+ Content to add to line.
|
|
6312
5960
|
|
|
6313
|
-
</details>
|
|
6314
|
-
|
|
6315
5961
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6316
5962
|
|
|
6317
5963
|
---
|
|
@@ -6325,10 +5971,6 @@ Assumes log built by repeated calls to `stampLog`
|
|
|
6325
5971
|
export function stampLogFormat(log?: string): string
|
|
6326
5972
|
```
|
|
6327
5973
|
|
|
6328
|
-
<details>
|
|
6329
|
-
|
|
6330
|
-
<summary>Function stampLogFormat Details</summary>
|
|
6331
|
-
|
|
6332
5974
|
Returns
|
|
6333
5975
|
|
|
6334
5976
|
reformated multi-line event log
|
|
@@ -6338,8 +5980,6 @@ Argument Details
|
|
|
6338
5980
|
+ **log**
|
|
6339
5981
|
+ Each logged event starts with ISO time stamp, space, rest of line, terminated by `\n`.
|
|
6340
5982
|
|
|
6341
|
-
</details>
|
|
6342
|
-
|
|
6343
5983
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6344
5984
|
|
|
6345
5985
|
---
|
|
@@ -6366,16 +6006,10 @@ export function toBinaryBaseBlockHeader(header: sdk.BaseBlockHeader): number[] {
|
|
|
6366
6006
|
|
|
6367
6007
|
See also: [BaseBlockHeader](#interface-baseblockheader), [asArray](#function-asarray)
|
|
6368
6008
|
|
|
6369
|
-
<details>
|
|
6370
|
-
|
|
6371
|
-
<summary>Function toBinaryBaseBlockHeader Details</summary>
|
|
6372
|
-
|
|
6373
6009
|
Returns
|
|
6374
6010
|
|
|
6375
6011
|
80 byte array
|
|
6376
6012
|
|
|
6377
|
-
</details>
|
|
6378
|
-
|
|
6379
6013
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6380
6014
|
|
|
6381
6015
|
---
|
|
@@ -6396,10 +6030,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6396
6030
|
export function transactionInputSize(scriptSize: number): number
|
|
6397
6031
|
```
|
|
6398
6032
|
|
|
6399
|
-
<details>
|
|
6400
|
-
|
|
6401
|
-
<summary>Function transactionInputSize Details</summary>
|
|
6402
|
-
|
|
6403
6033
|
Returns
|
|
6404
6034
|
|
|
6405
6035
|
serialized byte length a transaction input
|
|
@@ -6409,8 +6039,6 @@ Argument Details
|
|
|
6409
6039
|
+ **scriptSize**
|
|
6410
6040
|
+ byte length of input script
|
|
6411
6041
|
|
|
6412
|
-
</details>
|
|
6413
|
-
|
|
6414
6042
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6415
6043
|
|
|
6416
6044
|
---
|
|
@@ -6420,10 +6048,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
|
|
|
6420
6048
|
export function transactionOutputSize(scriptSize: number): number
|
|
6421
6049
|
```
|
|
6422
6050
|
|
|
6423
|
-
<details>
|
|
6424
|
-
|
|
6425
|
-
<summary>Function transactionOutputSize Details</summary>
|
|
6426
|
-
|
|
6427
6051
|
Returns
|
|
6428
6052
|
|
|
6429
6053
|
serialized byte length a transaction output
|
|
@@ -6433,8 +6057,6 @@ Argument Details
|
|
|
6433
6057
|
+ **scriptSize**
|
|
6434
6058
|
+ byte length of output script
|
|
6435
6059
|
|
|
6436
|
-
</details>
|
|
6437
|
-
|
|
6438
6060
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6439
6061
|
|
|
6440
6062
|
---
|
|
@@ -6448,10 +6070,6 @@ and the size of each script.
|
|
|
6448
6070
|
export function transactionSize(inputs: number[], outputs: number[]): number
|
|
6449
6071
|
```
|
|
6450
6072
|
|
|
6451
|
-
<details>
|
|
6452
|
-
|
|
6453
|
-
<summary>Function transactionSize Details</summary>
|
|
6454
|
-
|
|
6455
6073
|
Returns
|
|
6456
6074
|
|
|
6457
6075
|
total transaction size in bytes
|
|
@@ -6463,8 +6081,6 @@ Argument Details
|
|
|
6463
6081
|
+ **outputs**
|
|
6464
6082
|
+ array of output script lengths, in bytes
|
|
6465
6083
|
|
|
6466
|
-
</details>
|
|
6467
|
-
|
|
6468
6084
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6469
6085
|
|
|
6470
6086
|
---
|
|
@@ -6520,17 +6136,11 @@ export async function validateAcquireCertificateArgs(args: AcquireCertificateArg
|
|
|
6520
6136
|
|
|
6521
6137
|
See also: [ValidAcquireCertificateArgs](#interface-validacquirecertificateargs)
|
|
6522
6138
|
|
|
6523
|
-
<details>
|
|
6524
|
-
|
|
6525
|
-
<summary>Function validateAcquireCertificateArgs Details</summary>
|
|
6526
|
-
|
|
6527
6139
|
Argument Details
|
|
6528
6140
|
|
|
6529
6141
|
+ **subject**
|
|
6530
6142
|
+ Must be valid for "direct" `acquisitionProtocol`. public key of the certificate subject.
|
|
6531
6143
|
|
|
6532
|
-
</details>
|
|
6533
|
-
|
|
6534
6144
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6535
6145
|
|
|
6536
6146
|
---
|
|
@@ -6702,10 +6312,6 @@ export function validateListActionsArgs(args: ListActionsArgs): ValidListActions
|
|
|
6702
6312
|
|
|
6703
6313
|
See also: [ValidListActionsArgs](#interface-validlistactionsargs)
|
|
6704
6314
|
|
|
6705
|
-
<details>
|
|
6706
|
-
|
|
6707
|
-
<summary>Function validateListActionsArgs Details</summary>
|
|
6708
|
-
|
|
6709
6315
|
Argument Details
|
|
6710
6316
|
|
|
6711
6317
|
+ **args.labels**
|
|
@@ -6731,8 +6337,6 @@ Argument Details
|
|
|
6731
6337
|
+ **args.seekPermission**
|
|
6732
6338
|
+ — 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.
|
|
6733
6339
|
|
|
6734
|
-
</details>
|
|
6735
|
-
|
|
6736
6340
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6737
6341
|
|
|
6738
6342
|
---
|
|
@@ -6755,10 +6359,6 @@ export function validateListOutputsArgs(args: ListOutputsArgs): ValidListOutputs
|
|
|
6755
6359
|
|
|
6756
6360
|
See also: [ValidListOutputsArgs](#interface-validlistoutputsargs)
|
|
6757
6361
|
|
|
6758
|
-
<details>
|
|
6759
|
-
|
|
6760
|
-
<summary>Function validateListOutputsArgs Details</summary>
|
|
6761
|
-
|
|
6762
6362
|
Argument Details
|
|
6763
6363
|
|
|
6764
6364
|
+ **args.basket**
|
|
@@ -6784,8 +6384,6 @@ Argument Details
|
|
|
6784
6384
|
+ **args.seekPermission**
|
|
6785
6385
|
+ — 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.
|
|
6786
6386
|
|
|
6787
|
-
</details>
|
|
6788
|
-
|
|
6789
6387
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
6790
6388
|
|
|
6791
6389
|
---
|
|
@@ -7031,10 +6629,6 @@ Helper function.
|
|
|
7031
6629
|
export function verifyOne<T>(results: T[], errorDescrition?: string): T
|
|
7032
6630
|
```
|
|
7033
6631
|
|
|
7034
|
-
<details>
|
|
7035
|
-
|
|
7036
|
-
<summary>Function verifyOne Details</summary>
|
|
7037
|
-
|
|
7038
6632
|
Returns
|
|
7039
6633
|
|
|
7040
6634
|
results[0].
|
|
@@ -7043,8 +6637,6 @@ Throws
|
|
|
7043
6637
|
|
|
7044
6638
|
WERR_BAD_REQUEST if results has length other than one.
|
|
7045
6639
|
|
|
7046
|
-
</details>
|
|
7047
|
-
|
|
7048
6640
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7049
6641
|
|
|
7050
6642
|
---
|
|
@@ -7056,10 +6648,6 @@ Helper function.
|
|
|
7056
6648
|
export function verifyOneOrNone<T>(results: T[]): T | undefined
|
|
7057
6649
|
```
|
|
7058
6650
|
|
|
7059
|
-
<details>
|
|
7060
|
-
|
|
7061
|
-
<summary>Function verifyOneOrNone Details</summary>
|
|
7062
|
-
|
|
7063
6651
|
Returns
|
|
7064
6652
|
|
|
7065
6653
|
results[0] or undefined if length is zero.
|
|
@@ -7068,8 +6656,6 @@ Throws
|
|
|
7068
6656
|
|
|
7069
6657
|
WERR_BAD_REQUEST if results has length greater than one.
|
|
7070
6658
|
|
|
7071
|
-
</details>
|
|
7072
|
-
|
|
7073
6659
|
Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
|
|
7074
6660
|
|
|
7075
6661
|
---
|