@atomiqlabs/chain-starknet 4.0.0-dev.3 → 4.0.0-dev.31

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 -98
  38. package/dist/starknet/chain/modules/StarknetTransactions.d.ts +111 -93
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +381 -255
  40. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -13
  41. package/dist/starknet/contract/StarknetContractBase.js +20 -16
  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 -90
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +307 -292
  50. package/dist/starknet/provider/RpcProviderWithRetries.d.ts +41 -21
  51. package/dist/starknet/provider/RpcProviderWithRetries.js +70 -32
  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 -434
  61. package/dist/starknet/swaps/EscrowManagerAbi.js +583 -587
  62. package/dist/starknet/swaps/StarknetSwapContract.d.ts +197 -190
  63. package/dist/starknet/swaps/StarknetSwapContract.js +440 -409
  64. package/dist/starknet/swaps/StarknetSwapData.d.ts +74 -67
  65. package/dist/starknet/swaps/StarknetSwapData.js +325 -290
  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 -86
  89. package/dist/starknet/swaps/modules/StarknetSwapInit.js +235 -224
  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 -30
  96. package/dist/starknet/wallet/StarknetPersistentSigner.d.ts +33 -0
  97. package/dist/starknet/wallet/StarknetPersistentSigner.js +244 -0
  98. package/dist/starknet/wallet/StarknetSigner.d.ts +18 -12
  99. package/dist/starknet/wallet/StarknetSigner.js +69 -46
  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 -261
  104. package/package.json +45 -37
  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 -74
  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 -116
  123. package/src/starknet/chain/modules/StarknetTransactions.ts +424 -277
  124. package/src/starknet/contract/StarknetContractBase.ts +30 -26
  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 -410
  129. package/src/starknet/provider/RpcProviderWithRetries.ts +83 -43
  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 -586
  135. package/src/starknet/swaps/StarknetSwapContract.ts +668 -628
  136. package/src/starknet/swaps/StarknetSwapData.ts +455 -403
  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 -286
  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 -39
  154. package/src/utils/Utils.ts +262 -252
@@ -1,278 +1,425 @@
1
- import {StarknetModule} from "../StarknetModule";
2
- import {
3
- Call,
4
- DeployAccountContractPayload, DeployAccountContractTransaction,
5
- Invocation, InvocationsSignerDetails,
6
- BigNumberish
7
- } from "starknet";
8
- import {StarknetSigner} from "../../wallet/StarknetSigner";
9
- import {calculateHash, timeoutPromise, toBigInt, toHex, tryWithRetries} from "../../../utils/Utils";
10
-
11
- export type StarknetTx = ({
12
- type: "DEPLOY_ACCOUNT",
13
- tx: DeployAccountContractPayload,
14
- signed?: DeployAccountContractTransaction
15
- } | {
16
- type: "INVOKE",
17
- tx: Array<Call>,
18
- signed?: Invocation
19
- }) & {
20
- details: InvocationsSignerDetails & {maxFee?: BigNumberish},
21
- txId?: string
22
- };
23
-
24
- export class StarknetTransactions extends StarknetModule {
25
-
26
- private readonly latestConfirmedNonces: {[address: string]: bigint} = {};
27
-
28
- private cbkBeforeTxSigned: (tx: StarknetTx) => Promise<void>;
29
-
30
- /**
31
- * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
32
- * the transaction at regular interval
33
- *
34
- * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
35
- * @param abortSignal signal to abort waiting for tx confirmation
36
- * @private
37
- */
38
- private async confirmTransaction(tx: StarknetTx, abortSignal?: AbortSignal) {
39
- let state = "pending";
40
- while(state==="pending" || state==="not_found") {
41
- await timeoutPromise(3000, abortSignal);
42
- state = await this._getTxIdStatus(tx.txId);
43
- if(state==="not_found" && tx.signed!=null) await this.sendSignedTransaction(tx).catch(e => {
44
- if(e.baseError?.code === 59) return; //Transaction already in the mempool
45
- this.logger.error("confirmTransaction(): Error on transaction re-send: ", e);
46
- });
47
- }
48
- if(state==="rejected") throw new Error("Transaction rejected!");
49
- const nextAccountNonce = toBigInt(tx.details.nonce) + 1n;
50
- const currentNonce = this.latestConfirmedNonces[tx.details.walletAddress];
51
- if(currentNonce==null || nextAccountNonce > currentNonce) {
52
- this.latestConfirmedNonces[tx.details.walletAddress] = nextAccountNonce;
53
- }
54
- if(state==="reverted") throw new Error("Transaction reverted!");
55
- }
56
-
57
- /**
58
- * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
59
- *
60
- * @param signer
61
- * @param txs
62
- * @private
63
- */
64
- private async prepareTransactions(signer: StarknetSigner, txs: StarknetTx[]): Promise<void> {
65
- let nonce: bigint = await signer.getNonce();
66
- const latestConfirmedNonce = this.latestConfirmedNonces[signer.getAddress()];
67
- if(latestConfirmedNonce!=null && latestConfirmedNonce > nonce) {
68
- this.logger.debug("prepareTransactions(): Using nonce from local cache!");
69
- nonce = latestConfirmedNonce;
70
- }
71
- if(nonce===BigInt(0) && signer.isWalletAccount()) {
72
- //Just increment the nonce by one and hope the wallet is smart enough to deploy account first
73
- nonce = BigInt(1);
74
- }
75
- const deployPayload = await signer.checkAndGetDeployPayload(nonce);
76
- if(deployPayload!=null) {
77
- txs.unshift(await this.root.Accounts.getAccountDeployTransaction(deployPayload));
78
- }
79
-
80
- for(let i=0;i<txs.length;i++) {
81
- const tx = txs[i];
82
- if(tx.details.nonce!=null) nonce = BigInt(tx.details.nonce); //Take the nonce from last tx
83
- if(nonce==null) nonce = BigInt(await this.root.provider.getNonceForAddress(signer.getAddress())); //Fetch the nonce
84
- if(tx.details.nonce==null) tx.details.nonce = nonce;
85
-
86
- this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.details.nonce);
87
-
88
- nonce += BigInt(1);
89
-
90
- if(this.cbkBeforeTxSigned!=null) await this.cbkBeforeTxSigned(tx);
91
- }
92
- }
93
-
94
- /**
95
- * Sends out a signed transaction to the RPC
96
- *
97
- * @param tx Starknet tx to send
98
- * @param onBeforePublish a callback called before every transaction is published
99
- * @param signer
100
- * @private
101
- */
102
- private async sendSignedTransaction(
103
- tx: StarknetTx,
104
- onBeforePublish?: (txId: string, rawTx: string) => Promise<void>,
105
- signer?: StarknetSigner
106
- ): Promise<string> {
107
- if(onBeforePublish!=null) await onBeforePublish(tx.txId, await this.serializeTx(tx));
108
- this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.txId);
109
-
110
- if(tx.signed==null) {
111
- let txHash: string;
112
- switch(tx.type) {
113
- case "INVOKE":
114
- txHash = (await signer.account.execute(tx.tx, tx.details)).transaction_hash;
115
- break;
116
- case "DEPLOY_ACCOUNT":
117
- txHash = (await signer.account.deployAccount(tx.tx, tx.details)).transaction_hash;
118
- break;
119
- default:
120
- throw new Error("Unsupported tx type!");
121
- }
122
- tx.txId = txHash;
123
- return txHash;
124
- }
125
-
126
- let txResult: string;
127
- switch(tx.type) {
128
- case "INVOKE":
129
- txResult = await this.provider.channel.invoke(tx.signed, tx.details).then(res => res.transaction_hash);
130
- break;
131
- case "DEPLOY_ACCOUNT":
132
- txResult = await this.provider.channel.deployAccount(tx.signed, tx.details).then((res: any) => res.transaction_hash);
133
- break;
134
- default:
135
- throw new Error("Unsupported tx type!");
136
- }
137
- if(tx.txId!==txResult) this.logger.warn("sendSignedTransaction(): sent tx hash not matching the precomputed hash!");
138
- this.logger.info("sendSignedTransaction(): tx sent, expected txHash: "+tx.txId+", txHash: "+txResult);
139
- return txResult;
140
- }
141
-
142
- /**
143
- * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
144
- * of a batch of starknet transactions
145
- *
146
- * @param signer
147
- * @param txs transactions to send
148
- * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
149
- * are re-sent at regular intervals)
150
- * @param abortSignal abort signal to abort waiting for transaction confirmations
151
- * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
152
- * are executed in order)
153
- * @param onBeforePublish a callback called before every transaction is published
154
- */
155
- public async sendAndConfirm(signer: StarknetSigner, txs: StarknetTx[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
156
- await this.prepareTransactions(signer, txs);
157
- if(!signer.isWalletAccount()) {
158
- for(let i=0;i<txs.length;i++) {
159
- const tx = txs[i];
160
- switch(tx.type) {
161
- case "INVOKE":
162
- tx.signed = await signer.account.buildInvocation(tx.tx, tx.details);
163
- calculateHash(tx);
164
- break;
165
- case "DEPLOY_ACCOUNT":
166
- tx.signed = await signer.account.buildAccountDeployPayload(tx.tx, tx.details);
167
- calculateHash(tx);
168
- break;
169
- default:
170
- throw new Error("Unsupported tx type!");
171
- }
172
- this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+tx.txId);
173
- }
174
- }
175
-
176
- this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
177
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
178
-
179
- const txIds: string[] = [];
180
- if(parallel) {
181
- const promises: Promise<void>[] = [];
182
- for(let i=0;i<txs.length;i++) {
183
- const signedTx = txs[i];
184
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish, signer);
185
- if(waitForConfirmation) promises.push(this.confirmTransaction(signedTx, abortSignal));
186
- txIds.push(txId);
187
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+signedTx.txId);
188
- }
189
- if(promises.length>0) await Promise.all(promises);
190
- } else {
191
- for(let i=0;i<txs.length;i++) {
192
- const signedTx = txs[i];
193
- const txId = await this.sendSignedTransaction(signedTx, onBeforePublish, signer);
194
- const confirmPromise = this.confirmTransaction(signedTx, abortSignal);
195
- this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+signedTx.txId);
196
- //Don't await the last promise when !waitForConfirmation
197
- if(i<txs.length-1 || waitForConfirmation) await confirmPromise;
198
- txIds.push(txId);
199
- }
200
- }
201
-
202
- this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
203
- " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
204
-
205
- return txIds;
206
- }
207
-
208
- /**
209
- * Serializes the solana transaction, saves the transaction, signers & last valid blockheight
210
- *
211
- * @param tx
212
- */
213
- public serializeTx(tx: StarknetTx): Promise<string> {
214
- return Promise.resolve(JSON.stringify(tx, (key, value) => {
215
- if(typeof(value)==="bigint") return toHex(value);
216
- return value;
217
- }));
218
- }
219
-
220
- /**
221
- * Deserializes saved solana transaction, extracting the transaction, signers & last valid blockheight
222
- *
223
- * @param txData
224
- */
225
- public deserializeTx(txData: string): Promise<StarknetTx> {
226
- return Promise.resolve(JSON.parse(txData));
227
- }
228
-
229
- /**
230
- * Gets the status of the raw starknet transaction
231
- *
232
- * @param tx
233
- */
234
- public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
235
- const parsedTx: StarknetTx = await this.deserializeTx(tx);
236
- return await this.getTxIdStatus(parsedTx.txId);
237
- }
238
-
239
- /**
240
- * Gets the status of the starknet transaction with a specific txId
241
- *
242
- * @param txId
243
- */
244
- public async _getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted" | "rejected"> {
245
- const status = await this.provider.getTransactionStatus(txId).catch(e => {
246
- if(e.message!=null && e.message.includes("29: Transaction hash not found")) return null;
247
- throw e;
248
- });
249
- if(status==null) return "not_found";
250
- if(status.finality_status==="RECEIVED") return "pending";
251
- if(status.finality_status==="REJECTED") return "rejected";
252
- if(status.execution_status==="SUCCEEDED"){
253
- return "success";
254
- }
255
- return "reverted";
256
- }
257
-
258
- /**
259
- * Gets the status of the starknet transaction with a specific txId
260
- *
261
- * @param txId
262
- */
263
- public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
264
- const status = await this._getTxIdStatus(txId);
265
- if(status==="rejected") return "reverted";
266
- return status;
267
- }
268
-
269
- public onBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): void {
270
- this.cbkBeforeTxSigned = callback;
271
- }
272
-
273
- public offBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): boolean {
274
- this.cbkBeforeTxSigned = null;
275
- return true;
276
- }
277
-
1
+ import {StarknetModule} from "../StarknetModule";
2
+ import {
3
+ Call,
4
+ DeployAccountContractPayload, DeployAccountContractTransaction,
5
+ Invocation, InvocationsSignerDetails,
6
+ BigNumberish,
7
+ ETransactionStatus,
8
+ ETransactionExecutionStatus, BlockTag
9
+ } from "starknet";
10
+ import {StarknetSigner} from "../../wallet/StarknetSigner";
11
+ import {timeoutPromise, toHex} from "../../../utils/Utils";
12
+
13
+ export type StarknetTxBase = {
14
+ details: InvocationsSignerDetails & {maxFee?: BigNumberish},
15
+ txId?: string
16
+ };
17
+
18
+ export type StarknetTxInvoke = StarknetTxBase & {
19
+ type: "INVOKE",
20
+ tx: Array<Call>,
21
+ signed?: Invocation
22
+ };
23
+
24
+ export function isStarknetTxInvoke(obj: any): obj is StarknetTxInvoke {
25
+ return typeof(obj)==="object" &&
26
+ typeof(obj.details)==="object" &&
27
+ (obj.txId==null || typeof(obj.txId)==="string") &&
28
+ obj.type==="INVOKE" &&
29
+ Array.isArray(obj.tx) &&
30
+ (obj.signed==null || typeof(obj.signed)==="object");
31
+ }
32
+
33
+ export type StarknetTxDeployAccount = StarknetTxBase & {
34
+ type: "DEPLOY_ACCOUNT",
35
+ tx: DeployAccountContractPayload,
36
+ signed?: DeployAccountContractTransaction
37
+ };
38
+
39
+ export function isStarknetTxDeployAccount(obj: any): obj is StarknetTxDeployAccount {
40
+ return typeof(obj)==="object" &&
41
+ typeof(obj.details)==="object" &&
42
+ (obj.txId==null || typeof(obj.txId)==="string") &&
43
+ obj.type==="DEPLOY_ACCOUNT" &&
44
+ Array.isArray(obj.tx) &&
45
+ (obj.signed==null || typeof(obj.signed)==="object");
46
+ }
47
+
48
+ export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
49
+
50
+ const MAX_UNCONFIRMED_TXS = 25;
51
+
52
+ export class StarknetTransactions extends StarknetModule {
53
+
54
+ private readonly latestConfirmedNonces: {[address: string]: bigint} = {};
55
+ private readonly latestPendingNonces: {[address: string]: bigint} = {};
56
+ private readonly latestSignedNonces: {[address: string]: bigint} = {};
57
+
58
+ readonly _cbksBeforeTxReplace: ((oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>)[] = [];
59
+ private readonly cbksBeforeTxSigned: ((tx: StarknetTx) => Promise<void>)[] = [];
60
+
61
+ readonly _knownTxSet: Set<string> = new Set();
62
+
63
+ sendTransaction(tx: StarknetTx): Promise<string> {
64
+ switch(tx.type) {
65
+ case "INVOKE":
66
+ return this.provider.channel.invoke(tx.signed, tx.details).then(res => res.transaction_hash);
67
+ case "DEPLOY_ACCOUNT":
68
+ return this.provider.channel.deployAccount(tx.signed, tx.details).then((res: any) => res.transaction_hash);
69
+ default:
70
+ throw new Error("Unsupported tx type!");
71
+ }
72
+ }
73
+
74
+ /**
75
+ * Returns the nonce of the account or 0, if the account is not deployed yet
76
+ *
77
+ * @param address
78
+ * @param blockTag
79
+ */
80
+ async getNonce(address: string, blockTag: BlockTag = BlockTag.PRE_CONFIRMED): Promise<bigint> {
81
+ try {
82
+ return BigInt(await this.provider.getNonceForAddress(address, blockTag));
83
+ } catch (e) {
84
+ if(
85
+ e.baseError?.code === 20 ||
86
+ (e.message!=null && e.message.includes("20: Contract not found"))
87
+ ) {
88
+ return BigInt(0);
89
+ }
90
+ throw e;
91
+ }
92
+ }
93
+
94
+ /**
95
+ * Waits for transaction confirmation using WS subscription and occasional HTTP polling, also re-sends
96
+ * the transaction at regular interval
97
+ *
98
+ * @param tx starknet transaction to wait for confirmation for & keep re-sending until it confirms
99
+ * @param abortSignal signal to abort waiting for tx confirmation
100
+ * @private
101
+ */
102
+ private async confirmTransaction(tx: StarknetTx, abortSignal?: AbortSignal): Promise<string> {
103
+ const checkTxns: Set<string> = new Set([tx.txId]);
104
+
105
+ const txReplaceListener = (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => {
106
+ if(checkTxns.has(oldTxId)) checkTxns.add(newTxId);
107
+ return Promise.resolve();
108
+ };
109
+ this.onBeforeTxReplace(txReplaceListener);
110
+
111
+ let state = "pending";
112
+ let confirmedTxId: string = null;
113
+ while(state==="pending") {
114
+ await timeoutPromise(3000, abortSignal);
115
+ const latestConfirmedNonce = this.latestConfirmedNonces[toHex(tx.details.walletAddress)];
116
+
117
+ const snapshot = [...checkTxns]; //Iterate over a snapshot
118
+ const totalTxnCount = snapshot.length;
119
+ let rejectedTxns = 0;
120
+ let notFoundTxns = 0;
121
+ for(let txId of snapshot) {
122
+ let _state = await this._getTxIdStatus(txId);
123
+ if(_state==="not_found") notFoundTxns++;
124
+ if(_state==="rejected") rejectedTxns++;
125
+ if(_state==="reverted" || _state==="success") {
126
+ confirmedTxId = txId;
127
+ state = _state;
128
+ break;
129
+ }
130
+ }
131
+ if(rejectedTxns===totalTxnCount) { //All rejected
132
+ state = "rejected";
133
+ break;
134
+ }
135
+ if(notFoundTxns===totalTxnCount) { //All not found, check the latest account nonce
136
+ if(latestConfirmedNonce!=null && latestConfirmedNonce>BigInt(tx.details.nonce)) {
137
+ //Confirmed nonce is already higher than the TX nonce, meaning the TX got replaced
138
+ throw new Error("Transaction failed - replaced!");
139
+ }
140
+ this.logger.warn("confirmTransaction(): All transactions not found, fetching the latest account nonce...");
141
+ const _latestConfirmedNonce = this.latestConfirmedNonces[toHex(tx.details.walletAddress)];
142
+ const currentLatestNonce = await this.getNonce(tx.details.walletAddress, BlockTag.LATEST);
143
+ if(_latestConfirmedNonce==null || _latestConfirmedNonce < currentLatestNonce) {
144
+ this.latestConfirmedNonces[toHex(tx.details.walletAddress)] = currentLatestNonce;
145
+ }
146
+ }
147
+ }
148
+
149
+ this.offBeforeTxReplace(txReplaceListener);
150
+
151
+ if(state==="rejected") throw new Error("Transaction rejected!");
152
+
153
+ const nextAccountNonce = BigInt(tx.details.nonce) + 1n;
154
+ const currentConfirmedNonce = this.latestConfirmedNonces[toHex(tx.details.walletAddress)];
155
+ if(currentConfirmedNonce==null || nextAccountNonce > currentConfirmedNonce) {
156
+ this.latestConfirmedNonces[toHex(tx.details.walletAddress)] = nextAccountNonce;
157
+ }
158
+ if(state==="reverted") throw new Error("Transaction reverted!");
159
+
160
+ return confirmedTxId;
161
+ }
162
+
163
+ /**
164
+ * Prepares starknet transactions, checks if the account is deployed, assigns nonces if needed & calls beforeTxSigned callback
165
+ *
166
+ * @param signer
167
+ * @param txs
168
+ * @private
169
+ */
170
+ private async prepareTransactions(signer: StarknetSigner, txs: StarknetTx[]): Promise<void> {
171
+ let nonce: bigint = await this.getNonce(signer.getAddress());
172
+ const latestPendingNonce = this.latestPendingNonces[toHex(signer.getAddress())];
173
+ if(latestPendingNonce!=null && latestPendingNonce > nonce) {
174
+ this.logger.debug("prepareTransactions(): Using 'pending' nonce from local cache!");
175
+ nonce = latestPendingNonce;
176
+ }
177
+
178
+ //Add deploy account tx
179
+ if(nonce===0n) {
180
+ const deployPayload = await signer.getDeployPayload();
181
+ if(deployPayload!=null) txs.unshift(await this.root.Accounts.getAccountDeployTransaction(deployPayload));
182
+ }
183
+
184
+ if(!signer.isManagingNoncesInternally) {
185
+ if(nonce===0n) {
186
+ //Just increment the nonce by one and hope the wallet is smart enough to deploy account first
187
+ nonce = 1n;
188
+ }
189
+
190
+ for(let i=0;i<txs.length;i++) {
191
+ const tx = txs[i];
192
+ if(tx.details.nonce!=null) nonce = BigInt(tx.details.nonce); //Take the nonce from last tx
193
+ if(nonce==null) nonce = BigInt(await this.root.provider.getNonceForAddress(signer.getAddress())); //Fetch the nonce
194
+ if(tx.details.nonce==null) tx.details.nonce = nonce;
195
+
196
+ this.logger.debug("sendAndConfirm(): transaction prepared ("+(i+1)+"/"+txs.length+"), nonce: "+tx.details.nonce);
197
+
198
+ nonce += BigInt(1);
199
+ }
200
+ }
201
+
202
+ for(let tx of txs) {
203
+ for(let callback of this.cbksBeforeTxSigned) {
204
+ await callback(tx);
205
+ }
206
+ }
207
+ }
208
+
209
+ /**
210
+ * Sends out a signed transaction to the RPC
211
+ *
212
+ * @param tx Starknet tx to send
213
+ * @param onBeforePublish a callback called before every transaction is published
214
+ * @private
215
+ */
216
+ private async sendSignedTransaction(
217
+ tx: StarknetTx,
218
+ onBeforePublish?: (txId: string, rawTx: string) => Promise<void>
219
+ ): Promise<string> {
220
+ if(onBeforePublish!=null) await onBeforePublish(tx.txId, StarknetTransactions.serializeTx(tx));
221
+ this.logger.debug("sendSignedTransaction(): sending transaction: ", tx.txId);
222
+
223
+ const txResult: string = await this.sendTransaction(tx);
224
+ if(tx.txId!==txResult) this.logger.warn("sendSignedTransaction(): sent tx hash not matching the precomputed hash!");
225
+ this.logger.info("sendSignedTransaction(): tx sent, expected txHash: "+tx.txId+", txHash: "+txResult);
226
+ return txResult;
227
+ }
228
+
229
+ /**
230
+ * Prepares, signs , sends (in parallel or sequentially) & optionally waits for confirmation
231
+ * of a batch of starknet transactions
232
+ *
233
+ * @param signer
234
+ * @param txs transactions to send
235
+ * @param waitForConfirmation whether to wait for transaction confirmations (this also makes sure the transactions
236
+ * are re-sent at regular intervals)
237
+ * @param abortSignal abort signal to abort waiting for transaction confirmations
238
+ * @param parallel whether the send all the transaction at once in parallel or sequentially (such that transactions
239
+ * are executed in order)
240
+ * @param onBeforePublish a callback called before every transaction is published
241
+ */
242
+ public async sendAndConfirm(signer: StarknetSigner, txs: StarknetTx[], waitForConfirmation?: boolean, abortSignal?: AbortSignal, parallel?: boolean, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string[]> {
243
+ await this.prepareTransactions(signer, txs);
244
+ const signedTxs: StarknetTx[] = [];
245
+
246
+ //Don't separate the signing process from the sending when using browser-based wallet
247
+ if(signer.signTransaction!=null) for(let i=0;i<txs.length;i++) {
248
+ const tx = txs[i];
249
+ const signedTx = await signer.signTransaction(tx);
250
+ signedTxs.push(signedTx);
251
+ this.logger.debug("sendAndConfirm(): transaction signed ("+(i+1)+"/"+txs.length+"): "+signedTx.txId);
252
+
253
+ const nextAccountNonce = BigInt(signedTx.details.nonce) + 1n;
254
+ const currentSignedNonce = this.latestSignedNonces[toHex(signedTx.details.walletAddress)];
255
+ if(currentSignedNonce==null || nextAccountNonce > currentSignedNonce) {
256
+ this.latestSignedNonces[toHex(signedTx.details.walletAddress)] = nextAccountNonce;
257
+ }
258
+ }
259
+
260
+ this.logger.debug("sendAndConfirm(): sending transactions, count: "+txs.length+
261
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
262
+
263
+ const txIds: string[] = [];
264
+ if(parallel) {
265
+ let promises: Promise<string>[] = [];
266
+ for(let i=0;i<txs.length;i++) {
267
+ let tx: StarknetTx;
268
+ if(signer.signTransaction==null) {
269
+ const txId = await signer.sendTransaction(txs[i], onBeforePublish);
270
+ tx = txs[i];
271
+ tx.txId = txId;
272
+ } else {
273
+ const signedTx = signedTxs[i];
274
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
275
+ tx = signedTx;
276
+ }
277
+
278
+ if(tx.details.nonce!=null) {
279
+ const nextAccountNonce = BigInt(tx.details.nonce) + 1n;
280
+ const currentPendingNonce = this.latestPendingNonces[toHex(tx.details.walletAddress)];
281
+ if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
282
+ this.latestPendingNonces[toHex(tx.details.walletAddress)] = nextAccountNonce;
283
+ }
284
+ }
285
+
286
+ promises.push(this.confirmTransaction(tx, abortSignal));
287
+ if(!waitForConfirmation) txIds.push(tx.txId);
288
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+tx.txId);
289
+ if(promises.length >= MAX_UNCONFIRMED_TXS) {
290
+ if(waitForConfirmation) txIds.push(...await Promise.all(promises));
291
+ promises = [];
292
+ }
293
+ }
294
+ if(waitForConfirmation && promises.length>0) {
295
+ txIds.push(...await Promise.all(promises));
296
+ }
297
+ } else {
298
+ for(let i=0;i<txs.length;i++) {
299
+ let tx: StarknetTx;
300
+ if(signer.signTransaction==null) {
301
+ const txId = await signer.sendTransaction(txs[i], onBeforePublish);
302
+ tx = txs[i];
303
+ tx.txId = txId;
304
+ } else {
305
+ const signedTx = signedTxs[i];
306
+ await this.sendSignedTransaction(signedTx, onBeforePublish);
307
+ tx = signedTx;
308
+ }
309
+
310
+ if(tx.details.nonce!=null) {
311
+ const nextAccountNonce = BigInt(tx.details.nonce) + 1n;
312
+ const currentPendingNonce = this.latestPendingNonces[toHex(tx.details.walletAddress)];
313
+ if(currentPendingNonce==null || nextAccountNonce > currentPendingNonce) {
314
+ this.latestPendingNonces[toHex(tx.details.walletAddress)] = nextAccountNonce;
315
+ }
316
+ }
317
+
318
+ const confirmPromise = this.confirmTransaction(tx, abortSignal);
319
+ this.logger.debug("sendAndConfirm(): transaction sent ("+(i+1)+"/"+txs.length+"): "+tx.txId);
320
+ //Don't await the last promise when !waitForConfirmation
321
+ let txHash = tx.txId;
322
+ if(i<txs.length-1 || waitForConfirmation) txHash = await confirmPromise;
323
+ txIds.push(txHash);
324
+ }
325
+ }
326
+
327
+ this.logger.info("sendAndConfirm(): sent transactions, count: "+txs.length+
328
+ " waitForConfirmation: "+waitForConfirmation+" parallel: "+parallel);
329
+
330
+ return txIds;
331
+ }
332
+
333
+ /**
334
+ * Serializes the starknet transaction, saves the transaction, signers & last valid blockheight
335
+ *
336
+ * @param tx
337
+ */
338
+ public static serializeTx(tx: StarknetTx): string {
339
+ return JSON.stringify(tx, (key, value) => {
340
+ if(typeof(value)==="bigint") return {
341
+ _type: "bigint",
342
+ _value: toHex(value)
343
+ };
344
+ return value;
345
+ });
346
+ }
347
+
348
+ /**
349
+ * Deserializes saved starknet transaction, extracting the transaction, signers & last valid blockheight
350
+ *
351
+ * @param txData
352
+ */
353
+ public static deserializeTx(txData: string): StarknetTx {
354
+ return JSON.parse(txData, (key, value) => {
355
+ if(typeof(value)==="object" && value._type==="bigint") return BigInt(value._value);
356
+ return value;
357
+ });
358
+ }
359
+
360
+ /**
361
+ * Gets the status of the raw starknet transaction
362
+ *
363
+ * @param tx
364
+ */
365
+ public async getTxStatus(tx: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
366
+ const parsedTx: StarknetTx = StarknetTransactions.deserializeTx(tx);
367
+ return await this.getTxIdStatus(parsedTx.txId);
368
+ }
369
+
370
+ /**
371
+ * Gets the status of the starknet transaction with a specific txId
372
+ *
373
+ * @param txId
374
+ */
375
+ public async _getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted" | "rejected"> {
376
+ const status = await this.provider.getTransactionStatus(txId).catch(e => {
377
+ if(
378
+ e.baseError?.code===29 ||
379
+ (e.message!=null && e.message.includes("29: Transaction hash not found"))
380
+ ) return null;
381
+ throw e;
382
+ });
383
+ if(status==null) return this._knownTxSet.has(txId) ? "pending" : "not_found";
384
+ if(status.finality_status===ETransactionStatus.RECEIVED) return "pending";
385
+ if(status.finality_status===ETransactionStatus.REJECTED) return "rejected";
386
+ if(status.execution_status===ETransactionExecutionStatus.SUCCEEDED){
387
+ return "success";
388
+ }
389
+ return "reverted";
390
+ }
391
+
392
+ /**
393
+ * Gets the status of the starknet transaction with a specific txId
394
+ *
395
+ * @param txId
396
+ */
397
+ public async getTxIdStatus(txId: string): Promise<"pending" | "success" | "not_found" | "reverted"> {
398
+ const status = await this._getTxIdStatus(txId);
399
+ if(status==="rejected") return "reverted";
400
+ return status;
401
+ }
402
+
403
+ onBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): void {
404
+ this._cbksBeforeTxReplace.push(callback);
405
+ }
406
+
407
+ offBeforeTxReplace(callback: (oldTx: string, oldTxId: string, newTx: string, newTxId: string) => Promise<void>): boolean {
408
+ const index = this._cbksBeforeTxReplace.indexOf(callback);
409
+ if(index===-1) return false;
410
+ this._cbksBeforeTxReplace.splice(index, 1);
411
+ return true;
412
+ }
413
+
414
+ public onBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): void {
415
+ this.cbksBeforeTxSigned.push(callback);
416
+ }
417
+
418
+ public offBeforeTxSigned(callback: (tx: StarknetTx) => Promise<void>): boolean {
419
+ const index = this.cbksBeforeTxSigned.indexOf(callback);
420
+ if(index===-1) return false;
421
+ this.cbksBeforeTxSigned.splice(index, 1);
422
+ return true;
423
+ }
424
+
278
425
  }