@atomiqlabs/chain-starknet 3.0.0-dev.8 → 4.0.0-dev.3

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 (146) hide show
  1. package/LICENSE +201 -201
  2. package/dist/index.d.ts +38 -38
  3. package/dist/index.js +54 -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 +27 -19
  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 +52 -52
  19. package/dist/starknet/chain/StarknetChainInterface.js +91 -91
  20. package/dist/starknet/chain/StarknetModule.d.ts +14 -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 -19
  29. package/dist/starknet/chain/modules/StarknetBlocks.js +64 -49
  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 +77 -77
  33. package/dist/starknet/chain/modules/StarknetFees.js +114 -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 +98 -98
  38. package/dist/starknet/chain/modules/StarknetTransactions.d.ts +93 -93
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +255 -255
  40. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -13
  41. package/dist/starknet/contract/StarknetContractBase.js +16 -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 +90 -91
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +292 -294
  50. package/dist/starknet/provider/RpcProviderWithRetries.d.ts +21 -21
  51. package/dist/starknet/provider/RpcProviderWithRetries.js +32 -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 +66 -65
  55. package/dist/starknet/spv_swap/StarknetSpvVaultContract.js +382 -376
  56. package/dist/starknet/spv_swap/StarknetSpvVaultData.d.ts +49 -49
  57. package/dist/starknet/spv_swap/StarknetSpvVaultData.js +145 -144
  58. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.d.ts +25 -24
  59. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.js +72 -61
  60. package/dist/starknet/swaps/EscrowManagerAbi.d.ts +434 -434
  61. package/dist/starknet/swaps/EscrowManagerAbi.js +587 -587
  62. package/dist/starknet/swaps/StarknetSwapContract.d.ts +190 -196
  63. package/dist/starknet/swaps/StarknetSwapContract.js +409 -395
  64. package/dist/starknet/swaps/StarknetSwapData.d.ts +67 -67
  65. package/dist/starknet/swaps/StarknetSwapData.js +290 -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 +86 -84
  89. package/dist/starknet/swaps/modules/StarknetSwapInit.js +224 -200
  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/StarknetKeypairWallet.d.ts +7 -7
  93. package/dist/starknet/wallet/StarknetKeypairWallet.js +30 -30
  94. package/dist/starknet/wallet/StarknetSigner.d.ts +12 -12
  95. package/dist/starknet/wallet/StarknetSigner.js +46 -46
  96. package/dist/utils/Utils.d.ts +37 -37
  97. package/dist/utils/Utils.js +261 -257
  98. package/package.json +37 -37
  99. package/src/index.ts +47 -47
  100. package/src/starknet/StarknetChainType.ts +28 -28
  101. package/src/starknet/StarknetInitializer.ts +108 -100
  102. package/src/starknet/btcrelay/BtcRelayAbi.ts +338 -338
  103. package/src/starknet/btcrelay/StarknetBtcRelay.ts +494 -494
  104. package/src/starknet/btcrelay/headers/StarknetBtcHeader.ts +100 -100
  105. package/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts +141 -141
  106. package/src/starknet/chain/StarknetAction.ts +85 -85
  107. package/src/starknet/chain/StarknetChainInterface.ts +149 -149
  108. package/src/starknet/chain/StarknetModule.ts +19 -19
  109. package/src/starknet/chain/modules/ERC20Abi.ts +1029 -1029
  110. package/src/starknet/chain/modules/StarknetAccounts.ts +25 -25
  111. package/src/starknet/chain/modules/StarknetAddresses.ts +22 -22
  112. package/src/starknet/chain/modules/StarknetBlocks.ts +74 -58
  113. package/src/starknet/chain/modules/StarknetEvents.ts +104 -104
  114. package/src/starknet/chain/modules/StarknetFees.ts +154 -154
  115. package/src/starknet/chain/modules/StarknetSignatures.ts +91 -91
  116. package/src/starknet/chain/modules/StarknetTokens.ts +116 -116
  117. package/src/starknet/chain/modules/StarknetTransactions.ts +277 -277
  118. package/src/starknet/contract/StarknetContractBase.ts +26 -26
  119. package/src/starknet/contract/StarknetContractModule.ts +16 -16
  120. package/src/starknet/contract/modules/StarknetContractEvents.ts +134 -134
  121. package/src/starknet/events/StarknetChainEvents.ts +67 -67
  122. package/src/starknet/events/StarknetChainEventsBrowser.ts +410 -412
  123. package/src/starknet/provider/RpcProviderWithRetries.ts +43 -43
  124. package/src/starknet/spv_swap/SpvVaultContractAbi.ts +656 -656
  125. package/src/starknet/spv_swap/StarknetSpvVaultContract.ts +483 -477
  126. package/src/starknet/spv_swap/StarknetSpvVaultData.ts +195 -194
  127. package/src/starknet/spv_swap/StarknetSpvWithdrawalData.ts +79 -68
  128. package/src/starknet/swaps/EscrowManagerAbi.ts +586 -586
  129. package/src/starknet/swaps/StarknetSwapContract.ts +628 -605
  130. package/src/starknet/swaps/StarknetSwapData.ts +403 -403
  131. package/src/starknet/swaps/StarknetSwapModule.ts +17 -17
  132. package/src/starknet/swaps/handlers/IHandler.ts +20 -20
  133. package/src/starknet/swaps/handlers/claim/ClaimHandlers.ts +23 -23
  134. package/src/starknet/swaps/handlers/claim/HashlockClaimHandler.ts +53 -53
  135. package/src/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +73 -73
  136. package/src/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +67 -67
  137. package/src/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +50 -50
  138. package/src/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +102 -102
  139. package/src/starknet/swaps/handlers/refund/TimelockRefundHandler.ts +38 -38
  140. package/src/starknet/swaps/modules/StarknetLpVault.ts +147 -147
  141. package/src/starknet/swaps/modules/StarknetSwapClaim.ts +141 -141
  142. package/src/starknet/swaps/modules/StarknetSwapInit.ts +286 -260
  143. package/src/starknet/swaps/modules/StarknetSwapRefund.ts +196 -196
  144. package/src/starknet/wallet/StarknetKeypairWallet.ts +39 -39
  145. package/src/starknet/wallet/StarknetSigner.ts +55 -55
  146. package/src/utils/Utils.ts +252 -248
@@ -1,278 +1,278 @@
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
- console.error("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
- console.debug("StarknetTransactions: 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
+ } 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
+
278
278
  }
@@ -1,26 +1,26 @@
1
- import {StarknetChainInterface} from "../chain/StarknetChainInterface";
2
- import {Contract, TypedContractV2} from "starknet";
3
- import {Abi} from "abi-wan-kanabi";
4
- import {StarknetContractEvents} from "./modules/StarknetContractEvents";
5
-
6
- /**
7
- * Base class providing program specific utilities
8
- */
9
- export class StarknetContractBase<T extends Abi> {
10
-
11
- contract: TypedContractV2<T>;
12
-
13
- public readonly Events: StarknetContractEvents<T>;
14
- public readonly Chain: StarknetChainInterface;
15
-
16
- constructor(
17
- chainInterface: StarknetChainInterface,
18
- contractAddress: string,
19
- contractAbi: T
20
- ) {
21
- this.Chain = chainInterface;
22
- this.contract = new Contract(contractAbi, contractAddress, chainInterface.provider).typedv2(contractAbi);
23
- this.Events = new StarknetContractEvents(chainInterface, this, contractAbi);
24
- }
25
-
26
- }
1
+ import {StarknetChainInterface} from "../chain/StarknetChainInterface";
2
+ import {Contract, TypedContractV2} from "starknet";
3
+ import {Abi} from "abi-wan-kanabi";
4
+ import {StarknetContractEvents} from "./modules/StarknetContractEvents";
5
+
6
+ /**
7
+ * Base class providing program specific utilities
8
+ */
9
+ export class StarknetContractBase<T extends Abi> {
10
+
11
+ contract: TypedContractV2<T>;
12
+
13
+ public readonly Events: StarknetContractEvents<T>;
14
+ public readonly Chain: StarknetChainInterface;
15
+
16
+ constructor(
17
+ chainInterface: StarknetChainInterface,
18
+ contractAddress: string,
19
+ contractAbi: T
20
+ ) {
21
+ this.Chain = chainInterface;
22
+ this.contract = new Contract(contractAbi, contractAddress, chainInterface.provider).typedv2(contractAbi);
23
+ this.Events = new StarknetContractEvents(chainInterface, this, contractAbi);
24
+ }
25
+
26
+ }
@@ -1,16 +1,16 @@
1
- import {Abi} from "abi-wan-kanabi";
2
- import {StarknetContractBase} from "./StarknetContractBase";
3
- import {StarknetChainInterface} from "../chain/StarknetChainInterface";
4
- import {StarknetModule} from "../chain/StarknetModule";
5
-
6
-
7
- export class StarknetContractModule<TAbi extends Abi> extends StarknetModule {
8
-
9
- readonly contract: StarknetContractBase<TAbi>;
10
-
11
- constructor(chainInterface: StarknetChainInterface, contract: StarknetContractBase<TAbi>) {
12
- super(chainInterface)
13
- this.contract = contract;
14
- }
15
-
16
- }
1
+ import {Abi} from "abi-wan-kanabi";
2
+ import {StarknetContractBase} from "./StarknetContractBase";
3
+ import {StarknetChainInterface} from "../chain/StarknetChainInterface";
4
+ import {StarknetModule} from "../chain/StarknetModule";
5
+
6
+
7
+ export class StarknetContractModule<TAbi extends Abi> extends StarknetModule {
8
+
9
+ readonly contract: StarknetContractBase<TAbi>;
10
+
11
+ constructor(chainInterface: StarknetChainInterface, contract: StarknetContractBase<TAbi>) {
12
+ super(chainInterface)
13
+ this.contract = contract;
14
+ }
15
+
16
+ }