@atomiqlabs/lp-lib 17.5.1 → 17.5.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 (170) hide show
  1. package/LICENSE +201 -201
  2. package/dist/fees/IBtcFeeEstimator.d.ts +3 -3
  3. package/dist/fees/IBtcFeeEstimator.js +2 -2
  4. package/dist/index.d.ts +43 -43
  5. package/dist/index.js +59 -59
  6. package/dist/info/InfoHandler.d.ts +17 -17
  7. package/dist/info/InfoHandler.js +61 -61
  8. package/dist/plugins/IPlugin.d.ts +158 -158
  9. package/dist/plugins/IPlugin.js +35 -35
  10. package/dist/plugins/PluginManager.d.ts +115 -115
  11. package/dist/plugins/PluginManager.js +304 -304
  12. package/dist/prices/BinanceSwapPrice.d.ts +29 -29
  13. package/dist/prices/BinanceSwapPrice.js +79 -79
  14. package/dist/prices/CoinGeckoSwapPrice.d.ts +33 -33
  15. package/dist/prices/CoinGeckoSwapPrice.js +51 -51
  16. package/dist/prices/ISwapPrice.d.ts +43 -43
  17. package/dist/prices/ISwapPrice.js +55 -55
  18. package/dist/prices/OKXSwapPrice.d.ts +29 -29
  19. package/dist/prices/OKXSwapPrice.js +79 -79
  20. package/dist/storage/IIntermediaryStorage.d.ts +18 -18
  21. package/dist/storage/IIntermediaryStorage.js +2 -2
  22. package/dist/storagemanager/IntermediaryStorageManager.d.ts +19 -19
  23. package/dist/storagemanager/IntermediaryStorageManager.js +111 -111
  24. package/dist/storagemanager/StorageManager.d.ts +13 -13
  25. package/dist/storagemanager/StorageManager.js +64 -64
  26. package/dist/swaps/SwapHandler.d.ts +178 -178
  27. package/dist/swaps/SwapHandler.js +225 -225
  28. package/dist/swaps/SwapHandlerSwap.d.ts +80 -80
  29. package/dist/swaps/SwapHandlerSwap.js +78 -78
  30. package/dist/swaps/assertions/AmountAssertions.d.ts +37 -37
  31. package/dist/swaps/assertions/AmountAssertions.js +83 -83
  32. package/dist/swaps/assertions/FromBtcAmountAssertions.d.ts +76 -76
  33. package/dist/swaps/assertions/FromBtcAmountAssertions.js +189 -189
  34. package/dist/swaps/assertions/LightningAssertions.d.ts +44 -44
  35. package/dist/swaps/assertions/LightningAssertions.js +86 -86
  36. package/dist/swaps/assertions/ToBtcAmountAssertions.d.ts +53 -53
  37. package/dist/swaps/assertions/ToBtcAmountAssertions.js +154 -154
  38. package/dist/swaps/escrow/EscrowHandler.d.ts +50 -50
  39. package/dist/swaps/escrow/EscrowHandler.js +151 -151
  40. package/dist/swaps/escrow/EscrowHandlerSwap.d.ts +35 -35
  41. package/dist/swaps/escrow/EscrowHandlerSwap.js +69 -69
  42. package/dist/swaps/escrow/FromBtcBaseSwap.d.ts +14 -14
  43. package/dist/swaps/escrow/FromBtcBaseSwap.js +32 -32
  44. package/dist/swaps/escrow/FromBtcBaseSwapHandler.d.ts +102 -102
  45. package/dist/swaps/escrow/FromBtcBaseSwapHandler.js +210 -210
  46. package/dist/swaps/escrow/ToBtcBaseSwap.d.ts +36 -36
  47. package/dist/swaps/escrow/ToBtcBaseSwap.js +67 -67
  48. package/dist/swaps/escrow/ToBtcBaseSwapHandler.d.ts +53 -53
  49. package/dist/swaps/escrow/ToBtcBaseSwapHandler.js +81 -81
  50. package/dist/swaps/escrow/frombtc_abstract/FromBtcAbs.d.ts +84 -84
  51. package/dist/swaps/escrow/frombtc_abstract/FromBtcAbs.js +329 -329
  52. package/dist/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.d.ts +22 -22
  53. package/dist/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.js +53 -53
  54. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.d.ts +115 -115
  55. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.js +719 -719
  56. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.d.ts +34 -34
  57. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.js +94 -94
  58. package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.d.ts +119 -119
  59. package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.js +730 -730
  60. package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAutoSwap.d.ts +56 -56
  61. package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAutoSwap.js +123 -123
  62. package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.d.ts +170 -170
  63. package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.js +769 -769
  64. package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.d.ts +29 -29
  65. package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.js +67 -67
  66. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.d.ts +178 -178
  67. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.js +912 -912
  68. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.d.ts +25 -25
  69. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.js +61 -61
  70. package/dist/swaps/spv_vault_swap/SpvVault.d.ts +45 -45
  71. package/dist/swaps/spv_vault_swap/SpvVault.js +148 -148
  72. package/dist/swaps/spv_vault_swap/SpvVaultSwap.d.ts +71 -71
  73. package/dist/swaps/spv_vault_swap/SpvVaultSwap.js +165 -165
  74. package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.d.ts +72 -72
  75. package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.js +710 -710
  76. package/dist/swaps/spv_vault_swap/SpvVaults.d.ts +70 -70
  77. package/dist/swaps/spv_vault_swap/SpvVaults.js +554 -554
  78. package/dist/swaps/spv_vault_swap/StickyAddress.d.ts +6 -6
  79. package/dist/swaps/spv_vault_swap/StickyAddress.js +19 -19
  80. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrusted.d.ts +52 -52
  81. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrusted.js +677 -677
  82. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.d.ts +53 -53
  83. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.js +121 -121
  84. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.d.ts +77 -77
  85. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.js +518 -518
  86. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.d.ts +35 -35
  87. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.js +84 -84
  88. package/dist/utils/BitcoinUtils.d.ts +4 -4
  89. package/dist/utils/BitcoinUtils.js +61 -61
  90. package/dist/utils/Utils.d.ts +32 -32
  91. package/dist/utils/Utils.js +130 -130
  92. package/dist/utils/paramcoders/IParamReader.d.ts +5 -5
  93. package/dist/utils/paramcoders/IParamReader.js +2 -2
  94. package/dist/utils/paramcoders/IParamWriter.d.ts +4 -4
  95. package/dist/utils/paramcoders/IParamWriter.js +2 -2
  96. package/dist/utils/paramcoders/LegacyParamEncoder.d.ts +10 -10
  97. package/dist/utils/paramcoders/LegacyParamEncoder.js +22 -22
  98. package/dist/utils/paramcoders/ParamDecoder.d.ts +25 -25
  99. package/dist/utils/paramcoders/ParamDecoder.js +222 -222
  100. package/dist/utils/paramcoders/ParamEncoder.d.ts +9 -9
  101. package/dist/utils/paramcoders/ParamEncoder.js +22 -22
  102. package/dist/utils/paramcoders/SchemaVerifier.d.ts +21 -21
  103. package/dist/utils/paramcoders/SchemaVerifier.js +84 -84
  104. package/dist/utils/paramcoders/server/ServerParamDecoder.d.ts +8 -8
  105. package/dist/utils/paramcoders/server/ServerParamDecoder.js +107 -107
  106. package/dist/utils/paramcoders/server/ServerParamEncoder.d.ts +11 -11
  107. package/dist/utils/paramcoders/server/ServerParamEncoder.js +65 -65
  108. package/dist/wallets/IBitcoinWallet.d.ts +155 -155
  109. package/dist/wallets/IBitcoinWallet.js +100 -100
  110. package/dist/wallets/ILightningWallet.d.ts +137 -137
  111. package/dist/wallets/ILightningWallet.js +37 -37
  112. package/dist/wallets/ISpvVaultSigner.d.ts +7 -7
  113. package/dist/wallets/ISpvVaultSigner.js +2 -2
  114. package/package.json +37 -37
  115. package/src/fees/IBtcFeeEstimator.ts +6 -6
  116. package/src/index.ts +54 -54
  117. package/src/info/InfoHandler.ts +106 -106
  118. package/src/plugins/IPlugin.ts +196 -196
  119. package/src/plugins/PluginManager.ts +389 -389
  120. package/src/prices/BinanceSwapPrice.ts +101 -101
  121. package/src/prices/CoinGeckoSwapPrice.ts +75 -75
  122. package/src/prices/ISwapPrice.ts +88 -88
  123. package/src/prices/OKXSwapPrice.ts +101 -101
  124. package/src/storage/IIntermediaryStorage.ts +19 -19
  125. package/src/storagemanager/IntermediaryStorageManager.ts +118 -118
  126. package/src/storagemanager/StorageManager.ts +78 -78
  127. package/src/swaps/SwapHandler.ts +337 -337
  128. package/src/swaps/SwapHandlerSwap.ts +143 -143
  129. package/src/swaps/assertions/AmountAssertions.ts +97 -97
  130. package/src/swaps/assertions/FromBtcAmountAssertions.ts +257 -257
  131. package/src/swaps/assertions/LightningAssertions.ts +103 -103
  132. package/src/swaps/assertions/ToBtcAmountAssertions.ts +209 -209
  133. package/src/swaps/escrow/EscrowHandler.ts +172 -172
  134. package/src/swaps/escrow/EscrowHandlerSwap.ts +86 -86
  135. package/src/swaps/escrow/FromBtcBaseSwap.ts +38 -38
  136. package/src/swaps/escrow/FromBtcBaseSwapHandler.ts +286 -286
  137. package/src/swaps/escrow/ToBtcBaseSwap.ts +85 -85
  138. package/src/swaps/escrow/ToBtcBaseSwapHandler.ts +129 -129
  139. package/src/swaps/escrow/frombtc_abstract/FromBtcAbs.ts +468 -468
  140. package/src/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.ts +65 -65
  141. package/src/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.ts +900 -900
  142. package/src/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.ts +145 -145
  143. package/src/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.ts +892 -892
  144. package/src/swaps/escrow/frombtcln_autoinit/FromBtcLnAutoSwap.ts +200 -200
  145. package/src/swaps/escrow/tobtc_abstract/ToBtcAbs.ts +947 -947
  146. package/src/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.ts +112 -112
  147. package/src/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.ts +1167 -1167
  148. package/src/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.ts +84 -84
  149. package/src/swaps/spv_vault_swap/SpvVault.ts +182 -182
  150. package/src/swaps/spv_vault_swap/SpvVaultSwap.ts +239 -239
  151. package/src/swaps/spv_vault_swap/SpvVaultSwapHandler.ts +897 -897
  152. package/src/swaps/spv_vault_swap/SpvVaults.ts +640 -640
  153. package/src/swaps/spv_vault_swap/StickyAddress.ts +20 -20
  154. package/src/swaps/trusted/frombtc_trusted/FromBtcTrusted.ts +782 -782
  155. package/src/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.ts +189 -189
  156. package/src/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.ts +622 -622
  157. package/src/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.ts +125 -125
  158. package/src/utils/BitcoinUtils.ts +59 -59
  159. package/src/utils/Utils.ts +152 -152
  160. package/src/utils/paramcoders/IParamReader.ts +7 -7
  161. package/src/utils/paramcoders/IParamWriter.ts +8 -8
  162. package/src/utils/paramcoders/LegacyParamEncoder.ts +27 -27
  163. package/src/utils/paramcoders/ParamDecoder.ts +218 -218
  164. package/src/utils/paramcoders/ParamEncoder.ts +29 -29
  165. package/src/utils/paramcoders/SchemaVerifier.ts +96 -96
  166. package/src/utils/paramcoders/server/ServerParamDecoder.ts +118 -118
  167. package/src/utils/paramcoders/server/ServerParamEncoder.ts +75 -75
  168. package/src/wallets/IBitcoinWallet.ts +246 -246
  169. package/src/wallets/ILightningWallet.ts +201 -201
  170. package/src/wallets/ISpvVaultSigner.ts +10 -10
@@ -1,337 +1,337 @@
1
- import {Express, Request} from "express";
2
- import {ISwapPrice} from "../prices/ISwapPrice";
3
- import {
4
- ChainType
5
- } from "@atomiqlabs/base";
6
- import {SwapHandlerSwap} from "./SwapHandlerSwap";
7
- import {PluginManager} from "../plugins/PluginManager";
8
- import {IIntermediaryStorage} from "../storage/IIntermediaryStorage";
9
- import {IParamReader} from "../utils/paramcoders/IParamReader";
10
- import {getLogger, LoggerType} from "../utils/Utils";
11
-
12
- export enum SwapHandlerType {
13
- TO_BTC = "TO_BTC",
14
- FROM_BTC = "FROM_BTC",
15
- TO_BTCLN = "TO_BTCLN",
16
- FROM_BTCLN = "FROM_BTCLN",
17
- FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
18
- FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
19
- FROM_BTC_SPV = "FROM_BTC_SPV",
20
- FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
21
- }
22
-
23
- export type SwapHandlerInfoType = {
24
- swapFeePPM: number,
25
- swapBaseFee: number,
26
- min: number,
27
- max: number,
28
- chainTokens: {[chainId: string]: string[]};
29
- data?: any,
30
- };
31
-
32
- export type SwapBaseConfig = {
33
- initAuthorizationTimeout: number,
34
- initAuthorizationTimeouts?: {
35
- [chainId: string]: number
36
- },
37
- minNativeBalances?: {
38
- [chainId: string]: bigint
39
- },
40
- maxInflightSwaps?: number,
41
- bitcoinBlocktime: bigint,
42
- baseFee: bigint,
43
- feePPM: bigint,
44
- safetyFactor: bigint,
45
- swapCheckInterval: number,
46
-
47
- max: bigint,
48
- min: bigint,
49
-
50
- minMaxOverrides?: {
51
- [chainIdentifier: string]: {min: bigint, max: bigint}
52
- }
53
- };
54
-
55
- export type MultichainData = {
56
- chains: {
57
- [identifier: string]: ChainData
58
- }
59
- };
60
-
61
- export type ChainData<T extends ChainType = ChainType> = {
62
- signer: T["Signer"],
63
- swapContract: T["Contract"],
64
- spvVaultContract: T["SpvVaultContract"],
65
- chainInterface: T["ChainInterface"],
66
- chainEvents: T["Events"],
67
- allowedTokens: string[],
68
- tokenMultipliers?: {[tokenAddress: string]: bigint},
69
- allowedDepositTokens?: string[],
70
- btcRelay?: T["BtcRelay"],
71
- contractVersion?: string
72
- }
73
-
74
- export type RequestData<T> = {
75
- chainIdentifier: string,
76
- raw: Request & {paramReader: IParamReader},
77
- parsed: T,
78
- metadata: any
79
- };
80
-
81
- /**
82
- * An abstract class defining a singular swap service
83
- */
84
- export abstract class SwapHandler<V extends SwapHandlerSwap<S> = SwapHandlerSwap, S = any> {
85
-
86
- abstract readonly type: SwapHandlerType;
87
-
88
- readonly storageManager: IIntermediaryStorage<V>;
89
- readonly path: string;
90
-
91
- readonly chains: MultichainData;
92
- readonly allowedTokens: {[chainId: string]: Set<string>};
93
- readonly swapPricing: ISwapPrice;
94
-
95
- abstract readonly inflightSwapStates: Set<S>;
96
- abstract config: SwapBaseConfig;
97
-
98
- inflightSwaps: Set<string> = new Set();
99
-
100
- logger: LoggerType = getLogger(() => "SwapHandler("+this.type+"): ");
101
-
102
- protected swapLogger = {
103
- debug: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.debug(swap.getIdentifier()+": "+msg, ...args),
104
- info: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.info(swap.getIdentifier()+": "+msg, ...args),
105
- warn: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.warn(swap.getIdentifier()+": "+msg, ...args),
106
- error: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.error(swap.getIdentifier()+": "+msg, ...args)
107
- };
108
-
109
- protected constructor(
110
- storageDirectory: IIntermediaryStorage<V>,
111
- path: string,
112
- chainsData: MultichainData,
113
- swapPricing: ISwapPrice
114
- ) {
115
- this.storageManager = storageDirectory;
116
- this.chains = chainsData;
117
- this.path = path;
118
- this.swapPricing = swapPricing;
119
- this.allowedTokens = {};
120
- for(let chainId in chainsData.chains) {
121
- this.allowedTokens[chainId] = new Set<string>(chainsData.chains[chainId].allowedTokens);
122
- }
123
- }
124
-
125
- protected getChain(identifier: string): ChainData {
126
- if(this.chains.chains[identifier]==null)
127
- throw {
128
- code: 20200,
129
- msg: "Invalid chain specified!"
130
- };
131
- return this.chains.chains[identifier];
132
- }
133
-
134
- protected abstract processPastSwaps(): Promise<void>;
135
-
136
- /**
137
- * Starts the watchdog checking past swaps for expiry or claim eligibility.
138
- */
139
- async startWatchdog() {
140
- let rerun: () => Promise<void>;
141
- rerun = async () => {
142
- await this.processPastSwaps().catch( e => this.logger.error("startWatchdog(): Error when processing past swaps: ", e));
143
- setTimeout(rerun, this.config.swapCheckInterval);
144
- };
145
- await rerun();
146
- }
147
-
148
- /**
149
- * Initializes swap handler, loads data and subscribes to chain events
150
- */
151
- abstract init(): Promise<void>;
152
-
153
- protected async loadData(ctor: new (data: any) => V) {
154
- await this.storageManager.loadData(ctor);
155
- //Check if all swaps contain a valid amount
156
- for(let {obj: swap, hash, sequence} of await this.storageManager.query([])) {
157
- if(hash!==swap.getIdentifierHash() || sequence !== (swap.getSequence() ?? 0n)) {
158
- this.swapLogger.info(swap, "loadData(): Swap storage key or sequence mismatch, fixing,"+
159
- " old hash: "+hash+" new hash: "+swap.getIdentifierHash()+
160
- " old seq: "+sequence.toString(10)+" new seq: "+(swap.getSequence() ?? 0n).toString(10));
161
-
162
- await this.storageManager.removeData(hash, sequence);
163
- await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
164
- }
165
- if(this.inflightSwapStates.has(swap.state)) this.inflightSwaps.add(swap.getIdentifier());
166
- }
167
- }
168
-
169
- /**
170
- * Sets up required listeners for the REST server
171
- *
172
- * @param restServer
173
- */
174
- abstract startRestServer(restServer: Express): void;
175
-
176
- /**
177
- * Returns data to be returned in swap handler info
178
- */
179
- abstract getInfoData(): any;
180
-
181
- /**
182
- * Remove swap data
183
- *
184
- * @param swap
185
- * @param ultimateState set the ultimate state of the swap before removing
186
- */
187
- protected async removeSwapData(swap: V, ultimateState?: S) {
188
- if(this.inflightSwaps.delete(swap.getIdentifier()))
189
- this.logger.debug("removeSwapData(): Removing in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
190
- if(ultimateState!=null) await swap.setState(ultimateState);
191
- if(swap!=null) await PluginManager.swapRemove(swap);
192
- this.swapLogger.debug(swap, "removeSwapData(): removing swap final state: "+swap.state);
193
- await this.storageManager.removeData(swap.getIdentifierHash(), swap.getSequence());
194
- }
195
-
196
- protected async saveSwapData(swap: V) {
197
- const identifier = swap.getIdentifier();
198
- if(this.inflightSwapStates.has(swap.state)) {
199
- if(!this.inflightSwaps.has(identifier)) {
200
- this.inflightSwaps.add(identifier);
201
- this.logger.debug("saveSwapData(): Adding in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
202
- }
203
- } else {
204
- if(this.inflightSwaps.delete(identifier))
205
- this.logger.debug("saveSwapData(): Removing in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
206
- }
207
- await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
208
- }
209
-
210
- /**
211
- * Pre-fetches native balance to further check if we have enough reserve in a native token
212
- *
213
- * @param chainIdentifier
214
- * @param abortController
215
- * @protected
216
- */
217
- protected prefetchNativeBalanceIfNeeded(chainIdentifier: string, abortController: AbortController): Promise<bigint> | null {
218
- const minNativeTokenReserve: bigint = this.config.minNativeBalances?.[chainIdentifier] ?? 0n;
219
- if(minNativeTokenReserve===0n) return null;
220
-
221
- const { chainInterface, signer} = this.getChain(chainIdentifier);
222
-
223
- return chainInterface.getBalance(signer.getAddress(), chainInterface.getNativeCurrencyAddress()).catch(e => {
224
- this.logger.error("getBalancePrefetch(): balancePrefetch error: ", e);
225
- abortController.abort(e);
226
- return null;
227
- });
228
- }
229
-
230
- /**
231
- * Checks if we have enough native balance to facilitate swaps
232
- *
233
- * @param chainIdentifier
234
- * @param balancePrefetch
235
- * @param signal
236
- * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
237
- */
238
- protected async checkNativeBalance(chainIdentifier: string, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
239
- if(signal!=null) signal.throwIfAborted();
240
-
241
- const minNativeTokenReserve: bigint = this.config.minNativeBalances?.[chainIdentifier] ?? 0n;
242
- if(minNativeTokenReserve===0n) return;
243
- const balance = await balancePrefetch;
244
- if(signal!=null) signal.throwIfAborted();
245
-
246
- if(balance==null) {
247
- throw new Error("Failed to fetch native token balance!");
248
- }
249
-
250
- if(balance < minNativeTokenReserve) {
251
- throw {
252
- code: 20012,
253
- msg: "LP ran out of native token to cover gas fees"
254
- };
255
- }
256
- }
257
-
258
- /**
259
- * Checks whether there are too many swaps in-flight currently
260
- * @private
261
- */
262
- protected checkTooManyInflightSwaps() {
263
- if(this.config.maxInflightSwaps==null) return;
264
- if(this.inflightSwaps.size>=this.config.maxInflightSwaps) throw {
265
- code: 20013,
266
- msg: "LP has too many in-flight swaps, retry later!"
267
- }
268
- }
269
-
270
- /**
271
- * Checks if we have enough balance of the token in the swap vault
272
- *
273
- * @param totalInToken
274
- * @param balancePrefetch
275
- * @param signal
276
- * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
277
- */
278
- protected async checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
279
- const balance = await balancePrefetch;
280
- if(signal!=null) signal.throwIfAborted();
281
-
282
- if(balance==null || balance < totalInToken) {
283
- throw {
284
- code: 20002,
285
- msg: "Not enough liquidity"
286
- };
287
- }
288
- }
289
-
290
- /**
291
- * Checks if the sequence number is between 0-2^64
292
- *
293
- * @param sequence
294
- * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
295
- */
296
- protected checkSequence(sequence: bigint) {
297
- if(sequence < 0n || sequence >= 2n ** 64n) {
298
- throw {
299
- code: 20060,
300
- msg: "Invalid sequence"
301
- };
302
- }
303
- }
304
-
305
- /**
306
- * Checks whether a given token is supported on a specified chain
307
- *
308
- * @param chainId
309
- * @param token
310
- * @protected
311
- */
312
- protected isTokenSupported(chainId: string, token: string): boolean {
313
- const chainTokens = this.allowedTokens[chainId];
314
- if(chainTokens==null) return false;
315
- return chainTokens.has(token);
316
- }
317
-
318
- getInfo(): SwapHandlerInfoType {
319
- const chainTokens: {[chainId: string]: string[]} = {};
320
- for(let chainId in this.allowedTokens) {
321
- chainTokens[chainId] = Array.from<string>(this.allowedTokens[chainId]);
322
- }
323
- return {
324
- swapFeePPM: Number(this.config.feePPM),
325
- swapBaseFee: Number(this.config.baseFee),
326
- min: Number(this.config.min),
327
- max: Number(this.config.max),
328
- data: this.getInfoData(),
329
- chainTokens
330
- };
331
- }
332
-
333
- protected getInitAuthorizationTimeout(chainIdentifier: string) {
334
- return this.config.initAuthorizationTimeouts?.[chainIdentifier] ?? this.config.initAuthorizationTimeout;
335
- }
336
-
337
- }
1
+ import {Express, Request} from "express";
2
+ import {ISwapPrice} from "../prices/ISwapPrice";
3
+ import {
4
+ ChainType
5
+ } from "@atomiqlabs/base";
6
+ import {SwapHandlerSwap} from "./SwapHandlerSwap";
7
+ import {PluginManager} from "../plugins/PluginManager";
8
+ import {IIntermediaryStorage} from "../storage/IIntermediaryStorage";
9
+ import {IParamReader} from "../utils/paramcoders/IParamReader";
10
+ import {getLogger, LoggerType} from "../utils/Utils";
11
+
12
+ export enum SwapHandlerType {
13
+ TO_BTC = "TO_BTC",
14
+ FROM_BTC = "FROM_BTC",
15
+ TO_BTCLN = "TO_BTCLN",
16
+ FROM_BTCLN = "FROM_BTCLN",
17
+ FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
18
+ FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
19
+ FROM_BTC_SPV = "FROM_BTC_SPV",
20
+ FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
21
+ }
22
+
23
+ export type SwapHandlerInfoType = {
24
+ swapFeePPM: number,
25
+ swapBaseFee: number,
26
+ min: number,
27
+ max: number,
28
+ chainTokens: {[chainId: string]: string[]};
29
+ data?: any,
30
+ };
31
+
32
+ export type SwapBaseConfig = {
33
+ initAuthorizationTimeout: number,
34
+ initAuthorizationTimeouts?: {
35
+ [chainId: string]: number
36
+ },
37
+ minNativeBalances?: {
38
+ [chainId: string]: bigint
39
+ },
40
+ maxInflightSwaps?: number,
41
+ bitcoinBlocktime: bigint,
42
+ baseFee: bigint,
43
+ feePPM: bigint,
44
+ safetyFactor: bigint,
45
+ swapCheckInterval: number,
46
+
47
+ max: bigint,
48
+ min: bigint,
49
+
50
+ minMaxOverrides?: {
51
+ [chainIdentifier: string]: {min: bigint, max: bigint}
52
+ }
53
+ };
54
+
55
+ export type MultichainData = {
56
+ chains: {
57
+ [identifier: string]: ChainData
58
+ }
59
+ };
60
+
61
+ export type ChainData<T extends ChainType = ChainType> = {
62
+ signer: T["Signer"],
63
+ swapContract: T["Contract"],
64
+ spvVaultContract: T["SpvVaultContract"],
65
+ chainInterface: T["ChainInterface"],
66
+ chainEvents: T["Events"],
67
+ allowedTokens: string[],
68
+ tokenMultipliers?: {[tokenAddress: string]: bigint},
69
+ allowedDepositTokens?: string[],
70
+ btcRelay?: T["BtcRelay"],
71
+ contractVersion?: string
72
+ }
73
+
74
+ export type RequestData<T> = {
75
+ chainIdentifier: string,
76
+ raw: Request & {paramReader: IParamReader},
77
+ parsed: T,
78
+ metadata: any
79
+ };
80
+
81
+ /**
82
+ * An abstract class defining a singular swap service
83
+ */
84
+ export abstract class SwapHandler<V extends SwapHandlerSwap<S> = SwapHandlerSwap, S = any> {
85
+
86
+ abstract readonly type: SwapHandlerType;
87
+
88
+ readonly storageManager: IIntermediaryStorage<V>;
89
+ readonly path: string;
90
+
91
+ readonly chains: MultichainData;
92
+ readonly allowedTokens: {[chainId: string]: Set<string>};
93
+ readonly swapPricing: ISwapPrice;
94
+
95
+ abstract readonly inflightSwapStates: Set<S>;
96
+ abstract config: SwapBaseConfig;
97
+
98
+ inflightSwaps: Set<string> = new Set();
99
+
100
+ logger: LoggerType = getLogger(() => "SwapHandler("+this.type+"): ");
101
+
102
+ protected swapLogger = {
103
+ debug: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.debug(swap.getIdentifier()+": "+msg, ...args),
104
+ info: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.info(swap.getIdentifier()+": "+msg, ...args),
105
+ warn: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.warn(swap.getIdentifier()+": "+msg, ...args),
106
+ error: (swap: SwapHandlerSwap, msg: string, ...args: any) => this.logger.error(swap.getIdentifier()+": "+msg, ...args)
107
+ };
108
+
109
+ protected constructor(
110
+ storageDirectory: IIntermediaryStorage<V>,
111
+ path: string,
112
+ chainsData: MultichainData,
113
+ swapPricing: ISwapPrice
114
+ ) {
115
+ this.storageManager = storageDirectory;
116
+ this.chains = chainsData;
117
+ this.path = path;
118
+ this.swapPricing = swapPricing;
119
+ this.allowedTokens = {};
120
+ for(let chainId in chainsData.chains) {
121
+ this.allowedTokens[chainId] = new Set<string>(chainsData.chains[chainId].allowedTokens);
122
+ }
123
+ }
124
+
125
+ protected getChain(identifier: string): ChainData {
126
+ if(this.chains.chains[identifier]==null)
127
+ throw {
128
+ code: 20200,
129
+ msg: "Invalid chain specified!"
130
+ };
131
+ return this.chains.chains[identifier];
132
+ }
133
+
134
+ protected abstract processPastSwaps(): Promise<void>;
135
+
136
+ /**
137
+ * Starts the watchdog checking past swaps for expiry or claim eligibility.
138
+ */
139
+ async startWatchdog() {
140
+ let rerun: () => Promise<void>;
141
+ rerun = async () => {
142
+ await this.processPastSwaps().catch( e => this.logger.error("startWatchdog(): Error when processing past swaps: ", e));
143
+ setTimeout(rerun, this.config.swapCheckInterval);
144
+ };
145
+ await rerun();
146
+ }
147
+
148
+ /**
149
+ * Initializes swap handler, loads data and subscribes to chain events
150
+ */
151
+ abstract init(): Promise<void>;
152
+
153
+ protected async loadData(ctor: new (data: any) => V) {
154
+ await this.storageManager.loadData(ctor);
155
+ //Check if all swaps contain a valid amount
156
+ for(let {obj: swap, hash, sequence} of await this.storageManager.query([])) {
157
+ if(hash!==swap.getIdentifierHash() || sequence !== (swap.getSequence() ?? 0n)) {
158
+ this.swapLogger.info(swap, "loadData(): Swap storage key or sequence mismatch, fixing,"+
159
+ " old hash: "+hash+" new hash: "+swap.getIdentifierHash()+
160
+ " old seq: "+sequence.toString(10)+" new seq: "+(swap.getSequence() ?? 0n).toString(10));
161
+
162
+ await this.storageManager.removeData(hash, sequence);
163
+ await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
164
+ }
165
+ if(this.inflightSwapStates.has(swap.state)) this.inflightSwaps.add(swap.getIdentifier());
166
+ }
167
+ }
168
+
169
+ /**
170
+ * Sets up required listeners for the REST server
171
+ *
172
+ * @param restServer
173
+ */
174
+ abstract startRestServer(restServer: Express): void;
175
+
176
+ /**
177
+ * Returns data to be returned in swap handler info
178
+ */
179
+ abstract getInfoData(): any;
180
+
181
+ /**
182
+ * Remove swap data
183
+ *
184
+ * @param swap
185
+ * @param ultimateState set the ultimate state of the swap before removing
186
+ */
187
+ protected async removeSwapData(swap: V, ultimateState?: S) {
188
+ if(this.inflightSwaps.delete(swap.getIdentifier()))
189
+ this.logger.debug("removeSwapData(): Removing in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
190
+ if(ultimateState!=null) await swap.setState(ultimateState);
191
+ if(swap!=null) await PluginManager.swapRemove(swap);
192
+ this.swapLogger.debug(swap, "removeSwapData(): removing swap final state: "+swap.state);
193
+ await this.storageManager.removeData(swap.getIdentifierHash(), swap.getSequence());
194
+ }
195
+
196
+ protected async saveSwapData(swap: V) {
197
+ const identifier = swap.getIdentifier();
198
+ if(this.inflightSwapStates.has(swap.state)) {
199
+ if(!this.inflightSwaps.has(identifier)) {
200
+ this.inflightSwaps.add(identifier);
201
+ this.logger.debug("saveSwapData(): Adding in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
202
+ }
203
+ } else {
204
+ if(this.inflightSwaps.delete(identifier))
205
+ this.logger.debug("saveSwapData(): Removing in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
206
+ }
207
+ await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
208
+ }
209
+
210
+ /**
211
+ * Pre-fetches native balance to further check if we have enough reserve in a native token
212
+ *
213
+ * @param chainIdentifier
214
+ * @param abortController
215
+ * @protected
216
+ */
217
+ protected prefetchNativeBalanceIfNeeded(chainIdentifier: string, abortController: AbortController): Promise<bigint> | null {
218
+ const minNativeTokenReserve: bigint = this.config.minNativeBalances?.[chainIdentifier] ?? 0n;
219
+ if(minNativeTokenReserve===0n) return null;
220
+
221
+ const { chainInterface, signer} = this.getChain(chainIdentifier);
222
+
223
+ return chainInterface.getBalance(signer.getAddress(), chainInterface.getNativeCurrencyAddress()).catch(e => {
224
+ this.logger.error("getBalancePrefetch(): balancePrefetch error: ", e);
225
+ abortController.abort(e);
226
+ return null;
227
+ });
228
+ }
229
+
230
+ /**
231
+ * Checks if we have enough native balance to facilitate swaps
232
+ *
233
+ * @param chainIdentifier
234
+ * @param balancePrefetch
235
+ * @param signal
236
+ * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
237
+ */
238
+ protected async checkNativeBalance(chainIdentifier: string, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
239
+ if(signal!=null) signal.throwIfAborted();
240
+
241
+ const minNativeTokenReserve: bigint = this.config.minNativeBalances?.[chainIdentifier] ?? 0n;
242
+ if(minNativeTokenReserve===0n) return;
243
+ const balance = await balancePrefetch;
244
+ if(signal!=null) signal.throwIfAborted();
245
+
246
+ if(balance==null) {
247
+ throw new Error("Failed to fetch native token balance!");
248
+ }
249
+
250
+ if(balance < minNativeTokenReserve) {
251
+ throw {
252
+ code: 20012,
253
+ msg: "LP ran out of native token to cover gas fees"
254
+ };
255
+ }
256
+ }
257
+
258
+ /**
259
+ * Checks whether there are too many swaps in-flight currently
260
+ * @private
261
+ */
262
+ protected checkTooManyInflightSwaps() {
263
+ if(this.config.maxInflightSwaps==null) return;
264
+ if(this.inflightSwaps.size>=this.config.maxInflightSwaps) throw {
265
+ code: 20013,
266
+ msg: "LP has too many in-flight swaps, retry later!"
267
+ }
268
+ }
269
+
270
+ /**
271
+ * Checks if we have enough balance of the token in the swap vault
272
+ *
273
+ * @param totalInToken
274
+ * @param balancePrefetch
275
+ * @param signal
276
+ * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
277
+ */
278
+ protected async checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
279
+ const balance = await balancePrefetch;
280
+ if(signal!=null) signal.throwIfAborted();
281
+
282
+ if(balance==null || balance < totalInToken) {
283
+ throw {
284
+ code: 20002,
285
+ msg: "Not enough liquidity"
286
+ };
287
+ }
288
+ }
289
+
290
+ /**
291
+ * Checks if the sequence number is between 0-2^64
292
+ *
293
+ * @param sequence
294
+ * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
295
+ */
296
+ protected checkSequence(sequence: bigint) {
297
+ if(sequence < 0n || sequence >= 2n ** 64n) {
298
+ throw {
299
+ code: 20060,
300
+ msg: "Invalid sequence"
301
+ };
302
+ }
303
+ }
304
+
305
+ /**
306
+ * Checks whether a given token is supported on a specified chain
307
+ *
308
+ * @param chainId
309
+ * @param token
310
+ * @protected
311
+ */
312
+ protected isTokenSupported(chainId: string, token: string): boolean {
313
+ const chainTokens = this.allowedTokens[chainId];
314
+ if(chainTokens==null) return false;
315
+ return chainTokens.has(token);
316
+ }
317
+
318
+ getInfo(): SwapHandlerInfoType {
319
+ const chainTokens: {[chainId: string]: string[]} = {};
320
+ for(let chainId in this.allowedTokens) {
321
+ chainTokens[chainId] = Array.from<string>(this.allowedTokens[chainId]);
322
+ }
323
+ return {
324
+ swapFeePPM: Number(this.config.feePPM),
325
+ swapBaseFee: Number(this.config.baseFee),
326
+ min: Number(this.config.min),
327
+ max: Number(this.config.max),
328
+ data: this.getInfoData(),
329
+ chainTokens
330
+ };
331
+ }
332
+
333
+ protected getInitAuthorizationTimeout(chainIdentifier: string) {
334
+ return this.config.initAuthorizationTimeouts?.[chainIdentifier] ?? this.config.initAuthorizationTimeout;
335
+ }
336
+
337
+ }