@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,325 +1,325 @@
1
- import {EVMModule} from "../EVMModule";
2
- import {Transaction, TransactionRequest, TransactionResponse} from "ethers";
3
- import {timeoutPromise} from "../../../utils/Utils";
4
- import {EVMSigner} from "../../wallet/EVMSigner";
5
-
6
- export type EVMTx = TransactionRequest;
7
-
8
- export type EVMTxTrace = {
9
- from: string,
10
- gas: string,
11
- gasused: string,
12
- to: string,
13
- input: string,
14
- output: string,
15
- error: string,
16
- revertReason: string,
17
- calls: EVMTxTrace[],
18
- type: "CREATE" | "CALL" | "STATICCALL"
19
- };
20
-
21
- const MAX_UNCONFIRMED_TXNS = 10;
22
-
23
- export class EVMTransactions extends EVMModule<any> {
24
-
25
- private readonly latestConfirmedNonces: {[address: string]: number} = {};
26
- private readonly latestPendingNonces: {[address: string]: number} = {};
27
- private readonly latestSignedNonces: {[address: string]: number} = {};
28
-
29
- readonly _cbksBeforeTxReplace: ((oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>)[] = [];
30
- private readonly cbksBeforeTxSigned: ((tx: TransactionRequest) => Promise<void>)[] = [];
31
- private cbkSendTransaction: (tx: string) => Promise<string>;
32
-
33
- readonly _knownTxSet: Set<string> = new Set();
34
-
35
- /**
36
- * Waits for transaction confirmation using HTTP polling
37
- *
38
- * @param tx EVM transaction to wait for confirmation for
39
- * @param abortSignal signal to abort waiting for tx confirmation
40
- * @private
41
- */
42
- private async confirmTransaction(tx: TransactionResponse | Transaction, abortSignal?: AbortSignal): Promise<string> {
43
- const checkTxns: Set<string> = new Set([tx.hash]);
44
-
45
- const txReplaceListener = (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => {
46
- if(checkTxns.has(oldTxId)) checkTxns.add(newTxId);
47
- return Promise.resolve();
48
- };
49
- this.onBeforeTxReplace(txReplaceListener);
50
-
51
- let state = "pending";
52
- let confirmedTxId: string = null;
53
- while(state==="pending" || state==="not_found") {
54
- await timeoutPromise(3000, abortSignal);
55
- for(let txId of checkTxns) {
56
- state = await this.getTxIdStatus(txId);
57
- if(state==="reverted" || state==="success") {
58
- confirmedTxId = txId;
59
- break;
60
- }
61
- }
62
- }
63
-
64
- this.offBeforeTxReplace(txReplaceListener);
65
-
66
- const nextAccountNonce = tx.nonce + 1;
67
- const currentConfirmedNonce = this.latestConfirmedNonces[tx.from];
68
- if(currentConfirmedNonce==null || nextAccountNonce > currentConfirmedNonce) {
69
- this.latestConfirmedNonces[tx.from] = nextAccountNonce;
70
- }
71
- if(state==="reverted") throw new Error("Transaction reverted!");
72
-
73
- return confirmedTxId;
74
- }
75
-
76
- /**
77
- * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
78
- *
79
- * @param signer
80
- * @param txs
81
- * @private
82
- */
83
- private async prepareTransactions(signer: EVMSigner, txs: TransactionRequest[]): Promise<void> {
84
- for(let tx of txs) {
85
- tx.chainId = this.root.evmChainId;
86
- tx.from = signer.getAddress();
87
- }
88
-
89
- if(!signer.isManagingNoncesInternally) {
90
- let nonce: number = await this.root.provider.getTransactionCount(signer.getAddress(), "pending");
91
- const latestKnownNonce = this.latestPendingNonces[signer.getAddress()];
92
- if(latestKnownNonce!=null && latestKnownNonce > nonce) {
93
- this.logger.debug("prepareTransactions(): Using nonce from local cache!");
94
- nonce = latestKnownNonce;
95
- }
96
-
97
- for(let i=0;i<txs.length;i++) {
98
- const tx = txs[i];
99
- if(tx.nonce!=null) nonce = tx.nonce; //Take the nonce from last tx
100
- if(nonce==null) nonce = await this.root.provider.getTransactionCount(signer.getAddress(), "pending"); //Fetch the nonce
101
- if(tx.nonce==null) tx.nonce = nonce;
102
-
103
- this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.nonce);
104
-
105
- nonce++;
106
- }
107
- }
108
-
109
- for(let tx of txs) {
110
- for(let callback of this.cbksBeforeTxSigned) {
111
- await callback(tx);
112
- }
113
- }
114
- }
115
-
116
- /**
117
- * Sends out a signed transaction to the RPC
118
- *
119
- * @param tx EVM tx to send
120
- * @param onBeforePublish a callback called before every transaction is published
121
- * @private
122
- */
123
- private async sendSignedTransaction(
124
- tx: Transaction,
125
- onBeforePublish?: (txId: string, rawTx: string) => Promise<void>,
126
- ): Promise<string> {
127
- if(onBeforePublish!=null) await onBeforePublish(tx.hash, await this.serializeTx(tx));
128
- this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.hash);
129
-
130
- const serializedTx = tx.serialized;
131
-
132
- let result: string;
133
- if(this.cbkSendTransaction!=null) result = await this.cbkSendTransaction(serializedTx);
134
- if(result==null) {
135
- const broadcastResult = await this.provider.broadcastTransaction(tx.serialized);
136
- result = broadcastResult.hash;
137
- }
138
-
139
- this.logger.info("sendSignedTransaction(): tx sent, txHash: "+result);
140
- return result;
141
- }
142
-
143
- /**
144
- * Prepares, signs, sends (in parallel or sequentially) & optionally waits for confirmation
145
- * of a batch of EVM transactions
146
- *
147
- * @param signer
148
- * @param txs transactions to send
149
- * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
150
- * are re-sent at regular intervals)
151
- * @param abortSignal abort signal to abort waiting for transaction confirmations
152
- * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
153
- * are executed in order)
154
- * @param onBeforePublish a callback called before every transaction is published, NOTE: callback is not called when using browser-based wallet!
155
- */
156
- public async sendAndConfirm(signer: EVMSigner, txs: TransactionRequest[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
157
- await this.prepareTransactions(signer, txs);
158
- const signedTxs: Transaction[] = [];
159
-
160
- //Don't separate the signing process from the sending when using browser-based wallet
161
- if(signer.signTransaction!=null) for(let i=0;i<txs.length;i++) {
162
- const tx = txs[i];
163
- const signedTx = Transaction.from(await signer.signTransaction(tx));
164
- signedTxs.push(signedTx);
165
- this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+signedTx);
166
-
167
- const nextAccountNonce = signedTx.nonce + 1;
168
- const currentSignedNonce = this.latestSignedNonces[signedTx.from];
169
- if(currentSignedNonce==null || nextAccountNonce > currentSignedNonce) {
170
- this.latestSignedNonces[signedTx.from] = nextAccountNonce;
171
- }
172
- }
173
-
174
- this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
175
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
176
-
177
- let txIds: string[] = [];
178
- if(parallel) {
179
- let promises: Promise<string>[] = [];
180
- for(let i=0;i<txs.length;i++) {
181
- let tx: TransactionResponse | Transaction;
182
- if(signer.signTransaction==null) {
183
- tx = await signer.sendTransaction(txs[i], onBeforePublish);
184
- } else {
185
- const signedTx = signedTxs[i];
186
- await this.sendSignedTransaction(signedTx, onBeforePublish);
187
- tx = signedTx;
188
- }
189
-
190
- const nextAccountNonce = tx.nonce + 1;
191
- const currentPendingNonce = this.latestPendingNonces[tx.from];
192
- if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
193
- this.latestPendingNonces[tx.from] = nextAccountNonce;
194
- }
195
-
196
- if(waitForConfirmation) promises.push(this.confirmTransaction(tx, abortSignal));
197
- txIds.push(tx.hash);
198
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+signedTxs.length+"): "+tx.hash);
199
- if(promises.length >= MAX_UNCONFIRMED_TXNS) {
200
- await Promise.all(promises);
201
- promises = [];
202
- }
203
- }
204
- if(promises.length>0) txIds = await Promise.all(promises);
205
- } else {
206
- for(let i=0;i<txs.length;i++) {
207
- let tx: TransactionResponse | Transaction;
208
- if(signer.signTransaction==null) {
209
- tx = await signer.sendTransaction(txs[i], onBeforePublish);
210
- } else {
211
- const signedTx = signedTxs[i];
212
- await this.sendSignedTransaction(signedTx, onBeforePublish);
213
- tx = signedTx;
214
- }
215
-
216
- const nextAccountNonce = tx.nonce + 1;
217
- const currentPendingNonce = this.latestPendingNonces[tx.from];
218
- if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
219
- this.latestPendingNonces[tx.from] = nextAccountNonce;
220
- }
221
-
222
- const confirmPromise = this.confirmTransaction(tx, abortSignal);
223
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+tx.hash);
224
- //Don't await the last promise when !waitForConfirmation
225
- let txHash = tx.hash;
226
- if(i<txs.length-1 || waitForConfirmation) txHash = await confirmPromise;
227
- txIds.push(txHash);
228
- }
229
- }
230
-
231
- this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
232
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
233
-
234
- return txIds;
235
- }
236
-
237
- /**
238
- * Serializes the signed EVM transaction
239
- *
240
- * @param tx
241
- */
242
- public serializeTx(tx: Transaction): Promise<string> {
243
- return Promise.resolve(tx.serialized);
244
- }
245
-
246
- /**
247
- * Deserializes signed EVM transaction
248
- *
249
- * @param txData
250
- */
251
- public deserializeTx(txData: string): Promise<Transaction> {
252
- return Promise.resolve(Transaction.from(txData));
253
- }
254
-
255
- /**
256
- * Gets the status of the raw starknet transaction
257
- *
258
- * @param tx
259
- */
260
- public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
261
- const parsedTx: Transaction = await this.deserializeTx(tx);
262
- return await this.getTxIdStatus(parsedTx.hash);
263
- }
264
-
265
- /**
266
- * Gets the status of the EVM transaction with a specific txId
267
- *
268
- * @param txId
269
- */
270
- public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
271
- const txResponse = await this.provider.getTransaction(txId);
272
- if(txResponse==null) return this._knownTxSet.has(txId) ? "pending" : "not_found";
273
- if(txResponse.blockHash==null) return "pending";
274
-
275
- const [safeBlockNumber, txReceipt] = await Promise.all([
276
- this.root.config.safeBlockTag==="latest" ? Promise.resolve(null) : this.provider.getBlock(this.root.config.safeBlockTag).then(res => res.number),
277
- this.provider.getTransactionReceipt(txId)
278
- ]);
279
-
280
- if(txReceipt==null || (safeBlockNumber!=null && txReceipt.blockNumber > safeBlockNumber)) return "pending";
281
- if(txReceipt.status===0) return "reverted";
282
- return "success";
283
- }
284
-
285
- public onBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): void {
286
- this.cbksBeforeTxSigned.push(callback);
287
- }
288
-
289
- public offBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): boolean {
290
- const index = this.cbksBeforeTxSigned.indexOf(callback);
291
- if(index===-1) return false;
292
- this.cbksBeforeTxSigned.splice(index, 1);
293
- return true;
294
- }
295
-
296
- public onSendTransaction(callback: (tx: string) => Promise<string>): void {
297
- this.cbkSendTransaction = callback;
298
- }
299
-
300
- public offSendTransaction(callback: (tx: string) => Promise<string>): boolean {
301
- this.cbkSendTransaction = null;
302
- return true;
303
- }
304
-
305
- onBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): void {
306
- this._cbksBeforeTxReplace.push(callback);
307
- }
308
-
309
- offBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): boolean {
310
- const index = this._cbksBeforeTxReplace.indexOf(callback);
311
- if(index===-1) return false;
312
- this._cbksBeforeTxReplace.splice(index, 1);
313
- return true;
314
- }
315
-
316
- public traceTransaction(txId: string): Promise<EVMTxTrace> {
317
- return this.provider.send("debug_traceTransaction", [
318
- txId,
319
- {
320
- tracer: "callTracer"
321
- }
322
- ]);
323
- }
324
-
325
- }
1
+ import {EVMModule} from "../EVMModule";
2
+ import {Transaction, TransactionRequest, TransactionResponse} from "ethers";
3
+ import {timeoutPromise} from "../../../utils/Utils";
4
+ import {EVMSigner} from "../../wallet/EVMSigner";
5
+
6
+ export type EVMTx = TransactionRequest;
7
+
8
+ export type EVMTxTrace = {
9
+ from: string,
10
+ gas: string,
11
+ gasused: string,
12
+ to: string,
13
+ input: string,
14
+ output: string,
15
+ error: string,
16
+ revertReason: string,
17
+ calls: EVMTxTrace[],
18
+ type: "CREATE" | "CALL" | "STATICCALL"
19
+ };
20
+
21
+ const MAX_UNCONFIRMED_TXNS = 10;
22
+
23
+ export class EVMTransactions extends EVMModule<any> {
24
+
25
+ private readonly latestConfirmedNonces: {[address: string]: number} = {};
26
+ private readonly latestPendingNonces: {[address: string]: number} = {};
27
+ private readonly latestSignedNonces: {[address: string]: number} = {};
28
+
29
+ readonly _cbksBeforeTxReplace: ((oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>)[] = [];
30
+ private readonly cbksBeforeTxSigned: ((tx: TransactionRequest) => Promise<void>)[] = [];
31
+ private cbkSendTransaction: (tx: string) => Promise<string>;
32
+
33
+ readonly _knownTxSet: Set<string> = new Set();
34
+
35
+ /**
36
+ * Waits for transaction confirmation using HTTP polling
37
+ *
38
+ * @param tx EVM transaction to wait for confirmation for
39
+ * @param abortSignal signal to abort waiting for tx confirmation
40
+ * @private
41
+ */
42
+ private async confirmTransaction(tx: TransactionResponse | Transaction, abortSignal?: AbortSignal): Promise<string> {
43
+ const checkTxns: Set<string> = new Set([tx.hash]);
44
+
45
+ const txReplaceListener = (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => {
46
+ if(checkTxns.has(oldTxId)) checkTxns.add(newTxId);
47
+ return Promise.resolve();
48
+ };
49
+ this.onBeforeTxReplace(txReplaceListener);
50
+
51
+ let state = "pending";
52
+ let confirmedTxId: string = null;
53
+ while(state==="pending" || state==="not_found") {
54
+ await timeoutPromise(3000, abortSignal);
55
+ for(let txId of checkTxns) {
56
+ state = await this.getTxIdStatus(txId);
57
+ if(state==="reverted" || state==="success") {
58
+ confirmedTxId = txId;
59
+ break;
60
+ }
61
+ }
62
+ }
63
+
64
+ this.offBeforeTxReplace(txReplaceListener);
65
+
66
+ const nextAccountNonce = tx.nonce + 1;
67
+ const currentConfirmedNonce = this.latestConfirmedNonces[tx.from];
68
+ if(currentConfirmedNonce==null || nextAccountNonce > currentConfirmedNonce) {
69
+ this.latestConfirmedNonces[tx.from] = nextAccountNonce;
70
+ }
71
+ if(state==="reverted") throw new Error("Transaction reverted!");
72
+
73
+ return confirmedTxId;
74
+ }
75
+
76
+ /**
77
+ * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
78
+ *
79
+ * @param signer
80
+ * @param txs
81
+ * @private
82
+ */
83
+ private async prepareTransactions(signer: EVMSigner, txs: TransactionRequest[]): Promise<void> {
84
+ for(let tx of txs) {
85
+ tx.chainId = this.root.evmChainId;
86
+ tx.from = signer.getAddress();
87
+ }
88
+
89
+ if(!signer.isManagingNoncesInternally) {
90
+ let nonce: number = await this.root.provider.getTransactionCount(signer.getAddress(), "pending");
91
+ const latestKnownNonce = this.latestPendingNonces[signer.getAddress()];
92
+ if(latestKnownNonce!=null && latestKnownNonce > nonce) {
93
+ this.logger.debug("prepareTransactions(): Using nonce from local cache!");
94
+ nonce = latestKnownNonce;
95
+ }
96
+
97
+ for(let i=0;i<txs.length;i++) {
98
+ const tx = txs[i];
99
+ if(tx.nonce!=null) nonce = tx.nonce; //Take the nonce from last tx
100
+ if(nonce==null) nonce = await this.root.provider.getTransactionCount(signer.getAddress(), "pending"); //Fetch the nonce
101
+ if(tx.nonce==null) tx.nonce = nonce;
102
+
103
+ this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.nonce);
104
+
105
+ nonce++;
106
+ }
107
+ }
108
+
109
+ for(let tx of txs) {
110
+ for(let callback of this.cbksBeforeTxSigned) {
111
+ await callback(tx);
112
+ }
113
+ }
114
+ }
115
+
116
+ /**
117
+ * Sends out a signed transaction to the RPC
118
+ *
119
+ * @param tx EVM tx to send
120
+ * @param onBeforePublish a callback called before every transaction is published
121
+ * @private
122
+ */
123
+ private async sendSignedTransaction(
124
+ tx: Transaction,
125
+ onBeforePublish?: (txId: string, rawTx: string) => Promise<void>,
126
+ ): Promise<string> {
127
+ if(onBeforePublish!=null) await onBeforePublish(tx.hash, await this.serializeTx(tx));
128
+ this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.hash);
129
+
130
+ const serializedTx = tx.serialized;
131
+
132
+ let result: string;
133
+ if(this.cbkSendTransaction!=null) result = await this.cbkSendTransaction(serializedTx);
134
+ if(result==null) {
135
+ const broadcastResult = await this.provider.broadcastTransaction(tx.serialized);
136
+ result = broadcastResult.hash;
137
+ }
138
+
139
+ this.logger.info("sendSignedTransaction(): tx sent, txHash: "+result);
140
+ return result;
141
+ }
142
+
143
+ /**
144
+ * Prepares, signs, sends (in parallel or sequentially) & optionally waits for confirmation
145
+ * of a batch of EVM transactions
146
+ *
147
+ * @param signer
148
+ * @param txs transactions to send
149
+ * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
150
+ * are re-sent at regular intervals)
151
+ * @param abortSignal abort signal to abort waiting for transaction confirmations
152
+ * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
153
+ * are executed in order)
154
+ * @param onBeforePublish a callback called before every transaction is published, NOTE: callback is not called when using browser-based wallet!
155
+ */
156
+ public async sendAndConfirm(signer: EVMSigner, txs: TransactionRequest[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
157
+ await this.prepareTransactions(signer, txs);
158
+ const signedTxs: Transaction[] = [];
159
+
160
+ //Don't separate the signing process from the sending when using browser-based wallet
161
+ if(signer.signTransaction!=null) for(let i=0;i<txs.length;i++) {
162
+ const tx = txs[i];
163
+ const signedTx = Transaction.from(await signer.signTransaction(tx));
164
+ signedTxs.push(signedTx);
165
+ this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+signedTx);
166
+
167
+ const nextAccountNonce = signedTx.nonce + 1;
168
+ const currentSignedNonce = this.latestSignedNonces[signedTx.from];
169
+ if(currentSignedNonce==null || nextAccountNonce > currentSignedNonce) {
170
+ this.latestSignedNonces[signedTx.from] = nextAccountNonce;
171
+ }
172
+ }
173
+
174
+ this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
175
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
176
+
177
+ let txIds: string[] = [];
178
+ if(parallel) {
179
+ let promises: Promise<string>[] = [];
180
+ for(let i=0;i<txs.length;i++) {
181
+ let tx: TransactionResponse | Transaction;
182
+ if(signer.signTransaction==null) {
183
+ tx = await signer.sendTransaction(txs[i], onBeforePublish);
184
+ } else {
185
+ const signedTx = signedTxs[i];
186
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
187
+ tx = signedTx;
188
+ }
189
+
190
+ const nextAccountNonce = tx.nonce + 1;
191
+ const currentPendingNonce = this.latestPendingNonces[tx.from];
192
+ if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
193
+ this.latestPendingNonces[tx.from] = nextAccountNonce;
194
+ }
195
+
196
+ if(waitForConfirmation) promises.push(this.confirmTransaction(tx, abortSignal));
197
+ txIds.push(tx.hash);
198
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+signedTxs.length+"): "+tx.hash);
199
+ if(promises.length >= MAX_UNCONFIRMED_TXNS) {
200
+ await Promise.all(promises);
201
+ promises = [];
202
+ }
203
+ }
204
+ if(promises.length>0) txIds = await Promise.all(promises);
205
+ } else {
206
+ for(let i=0;i<txs.length;i++) {
207
+ let tx: TransactionResponse | Transaction;
208
+ if(signer.signTransaction==null) {
209
+ tx = await signer.sendTransaction(txs[i], onBeforePublish);
210
+ } else {
211
+ const signedTx = signedTxs[i];
212
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
213
+ tx = signedTx;
214
+ }
215
+
216
+ const nextAccountNonce = tx.nonce + 1;
217
+ const currentPendingNonce = this.latestPendingNonces[tx.from];
218
+ if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
219
+ this.latestPendingNonces[tx.from] = nextAccountNonce;
220
+ }
221
+
222
+ const confirmPromise = this.confirmTransaction(tx, abortSignal);
223
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+tx.hash);
224
+ //Don't await the last promise when !waitForConfirmation
225
+ let txHash = tx.hash;
226
+ if(i<txs.length-1 || waitForConfirmation) txHash = await confirmPromise;
227
+ txIds.push(txHash);
228
+ }
229
+ }
230
+
231
+ this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
232
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
233
+
234
+ return txIds;
235
+ }
236
+
237
+ /**
238
+ * Serializes the signed EVM transaction
239
+ *
240
+ * @param tx
241
+ */
242
+ public serializeTx(tx: Transaction): Promise<string> {
243
+ return Promise.resolve(tx.serialized);
244
+ }
245
+
246
+ /**
247
+ * Deserializes signed EVM transaction
248
+ *
249
+ * @param txData
250
+ */
251
+ public deserializeTx(txData: string): Promise<Transaction> {
252
+ return Promise.resolve(Transaction.from(txData));
253
+ }
254
+
255
+ /**
256
+ * Gets the status of the raw starknet transaction
257
+ *
258
+ * @param tx
259
+ */
260
+ public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
261
+ const parsedTx: Transaction = await this.deserializeTx(tx);
262
+ return await this.getTxIdStatus(parsedTx.hash);
263
+ }
264
+
265
+ /**
266
+ * Gets the status of the EVM transaction with a specific txId
267
+ *
268
+ * @param txId
269
+ */
270
+ public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
271
+ const txResponse = await this.provider.getTransaction(txId);
272
+ if(txResponse==null) return this._knownTxSet.has(txId) ? "pending" : "not_found";
273
+ if(txResponse.blockHash==null) return "pending";
274
+
275
+ const [safeBlockNumber, txReceipt] = await Promise.all([
276
+ this.root.config.safeBlockTag==="latest" ? Promise.resolve(null) : this.provider.getBlock(this.root.config.safeBlockTag).then(res => res.number),
277
+ this.provider.getTransactionReceipt(txId)
278
+ ]);
279
+
280
+ if(txReceipt==null || (safeBlockNumber!=null && txReceipt.blockNumber > safeBlockNumber)) return "pending";
281
+ if(txReceipt.status===0) return "reverted";
282
+ return "success";
283
+ }
284
+
285
+ public onBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): void {
286
+ this.cbksBeforeTxSigned.push(callback);
287
+ }
288
+
289
+ public offBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): boolean {
290
+ const index = this.cbksBeforeTxSigned.indexOf(callback);
291
+ if(index===-1) return false;
292
+ this.cbksBeforeTxSigned.splice(index, 1);
293
+ return true;
294
+ }
295
+
296
+ public onSendTransaction(callback: (tx: string) => Promise<string>): void {
297
+ this.cbkSendTransaction = callback;
298
+ }
299
+
300
+ public offSendTransaction(callback: (tx: string) => Promise<string>): boolean {
301
+ this.cbkSendTransaction = null;
302
+ return true;
303
+ }
304
+
305
+ onBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): void {
306
+ this._cbksBeforeTxReplace.push(callback);
307
+ }
308
+
309
+ offBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): boolean {
310
+ const index = this._cbksBeforeTxReplace.indexOf(callback);
311
+ if(index===-1) return false;
312
+ this._cbksBeforeTxReplace.splice(index, 1);
313
+ return true;
314
+ }
315
+
316
+ public traceTransaction(txId: string): Promise<EVMTxTrace> {
317
+ return this.provider.send("debug_traceTransaction", [
318
+ txId,
319
+ {
320
+ tracer: "callTracer"
321
+ }
322
+ ]);
323
+ }
324
+
325
+ }