@atomiqlabs/sdk 8.8.3 → 8.8.4
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/LICENSE +201 -201
- package/README.md +1760 -1760
- package/dist/SmartChainAssets.d.ts +181 -181
- package/dist/SmartChainAssets.js +181 -181
- package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
- package/dist/bitcoin/coinselect2/accumulative.js +52 -52
- package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
- package/dist/bitcoin/coinselect2/blackjack.js +38 -38
- package/dist/bitcoin/coinselect2/index.d.ts +20 -20
- package/dist/bitcoin/coinselect2/index.js +69 -69
- package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
- package/dist/bitcoin/coinselect2/utils.js +158 -158
- package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
- package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
- package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
- package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
- package/dist/enums/FeeType.d.ts +15 -15
- package/dist/enums/FeeType.js +19 -19
- package/dist/enums/SwapAmountType.d.ts +15 -15
- package/dist/enums/SwapAmountType.js +19 -19
- package/dist/enums/SwapDirection.d.ts +15 -15
- package/dist/enums/SwapDirection.js +19 -19
- package/dist/enums/SwapSide.d.ts +15 -15
- package/dist/enums/SwapSide.js +19 -19
- package/dist/enums/SwapType.d.ts +75 -75
- package/dist/enums/SwapType.js +79 -79
- package/dist/errors/IntermediaryError.d.ts +13 -13
- package/dist/errors/IntermediaryError.js +27 -27
- package/dist/errors/RequestError.d.ts +32 -32
- package/dist/errors/RequestError.js +54 -54
- package/dist/errors/UserError.d.ts +8 -8
- package/dist/errors/UserError.js +16 -16
- package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
- package/dist/events/UnifiedSwapEventListener.js +132 -132
- package/dist/http/HttpUtils.d.ts +27 -27
- package/dist/http/HttpUtils.js +91 -91
- package/dist/http/paramcoders/IParamReader.d.ts +8 -8
- package/dist/http/paramcoders/IParamReader.js +2 -2
- package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
- package/dist/http/paramcoders/ParamDecoder.js +137 -137
- package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
- package/dist/http/paramcoders/ParamEncoder.js +36 -36
- package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
- package/dist/http/paramcoders/SchemaVerifier.js +145 -145
- package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
- package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
- package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
- package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
- package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
- package/dist/http/paramcoders/client/StreamingFetchPromise.js +174 -174
- package/dist/index.d.ts +85 -85
- package/dist/index.js +158 -158
- package/dist/intermediaries/Intermediary.d.ts +178 -178
- package/dist/intermediaries/Intermediary.js +166 -166
- package/dist/intermediaries/IntermediaryDiscovery.d.ts +211 -211
- package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
- package/dist/intermediaries/apis/IntermediaryAPI.d.ts +450 -450
- package/dist/intermediaries/apis/IntermediaryAPI.js +618 -618
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
- package/dist/lnurl/LNURL.d.ts +102 -102
- package/dist/lnurl/LNURL.js +321 -321
- package/dist/prices/RedundantSwapPrice.d.ts +110 -110
- package/dist/prices/RedundantSwapPrice.js +222 -222
- package/dist/prices/SingleSwapPrice.d.ts +34 -34
- package/dist/prices/SingleSwapPrice.js +44 -44
- package/dist/prices/SwapPriceWithChain.d.ts +107 -107
- package/dist/prices/SwapPriceWithChain.js +128 -128
- package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
- package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
- package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
- package/dist/prices/abstract/IPriceProvider.js +74 -74
- package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
- package/dist/prices/abstract/ISwapPrice.js +279 -279
- package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
- package/dist/prices/providers/BinancePriceProvider.js +30 -30
- package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
- package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
- package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
- package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
- package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
- package/dist/prices/providers/CustomPriceProvider.js +35 -35
- package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
- package/dist/prices/providers/KrakenPriceProvider.js +45 -45
- package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
- package/dist/prices/providers/OKXPriceProvider.js +29 -29
- package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
- package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
- package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
- package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
- package/dist/storage/IUnifiedStorage.d.ts +85 -85
- package/dist/storage/IUnifiedStorage.js +2 -2
- package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
- package/dist/storage/UnifiedSwapStorage.js +116 -116
- package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
- package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
- package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
- package/dist/storage-browser/LocalStorageManager.js +93 -93
- package/dist/swapper/Swapper.d.ts +732 -732
- package/dist/swapper/Swapper.js +1713 -1713
- package/dist/swapper/SwapperFactory.d.ts +135 -135
- package/dist/swapper/SwapperFactory.js +162 -162
- package/dist/swapper/SwapperUtils.d.ts +206 -206
- package/dist/swapper/SwapperUtils.js +481 -481
- package/dist/swapper/SwapperWithChain.d.ts +404 -404
- package/dist/swapper/SwapperWithChain.js +469 -469
- package/dist/swapper/SwapperWithSigner.d.ts +322 -322
- package/dist/swapper/SwapperWithSigner.js +318 -318
- package/dist/swaps/IAddressSwap.d.ts +22 -22
- package/dist/swaps/IAddressSwap.js +14 -14
- package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
- package/dist/swaps/IBTCWalletSwap.js +18 -18
- package/dist/swaps/IClaimableSwap.d.ts +49 -49
- package/dist/swaps/IClaimableSwap.js +15 -15
- package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
- package/dist/swaps/IClaimableSwapWrapper.js +2 -2
- package/dist/swaps/IRefundableSwap.d.ts +43 -43
- package/dist/swaps/IRefundableSwap.js +14 -14
- package/dist/swaps/ISwap.d.ts +392 -392
- package/dist/swaps/ISwap.js +349 -349
- package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
- package/dist/swaps/ISwapWithGasDrop.js +12 -12
- package/dist/swaps/ISwapWrapper.d.ts +285 -285
- package/dist/swaps/ISwapWrapper.js +353 -353
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
- package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
- package/dist/swaps/escrow_swaps/IEscrowSwap.js +170 -170
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +128 -128
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +105 -105
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +129 -129
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +531 -531
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +190 -190
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +583 -583
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +235 -235
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +202 -202
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +251 -251
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +536 -536
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +132 -132
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +637 -637
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1448
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -257
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
- package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
- package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
- package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
- package/dist/swaps/trusted/ln/LnForGasWrapper.js +83 -83
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +69 -69
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
- package/dist/types/AmountData.d.ts +10 -10
- package/dist/types/AmountData.js +2 -2
- package/dist/types/CustomPriceFunction.d.ts +11 -11
- package/dist/types/CustomPriceFunction.js +2 -2
- package/dist/types/PriceInfoType.d.ts +28 -28
- package/dist/types/PriceInfoType.js +57 -57
- package/dist/types/SwapExecutionAction.d.ts +88 -88
- package/dist/types/SwapExecutionAction.js +2 -2
- package/dist/types/SwapStateInfo.d.ts +5 -5
- package/dist/types/SwapStateInfo.js +2 -2
- package/dist/types/SwapWithSigner.d.ts +17 -17
- package/dist/types/SwapWithSigner.js +43 -43
- package/dist/types/Token.d.ts +99 -99
- package/dist/types/Token.js +76 -76
- package/dist/types/TokenAmount.d.ts +69 -69
- package/dist/types/TokenAmount.js +60 -60
- package/dist/types/fees/Fee.d.ts +50 -50
- package/dist/types/fees/Fee.js +2 -2
- package/dist/types/fees/FeeBreakdown.d.ts +11 -11
- package/dist/types/fees/FeeBreakdown.js +2 -2
- package/dist/types/fees/PercentagePPM.d.ts +17 -17
- package/dist/types/fees/PercentagePPM.js +18 -18
- package/dist/types/lnurl/LNURLPay.d.ts +61 -61
- package/dist/types/lnurl/LNURLPay.js +31 -31
- package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
- package/dist/types/lnurl/LNURLWithdraw.js +27 -27
- package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
- package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
- package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
- package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
- package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
- package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
- package/dist/utils/BitcoinUtils.d.ts +16 -16
- package/dist/utils/BitcoinUtils.js +141 -141
- package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
- package/dist/utils/BitcoinWalletUtils.js +14 -14
- package/dist/utils/Logger.d.ts +7 -7
- package/dist/utils/Logger.js +12 -12
- package/dist/utils/RetryUtils.d.ts +22 -22
- package/dist/utils/RetryUtils.js +67 -67
- package/dist/utils/SwapUtils.d.ts +88 -88
- package/dist/utils/SwapUtils.js +72 -72
- package/dist/utils/TimeoutUtils.d.ts +17 -17
- package/dist/utils/TimeoutUtils.js +55 -55
- package/dist/utils/TokenUtils.d.ts +19 -19
- package/dist/utils/TokenUtils.js +37 -37
- package/dist/utils/TypeUtils.d.ts +7 -7
- package/dist/utils/TypeUtils.js +2 -2
- package/dist/utils/Utils.d.ts +67 -67
- package/dist/utils/Utils.js +208 -208
- package/package.json +43 -43
- package/src/SmartChainAssets.ts +186 -186
- package/src/bitcoin/coinselect2/accumulative.ts +69 -69
- package/src/bitcoin/coinselect2/blackjack.ts +50 -50
- package/src/bitcoin/coinselect2/index.ts +93 -93
- package/src/bitcoin/coinselect2/utils.ts +236 -236
- package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
- package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
- package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
- package/src/enums/FeeType.ts +15 -15
- package/src/enums/SwapAmountType.ts +16 -16
- package/src/enums/SwapDirection.ts +15 -15
- package/src/enums/SwapSide.ts +16 -16
- package/src/enums/SwapType.ts +75 -75
- package/src/errors/IntermediaryError.ts +28 -28
- package/src/errors/RequestError.ts +64 -64
- package/src/errors/UserError.ts +15 -15
- package/src/events/UnifiedSwapEventListener.ts +173 -173
- package/src/http/HttpUtils.ts +91 -91
- package/src/http/paramcoders/IParamReader.ts +9 -9
- package/src/http/paramcoders/ParamDecoder.ts +145 -145
- package/src/http/paramcoders/ParamEncoder.ts +40 -40
- package/src/http/paramcoders/SchemaVerifier.ts +153 -153
- package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
- package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
- package/src/http/paramcoders/client/StreamingFetchPromise.ts +192 -192
- package/src/index.ts +140 -140
- package/src/intermediaries/Intermediary.ts +280 -280
- package/src/intermediaries/IntermediaryDiscovery.ts +541 -541
- package/src/intermediaries/apis/IntermediaryAPI.ts +963 -963
- package/src/intermediaries/apis/TrustedIntermediaryAPI.ts +257 -257
- package/src/lnurl/LNURL.ts +402 -402
- package/src/prices/RedundantSwapPrice.ts +264 -264
- package/src/prices/SingleSwapPrice.ts +50 -50
- package/src/prices/SwapPriceWithChain.ts +194 -194
- package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
- package/src/prices/abstract/IPriceProvider.ts +127 -127
- package/src/prices/abstract/ISwapPrice.ts +390 -390
- package/src/prices/providers/BinancePriceProvider.ts +48 -48
- package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
- package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
- package/src/prices/providers/CustomPriceProvider.ts +40 -40
- package/src/prices/providers/KrakenPriceProvider.ts +83 -83
- package/src/prices/providers/OKXPriceProvider.ts +59 -59
- package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
- package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
- package/src/storage/IUnifiedStorage.ts +95 -95
- package/src/storage/UnifiedSwapStorage.ts +141 -141
- package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
- package/src/storage-browser/LocalStorageManager.ts +106 -106
- package/src/swapper/Swapper.ts +2488 -2488
- package/src/swapper/SwapperFactory.ts +307 -307
- package/src/swapper/SwapperUtils.ts +570 -570
- package/src/swapper/SwapperWithChain.ts +707 -707
- package/src/swapper/SwapperWithSigner.ts +511 -511
- package/src/swaps/IAddressSwap.ts +30 -30
- package/src/swaps/IBTCWalletSwap.ts +92 -92
- package/src/swaps/IClaimableSwap.ts +65 -65
- package/src/swaps/IClaimableSwapWrapper.ts +17 -17
- package/src/swaps/IRefundableSwap.ts +58 -58
- package/src/swaps/ISwap.ts +703 -703
- package/src/swaps/ISwapWithGasDrop.ts +25 -25
- package/src/swaps/ISwapWrapper.ts +539 -539
- package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
- package/src/swaps/escrow_swaps/IEscrowSwap.ts +269 -269
- package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +282 -282
- package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +169 -169
- package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
- package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
- package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1473 -1474
- package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +601 -601
- package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1582 -1582
- package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +750 -750
- package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1299 -1299
- package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +610 -610
- package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1096 -1096
- package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
- package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
- package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +786 -786
- package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
- package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +401 -401
- package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +1812 -1812
- package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1236
- package/src/swaps/trusted/ln/LnForGasSwap.ts +589 -589
- package/src/swaps/trusted/ln/LnForGasWrapper.ts +91 -91
- package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +862 -862
- package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +131 -131
- package/src/types/AmountData.ts +9 -9
- package/src/types/CustomPriceFunction.ts +11 -11
- package/src/types/PriceInfoType.ts +66 -66
- package/src/types/SwapExecutionAction.ts +99 -99
- package/src/types/SwapStateInfo.ts +6 -6
- package/src/types/SwapWithSigner.ts +61 -61
- package/src/types/Token.ts +163 -163
- package/src/types/TokenAmount.ts +132 -132
- package/src/types/fees/Fee.ts +56 -56
- package/src/types/fees/FeeBreakdown.ts +11 -11
- package/src/types/fees/PercentagePPM.ts +26 -26
- package/src/types/lnurl/LNURLPay.ts +79 -79
- package/src/types/lnurl/LNURLWithdraw.ts +61 -61
- package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
- package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
- package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
- package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
- package/src/utils/BitcoinUtils.ts +132 -132
- package/src/utils/BitcoinWalletUtils.ts +15 -15
- package/src/utils/Logger.ts +14 -14
- package/src/utils/RetryUtils.ts +78 -78
- package/src/utils/SwapUtils.ts +99 -99
- package/src/utils/TimeoutUtils.ts +49 -49
- package/src/utils/TokenUtils.ts +33 -33
- package/src/utils/TypeUtils.ts +8 -8
- package/src/utils/Utils.ts +212 -212
|
@@ -1,93 +1,93 @@
|
|
|
1
|
-
import {accumulative} from "./accumulative"
|
|
2
|
-
import {blackjack} from "./blackjack"
|
|
3
|
-
import {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, DUST_THRESHOLDS, utils} from "./utils"
|
|
4
|
-
|
|
5
|
-
// order by descending value, minus the inputs approximate fee
|
|
6
|
-
function utxoScore (x: CoinselectTxInput, feeRate: number) {
|
|
7
|
-
let valueAfterFee = x.value - (feeRate * utils.inputBytes(x))
|
|
8
|
-
if(x.cpfp!=null && x.cpfp.txEffectiveFeeRate<feeRate) valueAfterFee -= x.cpfp.txVsize*(feeRate - x.cpfp.txEffectiveFeeRate);
|
|
9
|
-
return valueAfterFee;
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
export {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, DUST_THRESHOLDS};
|
|
13
|
-
|
|
14
|
-
export function coinSelect (
|
|
15
|
-
utxos: CoinselectTxInput[],
|
|
16
|
-
outputs: CoinselectTxOutput[],
|
|
17
|
-
feeRate: number,
|
|
18
|
-
type: CoinselectAddressTypes,
|
|
19
|
-
requiredInputs?: CoinselectTxInput[]
|
|
20
|
-
): {
|
|
21
|
-
inputs?: CoinselectTxInput[],
|
|
22
|
-
outputs?: CoinselectTxOutput[],
|
|
23
|
-
effectiveFeeRate?: number,
|
|
24
|
-
fee: number
|
|
25
|
-
} {
|
|
26
|
-
// order by descending value, minus the inputs approximate fee
|
|
27
|
-
utxos = utxos.sort((a, b) => {
|
|
28
|
-
// if(a.cpfp!=null && b.cpfp==null) return 1;
|
|
29
|
-
// if(a.cpfp==null && b.cpfp!=null) return -1;
|
|
30
|
-
return utxoScore(b, feeRate) - utxoScore(a, feeRate);
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
// attempt to use the blackjack strategy first (no change output)
|
|
34
|
-
const base = blackjack(utxos, outputs, feeRate, type, requiredInputs);
|
|
35
|
-
if (base.inputs) return base;
|
|
36
|
-
|
|
37
|
-
// else, try the accumulative strategy
|
|
38
|
-
return accumulative(utxos, outputs, feeRate, type, requiredInputs);
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
export function maxSendable (
|
|
42
|
-
utxos: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">[],
|
|
43
|
-
output: {script: Buffer, type: CoinselectAddressTypes},
|
|
44
|
-
feeRate: number,
|
|
45
|
-
requiredInputs?: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">[],
|
|
46
|
-
additionalOutputs?: {script: Buffer, value: number}[],
|
|
47
|
-
): {
|
|
48
|
-
value: number,
|
|
49
|
-
fee: number
|
|
50
|
-
} {
|
|
51
|
-
if (!isFinite(utils.numberOrNaN(feeRate))) throw new Error("Invalid feeRate passed!");
|
|
52
|
-
|
|
53
|
-
const outputs = additionalOutputs ?? [];
|
|
54
|
-
const inputs = requiredInputs ?? [];
|
|
55
|
-
let bytesAccum = utils.transactionBytes(inputs, (outputs as {script: Buffer}[]).concat([output]));
|
|
56
|
-
let cpfpAddFee = 0;
|
|
57
|
-
let inAccum = utils.sumOrNaN(inputs);
|
|
58
|
-
let outAccum = utils.sumOrNaN(outputs);
|
|
59
|
-
|
|
60
|
-
for (let i = 0; i < utxos.length; ++i) {
|
|
61
|
-
const utxo = utxos[i];
|
|
62
|
-
const utxoBytes = utils.inputBytes(utxo);
|
|
63
|
-
const utxoFee = feeRate * utxoBytes;
|
|
64
|
-
let cpfpFee = 0;
|
|
65
|
-
if(utxo.cpfp!=null && utxo.cpfp.txEffectiveFeeRate<feeRate) cpfpFee = Math.ceil(utxo.cpfp.txVsize*(feeRate - utxo.cpfp.txEffectiveFeeRate));
|
|
66
|
-
const utxoValue = utils.uintOrNaN(utxo.value);
|
|
67
|
-
|
|
68
|
-
// skip detrimental input
|
|
69
|
-
if (utxoFee + cpfpFee > utxo.value) {
|
|
70
|
-
continue;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
bytesAccum += utxoBytes;
|
|
74
|
-
inAccum += utxoValue;
|
|
75
|
-
cpfpAddFee += cpfpFee;
|
|
76
|
-
inputs.push(utxo);
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
const fee = (feeRate * bytesAccum) + cpfpAddFee;
|
|
80
|
-
const outputValue = inAccum - fee - outAccum;
|
|
81
|
-
|
|
82
|
-
const dustThreshold = DUST_THRESHOLDS[output.type];
|
|
83
|
-
|
|
84
|
-
if(outputValue<dustThreshold) return {
|
|
85
|
-
fee,
|
|
86
|
-
value: 0
|
|
87
|
-
};
|
|
88
|
-
|
|
89
|
-
return {
|
|
90
|
-
fee,
|
|
91
|
-
value: outputValue
|
|
92
|
-
};
|
|
93
|
-
}
|
|
1
|
+
import {accumulative} from "./accumulative"
|
|
2
|
+
import {blackjack} from "./blackjack"
|
|
3
|
+
import {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, DUST_THRESHOLDS, utils} from "./utils"
|
|
4
|
+
|
|
5
|
+
// order by descending value, minus the inputs approximate fee
|
|
6
|
+
function utxoScore (x: CoinselectTxInput, feeRate: number) {
|
|
7
|
+
let valueAfterFee = x.value - (feeRate * utils.inputBytes(x))
|
|
8
|
+
if(x.cpfp!=null && x.cpfp.txEffectiveFeeRate<feeRate) valueAfterFee -= x.cpfp.txVsize*(feeRate - x.cpfp.txEffectiveFeeRate);
|
|
9
|
+
return valueAfterFee;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, DUST_THRESHOLDS};
|
|
13
|
+
|
|
14
|
+
export function coinSelect (
|
|
15
|
+
utxos: CoinselectTxInput[],
|
|
16
|
+
outputs: CoinselectTxOutput[],
|
|
17
|
+
feeRate: number,
|
|
18
|
+
type: CoinselectAddressTypes,
|
|
19
|
+
requiredInputs?: CoinselectTxInput[]
|
|
20
|
+
): {
|
|
21
|
+
inputs?: CoinselectTxInput[],
|
|
22
|
+
outputs?: CoinselectTxOutput[],
|
|
23
|
+
effectiveFeeRate?: number,
|
|
24
|
+
fee: number
|
|
25
|
+
} {
|
|
26
|
+
// order by descending value, minus the inputs approximate fee
|
|
27
|
+
utxos = utxos.sort((a, b) => {
|
|
28
|
+
// if(a.cpfp!=null && b.cpfp==null) return 1;
|
|
29
|
+
// if(a.cpfp==null && b.cpfp!=null) return -1;
|
|
30
|
+
return utxoScore(b, feeRate) - utxoScore(a, feeRate);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// attempt to use the blackjack strategy first (no change output)
|
|
34
|
+
const base = blackjack(utxos, outputs, feeRate, type, requiredInputs);
|
|
35
|
+
if (base.inputs) return base;
|
|
36
|
+
|
|
37
|
+
// else, try the accumulative strategy
|
|
38
|
+
return accumulative(utxos, outputs, feeRate, type, requiredInputs);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export function maxSendable (
|
|
42
|
+
utxos: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">[],
|
|
43
|
+
output: {script: Buffer, type: CoinselectAddressTypes},
|
|
44
|
+
feeRate: number,
|
|
45
|
+
requiredInputs?: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">[],
|
|
46
|
+
additionalOutputs?: {script: Buffer, value: number}[],
|
|
47
|
+
): {
|
|
48
|
+
value: number,
|
|
49
|
+
fee: number
|
|
50
|
+
} {
|
|
51
|
+
if (!isFinite(utils.numberOrNaN(feeRate))) throw new Error("Invalid feeRate passed!");
|
|
52
|
+
|
|
53
|
+
const outputs = additionalOutputs ?? [];
|
|
54
|
+
const inputs = requiredInputs ?? [];
|
|
55
|
+
let bytesAccum = utils.transactionBytes(inputs, (outputs as {script: Buffer}[]).concat([output]));
|
|
56
|
+
let cpfpAddFee = 0;
|
|
57
|
+
let inAccum = utils.sumOrNaN(inputs);
|
|
58
|
+
let outAccum = utils.sumOrNaN(outputs);
|
|
59
|
+
|
|
60
|
+
for (let i = 0; i < utxos.length; ++i) {
|
|
61
|
+
const utxo = utxos[i];
|
|
62
|
+
const utxoBytes = utils.inputBytes(utxo);
|
|
63
|
+
const utxoFee = feeRate * utxoBytes;
|
|
64
|
+
let cpfpFee = 0;
|
|
65
|
+
if(utxo.cpfp!=null && utxo.cpfp.txEffectiveFeeRate<feeRate) cpfpFee = Math.ceil(utxo.cpfp.txVsize*(feeRate - utxo.cpfp.txEffectiveFeeRate));
|
|
66
|
+
const utxoValue = utils.uintOrNaN(utxo.value);
|
|
67
|
+
|
|
68
|
+
// skip detrimental input
|
|
69
|
+
if (utxoFee + cpfpFee > utxo.value) {
|
|
70
|
+
continue;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
bytesAccum += utxoBytes;
|
|
74
|
+
inAccum += utxoValue;
|
|
75
|
+
cpfpAddFee += cpfpFee;
|
|
76
|
+
inputs.push(utxo);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
const fee = (feeRate * bytesAccum) + cpfpAddFee;
|
|
80
|
+
const outputValue = inAccum - fee - outAccum;
|
|
81
|
+
|
|
82
|
+
const dustThreshold = DUST_THRESHOLDS[output.type];
|
|
83
|
+
|
|
84
|
+
if(outputValue<dustThreshold) return {
|
|
85
|
+
fee,
|
|
86
|
+
value: 0
|
|
87
|
+
};
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
fee,
|
|
91
|
+
value: outputValue
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -1,236 +1,236 @@
|
|
|
1
|
-
import {getLogger} from "../../utils/Logger";
|
|
2
|
-
|
|
3
|
-
const logger = getLogger("CoinSelect: ");
|
|
4
|
-
|
|
5
|
-
// baseline estimates, used to improve performance
|
|
6
|
-
const TX_EMPTY_SIZE = 4 + 1 + 1 + 4;
|
|
7
|
-
const TX_INPUT_BASE = 32 + 4 + 1 + 4;
|
|
8
|
-
|
|
9
|
-
const WITNESS_OVERHEAD = 2/4;
|
|
10
|
-
|
|
11
|
-
const P2WPKH_WITNESS = (1+1+72+1+33)/4;
|
|
12
|
-
const P2TR_WITNESS = (1+1+65)/4;
|
|
13
|
-
|
|
14
|
-
const TX_INPUT_PUBKEYHASH = 107;
|
|
15
|
-
const TX_INPUT_P2SH_P2WPKH = 23 + P2WPKH_WITNESS + 1;
|
|
16
|
-
const TX_INPUT_P2WPKH = 0 + P2WPKH_WITNESS;
|
|
17
|
-
const TX_INPUT_P2WSH = 0 + (1+1+64)/4;
|
|
18
|
-
const TX_INPUT_P2TR = 0 + P2TR_WITNESS;
|
|
19
|
-
|
|
20
|
-
const TX_OUTPUT_BASE = 8 + 1;
|
|
21
|
-
|
|
22
|
-
const TX_OUTPUT_PUBKEYHASH = 25;
|
|
23
|
-
const TX_OUTPUT_P2SH_P2WPKH = 23;
|
|
24
|
-
const TX_OUTPUT_P2WPKH = 22;
|
|
25
|
-
const TX_OUTPUT_P2WSH = 34;
|
|
26
|
-
const TX_OUTPUT_P2TR = 34;
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Defines a type of the address used by the wallet, for proper coinselection (as coinselection
|
|
30
|
-
* depends on estimating the cost for spending the input + the cost of adding a change output)
|
|
31
|
-
*
|
|
32
|
-
* @category Bitcoin
|
|
33
|
-
*/
|
|
34
|
-
export type CoinselectAddressTypes = "p2sh-p2wpkh" | "p2wpkh" | "p2wsh" | "p2tr" | "p2pkh";
|
|
35
|
-
|
|
36
|
-
export type CoinselectTxInput = {
|
|
37
|
-
script?: Buffer,
|
|
38
|
-
txId: string,
|
|
39
|
-
vout: number,
|
|
40
|
-
type?: CoinselectAddressTypes,
|
|
41
|
-
value: number,
|
|
42
|
-
outputScript?: Buffer,
|
|
43
|
-
address?: string,
|
|
44
|
-
cpfp?: {
|
|
45
|
-
txVsize: number,
|
|
46
|
-
txEffectiveFeeRate: number
|
|
47
|
-
}
|
|
48
|
-
};
|
|
49
|
-
|
|
50
|
-
export type CoinselectTxOutput = {
|
|
51
|
-
script?: Buffer,
|
|
52
|
-
address?: string,
|
|
53
|
-
type?: CoinselectAddressTypes,
|
|
54
|
-
value: number
|
|
55
|
-
};
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
const INPUT_BYTES = {
|
|
59
|
-
"p2sh-p2wpkh": TX_INPUT_P2SH_P2WPKH,
|
|
60
|
-
"p2wpkh": TX_INPUT_P2WPKH,
|
|
61
|
-
"p2tr": TX_INPUT_P2TR,
|
|
62
|
-
"p2pkh": TX_INPUT_PUBKEYHASH,
|
|
63
|
-
"p2wsh": TX_INPUT_P2WSH
|
|
64
|
-
};
|
|
65
|
-
|
|
66
|
-
function inputBytes (input: {
|
|
67
|
-
script?: Buffer,
|
|
68
|
-
type?: CoinselectAddressTypes
|
|
69
|
-
}) {
|
|
70
|
-
if(input.script==null && input.type==null) throw new Error("Needs either script or type defined!");
|
|
71
|
-
return TX_INPUT_BASE + (input.script ? input.script.length : INPUT_BYTES[input.type!]);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
const OUTPUT_BYTES = {
|
|
75
|
-
"p2sh-p2wpkh": TX_OUTPUT_P2SH_P2WPKH,
|
|
76
|
-
"p2wpkh": TX_OUTPUT_P2WPKH,
|
|
77
|
-
"p2tr": TX_OUTPUT_P2TR,
|
|
78
|
-
"p2pkh": TX_OUTPUT_PUBKEYHASH,
|
|
79
|
-
"p2wsh": TX_OUTPUT_P2WSH
|
|
80
|
-
};
|
|
81
|
-
|
|
82
|
-
function outputBytes (output: {
|
|
83
|
-
script?: Buffer,
|
|
84
|
-
type?: CoinselectAddressTypes
|
|
85
|
-
}): number {
|
|
86
|
-
if(output.script==null && output.type==null) throw new Error("Needs either script or type defined!");
|
|
87
|
-
return TX_OUTPUT_BASE + (output.script ? output.script.length : OUTPUT_BYTES[output.type!]);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
export const DUST_THRESHOLDS = {
|
|
91
|
-
"p2sh-p2wpkh": 540,
|
|
92
|
-
"p2wpkh": 294,
|
|
93
|
-
"p2tr": 330,
|
|
94
|
-
"p2pkh": 546,
|
|
95
|
-
"p2wsh": 330
|
|
96
|
-
};
|
|
97
|
-
|
|
98
|
-
function dustThreshold (output: {
|
|
99
|
-
script?: Buffer,
|
|
100
|
-
type: CoinselectAddressTypes
|
|
101
|
-
}): number {
|
|
102
|
-
return DUST_THRESHOLDS[output.type];
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
function transactionBytes (
|
|
106
|
-
inputs: {
|
|
107
|
-
script?: Buffer,
|
|
108
|
-
type?: CoinselectAddressTypes
|
|
109
|
-
}[],
|
|
110
|
-
outputs: {
|
|
111
|
-
script?: Buffer,
|
|
112
|
-
type?: CoinselectAddressTypes
|
|
113
|
-
}[],
|
|
114
|
-
changeType?: CoinselectAddressTypes
|
|
115
|
-
): number {
|
|
116
|
-
let size = TX_EMPTY_SIZE;
|
|
117
|
-
let isSegwit = false;
|
|
118
|
-
if(changeType!=null && changeType!=="p2pkh") {
|
|
119
|
-
size += WITNESS_OVERHEAD;
|
|
120
|
-
isSegwit = true;
|
|
121
|
-
}
|
|
122
|
-
for(let input of inputs) {
|
|
123
|
-
if(!isSegwit && (input.type!=="p2pkh")) {
|
|
124
|
-
isSegwit = true;
|
|
125
|
-
size += WITNESS_OVERHEAD;
|
|
126
|
-
}
|
|
127
|
-
size += inputBytes(input);
|
|
128
|
-
}
|
|
129
|
-
for(let output of outputs) {
|
|
130
|
-
size += outputBytes(output);
|
|
131
|
-
}
|
|
132
|
-
return Math.ceil(size);
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
function numberOrNaN(v: number): number {
|
|
136
|
-
if (typeof v !== 'number') return NaN;
|
|
137
|
-
if (!isFinite(v)) return NaN;
|
|
138
|
-
if (v < 0) return NaN;
|
|
139
|
-
return v;
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
function uintOrNaN(v: number): number {
|
|
143
|
-
if (typeof v !== 'number') return NaN;
|
|
144
|
-
if (!isFinite(v)) return NaN;
|
|
145
|
-
if (Math.floor(v) !== v) return NaN;
|
|
146
|
-
if (v < 0) return NaN;
|
|
147
|
-
return v;
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
function sumForgiving(range: {value: number}[]): number {
|
|
151
|
-
return range.reduce((a, x) => a + (isFinite(x.value) ? x.value : 0), 0);
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
function sumOrNaN(range: {value: number}[]): number {
|
|
155
|
-
return range.reduce((a, x) => a + uintOrNaN(x.value), 0);
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
function finalize<T extends Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">>(
|
|
159
|
-
inputs: T[],
|
|
160
|
-
outputs: CoinselectTxOutput[],
|
|
161
|
-
feeRate: number,
|
|
162
|
-
changeType: CoinselectAddressTypes | null,
|
|
163
|
-
cpfpAddFee: number = 0
|
|
164
|
-
): {
|
|
165
|
-
inputs?: T[],
|
|
166
|
-
outputs?: CoinselectTxOutput[],
|
|
167
|
-
effectiveFeeRate?: number,
|
|
168
|
-
fee: number
|
|
169
|
-
} {
|
|
170
|
-
const bytesAccum = transactionBytes(inputs, outputs, changeType ?? undefined);
|
|
171
|
-
logger.debug("finalize(): Transaction bytes: ", bytesAccum);
|
|
172
|
-
|
|
173
|
-
if(changeType!=null) {
|
|
174
|
-
const feeAfterExtraOutput = (feeRate * (bytesAccum + outputBytes({type: changeType}))) + cpfpAddFee;
|
|
175
|
-
logger.debug("finalize(): TX fee after adding change output: ", feeAfterExtraOutput);
|
|
176
|
-
const remainderAfterExtraOutput = Math.floor(sumOrNaN(inputs) - (sumOrNaN(outputs) + feeAfterExtraOutput));
|
|
177
|
-
logger.debug("finalize(): Leaves change (changeType="+changeType+") value: ", remainderAfterExtraOutput);
|
|
178
|
-
|
|
179
|
-
// is it worth a change output?
|
|
180
|
-
if (remainderAfterExtraOutput >= dustThreshold({type: changeType})) {
|
|
181
|
-
outputs = outputs.concat({ value: remainderAfterExtraOutput, type: changeType })
|
|
182
|
-
}
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
const fee = sumOrNaN(inputs) - sumOrNaN(outputs);
|
|
186
|
-
logger.debug("finalize(): Re-calculated total fee: ", fee);
|
|
187
|
-
if (!isFinite(fee) || fee<0) return { fee: (feeRate * bytesAccum) + cpfpAddFee }
|
|
188
|
-
|
|
189
|
-
let txVSize = utils.transactionBytes(inputs, outputs);
|
|
190
|
-
let txFee = fee;
|
|
191
|
-
const cpfpSortedInputs = [...inputs].sort(
|
|
192
|
-
(a, b) => (b.cpfp?.txEffectiveFeeRate ?? 0) - (a.cpfp?.txEffectiveFeeRate ?? 0)
|
|
193
|
-
);
|
|
194
|
-
cpfpSortedInputs.forEach(input => {
|
|
195
|
-
if(input.cpfp==null) return;
|
|
196
|
-
const currentEffectiveFeeRate = txFee / txVSize;
|
|
197
|
-
if(currentEffectiveFeeRate > input.cpfp.txEffectiveFeeRate) {
|
|
198
|
-
txVSize += input.cpfp.txVsize;
|
|
199
|
-
txFee += input.cpfp.txVsize * input.cpfp.txEffectiveFeeRate;
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
);
|
|
203
|
-
|
|
204
|
-
return {
|
|
205
|
-
inputs: inputs,
|
|
206
|
-
outputs: outputs,
|
|
207
|
-
effectiveFeeRate: txFee / txVSize,
|
|
208
|
-
fee: fee
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
function isDetrimentalInput(
|
|
213
|
-
feeRate: number,
|
|
214
|
-
utxo: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">
|
|
215
|
-
) {
|
|
216
|
-
const utxoBytes = utils.inputBytes(utxo);
|
|
217
|
-
const utxoFee = feeRate * utxoBytes;
|
|
218
|
-
let cpfpFee = 0;
|
|
219
|
-
if(utxo.cpfp!=null && utxo.cpfp.txEffectiveFeeRate<feeRate) cpfpFee = Math.ceil(utxo.cpfp.txVsize*(feeRate - utxo.cpfp.txEffectiveFeeRate));
|
|
220
|
-
|
|
221
|
-
// skip detrimental input
|
|
222
|
-
return utxoFee + cpfpFee > utxo.value;
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
export const utils = {
|
|
226
|
-
dustThreshold: dustThreshold,
|
|
227
|
-
finalize: finalize,
|
|
228
|
-
inputBytes: inputBytes,
|
|
229
|
-
outputBytes: outputBytes,
|
|
230
|
-
sumOrNaN: sumOrNaN,
|
|
231
|
-
sumForgiving: sumForgiving,
|
|
232
|
-
transactionBytes: transactionBytes,
|
|
233
|
-
uintOrNaN: uintOrNaN,
|
|
234
|
-
numberOrNaN: numberOrNaN,
|
|
235
|
-
isDetrimentalInput
|
|
236
|
-
};
|
|
1
|
+
import {getLogger} from "../../utils/Logger";
|
|
2
|
+
|
|
3
|
+
const logger = getLogger("CoinSelect: ");
|
|
4
|
+
|
|
5
|
+
// baseline estimates, used to improve performance
|
|
6
|
+
const TX_EMPTY_SIZE = 4 + 1 + 1 + 4;
|
|
7
|
+
const TX_INPUT_BASE = 32 + 4 + 1 + 4;
|
|
8
|
+
|
|
9
|
+
const WITNESS_OVERHEAD = 2/4;
|
|
10
|
+
|
|
11
|
+
const P2WPKH_WITNESS = (1+1+72+1+33)/4;
|
|
12
|
+
const P2TR_WITNESS = (1+1+65)/4;
|
|
13
|
+
|
|
14
|
+
const TX_INPUT_PUBKEYHASH = 107;
|
|
15
|
+
const TX_INPUT_P2SH_P2WPKH = 23 + P2WPKH_WITNESS + 1;
|
|
16
|
+
const TX_INPUT_P2WPKH = 0 + P2WPKH_WITNESS;
|
|
17
|
+
const TX_INPUT_P2WSH = 0 + (1+1+64)/4;
|
|
18
|
+
const TX_INPUT_P2TR = 0 + P2TR_WITNESS;
|
|
19
|
+
|
|
20
|
+
const TX_OUTPUT_BASE = 8 + 1;
|
|
21
|
+
|
|
22
|
+
const TX_OUTPUT_PUBKEYHASH = 25;
|
|
23
|
+
const TX_OUTPUT_P2SH_P2WPKH = 23;
|
|
24
|
+
const TX_OUTPUT_P2WPKH = 22;
|
|
25
|
+
const TX_OUTPUT_P2WSH = 34;
|
|
26
|
+
const TX_OUTPUT_P2TR = 34;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Defines a type of the address used by the wallet, for proper coinselection (as coinselection
|
|
30
|
+
* depends on estimating the cost for spending the input + the cost of adding a change output)
|
|
31
|
+
*
|
|
32
|
+
* @category Bitcoin
|
|
33
|
+
*/
|
|
34
|
+
export type CoinselectAddressTypes = "p2sh-p2wpkh" | "p2wpkh" | "p2wsh" | "p2tr" | "p2pkh";
|
|
35
|
+
|
|
36
|
+
export type CoinselectTxInput = {
|
|
37
|
+
script?: Buffer,
|
|
38
|
+
txId: string,
|
|
39
|
+
vout: number,
|
|
40
|
+
type?: CoinselectAddressTypes,
|
|
41
|
+
value: number,
|
|
42
|
+
outputScript?: Buffer,
|
|
43
|
+
address?: string,
|
|
44
|
+
cpfp?: {
|
|
45
|
+
txVsize: number,
|
|
46
|
+
txEffectiveFeeRate: number
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
export type CoinselectTxOutput = {
|
|
51
|
+
script?: Buffer,
|
|
52
|
+
address?: string,
|
|
53
|
+
type?: CoinselectAddressTypes,
|
|
54
|
+
value: number
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
const INPUT_BYTES = {
|
|
59
|
+
"p2sh-p2wpkh": TX_INPUT_P2SH_P2WPKH,
|
|
60
|
+
"p2wpkh": TX_INPUT_P2WPKH,
|
|
61
|
+
"p2tr": TX_INPUT_P2TR,
|
|
62
|
+
"p2pkh": TX_INPUT_PUBKEYHASH,
|
|
63
|
+
"p2wsh": TX_INPUT_P2WSH
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
function inputBytes (input: {
|
|
67
|
+
script?: Buffer,
|
|
68
|
+
type?: CoinselectAddressTypes
|
|
69
|
+
}) {
|
|
70
|
+
if(input.script==null && input.type==null) throw new Error("Needs either script or type defined!");
|
|
71
|
+
return TX_INPUT_BASE + (input.script ? input.script.length : INPUT_BYTES[input.type!]);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const OUTPUT_BYTES = {
|
|
75
|
+
"p2sh-p2wpkh": TX_OUTPUT_P2SH_P2WPKH,
|
|
76
|
+
"p2wpkh": TX_OUTPUT_P2WPKH,
|
|
77
|
+
"p2tr": TX_OUTPUT_P2TR,
|
|
78
|
+
"p2pkh": TX_OUTPUT_PUBKEYHASH,
|
|
79
|
+
"p2wsh": TX_OUTPUT_P2WSH
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
function outputBytes (output: {
|
|
83
|
+
script?: Buffer,
|
|
84
|
+
type?: CoinselectAddressTypes
|
|
85
|
+
}): number {
|
|
86
|
+
if(output.script==null && output.type==null) throw new Error("Needs either script or type defined!");
|
|
87
|
+
return TX_OUTPUT_BASE + (output.script ? output.script.length : OUTPUT_BYTES[output.type!]);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export const DUST_THRESHOLDS = {
|
|
91
|
+
"p2sh-p2wpkh": 540,
|
|
92
|
+
"p2wpkh": 294,
|
|
93
|
+
"p2tr": 330,
|
|
94
|
+
"p2pkh": 546,
|
|
95
|
+
"p2wsh": 330
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
function dustThreshold (output: {
|
|
99
|
+
script?: Buffer,
|
|
100
|
+
type: CoinselectAddressTypes
|
|
101
|
+
}): number {
|
|
102
|
+
return DUST_THRESHOLDS[output.type];
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
function transactionBytes (
|
|
106
|
+
inputs: {
|
|
107
|
+
script?: Buffer,
|
|
108
|
+
type?: CoinselectAddressTypes
|
|
109
|
+
}[],
|
|
110
|
+
outputs: {
|
|
111
|
+
script?: Buffer,
|
|
112
|
+
type?: CoinselectAddressTypes
|
|
113
|
+
}[],
|
|
114
|
+
changeType?: CoinselectAddressTypes
|
|
115
|
+
): number {
|
|
116
|
+
let size = TX_EMPTY_SIZE;
|
|
117
|
+
let isSegwit = false;
|
|
118
|
+
if(changeType!=null && changeType!=="p2pkh") {
|
|
119
|
+
size += WITNESS_OVERHEAD;
|
|
120
|
+
isSegwit = true;
|
|
121
|
+
}
|
|
122
|
+
for(let input of inputs) {
|
|
123
|
+
if(!isSegwit && (input.type!=="p2pkh")) {
|
|
124
|
+
isSegwit = true;
|
|
125
|
+
size += WITNESS_OVERHEAD;
|
|
126
|
+
}
|
|
127
|
+
size += inputBytes(input);
|
|
128
|
+
}
|
|
129
|
+
for(let output of outputs) {
|
|
130
|
+
size += outputBytes(output);
|
|
131
|
+
}
|
|
132
|
+
return Math.ceil(size);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
function numberOrNaN(v: number): number {
|
|
136
|
+
if (typeof v !== 'number') return NaN;
|
|
137
|
+
if (!isFinite(v)) return NaN;
|
|
138
|
+
if (v < 0) return NaN;
|
|
139
|
+
return v;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function uintOrNaN(v: number): number {
|
|
143
|
+
if (typeof v !== 'number') return NaN;
|
|
144
|
+
if (!isFinite(v)) return NaN;
|
|
145
|
+
if (Math.floor(v) !== v) return NaN;
|
|
146
|
+
if (v < 0) return NaN;
|
|
147
|
+
return v;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
function sumForgiving(range: {value: number}[]): number {
|
|
151
|
+
return range.reduce((a, x) => a + (isFinite(x.value) ? x.value : 0), 0);
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
function sumOrNaN(range: {value: number}[]): number {
|
|
155
|
+
return range.reduce((a, x) => a + uintOrNaN(x.value), 0);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
function finalize<T extends Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">>(
|
|
159
|
+
inputs: T[],
|
|
160
|
+
outputs: CoinselectTxOutput[],
|
|
161
|
+
feeRate: number,
|
|
162
|
+
changeType: CoinselectAddressTypes | null,
|
|
163
|
+
cpfpAddFee: number = 0
|
|
164
|
+
): {
|
|
165
|
+
inputs?: T[],
|
|
166
|
+
outputs?: CoinselectTxOutput[],
|
|
167
|
+
effectiveFeeRate?: number,
|
|
168
|
+
fee: number
|
|
169
|
+
} {
|
|
170
|
+
const bytesAccum = transactionBytes(inputs, outputs, changeType ?? undefined);
|
|
171
|
+
logger.debug("finalize(): Transaction bytes: ", bytesAccum);
|
|
172
|
+
|
|
173
|
+
if(changeType!=null) {
|
|
174
|
+
const feeAfterExtraOutput = (feeRate * (bytesAccum + outputBytes({type: changeType}))) + cpfpAddFee;
|
|
175
|
+
logger.debug("finalize(): TX fee after adding change output: ", feeAfterExtraOutput);
|
|
176
|
+
const remainderAfterExtraOutput = Math.floor(sumOrNaN(inputs) - (sumOrNaN(outputs) + feeAfterExtraOutput));
|
|
177
|
+
logger.debug("finalize(): Leaves change (changeType="+changeType+") value: ", remainderAfterExtraOutput);
|
|
178
|
+
|
|
179
|
+
// is it worth a change output?
|
|
180
|
+
if (remainderAfterExtraOutput >= dustThreshold({type: changeType})) {
|
|
181
|
+
outputs = outputs.concat({ value: remainderAfterExtraOutput, type: changeType })
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
const fee = sumOrNaN(inputs) - sumOrNaN(outputs);
|
|
186
|
+
logger.debug("finalize(): Re-calculated total fee: ", fee);
|
|
187
|
+
if (!isFinite(fee) || fee<0) return { fee: (feeRate * bytesAccum) + cpfpAddFee }
|
|
188
|
+
|
|
189
|
+
let txVSize = utils.transactionBytes(inputs, outputs);
|
|
190
|
+
let txFee = fee;
|
|
191
|
+
const cpfpSortedInputs = [...inputs].sort(
|
|
192
|
+
(a, b) => (b.cpfp?.txEffectiveFeeRate ?? 0) - (a.cpfp?.txEffectiveFeeRate ?? 0)
|
|
193
|
+
);
|
|
194
|
+
cpfpSortedInputs.forEach(input => {
|
|
195
|
+
if(input.cpfp==null) return;
|
|
196
|
+
const currentEffectiveFeeRate = txFee / txVSize;
|
|
197
|
+
if(currentEffectiveFeeRate > input.cpfp.txEffectiveFeeRate) {
|
|
198
|
+
txVSize += input.cpfp.txVsize;
|
|
199
|
+
txFee += input.cpfp.txVsize * input.cpfp.txEffectiveFeeRate;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
);
|
|
203
|
+
|
|
204
|
+
return {
|
|
205
|
+
inputs: inputs,
|
|
206
|
+
outputs: outputs,
|
|
207
|
+
effectiveFeeRate: txFee / txVSize,
|
|
208
|
+
fee: fee
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
function isDetrimentalInput(
|
|
213
|
+
feeRate: number,
|
|
214
|
+
utxo: Omit<CoinselectTxInput, "txId" | "address" | "vout" | "outputScript">
|
|
215
|
+
) {
|
|
216
|
+
const utxoBytes = utils.inputBytes(utxo);
|
|
217
|
+
const utxoFee = feeRate * utxoBytes;
|
|
218
|
+
let cpfpFee = 0;
|
|
219
|
+
if(utxo.cpfp!=null && utxo.cpfp.txEffectiveFeeRate<feeRate) cpfpFee = Math.ceil(utxo.cpfp.txVsize*(feeRate - utxo.cpfp.txEffectiveFeeRate));
|
|
220
|
+
|
|
221
|
+
// skip detrimental input
|
|
222
|
+
return utxoFee + cpfpFee > utxo.value;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
export const utils = {
|
|
226
|
+
dustThreshold: dustThreshold,
|
|
227
|
+
finalize: finalize,
|
|
228
|
+
inputBytes: inputBytes,
|
|
229
|
+
outputBytes: outputBytes,
|
|
230
|
+
sumOrNaN: sumOrNaN,
|
|
231
|
+
sumForgiving: sumForgiving,
|
|
232
|
+
transactionBytes: transactionBytes,
|
|
233
|
+
uintOrNaN: uintOrNaN,
|
|
234
|
+
numberOrNaN: numberOrNaN,
|
|
235
|
+
isDetrimentalInput
|
|
236
|
+
};
|