@atomiqlabs/chain-starknet 4.0.0-dev.20 → 4.0.0-dev.23

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 (154) hide show
  1. package/LICENSE +201 -201
  2. package/dist/index.d.ts +39 -38
  3. package/dist/index.js +55 -54
  4. package/dist/starknet/StarknetChainType.d.ts +13 -13
  5. package/dist/starknet/StarknetChainType.js +2 -2
  6. package/dist/starknet/StarknetInitializer.d.ts +28 -27
  7. package/dist/starknet/StarknetInitializer.js +69 -69
  8. package/dist/starknet/btcrelay/BtcRelayAbi.d.ts +250 -250
  9. package/dist/starknet/btcrelay/BtcRelayAbi.js +341 -341
  10. package/dist/starknet/btcrelay/StarknetBtcRelay.d.ts +186 -186
  11. package/dist/starknet/btcrelay/StarknetBtcRelay.js +379 -379
  12. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.d.ts +31 -31
  13. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.js +74 -74
  14. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.d.ts +51 -51
  15. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.js +113 -113
  16. package/dist/starknet/chain/StarknetAction.d.ts +19 -19
  17. package/dist/starknet/chain/StarknetAction.js +73 -73
  18. package/dist/starknet/chain/StarknetChainInterface.d.ts +54 -52
  19. package/dist/starknet/chain/StarknetChainInterface.js +97 -91
  20. package/dist/starknet/chain/StarknetModule.d.ts +9 -14
  21. package/dist/starknet/chain/StarknetModule.js +13 -13
  22. package/dist/starknet/chain/modules/ERC20Abi.d.ts +755 -755
  23. package/dist/starknet/chain/modules/ERC20Abi.js +1032 -1032
  24. package/dist/starknet/chain/modules/StarknetAccounts.d.ts +6 -6
  25. package/dist/starknet/chain/modules/StarknetAccounts.js +24 -24
  26. package/dist/starknet/chain/modules/StarknetAddresses.d.ts +9 -9
  27. package/dist/starknet/chain/modules/StarknetAddresses.js +26 -26
  28. package/dist/starknet/chain/modules/StarknetBlocks.d.ts +20 -20
  29. package/dist/starknet/chain/modules/StarknetBlocks.js +64 -64
  30. package/dist/starknet/chain/modules/StarknetEvents.d.ts +44 -44
  31. package/dist/starknet/chain/modules/StarknetEvents.js +88 -88
  32. package/dist/starknet/chain/modules/StarknetFees.d.ts +82 -77
  33. package/dist/starknet/chain/modules/StarknetFees.js +121 -114
  34. package/dist/starknet/chain/modules/StarknetSignatures.d.ts +29 -29
  35. package/dist/starknet/chain/modules/StarknetSignatures.js +72 -72
  36. package/dist/starknet/chain/modules/StarknetTokens.d.ts +69 -69
  37. package/dist/starknet/chain/modules/StarknetTokens.js +102 -102
  38. package/dist/starknet/chain/modules/StarknetTransactions.d.ts +110 -93
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +351 -261
  40. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -13
  41. package/dist/starknet/contract/StarknetContractBase.js +20 -20
  42. package/dist/starknet/contract/StarknetContractModule.d.ts +8 -8
  43. package/dist/starknet/contract/StarknetContractModule.js +11 -11
  44. package/dist/starknet/contract/modules/StarknetContractEvents.d.ts +51 -51
  45. package/dist/starknet/contract/modules/StarknetContractEvents.js +97 -97
  46. package/dist/starknet/events/StarknetChainEvents.d.ts +21 -21
  47. package/dist/starknet/events/StarknetChainEvents.js +52 -52
  48. package/dist/starknet/events/StarknetChainEventsBrowser.d.ts +84 -89
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +307 -307
  50. package/dist/starknet/provider/RpcProviderWithRetries.d.ts +41 -41
  51. package/dist/starknet/provider/RpcProviderWithRetries.js +70 -70
  52. package/dist/starknet/spv_swap/SpvVaultContractAbi.d.ts +488 -488
  53. package/dist/starknet/spv_swap/SpvVaultContractAbi.js +656 -656
  54. package/dist/starknet/spv_swap/StarknetSpvVaultContract.d.ts +89 -66
  55. package/dist/starknet/spv_swap/StarknetSpvVaultContract.js +477 -382
  56. package/dist/starknet/spv_swap/StarknetSpvVaultData.d.ts +49 -49
  57. package/dist/starknet/spv_swap/StarknetSpvVaultData.js +145 -145
  58. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.d.ts +25 -25
  59. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.js +72 -72
  60. package/dist/starknet/swaps/EscrowManagerAbi.d.ts +431 -431
  61. package/dist/starknet/swaps/EscrowManagerAbi.js +583 -583
  62. package/dist/starknet/swaps/StarknetSwapContract.d.ts +197 -191
  63. package/dist/starknet/swaps/StarknetSwapContract.js +440 -424
  64. package/dist/starknet/swaps/StarknetSwapData.d.ts +74 -74
  65. package/dist/starknet/swaps/StarknetSwapData.js +325 -325
  66. package/dist/starknet/swaps/StarknetSwapModule.d.ts +10 -10
  67. package/dist/starknet/swaps/StarknetSwapModule.js +11 -11
  68. package/dist/starknet/swaps/handlers/IHandler.d.ts +13 -13
  69. package/dist/starknet/swaps/handlers/IHandler.js +2 -2
  70. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.d.ts +13 -13
  71. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.js +13 -13
  72. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.d.ts +21 -21
  73. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.js +44 -44
  74. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  75. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +48 -48
  76. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  77. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +40 -40
  78. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +20 -20
  79. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +30 -30
  80. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +45 -45
  81. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +52 -52
  82. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  83. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.js +27 -27
  84. package/dist/starknet/swaps/modules/StarknetLpVault.d.ts +69 -69
  85. package/dist/starknet/swaps/modules/StarknetLpVault.js +122 -122
  86. package/dist/starknet/swaps/modules/StarknetSwapClaim.d.ts +53 -53
  87. package/dist/starknet/swaps/modules/StarknetSwapClaim.js +100 -100
  88. package/dist/starknet/swaps/modules/StarknetSwapInit.d.ts +94 -94
  89. package/dist/starknet/swaps/modules/StarknetSwapInit.js +235 -235
  90. package/dist/starknet/swaps/modules/StarknetSwapRefund.d.ts +62 -62
  91. package/dist/starknet/swaps/modules/StarknetSwapRefund.js +128 -128
  92. package/dist/starknet/wallet/StarknetBrowserSigner.d.ts +5 -0
  93. package/dist/starknet/wallet/StarknetBrowserSigner.js +11 -0
  94. package/dist/starknet/wallet/StarknetKeypairWallet.d.ts +7 -7
  95. package/dist/starknet/wallet/StarknetKeypairWallet.js +35 -35
  96. package/dist/starknet/wallet/StarknetPersistentSigner.d.ts +33 -0
  97. package/dist/starknet/wallet/StarknetPersistentSigner.js +243 -0
  98. package/dist/starknet/wallet/StarknetSigner.d.ts +18 -12
  99. package/dist/starknet/wallet/StarknetSigner.js +69 -47
  100. package/dist/starknet/wallet/accounts/StarknetKeypairWallet.d.ts +7 -0
  101. package/dist/starknet/wallet/accounts/StarknetKeypairWallet.js +35 -0
  102. package/dist/utils/Utils.d.ts +39 -37
  103. package/dist/utils/Utils.js +264 -260
  104. package/package.json +45 -43
  105. package/src/index.ts +48 -47
  106. package/src/starknet/StarknetChainType.ts +28 -28
  107. package/src/starknet/StarknetInitializer.ts +110 -108
  108. package/src/starknet/btcrelay/BtcRelayAbi.ts +338 -338
  109. package/src/starknet/btcrelay/StarknetBtcRelay.ts +494 -494
  110. package/src/starknet/btcrelay/headers/StarknetBtcHeader.ts +100 -100
  111. package/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts +141 -141
  112. package/src/starknet/chain/StarknetAction.ts +85 -85
  113. package/src/starknet/chain/StarknetChainInterface.ts +165 -149
  114. package/src/starknet/chain/StarknetModule.ts +19 -19
  115. package/src/starknet/chain/modules/ERC20Abi.ts +1029 -1029
  116. package/src/starknet/chain/modules/StarknetAccounts.ts +25 -25
  117. package/src/starknet/chain/modules/StarknetAddresses.ts +22 -22
  118. package/src/starknet/chain/modules/StarknetBlocks.ts +75 -75
  119. package/src/starknet/chain/modules/StarknetEvents.ts +104 -104
  120. package/src/starknet/chain/modules/StarknetFees.ts +162 -154
  121. package/src/starknet/chain/modules/StarknetSignatures.ts +91 -91
  122. package/src/starknet/chain/modules/StarknetTokens.ts +120 -120
  123. package/src/starknet/chain/modules/StarknetTransactions.ts +392 -285
  124. package/src/starknet/contract/StarknetContractBase.ts +30 -30
  125. package/src/starknet/contract/StarknetContractModule.ts +16 -16
  126. package/src/starknet/contract/modules/StarknetContractEvents.ts +134 -134
  127. package/src/starknet/events/StarknetChainEvents.ts +67 -67
  128. package/src/starknet/events/StarknetChainEventsBrowser.ts +420 -420
  129. package/src/starknet/provider/RpcProviderWithRetries.ts +83 -83
  130. package/src/starknet/spv_swap/SpvVaultContractAbi.ts +656 -656
  131. package/src/starknet/spv_swap/StarknetSpvVaultContract.ts +591 -483
  132. package/src/starknet/spv_swap/StarknetSpvVaultData.ts +195 -195
  133. package/src/starknet/spv_swap/StarknetSpvWithdrawalData.ts +79 -79
  134. package/src/starknet/swaps/EscrowManagerAbi.ts +582 -582
  135. package/src/starknet/swaps/StarknetSwapContract.ts +668 -647
  136. package/src/starknet/swaps/StarknetSwapData.ts +455 -455
  137. package/src/starknet/swaps/StarknetSwapModule.ts +17 -17
  138. package/src/starknet/swaps/handlers/IHandler.ts +20 -20
  139. package/src/starknet/swaps/handlers/claim/ClaimHandlers.ts +23 -23
  140. package/src/starknet/swaps/handlers/claim/HashlockClaimHandler.ts +53 -53
  141. package/src/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +73 -73
  142. package/src/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +67 -67
  143. package/src/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +50 -50
  144. package/src/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +102 -102
  145. package/src/starknet/swaps/handlers/refund/TimelockRefundHandler.ts +38 -38
  146. package/src/starknet/swaps/modules/StarknetLpVault.ts +147 -147
  147. package/src/starknet/swaps/modules/StarknetSwapClaim.ts +141 -141
  148. package/src/starknet/swaps/modules/StarknetSwapInit.ts +300 -300
  149. package/src/starknet/swaps/modules/StarknetSwapRefund.ts +196 -196
  150. package/src/starknet/wallet/StarknetBrowserSigner.ts +12 -0
  151. package/src/starknet/wallet/StarknetPersistentSigner.ts +311 -0
  152. package/src/starknet/wallet/StarknetSigner.ts +84 -55
  153. package/src/starknet/wallet/{StarknetKeypairWallet.ts → accounts/StarknetKeypairWallet.ts} +44 -44
  154. package/src/utils/Utils.ts +262 -251
@@ -1,261 +1,351 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.StarknetTransactions = void 0;
4
- const StarknetModule_1 = require("../StarknetModule");
5
- const starknet_1 = require("starknet");
6
- const Utils_1 = require("../../../utils/Utils");
7
- const MAX_UNCONFIRMED_TXS = 25;
8
- class StarknetTransactions extends StarknetModule_1.StarknetModule {
9
- constructor() {
10
- super(...arguments);
11
- this.latestConfirmedNonces = {};
12
- }
13
- /**
14
- * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
15
- * the transaction at regular interval
16
- *
17
- * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
18
- * @param abortSignal signal to abort waiting for tx confirmation
19
- * @private
20
- */
21
- async confirmTransaction(tx, abortSignal) {
22
- let state = "pending";
23
- while (state === "pending" || state === "not_found") {
24
- await (0, Utils_1.timeoutPromise)(3000, abortSignal);
25
- state = await this._getTxIdStatus(tx.txId);
26
- if (state === "not_found" && tx.signed != null)
27
- await this.sendSignedTransaction(tx).catch(e => {
28
- if (e.baseError?.code === 59)
29
- return; //Transaction already in the mempool
30
- this.logger.error("confirmTransaction(): Error on transaction re-send: ", e);
31
- });
32
- }
33
- if (state === "rejected")
34
- throw new Error("Transaction rejected!");
35
- const nextAccountNonce = (0, Utils_1.toBigInt)(tx.details.nonce) + 1n;
36
- const currentNonce = this.latestConfirmedNonces[tx.details.walletAddress];
37
- if (currentNonce == null || nextAccountNonce > currentNonce) {
38
- this.latestConfirmedNonces[tx.details.walletAddress] = nextAccountNonce;
39
- }
40
- if (state === "reverted")
41
- throw new Error("Transaction reverted!");
42
- }
43
- /**
44
- * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
45
- *
46
- * @param signer
47
- * @param txs
48
- * @private
49
- */
50
- async prepareTransactions(signer, txs) {
51
- let nonce = await signer.getNonce();
52
- const latestConfirmedNonce = this.latestConfirmedNonces[signer.getAddress()];
53
- if (latestConfirmedNonce != null && latestConfirmedNonce > nonce) {
54
- this.logger.debug("prepareTransactions(): Using nonce from local cache!");
55
- nonce = latestConfirmedNonce;
56
- }
57
- if (nonce === BigInt(0) && signer.isWalletAccount()) {
58
- //Just increment the nonce by one and hope the wallet is smart enough to deploy account first
59
- nonce = BigInt(1);
60
- }
61
- const deployPayload = await signer.checkAndGetDeployPayload(nonce);
62
- if (deployPayload != null) {
63
- txs.unshift(await this.root.Accounts.getAccountDeployTransaction(deployPayload));
64
- }
65
- for (let i = 0; i < txs.length; i++) {
66
- const tx = txs[i];
67
- if (tx.details.nonce != null)
68
- nonce = BigInt(tx.details.nonce); //Take the nonce from last tx
69
- if (nonce == null)
70
- nonce = BigInt(await this.root.provider.getNonceForAddress(signer.getAddress())); //Fetch the nonce
71
- if (tx.details.nonce == null)
72
- tx.details.nonce = nonce;
73
- this.logger.debug("sendAndConfirm(): transaction prepared (" + (i + 1) + "/" + txs.length + "), nonce: " + tx.details.nonce);
74
- nonce += BigInt(1);
75
- if (this.cbkBeforeTxSigned != null)
76
- await this.cbkBeforeTxSigned(tx);
77
- }
78
- }
79
- /**
80
- * Sends out a signed transaction to the RPC
81
- *
82
- * @param tx Starknet tx to send
83
- * @param onBeforePublish a callback called before every transaction is published
84
- * @param signer
85
- * @private
86
- */
87
- async sendSignedTransaction(tx, onBeforePublish, signer) {
88
- if (onBeforePublish != null)
89
- await onBeforePublish(tx.txId, await this.serializeTx(tx));
90
- this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.txId);
91
- if (tx.signed == null) {
92
- let txHash;
93
- switch (tx.type) {
94
- case "INVOKE":
95
- txHash = (await signer.account.execute(tx.tx, tx.details)).transaction_hash;
96
- break;
97
- case "DEPLOY_ACCOUNT":
98
- txHash = (await signer.account.deployAccount(tx.tx, tx.details)).transaction_hash;
99
- break;
100
- default:
101
- throw new Error("Unsupported tx type!");
102
- }
103
- tx.txId = txHash;
104
- return txHash;
105
- }
106
- let txResult;
107
- switch (tx.type) {
108
- case "INVOKE":
109
- txResult = await this.provider.channel.invoke(tx.signed, tx.details).then(res => res.transaction_hash);
110
- break;
111
- case "DEPLOY_ACCOUNT":
112
- txResult = await this.provider.channel.deployAccount(tx.signed, tx.details).then((res) => res.transaction_hash);
113
- break;
114
- default:
115
- throw new Error("Unsupported tx type!");
116
- }
117
- if (tx.txId !== txResult)
118
- this.logger.warn("sendSignedTransaction(): sent tx hash not matching the precomputed hash!");
119
- this.logger.info("sendSignedTransaction(): tx sent, expected txHash: " + tx.txId + ", txHash: " + txResult);
120
- return txResult;
121
- }
122
- /**
123
- * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
124
- * of a batch of starknet transactions
125
- *
126
- * @param signer
127
- * @param txs transactions to send
128
- * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
129
- * are re-sent at regular intervals)
130
- * @param abortSignal abort signal to abort waiting for transaction confirmations
131
- * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
132
- * are executed in order)
133
- * @param onBeforePublish a callback called before every transaction is published
134
- */
135
- async sendAndConfirm(signer, txs, waitForConfirmation, abortSignal, parallel, onBeforePublish) {
136
- await this.prepareTransactions(signer, txs);
137
- if (!signer.isWalletAccount()) {
138
- for (let i = 0; i < txs.length; i++) {
139
- const tx = txs[i];
140
- switch (tx.type) {
141
- case "INVOKE":
142
- tx.signed = await signer.account.buildInvocation(tx.tx, tx.details);
143
- (0, Utils_1.calculateHash)(tx);
144
- break;
145
- case "DEPLOY_ACCOUNT":
146
- tx.signed = await signer.account.buildAccountDeployPayload(tx.tx, tx.details);
147
- (0, Utils_1.calculateHash)(tx);
148
- break;
149
- default:
150
- throw new Error("Unsupported tx type!");
151
- }
152
- this.logger.debug("sendAndConfirm(): transaction signed (" + (i + 1) + "/" + txs.length + "): " + tx.txId);
153
- }
154
- }
155
- this.logger.debug("sendAndConfirm(): sending transactions, count: " + txs.length +
156
- " waitForConfirmation: " + waitForConfirmation + " parallel: " + parallel);
157
- const txIds = [];
158
- if (parallel) {
159
- let promises = [];
160
- for (let i = 0; i < txs.length; i++) {
161
- const signedTx = txs[i];
162
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish, signer);
163
- if (waitForConfirmation)
164
- promises.push(this.confirmTransaction(signedTx, abortSignal));
165
- txIds.push(txId);
166
- this.logger.debug("sendAndConfirm(): transaction sent (" + (i + 1) + "/" + txs.length + "): " + signedTx.txId);
167
- if (promises.length >= MAX_UNCONFIRMED_TXS) {
168
- await Promise.all(promises);
169
- promises = [];
170
- }
171
- }
172
- if (promises.length > 0)
173
- await Promise.all(promises);
174
- }
175
- else {
176
- for (let i = 0; i < txs.length; i++) {
177
- const signedTx = txs[i];
178
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish, signer);
179
- const confirmPromise = this.confirmTransaction(signedTx, abortSignal);
180
- this.logger.debug("sendAndConfirm(): transaction sent (" + (i + 1) + "/" + txs.length + "): " + signedTx.txId);
181
- //Don't await the last promise when !waitForConfirmation
182
- if (i < txs.length - 1 || waitForConfirmation)
183
- await confirmPromise;
184
- txIds.push(txId);
185
- }
186
- }
187
- this.logger.info("sendAndConfirm(): sent transactions, count: " + txs.length +
188
- " waitForConfirmation: " + waitForConfirmation + " parallel: " + parallel);
189
- return txIds;
190
- }
191
- /**
192
- * Serializes the solana transaction, saves the transaction, signers & last valid blockheight
193
- *
194
- * @param tx
195
- */
196
- serializeTx(tx) {
197
- return Promise.resolve(JSON.stringify(tx, (key, value) => {
198
- if (typeof (value) === "bigint")
199
- return (0, Utils_1.toHex)(value);
200
- return value;
201
- }));
202
- }
203
- /**
204
- * Deserializes saved solana transaction, extracting the transaction, signers & last valid blockheight
205
- *
206
- * @param txData
207
- */
208
- deserializeTx(txData) {
209
- return Promise.resolve(JSON.parse(txData));
210
- }
211
- /**
212
- * Gets the status of the raw starknet transaction
213
- *
214
- * @param tx
215
- */
216
- async getTxStatus(tx) {
217
- const parsedTx = await this.deserializeTx(tx);
218
- return await this.getTxIdStatus(parsedTx.txId);
219
- }
220
- /**
221
- * Gets the status of the starknet transaction with a specific txId
222
- *
223
- * @param txId
224
- */
225
- async _getTxIdStatus(txId) {
226
- const status = await this.provider.getTransactionStatus(txId).catch(e => {
227
- if (e.message != null && e.message.includes("29: Transaction hash not found"))
228
- return null;
229
- throw e;
230
- });
231
- if (status == null)
232
- return "not_found";
233
- if (status.finality_status === starknet_1.ETransactionStatus.RECEIVED)
234
- return "pending";
235
- if (status.finality_status === starknet_1.ETransactionStatus.REJECTED)
236
- return "rejected";
237
- if (status.execution_status === starknet_1.ETransactionExecutionStatus.SUCCEEDED) {
238
- return "success";
239
- }
240
- return "reverted";
241
- }
242
- /**
243
- * Gets the status of the starknet transaction with a specific txId
244
- *
245
- * @param txId
246
- */
247
- async getTxIdStatus(txId) {
248
- const status = await this._getTxIdStatus(txId);
249
- if (status === "rejected")
250
- return "reverted";
251
- return status;
252
- }
253
- onBeforeTxSigned(callback) {
254
- this.cbkBeforeTxSigned = callback;
255
- }
256
- offBeforeTxSigned(callback) {
257
- this.cbkBeforeTxSigned = null;
258
- return true;
259
- }
260
- }
261
- exports.StarknetTransactions = StarknetTransactions;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StarknetTransactions = exports.isStarknetTxDeployAccount = exports.isStarknetTxInvoke = void 0;
4
+ const StarknetModule_1 = require("../StarknetModule");
5
+ const starknet_1 = require("starknet");
6
+ const Utils_1 = require("../../../utils/Utils");
7
+ function isStarknetTxInvoke(obj) {
8
+ return typeof (obj) === "object" &&
9
+ typeof (obj.details) === "object" &&
10
+ (obj.txId == null || typeof (obj.txId) === "string") &&
11
+ obj.type === "INVOKE" &&
12
+ Array.isArray(obj.tx) &&
13
+ (obj.signed == null || typeof (obj.signed) === "object");
14
+ }
15
+ exports.isStarknetTxInvoke = isStarknetTxInvoke;
16
+ function isStarknetTxDeployAccount(obj) {
17
+ return typeof (obj) === "object" &&
18
+ typeof (obj.details) === "object" &&
19
+ (obj.txId == null || typeof (obj.txId) === "string") &&
20
+ obj.type === "DEPLOY_ACCOUNT" &&
21
+ Array.isArray(obj.tx) &&
22
+ (obj.signed == null || typeof (obj.signed) === "object");
23
+ }
24
+ exports.isStarknetTxDeployAccount = isStarknetTxDeployAccount;
25
+ const MAX_UNCONFIRMED_TXS = 25;
26
+ class StarknetTransactions extends StarknetModule_1.StarknetModule {
27
+ constructor() {
28
+ super(...arguments);
29
+ this.latestConfirmedNonces = {};
30
+ this.latestPendingNonces = {};
31
+ this.latestSignedNonces = {};
32
+ this._cbksBeforeTxReplace = [];
33
+ this.cbksBeforeTxSigned = [];
34
+ this._knownTxSet = new Set();
35
+ }
36
+ sendTransaction(tx) {
37
+ switch (tx.type) {
38
+ case "INVOKE":
39
+ return this.provider.channel.invoke(tx.signed, tx.details).then(res => res.transaction_hash);
40
+ case "DEPLOY_ACCOUNT":
41
+ return this.provider.channel.deployAccount(tx.signed, tx.details).then((res) => res.transaction_hash);
42
+ default:
43
+ throw new Error("Unsupported tx type!");
44
+ }
45
+ }
46
+ /**
47
+ * Returns the nonce of the account or 0, if the account is not deployed yet
48
+ *
49
+ * @param address
50
+ */
51
+ async getNonce(address) {
52
+ try {
53
+ return BigInt(await this.provider.getNonceForAddress(address, starknet_1.BlockTag.PRE_CONFIRMED));
54
+ }
55
+ catch (e) {
56
+ if (e.message != null && e.message.includes("20: Contract not found")) {
57
+ return BigInt(0);
58
+ }
59
+ throw e;
60
+ }
61
+ }
62
+ /**
63
+ * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
64
+ * the transaction at regular interval
65
+ *
66
+ * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
67
+ * @param abortSignal signal to abort waiting for tx confirmation
68
+ * @private
69
+ */
70
+ async confirmTransaction(tx, abortSignal) {
71
+ const checkTxns = new Set([tx.txId]);
72
+ const txReplaceListener = (oldTx, oldTxId, newTx, newTxId) => {
73
+ if (checkTxns.has(oldTxId))
74
+ checkTxns.add(newTxId);
75
+ return Promise.resolve();
76
+ };
77
+ this.onBeforeTxReplace(txReplaceListener);
78
+ let state = "pending";
79
+ let confirmedTxId = null;
80
+ while (state === "pending" || state === "not_found") {
81
+ await (0, Utils_1.timeoutPromise)(3000, abortSignal);
82
+ for (let txId of checkTxns) {
83
+ //TODO: Rebroadcast latest tx if possible, we might need to do that in case we use 2 different RPCs on the backend
84
+ // as the other one might not have the tx in their mempool
85
+ // if(state==="not_found" && tx.signed!=null) await this.sendSignedTransaction(tx).catch(e => {
86
+ // if(e.baseError?.code === 59) return; //Transaction already in the mempool
87
+ // this.logger.error("confirmTransaction(): Error on transaction re-send: ", e);
88
+ // });
89
+ state = await this._getTxIdStatus(txId);
90
+ if (state === "rejected" || state === "reverted" || state === "success") {
91
+ confirmedTxId = txId;
92
+ break;
93
+ }
94
+ }
95
+ }
96
+ this.offBeforeTxReplace(txReplaceListener);
97
+ if (state === "rejected")
98
+ throw new Error("Transaction rejected!");
99
+ const nextAccountNonce = (0, Utils_1.toBigInt)(tx.details.nonce) + 1n;
100
+ const currentConfirmedNonce = this.latestConfirmedNonces[(0, Utils_1.toHex)(tx.details.walletAddress)];
101
+ if (currentConfirmedNonce == null || nextAccountNonce > currentConfirmedNonce) {
102
+ this.latestConfirmedNonces[(0, Utils_1.toHex)(tx.details.walletAddress)] = nextAccountNonce;
103
+ }
104
+ if (state === "reverted")
105
+ throw new Error("Transaction reverted!");
106
+ return confirmedTxId;
107
+ }
108
+ /**
109
+ * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
110
+ *
111
+ * @param signer
112
+ * @param txs
113
+ * @private
114
+ */
115
+ async prepareTransactions(signer, txs) {
116
+ let nonce = await this.getNonce(signer.getAddress());
117
+ const latestPendingNonce = this.latestPendingNonces[(0, Utils_1.toHex)(signer.getAddress())];
118
+ if (latestPendingNonce != null && latestPendingNonce > nonce) {
119
+ this.logger.debug("prepareTransactions(): Using 'pending' nonce from local cache!");
120
+ nonce = latestPendingNonce;
121
+ }
122
+ //Add deploy account tx
123
+ if (nonce === 0n) {
124
+ const deployPayload = await signer.getDeployPayload();
125
+ if (deployPayload != null)
126
+ txs.unshift(await this.root.Accounts.getAccountDeployTransaction(deployPayload));
127
+ }
128
+ if (!signer.isManagingNoncesInternally) {
129
+ if (nonce === 0n) {
130
+ //Just increment the nonce by one and hope the wallet is smart enough to deploy account first
131
+ nonce = 1n;
132
+ }
133
+ for (let i = 0; i < txs.length; i++) {
134
+ const tx = txs[i];
135
+ if (tx.details.nonce != null)
136
+ nonce = BigInt(tx.details.nonce); //Take the nonce from last tx
137
+ if (nonce == null)
138
+ nonce = BigInt(await this.root.provider.getNonceForAddress(signer.getAddress())); //Fetch the nonce
139
+ if (tx.details.nonce == null)
140
+ tx.details.nonce = nonce;
141
+ this.logger.debug("sendAndConfirm(): transaction prepared (" + (i + 1) + "/" + txs.length + "), nonce: " + tx.details.nonce);
142
+ nonce += BigInt(1);
143
+ }
144
+ }
145
+ for (let tx of txs) {
146
+ for (let callback of this.cbksBeforeTxSigned) {
147
+ await callback(tx);
148
+ }
149
+ }
150
+ }
151
+ /**
152
+ * Sends out a signed transaction to the RPC
153
+ *
154
+ * @param tx Starknet tx to send
155
+ * @param onBeforePublish a callback called before every transaction is published
156
+ * @private
157
+ */
158
+ async sendSignedTransaction(tx, onBeforePublish) {
159
+ if (onBeforePublish != null)
160
+ await onBeforePublish(tx.txId, StarknetTransactions.serializeTx(tx));
161
+ this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.txId);
162
+ const txResult = await this.sendTransaction(tx);
163
+ if (tx.txId !== txResult)
164
+ this.logger.warn("sendSignedTransaction(): sent tx hash not matching the precomputed hash!");
165
+ this.logger.info("sendSignedTransaction(): tx sent, expected txHash: " + tx.txId + ", txHash: " + txResult);
166
+ return txResult;
167
+ }
168
+ /**
169
+ * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
170
+ * of a batch of starknet transactions
171
+ *
172
+ * @param signer
173
+ * @param txs transactions to send
174
+ * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
175
+ * are re-sent at regular intervals)
176
+ * @param abortSignal abort signal to abort waiting for transaction confirmations
177
+ * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
178
+ * are executed in order)
179
+ * @param onBeforePublish a callback called before every transaction is published
180
+ */
181
+ async sendAndConfirm(signer, txs, waitForConfirmation, abortSignal, parallel, onBeforePublish) {
182
+ await this.prepareTransactions(signer, txs);
183
+ const signedTxs = [];
184
+ //Don't separate the signing process from the sending when using browser-based wallet
185
+ if (signer.signTransaction != null)
186
+ for (let i = 0; i < txs.length; i++) {
187
+ const tx = txs[i];
188
+ const signedTx = await signer.signTransaction(tx);
189
+ signedTxs.push(signedTx);
190
+ this.logger.debug("sendAndConfirm(): transaction signed (" + (i + 1) + "/" + txs.length + "): " + signedTx.txId);
191
+ const nextAccountNonce = BigInt(signedTx.details.nonce) + 1n;
192
+ const currentSignedNonce = this.latestSignedNonces[(0, Utils_1.toHex)(signedTx.details.walletAddress)];
193
+ if (currentSignedNonce == null || nextAccountNonce > currentSignedNonce) {
194
+ this.latestSignedNonces[(0, Utils_1.toHex)(signedTx.details.walletAddress)] = nextAccountNonce;
195
+ }
196
+ }
197
+ this.logger.debug("sendAndConfirm(): sending transactions, count: " + txs.length +
198
+ " waitForConfirmation: " + waitForConfirmation + " parallel: " + parallel);
199
+ const txIds = [];
200
+ if (parallel) {
201
+ let promises = [];
202
+ for (let i = 0; i < txs.length; i++) {
203
+ let tx;
204
+ if (signer.signTransaction == null) {
205
+ const txId = await signer.sendTransaction(txs[i], onBeforePublish);
206
+ tx = txs[i];
207
+ tx.txId = txId;
208
+ }
209
+ else {
210
+ const signedTx = signedTxs[i];
211
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
212
+ tx = signedTx;
213
+ }
214
+ if (tx.details.nonce != null) {
215
+ const nextAccountNonce = BigInt(tx.details.nonce) + 1n;
216
+ const currentPendingNonce = this.latestPendingNonces[(0, Utils_1.toHex)(tx.details.walletAddress)];
217
+ if (currentPendingNonce == null || nextAccountNonce > currentPendingNonce) {
218
+ this.latestPendingNonces[(0, Utils_1.toHex)(tx.details.walletAddress)] = nextAccountNonce;
219
+ }
220
+ }
221
+ promises.push(this.confirmTransaction(tx, abortSignal));
222
+ if (!waitForConfirmation)
223
+ txIds.push(tx.txId);
224
+ this.logger.debug("sendAndConfirm(): transaction sent (" + (i + 1) + "/" + txs.length + "): " + tx.txId);
225
+ if (promises.length >= MAX_UNCONFIRMED_TXS) {
226
+ if (waitForConfirmation)
227
+ txIds.push(...await Promise.all(promises));
228
+ promises = [];
229
+ }
230
+ }
231
+ if (waitForConfirmation && promises.length > 0) {
232
+ txIds.push(...await Promise.all(promises));
233
+ }
234
+ }
235
+ else {
236
+ for (let i = 0; i < txs.length; i++) {
237
+ let tx;
238
+ if (signer.signTransaction == null) {
239
+ const txId = await signer.sendTransaction(txs[i], onBeforePublish);
240
+ tx = txs[i];
241
+ tx.txId = txId;
242
+ }
243
+ else {
244
+ const signedTx = signedTxs[i];
245
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
246
+ tx = signedTx;
247
+ }
248
+ if (tx.details.nonce != null) {
249
+ const nextAccountNonce = BigInt(tx.details.nonce) + 1n;
250
+ const currentPendingNonce = this.latestPendingNonces[(0, Utils_1.toHex)(tx.details.walletAddress)];
251
+ if (currentPendingNonce == null || nextAccountNonce > currentPendingNonce) {
252
+ this.latestPendingNonces[(0, Utils_1.toHex)(tx.details.walletAddress)] = nextAccountNonce;
253
+ }
254
+ }
255
+ const confirmPromise = this.confirmTransaction(tx, abortSignal);
256
+ this.logger.debug("sendAndConfirm(): transaction sent (" + (i + 1) + "/" + txs.length + "): " + tx.txId);
257
+ //Don't await the last promise when !waitForConfirmation
258
+ let txHash = tx.txId;
259
+ if (i < txs.length - 1 || waitForConfirmation)
260
+ txHash = await confirmPromise;
261
+ txIds.push(txHash);
262
+ }
263
+ }
264
+ this.logger.info("sendAndConfirm(): sent transactions, count: " + txs.length +
265
+ " waitForConfirmation: " + waitForConfirmation + " parallel: " + parallel);
266
+ return txIds;
267
+ }
268
+ /**
269
+ * Serializes the solana transaction, saves the transaction, signers & last valid blockheight
270
+ *
271
+ * @param tx
272
+ */
273
+ static serializeTx(tx) {
274
+ return JSON.stringify(tx, (key, value) => {
275
+ if (typeof (value) === "bigint")
276
+ return (0, Utils_1.toHex)(value);
277
+ return value;
278
+ });
279
+ }
280
+ /**
281
+ * Deserializes saved solana transaction, extracting the transaction, signers & last valid blockheight
282
+ *
283
+ * @param txData
284
+ */
285
+ static deserializeTx(txData) {
286
+ return JSON.parse(txData);
287
+ }
288
+ /**
289
+ * Gets the status of the raw starknet transaction
290
+ *
291
+ * @param tx
292
+ */
293
+ async getTxStatus(tx) {
294
+ const parsedTx = StarknetTransactions.deserializeTx(tx);
295
+ return await this.getTxIdStatus(parsedTx.txId);
296
+ }
297
+ /**
298
+ * Gets the status of the starknet transaction with a specific txId
299
+ *
300
+ * @param txId
301
+ */
302
+ async _getTxIdStatus(txId) {
303
+ const status = await this.provider.getTransactionStatus(txId).catch(e => {
304
+ if (e.message != null && e.message.includes("29: Transaction hash not found"))
305
+ return null;
306
+ throw e;
307
+ });
308
+ if (status == null)
309
+ return this._knownTxSet.has(txId) ? "pending" : "not_found";
310
+ if (status.finality_status === starknet_1.ETransactionStatus.RECEIVED)
311
+ return "pending";
312
+ if (status.finality_status === starknet_1.ETransactionStatus.REJECTED)
313
+ return "rejected";
314
+ if (status.execution_status === starknet_1.ETransactionExecutionStatus.SUCCEEDED) {
315
+ return "success";
316
+ }
317
+ return "reverted";
318
+ }
319
+ /**
320
+ * Gets the status of the starknet transaction with a specific txId
321
+ *
322
+ * @param txId
323
+ */
324
+ async getTxIdStatus(txId) {
325
+ const status = await this._getTxIdStatus(txId);
326
+ if (status === "rejected")
327
+ return "reverted";
328
+ return status;
329
+ }
330
+ onBeforeTxReplace(callback) {
331
+ this._cbksBeforeTxReplace.push(callback);
332
+ }
333
+ offBeforeTxReplace(callback) {
334
+ const index = this._cbksBeforeTxReplace.indexOf(callback);
335
+ if (index === -1)
336
+ return false;
337
+ this._cbksBeforeTxReplace.splice(index, 1);
338
+ return true;
339
+ }
340
+ onBeforeTxSigned(callback) {
341
+ this.cbksBeforeTxSigned.push(callback);
342
+ }
343
+ offBeforeTxSigned(callback) {
344
+ const index = this.cbksBeforeTxSigned.indexOf(callback);
345
+ if (index === -1)
346
+ return false;
347
+ this.cbksBeforeTxSigned.splice(index, 1);
348
+ return true;
349
+ }
350
+ }
351
+ exports.StarknetTransactions = StarknetTransactions;