@atomiqlabs/lp-lib 15.0.5 → 15.0.6

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 (163) 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 +40 -40
  5. package/dist/index.js +56 -56
  6. package/dist/info/InfoHandler.d.ts +17 -17
  7. package/dist/info/InfoHandler.js +61 -61
  8. package/dist/plugins/IPlugin.d.ts +143 -143
  9. package/dist/plugins/IPlugin.js +34 -34
  10. package/dist/plugins/PluginManager.d.ts +112 -112
  11. package/dist/plugins/PluginManager.js +259 -259
  12. package/dist/prices/BinanceSwapPrice.d.ts +26 -26
  13. package/dist/prices/BinanceSwapPrice.js +92 -92
  14. package/dist/prices/CoinGeckoSwapPrice.d.ts +30 -30
  15. package/dist/prices/CoinGeckoSwapPrice.js +64 -64
  16. package/dist/prices/ISwapPrice.d.ts +43 -43
  17. package/dist/prices/ISwapPrice.js +55 -55
  18. package/dist/prices/OKXSwapPrice.d.ts +26 -26
  19. package/dist/prices/OKXSwapPrice.js +92 -92
  20. package/dist/storage/IIntermediaryStorage.d.ts +18 -18
  21. package/dist/storage/IIntermediaryStorage.js +2 -2
  22. package/dist/storagemanager/IntermediaryStorageManager.d.ts +18 -18
  23. package/dist/storagemanager/IntermediaryStorageManager.js +104 -104
  24. package/dist/storagemanager/StorageManager.d.ts +12 -12
  25. package/dist/storagemanager/StorageManager.js +57 -57
  26. package/dist/swaps/SwapHandler.d.ts +156 -156
  27. package/dist/swaps/SwapHandler.js +163 -163
  28. package/dist/swaps/SwapHandlerSwap.d.ts +79 -79
  29. package/dist/swaps/SwapHandlerSwap.js +78 -78
  30. package/dist/swaps/assertions/AmountAssertions.d.ts +28 -28
  31. package/dist/swaps/assertions/AmountAssertions.js +72 -72
  32. package/dist/swaps/assertions/FromBtcAmountAssertions.d.ts +76 -76
  33. package/dist/swaps/assertions/FromBtcAmountAssertions.js +172 -172
  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 +150 -150
  38. package/dist/swaps/escrow/EscrowHandler.d.ts +51 -51
  39. package/dist/swaps/escrow/EscrowHandler.js +158 -158
  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 +101 -101
  45. package/dist/swaps/escrow/FromBtcBaseSwapHandler.js +207 -207
  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 +83 -83
  51. package/dist/swaps/escrow/frombtc_abstract/FromBtcAbs.js +318 -318
  52. package/dist/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.d.ts +21 -21
  53. package/dist/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.js +50 -50
  54. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.d.ts +107 -107
  55. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.js +675 -675
  56. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.d.ts +32 -32
  57. package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.js +88 -88
  58. package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.d.ts +171 -171
  59. package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.js +718 -718
  60. package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.d.ts +28 -28
  61. package/dist/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.js +64 -64
  62. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.d.ts +177 -177
  63. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.js +863 -863
  64. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.d.ts +24 -24
  65. package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.js +58 -58
  66. package/dist/swaps/spv_vault_swap/SpvVault.d.ts +43 -43
  67. package/dist/swaps/spv_vault_swap/SpvVault.js +111 -111
  68. package/dist/swaps/spv_vault_swap/SpvVaultSwap.d.ts +68 -68
  69. package/dist/swaps/spv_vault_swap/SpvVaultSwap.js +158 -158
  70. package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.d.ts +68 -68
  71. package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.js +517 -517
  72. package/dist/swaps/spv_vault_swap/SpvVaults.d.ts +61 -61
  73. package/dist/swaps/spv_vault_swap/SpvVaults.js +372 -372
  74. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrusted.d.ts +51 -51
  75. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrusted.js +650 -650
  76. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.d.ts +52 -52
  77. package/dist/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.js +118 -118
  78. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.d.ts +76 -76
  79. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.js +495 -495
  80. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.d.ts +34 -34
  81. package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.js +81 -81
  82. package/dist/utils/BitcoinUtils.d.ts +6 -6
  83. package/dist/utils/BitcoinUtils.js +75 -75
  84. package/dist/utils/Utils.d.ts +29 -29
  85. package/dist/utils/Utils.js +88 -88
  86. package/dist/utils/paramcoders/IParamReader.d.ts +5 -5
  87. package/dist/utils/paramcoders/IParamReader.js +2 -2
  88. package/dist/utils/paramcoders/IParamWriter.d.ts +4 -4
  89. package/dist/utils/paramcoders/IParamWriter.js +2 -2
  90. package/dist/utils/paramcoders/LegacyParamEncoder.d.ts +10 -10
  91. package/dist/utils/paramcoders/LegacyParamEncoder.js +22 -22
  92. package/dist/utils/paramcoders/ParamDecoder.d.ts +25 -25
  93. package/dist/utils/paramcoders/ParamDecoder.js +222 -222
  94. package/dist/utils/paramcoders/ParamEncoder.d.ts +9 -9
  95. package/dist/utils/paramcoders/ParamEncoder.js +22 -22
  96. package/dist/utils/paramcoders/SchemaVerifier.d.ts +21 -21
  97. package/dist/utils/paramcoders/SchemaVerifier.js +84 -84
  98. package/dist/utils/paramcoders/server/ServerParamDecoder.d.ts +8 -8
  99. package/dist/utils/paramcoders/server/ServerParamDecoder.js +105 -105
  100. package/dist/utils/paramcoders/server/ServerParamEncoder.d.ts +11 -11
  101. package/dist/utils/paramcoders/server/ServerParamEncoder.js +65 -65
  102. package/dist/wallets/IBitcoinWallet.d.ts +67 -67
  103. package/dist/wallets/IBitcoinWallet.js +2 -2
  104. package/dist/wallets/ILightningWallet.d.ts +117 -117
  105. package/dist/wallets/ILightningWallet.js +37 -37
  106. package/dist/wallets/ISpvVaultSigner.d.ts +7 -7
  107. package/dist/wallets/ISpvVaultSigner.js +2 -2
  108. package/dist/wallets/ISpvVaultWallet.d.ts +42 -42
  109. package/dist/wallets/ISpvVaultWallet.js +2 -2
  110. package/package.json +36 -36
  111. package/src/fees/IBtcFeeEstimator.ts +6 -6
  112. package/src/index.ts +51 -51
  113. package/src/info/InfoHandler.ts +106 -106
  114. package/src/plugins/IPlugin.ts +168 -168
  115. package/src/plugins/PluginManager.ts +336 -336
  116. package/src/prices/BinanceSwapPrice.ts +113 -113
  117. package/src/prices/CoinGeckoSwapPrice.ts +87 -87
  118. package/src/prices/ISwapPrice.ts +88 -88
  119. package/src/prices/OKXSwapPrice.ts +113 -113
  120. package/src/storage/IIntermediaryStorage.ts +19 -19
  121. package/src/storagemanager/IntermediaryStorageManager.ts +109 -109
  122. package/src/storagemanager/StorageManager.ts +68 -68
  123. package/src/swaps/SwapHandler.ts +280 -280
  124. package/src/swaps/SwapHandlerSwap.ts +141 -141
  125. package/src/swaps/assertions/AmountAssertions.ts +76 -76
  126. package/src/swaps/assertions/FromBtcAmountAssertions.ts +238 -238
  127. package/src/swaps/assertions/LightningAssertions.ts +103 -103
  128. package/src/swaps/assertions/ToBtcAmountAssertions.ts +203 -203
  129. package/src/swaps/escrow/EscrowHandler.ts +179 -179
  130. package/src/swaps/escrow/EscrowHandlerSwap.ts +86 -86
  131. package/src/swaps/escrow/FromBtcBaseSwap.ts +38 -38
  132. package/src/swaps/escrow/FromBtcBaseSwapHandler.ts +283 -283
  133. package/src/swaps/escrow/ToBtcBaseSwap.ts +85 -85
  134. package/src/swaps/escrow/ToBtcBaseSwapHandler.ts +129 -129
  135. package/src/swaps/escrow/frombtc_abstract/FromBtcAbs.ts +452 -452
  136. package/src/swaps/escrow/frombtc_abstract/FromBtcSwapAbs.ts +61 -61
  137. package/src/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.ts +856 -856
  138. package/src/swaps/escrow/frombtcln_abstract/FromBtcLnSwapAbs.ts +137 -137
  139. package/src/swaps/escrow/tobtc_abstract/ToBtcAbs.ts +890 -890
  140. package/src/swaps/escrow/tobtc_abstract/ToBtcSwapAbs.ts +108 -108
  141. package/src/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.ts +1112 -1112
  142. package/src/swaps/escrow/tobtcln_abstract/ToBtcLnSwapAbs.ts +80 -80
  143. package/src/swaps/spv_vault_swap/SpvVault.ts +143 -143
  144. package/src/swaps/spv_vault_swap/SpvVaultSwap.ts +228 -228
  145. package/src/swaps/spv_vault_swap/SpvVaultSwapHandler.ts +654 -654
  146. package/src/swaps/spv_vault_swap/SpvVaults.ts +444 -444
  147. package/src/swaps/trusted/frombtc_trusted/FromBtcTrusted.ts +747 -747
  148. package/src/swaps/trusted/frombtc_trusted/FromBtcTrustedSwap.ts +185 -185
  149. package/src/swaps/trusted/frombtcln_trusted/FromBtcLnTrusted.ts +592 -592
  150. package/src/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.ts +121 -121
  151. package/src/utils/BitcoinUtils.ts +71 -71
  152. package/src/utils/Utils.ts +102 -102
  153. package/src/utils/paramcoders/IParamReader.ts +7 -7
  154. package/src/utils/paramcoders/IParamWriter.ts +8 -8
  155. package/src/utils/paramcoders/LegacyParamEncoder.ts +27 -27
  156. package/src/utils/paramcoders/ParamDecoder.ts +218 -218
  157. package/src/utils/paramcoders/ParamEncoder.ts +29 -29
  158. package/src/utils/paramcoders/SchemaVerifier.ts +96 -96
  159. package/src/utils/paramcoders/server/ServerParamDecoder.ts +115 -115
  160. package/src/utils/paramcoders/server/ServerParamEncoder.ts +75 -75
  161. package/src/wallets/IBitcoinWallet.ts +68 -68
  162. package/src/wallets/ILightningWallet.ts +178 -178
  163. package/src/wallets/ISpvVaultSigner.ts +10 -10
@@ -1,156 +1,156 @@
1
- import { Express, Request } from "express";
2
- import { ISwapPrice } from "../prices/ISwapPrice";
3
- import { ChainType } from "@atomiqlabs/base";
4
- import { SwapHandlerSwap } from "./SwapHandlerSwap";
5
- import { IIntermediaryStorage } from "../storage/IIntermediaryStorage";
6
- import { IParamReader } from "../utils/paramcoders/IParamReader";
7
- export declare enum SwapHandlerType {
8
- TO_BTC = "TO_BTC",
9
- FROM_BTC = "FROM_BTC",
10
- TO_BTCLN = "TO_BTCLN",
11
- FROM_BTCLN = "FROM_BTCLN",
12
- FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
13
- FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
14
- FROM_BTC_SPV = "FROM_BTC_SPV"
15
- }
16
- export type SwapHandlerInfoType = {
17
- swapFeePPM: number;
18
- swapBaseFee: number;
19
- min: number;
20
- max: number;
21
- tokens: string[];
22
- chainTokens: {
23
- [chainId: string]: string[];
24
- };
25
- data?: any;
26
- };
27
- export type SwapBaseConfig = {
28
- initAuthorizationTimeout: number;
29
- initAuthorizationTimeouts?: {
30
- [chainId: string]: number;
31
- };
32
- bitcoinBlocktime: bigint;
33
- baseFee: bigint;
34
- feePPM: bigint;
35
- max: bigint;
36
- min: bigint;
37
- safetyFactor: bigint;
38
- swapCheckInterval: number;
39
- };
40
- export type MultichainData = {
41
- chains: {
42
- [identifier: string]: ChainData;
43
- };
44
- default: string;
45
- };
46
- export type ChainData<T extends ChainType = ChainType> = {
47
- signer: T["Signer"];
48
- swapContract: T["Contract"];
49
- spvVaultContract: T["SpvVaultContract"];
50
- chainInterface: T["ChainInterface"];
51
- chainEvents: T["Events"];
52
- allowedTokens: string[];
53
- tokenMultipliers?: {
54
- [tokenAddress: string]: bigint;
55
- };
56
- allowedDepositTokens?: string[];
57
- btcRelay?: T["BtcRelay"];
58
- };
59
- export type RequestData<T> = {
60
- chainIdentifier: string;
61
- raw: Request & {
62
- paramReader: IParamReader;
63
- };
64
- parsed: T;
65
- metadata: any;
66
- };
67
- /**
68
- * An abstract class defining a singular swap service
69
- */
70
- export declare abstract class SwapHandler<V extends SwapHandlerSwap<S> = SwapHandlerSwap, S = any> {
71
- abstract readonly type: SwapHandlerType;
72
- readonly storageManager: IIntermediaryStorage<V>;
73
- readonly path: string;
74
- readonly chains: MultichainData;
75
- readonly allowedTokens: {
76
- [chainId: string]: Set<string>;
77
- };
78
- readonly swapPricing: ISwapPrice;
79
- abstract config: SwapBaseConfig;
80
- logger: {
81
- debug: (msg: string, ...args: any) => void;
82
- info: (msg: string, ...args: any) => void;
83
- warn: (msg: string, ...args: any) => void;
84
- error: (msg: string, ...args: any) => void;
85
- };
86
- protected swapLogger: {
87
- debug: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
88
- info: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
89
- warn: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
90
- error: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
91
- };
92
- protected constructor(storageDirectory: IIntermediaryStorage<V>, path: string, chainsData: MultichainData, swapPricing: ISwapPrice);
93
- protected getDefaultChain(): ChainData;
94
- protected getChain(identifier: string): ChainData;
95
- protected abstract processPastSwaps(): Promise<void>;
96
- /**
97
- * Starts the watchdog checking past swaps for expiry or claim eligibility.
98
- */
99
- startWatchdog(): Promise<void>;
100
- /**
101
- * Initializes swap handler, loads data and subscribes to chain events
102
- */
103
- abstract init(): Promise<void>;
104
- protected loadData(ctor: new (data: any) => V): Promise<void>;
105
- /**
106
- * Sets up required listeners for the REST server
107
- *
108
- * @param restServer
109
- */
110
- abstract startRestServer(restServer: Express): void;
111
- /**
112
- * Returns data to be returned in swap handler info
113
- */
114
- abstract getInfoData(): any;
115
- /**
116
- * Remove swap data
117
- *
118
- * @param hash
119
- * @param sequence
120
- */
121
- protected removeSwapData(hash: string, sequence: bigint): Promise<void>;
122
- /**
123
- * Remove swap data
124
- *
125
- * @param swap
126
- * @param ultimateState set the ultimate state of the swap before removing
127
- */
128
- protected removeSwapData(swap: V, ultimateState?: S): Promise<void>;
129
- protected saveSwapData(swap: V): Promise<void>;
130
- /**
131
- * Checks if we have enough balance of the token in the swap vault
132
- *
133
- * @param totalInToken
134
- * @param balancePrefetch
135
- * @param signal
136
- * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
137
- */
138
- protected checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void>;
139
- /**
140
- * Checks if the sequence number is between 0-2^64
141
- *
142
- * @param sequence
143
- * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
144
- */
145
- protected checkSequence(sequence: bigint): void;
146
- /**
147
- * Checks whether a given token is supported on a specified chain
148
- *
149
- * @param chainId
150
- * @param token
151
- * @protected
152
- */
153
- protected isTokenSupported(chainId: string, token: string): boolean;
154
- getInfo(): SwapHandlerInfoType;
155
- protected getInitAuthorizationTimeout(chainIdentifier: string): number;
156
- }
1
+ import { Express, Request } from "express";
2
+ import { ISwapPrice } from "../prices/ISwapPrice";
3
+ import { ChainType } from "@atomiqlabs/base";
4
+ import { SwapHandlerSwap } from "./SwapHandlerSwap";
5
+ import { IIntermediaryStorage } from "../storage/IIntermediaryStorage";
6
+ import { IParamReader } from "../utils/paramcoders/IParamReader";
7
+ export declare enum SwapHandlerType {
8
+ TO_BTC = "TO_BTC",
9
+ FROM_BTC = "FROM_BTC",
10
+ TO_BTCLN = "TO_BTCLN",
11
+ FROM_BTCLN = "FROM_BTCLN",
12
+ FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
13
+ FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
14
+ FROM_BTC_SPV = "FROM_BTC_SPV"
15
+ }
16
+ export type SwapHandlerInfoType = {
17
+ swapFeePPM: number;
18
+ swapBaseFee: number;
19
+ min: number;
20
+ max: number;
21
+ tokens: string[];
22
+ chainTokens: {
23
+ [chainId: string]: string[];
24
+ };
25
+ data?: any;
26
+ };
27
+ export type SwapBaseConfig = {
28
+ initAuthorizationTimeout: number;
29
+ initAuthorizationTimeouts?: {
30
+ [chainId: string]: number;
31
+ };
32
+ bitcoinBlocktime: bigint;
33
+ baseFee: bigint;
34
+ feePPM: bigint;
35
+ max: bigint;
36
+ min: bigint;
37
+ safetyFactor: bigint;
38
+ swapCheckInterval: number;
39
+ };
40
+ export type MultichainData = {
41
+ chains: {
42
+ [identifier: string]: ChainData;
43
+ };
44
+ default: string;
45
+ };
46
+ export type ChainData<T extends ChainType = ChainType> = {
47
+ signer: T["Signer"];
48
+ swapContract: T["Contract"];
49
+ spvVaultContract: T["SpvVaultContract"];
50
+ chainInterface: T["ChainInterface"];
51
+ chainEvents: T["Events"];
52
+ allowedTokens: string[];
53
+ tokenMultipliers?: {
54
+ [tokenAddress: string]: bigint;
55
+ };
56
+ allowedDepositTokens?: string[];
57
+ btcRelay?: T["BtcRelay"];
58
+ };
59
+ export type RequestData<T> = {
60
+ chainIdentifier: string;
61
+ raw: Request & {
62
+ paramReader: IParamReader;
63
+ };
64
+ parsed: T;
65
+ metadata: any;
66
+ };
67
+ /**
68
+ * An abstract class defining a singular swap service
69
+ */
70
+ export declare abstract class SwapHandler<V extends SwapHandlerSwap<S> = SwapHandlerSwap, S = any> {
71
+ abstract readonly type: SwapHandlerType;
72
+ readonly storageManager: IIntermediaryStorage<V>;
73
+ readonly path: string;
74
+ readonly chains: MultichainData;
75
+ readonly allowedTokens: {
76
+ [chainId: string]: Set<string>;
77
+ };
78
+ readonly swapPricing: ISwapPrice;
79
+ abstract config: SwapBaseConfig;
80
+ logger: {
81
+ debug: (msg: string, ...args: any) => void;
82
+ info: (msg: string, ...args: any) => void;
83
+ warn: (msg: string, ...args: any) => void;
84
+ error: (msg: string, ...args: any) => void;
85
+ };
86
+ protected swapLogger: {
87
+ debug: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
88
+ info: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
89
+ warn: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
90
+ error: (swap: SwapHandlerSwap, msg: string, ...args: any) => void;
91
+ };
92
+ protected constructor(storageDirectory: IIntermediaryStorage<V>, path: string, chainsData: MultichainData, swapPricing: ISwapPrice);
93
+ protected getDefaultChain(): ChainData;
94
+ protected getChain(identifier: string): ChainData;
95
+ protected abstract processPastSwaps(): Promise<void>;
96
+ /**
97
+ * Starts the watchdog checking past swaps for expiry or claim eligibility.
98
+ */
99
+ startWatchdog(): Promise<void>;
100
+ /**
101
+ * Initializes swap handler, loads data and subscribes to chain events
102
+ */
103
+ abstract init(): Promise<void>;
104
+ protected loadData(ctor: new (data: any) => V): Promise<void>;
105
+ /**
106
+ * Sets up required listeners for the REST server
107
+ *
108
+ * @param restServer
109
+ */
110
+ abstract startRestServer(restServer: Express): void;
111
+ /**
112
+ * Returns data to be returned in swap handler info
113
+ */
114
+ abstract getInfoData(): any;
115
+ /**
116
+ * Remove swap data
117
+ *
118
+ * @param hash
119
+ * @param sequence
120
+ */
121
+ protected removeSwapData(hash: string, sequence: bigint): Promise<void>;
122
+ /**
123
+ * Remove swap data
124
+ *
125
+ * @param swap
126
+ * @param ultimateState set the ultimate state of the swap before removing
127
+ */
128
+ protected removeSwapData(swap: V, ultimateState?: S): Promise<void>;
129
+ protected saveSwapData(swap: V): Promise<void>;
130
+ /**
131
+ * Checks if we have enough balance of the token in the swap vault
132
+ *
133
+ * @param totalInToken
134
+ * @param balancePrefetch
135
+ * @param signal
136
+ * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
137
+ */
138
+ protected checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void>;
139
+ /**
140
+ * Checks if the sequence number is between 0-2^64
141
+ *
142
+ * @param sequence
143
+ * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
144
+ */
145
+ protected checkSequence(sequence: bigint): void;
146
+ /**
147
+ * Checks whether a given token is supported on a specified chain
148
+ *
149
+ * @param chainId
150
+ * @param token
151
+ * @protected
152
+ */
153
+ protected isTokenSupported(chainId: string, token: string): boolean;
154
+ getInfo(): SwapHandlerInfoType;
155
+ protected getInitAuthorizationTimeout(chainIdentifier: string): number;
156
+ }
@@ -1,163 +1,163 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SwapHandler = exports.SwapHandlerType = void 0;
4
- const PluginManager_1 = require("../plugins/PluginManager");
5
- var SwapHandlerType;
6
- (function (SwapHandlerType) {
7
- SwapHandlerType["TO_BTC"] = "TO_BTC";
8
- SwapHandlerType["FROM_BTC"] = "FROM_BTC";
9
- SwapHandlerType["TO_BTCLN"] = "TO_BTCLN";
10
- SwapHandlerType["FROM_BTCLN"] = "FROM_BTCLN";
11
- SwapHandlerType["FROM_BTCLN_TRUSTED"] = "FROM_BTCLN_TRUSTED";
12
- SwapHandlerType["FROM_BTC_TRUSTED"] = "FROM_BTC_TRUSTED";
13
- SwapHandlerType["FROM_BTC_SPV"] = "FROM_BTC_SPV";
14
- })(SwapHandlerType = exports.SwapHandlerType || (exports.SwapHandlerType = {}));
15
- /**
16
- * An abstract class defining a singular swap service
17
- */
18
- class SwapHandler {
19
- constructor(storageDirectory, path, chainsData, swapPricing) {
20
- this.logger = {
21
- debug: (msg, ...args) => console.debug("SwapHandler(" + this.type + "): " + msg, ...args),
22
- info: (msg, ...args) => console.info("SwapHandler(" + this.type + "): " + msg, ...args),
23
- warn: (msg, ...args) => console.warn("SwapHandler(" + this.type + "): " + msg, ...args),
24
- error: (msg, ...args) => console.error("SwapHandler(" + this.type + "): " + msg, ...args)
25
- };
26
- this.swapLogger = {
27
- debug: (swap, msg, ...args) => this.logger.debug(swap.getIdentifier() + ": " + msg, ...args),
28
- info: (swap, msg, ...args) => this.logger.info(swap.getIdentifier() + ": " + msg, ...args),
29
- warn: (swap, msg, ...args) => this.logger.warn(swap.getIdentifier() + ": " + msg, ...args),
30
- error: (swap, msg, ...args) => this.logger.error(swap.getIdentifier() + ": " + msg, ...args)
31
- };
32
- this.storageManager = storageDirectory;
33
- this.chains = chainsData;
34
- if (this.chains.chains[this.chains.default] == null)
35
- throw new Error("Invalid default chain specified");
36
- this.path = path;
37
- this.swapPricing = swapPricing;
38
- this.allowedTokens = {};
39
- for (let chainId in chainsData.chains) {
40
- this.allowedTokens[chainId] = new Set(chainsData.chains[chainId].allowedTokens);
41
- }
42
- }
43
- getDefaultChain() {
44
- return this.chains.chains[this.chains.default];
45
- }
46
- getChain(identifier) {
47
- if (this.chains.chains[identifier] == null)
48
- throw {
49
- code: 20200,
50
- msg: "Invalid chain specified!"
51
- };
52
- return this.chains.chains[identifier];
53
- }
54
- /**
55
- * Starts the watchdog checking past swaps for expiry or claim eligibility.
56
- */
57
- async startWatchdog() {
58
- let rerun;
59
- rerun = async () => {
60
- await this.processPastSwaps().catch(e => console.error(e));
61
- setTimeout(rerun, this.config.swapCheckInterval);
62
- };
63
- await rerun();
64
- }
65
- async loadData(ctor) {
66
- await this.storageManager.loadData(ctor);
67
- //Check if all swaps contain a valid amount
68
- for (let { obj: swap, hash, sequence } of await this.storageManager.query([])) {
69
- if (hash !== swap.getIdentifierHash() || sequence !== (swap.getSequence() ?? 0n)) {
70
- this.swapLogger.info(swap, "loadData(): Swap storage key or sequence mismatch, fixing," +
71
- " old hash: " + hash + " new hash: " + swap.getIdentifierHash() +
72
- " old seq: " + sequence.toString(10) + " new seq: " + (swap.getSequence() ?? 0n).toString(10));
73
- await this.storageManager.removeData(hash, sequence);
74
- await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
75
- }
76
- }
77
- }
78
- async removeSwapData(hashOrSwap, sequenceOrUltimateState) {
79
- let swap;
80
- if (typeof (hashOrSwap) === "string") {
81
- if (typeof (sequenceOrUltimateState) !== "bigint")
82
- throw new Error("Sequence must be a BN instance!");
83
- swap = await this.storageManager.getData(hashOrSwap, sequenceOrUltimateState);
84
- }
85
- else {
86
- swap = hashOrSwap;
87
- if (sequenceOrUltimateState != null && typeof (sequenceOrUltimateState) !== "bigint")
88
- await swap.setState(sequenceOrUltimateState);
89
- }
90
- if (swap != null)
91
- await PluginManager_1.PluginManager.swapRemove(swap);
92
- this.swapLogger.debug(swap, "removeSwapData(): removing swap final state: " + swap.state);
93
- await this.storageManager.removeData(swap.getIdentifierHash(), swap.getSequence());
94
- }
95
- async saveSwapData(swap) {
96
- await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
97
- }
98
- /**
99
- * Checks if we have enough balance of the token in the swap vault
100
- *
101
- * @param totalInToken
102
- * @param balancePrefetch
103
- * @param signal
104
- * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
105
- */
106
- async checkBalance(totalInToken, balancePrefetch, signal) {
107
- const balance = await balancePrefetch;
108
- if (signal != null)
109
- signal.throwIfAborted();
110
- if (balance == null || balance < totalInToken) {
111
- throw {
112
- code: 20002,
113
- msg: "Not enough liquidity"
114
- };
115
- }
116
- }
117
- /**
118
- * Checks if the sequence number is between 0-2^64
119
- *
120
- * @param sequence
121
- * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
122
- */
123
- checkSequence(sequence) {
124
- if (sequence < 0n || sequence >= 2n ** 64n) {
125
- throw {
126
- code: 20060,
127
- msg: "Invalid sequence"
128
- };
129
- }
130
- }
131
- /**
132
- * Checks whether a given token is supported on a specified chain
133
- *
134
- * @param chainId
135
- * @param token
136
- * @protected
137
- */
138
- isTokenSupported(chainId, token) {
139
- const chainTokens = this.allowedTokens[chainId];
140
- if (chainTokens == null)
141
- return false;
142
- return chainTokens.has(token);
143
- }
144
- getInfo() {
145
- const chainTokens = {};
146
- for (let chainId in this.allowedTokens) {
147
- chainTokens[chainId] = Array.from(this.allowedTokens[chainId]);
148
- }
149
- return {
150
- swapFeePPM: Number(this.config.feePPM),
151
- swapBaseFee: Number(this.config.baseFee),
152
- min: Number(this.config.min),
153
- max: Number(this.config.max),
154
- data: this.getInfoData(),
155
- tokens: Array.from(this.allowedTokens[this.chains.default]),
156
- chainTokens
157
- };
158
- }
159
- getInitAuthorizationTimeout(chainIdentifier) {
160
- return this.config.initAuthorizationTimeouts?.[chainIdentifier] ?? this.config.initAuthorizationTimeout;
161
- }
162
- }
163
- exports.SwapHandler = SwapHandler;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SwapHandler = exports.SwapHandlerType = void 0;
4
+ const PluginManager_1 = require("../plugins/PluginManager");
5
+ var SwapHandlerType;
6
+ (function (SwapHandlerType) {
7
+ SwapHandlerType["TO_BTC"] = "TO_BTC";
8
+ SwapHandlerType["FROM_BTC"] = "FROM_BTC";
9
+ SwapHandlerType["TO_BTCLN"] = "TO_BTCLN";
10
+ SwapHandlerType["FROM_BTCLN"] = "FROM_BTCLN";
11
+ SwapHandlerType["FROM_BTCLN_TRUSTED"] = "FROM_BTCLN_TRUSTED";
12
+ SwapHandlerType["FROM_BTC_TRUSTED"] = "FROM_BTC_TRUSTED";
13
+ SwapHandlerType["FROM_BTC_SPV"] = "FROM_BTC_SPV";
14
+ })(SwapHandlerType = exports.SwapHandlerType || (exports.SwapHandlerType = {}));
15
+ /**
16
+ * An abstract class defining a singular swap service
17
+ */
18
+ class SwapHandler {
19
+ constructor(storageDirectory, path, chainsData, swapPricing) {
20
+ this.logger = {
21
+ debug: (msg, ...args) => console.debug("SwapHandler(" + this.type + "): " + msg, ...args),
22
+ info: (msg, ...args) => console.info("SwapHandler(" + this.type + "): " + msg, ...args),
23
+ warn: (msg, ...args) => console.warn("SwapHandler(" + this.type + "): " + msg, ...args),
24
+ error: (msg, ...args) => console.error("SwapHandler(" + this.type + "): " + msg, ...args)
25
+ };
26
+ this.swapLogger = {
27
+ debug: (swap, msg, ...args) => this.logger.debug(swap.getIdentifier() + ": " + msg, ...args),
28
+ info: (swap, msg, ...args) => this.logger.info(swap.getIdentifier() + ": " + msg, ...args),
29
+ warn: (swap, msg, ...args) => this.logger.warn(swap.getIdentifier() + ": " + msg, ...args),
30
+ error: (swap, msg, ...args) => this.logger.error(swap.getIdentifier() + ": " + msg, ...args)
31
+ };
32
+ this.storageManager = storageDirectory;
33
+ this.chains = chainsData;
34
+ if (this.chains.chains[this.chains.default] == null)
35
+ throw new Error("Invalid default chain specified");
36
+ this.path = path;
37
+ this.swapPricing = swapPricing;
38
+ this.allowedTokens = {};
39
+ for (let chainId in chainsData.chains) {
40
+ this.allowedTokens[chainId] = new Set(chainsData.chains[chainId].allowedTokens);
41
+ }
42
+ }
43
+ getDefaultChain() {
44
+ return this.chains.chains[this.chains.default];
45
+ }
46
+ getChain(identifier) {
47
+ if (this.chains.chains[identifier] == null)
48
+ throw {
49
+ code: 20200,
50
+ msg: "Invalid chain specified!"
51
+ };
52
+ return this.chains.chains[identifier];
53
+ }
54
+ /**
55
+ * Starts the watchdog checking past swaps for expiry or claim eligibility.
56
+ */
57
+ async startWatchdog() {
58
+ let rerun;
59
+ rerun = async () => {
60
+ await this.processPastSwaps().catch(e => console.error(e));
61
+ setTimeout(rerun, this.config.swapCheckInterval);
62
+ };
63
+ await rerun();
64
+ }
65
+ async loadData(ctor) {
66
+ await this.storageManager.loadData(ctor);
67
+ //Check if all swaps contain a valid amount
68
+ for (let { obj: swap, hash, sequence } of await this.storageManager.query([])) {
69
+ if (hash !== swap.getIdentifierHash() || sequence !== (swap.getSequence() ?? 0n)) {
70
+ this.swapLogger.info(swap, "loadData(): Swap storage key or sequence mismatch, fixing," +
71
+ " old hash: " + hash + " new hash: " + swap.getIdentifierHash() +
72
+ " old seq: " + sequence.toString(10) + " new seq: " + (swap.getSequence() ?? 0n).toString(10));
73
+ await this.storageManager.removeData(hash, sequence);
74
+ await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
75
+ }
76
+ }
77
+ }
78
+ async removeSwapData(hashOrSwap, sequenceOrUltimateState) {
79
+ let swap;
80
+ if (typeof (hashOrSwap) === "string") {
81
+ if (typeof (sequenceOrUltimateState) !== "bigint")
82
+ throw new Error("Sequence must be a BN instance!");
83
+ swap = await this.storageManager.getData(hashOrSwap, sequenceOrUltimateState);
84
+ }
85
+ else {
86
+ swap = hashOrSwap;
87
+ if (sequenceOrUltimateState != null && typeof (sequenceOrUltimateState) !== "bigint")
88
+ await swap.setState(sequenceOrUltimateState);
89
+ }
90
+ if (swap != null)
91
+ await PluginManager_1.PluginManager.swapRemove(swap);
92
+ this.swapLogger.debug(swap, "removeSwapData(): removing swap final state: " + swap.state);
93
+ await this.storageManager.removeData(swap.getIdentifierHash(), swap.getSequence());
94
+ }
95
+ async saveSwapData(swap) {
96
+ await this.storageManager.saveData(swap.getIdentifierHash(), swap.getSequence(), swap);
97
+ }
98
+ /**
99
+ * Checks if we have enough balance of the token in the swap vault
100
+ *
101
+ * @param totalInToken
102
+ * @param balancePrefetch
103
+ * @param signal
104
+ * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
105
+ */
106
+ async checkBalance(totalInToken, balancePrefetch, signal) {
107
+ const balance = await balancePrefetch;
108
+ if (signal != null)
109
+ signal.throwIfAborted();
110
+ if (balance == null || balance < totalInToken) {
111
+ throw {
112
+ code: 20002,
113
+ msg: "Not enough liquidity"
114
+ };
115
+ }
116
+ }
117
+ /**
118
+ * Checks if the sequence number is between 0-2^64
119
+ *
120
+ * @param sequence
121
+ * @throws {DefinedRuntimeError} will throw an error if sequence number is out of bounds
122
+ */
123
+ checkSequence(sequence) {
124
+ if (sequence < 0n || sequence >= 2n ** 64n) {
125
+ throw {
126
+ code: 20060,
127
+ msg: "Invalid sequence"
128
+ };
129
+ }
130
+ }
131
+ /**
132
+ * Checks whether a given token is supported on a specified chain
133
+ *
134
+ * @param chainId
135
+ * @param token
136
+ * @protected
137
+ */
138
+ isTokenSupported(chainId, token) {
139
+ const chainTokens = this.allowedTokens[chainId];
140
+ if (chainTokens == null)
141
+ return false;
142
+ return chainTokens.has(token);
143
+ }
144
+ getInfo() {
145
+ const chainTokens = {};
146
+ for (let chainId in this.allowedTokens) {
147
+ chainTokens[chainId] = Array.from(this.allowedTokens[chainId]);
148
+ }
149
+ return {
150
+ swapFeePPM: Number(this.config.feePPM),
151
+ swapBaseFee: Number(this.config.baseFee),
152
+ min: Number(this.config.min),
153
+ max: Number(this.config.max),
154
+ data: this.getInfoData(),
155
+ tokens: Array.from(this.allowedTokens[this.chains.default]),
156
+ chainTokens
157
+ };
158
+ }
159
+ getInitAuthorizationTimeout(chainIdentifier) {
160
+ return this.config.initAuthorizationTimeouts?.[chainIdentifier] ?? this.config.initAuthorizationTimeout;
161
+ }
162
+ }
163
+ exports.SwapHandler = SwapHandler;