@atomiqlabs/sdk 8.9.1 → 8.9.2

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.
Files changed (366) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/api/index.d.ts +1 -1
  4. package/api/index.js +3 -3
  5. package/dist/ApiList.d.ts +37 -37
  6. package/dist/ApiList.js +30 -30
  7. package/dist/SmartChainAssets.d.ts +181 -181
  8. package/dist/SmartChainAssets.js +181 -181
  9. package/dist/api/ApiEndpoints.d.ts +393 -393
  10. package/dist/api/ApiEndpoints.js +2 -2
  11. package/dist/api/ApiParser.d.ts +10 -10
  12. package/dist/api/ApiParser.js +134 -134
  13. package/dist/api/ApiTypes.d.ts +157 -157
  14. package/dist/api/ApiTypes.js +75 -75
  15. package/dist/api/SerializedAction.d.ts +40 -40
  16. package/dist/api/SerializedAction.js +59 -59
  17. package/dist/api/SwapperApi.d.ts +50 -50
  18. package/dist/api/SwapperApi.js +431 -431
  19. package/dist/api/index.d.ts +5 -5
  20. package/dist/api/index.js +24 -24
  21. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  22. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  23. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  24. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  25. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  26. package/dist/bitcoin/coinselect2/index.js +69 -69
  27. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  28. package/dist/bitcoin/coinselect2/utils.js +158 -158
  29. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  30. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  31. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  32. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  33. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  34. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  35. package/dist/enums/FeeType.d.ts +15 -15
  36. package/dist/enums/FeeType.js +19 -19
  37. package/dist/enums/SwapAmountType.d.ts +15 -15
  38. package/dist/enums/SwapAmountType.js +19 -19
  39. package/dist/enums/SwapDirection.d.ts +15 -15
  40. package/dist/enums/SwapDirection.js +19 -19
  41. package/dist/enums/SwapSide.d.ts +15 -15
  42. package/dist/enums/SwapSide.js +19 -19
  43. package/dist/enums/SwapType.d.ts +75 -75
  44. package/dist/enums/SwapType.js +79 -79
  45. package/dist/errors/IntermediaryError.d.ts +13 -13
  46. package/dist/errors/IntermediaryError.js +27 -27
  47. package/dist/errors/RequestError.d.ts +32 -32
  48. package/dist/errors/RequestError.js +54 -54
  49. package/dist/errors/UserError.d.ts +8 -8
  50. package/dist/errors/UserError.js +16 -16
  51. package/dist/events/UnifiedSwapEventListener.d.ts +24 -24
  52. package/dist/events/UnifiedSwapEventListener.js +138 -138
  53. package/dist/http/HttpUtils.d.ts +29 -29
  54. package/dist/http/HttpUtils.js +97 -97
  55. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  56. package/dist/http/paramcoders/IParamReader.js +2 -2
  57. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  58. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  59. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  60. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  61. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  62. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  63. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  64. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  65. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  66. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  67. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +17 -17
  68. package/dist/http/paramcoders/client/StreamingFetchPromise.js +175 -175
  69. package/dist/index.d.ts +86 -86
  70. package/dist/index.js +159 -159
  71. package/dist/intermediaries/Intermediary.d.ts +178 -178
  72. package/dist/intermediaries/Intermediary.js +166 -166
  73. package/dist/intermediaries/IntermediaryDiscovery.d.ts +216 -216
  74. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  75. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +607 -607
  76. package/dist/intermediaries/apis/IntermediaryAPI.js +764 -764
  77. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  78. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  79. package/dist/intermediaries/auth/SignedKeyBasedAuth.d.ts +14 -14
  80. package/dist/intermediaries/auth/SignedKeyBasedAuth.js +68 -68
  81. package/dist/lnurl/LNURL.d.ts +102 -102
  82. package/dist/lnurl/LNURL.js +321 -321
  83. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  84. package/dist/prices/RedundantSwapPrice.js +222 -222
  85. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  86. package/dist/prices/SingleSwapPrice.js +44 -44
  87. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  88. package/dist/prices/SwapPriceWithChain.js +128 -128
  89. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  90. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  91. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  92. package/dist/prices/abstract/IPriceProvider.js +74 -74
  93. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  94. package/dist/prices/abstract/ISwapPrice.js +279 -279
  95. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  96. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  97. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  98. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  99. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  100. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  101. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  102. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  103. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  104. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  105. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  106. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  107. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  108. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  109. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  110. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  111. package/dist/storage/IUnifiedStorage.d.ts +127 -127
  112. package/dist/storage/IUnifiedStorage.js +2 -2
  113. package/dist/storage/UnifiedSwapStorage.d.ts +120 -120
  114. package/dist/storage/UnifiedSwapStorage.js +154 -154
  115. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  116. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  117. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  118. package/dist/storage-browser/LocalStorageManager.js +93 -93
  119. package/dist/swapper/Swapper.d.ts +765 -770
  120. package/dist/swapper/Swapper.js +1749 -1758
  121. package/dist/swapper/SwapperFactory.d.ts +135 -135
  122. package/dist/swapper/SwapperFactory.js +162 -162
  123. package/dist/swapper/SwapperUtils.d.ts +222 -222
  124. package/dist/swapper/SwapperUtils.js +519 -519
  125. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  126. package/dist/swapper/SwapperWithChain.js +469 -469
  127. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  128. package/dist/swapper/SwapperWithSigner.js +318 -318
  129. package/dist/swaps/IAddressSwap.d.ts +22 -22
  130. package/dist/swaps/IAddressSwap.js +14 -14
  131. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  132. package/dist/swaps/IBTCWalletSwap.js +18 -18
  133. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  134. package/dist/swaps/IClaimableSwap.js +15 -15
  135. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  136. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  137. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  138. package/dist/swaps/IRefundableSwap.js +14 -14
  139. package/dist/swaps/ISwap.d.ts +453 -453
  140. package/dist/swaps/ISwap.js +371 -371
  141. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  142. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  143. package/dist/swaps/ISwapWrapper.d.ts +295 -295
  144. package/dist/swaps/ISwapWrapper.js +373 -373
  145. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  146. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  147. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  148. package/dist/swaps/escrow_swaps/IEscrowSwap.js +172 -172
  149. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +129 -129
  150. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  151. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +107 -107
  152. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
  153. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  154. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  155. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  156. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  157. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +547 -547
  158. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1419 -1419
  159. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +192 -192
  160. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  161. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +650 -650
  162. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1577 -1577
  163. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +237 -237
  164. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  165. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +491 -491
  166. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1463 -1463
  167. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +204 -204
  168. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  169. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +446 -446
  170. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +1097 -1097
  171. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  172. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  173. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  174. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  175. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +252 -252
  176. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +535 -535
  177. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  178. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  179. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +134 -134
  180. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  181. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +694 -694
  182. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1687 -1687
  183. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +259 -259
  184. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  185. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +302 -302
  186. package/dist/swaps/trusted/ln/LnForGasSwap.js +625 -625
  187. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  188. package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
  189. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +343 -343
  190. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +698 -698
  191. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +71 -71
  192. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  193. package/dist/types/AmountData.d.ts +10 -10
  194. package/dist/types/AmountData.js +2 -2
  195. package/dist/types/CustomPriceFunction.d.ts +11 -11
  196. package/dist/types/CustomPriceFunction.js +2 -2
  197. package/dist/types/PriceInfoType.d.ts +28 -28
  198. package/dist/types/PriceInfoType.js +57 -57
  199. package/dist/types/SwapExecutionAction.d.ts +195 -195
  200. package/dist/types/SwapExecutionAction.js +106 -106
  201. package/dist/types/SwapExecutionStep.d.ts +144 -144
  202. package/dist/types/SwapExecutionStep.js +87 -87
  203. package/dist/types/SwapStateInfo.d.ts +5 -5
  204. package/dist/types/SwapStateInfo.js +2 -2
  205. package/dist/types/SwapWithSigner.d.ts +17 -17
  206. package/dist/types/SwapWithSigner.js +43 -43
  207. package/dist/types/Token.d.ts +99 -99
  208. package/dist/types/Token.js +76 -76
  209. package/dist/types/TokenAmount.d.ts +75 -75
  210. package/dist/types/TokenAmount.js +85 -85
  211. package/dist/types/fees/Fee.d.ts +50 -50
  212. package/dist/types/fees/Fee.js +2 -2
  213. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  214. package/dist/types/fees/FeeBreakdown.js +2 -2
  215. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  216. package/dist/types/fees/PercentagePPM.js +18 -18
  217. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  218. package/dist/types/lnurl/LNURLPay.js +31 -31
  219. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  220. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  221. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  222. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  223. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  224. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  225. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  226. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  227. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  228. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  229. package/dist/utils/BitcoinUtils.d.ts +18 -18
  230. package/dist/utils/BitcoinUtils.js +174 -174
  231. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  232. package/dist/utils/BitcoinWalletUtils.js +14 -14
  233. package/dist/utils/Logger.d.ts +7 -7
  234. package/dist/utils/Logger.js +12 -12
  235. package/dist/utils/RetryUtils.d.ts +22 -22
  236. package/dist/utils/RetryUtils.js +67 -67
  237. package/dist/utils/SwapUtils.d.ts +88 -88
  238. package/dist/utils/SwapUtils.js +72 -72
  239. package/dist/utils/TimeoutUtils.d.ts +17 -17
  240. package/dist/utils/TimeoutUtils.js +55 -55
  241. package/dist/utils/TokenUtils.d.ts +19 -19
  242. package/dist/utils/TokenUtils.js +37 -37
  243. package/dist/utils/TypeUtils.d.ts +7 -7
  244. package/dist/utils/TypeUtils.js +2 -2
  245. package/dist/utils/Utils.d.ts +69 -69
  246. package/dist/utils/Utils.js +214 -214
  247. package/package.json +46 -46
  248. package/src/SmartChainAssets.ts +186 -186
  249. package/src/api/ApiEndpoints.ts +427 -427
  250. package/src/api/ApiParser.ts +138 -138
  251. package/src/api/ApiTypes.ts +229 -229
  252. package/src/api/SerializedAction.ts +97 -97
  253. package/src/api/SwapperApi.ts +545 -545
  254. package/src/api/index.ts +5 -5
  255. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  256. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  257. package/src/bitcoin/coinselect2/index.ts +93 -93
  258. package/src/bitcoin/coinselect2/utils.ts +236 -236
  259. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  260. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  261. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  262. package/src/enums/FeeType.ts +15 -15
  263. package/src/enums/SwapAmountType.ts +16 -16
  264. package/src/enums/SwapDirection.ts +15 -15
  265. package/src/enums/SwapSide.ts +16 -16
  266. package/src/enums/SwapType.ts +75 -75
  267. package/src/errors/IntermediaryError.ts +28 -28
  268. package/src/errors/RequestError.ts +64 -64
  269. package/src/errors/UserError.ts +15 -15
  270. package/src/events/UnifiedSwapEventListener.ts +181 -181
  271. package/src/http/HttpUtils.ts +97 -97
  272. package/src/http/paramcoders/IParamReader.ts +9 -9
  273. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  274. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  275. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  276. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  277. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  278. package/src/http/paramcoders/client/StreamingFetchPromise.ts +194 -194
  279. package/src/index.ts +141 -141
  280. package/src/intermediaries/Intermediary.ts +280 -280
  281. package/src/intermediaries/IntermediaryDiscovery.ts +548 -548
  282. package/src/intermediaries/apis/IntermediaryAPI.ts +1247 -1247
  283. package/src/intermediaries/auth/SignedKeyBasedAuth.ts +69 -69
  284. package/src/lnurl/LNURL.ts +402 -402
  285. package/src/prices/RedundantSwapPrice.ts +264 -264
  286. package/src/prices/SingleSwapPrice.ts +50 -50
  287. package/src/prices/SwapPriceWithChain.ts +194 -194
  288. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  289. package/src/prices/abstract/IPriceProvider.ts +127 -127
  290. package/src/prices/abstract/ISwapPrice.ts +390 -390
  291. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  292. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  293. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  294. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  295. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  296. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  297. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  298. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  299. package/src/storage/IUnifiedStorage.ts +136 -136
  300. package/src/storage/UnifiedSwapStorage.ts +175 -175
  301. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  302. package/src/storage-browser/LocalStorageManager.ts +106 -106
  303. package/src/swapper/Swapper.ts +2557 -2570
  304. package/src/swapper/SwapperFactory.ts +307 -307
  305. package/src/swapper/SwapperUtils.ts +610 -610
  306. package/src/swapper/SwapperWithChain.ts +707 -707
  307. package/src/swapper/SwapperWithSigner.ts +511 -511
  308. package/src/swaps/IAddressSwap.ts +30 -30
  309. package/src/swaps/IBTCWalletSwap.ts +92 -92
  310. package/src/swaps/IClaimableSwap.ts +65 -65
  311. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  312. package/src/swaps/IRefundableSwap.ts +58 -58
  313. package/src/swaps/ISwap.ts +775 -775
  314. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  315. package/src/swaps/ISwapWrapper.ts +564 -564
  316. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  317. package/src/swaps/escrow_swaps/IEscrowSwap.ts +271 -271
  318. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +284 -284
  319. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +172 -172
  320. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  321. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  322. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1670 -1671
  323. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +603 -603
  324. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1883 -1883
  325. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +752 -752
  326. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1753 -1753
  327. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +612 -612
  328. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1327 -1327
  329. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  330. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  331. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +787 -787
  332. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  333. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +403 -403
  334. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +2148 -2148
  335. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1238 -1238
  336. package/src/swaps/trusted/ln/LnForGasSwap.ts +753 -753
  337. package/src/swaps/trusted/ln/LnForGasWrapper.ts +90 -90
  338. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +843 -843
  339. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +133 -133
  340. package/src/types/AmountData.ts +9 -9
  341. package/src/types/CustomPriceFunction.ts +11 -11
  342. package/src/types/PriceInfoType.ts +66 -66
  343. package/src/types/SwapExecutionAction.ts +323 -323
  344. package/src/types/SwapExecutionStep.ts +224 -224
  345. package/src/types/SwapStateInfo.ts +6 -6
  346. package/src/types/SwapWithSigner.ts +61 -61
  347. package/src/types/Token.ts +163 -163
  348. package/src/types/TokenAmount.ts +167 -167
  349. package/src/types/fees/Fee.ts +56 -56
  350. package/src/types/fees/FeeBreakdown.ts +11 -11
  351. package/src/types/fees/PercentagePPM.ts +26 -26
  352. package/src/types/lnurl/LNURLPay.ts +79 -79
  353. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  354. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  355. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  356. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  357. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  358. package/src/utils/BitcoinUtils.ts +164 -164
  359. package/src/utils/BitcoinWalletUtils.ts +15 -15
  360. package/src/utils/Logger.ts +14 -14
  361. package/src/utils/RetryUtils.ts +78 -78
  362. package/src/utils/SwapUtils.ts +99 -99
  363. package/src/utils/TimeoutUtils.ts +49 -49
  364. package/src/utils/TokenUtils.ts +33 -33
  365. package/src/utils/TypeUtils.ts +8 -8
  366. package/src/utils/Utils.ts +221 -221
@@ -1,174 +1,174 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getSenderAddress = exports.getVoutIndex = exports.parsePsbtTransaction = exports.getDummyAddress = exports.getDummyOutputScript = exports.toCoinselectAddressType = exports.toOutputScript = exports.fromOutputScript = void 0;
4
- const utils_1 = require("@scure/btc-signer/utils");
5
- const buffer_1 = require("buffer");
6
- const btc_signer_1 = require("@scure/btc-signer");
7
- const Utils_1 = require("./Utils");
8
- function fromOutputScript(network, outputScriptHex) {
9
- return (0, btc_signer_1.Address)(network).encode(btc_signer_1.OutScript.decode(buffer_1.Buffer.from(outputScriptHex, "hex")));
10
- }
11
- exports.fromOutputScript = fromOutputScript;
12
- function toOutputScript(network, address) {
13
- const outputScript = (0, btc_signer_1.Address)(network).decode(address);
14
- switch (outputScript.type) {
15
- case "pkh":
16
- case "sh":
17
- case "wpkh":
18
- case "wsh":
19
- return buffer_1.Buffer.from(btc_signer_1.OutScript.encode({
20
- type: outputScript.type,
21
- hash: outputScript.hash
22
- }));
23
- case "tr":
24
- try {
25
- return buffer_1.Buffer.from(btc_signer_1.OutScript.encode({
26
- type: "tr",
27
- pubkey: outputScript.pubkey
28
- }));
29
- }
30
- catch (e) {
31
- let msg = "";
32
- if (e.name != null)
33
- msg += ": " + e.name;
34
- if (e.message != null)
35
- msg += ": " + e.message;
36
- if (typeof (e) === "string")
37
- msg += ": " + e;
38
- msg += ", isBytes: " + (0, utils_1.isBytes)(outputScript.pubkey);
39
- try {
40
- (0, utils_1.validatePubkey)(outputScript.pubkey, utils_1.PubT.schnorr);
41
- msg += ", validatePubkey: success";
42
- }
43
- catch (e) {
44
- msg += ", validatePubkeyError: ";
45
- if (e.name != null)
46
- msg += ": " + e.name;
47
- if (e.message != null)
48
- msg += ": " + e.message;
49
- if (typeof (e) === "string")
50
- msg += ": " + e;
51
- }
52
- throw new Error(msg);
53
- }
54
- }
55
- throw new Error(`Unrecognized output script type: ${outputScript.type}`);
56
- }
57
- exports.toOutputScript = toOutputScript;
58
- function toCoinselectAddressType(outputScript) {
59
- const data = btc_signer_1.OutScript.decode(outputScript);
60
- switch (data.type) {
61
- case "pkh":
62
- return "p2pkh";
63
- case "sh":
64
- return "p2sh-p2wpkh";
65
- case "wpkh":
66
- return "p2wpkh";
67
- case "wsh":
68
- return "p2wsh";
69
- case "tr":
70
- return "p2tr";
71
- }
72
- throw new Error("Unrecognized address type!");
73
- }
74
- exports.toCoinselectAddressType = toCoinselectAddressType;
75
- function getDummySpec(type) {
76
- switch (type) {
77
- case "p2pkh":
78
- return {
79
- type: "pkh",
80
- hash: (0, Utils_1.randomBytes)(20)
81
- };
82
- case "p2sh-p2wpkh":
83
- return {
84
- type: "sh",
85
- hash: (0, Utils_1.randomBytes)(20)
86
- };
87
- case "p2wpkh":
88
- return {
89
- type: "wpkh",
90
- hash: (0, Utils_1.randomBytes)(20)
91
- };
92
- case "p2wsh":
93
- return {
94
- type: "wsh",
95
- hash: (0, Utils_1.randomBytes)(32)
96
- };
97
- case "p2tr":
98
- return {
99
- type: "tr",
100
- pubkey: buffer_1.Buffer.from("0101010101010101010101010101010101010101010101010101010101010101", "hex")
101
- };
102
- }
103
- throw new Error("Unrecognized address type!");
104
- }
105
- function getDummyOutputScript(type) {
106
- return btc_signer_1.OutScript.encode(getDummySpec(type));
107
- }
108
- exports.getDummyOutputScript = getDummyOutputScript;
109
- function getDummyAddress(network, type) {
110
- return (0, btc_signer_1.Address)(network).encode(getDummySpec(type));
111
- }
112
- exports.getDummyAddress = getDummyAddress;
113
- /**
114
- * General parsers for PSBTs, can parse hex or base64 encoded PSBTs
115
- * @param _psbt
116
- */
117
- function parsePsbtTransaction(_psbt) {
118
- if (typeof (_psbt) === "string") {
119
- let rawPsbt;
120
- if (/^(?:[0-9a-fA-F]{2})+$/.test(_psbt)) {
121
- //Hex
122
- rawPsbt = buffer_1.Buffer.from(_psbt, "hex");
123
- }
124
- else if (/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(_psbt)) {
125
- //Base64
126
- rawPsbt = buffer_1.Buffer.from(_psbt, "base64");
127
- }
128
- else {
129
- throw new Error("Provided psbt string not base64 nor hex encoded!");
130
- }
131
- return btc_signer_1.Transaction.fromPSBT(rawPsbt, {
132
- allowUnknownOutputs: true,
133
- allowUnknownInputs: true,
134
- allowLegacyWitnessUtxo: true,
135
- });
136
- }
137
- else {
138
- return _psbt;
139
- }
140
- }
141
- exports.parsePsbtTransaction = parsePsbtTransaction;
142
- function getVoutIndex(psbt, network, address, amount) {
143
- const script = toOutputScript(network, address);
144
- for (let i = 0; i < psbt.outputsLength; i++) {
145
- const output = psbt.getOutput(i);
146
- if (output.amount === amount &&
147
- output.script != null &&
148
- script.equals(buffer_1.Buffer.from(output.script))) {
149
- return i;
150
- }
151
- }
152
- }
153
- exports.getVoutIndex = getVoutIndex;
154
- function getSenderAddress(psbt, network, inputIndex = 0) {
155
- if (psbt.inputsLength <= inputIndex)
156
- return undefined;
157
- const input = psbt.getInput(inputIndex);
158
- let script;
159
- if (input.witnessUtxo?.script != null) {
160
- script = input.witnessUtxo.script;
161
- }
162
- else if (input.nonWitnessUtxo != null && input.index != null) {
163
- script = input.nonWitnessUtxo.outputs[input.index]?.script;
164
- }
165
- if (script == null)
166
- return undefined;
167
- try {
168
- return (0, btc_signer_1.Address)(network).encode(btc_signer_1.OutScript.decode(script));
169
- }
170
- catch (e) {
171
- return buffer_1.Buffer.from(script).toString("hex");
172
- }
173
- }
174
- exports.getSenderAddress = getSenderAddress;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getSenderAddress = exports.getVoutIndex = exports.parsePsbtTransaction = exports.getDummyAddress = exports.getDummyOutputScript = exports.toCoinselectAddressType = exports.toOutputScript = exports.fromOutputScript = void 0;
4
+ const utils_1 = require("@scure/btc-signer/utils");
5
+ const buffer_1 = require("buffer");
6
+ const btc_signer_1 = require("@scure/btc-signer");
7
+ const Utils_1 = require("./Utils");
8
+ function fromOutputScript(network, outputScriptHex) {
9
+ return (0, btc_signer_1.Address)(network).encode(btc_signer_1.OutScript.decode(buffer_1.Buffer.from(outputScriptHex, "hex")));
10
+ }
11
+ exports.fromOutputScript = fromOutputScript;
12
+ function toOutputScript(network, address) {
13
+ const outputScript = (0, btc_signer_1.Address)(network).decode(address);
14
+ switch (outputScript.type) {
15
+ case "pkh":
16
+ case "sh":
17
+ case "wpkh":
18
+ case "wsh":
19
+ return buffer_1.Buffer.from(btc_signer_1.OutScript.encode({
20
+ type: outputScript.type,
21
+ hash: outputScript.hash
22
+ }));
23
+ case "tr":
24
+ try {
25
+ return buffer_1.Buffer.from(btc_signer_1.OutScript.encode({
26
+ type: "tr",
27
+ pubkey: outputScript.pubkey
28
+ }));
29
+ }
30
+ catch (e) {
31
+ let msg = "";
32
+ if (e.name != null)
33
+ msg += ": " + e.name;
34
+ if (e.message != null)
35
+ msg += ": " + e.message;
36
+ if (typeof (e) === "string")
37
+ msg += ": " + e;
38
+ msg += ", isBytes: " + (0, utils_1.isBytes)(outputScript.pubkey);
39
+ try {
40
+ (0, utils_1.validatePubkey)(outputScript.pubkey, utils_1.PubT.schnorr);
41
+ msg += ", validatePubkey: success";
42
+ }
43
+ catch (e) {
44
+ msg += ", validatePubkeyError: ";
45
+ if (e.name != null)
46
+ msg += ": " + e.name;
47
+ if (e.message != null)
48
+ msg += ": " + e.message;
49
+ if (typeof (e) === "string")
50
+ msg += ": " + e;
51
+ }
52
+ throw new Error(msg);
53
+ }
54
+ }
55
+ throw new Error(`Unrecognized output script type: ${outputScript.type}`);
56
+ }
57
+ exports.toOutputScript = toOutputScript;
58
+ function toCoinselectAddressType(outputScript) {
59
+ const data = btc_signer_1.OutScript.decode(outputScript);
60
+ switch (data.type) {
61
+ case "pkh":
62
+ return "p2pkh";
63
+ case "sh":
64
+ return "p2sh-p2wpkh";
65
+ case "wpkh":
66
+ return "p2wpkh";
67
+ case "wsh":
68
+ return "p2wsh";
69
+ case "tr":
70
+ return "p2tr";
71
+ }
72
+ throw new Error("Unrecognized address type!");
73
+ }
74
+ exports.toCoinselectAddressType = toCoinselectAddressType;
75
+ function getDummySpec(type) {
76
+ switch (type) {
77
+ case "p2pkh":
78
+ return {
79
+ type: "pkh",
80
+ hash: (0, Utils_1.randomBytes)(20)
81
+ };
82
+ case "p2sh-p2wpkh":
83
+ return {
84
+ type: "sh",
85
+ hash: (0, Utils_1.randomBytes)(20)
86
+ };
87
+ case "p2wpkh":
88
+ return {
89
+ type: "wpkh",
90
+ hash: (0, Utils_1.randomBytes)(20)
91
+ };
92
+ case "p2wsh":
93
+ return {
94
+ type: "wsh",
95
+ hash: (0, Utils_1.randomBytes)(32)
96
+ };
97
+ case "p2tr":
98
+ return {
99
+ type: "tr",
100
+ pubkey: buffer_1.Buffer.from("0101010101010101010101010101010101010101010101010101010101010101", "hex")
101
+ };
102
+ }
103
+ throw new Error("Unrecognized address type!");
104
+ }
105
+ function getDummyOutputScript(type) {
106
+ return btc_signer_1.OutScript.encode(getDummySpec(type));
107
+ }
108
+ exports.getDummyOutputScript = getDummyOutputScript;
109
+ function getDummyAddress(network, type) {
110
+ return (0, btc_signer_1.Address)(network).encode(getDummySpec(type));
111
+ }
112
+ exports.getDummyAddress = getDummyAddress;
113
+ /**
114
+ * General parsers for PSBTs, can parse hex or base64 encoded PSBTs
115
+ * @param _psbt
116
+ */
117
+ function parsePsbtTransaction(_psbt) {
118
+ if (typeof (_psbt) === "string") {
119
+ let rawPsbt;
120
+ if (/^(?:[0-9a-fA-F]{2})+$/.test(_psbt)) {
121
+ //Hex
122
+ rawPsbt = buffer_1.Buffer.from(_psbt, "hex");
123
+ }
124
+ else if (/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(_psbt)) {
125
+ //Base64
126
+ rawPsbt = buffer_1.Buffer.from(_psbt, "base64");
127
+ }
128
+ else {
129
+ throw new Error("Provided psbt string not base64 nor hex encoded!");
130
+ }
131
+ return btc_signer_1.Transaction.fromPSBT(rawPsbt, {
132
+ allowUnknownOutputs: true,
133
+ allowUnknownInputs: true,
134
+ allowLegacyWitnessUtxo: true,
135
+ });
136
+ }
137
+ else {
138
+ return _psbt;
139
+ }
140
+ }
141
+ exports.parsePsbtTransaction = parsePsbtTransaction;
142
+ function getVoutIndex(psbt, network, address, amount) {
143
+ const script = toOutputScript(network, address);
144
+ for (let i = 0; i < psbt.outputsLength; i++) {
145
+ const output = psbt.getOutput(i);
146
+ if (output.amount === amount &&
147
+ output.script != null &&
148
+ script.equals(buffer_1.Buffer.from(output.script))) {
149
+ return i;
150
+ }
151
+ }
152
+ }
153
+ exports.getVoutIndex = getVoutIndex;
154
+ function getSenderAddress(psbt, network, inputIndex = 0) {
155
+ if (psbt.inputsLength <= inputIndex)
156
+ return undefined;
157
+ const input = psbt.getInput(inputIndex);
158
+ let script;
159
+ if (input.witnessUtxo?.script != null) {
160
+ script = input.witnessUtxo.script;
161
+ }
162
+ else if (input.nonWitnessUtxo != null && input.index != null) {
163
+ script = input.nonWitnessUtxo.outputs[input.index]?.script;
164
+ }
165
+ if (script == null)
166
+ return undefined;
167
+ try {
168
+ return (0, btc_signer_1.Address)(network).encode(btc_signer_1.OutScript.decode(script));
169
+ }
170
+ catch (e) {
171
+ return buffer_1.Buffer.from(script).toString("hex");
172
+ }
173
+ }
174
+ exports.getSenderAddress = getSenderAddress;
@@ -1,7 +1,7 @@
1
- import { IBitcoinWallet } from "../bitcoin/wallet/IBitcoinWallet";
2
- import { BTC_NETWORK } from "@scure/btc-signer/utils";
3
- import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
4
- export declare function toBitcoinWallet(_bitcoinWallet: IBitcoinWallet | {
5
- address: string;
6
- publicKey: string;
7
- }, btcRpc: BitcoinRpcWithAddressIndex<any>, bitcoinNetwork: BTC_NETWORK | BitcoinNetwork): IBitcoinWallet;
1
+ import { IBitcoinWallet } from "../bitcoin/wallet/IBitcoinWallet";
2
+ import { BTC_NETWORK } from "@scure/btc-signer/utils";
3
+ import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
4
+ export declare function toBitcoinWallet(_bitcoinWallet: IBitcoinWallet | {
5
+ address: string;
6
+ publicKey: string;
7
+ }, btcRpc: BitcoinRpcWithAddressIndex<any>, bitcoinNetwork: BTC_NETWORK | BitcoinNetwork): IBitcoinWallet;
@@ -1,14 +1,14 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.toBitcoinWallet = void 0;
4
- const IBitcoinWallet_1 = require("../bitcoin/wallet/IBitcoinWallet");
5
- const SingleAddressBitcoinWallet_1 = require("../bitcoin/wallet/SingleAddressBitcoinWallet");
6
- function toBitcoinWallet(_bitcoinWallet, btcRpc, bitcoinNetwork) {
7
- if ((0, IBitcoinWallet_1.isIBitcoinWallet)(_bitcoinWallet)) {
8
- return _bitcoinWallet;
9
- }
10
- else {
11
- return new SingleAddressBitcoinWallet_1.SingleAddressBitcoinWallet(btcRpc, bitcoinNetwork, _bitcoinWallet);
12
- }
13
- }
14
- exports.toBitcoinWallet = toBitcoinWallet;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.toBitcoinWallet = void 0;
4
+ const IBitcoinWallet_1 = require("../bitcoin/wallet/IBitcoinWallet");
5
+ const SingleAddressBitcoinWallet_1 = require("../bitcoin/wallet/SingleAddressBitcoinWallet");
6
+ function toBitcoinWallet(_bitcoinWallet, btcRpc, bitcoinNetwork) {
7
+ if ((0, IBitcoinWallet_1.isIBitcoinWallet)(_bitcoinWallet)) {
8
+ return _bitcoinWallet;
9
+ }
10
+ else {
11
+ return new SingleAddressBitcoinWallet_1.SingleAddressBitcoinWallet(btcRpc, bitcoinNetwork, _bitcoinWallet);
12
+ }
13
+ }
14
+ exports.toBitcoinWallet = toBitcoinWallet;
@@ -1,7 +1,7 @@
1
- export type LoggerType = {
2
- debug: (msg: string, ...args: any[]) => void;
3
- info: (msg: string, ...args: any[]) => void;
4
- warn: (msg: string, ...args: any[]) => void;
5
- error: (msg: string, ...args: any[]) => void;
6
- };
7
- export declare function getLogger(prefix: string): LoggerType;
1
+ export type LoggerType = {
2
+ debug: (msg: string, ...args: any[]) => void;
3
+ info: (msg: string, ...args: any[]) => void;
4
+ warn: (msg: string, ...args: any[]) => void;
5
+ error: (msg: string, ...args: any[]) => void;
6
+ };
7
+ export declare function getLogger(prefix: string): LoggerType;
@@ -1,12 +1,12 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getLogger = void 0;
4
- function getLogger(prefix) {
5
- return {
6
- debug: (msg, ...args) => global.atomiqLogLevel >= 3 && console.debug(prefix + msg, ...args),
7
- info: (msg, ...args) => global.atomiqLogLevel >= 2 && console.info(prefix + msg, ...args),
8
- warn: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 1) && console.warn(prefix + msg, ...args),
9
- error: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 0) && console.error(prefix + msg, ...args)
10
- };
11
- }
12
- exports.getLogger = getLogger;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getLogger = void 0;
4
+ function getLogger(prefix) {
5
+ return {
6
+ debug: (msg, ...args) => global.atomiqLogLevel >= 3 && console.debug(prefix + msg, ...args),
7
+ info: (msg, ...args) => global.atomiqLogLevel >= 2 && console.info(prefix + msg, ...args),
8
+ warn: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 1) && console.warn(prefix + msg, ...args),
9
+ error: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 0) && console.error(prefix + msg, ...args)
10
+ };
11
+ }
12
+ exports.getLogger = getLogger;
@@ -1,22 +1,22 @@
1
- type Constructor<T = any> = new (...args: any[]) => T;
2
- /**
3
- * Runs the passed function multiple times if it fails
4
- *
5
- * @param func A callback for executing the action
6
- * @param func.retryCount Count of the current retry, starting from 0 for original request and increasing
7
- * @param retryPolicy Retry policy
8
- * @param retryPolicy.maxRetries How many retries to attempt in total
9
- * @param retryPolicy.delay How long should the delay be
10
- * @param retryPolicy.exponential Whether to use exponentially increasing delays
11
- * @param errorAllowed A callback for determining whether a given error is allowed, and we should therefore not retry
12
- * @param abortSignal
13
- * @param failureLogLevel
14
- * @returns Result of the action executing callback
15
- * @category Utilities
16
- */
17
- export declare function tryWithRetries<T>(func: (retryCount: number) => Promise<T>, retryPolicy?: {
18
- maxRetries?: number;
19
- delay?: number;
20
- exponential?: boolean;
21
- }, errorAllowed?: ((e: any) => boolean) | Constructor<Error> | Constructor<Error>[], abortSignal?: AbortSignal, failureLogLevel?: "debug" | "info" | "warn" | "error"): Promise<T>;
22
- export {};
1
+ type Constructor<T = any> = new (...args: any[]) => T;
2
+ /**
3
+ * Runs the passed function multiple times if it fails
4
+ *
5
+ * @param func A callback for executing the action
6
+ * @param func.retryCount Count of the current retry, starting from 0 for original request and increasing
7
+ * @param retryPolicy Retry policy
8
+ * @param retryPolicy.maxRetries How many retries to attempt in total
9
+ * @param retryPolicy.delay How long should the delay be
10
+ * @param retryPolicy.exponential Whether to use exponentially increasing delays
11
+ * @param errorAllowed A callback for determining whether a given error is allowed, and we should therefore not retry
12
+ * @param abortSignal
13
+ * @param failureLogLevel
14
+ * @returns Result of the action executing callback
15
+ * @category Utilities
16
+ */
17
+ export declare function tryWithRetries<T>(func: (retryCount: number) => Promise<T>, retryPolicy?: {
18
+ maxRetries?: number;
19
+ delay?: number;
20
+ exponential?: boolean;
21
+ }, errorAllowed?: ((e: any) => boolean) | Constructor<Error> | Constructor<Error>[], abortSignal?: AbortSignal, failureLogLevel?: "debug" | "info" | "warn" | "error"): Promise<T>;
22
+ export {};
@@ -1,67 +1,67 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.tryWithRetries = void 0;
4
- const TimeoutUtils_1 = require("./TimeoutUtils");
5
- const Logger_1 = require("./Logger");
6
- const logger = (0, Logger_1.getLogger)("RetryUtils: ");
7
- function isConstructor(fn) {
8
- return (typeof fn === 'function' &&
9
- fn.prototype != null &&
10
- fn.prototype.constructor === fn);
11
- }
12
- function isConstructorArray(fnArr) {
13
- return Array.isArray(fnArr) && fnArr.every(isConstructor);
14
- }
15
- /**
16
- * Checks whether the passed error is allowed to pass through
17
- *
18
- * @param e Error in question
19
- * @param errorAllowed Allowed errors as defined as a callback function, specific error type, or an array of error types
20
- */
21
- function checkError(e, errorAllowed) {
22
- if (isConstructorArray(errorAllowed))
23
- return errorAllowed.find(error => e instanceof error) != null;
24
- if (isConstructor(errorAllowed))
25
- return e instanceof errorAllowed;
26
- return errorAllowed(e);
27
- }
28
- /**
29
- * Runs the passed function multiple times if it fails
30
- *
31
- * @param func A callback for executing the action
32
- * @param func.retryCount Count of the current retry, starting from 0 for original request and increasing
33
- * @param retryPolicy Retry policy
34
- * @param retryPolicy.maxRetries How many retries to attempt in total
35
- * @param retryPolicy.delay How long should the delay be
36
- * @param retryPolicy.exponential Whether to use exponentially increasing delays
37
- * @param errorAllowed A callback for determining whether a given error is allowed, and we should therefore not retry
38
- * @param abortSignal
39
- * @param failureLogLevel
40
- * @returns Result of the action executing callback
41
- * @category Utilities
42
- */
43
- async function tryWithRetries(func, retryPolicy, errorAllowed, abortSignal, failureLogLevel = "warn") {
44
- retryPolicy = retryPolicy || {};
45
- retryPolicy.maxRetries = retryPolicy.maxRetries || 5;
46
- retryPolicy.delay = retryPolicy.delay || 500;
47
- retryPolicy.exponential = retryPolicy.exponential == null ? true : retryPolicy.exponential;
48
- let err = null;
49
- for (let i = 0; i < retryPolicy.maxRetries; i++) {
50
- try {
51
- return await func(i);
52
- }
53
- catch (e) {
54
- if (errorAllowed != null && checkError(e, errorAllowed))
55
- throw e;
56
- err = e;
57
- logger[failureLogLevel]("tryWithRetries(): Error on try number: " + i, e);
58
- }
59
- if (abortSignal != null && abortSignal.aborted)
60
- throw (abortSignal.reason || new Error("Aborted"));
61
- if (i !== retryPolicy.maxRetries - 1) {
62
- await (0, TimeoutUtils_1.timeoutPromise)(retryPolicy.exponential ? retryPolicy.delay * Math.pow(2, i) : retryPolicy.delay, abortSignal);
63
- }
64
- }
65
- throw err;
66
- }
67
- exports.tryWithRetries = tryWithRetries;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.tryWithRetries = void 0;
4
+ const TimeoutUtils_1 = require("./TimeoutUtils");
5
+ const Logger_1 = require("./Logger");
6
+ const logger = (0, Logger_1.getLogger)("RetryUtils: ");
7
+ function isConstructor(fn) {
8
+ return (typeof fn === 'function' &&
9
+ fn.prototype != null &&
10
+ fn.prototype.constructor === fn);
11
+ }
12
+ function isConstructorArray(fnArr) {
13
+ return Array.isArray(fnArr) && fnArr.every(isConstructor);
14
+ }
15
+ /**
16
+ * Checks whether the passed error is allowed to pass through
17
+ *
18
+ * @param e Error in question
19
+ * @param errorAllowed Allowed errors as defined as a callback function, specific error type, or an array of error types
20
+ */
21
+ function checkError(e, errorAllowed) {
22
+ if (isConstructorArray(errorAllowed))
23
+ return errorAllowed.find(error => e instanceof error) != null;
24
+ if (isConstructor(errorAllowed))
25
+ return e instanceof errorAllowed;
26
+ return errorAllowed(e);
27
+ }
28
+ /**
29
+ * Runs the passed function multiple times if it fails
30
+ *
31
+ * @param func A callback for executing the action
32
+ * @param func.retryCount Count of the current retry, starting from 0 for original request and increasing
33
+ * @param retryPolicy Retry policy
34
+ * @param retryPolicy.maxRetries How many retries to attempt in total
35
+ * @param retryPolicy.delay How long should the delay be
36
+ * @param retryPolicy.exponential Whether to use exponentially increasing delays
37
+ * @param errorAllowed A callback for determining whether a given error is allowed, and we should therefore not retry
38
+ * @param abortSignal
39
+ * @param failureLogLevel
40
+ * @returns Result of the action executing callback
41
+ * @category Utilities
42
+ */
43
+ async function tryWithRetries(func, retryPolicy, errorAllowed, abortSignal, failureLogLevel = "warn") {
44
+ retryPolicy = retryPolicy || {};
45
+ retryPolicy.maxRetries = retryPolicy.maxRetries || 5;
46
+ retryPolicy.delay = retryPolicy.delay || 500;
47
+ retryPolicy.exponential = retryPolicy.exponential == null ? true : retryPolicy.exponential;
48
+ let err = null;
49
+ for (let i = 0; i < retryPolicy.maxRetries; i++) {
50
+ try {
51
+ return await func(i);
52
+ }
53
+ catch (e) {
54
+ if (errorAllowed != null && checkError(e, errorAllowed))
55
+ throw e;
56
+ err = e;
57
+ logger[failureLogLevel]("tryWithRetries(): Error on try number: " + i, e);
58
+ }
59
+ if (abortSignal != null && abortSignal.aborted)
60
+ throw (abortSignal.reason || new Error("Aborted"));
61
+ if (i !== retryPolicy.maxRetries - 1) {
62
+ await (0, TimeoutUtils_1.timeoutPromise)(retryPolicy.exponential ? retryPolicy.delay * Math.pow(2, i) : retryPolicy.delay, abortSignal);
63
+ }
64
+ }
65
+ throw err;
66
+ }
67
+ exports.tryWithRetries = tryWithRetries;