@atomiqlabs/chain-starknet 4.0.0-dev.26 → 4.0.0-dev.28

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 -39
  3. package/dist/index.js +55 -55
  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 -28
  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 -54
  19. package/dist/starknet/chain/StarknetChainInterface.js +97 -97
  20. package/dist/starknet/chain/StarknetModule.d.ts +9 -9
  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 -82
  33. package/dist/starknet/chain/modules/StarknetFees.js +121 -121
  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 +111 -110
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +359 -351
  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 -84
  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 -89
  55. package/dist/starknet/spv_swap/StarknetSpvVaultContract.js +477 -477
  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 -197
  63. package/dist/starknet/swaps/StarknetSwapContract.js +440 -440
  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 -5
  93. package/dist/starknet/wallet/StarknetBrowserSigner.js +11 -11
  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 -33
  97. package/dist/starknet/wallet/StarknetPersistentSigner.js +248 -243
  98. package/dist/starknet/wallet/StarknetSigner.d.ts +18 -18
  99. package/dist/starknet/wallet/StarknetSigner.js +69 -69
  100. package/dist/starknet/wallet/accounts/StarknetKeypairWallet.d.ts +7 -7
  101. package/dist/starknet/wallet/accounts/StarknetKeypairWallet.js +35 -35
  102. package/dist/utils/Utils.d.ts +39 -39
  103. package/dist/utils/Utils.js +264 -264
  104. package/package.json +45 -45
  105. package/src/index.ts +48 -48
  106. package/src/starknet/StarknetChainType.ts +28 -28
  107. package/src/starknet/StarknetInitializer.ts +110 -110
  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 -165
  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 -162
  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 +399 -392
  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 -591
  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 -668
  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 +11 -11
  151. package/src/starknet/wallet/StarknetPersistentSigner.ts +314 -310
  152. package/src/starknet/wallet/StarknetSigner.ts +84 -84
  153. package/src/starknet/wallet/accounts/StarknetKeypairWallet.ts +44 -44
  154. package/src/utils/Utils.ts +262 -262
@@ -1,311 +1,315 @@
1
- import {StarknetSigner} from "./StarknetSigner";
2
- import {StarknetTransactions, StarknetTx} from "../chain/modules/StarknetTransactions";
3
- import {StarknetChainInterface} from "../chain/StarknetChainInterface";
4
- import {bigIntMax, getLogger, LoggerType, toBigInt} from "../../utils/Utils";
5
- import {Account} from "starknet";
6
- import {access, readFile, writeFile, mkdir, constants} from "fs/promises";
7
- import {StarknetFees} from "../chain/modules/StarknetFees";
8
- import {cloneDeep} from "@scure/btc-signer/transaction";
9
- import { PromiseQueue } from "promise-queue-ts";
10
-
11
- const WAIT_BEFORE_BUMP = 15*1000;
12
- const MIN_FEE_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
13
- const MIN_FEE_INCREASE_PPM = 110_000n; // +11%
14
-
15
- const MIN_TIP_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
16
- const MIN_TIP_INCREASE_PPM = 110_000n; // +11%
17
-
18
- export type StarknetPersistentSignerConfig = {
19
- waitBeforeBump?: number;
20
- minFeeIncreaseAbsolute?: bigint;
21
- minFeeIncreasePpm?: bigint
22
- minTipIncreaseAbsolute?: bigint;
23
- minTipIncreasePpm?: bigint;
24
- };
25
-
26
- export class StarknetPersistentSigner extends StarknetSigner {
27
-
28
- private pendingTxs: Map<bigint, {
29
- txs: StarknetTx[],
30
- lastBumped: number,
31
- sending?: boolean //Not saved
32
- }> = new Map();
33
-
34
- private confirmedNonce: bigint;
35
- private pendingNonce: bigint;
36
-
37
- private feeBumper: any;
38
- private stopped: boolean = false;
39
-
40
- private readonly directory: string;
41
-
42
- private readonly config: StarknetPersistentSignerConfig
43
-
44
- private readonly chainInterface: StarknetChainInterface;
45
-
46
- private readonly logger: LoggerType;
47
-
48
- constructor(
49
- account: Account,
50
- chainInterface: StarknetChainInterface,
51
- directory: string,
52
- config?: StarknetPersistentSignerConfig,
53
- ) {
54
- super(account, true);
55
- this.signTransaction = null;
56
- this.chainInterface = chainInterface;
57
- this.directory = directory;
58
- this.config = config ?? {};
59
- this.config.minFeeIncreaseAbsolute ??= MIN_FEE_INCREASE_ABSOLUTE;
60
- this.config.minFeeIncreasePpm ??= MIN_FEE_INCREASE_PPM;
61
- this.config.minTipIncreaseAbsolute ??= MIN_TIP_INCREASE_ABSOLUTE;
62
- this.config.minTipIncreasePpm ??= MIN_TIP_INCREASE_PPM;
63
- this.config.waitBeforeBump ??= WAIT_BEFORE_BUMP;
64
- this.logger = getLogger("StarknetPersistentSigner("+this.account.address+"): ");
65
- }
66
-
67
- private async load() {
68
- const fileExists = await access(this.directory+"/txs.json", constants.F_OK).then(() => true).catch(() => false);
69
- if(!fileExists) return;
70
- const res = await readFile(this.directory+"/txs.json");
71
- if(res!=null) {
72
- const pendingTxs: {
73
- [nonce: string]: {
74
- txs: string[],
75
- lastBumped: number
76
- }
77
- } = JSON.parse((res as Buffer).toString());
78
-
79
- for(let nonceStr in pendingTxs) {
80
- const nonceData = pendingTxs[nonceStr];
81
-
82
- const nonce = BigInt(nonceStr);
83
- if(this.confirmedNonce>=nonce) continue; //Already confirmed
84
-
85
- if(this.pendingNonce<nonce) {
86
- this.pendingNonce = nonce;
87
- }
88
- const parsedPendingTxns = nonceData.txs.map(StarknetTransactions.deserializeTx);
89
- this.pendingTxs.set(nonce, {
90
- txs: parsedPendingTxns,
91
- lastBumped: nonceData.lastBumped
92
- })
93
- for(let tx of parsedPendingTxns) {
94
- this.chainInterface.Transactions._knownTxSet.add(tx.txId);
95
- }
96
- }
97
- }
98
- }
99
-
100
- private priorSavePromise: Promise<void>;
101
- private saveCount: number = 0;
102
-
103
- private async save() {
104
- const pendingTxs: {
105
- [nonce: string]: {
106
- txs: string[],
107
- lastBumped: number
108
- }
109
- } = {};
110
- for(let [nonce, data] of this.pendingTxs) {
111
- pendingTxs[nonce.toString(10)] = {
112
- lastBumped: data.lastBumped,
113
- txs: data.txs.map(StarknetTransactions.serializeTx)
114
- };
115
- }
116
- const requiredSaveCount = ++this.saveCount;
117
- if(this.priorSavePromise!=null) {
118
- await this.priorSavePromise;
119
- }
120
- if(requiredSaveCount===this.saveCount) {
121
- this.priorSavePromise = writeFile(this.directory+"/txs.json", JSON.stringify(pendingTxs));
122
- await this.priorSavePromise;
123
- }
124
- }
125
-
126
- private async checkPastTransactions() {
127
- let _gasPrice: {l1GasCost: bigint, l2GasCost: bigint, l1DataGasCost: bigint} = null;
128
- let _safeBlockTxCount: bigint = null;
129
-
130
- for(let [nonce, data] of this.pendingTxs) {
131
- if(!data.sending && data.lastBumped<Date.now()-this.config.waitBeforeBump) {
132
- _safeBlockTxCount = await this.chainInterface.Transactions.getNonce(this.account.address);
133
- this.confirmedNonce = _safeBlockTxCount;
134
- if(_safeBlockTxCount > nonce) {
135
- this.pendingTxs.delete(nonce);
136
- data.txs.forEach(tx => this.chainInterface.Transactions._knownTxSet.delete(tx.txId));
137
- this.logger.info("checkPastTransactions(): Tx confirmed, required fee bumps: ", data.txs.length);
138
- this.save();
139
- continue;
140
- }
141
-
142
- const lastTx = data.txs[data.txs.length-1];
143
- if(_gasPrice==null) {
144
- const feeRate = await this.chainInterface.Fees.getFeeRate();
145
- _gasPrice = StarknetFees.extractFromFeeRateString(feeRate);
146
- }
147
-
148
- let l1GasCost = toBigInt(lastTx.details.resourceBounds.l1_gas.max_price_per_unit);
149
- let l2GasCost = toBigInt(lastTx.details.resourceBounds.l2_gas.max_price_per_unit);
150
- let l1DataGasCost = toBigInt(lastTx.details.resourceBounds.l1_data_gas.max_price_per_unit);
151
- let tip = toBigInt(lastTx.details.tip);
152
-
153
- let feeBumped: boolean = false;
154
- if(_gasPrice.l1GasCost > l1GasCost) {
155
- //Bump by minimum allowed or to the actual _gasPrice.l1GasCost
156
- l1GasCost = bigIntMax(_gasPrice.l1GasCost, this.config.minFeeIncreaseAbsolute + (l1GasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
157
- feeBumped = true;
158
- }
159
- if(_gasPrice.l1DataGasCost > l1DataGasCost) {
160
- //Bump by minimum allowed or to the actual _gasPrice.l1GasCost
161
- l1DataGasCost = bigIntMax(_gasPrice.l1DataGasCost, this.config.minFeeIncreaseAbsolute + (l1DataGasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
162
- feeBumped = true;
163
- }
164
- if(_gasPrice.l2GasCost > l2GasCost || feeBumped) { //In case the fees for l1 and l1Data were bumped, we also need to bump the l2GasFee regardless
165
- l2GasCost = bigIntMax(_gasPrice.l2GasCost, this.config.minFeeIncreaseAbsolute + (l2GasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
166
- feeBumped = true;
167
- }
168
- if(feeBumped) tip = this.config.minTipIncreaseAbsolute + (tip * (1_000_000n + this.config.minTipIncreasePpm) / 1_000_000n);
169
-
170
- if(!feeBumped) {
171
- //Not fee bumped
172
- this.logger.debug("checkPastTransactions(): Tx yet unconfirmed but not increasing fee for ", lastTx.txId);
173
- //Rebroadcast the tx
174
- await this.chainInterface.Transactions.sendTransaction(lastTx).catch(e => {
175
- if(e.baseError?.code === 52) { //Invalid transaction nonce
176
- this.logger.debug("checkPastTransactions(): Tx re-broadcast success, tx already confirmed: ", lastTx.txId);
177
- return;
178
- }
179
- if(e.baseError?.code === 59) { //Transaction already in the mempool
180
- this.logger.debug("checkPastTransactions(): Tx re-broadcast success, tx already known to the RPC: ", lastTx.txId);
181
- return;
182
- }
183
- this.logger.error("checkPastTransactions(): Tx re-broadcast error", e)
184
- });
185
- data.lastBumped = Date.now();
186
- continue;
187
- }
188
-
189
- const newTx = cloneDeep(lastTx);
190
- delete newTx.signed;
191
- delete newTx.txId;
192
-
193
- newTx.details.tip = tip;
194
- newTx.details.resourceBounds.l1_gas.max_price_per_unit = l1GasCost;
195
- newTx.details.resourceBounds.l2_gas.max_price_per_unit = l2GasCost;
196
- newTx.details.resourceBounds.l1_data_gas.max_price_per_unit = l1DataGasCost;
197
- this.logger.info("checkPastTransactions(): Bump fee for tx: ", lastTx.txId);
198
-
199
- await this._signTransaction(newTx);
200
-
201
- //Double check pending txns still has nonce after async signTransaction was called
202
- if(!this.pendingTxs.has(nonce)) continue;
203
-
204
- for(let callback of this.chainInterface.Transactions._cbksBeforeTxReplace) {
205
- try {
206
- await callback(StarknetTransactions.serializeTx(lastTx), lastTx.txId, StarknetTransactions.serializeTx(newTx), newTx.txId)
207
- } catch (e) {
208
- this.logger.error("checkPastTransactions(): beforeTxReplace callback error: ", e);
209
- }
210
- }
211
-
212
- data.txs.push(newTx);
213
- data.lastBumped = Date.now();
214
- this.save();
215
-
216
- this.chainInterface.Transactions._knownTxSet.add(newTx.txId);
217
-
218
- //TODO: Better error handling when sending tx
219
- await this.chainInterface.Transactions.sendTransaction(newTx).catch(e => {
220
- if(e.baseError?.code === 52) { //Invalid transaction nonce
221
- return
222
- }
223
- this.logger.error("checkPastTransactions(): Fee-bumped tx broadcast error", e)
224
- });
225
- }
226
- }
227
- }
228
-
229
- private startFeeBumper() {
230
- let func: () => Promise<void>;
231
- func = async () => {
232
- try {
233
- await this.checkPastTransactions();
234
- } catch (e) {
235
- this.logger.error("startFeeBumper(): Error when check past transactions: ", e);
236
- }
237
-
238
- if(this.stopped) return;
239
-
240
- this.feeBumper = setTimeout(func, 1000);
241
- };
242
- func();
243
- }
244
-
245
- async init(): Promise<void> {
246
- try {
247
- await mkdir(this.directory)
248
- } catch (e) {}
249
-
250
- const nonce = await this.chainInterface.Transactions.getNonce(this.account.address);
251
- this.confirmedNonce = nonce;
252
- this.pendingNonce = nonce;
253
-
254
- await this.load();
255
-
256
- this.startFeeBumper();
257
- }
258
-
259
- stop(): Promise<void> {
260
- this.stopped = true;
261
- if(this.feeBumper!=null) {
262
- clearTimeout(this.feeBumper);
263
- this.feeBumper = null;
264
- }
265
- return Promise.resolve();
266
- }
267
-
268
- private readonly sendTransactionQueue: PromiseQueue = new PromiseQueue();
269
-
270
- sendTransaction(transaction: StarknetTx, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string> {
271
- return this.sendTransactionQueue.enqueue(async () => {
272
- if(transaction.details.nonce!=null) {
273
- if(transaction.details.nonce !== this.pendingNonce + 1n)
274
- throw new Error("Invalid transaction nonce!");
275
- } else {
276
- transaction.details.nonce = this.pendingNonce + 1n;
277
- }
278
-
279
- const signedTx = await this._signTransaction(transaction);
280
-
281
- if(onBeforePublish!=null) {
282
- try {
283
- await onBeforePublish(signedTx.txId, StarknetTransactions.serializeTx(signedTx));
284
- } catch (e) {
285
- this.logger.error("sendTransaction(): Error when calling onBeforePublish function: ", e);
286
- }
287
- }
288
-
289
- const pendingTxObject = {txs: [signedTx], lastBumped: Date.now(), sending: true};
290
- this.pendingNonce++;
291
- this.logger.debug("sendTransaction(): Incrementing pending nonce to: ", this.pendingNonce);
292
- this.pendingTxs.set(transaction.details.nonce, pendingTxObject);
293
- this.save();
294
-
295
- this.chainInterface.Transactions._knownTxSet.add(signedTx.txId);
296
-
297
- try {
298
- const result = await this.chainInterface.Transactions.sendTransaction(signedTx);
299
- pendingTxObject.sending = false;
300
- return result;
301
- } catch (e) {
302
- this.chainInterface.Transactions._knownTxSet.delete(signedTx.txId);
303
- this.pendingTxs.delete(transaction.details.nonce);
304
- this.pendingNonce--;
305
- this.logger.debug("sendTransaction(): Error when broadcasting transaction, reverting pending nonce to: ", this.pendingNonce);
306
- throw e;
307
- }
308
- });
309
- }
310
-
1
+ import {StarknetSigner} from "./StarknetSigner";
2
+ import {StarknetTransactions, StarknetTx} from "../chain/modules/StarknetTransactions";
3
+ import {StarknetChainInterface} from "../chain/StarknetChainInterface";
4
+ import {bigIntMax, getLogger, LoggerType, toBigInt} from "../../utils/Utils";
5
+ import {Account, Block, BlockTag} from "starknet";
6
+ import {access, readFile, writeFile, mkdir, constants} from "fs/promises";
7
+ import {StarknetFees} from "../chain/modules/StarknetFees";
8
+ import {cloneDeep} from "@scure/btc-signer/transaction";
9
+ import { PromiseQueue } from "promise-queue-ts";
10
+
11
+ const WAIT_BEFORE_BUMP = 15*1000;
12
+ const MIN_FEE_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
13
+ const MIN_FEE_INCREASE_PPM = 110_000n; // +11%
14
+
15
+ const MIN_TIP_INCREASE_ABSOLUTE = 1n*1_000_000_000n; //1GWei
16
+ const MIN_TIP_INCREASE_PPM = 110_000n; // +11%
17
+
18
+ export type StarknetPersistentSignerConfig = {
19
+ waitBeforeBump?: number;
20
+ minFeeIncreaseAbsolute?: bigint;
21
+ minFeeIncreasePpm?: bigint
22
+ minTipIncreaseAbsolute?: bigint;
23
+ minTipIncreasePpm?: bigint;
24
+ };
25
+
26
+ export class StarknetPersistentSigner extends StarknetSigner {
27
+
28
+ private pendingTxs: Map<bigint, {
29
+ txs: StarknetTx[],
30
+ lastBumped: number,
31
+ sending?: boolean //Not saved
32
+ }> = new Map();
33
+
34
+ private confirmedNonce: bigint;
35
+ private pendingNonce: bigint;
36
+
37
+ private feeBumper: any;
38
+ private stopped: boolean = false;
39
+
40
+ private readonly directory: string;
41
+
42
+ private readonly config: StarknetPersistentSignerConfig
43
+
44
+ private readonly chainInterface: StarknetChainInterface;
45
+
46
+ private readonly logger: LoggerType;
47
+
48
+ constructor(
49
+ account: Account,
50
+ chainInterface: StarknetChainInterface,
51
+ directory: string,
52
+ config?: StarknetPersistentSignerConfig,
53
+ ) {
54
+ super(account, true);
55
+ this.signTransaction = null;
56
+ this.chainInterface = chainInterface;
57
+ this.directory = directory;
58
+ this.config = config ?? {};
59
+ this.config.minFeeIncreaseAbsolute ??= MIN_FEE_INCREASE_ABSOLUTE;
60
+ this.config.minFeeIncreasePpm ??= MIN_FEE_INCREASE_PPM;
61
+ this.config.minTipIncreaseAbsolute ??= MIN_TIP_INCREASE_ABSOLUTE;
62
+ this.config.minTipIncreasePpm ??= MIN_TIP_INCREASE_PPM;
63
+ this.config.waitBeforeBump ??= WAIT_BEFORE_BUMP;
64
+ this.logger = getLogger("StarknetPersistentSigner("+this.account.address+"): ");
65
+ }
66
+
67
+ private async load() {
68
+ const fileExists = await access(this.directory+"/txs.json", constants.F_OK).then(() => true).catch(() => false);
69
+ if(!fileExists) return;
70
+ const res = await readFile(this.directory+"/txs.json");
71
+ if(res!=null) {
72
+ const pendingTxs: {
73
+ [nonce: string]: {
74
+ txs: string[],
75
+ lastBumped: number
76
+ }
77
+ } = JSON.parse((res as Buffer).toString());
78
+
79
+ for(let nonceStr in pendingTxs) {
80
+ const nonceData = pendingTxs[nonceStr];
81
+
82
+ const nonce = BigInt(nonceStr);
83
+ if(this.confirmedNonce>=nonce) continue; //Already confirmed
84
+
85
+ if(this.pendingNonce<nonce) {
86
+ this.pendingNonce = nonce;
87
+ }
88
+ const parsedPendingTxns = nonceData.txs.map(StarknetTransactions.deserializeTx);
89
+ this.pendingTxs.set(nonce, {
90
+ txs: parsedPendingTxns,
91
+ lastBumped: nonceData.lastBumped
92
+ })
93
+ for(let tx of parsedPendingTxns) {
94
+ this.chainInterface.Transactions._knownTxSet.add(tx.txId);
95
+ }
96
+ }
97
+ }
98
+ }
99
+
100
+ private priorSavePromise: Promise<void>;
101
+ private saveCount: number = 0;
102
+
103
+ private async save() {
104
+ const pendingTxs: {
105
+ [nonce: string]: {
106
+ txs: string[],
107
+ lastBumped: number
108
+ }
109
+ } = {};
110
+ for(let [nonce, data] of this.pendingTxs) {
111
+ pendingTxs[nonce.toString(10)] = {
112
+ lastBumped: data.lastBumped,
113
+ txs: data.txs.map(StarknetTransactions.serializeTx)
114
+ };
115
+ }
116
+ const requiredSaveCount = ++this.saveCount;
117
+ if(this.priorSavePromise!=null) {
118
+ await this.priorSavePromise;
119
+ }
120
+ if(requiredSaveCount===this.saveCount) {
121
+ this.priorSavePromise = writeFile(this.directory+"/txs.json", JSON.stringify(pendingTxs));
122
+ await this.priorSavePromise;
123
+ }
124
+ }
125
+
126
+ private async checkPastTransactions() {
127
+ let _gasPrice: {l1GasCost: bigint, l2GasCost: bigint, l1DataGasCost: bigint} = null;
128
+ let _safeBlockNonce: bigint = null;
129
+
130
+ for(let [nonce, data] of this.pendingTxs) {
131
+ if(!data.sending && data.lastBumped<Date.now()-this.config.waitBeforeBump) {
132
+ _safeBlockNonce = await this.chainInterface.Transactions.getNonce(this.account.address, BlockTag.LATEST);
133
+ this.confirmedNonce = _safeBlockNonce;
134
+ if(_safeBlockNonce > nonce) {
135
+ this.pendingTxs.delete(nonce);
136
+ data.txs.forEach(tx => this.chainInterface.Transactions._knownTxSet.delete(tx.txId));
137
+ this.logger.info("checkPastTransactions(): Tx confirmed, required fee bumps: ", data.txs.length);
138
+ this.save();
139
+ continue;
140
+ }
141
+
142
+ const lastTx = data.txs[data.txs.length-1];
143
+ if(_gasPrice==null) {
144
+ const feeRate = await this.chainInterface.Fees.getFeeRate();
145
+ _gasPrice = StarknetFees.extractFromFeeRateString(feeRate);
146
+ }
147
+
148
+ let l1GasCost = BigInt(lastTx.details.resourceBounds.l1_gas.max_price_per_unit);
149
+ let l2GasCost = BigInt(lastTx.details.resourceBounds.l2_gas.max_price_per_unit);
150
+ let l1DataGasCost = BigInt(lastTx.details.resourceBounds.l1_data_gas.max_price_per_unit);
151
+ let tip = BigInt(lastTx.details.tip);
152
+
153
+ let feeBumped: boolean = false;
154
+ if(_gasPrice.l1GasCost > l1GasCost) {
155
+ //Bump by minimum allowed or to the actual _gasPrice.l1GasCost
156
+ l1GasCost = bigIntMax(_gasPrice.l1GasCost, this.config.minFeeIncreaseAbsolute + (l1GasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
157
+ feeBumped = true;
158
+ }
159
+ if(_gasPrice.l1DataGasCost > l1DataGasCost) {
160
+ //Bump by minimum allowed or to the actual _gasPrice.l1GasCost
161
+ l1DataGasCost = bigIntMax(_gasPrice.l1DataGasCost, this.config.minFeeIncreaseAbsolute + (l1DataGasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
162
+ feeBumped = true;
163
+ }
164
+ if(_gasPrice.l2GasCost > l2GasCost || feeBumped) { //In case the fees for l1 and l1Data were bumped, we also need to bump the l2GasFee regardless
165
+ l2GasCost = bigIntMax(_gasPrice.l2GasCost, this.config.minFeeIncreaseAbsolute + (l2GasCost * (1_000_000n + this.config.minFeeIncreasePpm) / 1_000_000n));
166
+ feeBumped = true;
167
+ }
168
+ if(feeBumped) tip = this.config.minTipIncreaseAbsolute + (tip * (1_000_000n + this.config.minTipIncreasePpm) / 1_000_000n);
169
+
170
+ if(!feeBumped) {
171
+ //Not fee bumped
172
+ this.logger.debug("checkPastTransactions(): Tx yet unconfirmed but not increasing fee for ", lastTx.txId);
173
+ //Rebroadcast the tx
174
+ await this.chainInterface.Transactions.sendTransaction(lastTx).catch(e => {
175
+ if(e.baseError?.code === 52) { //Invalid transaction nonce
176
+ this.logger.debug("checkPastTransactions(): Tx re-broadcast success, tx already confirmed: ", lastTx.txId);
177
+ return;
178
+ }
179
+ if(e.baseError?.code === 59) { //Transaction already in the mempool
180
+ this.logger.debug("checkPastTransactions(): Tx re-broadcast success, tx already known to the RPC: ", lastTx.txId);
181
+ return;
182
+ }
183
+ this.logger.error("checkPastTransactions(): Tx re-broadcast error", e)
184
+ });
185
+ data.lastBumped = Date.now();
186
+ continue;
187
+ }
188
+
189
+ const newTx = cloneDeep(lastTx);
190
+ delete newTx.signed;
191
+ delete newTx.txId;
192
+
193
+ newTx.details.tip = tip;
194
+ newTx.details.resourceBounds.l1_gas.max_price_per_unit = l1GasCost;
195
+ newTx.details.resourceBounds.l2_gas.max_price_per_unit = l2GasCost;
196
+ newTx.details.resourceBounds.l1_data_gas.max_price_per_unit = l1DataGasCost;
197
+ this.logger.info("checkPastTransactions(): Bump tip to: ", tip);
198
+ this.logger.info("checkPastTransactions(): Bump l1Gas to: ", l1GasCost);
199
+ this.logger.info("checkPastTransactions(): Bump l2Gas to: ", l2GasCost);
200
+ this.logger.info("checkPastTransactions(): Bump l1DataGas to: ", l1DataGasCost);
201
+ this.logger.info("checkPastTransactions(): Bump fee for tx: ", lastTx.txId);
202
+
203
+ await this._signTransaction(newTx);
204
+
205
+ //Double check pending txns still has nonce after async signTransaction was called
206
+ if(!this.pendingTxs.has(nonce)) continue;
207
+
208
+ for(let callback of this.chainInterface.Transactions._cbksBeforeTxReplace) {
209
+ try {
210
+ await callback(StarknetTransactions.serializeTx(lastTx), lastTx.txId, StarknetTransactions.serializeTx(newTx), newTx.txId)
211
+ } catch (e) {
212
+ this.logger.error("checkPastTransactions(): beforeTxReplace callback error: ", e);
213
+ }
214
+ }
215
+
216
+ data.txs.push(newTx);
217
+ data.lastBumped = Date.now();
218
+ this.save();
219
+
220
+ this.chainInterface.Transactions._knownTxSet.add(newTx.txId);
221
+
222
+ //TODO: Better error handling when sending tx
223
+ await this.chainInterface.Transactions.sendTransaction(newTx).catch(e => {
224
+ if(e.baseError?.code === 52) { //Invalid transaction nonce
225
+ return
226
+ }
227
+ this.logger.error("checkPastTransactions(): Fee-bumped tx broadcast error", e)
228
+ });
229
+ }
230
+ }
231
+ }
232
+
233
+ private startFeeBumper() {
234
+ let func: () => Promise<void>;
235
+ func = async () => {
236
+ try {
237
+ await this.checkPastTransactions();
238
+ } catch (e) {
239
+ this.logger.error("startFeeBumper(): Error when check past transactions: ", e);
240
+ }
241
+
242
+ if(this.stopped) return;
243
+
244
+ this.feeBumper = setTimeout(func, 1000);
245
+ };
246
+ func();
247
+ }
248
+
249
+ async init(): Promise<void> {
250
+ try {
251
+ await mkdir(this.directory)
252
+ } catch (e) {}
253
+
254
+ const nonce = await this.chainInterface.Transactions.getNonce(this.account.address, BlockTag.LATEST);
255
+ this.confirmedNonce = nonce - 1n;
256
+ this.pendingNonce = nonce - 1n;
257
+
258
+ await this.load();
259
+
260
+ this.startFeeBumper();
261
+ }
262
+
263
+ stop(): Promise<void> {
264
+ this.stopped = true;
265
+ if(this.feeBumper!=null) {
266
+ clearTimeout(this.feeBumper);
267
+ this.feeBumper = null;
268
+ }
269
+ return Promise.resolve();
270
+ }
271
+
272
+ private readonly sendTransactionQueue: PromiseQueue = new PromiseQueue();
273
+
274
+ sendTransaction(transaction: StarknetTx, onBeforePublish?: (txId: string, rawTx: string) => Promise<void>): Promise<string> {
275
+ return this.sendTransactionQueue.enqueue(async () => {
276
+ if(transaction.details.nonce!=null) {
277
+ if(transaction.details.nonce !== this.pendingNonce + 1n)
278
+ throw new Error("Invalid transaction nonce!");
279
+ } else {
280
+ transaction.details.nonce = this.pendingNonce + 1n;
281
+ }
282
+
283
+ const signedTx = await this._signTransaction(transaction);
284
+
285
+ if(onBeforePublish!=null) {
286
+ try {
287
+ await onBeforePublish(signedTx.txId, StarknetTransactions.serializeTx(signedTx));
288
+ } catch (e) {
289
+ this.logger.error("sendTransaction(): Error when calling onBeforePublish function: ", e);
290
+ }
291
+ }
292
+
293
+ const pendingTxObject = {txs: [signedTx], lastBumped: Date.now(), sending: true};
294
+ this.pendingNonce++;
295
+ this.logger.debug("sendTransaction(): Incrementing pending nonce to: ", this.pendingNonce);
296
+ this.pendingTxs.set(transaction.details.nonce, pendingTxObject);
297
+ this.save();
298
+
299
+ this.chainInterface.Transactions._knownTxSet.add(signedTx.txId);
300
+
301
+ try {
302
+ const result = await this.chainInterface.Transactions.sendTransaction(signedTx);
303
+ pendingTxObject.sending = false;
304
+ return result;
305
+ } catch (e) {
306
+ this.chainInterface.Transactions._knownTxSet.delete(signedTx.txId);
307
+ this.pendingTxs.delete(transaction.details.nonce);
308
+ this.pendingNonce--;
309
+ this.logger.debug("sendTransaction(): Error when broadcasting transaction, reverting pending nonce to: ", this.pendingNonce);
310
+ throw e;
311
+ }
312
+ });
313
+ }
314
+
311
315
  }