beignet 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -1
- package/dist/electrum/index.js +4 -4
- package/dist/electrum/index.js.map +1 -1
- package/dist/types/electrum/index.d.ts +3 -3
- package/dist/types/electrum.js +7 -1
- package/dist/types/electrum.js.map +1 -1
- package/dist/types/types/electrum.d.ts +6 -1
- package/dist/types/types/wallet.d.ts +3 -3
- package/dist/types/wallet/index.d.ts +1 -1
- package/dist/wallet/index.js.map +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/Electrum.html +46 -44
- package/docs/html/classes/Transaction.html +26 -24
- package/docs/html/classes/Wallet.html +222 -128
- package/docs/html/enums/EAddressType.html +6 -4
- package/docs/html/enums/EAvailableNetworks.html +10 -8
- package/docs/html/enums/EBoostType.html +5 -3
- package/docs/html/enums/EElectrumNetworks.html +229 -0
- package/docs/html/enums/EFeeId.html +8 -6
- package/docs/html/enums/EPaymentType.html +5 -3
- package/docs/html/enums/EProtocol.html +5 -3
- package/docs/html/enums/EUnit.html +6 -4
- package/docs/html/functions/availableNetworks.html +3 -1
- package/docs/html/functions/constructByteCountParam.html +3 -1
- package/docs/html/functions/decodeOpReturnMessage.html +3 -1
- package/docs/html/functions/decodeRawTransaction.html +3 -1
- package/docs/html/functions/err.html +3 -1
- package/docs/html/functions/formatKeyDerivationPath.html +3 -1
- package/docs/html/functions/formatPeerData.html +3 -1
- package/docs/html/functions/generateMnemonic.html +3 -1
- package/docs/html/functions/generateWalletId.html +3 -1
- package/docs/html/functions/getAddressFromScriptPubKey.html +3 -1
- package/docs/html/functions/getAddressTypeFromPath.html +3 -1
- package/docs/html/functions/getByteCount.html +7 -3
- package/docs/html/functions/getDataFallback.html +3 -1
- package/docs/html/functions/getDefaultPort.html +3 -1
- package/docs/html/functions/getDefaultWalletData.html +3 -1
- package/docs/html/functions/getDefaultWalletDataKeys.html +3 -1
- package/docs/html/functions/getExchangeRates.html +3 -1
- package/docs/html/functions/getHighestUsedIndexFromTxHashes.html +3 -1
- package/docs/html/functions/getKeyDerivationPath.html +3 -1
- package/docs/html/functions/getKeyDerivationPathObject.html +3 -1
- package/docs/html/functions/getKeyDerivationPathString.html +3 -1
- package/docs/html/functions/getKeyValue.html +3 -1
- package/docs/html/functions/getPeers.html +3 -1
- package/docs/html/functions/getProtocolForPort.html +3 -1
- package/docs/html/functions/getScriptHash.html +3 -1
- package/docs/html/functions/getSeed.html +3 -1
- package/docs/html/functions/getSeedHash.html +3 -1
- package/docs/html/functions/getSha256.html +3 -1
- package/docs/html/functions/getStorageKeyValues.html +3 -1
- package/docs/html/functions/getTxFee.html +3 -1
- package/docs/html/functions/getWalletDataStorageKey.html +3 -1
- package/docs/html/functions/isValidBech32mEncodedString.html +3 -1
- package/docs/html/functions/objectKeys-1.html +3 -1
- package/docs/html/functions/objectsMatch.html +3 -1
- package/docs/html/functions/ok.html +3 -1
- package/docs/html/functions/parseOnChainPaymentRequest.html +3 -1
- package/docs/html/functions/reduceValue.html +3 -1
- package/docs/html/functions/removeDustOutputs.html +3 -1
- package/docs/html/functions/setReplaceByFee.html +3 -1
- package/docs/html/functions/shuffleArray.html +3 -1
- package/docs/html/functions/validateAddress.html +3 -1
- package/docs/html/functions/validateMnemonic.html +3 -1
- package/docs/html/functions/validateTransaction.html +3 -1
- package/docs/html/index.html +4 -0
- package/docs/html/interfaces/IAddInput.html +6 -4
- package/docs/html/interfaces/IAddress.html +8 -6
- package/docs/html/interfaces/IAddressData.html +6 -4
- package/docs/html/interfaces/IAddressType.html +3 -1
- package/docs/html/interfaces/IAddressTypeData.html +9 -7
- package/docs/html/interfaces/IAddresses.html +3 -1
- package/docs/html/interfaces/IBoostedTransaction.html +7 -5
- package/docs/html/interfaces/IBoostedTransactions.html +3 -1
- package/docs/html/interfaces/ICreateTransaction.html +5 -3
- package/docs/html/interfaces/ICustomGetAddress.html +9 -7
- package/docs/html/interfaces/ICustomGetScriptHash.html +8 -6
- package/docs/html/interfaces/IElectrumGetAddressBalanceRes.html +6 -4
- package/docs/html/interfaces/IExchangeRates.html +3 -1
- package/docs/html/interfaces/IFormattedPeerData.html +8 -6
- package/docs/html/interfaces/IFormattedTransaction.html +22 -20
- package/docs/html/interfaces/IFormattedTransactions.html +3 -1
- package/docs/html/interfaces/IGenerateAddresses.html +17 -8
- package/docs/html/interfaces/IGenerateAddressesResponse.html +5 -3
- package/docs/html/interfaces/IGetAddress.html +6 -4
- package/docs/html/interfaces/IGetAddressBalanceRes.html +5 -3
- package/docs/html/interfaces/IGetAddressByPath.html +5 -3
- package/docs/html/interfaces/IGetAddressHistoryResponse.html +10 -8
- package/docs/html/interfaces/IGetAddressResponse.html +6 -4
- package/docs/html/interfaces/IGetAddressScriptHashBalances.html +247 -0
- package/docs/html/interfaces/IGetAddressScriptHashesHistoryResponse.html +8 -6
- package/docs/html/interfaces/IGetDerivationPath.html +9 -7
- package/docs/html/interfaces/IGetFeeEstimatesResponse.html +7 -5
- package/docs/html/interfaces/IGetHeaderResponse.html +8 -6
- package/docs/html/interfaces/IGetNextAvailableAddressResponse.html +7 -5
- package/docs/html/interfaces/IGetTransactions.html +8 -6
- package/docs/html/interfaces/IGetTransactionsFromInputs.html +8 -6
- package/docs/html/interfaces/IGetUtxosResponse.html +5 -3
- package/docs/html/interfaces/IHeader.html +6 -4
- package/docs/html/interfaces/IIndexes.html +7 -5
- package/docs/html/interfaces/IKeyDerivationPath.html +8 -6
- package/docs/html/interfaces/IKeyDerivationPathData.html +5 -3
- package/docs/html/interfaces/INewBlock.html +5 -3
- package/docs/html/interfaces/IOnchainFees.html +8 -6
- package/docs/html/interfaces/IOutput.html +6 -4
- package/docs/html/interfaces/IPeerData.html +6 -4
- package/docs/html/interfaces/IRbfData.html +9 -7
- package/docs/html/interfaces/ISend.html +5 -3
- package/docs/html/interfaces/ISendTransaction.html +19 -17
- package/docs/html/interfaces/ISendTx.html +6 -4
- package/docs/html/interfaces/ISetupTransaction.html +7 -5
- package/docs/html/interfaces/ISubscribeToAddress.html +7 -5
- package/docs/html/interfaces/ISubscribeToHeader.html +7 -5
- package/docs/html/interfaces/ITargets.html +7 -5
- package/docs/html/interfaces/ITransaction.html +8 -6
- package/docs/html/interfaces/ITxHash.html +4 -2
- package/docs/html/interfaces/ITxHashes.html +6 -4
- package/docs/html/interfaces/IUtxo.html +20 -18
- package/docs/html/interfaces/IVin.html +8 -6
- package/docs/html/interfaces/IVout.html +6 -4
- package/docs/html/interfaces/IWallet.html +18 -16
- package/docs/html/interfaces/IWalletData.html +22 -20
- package/docs/html/types/ElectrumConnectionPubSub.html +3 -1
- package/docs/html/types/ElectrumConnectionSubscription.html +4 -2
- package/docs/html/types/InputData.html +3 -1
- package/docs/html/types/ObjectKeys.html +3 -1
- package/docs/html/types/Result.html +3 -1
- package/docs/html/types/TAddressIndexInfo.html +3 -1
- package/docs/html/types/TAddressLabel.html +3 -1
- package/docs/html/types/TAddressType.html +3 -1
- package/docs/html/types/TAddressTypeContent.html +3 -1
- package/docs/html/types/TAddressTypes.html +3 -1
- package/docs/html/types/TAvailableNetworks.html +3 -1
- package/docs/html/types/TConnectToElectrumRes.html +3 -1
- package/docs/html/types/TDecodeRawTx.html +3 -1
- package/docs/html/types/TElectrumNetworks.html +3 -1
- package/docs/html/types/TGetAddressHistory.html +3 -1
- package/docs/html/types/TGetByteCountInput.html +3 -1
- package/docs/html/types/TGetByteCountInputs.html +3 -1
- package/docs/html/types/TGetByteCountOutput.html +3 -1
- package/docs/html/types/TGetByteCountOutputs.html +3 -1
- package/docs/html/types/TGetData.html +3 -1
- package/docs/html/types/TGetTotalFeeObj.html +3 -1
- package/docs/html/types/TKeyDerivationAccount.html +3 -1
- package/docs/html/types/TKeyDerivationChange.html +3 -1
- package/docs/html/types/TKeyDerivationCoinType.html +3 -1
- package/docs/html/types/TKeyDerivationIndex.html +3 -1
- package/docs/html/types/TKeyDerivationPurpose.html +3 -1
- package/docs/html/types/TMessageDataMap.html +3 -1
- package/docs/html/types/TMessageKeys.html +3 -1
- package/docs/html/types/TOnMessage.html +3 -1
- package/docs/html/types/TProcessUnconfirmedTransactions.html +3 -1
- package/docs/html/types/TProtocol.html +3 -1
- package/docs/html/types/TServer.html +3 -1
- package/docs/html/types/TSetData.html +3 -1
- package/docs/html/types/TSetupTransactionResponse.html +3 -1
- package/docs/html/types/TStorage.html +3 -1
- package/docs/html/types/TSubscribedReceive.html +3 -1
- package/docs/html/types/TTransactionMessage.html +3 -1
- package/docs/html/types/TTxResponse.html +3 -1
- package/docs/html/types/TTxResult.html +3 -1
- package/docs/html/types/TUnspentAddressScriptHashData.html +3 -1
- package/docs/html/types/TWalletDataKeys.html +3 -1
- package/docs/html/variables/defaultElectrumPorts.html +3 -1
- package/docs/html/variables/electrumConnection.html +3 -1
- package/docs/html/variables/mostUsedExchangeTickers.html +3 -1
- package/docs/markdown/README.md +154 -151
- package/docs/markdown/classes/Electrum.md +78 -78
- package/docs/markdown/classes/Transaction.md +54 -54
- package/docs/markdown/classes/Wallet.md +351 -245
- package/docs/markdown/enums/EAddressType.md +3 -3
- package/docs/markdown/enums/EAvailableNetworks.md +7 -7
- package/docs/markdown/enums/EBoostType.md +2 -2
- package/docs/markdown/enums/EElectrumNetworks.md +41 -0
- package/docs/markdown/enums/EFeeId.md +5 -5
- package/docs/markdown/enums/EPaymentType.md +2 -2
- package/docs/markdown/enums/EProtocol.md +2 -2
- package/docs/markdown/enums/EUnit.md +3 -3
- package/docs/markdown/interfaces/IAddInput.md +3 -3
- package/docs/markdown/interfaces/IAddress.md +5 -5
- package/docs/markdown/interfaces/IAddressData.md +3 -3
- package/docs/markdown/interfaces/IAddressTypeData.md +6 -6
- package/docs/markdown/interfaces/IBoostedTransaction.md +4 -4
- package/docs/markdown/interfaces/ICreateTransaction.md +2 -2
- package/docs/markdown/interfaces/ICustomGetAddress.md +4 -4
- package/docs/markdown/interfaces/ICustomGetScriptHash.md +3 -3
- package/docs/markdown/interfaces/IElectrumGetAddressBalanceRes.md +3 -3
- package/docs/markdown/interfaces/IExchangeRates.md +1 -1
- package/docs/markdown/interfaces/IFormattedPeerData.md +5 -5
- package/docs/markdown/interfaces/IFormattedTransaction.md +19 -19
- package/docs/markdown/interfaces/IGenerateAddresses.md +17 -6
- package/docs/markdown/interfaces/IGenerateAddressesResponse.md +2 -2
- package/docs/markdown/interfaces/IGetAddress.md +3 -3
- package/docs/markdown/interfaces/IGetAddressBalanceRes.md +2 -2
- package/docs/markdown/interfaces/IGetAddressByPath.md +2 -2
- package/docs/markdown/interfaces/IGetAddressHistoryResponse.md +7 -7
- package/docs/markdown/interfaces/IGetAddressResponse.md +3 -3
- package/docs/markdown/interfaces/IGetAddressScriptHashBalances.md +63 -0
- package/docs/markdown/interfaces/IGetAddressScriptHashesHistoryResponse.md +5 -5
- package/docs/markdown/interfaces/IGetDerivationPath.md +6 -6
- package/docs/markdown/interfaces/IGetFeeEstimatesResponse.md +4 -4
- package/docs/markdown/interfaces/IGetHeaderResponse.md +5 -5
- package/docs/markdown/interfaces/IGetNextAvailableAddressResponse.md +4 -4
- package/docs/markdown/interfaces/IGetTransactions.md +6 -6
- package/docs/markdown/interfaces/IGetTransactionsFromInputs.md +6 -6
- package/docs/markdown/interfaces/IGetUtxosResponse.md +2 -2
- package/docs/markdown/interfaces/IHeader.md +3 -3
- package/docs/markdown/interfaces/IIndexes.md +4 -4
- package/docs/markdown/interfaces/IKeyDerivationPath.md +5 -5
- package/docs/markdown/interfaces/IKeyDerivationPathData.md +2 -2
- package/docs/markdown/interfaces/INewBlock.md +2 -2
- package/docs/markdown/interfaces/IOnchainFees.md +5 -5
- package/docs/markdown/interfaces/IOutput.md +3 -3
- package/docs/markdown/interfaces/IPeerData.md +3 -3
- package/docs/markdown/interfaces/IRbfData.md +6 -6
- package/docs/markdown/interfaces/ISend.md +2 -2
- package/docs/markdown/interfaces/ISendTransaction.md +16 -16
- package/docs/markdown/interfaces/ISendTx.md +3 -3
- package/docs/markdown/interfaces/ISetupTransaction.md +4 -4
- package/docs/markdown/interfaces/ISubscribeToAddress.md +4 -4
- package/docs/markdown/interfaces/ISubscribeToHeader.md +4 -4
- package/docs/markdown/interfaces/ITargets.md +4 -4
- package/docs/markdown/interfaces/ITransaction.md +6 -6
- package/docs/markdown/interfaces/ITxHash.md +1 -1
- package/docs/markdown/interfaces/ITxHashes.md +3 -3
- package/docs/markdown/interfaces/IUtxo.md +16 -16
- package/docs/markdown/interfaces/IVin.md +5 -5
- package/docs/markdown/interfaces/IVout.md +3 -3
- package/docs/markdown/interfaces/IWallet.md +21 -21
- package/docs/markdown/interfaces/IWalletData.md +25 -25
- package/package.json +1 -1
- package/src/electrum/index.ts +8 -8
- package/src/types/electrum.ts +6 -2
- package/src/types/wallet.ts +3 -3
- package/src/wallet/index.ts +4 -4
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
|
|
75
75
|
#### Defined in
|
|
76
76
|
|
|
77
|
-
[electrum/index.ts:
|
|
77
|
+
[electrum/index.ts:65](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L65)
|
|
78
78
|
|
|
79
79
|
## Properties
|
|
80
80
|
|
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
|
|
85
85
|
#### Defined in
|
|
86
86
|
|
|
87
|
-
[electrum/index.ts:
|
|
87
|
+
[electrum/index.ts:53](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L53)
|
|
88
88
|
|
|
89
89
|
___
|
|
90
90
|
|
|
@@ -94,7 +94,7 @@ ___
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[electrum/index.ts:
|
|
97
|
+
[electrum/index.ts:63](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L63)
|
|
98
98
|
|
|
99
99
|
___
|
|
100
100
|
|
|
@@ -104,17 +104,17 @@ ___
|
|
|
104
104
|
|
|
105
105
|
#### Defined in
|
|
106
106
|
|
|
107
|
-
[electrum/index.ts:
|
|
107
|
+
[electrum/index.ts:56](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L56)
|
|
108
108
|
|
|
109
109
|
___
|
|
110
110
|
|
|
111
111
|
### electrumNetwork
|
|
112
112
|
|
|
113
|
-
• `Readonly` **electrumNetwork**: [`
|
|
113
|
+
• `Readonly` **electrumNetwork**: [`EElectrumNetworks`](../enums/EElectrumNetworks.md)
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
[electrum/index.ts:
|
|
117
|
+
[electrum/index.ts:62](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L62)
|
|
118
118
|
|
|
119
119
|
___
|
|
120
120
|
|
|
@@ -124,7 +124,7 @@ ___
|
|
|
124
124
|
|
|
125
125
|
#### Defined in
|
|
126
126
|
|
|
127
|
-
[electrum/index.ts:
|
|
127
|
+
[electrum/index.ts:55](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L55)
|
|
128
128
|
|
|
129
129
|
___
|
|
130
130
|
|
|
@@ -134,7 +134,7 @@ ___
|
|
|
134
134
|
|
|
135
135
|
#### Defined in
|
|
136
136
|
|
|
137
|
-
[electrum/index.ts:
|
|
137
|
+
[electrum/index.ts:58](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L58)
|
|
138
138
|
|
|
139
139
|
___
|
|
140
140
|
|
|
@@ -144,7 +144,7 @@ ___
|
|
|
144
144
|
|
|
145
145
|
#### Defined in
|
|
146
146
|
|
|
147
|
-
[electrum/index.ts:
|
|
147
|
+
[electrum/index.ts:61](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L61)
|
|
148
148
|
|
|
149
149
|
___
|
|
150
150
|
|
|
@@ -154,7 +154,7 @@ ___
|
|
|
154
154
|
|
|
155
155
|
#### Defined in
|
|
156
156
|
|
|
157
|
-
[electrum/index.ts:
|
|
157
|
+
[electrum/index.ts:54](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L54)
|
|
158
158
|
|
|
159
159
|
___
|
|
160
160
|
|
|
@@ -178,7 +178,7 @@ ___
|
|
|
178
178
|
|
|
179
179
|
#### Defined in
|
|
180
180
|
|
|
181
|
-
[electrum/index.ts:
|
|
181
|
+
[electrum/index.ts:64](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L64)
|
|
182
182
|
|
|
183
183
|
___
|
|
184
184
|
|
|
@@ -188,7 +188,7 @@ ___
|
|
|
188
188
|
|
|
189
189
|
#### Defined in
|
|
190
190
|
|
|
191
|
-
[electrum/index.ts:
|
|
191
|
+
[electrum/index.ts:60](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L60)
|
|
192
192
|
|
|
193
193
|
___
|
|
194
194
|
|
|
@@ -198,7 +198,7 @@ ___
|
|
|
198
198
|
|
|
199
199
|
#### Defined in
|
|
200
200
|
|
|
201
|
-
[electrum/index.ts:
|
|
201
|
+
[electrum/index.ts:57](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L57)
|
|
202
202
|
|
|
203
203
|
## Accessors
|
|
204
204
|
|
|
@@ -212,13 +212,13 @@ ___
|
|
|
212
212
|
|
|
213
213
|
#### Defined in
|
|
214
214
|
|
|
215
|
-
[electrum/index.ts:
|
|
215
|
+
[electrum/index.ts:100](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L100)
|
|
216
216
|
|
|
217
217
|
## Methods
|
|
218
218
|
|
|
219
219
|
### broadcastTransaction
|
|
220
220
|
|
|
221
|
-
▸ **broadcastTransaction**(`«destructured»`): `Promise
|
|
221
|
+
▸ **broadcastTransaction**(`«destructured»`): `Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
222
222
|
|
|
223
223
|
#### Parameters
|
|
224
224
|
|
|
@@ -230,33 +230,33 @@ ___
|
|
|
230
230
|
|
|
231
231
|
#### Returns
|
|
232
232
|
|
|
233
|
-
`Promise
|
|
233
|
+
`Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
234
234
|
|
|
235
235
|
#### Defined in
|
|
236
236
|
|
|
237
|
-
[electrum/index.ts:
|
|
237
|
+
[electrum/index.ts:755](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L755)
|
|
238
238
|
|
|
239
239
|
___
|
|
240
240
|
|
|
241
241
|
### checkConnection
|
|
242
242
|
|
|
243
|
-
▸ `Private` **checkConnection**(): `Promise
|
|
243
|
+
▸ `Private` **checkConnection**(): `Promise`<`void`\>
|
|
244
244
|
|
|
245
245
|
Attempts to check the current Electrum connection.
|
|
246
246
|
|
|
247
247
|
#### Returns
|
|
248
248
|
|
|
249
|
-
`Promise
|
|
249
|
+
`Promise`<`void`\>
|
|
250
250
|
|
|
251
251
|
#### Defined in
|
|
252
252
|
|
|
253
|
-
[electrum/index.ts:
|
|
253
|
+
[electrum/index.ts:802](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L802)
|
|
254
254
|
|
|
255
255
|
___
|
|
256
256
|
|
|
257
257
|
### connectToElectrum
|
|
258
258
|
|
|
259
|
-
▸ **connectToElectrum**(`«destructured»`): `Promise
|
|
259
|
+
▸ **connectToElectrum**(`«destructured»`): `Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
260
260
|
|
|
261
261
|
#### Parameters
|
|
262
262
|
|
|
@@ -268,31 +268,31 @@ ___
|
|
|
268
268
|
|
|
269
269
|
#### Returns
|
|
270
270
|
|
|
271
|
-
`Promise
|
|
271
|
+
`Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
272
272
|
|
|
273
273
|
#### Defined in
|
|
274
274
|
|
|
275
|
-
[electrum/index.ts:
|
|
275
|
+
[electrum/index.ts:104](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L104)
|
|
276
276
|
|
|
277
277
|
___
|
|
278
278
|
|
|
279
279
|
### disconnect
|
|
280
280
|
|
|
281
|
-
▸ **disconnect**(): `Promise
|
|
281
|
+
▸ **disconnect**(): `Promise`<`void`\>
|
|
282
282
|
|
|
283
283
|
#### Returns
|
|
284
284
|
|
|
285
|
-
`Promise
|
|
285
|
+
`Promise`<`void`\>
|
|
286
286
|
|
|
287
287
|
#### Defined in
|
|
288
288
|
|
|
289
|
-
[electrum/index.ts:
|
|
289
|
+
[electrum/index.ts:840](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L840)
|
|
290
290
|
|
|
291
291
|
___
|
|
292
292
|
|
|
293
293
|
### getAddressBalance
|
|
294
294
|
|
|
295
|
-
▸ **getAddressBalance**(`scriptHash`): `Promise
|
|
295
|
+
▸ **getAddressBalance**(`scriptHash`): `Promise`<[`IElectrumGetAddressBalanceRes`](../interfaces/IElectrumGetAddressBalanceRes.md)\>
|
|
296
296
|
|
|
297
297
|
Returns the balance in sats for a given address.
|
|
298
298
|
|
|
@@ -304,17 +304,17 @@ Returns the balance in sats for a given address.
|
|
|
304
304
|
|
|
305
305
|
#### Returns
|
|
306
306
|
|
|
307
|
-
`Promise
|
|
307
|
+
`Promise`<[`IElectrumGetAddressBalanceRes`](../interfaces/IElectrumGetAddressBalanceRes.md)\>
|
|
308
308
|
|
|
309
309
|
#### Defined in
|
|
310
310
|
|
|
311
|
-
[electrum/index.ts:
|
|
311
|
+
[electrum/index.ts:145](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L145)
|
|
312
312
|
|
|
313
313
|
___
|
|
314
314
|
|
|
315
315
|
### getAddressHistory
|
|
316
316
|
|
|
317
|
-
▸ **getAddressHistory**(`«destructured»?`): `Promise
|
|
317
|
+
▸ **getAddressHistory**(`«destructured»?`): `Promise`<[`Result`](../README.md#result)<[`IGetAddressHistoryResponse`](../interfaces/IGetAddressHistoryResponse.md)[]\>\>
|
|
318
318
|
|
|
319
319
|
Returns the available history for the provided address script hashes.
|
|
320
320
|
|
|
@@ -328,17 +328,17 @@ Returns the available history for the provided address script hashes.
|
|
|
328
328
|
|
|
329
329
|
#### Returns
|
|
330
330
|
|
|
331
|
-
`Promise
|
|
331
|
+
`Promise`<[`Result`](../README.md#result)<[`IGetAddressHistoryResponse`](../interfaces/IGetAddressHistoryResponse.md)[]\>\>
|
|
332
332
|
|
|
333
333
|
#### Defined in
|
|
334
334
|
|
|
335
|
-
[electrum/index.ts:
|
|
335
|
+
[electrum/index.ts:251](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L251)
|
|
336
336
|
|
|
337
337
|
___
|
|
338
338
|
|
|
339
339
|
### getAddressScriptHashBalances
|
|
340
340
|
|
|
341
|
-
▸ **getAddressScriptHashBalances**(`scriptHashes`): `Promise
|
|
341
|
+
▸ **getAddressScriptHashBalances**(`scriptHashes`): `Promise`<[`IGetAddressScriptHashBalances`](../interfaces/IGetAddressScriptHashBalances.md)\>
|
|
342
342
|
|
|
343
343
|
#### Parameters
|
|
344
344
|
|
|
@@ -348,11 +348,11 @@ ___
|
|
|
348
348
|
|
|
349
349
|
#### Returns
|
|
350
350
|
|
|
351
|
-
`Promise
|
|
351
|
+
`Promise`<[`IGetAddressScriptHashBalances`](../interfaces/IGetAddressScriptHashBalances.md)\>
|
|
352
352
|
|
|
353
353
|
#### Defined in
|
|
354
354
|
|
|
355
|
-
[electrum/index.ts:
|
|
355
|
+
[electrum/index.ts:165](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L165)
|
|
356
356
|
|
|
357
357
|
___
|
|
358
358
|
|
|
@@ -376,7 +376,7 @@ Leaving blockHex empty will return the last known block hash from storage.
|
|
|
376
376
|
|
|
377
377
|
#### Defined in
|
|
378
378
|
|
|
379
|
-
[electrum/index.ts:
|
|
379
|
+
[electrum/index.ts:586](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L586)
|
|
380
380
|
|
|
381
381
|
___
|
|
382
382
|
|
|
@@ -392,13 +392,13 @@ Returns last known block height, and it's corresponding hex from local storage.
|
|
|
392
392
|
|
|
393
393
|
#### Defined in
|
|
394
394
|
|
|
395
|
-
[electrum/index.ts:
|
|
395
|
+
[electrum/index.ts:602](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L602)
|
|
396
396
|
|
|
397
397
|
___
|
|
398
398
|
|
|
399
399
|
### getBlockHex
|
|
400
400
|
|
|
401
|
-
▸ **getBlockHex**(`«destructured»?`): `Promise
|
|
401
|
+
▸ **getBlockHex**(`«destructured»?`): `Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
402
402
|
|
|
403
403
|
Returns the block hex of the provided block height.
|
|
404
404
|
|
|
@@ -411,33 +411,33 @@ Returns the block hex of the provided block height.
|
|
|
411
411
|
|
|
412
412
|
#### Returns
|
|
413
413
|
|
|
414
|
-
`Promise
|
|
414
|
+
`Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
415
415
|
|
|
416
416
|
#### Defined in
|
|
417
417
|
|
|
418
|
-
[electrum/index.ts:
|
|
418
|
+
[electrum/index.ts:564](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L564)
|
|
419
419
|
|
|
420
420
|
___
|
|
421
421
|
|
|
422
422
|
### getConnectedPeer
|
|
423
423
|
|
|
424
|
-
▸ **getConnectedPeer**(): `Promise
|
|
424
|
+
▸ **getConnectedPeer**(): `Promise`<[`Result`](../README.md#result)<[`IPeerData`](../interfaces/IPeerData.md)\>\>
|
|
425
425
|
|
|
426
426
|
Returns currently connected peer.
|
|
427
427
|
|
|
428
428
|
#### Returns
|
|
429
429
|
|
|
430
|
-
`Promise
|
|
430
|
+
`Promise`<[`Result`](../README.md#result)<[`IPeerData`](../interfaces/IPeerData.md)\>\>
|
|
431
431
|
|
|
432
432
|
#### Defined in
|
|
433
433
|
|
|
434
|
-
[electrum/index.ts:
|
|
434
|
+
[electrum/index.ts:178](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L178)
|
|
435
435
|
|
|
436
436
|
___
|
|
437
437
|
|
|
438
438
|
### getElectrumNetwork
|
|
439
439
|
|
|
440
|
-
▸ **getElectrumNetwork**(`network?`): [`
|
|
440
|
+
▸ **getElectrumNetwork**(`network?`): [`EElectrumNetworks`](../enums/EElectrumNetworks.md)
|
|
441
441
|
|
|
442
442
|
Returns the network string for use with Electrum methods.
|
|
443
443
|
|
|
@@ -449,17 +449,17 @@ Returns the network string for use with Electrum methods.
|
|
|
449
449
|
|
|
450
450
|
#### Returns
|
|
451
451
|
|
|
452
|
-
[`
|
|
452
|
+
[`EElectrumNetworks`](../enums/EElectrumNetworks.md)
|
|
453
453
|
|
|
454
454
|
#### Defined in
|
|
455
455
|
|
|
456
|
-
[electrum/index.ts:
|
|
456
|
+
[electrum/index.ts:191](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L191)
|
|
457
457
|
|
|
458
458
|
___
|
|
459
459
|
|
|
460
460
|
### getScriptPubKeyHistory
|
|
461
461
|
|
|
462
|
-
▸ **getScriptPubKeyHistory**(`scriptPubkey`): `Promise
|
|
462
|
+
▸ **getScriptPubKeyHistory**(`scriptPubkey`): `Promise`<[`TGetAddressHistory`](../README.md#tgetaddresshistory)[]\>
|
|
463
463
|
|
|
464
464
|
Used to retrieve scriptPubkey history for LDK.
|
|
465
465
|
|
|
@@ -471,17 +471,17 @@ Used to retrieve scriptPubkey history for LDK.
|
|
|
471
471
|
|
|
472
472
|
#### Returns
|
|
473
473
|
|
|
474
|
-
`Promise
|
|
474
|
+
`Promise`<[`TGetAddressHistory`](../README.md#tgetaddresshistory)[]\>
|
|
475
475
|
|
|
476
476
|
#### Defined in
|
|
477
477
|
|
|
478
|
-
[electrum/index.ts:
|
|
478
|
+
[electrum/index.ts:366](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L366)
|
|
479
479
|
|
|
480
480
|
___
|
|
481
481
|
|
|
482
482
|
### getTransactionMerkle
|
|
483
483
|
|
|
484
|
-
▸ **getTransactionMerkle**(`«destructured»`): `Promise
|
|
484
|
+
▸ **getTransactionMerkle**(`«destructured»`): `Promise`<{ `block_height`: `number` ; `merkle`: `string`[] ; `pos`: `number` }\>
|
|
485
485
|
|
|
486
486
|
Returns the merkle branch to a confirmed transaction given its hash and height.
|
|
487
487
|
|
|
@@ -495,17 +495,17 @@ Returns the merkle branch to a confirmed transaction given its hash and height.
|
|
|
495
495
|
|
|
496
496
|
#### Returns
|
|
497
497
|
|
|
498
|
-
`Promise
|
|
498
|
+
`Promise`<{ `block_height`: `number` ; `merkle`: `string`[] ; `pos`: `number` }\>
|
|
499
499
|
|
|
500
500
|
#### Defined in
|
|
501
501
|
|
|
502
|
-
[electrum/index.ts:
|
|
502
|
+
[electrum/index.ts:641](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L641)
|
|
503
503
|
|
|
504
504
|
___
|
|
505
505
|
|
|
506
506
|
### getTransactions
|
|
507
507
|
|
|
508
|
-
▸ **getTransactions**(`txHashes`): `Promise
|
|
508
|
+
▸ **getTransactions**(`txHashes`): `Promise`<[`Result`](../README.md#result)<[`IGetTransactions`](../interfaces/IGetTransactions.md)\>\>
|
|
509
509
|
|
|
510
510
|
Returns available transactions from electrum based on the provided txHashes.
|
|
511
511
|
|
|
@@ -518,17 +518,17 @@ Returns available transactions from electrum based on the provided txHashes.
|
|
|
518
518
|
|
|
519
519
|
#### Returns
|
|
520
520
|
|
|
521
|
-
`Promise
|
|
521
|
+
`Promise`<[`Result`](../README.md#result)<[`IGetTransactions`](../interfaces/IGetTransactions.md)\>\>
|
|
522
522
|
|
|
523
523
|
#### Defined in
|
|
524
524
|
|
|
525
|
-
[electrum/index.ts:
|
|
525
|
+
[electrum/index.ts:484](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L484)
|
|
526
526
|
|
|
527
527
|
___
|
|
528
528
|
|
|
529
529
|
### getTransactionsFromInputs
|
|
530
530
|
|
|
531
|
-
▸ **getTransactionsFromInputs**(`txHashes`): `Promise
|
|
531
|
+
▸ **getTransactionsFromInputs**(`txHashes`): `Promise`<[`Result`](../README.md#result)<[`IGetTransactionsFromInputs`](../interfaces/IGetTransactionsFromInputs.md)\>\>
|
|
532
532
|
|
|
533
533
|
Returns transactions associated with the provided transaction hashes.
|
|
534
534
|
|
|
@@ -541,17 +541,17 @@ Returns transactions associated with the provided transaction hashes.
|
|
|
541
541
|
|
|
542
542
|
#### Returns
|
|
543
543
|
|
|
544
|
-
`Promise
|
|
544
|
+
`Promise`<[`Result`](../README.md#result)<[`IGetTransactionsFromInputs`](../interfaces/IGetTransactionsFromInputs.md)\>\>
|
|
545
545
|
|
|
546
546
|
#### Defined in
|
|
547
547
|
|
|
548
|
-
[electrum/index.ts:
|
|
548
|
+
[electrum/index.ts:611](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L611)
|
|
549
549
|
|
|
550
550
|
___
|
|
551
551
|
|
|
552
552
|
### getUtxos
|
|
553
553
|
|
|
554
|
-
▸ **getUtxos**(`scanAllAddresses?`): `Promise
|
|
554
|
+
▸ **getUtxos**(`scanAllAddresses?`): `Promise`<[`Result`](../README.md#result)<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
|
|
555
555
|
|
|
556
556
|
Returns UTXO's for a given wallet and network along with the available balance.
|
|
557
557
|
|
|
@@ -564,31 +564,31 @@ Returns UTXO's for a given wallet and network along with the available balance.
|
|
|
564
564
|
|
|
565
565
|
#### Returns
|
|
566
566
|
|
|
567
|
-
`Promise
|
|
567
|
+
`Promise`<[`Result`](../README.md#result)<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
|
|
568
568
|
|
|
569
569
|
#### Defined in
|
|
570
570
|
|
|
571
|
-
[electrum/index.ts:
|
|
571
|
+
[electrum/index.ts:408](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L408)
|
|
572
572
|
|
|
573
573
|
___
|
|
574
574
|
|
|
575
575
|
### isConnected
|
|
576
576
|
|
|
577
|
-
▸ **isConnected**(): `Promise
|
|
577
|
+
▸ **isConnected**(): `Promise`<`boolean`\>
|
|
578
578
|
|
|
579
579
|
#### Returns
|
|
580
580
|
|
|
581
|
-
`Promise
|
|
581
|
+
`Promise`<`boolean`\>
|
|
582
582
|
|
|
583
583
|
#### Defined in
|
|
584
584
|
|
|
585
|
-
[electrum/index.ts:
|
|
585
|
+
[electrum/index.ts:135](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L135)
|
|
586
586
|
|
|
587
587
|
___
|
|
588
588
|
|
|
589
589
|
### listUnspentAddressScriptHashes
|
|
590
590
|
|
|
591
|
-
▸ **listUnspentAddressScriptHashes**(`«destructured»?`): `Promise
|
|
591
|
+
▸ **listUnspentAddressScriptHashes**(`«destructured»?`): `Promise`<[`Result`](../README.md#result)<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
|
|
592
592
|
|
|
593
593
|
Queries Electrum to return the available UTXO's and balance of the provided addresses.
|
|
594
594
|
|
|
@@ -601,11 +601,11 @@ Queries Electrum to return the available UTXO's and balance of the provided addr
|
|
|
601
601
|
|
|
602
602
|
#### Returns
|
|
603
603
|
|
|
604
|
-
`Promise
|
|
604
|
+
`Promise`<[`Result`](../README.md#result)<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
|
|
605
605
|
|
|
606
606
|
#### Defined in
|
|
607
607
|
|
|
608
|
-
[electrum/index.ts:
|
|
608
|
+
[electrum/index.ts:209](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L209)
|
|
609
609
|
|
|
610
610
|
___
|
|
611
611
|
|
|
@@ -625,7 +625,7 @@ ___
|
|
|
625
625
|
|
|
626
626
|
#### Defined in
|
|
627
627
|
|
|
628
|
-
[electrum/index.ts:
|
|
628
|
+
[electrum/index.ts:829](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L829)
|
|
629
629
|
|
|
630
630
|
___
|
|
631
631
|
|
|
@@ -639,7 +639,7 @@ ___
|
|
|
639
639
|
|
|
640
640
|
#### Defined in
|
|
641
641
|
|
|
642
|
-
[electrum/index.ts:
|
|
642
|
+
[electrum/index.ts:845](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L845)
|
|
643
643
|
|
|
644
644
|
___
|
|
645
645
|
|
|
@@ -653,13 +653,13 @@ ___
|
|
|
653
653
|
|
|
654
654
|
#### Defined in
|
|
655
655
|
|
|
656
|
-
[electrum/index.ts:
|
|
656
|
+
[electrum/index.ts:853](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L853)
|
|
657
657
|
|
|
658
658
|
___
|
|
659
659
|
|
|
660
660
|
### subscribeToAddresses
|
|
661
661
|
|
|
662
|
-
▸ **subscribeToAddresses**(`«destructured»?`): `Promise
|
|
662
|
+
▸ **subscribeToAddresses**(`«destructured»?`): `Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
663
663
|
|
|
664
664
|
Subscribes to a number of address script hashes for receiving.
|
|
665
665
|
|
|
@@ -673,27 +673,27 @@ Subscribes to a number of address script hashes for receiving.
|
|
|
673
673
|
|
|
674
674
|
#### Returns
|
|
675
675
|
|
|
676
|
-
`Promise
|
|
676
|
+
`Promise`<[`Result`](../README.md#result)<`string`\>\>
|
|
677
677
|
|
|
678
678
|
#### Defined in
|
|
679
679
|
|
|
680
|
-
[electrum/index.ts:
|
|
680
|
+
[electrum/index.ts:698](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L698)
|
|
681
681
|
|
|
682
682
|
___
|
|
683
683
|
|
|
684
684
|
### subscribeToHeader
|
|
685
685
|
|
|
686
|
-
▸ **subscribeToHeader**(): `Promise
|
|
686
|
+
▸ **subscribeToHeader**(): `Promise`<[`Result`](../README.md#result)<[`IHeader`](../interfaces/IHeader.md)\>\>
|
|
687
687
|
|
|
688
688
|
Subscribes to the current networks headers.
|
|
689
689
|
|
|
690
690
|
#### Returns
|
|
691
691
|
|
|
692
|
-
`Promise
|
|
692
|
+
`Promise`<[`Result`](../README.md#result)<[`IHeader`](../interfaces/IHeader.md)\>\>
|
|
693
693
|
|
|
694
694
|
#### Defined in
|
|
695
695
|
|
|
696
|
-
[electrum/index.ts:
|
|
696
|
+
[electrum/index.ts:663](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L663)
|
|
697
697
|
|
|
698
698
|
___
|
|
699
699
|
|
|
@@ -707,7 +707,7 @@ Determines whether a transaction exists based on the transaction response from e
|
|
|
707
707
|
|
|
708
708
|
| Name | Type |
|
|
709
709
|
| :------ | :------ |
|
|
710
|
-
| `txData` | [`ITransaction`](../interfaces/ITransaction.md)
|
|
710
|
+
| `txData` | [`ITransaction`](../interfaces/ITransaction.md)<[`IUtxo`](../interfaces/IUtxo.md)\> |
|
|
711
711
|
|
|
712
712
|
#### Returns
|
|
713
713
|
|
|
@@ -715,4 +715,4 @@ Determines whether a transaction exists based on the transaction response from e
|
|
|
715
715
|
|
|
716
716
|
#### Defined in
|
|
717
717
|
|
|
718
|
-
[electrum/index.ts:
|
|
718
|
+
[electrum/index.ts:541](https://github.com/synonymdev/beignet/blob/88520f5/src/electrum/index.ts#L541)
|