@atomiqlabs/chain-evm 1.0.0-dev.75 → 1.0.0-dev.77

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 (185) hide show
  1. package/LICENSE +201 -201
  2. package/dist/chains/botanix/BotanixChainType.d.ts +13 -13
  3. package/dist/chains/botanix/BotanixChainType.js +2 -2
  4. package/dist/chains/botanix/BotanixInitializer.d.ts +30 -30
  5. package/dist/chains/botanix/BotanixInitializer.js +122 -122
  6. package/dist/chains/citrea/CitreaBtcRelay.d.ts +21 -21
  7. package/dist/chains/citrea/CitreaBtcRelay.js +43 -43
  8. package/dist/chains/citrea/CitreaChainType.d.ts +13 -13
  9. package/dist/chains/citrea/CitreaChainType.js +2 -2
  10. package/dist/chains/citrea/CitreaFees.d.ts +29 -29
  11. package/dist/chains/citrea/CitreaFees.js +67 -67
  12. package/dist/chains/citrea/CitreaInitializer.d.ts +30 -30
  13. package/dist/chains/citrea/CitreaInitializer.js +129 -129
  14. package/dist/chains/citrea/CitreaSpvVaultContract.d.ts +15 -15
  15. package/dist/chains/citrea/CitreaSpvVaultContract.js +74 -74
  16. package/dist/chains/citrea/CitreaSwapContract.d.ts +22 -22
  17. package/dist/chains/citrea/CitreaSwapContract.js +96 -96
  18. package/dist/chains/citrea/CitreaTokens.d.ts +9 -9
  19. package/dist/chains/citrea/CitreaTokens.js +20 -20
  20. package/dist/evm/btcrelay/BtcRelayAbi.d.ts +198 -198
  21. package/dist/evm/btcrelay/BtcRelayAbi.js +261 -261
  22. package/dist/evm/btcrelay/BtcRelayTypechain.d.ts +172 -172
  23. package/dist/evm/btcrelay/BtcRelayTypechain.js +2 -2
  24. package/dist/evm/btcrelay/EVMBtcRelay.d.ts +197 -197
  25. package/dist/evm/btcrelay/EVMBtcRelay.js +435 -435
  26. package/dist/evm/btcrelay/headers/EVMBtcHeader.d.ts +33 -33
  27. package/dist/evm/btcrelay/headers/EVMBtcHeader.js +84 -84
  28. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.d.ts +56 -56
  29. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js +123 -123
  30. package/dist/evm/chain/EVMChainInterface.d.ts +51 -51
  31. package/dist/evm/chain/EVMChainInterface.js +89 -89
  32. package/dist/evm/chain/EVMModule.d.ts +9 -9
  33. package/dist/evm/chain/EVMModule.js +13 -13
  34. package/dist/evm/chain/modules/ERC20Abi.d.ts +168 -168
  35. package/dist/evm/chain/modules/ERC20Abi.js +225 -225
  36. package/dist/evm/chain/modules/EVMAddresses.d.ts +10 -10
  37. package/dist/evm/chain/modules/EVMAddresses.js +30 -30
  38. package/dist/evm/chain/modules/EVMBlocks.d.ts +20 -20
  39. package/dist/evm/chain/modules/EVMBlocks.js +64 -64
  40. package/dist/evm/chain/modules/EVMEvents.d.ts +36 -36
  41. package/dist/evm/chain/modules/EVMEvents.js +122 -122
  42. package/dist/evm/chain/modules/EVMFees.d.ts +36 -36
  43. package/dist/evm/chain/modules/EVMFees.js +74 -74
  44. package/dist/evm/chain/modules/EVMSignatures.d.ts +29 -29
  45. package/dist/evm/chain/modules/EVMSignatures.js +68 -68
  46. package/dist/evm/chain/modules/EVMTokens.d.ts +70 -70
  47. package/dist/evm/chain/modules/EVMTokens.js +142 -142
  48. package/dist/evm/chain/modules/EVMTransactions.d.ts +94 -94
  49. package/dist/evm/chain/modules/EVMTransactions.js +286 -286
  50. package/dist/evm/contract/EVMContractBase.d.ts +22 -22
  51. package/dist/evm/contract/EVMContractBase.js +34 -34
  52. package/dist/evm/contract/EVMContractModule.d.ts +8 -8
  53. package/dist/evm/contract/EVMContractModule.js +11 -11
  54. package/dist/evm/contract/modules/EVMContractEvents.d.ts +42 -42
  55. package/dist/evm/contract/modules/EVMContractEvents.js +75 -75
  56. package/dist/evm/events/EVMChainEvents.d.ts +22 -22
  57. package/dist/evm/events/EVMChainEvents.js +69 -69
  58. package/dist/evm/events/EVMChainEventsBrowser.d.ts +102 -102
  59. package/dist/evm/events/EVMChainEventsBrowser.js +413 -404
  60. package/dist/evm/providers/JsonRpcProviderWithRetries.d.ts +15 -15
  61. package/dist/evm/providers/JsonRpcProviderWithRetries.js +19 -19
  62. package/dist/evm/providers/ReconnectingWebSocketProvider.d.ts +22 -22
  63. package/dist/evm/providers/ReconnectingWebSocketProvider.js +87 -87
  64. package/dist/evm/providers/SocketProvider.d.ts +111 -111
  65. package/dist/evm/providers/SocketProvider.js +334 -334
  66. package/dist/evm/providers/WebSocketProviderWithRetries.d.ts +17 -17
  67. package/dist/evm/providers/WebSocketProviderWithRetries.js +19 -19
  68. package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts +79 -79
  69. package/dist/evm/spv_swap/EVMSpvVaultContract.js +482 -482
  70. package/dist/evm/spv_swap/EVMSpvVaultData.d.ts +39 -39
  71. package/dist/evm/spv_swap/EVMSpvVaultData.js +0 -180
  72. package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts +19 -19
  73. package/dist/evm/spv_swap/EVMSpvWithdrawalData.js +55 -55
  74. package/dist/evm/spv_swap/SpvVaultContractAbi.d.ts +91 -91
  75. package/dist/evm/spv_swap/SpvVaultContractAbi.js +849 -849
  76. package/dist/evm/spv_swap/SpvVaultContractTypechain.d.ts +450 -450
  77. package/dist/evm/spv_swap/SpvVaultContractTypechain.js +2 -2
  78. package/dist/evm/swaps/EVMSwapContract.d.ts +193 -193
  79. package/dist/evm/swaps/EVMSwapContract.js +378 -378
  80. package/dist/evm/swaps/EVMSwapData.d.ts +66 -66
  81. package/dist/evm/swaps/EVMSwapData.js +260 -260
  82. package/dist/evm/swaps/EVMSwapModule.d.ts +9 -9
  83. package/dist/evm/swaps/EVMSwapModule.js +11 -11
  84. package/dist/evm/swaps/EscrowManagerAbi.d.ts +120 -120
  85. package/dist/evm/swaps/EscrowManagerAbi.js +985 -985
  86. package/dist/evm/swaps/EscrowManagerTypechain.d.ts +475 -475
  87. package/dist/evm/swaps/EscrowManagerTypechain.js +2 -2
  88. package/dist/evm/swaps/handlers/IHandler.d.ts +13 -13
  89. package/dist/evm/swaps/handlers/IHandler.js +2 -2
  90. package/dist/evm/swaps/handlers/claim/ClaimHandlers.d.ts +10 -10
  91. package/dist/evm/swaps/handlers/claim/ClaimHandlers.js +13 -13
  92. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.d.ts +20 -20
  93. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.js +39 -39
  94. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  95. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +59 -59
  96. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  97. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +51 -51
  98. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +21 -21
  99. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +28 -28
  100. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +48 -48
  101. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +63 -63
  102. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  103. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.js +28 -28
  104. package/dist/evm/swaps/modules/EVMLpVault.d.ts +69 -69
  105. package/dist/evm/swaps/modules/EVMLpVault.js +134 -134
  106. package/dist/evm/swaps/modules/EVMSwapClaim.d.ts +54 -54
  107. package/dist/evm/swaps/modules/EVMSwapClaim.js +137 -137
  108. package/dist/evm/swaps/modules/EVMSwapInit.d.ts +88 -88
  109. package/dist/evm/swaps/modules/EVMSwapInit.js +274 -274
  110. package/dist/evm/swaps/modules/EVMSwapRefund.d.ts +62 -62
  111. package/dist/evm/swaps/modules/EVMSwapRefund.js +167 -167
  112. package/dist/evm/typechain/common.d.ts +50 -50
  113. package/dist/evm/typechain/common.js +2 -2
  114. package/dist/evm/wallet/EVMBrowserSigner.d.ts +5 -5
  115. package/dist/evm/wallet/EVMBrowserSigner.js +11 -11
  116. package/dist/evm/wallet/EVMPersistentSigner.d.ts +29 -29
  117. package/dist/evm/wallet/EVMPersistentSigner.js +222 -222
  118. package/dist/evm/wallet/EVMSigner.d.ts +11 -11
  119. package/dist/evm/wallet/EVMSigner.js +24 -24
  120. package/dist/index.d.ts +44 -44
  121. package/dist/index.js +60 -60
  122. package/dist/utils/Utils.d.ts +17 -17
  123. package/dist/utils/Utils.js +81 -81
  124. package/package.json +39 -39
  125. package/src/chains/botanix/BotanixChainType.ts +28 -28
  126. package/src/chains/botanix/BotanixInitializer.ts +171 -171
  127. package/src/chains/citrea/CitreaBtcRelay.ts +57 -57
  128. package/src/chains/citrea/CitreaChainType.ts +28 -28
  129. package/src/chains/citrea/CitreaFees.ts +77 -77
  130. package/src/chains/citrea/CitreaInitializer.ts +178 -178
  131. package/src/chains/citrea/CitreaSpvVaultContract.ts +75 -75
  132. package/src/chains/citrea/CitreaSwapContract.ts +102 -102
  133. package/src/chains/citrea/CitreaTokens.ts +21 -21
  134. package/src/evm/btcrelay/BtcRelayAbi.ts +258 -258
  135. package/src/evm/btcrelay/BtcRelayTypechain.ts +371 -371
  136. package/src/evm/btcrelay/EVMBtcRelay.ts +537 -537
  137. package/src/evm/btcrelay/headers/EVMBtcHeader.ts +109 -109
  138. package/src/evm/btcrelay/headers/EVMBtcStoredHeader.ts +152 -152
  139. package/src/evm/chain/EVMChainInterface.ts +155 -155
  140. package/src/evm/chain/EVMModule.ts +21 -21
  141. package/src/evm/chain/modules/ERC20Abi.ts +222 -222
  142. package/src/evm/chain/modules/EVMAddresses.ts +28 -28
  143. package/src/evm/chain/modules/EVMBlocks.ts +75 -75
  144. package/src/evm/chain/modules/EVMEvents.ts +139 -139
  145. package/src/evm/chain/modules/EVMFees.ts +104 -104
  146. package/src/evm/chain/modules/EVMSignatures.ts +76 -76
  147. package/src/evm/chain/modules/EVMTokens.ts +155 -155
  148. package/src/evm/chain/modules/EVMTransactions.ts +325 -325
  149. package/src/evm/contract/EVMContractBase.ts +63 -63
  150. package/src/evm/contract/EVMContractModule.ts +16 -16
  151. package/src/evm/contract/modules/EVMContractEvents.ts +102 -102
  152. package/src/evm/events/EVMChainEvents.ts +82 -82
  153. package/src/evm/events/EVMChainEventsBrowser.ts +534 -525
  154. package/src/evm/providers/JsonRpcProviderWithRetries.ts +24 -24
  155. package/src/evm/providers/ReconnectingWebSocketProvider.ts +101 -101
  156. package/src/evm/providers/SocketProvider.ts +368 -368
  157. package/src/evm/providers/WebSocketProviderWithRetries.ts +27 -27
  158. package/src/evm/spv_swap/EVMSpvVaultContract.ts +615 -615
  159. package/src/evm/spv_swap/EVMSpvVaultData.ts +224 -224
  160. package/src/evm/spv_swap/EVMSpvWithdrawalData.ts +70 -70
  161. package/src/evm/spv_swap/SpvVaultContractAbi.ts +846 -846
  162. package/src/evm/spv_swap/SpvVaultContractTypechain.ts +685 -685
  163. package/src/evm/swaps/EVMSwapContract.ts +600 -600
  164. package/src/evm/swaps/EVMSwapData.ts +378 -378
  165. package/src/evm/swaps/EVMSwapModule.ts +16 -16
  166. package/src/evm/swaps/EscrowManagerAbi.ts +982 -982
  167. package/src/evm/swaps/EscrowManagerTypechain.ts +723 -723
  168. package/src/evm/swaps/handlers/IHandler.ts +17 -17
  169. package/src/evm/swaps/handlers/claim/ClaimHandlers.ts +20 -20
  170. package/src/evm/swaps/handlers/claim/HashlockClaimHandler.ts +46 -46
  171. package/src/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +82 -82
  172. package/src/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +76 -76
  173. package/src/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +46 -46
  174. package/src/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +115 -115
  175. package/src/evm/swaps/handlers/refund/TimelockRefundHandler.ts +37 -37
  176. package/src/evm/swaps/modules/EVMLpVault.ts +154 -154
  177. package/src/evm/swaps/modules/EVMSwapClaim.ts +172 -172
  178. package/src/evm/swaps/modules/EVMSwapInit.ts +328 -328
  179. package/src/evm/swaps/modules/EVMSwapRefund.ts +229 -229
  180. package/src/evm/typechain/common.ts +131 -131
  181. package/src/evm/wallet/EVMBrowserSigner.ts +11 -11
  182. package/src/evm/wallet/EVMPersistentSigner.ts +298 -298
  183. package/src/evm/wallet/EVMSigner.ts +31 -31
  184. package/src/index.ts +53 -53
  185. package/src/utils/Utils.ts +92 -92
@@ -1,298 +1,298 @@
1
- import * as fs from "fs/promises";
2
- import {
3
- Signer,
4
- Transaction,
5
- TransactionRequest,
6
- TransactionResponse
7
- } from "ethers";
8
- import {bigIntMax, getLogger, LoggerType} from "../../utils/Utils";
9
- import {EVMBlockTag} from "../chain/modules/EVMBlocks";
10
- import {EVMChainInterface} from "../chain/EVMChainInterface";
11
- import {EVMFees} from "../chain/modules/EVMFees";
12
- import {EVMSigner} from "./EVMSigner";
13
- import {PromiseQueue} from "promise-queue-ts";
14
-
15
- const WAIT_BEFORE_BUMP = 15*1000;
16
- const MIN_FEE_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
17
- const MIN_FEE_INCREASE_PPM = 100_000n; // +10%
18
-
19
- export class EVMPersistentSigner extends EVMSigner {
20
-
21
- readonly safeBlockTag: EVMBlockTag;
22
-
23
- private pendingTxs: Map<number, {
24
- txs: Transaction[],
25
- lastBumped: number,
26
- sending?: boolean //Not saved
27
- }> = new Map();
28
-
29
- private confirmedNonce: number;
30
- private pendingNonce: number;
31
-
32
- private feeBumper: any;
33
- private stopped: boolean = false;
34
-
35
- private readonly directory: string;
36
-
37
- private readonly waitBeforeBump: number;
38
- private readonly minFeeIncreaseAbsolute: bigint;
39
- private readonly minFeeIncreasePpm: bigint;
40
-
41
- private readonly chainInterface: EVMChainInterface;
42
-
43
- private readonly logger: LoggerType;
44
-
45
- constructor(
46
- account: Signer,
47
- address: string,
48
- chainInterface: EVMChainInterface,
49
- directory: string,
50
- minFeeIncreaseAbsolute?: bigint,
51
- minFeeIncreasePpm?: bigint,
52
- waitBeforeBumpMillis?: number
53
- ) {
54
- super(account, address, true);
55
- this.signTransaction = null;
56
- this.chainInterface = chainInterface;
57
- this.directory = directory;
58
- this.minFeeIncreaseAbsolute = minFeeIncreaseAbsolute ?? MIN_FEE_INCREASE_ABSOLUTE;
59
- this.minFeeIncreasePpm = minFeeIncreasePpm ?? MIN_FEE_INCREASE_PPM;
60
- this.waitBeforeBump = waitBeforeBumpMillis ?? WAIT_BEFORE_BUMP;
61
- this.safeBlockTag = chainInterface.config.safeBlockTag;
62
- this.logger = getLogger("EVMPersistentSigner("+address+"): ");
63
- }
64
-
65
- private async load() {
66
- const fileExists = await fs.access(this.directory+"/txs.json", fs.constants.F_OK).then(() => true).catch(() => false);
67
- if(!fileExists) return;
68
- const res = await fs.readFile(this.directory+"/txs.json");
69
- if(res!=null) {
70
- const pendingTxs: {
71
- [nonce: string]: {
72
- txs: string[],
73
- lastBumped: number
74
- }
75
- } = JSON.parse((res as Buffer).toString());
76
-
77
- for(let nonceStr in pendingTxs) {
78
- const nonceData = pendingTxs[nonceStr];
79
-
80
- const nonce = parseInt(nonceStr);
81
- if(this.confirmedNonce>=nonce) continue; //Already confirmed
82
-
83
- if(this.pendingNonce<nonce) {
84
- this.pendingNonce = nonce;
85
- }
86
- const parsedPendingTxns = nonceData.txs.map(Transaction.from);
87
- this.pendingTxs.set(nonce, {
88
- txs: parsedPendingTxns,
89
- lastBumped: nonceData.lastBumped
90
- })
91
- for(let tx of parsedPendingTxns) {
92
- this.chainInterface.Transactions._knownTxSet.add(tx.hash);
93
- }
94
- }
95
- }
96
- }
97
-
98
- private priorSavePromise: Promise<void>;
99
- private saveCount: number = 0;
100
-
101
- private async save() {
102
- const pendingTxs: {
103
- [nonce: string]: {
104
- txs: string[],
105
- lastBumped: number
106
- }
107
- } = {};
108
- for(let [nonce, data] of this.pendingTxs) {
109
- pendingTxs[nonce.toString(10)] = {
110
- lastBumped: data.lastBumped,
111
- txs: data.txs.map(tx => tx.serialized)
112
- };
113
- }
114
- const requiredSaveCount = ++this.saveCount;
115
- if(this.priorSavePromise!=null) {
116
- await this.priorSavePromise;
117
- }
118
- if(requiredSaveCount===this.saveCount) {
119
- this.priorSavePromise = fs.writeFile(this.directory+"/txs.json", JSON.stringify(pendingTxs));
120
- await this.priorSavePromise;
121
- }
122
- }
123
-
124
- private async checkPastTransactions() {
125
- let _gasPrice: {
126
- baseFee: bigint,
127
- priorityFee: bigint
128
- } = null;
129
- let _safeBlockTxCount: number = null;
130
-
131
- for(let [nonce, data] of this.pendingTxs) {
132
- if(!data.sending && data.lastBumped<Date.now()-this.waitBeforeBump) {
133
- _safeBlockTxCount = await this.chainInterface.provider.getTransactionCount(this.address, this.safeBlockTag);
134
- this.confirmedNonce = _safeBlockTxCount;
135
- if(_safeBlockTxCount > nonce) {
136
- this.pendingTxs.delete(nonce);
137
- data.txs.forEach(tx => this.chainInterface.Transactions._knownTxSet.delete(tx.hash));
138
- this.logger.info("checkPastTransactions(): Tx confirmed, required fee bumps: ", data.txs.length);
139
- this.save();
140
- continue;
141
- }
142
-
143
- const lastTx = data.txs[data.txs.length-1];
144
- if(_gasPrice==null) {
145
- const feeRate = await this.chainInterface.Fees.getFeeRate();
146
- const [baseFee, priorityFee] = feeRate.split(",");
147
- _gasPrice = {
148
- baseFee: BigInt(baseFee),
149
- priorityFee: BigInt(priorityFee)
150
- };
151
- }
152
-
153
- let priorityFee = lastTx.maxPriorityFeePerGas;
154
- let baseFee = lastTx.maxFeePerGas - lastTx.maxPriorityFeePerGas;
155
-
156
- baseFee = bigIntMax(_gasPrice.baseFee, this.minFeeIncreaseAbsolute + (baseFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n));
157
- priorityFee = bigIntMax(_gasPrice.priorityFee, this.minFeeIncreaseAbsolute + (priorityFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n));
158
-
159
- if(
160
- baseFee > (this.minFeeIncreaseAbsolute + (_gasPrice.baseFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n)) &&
161
- priorityFee > (this.minFeeIncreaseAbsolute + (_gasPrice.priorityFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n))
162
- ) {
163
- //Too big of an increase over the current fee rate, don't fee bump
164
- this.logger.debug("checkPastTransactions(): Tx yet unconfirmed but not increasing fee for ", lastTx.hash);
165
- await this.chainInterface.provider.broadcastTransaction(lastTx.serialized).catch(e => {
166
- if(e.code==="NONCE_EXPIRED") return;
167
- this.logger.error("checkPastTransactions(): Tx re-broadcast error", e)
168
- });
169
- continue;
170
- }
171
-
172
- let newTx = lastTx.clone();
173
- EVMFees.applyFeeRate(newTx, null, baseFee.toString(10)+","+priorityFee.toString(10));
174
- this.logger.info("checkPastTransactions(): Bump fee for tx: ", lastTx.hash);
175
-
176
- newTx.signature = null;
177
- const signedRawTx = await this.account.signTransaction(newTx);
178
-
179
- //Double check pending txns still has nonce after async signTransaction was called
180
- if(!this.pendingTxs.has(nonce)) continue;
181
-
182
- newTx = Transaction.from(signedRawTx);
183
-
184
- for(let callback of this.chainInterface.Transactions._cbksBeforeTxReplace) {
185
- try {
186
- await callback(lastTx.serialized, lastTx.hash, signedRawTx, newTx.hash)
187
- } catch (e) {
188
- this.logger.error("checkPastTransactions(): beforeTxReplace callback error: ", e);
189
- }
190
- }
191
-
192
- data.txs.push(newTx);
193
- data.lastBumped = Date.now();
194
- this.save();
195
-
196
- this.chainInterface.Transactions._knownTxSet.add(newTx.hash);
197
-
198
- //TODO: Better error handling when sending tx
199
- await this.chainInterface.provider.broadcastTransaction(signedRawTx).catch(e => {
200
- if(e.code==="NONCE_EXPIRED") return;
201
- this.logger.error("checkPastTransactions(): Fee-bumped tx broadcast error", e)
202
- });
203
- }
204
- }
205
- }
206
-
207
- private startFeeBumper() {
208
- let func: () => Promise<void>;
209
- func = async () => {
210
- try {
211
- await this.checkPastTransactions();
212
- } catch (e) {
213
- this.logger.error("startFeeBumper(): Error when check past transactions: ", e);
214
- }
215
-
216
- if(this.stopped) return;
217
-
218
- this.feeBumper = setTimeout(func, 1000);
219
- };
220
- func();
221
- }
222
-
223
- async init(): Promise<void> {
224
- try {
225
- await fs.mkdir(this.directory)
226
- } catch (e) {}
227
-
228
- const txCount = await this.chainInterface.provider.getTransactionCount(this.address, this.safeBlockTag);
229
- this.confirmedNonce = txCount-1;
230
- this.pendingNonce = txCount-1;
231
-
232
- await this.load();
233
-
234
- this.startFeeBumper();
235
- }
236
-
237
- stop(): Promise<void> {
238
- this.stopped = true;
239
- if(this.feeBumper!=null) {
240
- clearTimeout(this.feeBumper);
241
- this.feeBumper = null;
242
- }
243
- return Promise.resolve();
244
- }
245
-
246
- private readonly sendTransactionQueue: PromiseQueue = new PromiseQueue();
247
-
248
- sendTransaction(transaction: TransactionRequest, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<TransactionResponse> {
249
- return this.sendTransactionQueue.enqueue(async () => {
250
- if(transaction.nonce!=null) {
251
- if(transaction.nonce !== this.pendingNonce + 1)
252
- throw new Error("Invalid transaction nonce!");
253
- this.pendingNonce++;
254
- } else {
255
- this.pendingNonce++;
256
- transaction.nonce = this.pendingNonce;
257
- }
258
-
259
- const tx: TransactionRequest = {};
260
- for(let key in transaction) {
261
- if(transaction[key] instanceof Promise) {
262
- tx[key] = await transaction[key];
263
- } else {
264
- tx[key] = transaction[key];
265
- }
266
- }
267
-
268
- const signedRawTx = await this.account.signTransaction(tx);
269
- const signedTx = Transaction.from(signedRawTx);
270
-
271
- if(onBeforePublish!=null) {
272
- try {
273
- await onBeforePublish(signedTx.hash, signedRawTx);
274
- } catch (e) {
275
- this.logger.error("sendTransaction(): Error when calling onBeforePublish function: ", e);
276
- }
277
- }
278
-
279
- const pendingTxObject = {txs: [signedTx], lastBumped: Date.now(), sending: true};
280
- this.pendingTxs.set(transaction.nonce, pendingTxObject);
281
- this.save();
282
-
283
- this.chainInterface.Transactions._knownTxSet.add(signedTx.hash);
284
-
285
- try {
286
- const result = await this.chainInterface.provider.broadcastTransaction(signedRawTx);
287
- pendingTxObject.sending = false;
288
- return result;
289
- } catch (e) {
290
- this.chainInterface.Transactions._knownTxSet.delete(signedTx.hash);
291
- this.pendingTxs.delete(transaction.nonce);
292
- this.pendingNonce--;
293
- throw e;
294
- }
295
- });
296
- }
297
-
298
- }
1
+ import * as fs from "fs/promises";
2
+ import {
3
+ Signer,
4
+ Transaction,
5
+ TransactionRequest,
6
+ TransactionResponse
7
+ } from "ethers";
8
+ import {bigIntMax, getLogger, LoggerType} from "../../utils/Utils";
9
+ import {EVMBlockTag} from "../chain/modules/EVMBlocks";
10
+ import {EVMChainInterface} from "../chain/EVMChainInterface";
11
+ import {EVMFees} from "../chain/modules/EVMFees";
12
+ import {EVMSigner} from "./EVMSigner";
13
+ import {PromiseQueue} from "promise-queue-ts";
14
+
15
+ const WAIT_BEFORE_BUMP = 15*1000;
16
+ const MIN_FEE_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
17
+ const MIN_FEE_INCREASE_PPM = 100_000n; // +10%
18
+
19
+ export class EVMPersistentSigner extends EVMSigner {
20
+
21
+ readonly safeBlockTag: EVMBlockTag;
22
+
23
+ private pendingTxs: Map<number, {
24
+ txs: Transaction[],
25
+ lastBumped: number,
26
+ sending?: boolean //Not saved
27
+ }> = new Map();
28
+
29
+ private confirmedNonce: number;
30
+ private pendingNonce: number;
31
+
32
+ private feeBumper: any;
33
+ private stopped: boolean = false;
34
+
35
+ private readonly directory: string;
36
+
37
+ private readonly waitBeforeBump: number;
38
+ private readonly minFeeIncreaseAbsolute: bigint;
39
+ private readonly minFeeIncreasePpm: bigint;
40
+
41
+ private readonly chainInterface: EVMChainInterface;
42
+
43
+ private readonly logger: LoggerType;
44
+
45
+ constructor(
46
+ account: Signer,
47
+ address: string,
48
+ chainInterface: EVMChainInterface,
49
+ directory: string,
50
+ minFeeIncreaseAbsolute?: bigint,
51
+ minFeeIncreasePpm?: bigint,
52
+ waitBeforeBumpMillis?: number
53
+ ) {
54
+ super(account, address, true);
55
+ this.signTransaction = null;
56
+ this.chainInterface = chainInterface;
57
+ this.directory = directory;
58
+ this.minFeeIncreaseAbsolute = minFeeIncreaseAbsolute ?? MIN_FEE_INCREASE_ABSOLUTE;
59
+ this.minFeeIncreasePpm = minFeeIncreasePpm ?? MIN_FEE_INCREASE_PPM;
60
+ this.waitBeforeBump = waitBeforeBumpMillis ?? WAIT_BEFORE_BUMP;
61
+ this.safeBlockTag = chainInterface.config.safeBlockTag;
62
+ this.logger = getLogger("EVMPersistentSigner("+address+"): ");
63
+ }
64
+
65
+ private async load() {
66
+ const fileExists = await fs.access(this.directory+"/txs.json", fs.constants.F_OK).then(() => true).catch(() => false);
67
+ if(!fileExists) return;
68
+ const res = await fs.readFile(this.directory+"/txs.json");
69
+ if(res!=null) {
70
+ const pendingTxs: {
71
+ [nonce: string]: {
72
+ txs: string[],
73
+ lastBumped: number
74
+ }
75
+ } = JSON.parse((res as Buffer).toString());
76
+
77
+ for(let nonceStr in pendingTxs) {
78
+ const nonceData = pendingTxs[nonceStr];
79
+
80
+ const nonce = parseInt(nonceStr);
81
+ if(this.confirmedNonce>=nonce) continue; //Already confirmed
82
+
83
+ if(this.pendingNonce<nonce) {
84
+ this.pendingNonce = nonce;
85
+ }
86
+ const parsedPendingTxns = nonceData.txs.map(Transaction.from);
87
+ this.pendingTxs.set(nonce, {
88
+ txs: parsedPendingTxns,
89
+ lastBumped: nonceData.lastBumped
90
+ })
91
+ for(let tx of parsedPendingTxns) {
92
+ this.chainInterface.Transactions._knownTxSet.add(tx.hash);
93
+ }
94
+ }
95
+ }
96
+ }
97
+
98
+ private priorSavePromise: Promise<void>;
99
+ private saveCount: number = 0;
100
+
101
+ private async save() {
102
+ const pendingTxs: {
103
+ [nonce: string]: {
104
+ txs: string[],
105
+ lastBumped: number
106
+ }
107
+ } = {};
108
+ for(let [nonce, data] of this.pendingTxs) {
109
+ pendingTxs[nonce.toString(10)] = {
110
+ lastBumped: data.lastBumped,
111
+ txs: data.txs.map(tx => tx.serialized)
112
+ };
113
+ }
114
+ const requiredSaveCount = ++this.saveCount;
115
+ if(this.priorSavePromise!=null) {
116
+ await this.priorSavePromise;
117
+ }
118
+ if(requiredSaveCount===this.saveCount) {
119
+ this.priorSavePromise = fs.writeFile(this.directory+"/txs.json", JSON.stringify(pendingTxs));
120
+ await this.priorSavePromise;
121
+ }
122
+ }
123
+
124
+ private async checkPastTransactions() {
125
+ let _gasPrice: {
126
+ baseFee: bigint,
127
+ priorityFee: bigint
128
+ } = null;
129
+ let _safeBlockTxCount: number = null;
130
+
131
+ for(let [nonce, data] of this.pendingTxs) {
132
+ if(!data.sending && data.lastBumped<Date.now()-this.waitBeforeBump) {
133
+ _safeBlockTxCount = await this.chainInterface.provider.getTransactionCount(this.address, this.safeBlockTag);
134
+ this.confirmedNonce = _safeBlockTxCount;
135
+ if(_safeBlockTxCount > nonce) {
136
+ this.pendingTxs.delete(nonce);
137
+ data.txs.forEach(tx => this.chainInterface.Transactions._knownTxSet.delete(tx.hash));
138
+ this.logger.info("checkPastTransactions(): Tx confirmed, required fee bumps: ", data.txs.length);
139
+ this.save();
140
+ continue;
141
+ }
142
+
143
+ const lastTx = data.txs[data.txs.length-1];
144
+ if(_gasPrice==null) {
145
+ const feeRate = await this.chainInterface.Fees.getFeeRate();
146
+ const [baseFee, priorityFee] = feeRate.split(",");
147
+ _gasPrice = {
148
+ baseFee: BigInt(baseFee),
149
+ priorityFee: BigInt(priorityFee)
150
+ };
151
+ }
152
+
153
+ let priorityFee = lastTx.maxPriorityFeePerGas;
154
+ let baseFee = lastTx.maxFeePerGas - lastTx.maxPriorityFeePerGas;
155
+
156
+ baseFee = bigIntMax(_gasPrice.baseFee, this.minFeeIncreaseAbsolute + (baseFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n));
157
+ priorityFee = bigIntMax(_gasPrice.priorityFee, this.minFeeIncreaseAbsolute + (priorityFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n));
158
+
159
+ if(
160
+ baseFee > (this.minFeeIncreaseAbsolute + (_gasPrice.baseFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n)) &&
161
+ priorityFee > (this.minFeeIncreaseAbsolute + (_gasPrice.priorityFee * (1_000_000n + this.minFeeIncreasePpm) / 1_000_000n))
162
+ ) {
163
+ //Too big of an increase over the current fee rate, don't fee bump
164
+ this.logger.debug("checkPastTransactions(): Tx yet unconfirmed but not increasing fee for ", lastTx.hash);
165
+ await this.chainInterface.provider.broadcastTransaction(lastTx.serialized).catch(e => {
166
+ if(e.code==="NONCE_EXPIRED") return;
167
+ this.logger.error("checkPastTransactions(): Tx re-broadcast error", e)
168
+ });
169
+ continue;
170
+ }
171
+
172
+ let newTx = lastTx.clone();
173
+ EVMFees.applyFeeRate(newTx, null, baseFee.toString(10)+","+priorityFee.toString(10));
174
+ this.logger.info("checkPastTransactions(): Bump fee for tx: ", lastTx.hash);
175
+
176
+ newTx.signature = null;
177
+ const signedRawTx = await this.account.signTransaction(newTx);
178
+
179
+ //Double check pending txns still has nonce after async signTransaction was called
180
+ if(!this.pendingTxs.has(nonce)) continue;
181
+
182
+ newTx = Transaction.from(signedRawTx);
183
+
184
+ for(let callback of this.chainInterface.Transactions._cbksBeforeTxReplace) {
185
+ try {
186
+ await callback(lastTx.serialized, lastTx.hash, signedRawTx, newTx.hash)
187
+ } catch (e) {
188
+ this.logger.error("checkPastTransactions(): beforeTxReplace callback error: ", e);
189
+ }
190
+ }
191
+
192
+ data.txs.push(newTx);
193
+ data.lastBumped = Date.now();
194
+ this.save();
195
+
196
+ this.chainInterface.Transactions._knownTxSet.add(newTx.hash);
197
+
198
+ //TODO: Better error handling when sending tx
199
+ await this.chainInterface.provider.broadcastTransaction(signedRawTx).catch(e => {
200
+ if(e.code==="NONCE_EXPIRED") return;
201
+ this.logger.error("checkPastTransactions(): Fee-bumped tx broadcast error", e)
202
+ });
203
+ }
204
+ }
205
+ }
206
+
207
+ private startFeeBumper() {
208
+ let func: () => Promise<void>;
209
+ func = async () => {
210
+ try {
211
+ await this.checkPastTransactions();
212
+ } catch (e) {
213
+ this.logger.error("startFeeBumper(): Error when check past transactions: ", e);
214
+ }
215
+
216
+ if(this.stopped) return;
217
+
218
+ this.feeBumper = setTimeout(func, 1000);
219
+ };
220
+ func();
221
+ }
222
+
223
+ async init(): Promise<void> {
224
+ try {
225
+ await fs.mkdir(this.directory)
226
+ } catch (e) {}
227
+
228
+ const txCount = await this.chainInterface.provider.getTransactionCount(this.address, this.safeBlockTag);
229
+ this.confirmedNonce = txCount-1;
230
+ this.pendingNonce = txCount-1;
231
+
232
+ await this.load();
233
+
234
+ this.startFeeBumper();
235
+ }
236
+
237
+ stop(): Promise<void> {
238
+ this.stopped = true;
239
+ if(this.feeBumper!=null) {
240
+ clearTimeout(this.feeBumper);
241
+ this.feeBumper = null;
242
+ }
243
+ return Promise.resolve();
244
+ }
245
+
246
+ private readonly sendTransactionQueue: PromiseQueue = new PromiseQueue();
247
+
248
+ sendTransaction(transaction: TransactionRequest, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<TransactionResponse> {
249
+ return this.sendTransactionQueue.enqueue(async () => {
250
+ if(transaction.nonce!=null) {
251
+ if(transaction.nonce !== this.pendingNonce + 1)
252
+ throw new Error("Invalid transaction nonce!");
253
+ this.pendingNonce++;
254
+ } else {
255
+ this.pendingNonce++;
256
+ transaction.nonce = this.pendingNonce;
257
+ }
258
+
259
+ const tx: TransactionRequest = {};
260
+ for(let key in transaction) {
261
+ if(transaction[key] instanceof Promise) {
262
+ tx[key] = await transaction[key];
263
+ } else {
264
+ tx[key] = transaction[key];
265
+ }
266
+ }
267
+
268
+ const signedRawTx = await this.account.signTransaction(tx);
269
+ const signedTx = Transaction.from(signedRawTx);
270
+
271
+ if(onBeforePublish!=null) {
272
+ try {
273
+ await onBeforePublish(signedTx.hash, signedRawTx);
274
+ } catch (e) {
275
+ this.logger.error("sendTransaction(): Error when calling onBeforePublish function: ", e);
276
+ }
277
+ }
278
+
279
+ const pendingTxObject = {txs: [signedTx], lastBumped: Date.now(), sending: true};
280
+ this.pendingTxs.set(transaction.nonce, pendingTxObject);
281
+ this.save();
282
+
283
+ this.chainInterface.Transactions._knownTxSet.add(signedTx.hash);
284
+
285
+ try {
286
+ const result = await this.chainInterface.provider.broadcastTransaction(signedRawTx);
287
+ pendingTxObject.sending = false;
288
+ return result;
289
+ } catch (e) {
290
+ this.chainInterface.Transactions._knownTxSet.delete(signedTx.hash);
291
+ this.pendingTxs.delete(transaction.nonce);
292
+ this.pendingNonce--;
293
+ throw e;
294
+ }
295
+ });
296
+ }
297
+
298
+ }
@@ -1,31 +1,31 @@
1
- import {AbstractSigner} from "@atomiqlabs/base";
2
- import {Signer, Transaction, TransactionRequest, TransactionResponse} from "ethers";
3
-
4
-
5
- export class EVMSigner implements AbstractSigner {
6
-
7
- account: Signer;
8
- public readonly address: string;
9
- public readonly isManagingNoncesInternally: boolean;
10
-
11
- constructor(account: Signer, address: string, isManagingNoncesInternally: boolean = false) {
12
- this.account = account;
13
- this.address = address;
14
- this.isManagingNoncesInternally = isManagingNoncesInternally;
15
- }
16
-
17
- getAddress(): string {
18
- return this.address;
19
- }
20
-
21
- async signTransaction?(transaction: TransactionRequest): Promise<string> {
22
- return this.account.signTransaction(transaction);
23
- }
24
-
25
- async sendTransaction(transaction: TransactionRequest, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<TransactionResponse> {
26
- const txResponse = await this.account.sendTransaction(transaction);
27
- if(onBeforePublish!=null) await onBeforePublish(txResponse.hash, Transaction.from(txResponse).serialized);
28
- return txResponse;
29
- }
30
-
31
- }
1
+ import {AbstractSigner} from "@atomiqlabs/base";
2
+ import {Signer, Transaction, TransactionRequest, TransactionResponse} from "ethers";
3
+
4
+
5
+ export class EVMSigner implements AbstractSigner {
6
+
7
+ account: Signer;
8
+ public readonly address: string;
9
+ public readonly isManagingNoncesInternally: boolean;
10
+
11
+ constructor(account: Signer, address: string, isManagingNoncesInternally: boolean = false) {
12
+ this.account = account;
13
+ this.address = address;
14
+ this.isManagingNoncesInternally = isManagingNoncesInternally;
15
+ }
16
+
17
+ getAddress(): string {
18
+ return this.address;
19
+ }
20
+
21
+ async signTransaction?(transaction: TransactionRequest): Promise<string> {
22
+ return this.account.signTransaction(transaction);
23
+ }
24
+
25
+ async sendTransaction(transaction: TransactionRequest, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<TransactionResponse> {
26
+ const txResponse = await this.account.sendTransaction(transaction);
27
+ if(onBeforePublish!=null) await onBeforePublish(txResponse.hash, Transaction.from(txResponse).serialized);
28
+ return txResponse;
29
+ }
30
+
31
+ }