@atomiqlabs/chain-evm 1.0.0-dev.35 → 1.0.0-dev.37

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 (161) hide show
  1. package/LICENSE +201 -201
  2. package/dist/chains/citrea/CitreaBtcRelay.d.ts +21 -21
  3. package/dist/chains/citrea/CitreaBtcRelay.js +43 -43
  4. package/dist/chains/citrea/CitreaChainType.d.ts +13 -13
  5. package/dist/chains/citrea/CitreaChainType.js +2 -2
  6. package/dist/chains/citrea/CitreaFees.d.ts +29 -29
  7. package/dist/chains/citrea/CitreaFees.js +67 -67
  8. package/dist/chains/citrea/CitreaInitializer.d.ts +30 -30
  9. package/dist/chains/citrea/CitreaInitializer.js +127 -127
  10. package/dist/chains/citrea/CitreaSpvVaultContract.d.ts +15 -15
  11. package/dist/chains/citrea/CitreaSpvVaultContract.js +74 -74
  12. package/dist/chains/citrea/CitreaSwapContract.d.ts +22 -22
  13. package/dist/chains/citrea/CitreaSwapContract.js +96 -96
  14. package/dist/chains/citrea/CitreaTokens.d.ts +9 -9
  15. package/dist/chains/citrea/CitreaTokens.js +20 -20
  16. package/dist/evm/btcrelay/BtcRelayAbi.d.ts +198 -198
  17. package/dist/evm/btcrelay/BtcRelayAbi.js +261 -261
  18. package/dist/evm/btcrelay/BtcRelayTypechain.d.ts +172 -172
  19. package/dist/evm/btcrelay/BtcRelayTypechain.js +2 -2
  20. package/dist/evm/btcrelay/EVMBtcRelay.d.ts +195 -195
  21. package/dist/evm/btcrelay/EVMBtcRelay.js +423 -423
  22. package/dist/evm/btcrelay/headers/EVMBtcHeader.d.ts +33 -33
  23. package/dist/evm/btcrelay/headers/EVMBtcHeader.js +84 -84
  24. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.d.ts +56 -56
  25. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js +123 -123
  26. package/dist/evm/chain/EVMChainInterface.d.ts +51 -51
  27. package/dist/evm/chain/EVMChainInterface.js +89 -89
  28. package/dist/evm/chain/EVMModule.d.ts +9 -9
  29. package/dist/evm/chain/EVMModule.js +13 -13
  30. package/dist/evm/chain/modules/ERC20Abi.d.ts +168 -168
  31. package/dist/evm/chain/modules/ERC20Abi.js +225 -225
  32. package/dist/evm/chain/modules/EVMAddresses.d.ts +10 -10
  33. package/dist/evm/chain/modules/EVMAddresses.js +30 -30
  34. package/dist/evm/chain/modules/EVMBlocks.d.ts +20 -20
  35. package/dist/evm/chain/modules/EVMBlocks.js +64 -64
  36. package/dist/evm/chain/modules/EVMEvents.d.ts +36 -36
  37. package/dist/evm/chain/modules/EVMEvents.js +122 -122
  38. package/dist/evm/chain/modules/EVMFees.d.ts +36 -36
  39. package/dist/evm/chain/modules/EVMFees.js +73 -73
  40. package/dist/evm/chain/modules/EVMSignatures.d.ts +29 -29
  41. package/dist/evm/chain/modules/EVMSignatures.js +68 -68
  42. package/dist/evm/chain/modules/EVMTokens.d.ts +70 -51
  43. package/dist/evm/chain/modules/EVMTokens.js +142 -113
  44. package/dist/evm/chain/modules/EVMTransactions.d.ts +89 -89
  45. package/dist/evm/chain/modules/EVMTransactions.js +230 -216
  46. package/dist/evm/contract/EVMContractBase.d.ts +22 -22
  47. package/dist/evm/contract/EVMContractBase.js +34 -34
  48. package/dist/evm/contract/EVMContractModule.d.ts +8 -8
  49. package/dist/evm/contract/EVMContractModule.js +11 -11
  50. package/dist/evm/contract/modules/EVMContractEvents.d.ts +42 -42
  51. package/dist/evm/contract/modules/EVMContractEvents.js +75 -75
  52. package/dist/evm/events/EVMChainEvents.d.ts +22 -22
  53. package/dist/evm/events/EVMChainEvents.js +67 -67
  54. package/dist/evm/events/EVMChainEventsBrowser.d.ts +86 -86
  55. package/dist/evm/events/EVMChainEventsBrowser.js +294 -294
  56. package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts +78 -78
  57. package/dist/evm/spv_swap/EVMSpvVaultContract.js +478 -480
  58. package/dist/evm/spv_swap/EVMSpvVaultData.d.ts +39 -39
  59. package/dist/evm/spv_swap/EVMSpvVaultData.js +180 -180
  60. package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts +19 -19
  61. package/dist/evm/spv_swap/EVMSpvWithdrawalData.js +55 -55
  62. package/dist/evm/spv_swap/SpvVaultContractAbi.d.ts +91 -91
  63. package/dist/evm/spv_swap/SpvVaultContractAbi.js +849 -849
  64. package/dist/evm/spv_swap/SpvVaultContractTypechain.d.ts +450 -450
  65. package/dist/evm/spv_swap/SpvVaultContractTypechain.js +2 -2
  66. package/dist/evm/swaps/EVMSwapContract.d.ts +193 -193
  67. package/dist/evm/swaps/EVMSwapContract.js +374 -374
  68. package/dist/evm/swaps/EVMSwapData.d.ts +66 -66
  69. package/dist/evm/swaps/EVMSwapData.js +260 -260
  70. package/dist/evm/swaps/EVMSwapModule.d.ts +9 -9
  71. package/dist/evm/swaps/EVMSwapModule.js +11 -11
  72. package/dist/evm/swaps/EscrowManagerAbi.d.ts +120 -120
  73. package/dist/evm/swaps/EscrowManagerAbi.js +985 -985
  74. package/dist/evm/swaps/EscrowManagerTypechain.d.ts +475 -475
  75. package/dist/evm/swaps/EscrowManagerTypechain.js +2 -2
  76. package/dist/evm/swaps/handlers/IHandler.d.ts +13 -13
  77. package/dist/evm/swaps/handlers/IHandler.js +2 -2
  78. package/dist/evm/swaps/handlers/claim/ClaimHandlers.d.ts +10 -10
  79. package/dist/evm/swaps/handlers/claim/ClaimHandlers.js +13 -13
  80. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.d.ts +20 -20
  81. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.js +39 -39
  82. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  83. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +59 -59
  84. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  85. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +51 -51
  86. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +21 -21
  87. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +28 -28
  88. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +48 -48
  89. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +63 -63
  90. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  91. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.js +28 -28
  92. package/dist/evm/swaps/modules/EVMLpVault.d.ts +69 -69
  93. package/dist/evm/swaps/modules/EVMLpVault.js +134 -131
  94. package/dist/evm/swaps/modules/EVMSwapClaim.d.ts +54 -54
  95. package/dist/evm/swaps/modules/EVMSwapClaim.js +137 -137
  96. package/dist/evm/swaps/modules/EVMSwapInit.d.ts +88 -88
  97. package/dist/evm/swaps/modules/EVMSwapInit.js +274 -275
  98. package/dist/evm/swaps/modules/EVMSwapRefund.d.ts +62 -62
  99. package/dist/evm/swaps/modules/EVMSwapRefund.js +167 -167
  100. package/dist/evm/typechain/common.d.ts +50 -50
  101. package/dist/evm/typechain/common.js +2 -2
  102. package/dist/evm/wallet/EVMSigner.d.ts +10 -9
  103. package/dist/evm/wallet/EVMSigner.js +17 -16
  104. package/dist/index.d.ts +38 -38
  105. package/dist/index.js +54 -54
  106. package/dist/utils/Utils.d.ts +15 -15
  107. package/dist/utils/Utils.js +71 -71
  108. package/package.json +37 -37
  109. package/src/chains/citrea/CitreaBtcRelay.ts +57 -57
  110. package/src/chains/citrea/CitreaChainType.ts +28 -28
  111. package/src/chains/citrea/CitreaFees.ts +77 -77
  112. package/src/chains/citrea/CitreaInitializer.ts +178 -178
  113. package/src/chains/citrea/CitreaSpvVaultContract.ts +75 -75
  114. package/src/chains/citrea/CitreaSwapContract.ts +102 -102
  115. package/src/chains/citrea/CitreaTokens.ts +21 -21
  116. package/src/evm/btcrelay/BtcRelayAbi.ts +258 -258
  117. package/src/evm/btcrelay/BtcRelayTypechain.ts +371 -371
  118. package/src/evm/btcrelay/EVMBtcRelay.ts +522 -522
  119. package/src/evm/btcrelay/headers/EVMBtcHeader.ts +109 -109
  120. package/src/evm/btcrelay/headers/EVMBtcStoredHeader.ts +152 -152
  121. package/src/evm/chain/EVMChainInterface.ts +155 -155
  122. package/src/evm/chain/EVMModule.ts +21 -21
  123. package/src/evm/chain/modules/ERC20Abi.ts +222 -222
  124. package/src/evm/chain/modules/EVMAddresses.ts +28 -28
  125. package/src/evm/chain/modules/EVMBlocks.ts +75 -75
  126. package/src/evm/chain/modules/EVMEvents.ts +139 -139
  127. package/src/evm/chain/modules/EVMFees.ts +104 -104
  128. package/src/evm/chain/modules/EVMSignatures.ts +76 -76
  129. package/src/evm/chain/modules/EVMTokens.ts +155 -126
  130. package/src/evm/chain/modules/EVMTransactions.ts +257 -246
  131. package/src/evm/contract/EVMContractBase.ts +63 -63
  132. package/src/evm/contract/EVMContractModule.ts +16 -16
  133. package/src/evm/contract/modules/EVMContractEvents.ts +102 -102
  134. package/src/evm/events/EVMChainEvents.ts +81 -81
  135. package/src/evm/events/EVMChainEventsBrowser.ts +390 -390
  136. package/src/evm/spv_swap/EVMSpvVaultContract.ts +608 -603
  137. package/src/evm/spv_swap/EVMSpvVaultData.ts +224 -224
  138. package/src/evm/spv_swap/EVMSpvWithdrawalData.ts +70 -70
  139. package/src/evm/spv_swap/SpvVaultContractAbi.ts +846 -846
  140. package/src/evm/spv_swap/SpvVaultContractTypechain.ts +685 -685
  141. package/src/evm/swaps/EVMSwapContract.ts +592 -592
  142. package/src/evm/swaps/EVMSwapData.ts +378 -378
  143. package/src/evm/swaps/EVMSwapModule.ts +16 -16
  144. package/src/evm/swaps/EscrowManagerAbi.ts +982 -982
  145. package/src/evm/swaps/EscrowManagerTypechain.ts +723 -723
  146. package/src/evm/swaps/handlers/IHandler.ts +17 -17
  147. package/src/evm/swaps/handlers/claim/ClaimHandlers.ts +20 -20
  148. package/src/evm/swaps/handlers/claim/HashlockClaimHandler.ts +46 -46
  149. package/src/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +82 -82
  150. package/src/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +76 -76
  151. package/src/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +46 -46
  152. package/src/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +115 -115
  153. package/src/evm/swaps/handlers/refund/TimelockRefundHandler.ts +37 -37
  154. package/src/evm/swaps/modules/EVMLpVault.ts +154 -152
  155. package/src/evm/swaps/modules/EVMSwapClaim.ts +172 -172
  156. package/src/evm/swaps/modules/EVMSwapInit.ts +328 -325
  157. package/src/evm/swaps/modules/EVMSwapRefund.ts +229 -229
  158. package/src/evm/typechain/common.ts +131 -131
  159. package/src/evm/wallet/EVMSigner.ts +25 -23
  160. package/src/index.ts +45 -45
  161. package/src/utils/Utils.ts +81 -81
@@ -1,246 +1,257 @@
1
- import {EVMModule} from "../EVMModule";
2
- import {Transaction, TransactionRequest} 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
- export class EVMTransactions extends EVMModule<any> {
22
-
23
- private readonly latestConfirmedNonces: {[address: string]: number} = {};
24
-
25
- private cbkBeforeTxSigned: (tx: TransactionRequest) => Promise<void>;
26
- private cbkSendTransaction: (tx: string) => Promise<string>;
27
-
28
- /**
29
- * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
30
- * the transaction at regular interval
31
- *
32
- * @param tx EVM transaction to wait for confirmation for
33
- * @param abortSignal signal to abort waiting for tx confirmation
34
- * @private
35
- */
36
- private async confirmTransaction(tx: Transaction, abortSignal?: AbortSignal) {
37
- let state = "pending";
38
- while(state==="pending" || state==="not_found") {
39
- await timeoutPromise(3000, abortSignal);
40
- state = await this.getTxIdStatus(tx.hash);
41
- //Don't re-send transactions
42
- // if(state==="not_found") await this.sendSignedTransaction(tx).catch(e => {
43
- // if(e.baseError?.code === 59) return; //Transaction already in the mempool
44
- // this.logger.error("confirmTransaction(): Error on transaction re-send: ", e);
45
- // });
46
- }
47
- const nextAccountNonce = tx.nonce + 1;
48
- const currentNonce = this.latestConfirmedNonces[tx.from];
49
- if(currentNonce==null || nextAccountNonce > currentNonce) {
50
- this.latestConfirmedNonces[tx.from] = nextAccountNonce;
51
- }
52
- if(state==="reverted") throw new Error("Transaction reverted!");
53
- }
54
-
55
- /**
56
- * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
57
- *
58
- * @param signer
59
- * @param txs
60
- * @private
61
- */
62
- private async prepareTransactions(signer: EVMSigner, txs: TransactionRequest[]): Promise<void> {
63
- let nonce: number = (await signer.getNonce()) ?? await this.root.provider.getTransactionCount(signer.getAddress(), "pending");
64
- const latestConfirmedNonce = this.latestConfirmedNonces[signer.getAddress()];
65
- if(latestConfirmedNonce!=null && latestConfirmedNonce > nonce) {
66
- this.logger.debug("prepareTransactions(): Using nonce from local cache!");
67
- nonce = latestConfirmedNonce;
68
- }
69
-
70
- for(let i=0;i<txs.length;i++) {
71
- const tx = txs[i];
72
- tx.chainId = this.root.evmChainId;
73
- tx.from = signer.getAddress();
74
- if(tx.nonce!=null) nonce = tx.nonce; //Take the nonce from last tx
75
- if(nonce==null) nonce = await this.root.provider.getTransactionCount(signer.getAddress(), "pending"); //Fetch the nonce
76
- if(tx.nonce==null) tx.nonce = nonce;
77
-
78
- this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.nonce);
79
-
80
- nonce++;
81
-
82
- if(this.cbkBeforeTxSigned!=null) await this.cbkBeforeTxSigned(tx);
83
- }
84
- }
85
-
86
- /**
87
- * Sends out a signed transaction to the RPC
88
- *
89
- * @param tx EVM tx to send
90
- * @param onBeforePublish a callback called before every transaction is published
91
- * @private
92
- */
93
- private async sendSignedTransaction(
94
- tx: Transaction,
95
- onBeforePublish?: (txId: string, rawTx: string) => Promise<void>,
96
- ): Promise<string> {
97
- if(onBeforePublish!=null) await onBeforePublish(tx.hash, await this.serializeTx(tx));
98
- this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.hash);
99
-
100
- const serializedTx = tx.serialized;
101
-
102
- let result: string;
103
- if(this.cbkSendTransaction!=null) result = await this.cbkSendTransaction(serializedTx);
104
- if(result==null) {
105
- const broadcastResult = await this.provider.broadcastTransaction(tx.serialized);
106
- result = broadcastResult.hash;
107
- }
108
-
109
- this.logger.info("sendSignedTransaction(): tx sent, txHash: "+result);
110
- return result;
111
- }
112
-
113
- /**
114
- * Prepares, signs, sends (in parallel or sequentially) & optionally waits for confirmation
115
- * of a batch of EVM transactions
116
- *
117
- * @param signer
118
- * @param txs transactions to send
119
- * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
120
- * are re-sent at regular intervals)
121
- * @param abortSignal abort signal to abort waiting for transaction confirmations
122
- * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
123
- * are executed in order)
124
- * @param onBeforePublish a callback called before every transaction is published
125
- */
126
- public async sendAndConfirm(signer: EVMSigner, txs: TransactionRequest[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
127
- await this.prepareTransactions(signer, txs);
128
- const signedTxs: Transaction[] = [];
129
-
130
- //TODO: Maybe don't separate the signing process from the sending when using browser-based wallet,
131
- // like with Starknet
132
- for(let i=0;i<txs.length;i++) {
133
- const tx = txs[i];
134
- const signedTx = Transaction.from(await signer.account.signTransaction(tx));
135
- signedTxs.push(signedTx);
136
- this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+signedTx);
137
- }
138
-
139
- this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
140
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
141
-
142
- const txIds: string[] = [];
143
- if(parallel) {
144
- const promises: Promise<void>[] = [];
145
- for(let i=0;i<signedTxs.length;i++) {
146
- const signedTx = signedTxs[i];
147
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish);
148
- if(waitForConfirmation) promises.push(this.confirmTransaction(signedTx, abortSignal));
149
- txIds.push(txId);
150
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+signedTxs.length+"): "+signedTx.hash);
151
- }
152
- if(promises.length>0) await Promise.all(promises);
153
- } else {
154
- for(let i=0;i<signedTxs.length;i++) {
155
- const signedTx = signedTxs[i];
156
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish);
157
- const confirmPromise = this.confirmTransaction(signedTx, abortSignal);
158
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+signedTx.hash);
159
- //Don't await the last promise when !waitForConfirmation
160
- if(i<txs.length-1 || waitForConfirmation) await confirmPromise;
161
- txIds.push(txId);
162
- }
163
- }
164
-
165
- this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
166
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
167
-
168
- return txIds;
169
- }
170
-
171
- /**
172
- * Serializes the signed EVM transaction
173
- *
174
- * @param tx
175
- */
176
- public serializeTx(tx: Transaction): Promise<string> {
177
- return Promise.resolve(tx.serialized);
178
- }
179
-
180
- /**
181
- * Deserializes signed EVM transaction
182
- *
183
- * @param txData
184
- */
185
- public deserializeTx(txData: string): Promise<Transaction> {
186
- return Promise.resolve(Transaction.from(txData));
187
- }
188
-
189
- /**
190
- * Gets the status of the raw starknet transaction
191
- *
192
- * @param tx
193
- */
194
- public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
195
- const parsedTx: Transaction = await this.deserializeTx(tx);
196
- return await this.getTxIdStatus(parsedTx.hash);
197
- }
198
-
199
- /**
200
- * Gets the status of the starknet transaction with a specific txId
201
- *
202
- * @param txId
203
- */
204
- public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
205
- const txResponse = await this.provider.getTransaction(txId);
206
- if(txResponse==null) return "not_found";
207
- if(txResponse.blockHash==null) return "pending";
208
-
209
- const [safeBlockNumber, txReceipt] = await Promise.all([
210
- this.root.config.safeBlockTag==="latest" ? Promise.resolve(null) : this.provider.getBlock(this.root.config.safeBlockTag).then(res => res.number),
211
- this.provider.getTransactionReceipt(txId)
212
- ]);
213
-
214
- if(txReceipt==null || (safeBlockNumber!=null && txReceipt.blockNumber < safeBlockNumber)) return "pending";
215
- if(txReceipt.status===0) return "reverted";
216
- return "success";
217
- }
218
-
219
- public onBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): void {
220
- this.cbkBeforeTxSigned = callback;
221
- }
222
-
223
- public offBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): boolean {
224
- this.cbkBeforeTxSigned = null;
225
- return true;
226
- }
227
-
228
- public onSendTransaction(callback: (tx: string) => Promise<string>): void {
229
- this.cbkSendTransaction = callback;
230
- }
231
-
232
- public offSendTransaction(callback: (tx: string) => Promise<string>): boolean {
233
- this.cbkSendTransaction = null;
234
- return true;
235
- }
236
-
237
- public traceTransaction(txId: string): Promise<EVMTxTrace> {
238
- return this.provider.send("debug_traceTransaction", [
239
- txId,
240
- {
241
- tracer: "callTracer"
242
- }
243
- ]);
244
- }
245
-
246
- }
1
+ import {EVMModule} from "../EVMModule";
2
+ import {Transaction, TransactionRequest} 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
+ export class EVMTransactions extends EVMModule<any> {
22
+
23
+ private readonly latestConfirmedNonces: {[address: string]: number} = {};
24
+
25
+ private cbkBeforeTxSigned: (tx: TransactionRequest) => Promise<void>;
26
+ private cbkSendTransaction: (tx: string) => Promise<string>;
27
+
28
+ /**
29
+ * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
30
+ * the transaction at regular interval
31
+ *
32
+ * @param tx EVM transaction to wait for confirmation for
33
+ * @param abortSignal signal to abort waiting for tx confirmation
34
+ * @private
35
+ */
36
+ private async confirmTransaction(tx: {nonce: number, from: string, hash: string}, abortSignal?: AbortSignal) {
37
+ let state = "pending";
38
+ while(state==="pending" || state==="not_found") {
39
+ await timeoutPromise(3000, abortSignal);
40
+ state = await this.getTxIdStatus(tx.hash);
41
+ //Don't re-send transactions
42
+ // if(state==="not_found") await this.sendSignedTransaction(tx).catch(e => {
43
+ // if(e.baseError?.code === 59) return; //Transaction already in the mempool
44
+ // this.logger.error("confirmTransaction(): Error on transaction re-send: ", e);
45
+ // });
46
+ }
47
+ const nextAccountNonce = tx.nonce + 1;
48
+ const currentNonce = this.latestConfirmedNonces[tx.from];
49
+ if(currentNonce==null || nextAccountNonce > currentNonce) {
50
+ this.latestConfirmedNonces[tx.from] = nextAccountNonce;
51
+ }
52
+ if(state==="reverted") throw new Error("Transaction reverted!");
53
+ }
54
+
55
+ /**
56
+ * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
57
+ *
58
+ * @param signer
59
+ * @param txs
60
+ * @private
61
+ */
62
+ private async prepareTransactions(signer: EVMSigner, txs: TransactionRequest[]): Promise<void> {
63
+ let nonce: number = (await signer.getNonce()) ?? await this.root.provider.getTransactionCount(signer.getAddress(), "pending");
64
+ const latestConfirmedNonce = this.latestConfirmedNonces[signer.getAddress()];
65
+ if(latestConfirmedNonce!=null && latestConfirmedNonce > nonce) {
66
+ this.logger.debug("prepareTransactions(): Using nonce from local cache!");
67
+ nonce = latestConfirmedNonce;
68
+ }
69
+
70
+ for(let i=0;i<txs.length;i++) {
71
+ const tx = txs[i];
72
+ tx.chainId = this.root.evmChainId;
73
+ tx.from = signer.getAddress();
74
+ if(tx.nonce!=null) nonce = tx.nonce; //Take the nonce from last tx
75
+ if(nonce==null) nonce = await this.root.provider.getTransactionCount(signer.getAddress(), "pending"); //Fetch the nonce
76
+ if(tx.nonce==null) tx.nonce = nonce;
77
+
78
+ this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.nonce);
79
+
80
+ nonce++;
81
+
82
+ if(this.cbkBeforeTxSigned!=null) await this.cbkBeforeTxSigned(tx);
83
+ }
84
+ }
85
+
86
+ /**
87
+ * Sends out a signed transaction to the RPC
88
+ *
89
+ * @param tx EVM tx to send
90
+ * @param onBeforePublish a callback called before every transaction is published
91
+ * @private
92
+ */
93
+ private async sendSignedTransaction(
94
+ tx: Transaction,
95
+ onBeforePublish?: (txId: string, rawTx: string) => Promise<void>,
96
+ ): Promise<string> {
97
+ if(onBeforePublish!=null) await onBeforePublish(tx.hash, await this.serializeTx(tx));
98
+ this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.hash);
99
+
100
+ const serializedTx = tx.serialized;
101
+
102
+ let result: string;
103
+ if(this.cbkSendTransaction!=null) result = await this.cbkSendTransaction(serializedTx);
104
+ if(result==null) {
105
+ const broadcastResult = await this.provider.broadcastTransaction(tx.serialized);
106
+ result = broadcastResult.hash;
107
+ }
108
+
109
+ this.logger.info("sendSignedTransaction(): tx sent, txHash: "+result);
110
+ return result;
111
+ }
112
+
113
+ /**
114
+ * Prepares, signs, sends (in parallel or sequentially) & optionally waits for confirmation
115
+ * of a batch of EVM transactions
116
+ *
117
+ * @param signer
118
+ * @param txs transactions to send
119
+ * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
120
+ * are re-sent at regular intervals)
121
+ * @param abortSignal abort signal to abort waiting for transaction confirmations
122
+ * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
123
+ * are executed in order)
124
+ * @param onBeforePublish a callback called before every transaction is published, NOTE: callback is not called when using browser-based wallet!
125
+ */
126
+ public async sendAndConfirm(signer: EVMSigner, txs: TransactionRequest[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
127
+ await this.prepareTransactions(signer, txs);
128
+ const signedTxs: Transaction[] = [];
129
+
130
+ //Don't separate the signing process from the sending when using browser-based wallet
131
+ if(!signer.isBrowserWallet) for(let i=0;i<txs.length;i++) {
132
+ const tx = txs[i];
133
+ const signedTx = Transaction.from(await signer.account.signTransaction(tx));
134
+ signedTxs.push(signedTx);
135
+ this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+signedTx);
136
+ }
137
+
138
+ this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
139
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
140
+
141
+ const txIds: string[] = [];
142
+ if(parallel) {
143
+ const promises: Promise<void>[] = [];
144
+ for(let i=0;i<signedTxs.length;i++) {
145
+ let tx: {nonce: number, from: string, hash: string};
146
+ if(signer.isBrowserWallet) {
147
+ tx = await signer.account.sendTransaction(txs[i]);
148
+ } else {
149
+ const signedTx = signedTxs[i];
150
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
151
+ tx = signedTx;
152
+ }
153
+ if(waitForConfirmation) promises.push(this.confirmTransaction(tx, abortSignal));
154
+ txIds.push(tx.hash);
155
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+signedTxs.length+"): "+tx.hash);
156
+ }
157
+ if(promises.length>0) await Promise.all(promises);
158
+ } else {
159
+ for(let i=0;i<signedTxs.length;i++) {
160
+ let tx: {nonce: number, from: string, hash: string};
161
+ if(signer.isBrowserWallet) {
162
+ tx = await signer.account.sendTransaction(txs[i]);
163
+ } else {
164
+ const signedTx = signedTxs[i];
165
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
166
+ tx = signedTx;
167
+ }
168
+ const confirmPromise = this.confirmTransaction(tx, abortSignal);
169
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+tx.hash);
170
+ //Don't await the last promise when !waitForConfirmation
171
+ if(i<txs.length-1 || waitForConfirmation) await confirmPromise;
172
+ txIds.push(tx.hash);
173
+ }
174
+ }
175
+
176
+ this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
177
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
178
+
179
+ return txIds;
180
+ }
181
+
182
+ /**
183
+ * Serializes the signed EVM transaction
184
+ *
185
+ * @param tx
186
+ */
187
+ public serializeTx(tx: Transaction): Promise<string> {
188
+ return Promise.resolve(tx.serialized);
189
+ }
190
+
191
+ /**
192
+ * Deserializes signed EVM transaction
193
+ *
194
+ * @param txData
195
+ */
196
+ public deserializeTx(txData: string): Promise<Transaction> {
197
+ return Promise.resolve(Transaction.from(txData));
198
+ }
199
+
200
+ /**
201
+ * Gets the status of the raw starknet transaction
202
+ *
203
+ * @param tx
204
+ */
205
+ public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
206
+ const parsedTx: Transaction = await this.deserializeTx(tx);
207
+ return await this.getTxIdStatus(parsedTx.hash);
208
+ }
209
+
210
+ /**
211
+ * Gets the status of the starknet transaction with a specific txId
212
+ *
213
+ * @param txId
214
+ */
215
+ public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
216
+ const txResponse = await this.provider.getTransaction(txId);
217
+ if(txResponse==null) return "not_found";
218
+ if(txResponse.blockHash==null) return "pending";
219
+
220
+ const [safeBlockNumber, txReceipt] = await Promise.all([
221
+ this.root.config.safeBlockTag==="latest" ? Promise.resolve(null) : this.provider.getBlock(this.root.config.safeBlockTag).then(res => res.number),
222
+ this.provider.getTransactionReceipt(txId)
223
+ ]);
224
+
225
+ if(txReceipt==null || (safeBlockNumber!=null && txReceipt.blockNumber < safeBlockNumber)) return "pending";
226
+ if(txReceipt.status===0) return "reverted";
227
+ return "success";
228
+ }
229
+
230
+ public onBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): void {
231
+ this.cbkBeforeTxSigned = callback;
232
+ }
233
+
234
+ public offBeforeTxSigned(callback: (tx: TransactionRequest) => Promise<void>): boolean {
235
+ this.cbkBeforeTxSigned = null;
236
+ return true;
237
+ }
238
+
239
+ public onSendTransaction(callback: (tx: string) => Promise<string>): void {
240
+ this.cbkSendTransaction = callback;
241
+ }
242
+
243
+ public offSendTransaction(callback: (tx: string) => Promise<string>): boolean {
244
+ this.cbkSendTransaction = null;
245
+ return true;
246
+ }
247
+
248
+ public traceTransaction(txId: string): Promise<EVMTxTrace> {
249
+ return this.provider.send("debug_traceTransaction", [
250
+ txId,
251
+ {
252
+ tracer: "callTracer"
253
+ }
254
+ ]);
255
+ }
256
+
257
+ }
@@ -1,63 +1,63 @@
1
- import {BaseContract, Contract, EventFragment, Log, TransactionDescription, EventLog} from "ethers";
2
- import {EVMChainInterface} from "../chain/EVMChainInterface";
3
- import {EVMContractEvents} from "./modules/EVMContractEvents";
4
- import {TypedContractMethod, TypedEventLog} from "../typechain/common";
5
-
6
- type __TypechainOutputObject<T> = T extends TypedContractMethod<
7
- infer V
8
- >
9
- ? V
10
- : never;
11
-
12
- type KeysOfType<T, ValueType> = keyof {
13
- [K in keyof T]: T[K] extends ValueType ? K : never;
14
- };
15
-
16
- export interface TypedFunctionCall<TCMethod extends TypedContractMethod>
17
- extends Omit<TransactionDescription, "args"> {
18
- args: __TypechainOutputObject<TCMethod>;
19
- }
20
-
21
- /**
22
- * Base class providing program specific utilities
23
- */
24
- export class EVMContractBase<T extends BaseContract> {
25
-
26
- contract: T;
27
-
28
- public readonly Events: EVMContractEvents<T>;
29
- public readonly Chain: EVMChainInterface<any>;
30
-
31
- public readonly contractAddress: string;
32
- public readonly contractDeploymentHeight: number;
33
-
34
- constructor(
35
- chainInterface: EVMChainInterface<any>,
36
- contractAddress: string,
37
- contractAbi: any,
38
- contractDeploymentHeight?: number,
39
- ) {
40
- this.Chain = chainInterface;
41
- this.contract = new Contract(contractAddress, contractAbi, chainInterface.provider) as unknown as T;
42
- this.Events = new EVMContractEvents<T>(chainInterface, this);
43
- this.contractAddress = contractAddress;
44
- this.contractDeploymentHeight = contractDeploymentHeight;
45
- }
46
-
47
- toTypedEvent<TEventName extends keyof T["filters"] = keyof T["filters"]>(log: Log): TypedEventLog<T["filters"][TEventName]> {
48
- let foundFragment: EventFragment;
49
- try {
50
- foundFragment = this.contract.interface.getEvent(log.topics[0]);
51
- } catch (error) { }
52
- if(!foundFragment) return null;
53
-
54
- try {
55
- return new EventLog(log, this.contract.interface, foundFragment) as unknown as TypedEventLog<T["filters"][TEventName]>;
56
- } catch (error: any) { }
57
- }
58
-
59
- parseCalldata<TMethod extends TypedContractMethod>(calldata: string): TypedFunctionCall<TMethod> {
60
- return this.contract.interface.parseTransaction({data: calldata}) as unknown as TypedFunctionCall<TMethod>;
61
- }
62
-
63
- }
1
+ import {BaseContract, Contract, EventFragment, Log, TransactionDescription, EventLog} from "ethers";
2
+ import {EVMChainInterface} from "../chain/EVMChainInterface";
3
+ import {EVMContractEvents} from "./modules/EVMContractEvents";
4
+ import {TypedContractMethod, TypedEventLog} from "../typechain/common";
5
+
6
+ type __TypechainOutputObject<T> = T extends TypedContractMethod<
7
+ infer V
8
+ >
9
+ ? V
10
+ : never;
11
+
12
+ type KeysOfType<T, ValueType> = keyof {
13
+ [K in keyof T]: T[K] extends ValueType ? K : never;
14
+ };
15
+
16
+ export interface TypedFunctionCall<TCMethod extends TypedContractMethod>
17
+ extends Omit<TransactionDescription, "args"> {
18
+ args: __TypechainOutputObject<TCMethod>;
19
+ }
20
+
21
+ /**
22
+ * Base class providing program specific utilities
23
+ */
24
+ export class EVMContractBase<T extends BaseContract> {
25
+
26
+ contract: T;
27
+
28
+ public readonly Events: EVMContractEvents<T>;
29
+ public readonly Chain: EVMChainInterface<any>;
30
+
31
+ public readonly contractAddress: string;
32
+ public readonly contractDeploymentHeight: number;
33
+
34
+ constructor(
35
+ chainInterface: EVMChainInterface<any>,
36
+ contractAddress: string,
37
+ contractAbi: any,
38
+ contractDeploymentHeight?: number,
39
+ ) {
40
+ this.Chain = chainInterface;
41
+ this.contract = new Contract(contractAddress, contractAbi, chainInterface.provider) as unknown as T;
42
+ this.Events = new EVMContractEvents<T>(chainInterface, this);
43
+ this.contractAddress = contractAddress;
44
+ this.contractDeploymentHeight = contractDeploymentHeight;
45
+ }
46
+
47
+ toTypedEvent<TEventName extends keyof T["filters"] = keyof T["filters"]>(log: Log): TypedEventLog<T["filters"][TEventName]> {
48
+ let foundFragment: EventFragment;
49
+ try {
50
+ foundFragment = this.contract.interface.getEvent(log.topics[0]);
51
+ } catch (error) { }
52
+ if(!foundFragment) return null;
53
+
54
+ try {
55
+ return new EventLog(log, this.contract.interface, foundFragment) as unknown as TypedEventLog<T["filters"][TEventName]>;
56
+ } catch (error: any) { }
57
+ }
58
+
59
+ parseCalldata<TMethod extends TypedContractMethod>(calldata: string): TypedFunctionCall<TMethod> {
60
+ return this.contract.interface.parseTransaction({data: calldata}) as unknown as TypedFunctionCall<TMethod>;
61
+ }
62
+
63
+ }