@atomiqlabs/chain-starknet 4.0.0-dev.27 → 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 -357
  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 -247
  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 -397
  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 -314
  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,420 +1,420 @@
1
- import {
2
- ChainEvent,
3
- ChainEvents,
4
- ChainSwapType,
5
- ClaimEvent,
6
- EventListener,
7
- InitializeEvent,
8
- RefundEvent, SpvVaultClaimEvent, SpvVaultCloseEvent, SpvVaultDepositEvent, SpvVaultFrontEvent, SpvVaultOpenEvent
9
- } from "@atomiqlabs/base";
10
- import {StarknetSwapData} from "../swaps/StarknetSwapData";
11
- import {
12
- bigNumberishToBuffer,
13
- bytes31SpanToBuffer, findLastIndex,
14
- getLogger,
15
- onceAsync,
16
- parseInitFunctionCalldata, toBigInt,
17
- toHex
18
- } from "../../utils/Utils";
19
- import {StarknetSwapContract} from "../swaps/StarknetSwapContract";
20
- import {BigNumberish, BlockTag, hash, Provider} from "starknet";
21
- import {StarknetAbiEvent} from "../contract/modules/StarknetContractEvents";
22
- import {EscrowManagerAbiType} from "../swaps/EscrowManagerAbi";
23
- import {ExtractAbiFunctionNames} from "abi-wan-kanabi/dist/kanabi";
24
- import {IClaimHandler} from "../swaps/handlers/claim/ClaimHandlers";
25
- import {StarknetSpvVaultContract} from "../spv_swap/StarknetSpvVaultContract";
26
- import {StarknetChainInterface} from "../chain/StarknetChainInterface";
27
- import {SpvVaultContractAbiType} from "../spv_swap/SpvVaultContractAbi";
28
-
29
- export type StarknetTraceCall = {
30
- calldata: string[],
31
- contract_address: string,
32
- entry_point_selector: string,
33
- calls: StarknetTraceCall[]
34
- };
35
-
36
- /**
37
- * Starknet on-chain event handler for front-end systems without access to fs, uses WS or long-polling to subscribe, might lose
38
- * out on some events if the network is unreliable, front-end systems should take this into consideration and not
39
- * rely purely on events
40
- */
41
- export class StarknetChainEventsBrowser implements ChainEvents<StarknetSwapData> {
42
-
43
- protected readonly listeners: EventListener<StarknetSwapData>[] = [];
44
- protected readonly provider: Provider;
45
- protected readonly starknetSwapContract: StarknetSwapContract;
46
- protected readonly starknetSpvVaultContract: StarknetSpvVaultContract;
47
- protected readonly logger = getLogger("StarknetChainEventsBrowser: ");
48
-
49
- protected initFunctionName: ExtractAbiFunctionNames<EscrowManagerAbiType> = "initialize";
50
- protected initEntryPointSelector = BigInt(hash.starknetKeccak(this.initFunctionName));
51
-
52
- protected stopped: boolean;
53
- protected pollIntervalSeconds: number;
54
-
55
- private timeout: any;
56
-
57
- constructor(
58
- chainInterface: StarknetChainInterface,
59
- starknetSwapContract: StarknetSwapContract,
60
- starknetSpvVaultContract: StarknetSpvVaultContract,
61
- pollIntervalSeconds: number = 5
62
- ) {
63
- this.provider = chainInterface.provider;
64
- this.starknetSwapContract = starknetSwapContract;
65
- this.starknetSpvVaultContract = starknetSpvVaultContract;
66
- this.pollIntervalSeconds = pollIntervalSeconds;
67
- }
68
-
69
- findInitSwapData(call: StarknetTraceCall, escrowHash: BigNumberish, claimHandler: IClaimHandler<any, any>): StarknetSwapData {
70
- if(
71
- BigInt(call.contract_address)===BigInt(this.starknetSwapContract.contract.address) &&
72
- BigInt(call.entry_point_selector)===this.initEntryPointSelector
73
- ) {
74
- //Found, check correct escrow hash
75
- const {escrow, extraData} = parseInitFunctionCalldata(call.calldata, claimHandler);
76
- if("0x"+escrow.getEscrowHash()===toHex(escrowHash)) {
77
- if(extraData.length!==0) {
78
- escrow.setExtraData(bytes31SpanToBuffer(extraData, 42).toString("hex"));
79
- }
80
- return escrow;
81
- }
82
- }
83
- for(let _call of call.calls) {
84
- const found = this.findInitSwapData(_call, escrowHash, claimHandler);
85
- if(found!=null) return found;
86
- }
87
- return null;
88
- }
89
-
90
- /**
91
- * Returns async getter for fetching on-demand initialize event swap data
92
- *
93
- * @param event
94
- * @param claimHandler
95
- * @private
96
- * @returns {() => Promise<StarknetSwapData>} getter to be passed to InitializeEvent constructor
97
- */
98
- private getSwapDataGetter(
99
- event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Initialize">,
100
- claimHandler: IClaimHandler<any, any>
101
- ): () => Promise<StarknetSwapData> {
102
- return async () => {
103
- let trace: any;
104
- try {
105
- trace = await this.provider.getTransactionTrace(event.txHash);
106
- } catch (e) {
107
- this.logger.warn("getSwapDataGetter(): getter: starknet_traceTransaction not supported by the RPC: ", e);
108
- const blockTraces: any[] = await this.provider.getBlockTransactionsTraces(event.blockHash);
109
- const foundTrace = blockTraces.find(val => toHex(val.transaction_hash)===toHex(event.txHash));
110
- if(foundTrace==null) throw new Error(`Cannot find ${event.txHash} in the block traces, block: ${event.blockHash}`);
111
- trace = foundTrace.trace_root;
112
- }
113
- if(trace==null) return null;
114
- if(trace.execute_invocation.revert_reason!=null) return null;
115
- return this.findInitSwapData(trace.execute_invocation as any, event.params.escrow_hash, claimHandler);
116
- }
117
- }
118
-
119
- protected parseInitializeEvent(
120
- event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Initialize">
121
- ): InitializeEvent<StarknetSwapData> {
122
- const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
123
- const escrowHash = escrowHashBuffer.toString("hex");
124
- const claimHandlerHex = toHex(event.params.claim_handler);
125
- const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
126
- if(claimHandler==null) {
127
- this.logger.warn("parseInitializeEvent("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
128
- return null;
129
- }
130
- const swapType: ChainSwapType = claimHandler.getType();
131
-
132
- this.logger.debug("InitializeEvent claimHash: "+toHex(event.params.claim_data)+" escrowHash: "+escrowHash);
133
- return new InitializeEvent<StarknetSwapData>(
134
- escrowHash,
135
- swapType,
136
- onceAsync<StarknetSwapData>(this.getSwapDataGetter(event, claimHandler))
137
- );
138
- }
139
-
140
- protected parseRefundEvent(
141
- event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Refund">
142
- ): RefundEvent<StarknetSwapData> {
143
- const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
144
- const escrowHash = escrowHashBuffer.toString("hex");
145
- this.logger.debug("RefundEvent claimHash: "+toHex(event.params.claim_data)+" escrowHash: "+escrowHash);
146
- return new RefundEvent<StarknetSwapData>(escrowHash);
147
- }
148
-
149
- protected parseClaimEvent(
150
- event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Claim">
151
- ): ClaimEvent<StarknetSwapData> {
152
- const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
153
- const escrowHash = escrowHashBuffer.toString("hex");
154
- const claimHandlerHex = toHex(event.params.claim_handler);
155
- const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
156
- if(claimHandler==null) {
157
- this.logger.warn("parseClaimEvent("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
158
- return null;
159
- }
160
- const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
161
- this.logger.debug("ClaimEvent claimHash: "+toHex(event.params.claim_data)+
162
- " witnessResult: "+witnessResult+" escrowHash: "+escrowHash);
163
- return new ClaimEvent<StarknetSwapData>(escrowHash, witnessResult);
164
- }
165
-
166
- protected parseSpvOpenEvent(
167
- event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Opened">
168
- ): SpvVaultOpenEvent {
169
- const owner = toHex(event.params.owner);
170
- const vaultId = toBigInt(event.params.vault_id);
171
- const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
172
- const vout = Number(toBigInt(event.params.vout));
173
-
174
- this.logger.debug("SpvOpenEvent owner: "+owner+" vaultId: "+vaultId+" utxo: "+btcTxId+":"+vout);
175
- return new SpvVaultOpenEvent(owner, vaultId, btcTxId, vout);
176
- }
177
-
178
- protected parseSpvDepositEvent(
179
- event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Deposited">
180
- ): SpvVaultDepositEvent {
181
- const owner = toHex(event.params.owner);
182
- const vaultId = toBigInt(event.params.vault_id);
183
- const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
184
- const depositCount = Number(toBigInt(event.params.deposit_count));
185
-
186
- this.logger.debug("SpvDepositEvent owner: "+owner+" vaultId: "+vaultId+" depositCount: "+depositCount+" amounts: ", amounts);
187
- return new SpvVaultDepositEvent(owner, vaultId, amounts, depositCount);
188
- }
189
-
190
- protected parseSpvFrontEvent(
191
- event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Fronted">
192
- ): SpvVaultFrontEvent {
193
- const owner = toHex(event.params.owner);
194
- const vaultId = toBigInt(event.params.vault_id);
195
- const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
196
- const recipient = toHex(event.params.recipient);
197
- const executionHash = toHex(event.params.execution_hash);
198
- const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
199
- const frontingAddress = toHex(event.params.caller);
200
-
201
- this.logger.debug("SpvFrontEvent owner: "+owner+" vaultId: "+vaultId+" btcTxId: "+btcTxId+
202
- " recipient: "+recipient+" frontedBy: "+frontingAddress+" amounts: ", amounts);
203
- return new SpvVaultFrontEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, frontingAddress);
204
- }
205
-
206
- protected parseSpvClaimEvent(
207
- event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Claimed">
208
- ): SpvVaultClaimEvent {
209
- const owner = toHex(event.params.owner);
210
- const vaultId = toBigInt(event.params.vault_id);
211
- const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
212
- const recipient = toHex(event.params.recipient);
213
- const executionHash = toHex(event.params.execution_hash);
214
- const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
215
- const caller = toHex(event.params.caller);
216
- const frontingAddress = toHex(event.params.fronting_address);
217
- const withdrawCount = Number(toBigInt(event.params.withdraw_count));
218
-
219
- this.logger.debug("SpvClaimEvent owner: "+owner+" vaultId: "+vaultId+" btcTxId: "+btcTxId+" withdrawCount: "+withdrawCount+
220
- " recipient: "+recipient+" frontedBy: "+frontingAddress+" claimedBy: "+caller+" amounts: ", amounts);
221
- return new SpvVaultClaimEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, caller, frontingAddress, withdrawCount);
222
- }
223
-
224
- protected parseSpvCloseEvent(
225
- event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Closed">
226
- ): SpvVaultCloseEvent {
227
- const owner = toHex(event.params.owner);
228
- const vaultId = toBigInt(event.params.vault_id);
229
- const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
230
- const error = bigNumberishToBuffer(event.params.error).toString();
231
-
232
- return new SpvVaultCloseEvent(owner, vaultId, btcTxId, error);
233
- }
234
-
235
- /**
236
- * Processes event as received from the chain, parses it & calls event listeners
237
- *
238
- * @param events
239
- * @param currentBlockNumber
240
- * @param currentBlockTimestamp
241
- * @protected
242
- */
243
- protected async processEvents(
244
- events : (StarknetAbiEvent<
245
- EscrowManagerAbiType,
246
- "escrow_manager::events::Initialize" | "escrow_manager::events::Refund" | "escrow_manager::events::Claim"
247
- > | StarknetAbiEvent<
248
- SpvVaultContractAbiType,
249
- "spv_swap_vault::events::Opened" | "spv_swap_vault::events::Deposited" | "spv_swap_vault::events::Fronted" | "spv_swap_vault::events::Claimed" | "spv_swap_vault::events::Closed"
250
- >)[],
251
- currentBlockNumber: number,
252
- currentBlockTimestamp: number
253
- ) {
254
- const blockTimestampsCache: {[blockNumber: string]: number} = {};
255
- const getBlockTimestamp: (blockNumber: number) => Promise<number> = async (blockNumber: number)=> {
256
- if(blockNumber===currentBlockNumber) return currentBlockTimestamp;
257
- const blockNumberString = blockNumber.toString();
258
- blockTimestampsCache[blockNumberString] ??= (await this.provider.getBlockWithTxHashes(blockNumber)).timestamp;
259
- return blockTimestampsCache[blockNumberString];
260
- }
261
-
262
- const parsedEvents: ChainEvent<StarknetSwapData>[] = [];
263
-
264
- for(let event of events) {
265
- let parsedEvent: ChainEvent<StarknetSwapData>;
266
- switch(event.name) {
267
- case "escrow_manager::events::Claim":
268
- parsedEvent = this.parseClaimEvent(event as any);
269
- break;
270
- case "escrow_manager::events::Refund":
271
- parsedEvent = this.parseRefundEvent(event as any);
272
- break;
273
- case "escrow_manager::events::Initialize":
274
- parsedEvent = this.parseInitializeEvent(event as any);
275
- break;
276
- case "spv_swap_vault::events::Opened":
277
- parsedEvent = this.parseSpvOpenEvent(event as any);
278
- break;
279
- case "spv_swap_vault::events::Deposited":
280
- parsedEvent = this.parseSpvDepositEvent(event as any);
281
- break;
282
- case "spv_swap_vault::events::Fronted":
283
- parsedEvent = this.parseSpvFrontEvent(event as any);
284
- break;
285
- case "spv_swap_vault::events::Claimed":
286
- parsedEvent = this.parseSpvClaimEvent(event as any);
287
- break;
288
- case "spv_swap_vault::events::Closed":
289
- parsedEvent = this.parseSpvCloseEvent(event as any);
290
- break;
291
- }
292
- if(parsedEvent==null) continue;
293
- //We are not trusting pre-confs for events, so this shall never happen
294
- if(event.blockNumber==null) throw new Error("Event block number cannot be null!");
295
- const timestamp = await getBlockTimestamp(event.blockNumber);
296
- parsedEvent.meta = {
297
- blockTime: timestamp,
298
- txId: event.txHash,
299
- timestamp //Maybe deprecated
300
- } as any;
301
- parsedEvents.push(parsedEvent);
302
- }
303
-
304
- for(let listener of this.listeners) {
305
- await listener(parsedEvents);
306
- }
307
- }
308
-
309
- protected async checkEventsEcrowManager(lastTxHash: string, lastBlockNumber?: number, currentBlock?: {timestamp: number, block_number: number}): Promise<string> {
310
- const currentBlockNumber: number = (currentBlock as any).block_number;
311
- lastBlockNumber ??= currentBlockNumber;
312
- // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
313
- let events = await this.starknetSwapContract.Events.getContractBlockEvents(
314
- ["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"],
315
- [],
316
- lastBlockNumber,
317
- null
318
- );
319
- if(lastTxHash!=null) {
320
- const latestProcessedEventIndex = findLastIndex(events, val => val.txHash===lastTxHash);
321
- if(latestProcessedEventIndex!==-1) {
322
- events.splice(0, latestProcessedEventIndex+1);
323
- // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
324
- }
325
- }
326
- if(events.length>0) {
327
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
328
- lastTxHash = events[events.length-1].txHash;
329
- }
330
- return lastTxHash;
331
- }
332
-
333
- protected async checkEventsSpvVaults(lastTxHash: string, lastBlockNumber?: number, currentBlock?: {timestamp: number, block_number: number}): Promise<string> {
334
- const currentBlockNumber: number = (currentBlock as any).block_number;
335
- lastBlockNumber ??= currentBlockNumber;
336
- // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
337
- let events = await this.starknetSpvVaultContract.Events.getContractBlockEvents(
338
- ["spv_swap_vault::events::Opened", "spv_swap_vault::events::Deposited", "spv_swap_vault::events::Closed", "spv_swap_vault::events::Fronted", "spv_swap_vault::events::Claimed"],
339
- [],
340
- lastBlockNumber,
341
- null
342
- );
343
- if(lastTxHash!=null) {
344
- const latestProcessedEventIndex = findLastIndex(events, val => val.txHash===lastTxHash);
345
- if(latestProcessedEventIndex!==-1) {
346
- events.splice(0, latestProcessedEventIndex+1);
347
- // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
348
- }
349
- }
350
- if(events.length>0) {
351
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
352
- lastTxHash = events[events.length-1].txHash;
353
- }
354
- return lastTxHash;
355
- }
356
-
357
- protected async checkEvents(lastBlockNumber: number, lastTxHashes: string[]): Promise<{txHashes: string[], blockNumber: number}> {
358
- lastTxHashes ??= [];
359
-
360
- const currentBlock = await this.provider.getBlockWithTxHashes(BlockTag.LATEST);
361
- const currentBlockNumber: number = currentBlock.block_number;
362
-
363
- lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock as any);
364
- lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock as any);
365
-
366
- return {
367
- txHashes: lastTxHashes,
368
- blockNumber: currentBlockNumber
369
- };
370
- }
371
-
372
- /**
373
- * Sets up event handlers listening for swap events over websocket
374
- *
375
- * @protected
376
- */
377
- protected async setupPoll(
378
- lastBlockNumber?: number,
379
- lastTxHashes?: string[],
380
- saveLatestProcessedBlockNumber?: (blockNumber: number, lastTxHashes: string[]) => Promise<void>
381
- ) {
382
- this.stopped = false;
383
- let func;
384
- func = async () => {
385
- await this.checkEvents(lastBlockNumber, lastTxHashes).then(({blockNumber, txHashes}) => {
386
- lastBlockNumber = blockNumber;
387
- lastTxHashes = txHashes;
388
- if(saveLatestProcessedBlockNumber!=null) return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
389
- }).catch(e => {
390
- this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
391
- });
392
- if(this.stopped) return;
393
- this.timeout = setTimeout(func, this.pollIntervalSeconds*1000);
394
- };
395
- await func();
396
- }
397
-
398
- init(): Promise<void> {
399
- this.setupPoll();
400
- return Promise.resolve();
401
- }
402
-
403
- async stop(): Promise<void> {
404
- this.stopped = true;
405
- if(this.timeout!=null) clearTimeout(this.timeout);
406
- }
407
-
408
- registerListener(cbk: EventListener<StarknetSwapData>): void {
409
- this.listeners.push(cbk);
410
- }
411
-
412
- unregisterListener(cbk: EventListener<StarknetSwapData>): boolean {
413
- const index = this.listeners.indexOf(cbk);
414
- if(index>=0) {
415
- this.listeners.splice(index, 1);
416
- return true;
417
- }
418
- return false;
419
- }
420
- }
1
+ import {
2
+ ChainEvent,
3
+ ChainEvents,
4
+ ChainSwapType,
5
+ ClaimEvent,
6
+ EventListener,
7
+ InitializeEvent,
8
+ RefundEvent, SpvVaultClaimEvent, SpvVaultCloseEvent, SpvVaultDepositEvent, SpvVaultFrontEvent, SpvVaultOpenEvent
9
+ } from "@atomiqlabs/base";
10
+ import {StarknetSwapData} from "../swaps/StarknetSwapData";
11
+ import {
12
+ bigNumberishToBuffer,
13
+ bytes31SpanToBuffer, findLastIndex,
14
+ getLogger,
15
+ onceAsync,
16
+ parseInitFunctionCalldata, toBigInt,
17
+ toHex
18
+ } from "../../utils/Utils";
19
+ import {StarknetSwapContract} from "../swaps/StarknetSwapContract";
20
+ import {BigNumberish, BlockTag, hash, Provider} from "starknet";
21
+ import {StarknetAbiEvent} from "../contract/modules/StarknetContractEvents";
22
+ import {EscrowManagerAbiType} from "../swaps/EscrowManagerAbi";
23
+ import {ExtractAbiFunctionNames} from "abi-wan-kanabi/dist/kanabi";
24
+ import {IClaimHandler} from "../swaps/handlers/claim/ClaimHandlers";
25
+ import {StarknetSpvVaultContract} from "../spv_swap/StarknetSpvVaultContract";
26
+ import {StarknetChainInterface} from "../chain/StarknetChainInterface";
27
+ import {SpvVaultContractAbiType} from "../spv_swap/SpvVaultContractAbi";
28
+
29
+ export type StarknetTraceCall = {
30
+ calldata: string[],
31
+ contract_address: string,
32
+ entry_point_selector: string,
33
+ calls: StarknetTraceCall[]
34
+ };
35
+
36
+ /**
37
+ * Starknet on-chain event handler for front-end systems without access to fs, uses WS or long-polling to subscribe, might lose
38
+ * out on some events if the network is unreliable, front-end systems should take this into consideration and not
39
+ * rely purely on events
40
+ */
41
+ export class StarknetChainEventsBrowser implements ChainEvents<StarknetSwapData> {
42
+
43
+ protected readonly listeners: EventListener<StarknetSwapData>[] = [];
44
+ protected readonly provider: Provider;
45
+ protected readonly starknetSwapContract: StarknetSwapContract;
46
+ protected readonly starknetSpvVaultContract: StarknetSpvVaultContract;
47
+ protected readonly logger = getLogger("StarknetChainEventsBrowser: ");
48
+
49
+ protected initFunctionName: ExtractAbiFunctionNames<EscrowManagerAbiType> = "initialize";
50
+ protected initEntryPointSelector = BigInt(hash.starknetKeccak(this.initFunctionName));
51
+
52
+ protected stopped: boolean;
53
+ protected pollIntervalSeconds: number;
54
+
55
+ private timeout: any;
56
+
57
+ constructor(
58
+ chainInterface: StarknetChainInterface,
59
+ starknetSwapContract: StarknetSwapContract,
60
+ starknetSpvVaultContract: StarknetSpvVaultContract,
61
+ pollIntervalSeconds: number = 5
62
+ ) {
63
+ this.provider = chainInterface.provider;
64
+ this.starknetSwapContract = starknetSwapContract;
65
+ this.starknetSpvVaultContract = starknetSpvVaultContract;
66
+ this.pollIntervalSeconds = pollIntervalSeconds;
67
+ }
68
+
69
+ findInitSwapData(call: StarknetTraceCall, escrowHash: BigNumberish, claimHandler: IClaimHandler<any, any>): StarknetSwapData {
70
+ if(
71
+ BigInt(call.contract_address)===BigInt(this.starknetSwapContract.contract.address) &&
72
+ BigInt(call.entry_point_selector)===this.initEntryPointSelector
73
+ ) {
74
+ //Found, check correct escrow hash
75
+ const {escrow, extraData} = parseInitFunctionCalldata(call.calldata, claimHandler);
76
+ if("0x"+escrow.getEscrowHash()===toHex(escrowHash)) {
77
+ if(extraData.length!==0) {
78
+ escrow.setExtraData(bytes31SpanToBuffer(extraData, 42).toString("hex"));
79
+ }
80
+ return escrow;
81
+ }
82
+ }
83
+ for(let _call of call.calls) {
84
+ const found = this.findInitSwapData(_call, escrowHash, claimHandler);
85
+ if(found!=null) return found;
86
+ }
87
+ return null;
88
+ }
89
+
90
+ /**
91
+ * Returns async getter for fetching on-demand initialize event swap data
92
+ *
93
+ * @param event
94
+ * @param claimHandler
95
+ * @private
96
+ * @returns {() => Promise<StarknetSwapData>} getter to be passed to InitializeEvent constructor
97
+ */
98
+ private getSwapDataGetter(
99
+ event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Initialize">,
100
+ claimHandler: IClaimHandler<any, any>
101
+ ): () => Promise<StarknetSwapData> {
102
+ return async () => {
103
+ let trace: any;
104
+ try {
105
+ trace = await this.provider.getTransactionTrace(event.txHash);
106
+ } catch (e) {
107
+ this.logger.warn("getSwapDataGetter(): getter: starknet_traceTransaction not supported by the RPC: ", e);
108
+ const blockTraces: any[] = await this.provider.getBlockTransactionsTraces(event.blockHash);
109
+ const foundTrace = blockTraces.find(val => toHex(val.transaction_hash)===toHex(event.txHash));
110
+ if(foundTrace==null) throw new Error(`Cannot find ${event.txHash} in the block traces, block: ${event.blockHash}`);
111
+ trace = foundTrace.trace_root;
112
+ }
113
+ if(trace==null) return null;
114
+ if(trace.execute_invocation.revert_reason!=null) return null;
115
+ return this.findInitSwapData(trace.execute_invocation as any, event.params.escrow_hash, claimHandler);
116
+ }
117
+ }
118
+
119
+ protected parseInitializeEvent(
120
+ event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Initialize">
121
+ ): InitializeEvent<StarknetSwapData> {
122
+ const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
123
+ const escrowHash = escrowHashBuffer.toString("hex");
124
+ const claimHandlerHex = toHex(event.params.claim_handler);
125
+ const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
126
+ if(claimHandler==null) {
127
+ this.logger.warn("parseInitializeEvent("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
128
+ return null;
129
+ }
130
+ const swapType: ChainSwapType = claimHandler.getType();
131
+
132
+ this.logger.debug("InitializeEvent claimHash: "+toHex(event.params.claim_data)+" escrowHash: "+escrowHash);
133
+ return new InitializeEvent<StarknetSwapData>(
134
+ escrowHash,
135
+ swapType,
136
+ onceAsync<StarknetSwapData>(this.getSwapDataGetter(event, claimHandler))
137
+ );
138
+ }
139
+
140
+ protected parseRefundEvent(
141
+ event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Refund">
142
+ ): RefundEvent<StarknetSwapData> {
143
+ const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
144
+ const escrowHash = escrowHashBuffer.toString("hex");
145
+ this.logger.debug("RefundEvent claimHash: "+toHex(event.params.claim_data)+" escrowHash: "+escrowHash);
146
+ return new RefundEvent<StarknetSwapData>(escrowHash);
147
+ }
148
+
149
+ protected parseClaimEvent(
150
+ event: StarknetAbiEvent<EscrowManagerAbiType, "escrow_manager::events::Claim">
151
+ ): ClaimEvent<StarknetSwapData> {
152
+ const escrowHashBuffer = bigNumberishToBuffer(event.params.escrow_hash, 32);
153
+ const escrowHash = escrowHashBuffer.toString("hex");
154
+ const claimHandlerHex = toHex(event.params.claim_handler);
155
+ const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
156
+ if(claimHandler==null) {
157
+ this.logger.warn("parseClaimEvent("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
158
+ return null;
159
+ }
160
+ const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
161
+ this.logger.debug("ClaimEvent claimHash: "+toHex(event.params.claim_data)+
162
+ " witnessResult: "+witnessResult+" escrowHash: "+escrowHash);
163
+ return new ClaimEvent<StarknetSwapData>(escrowHash, witnessResult);
164
+ }
165
+
166
+ protected parseSpvOpenEvent(
167
+ event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Opened">
168
+ ): SpvVaultOpenEvent {
169
+ const owner = toHex(event.params.owner);
170
+ const vaultId = toBigInt(event.params.vault_id);
171
+ const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
172
+ const vout = Number(toBigInt(event.params.vout));
173
+
174
+ this.logger.debug("SpvOpenEvent owner: "+owner+" vaultId: "+vaultId+" utxo: "+btcTxId+":"+vout);
175
+ return new SpvVaultOpenEvent(owner, vaultId, btcTxId, vout);
176
+ }
177
+
178
+ protected parseSpvDepositEvent(
179
+ event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Deposited">
180
+ ): SpvVaultDepositEvent {
181
+ const owner = toHex(event.params.owner);
182
+ const vaultId = toBigInt(event.params.vault_id);
183
+ const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
184
+ const depositCount = Number(toBigInt(event.params.deposit_count));
185
+
186
+ this.logger.debug("SpvDepositEvent owner: "+owner+" vaultId: "+vaultId+" depositCount: "+depositCount+" amounts: ", amounts);
187
+ return new SpvVaultDepositEvent(owner, vaultId, amounts, depositCount);
188
+ }
189
+
190
+ protected parseSpvFrontEvent(
191
+ event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Fronted">
192
+ ): SpvVaultFrontEvent {
193
+ const owner = toHex(event.params.owner);
194
+ const vaultId = toBigInt(event.params.vault_id);
195
+ const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
196
+ const recipient = toHex(event.params.recipient);
197
+ const executionHash = toHex(event.params.execution_hash);
198
+ const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
199
+ const frontingAddress = toHex(event.params.caller);
200
+
201
+ this.logger.debug("SpvFrontEvent owner: "+owner+" vaultId: "+vaultId+" btcTxId: "+btcTxId+
202
+ " recipient: "+recipient+" frontedBy: "+frontingAddress+" amounts: ", amounts);
203
+ return new SpvVaultFrontEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, frontingAddress);
204
+ }
205
+
206
+ protected parseSpvClaimEvent(
207
+ event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Claimed">
208
+ ): SpvVaultClaimEvent {
209
+ const owner = toHex(event.params.owner);
210
+ const vaultId = toBigInt(event.params.vault_id);
211
+ const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
212
+ const recipient = toHex(event.params.recipient);
213
+ const executionHash = toHex(event.params.execution_hash);
214
+ const amounts = [toBigInt(event.params.amounts["0"] as BigNumberish), toBigInt(event.params.amounts["1"] as BigNumberish)];
215
+ const caller = toHex(event.params.caller);
216
+ const frontingAddress = toHex(event.params.fronting_address);
217
+ const withdrawCount = Number(toBigInt(event.params.withdraw_count));
218
+
219
+ this.logger.debug("SpvClaimEvent owner: "+owner+" vaultId: "+vaultId+" btcTxId: "+btcTxId+" withdrawCount: "+withdrawCount+
220
+ " recipient: "+recipient+" frontedBy: "+frontingAddress+" claimedBy: "+caller+" amounts: ", amounts);
221
+ return new SpvVaultClaimEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, caller, frontingAddress, withdrawCount);
222
+ }
223
+
224
+ protected parseSpvCloseEvent(
225
+ event: StarknetAbiEvent<SpvVaultContractAbiType, "spv_swap_vault::events::Closed">
226
+ ): SpvVaultCloseEvent {
227
+ const owner = toHex(event.params.owner);
228
+ const vaultId = toBigInt(event.params.vault_id);
229
+ const btcTxId = bigNumberishToBuffer(event.params.btc_tx_hash, 32).reverse().toString("hex");
230
+ const error = bigNumberishToBuffer(event.params.error).toString();
231
+
232
+ return new SpvVaultCloseEvent(owner, vaultId, btcTxId, error);
233
+ }
234
+
235
+ /**
236
+ * Processes event as received from the chain, parses it & calls event listeners
237
+ *
238
+ * @param events
239
+ * @param currentBlockNumber
240
+ * @param currentBlockTimestamp
241
+ * @protected
242
+ */
243
+ protected async processEvents(
244
+ events : (StarknetAbiEvent<
245
+ EscrowManagerAbiType,
246
+ "escrow_manager::events::Initialize" | "escrow_manager::events::Refund" | "escrow_manager::events::Claim"
247
+ > | StarknetAbiEvent<
248
+ SpvVaultContractAbiType,
249
+ "spv_swap_vault::events::Opened" | "spv_swap_vault::events::Deposited" | "spv_swap_vault::events::Fronted" | "spv_swap_vault::events::Claimed" | "spv_swap_vault::events::Closed"
250
+ >)[],
251
+ currentBlockNumber: number,
252
+ currentBlockTimestamp: number
253
+ ) {
254
+ const blockTimestampsCache: {[blockNumber: string]: number} = {};
255
+ const getBlockTimestamp: (blockNumber: number) => Promise<number> = async (blockNumber: number)=> {
256
+ if(blockNumber===currentBlockNumber) return currentBlockTimestamp;
257
+ const blockNumberString = blockNumber.toString();
258
+ blockTimestampsCache[blockNumberString] ??= (await this.provider.getBlockWithTxHashes(blockNumber)).timestamp;
259
+ return blockTimestampsCache[blockNumberString];
260
+ }
261
+
262
+ const parsedEvents: ChainEvent<StarknetSwapData>[] = [];
263
+
264
+ for(let event of events) {
265
+ let parsedEvent: ChainEvent<StarknetSwapData>;
266
+ switch(event.name) {
267
+ case "escrow_manager::events::Claim":
268
+ parsedEvent = this.parseClaimEvent(event as any);
269
+ break;
270
+ case "escrow_manager::events::Refund":
271
+ parsedEvent = this.parseRefundEvent(event as any);
272
+ break;
273
+ case "escrow_manager::events::Initialize":
274
+ parsedEvent = this.parseInitializeEvent(event as any);
275
+ break;
276
+ case "spv_swap_vault::events::Opened":
277
+ parsedEvent = this.parseSpvOpenEvent(event as any);
278
+ break;
279
+ case "spv_swap_vault::events::Deposited":
280
+ parsedEvent = this.parseSpvDepositEvent(event as any);
281
+ break;
282
+ case "spv_swap_vault::events::Fronted":
283
+ parsedEvent = this.parseSpvFrontEvent(event as any);
284
+ break;
285
+ case "spv_swap_vault::events::Claimed":
286
+ parsedEvent = this.parseSpvClaimEvent(event as any);
287
+ break;
288
+ case "spv_swap_vault::events::Closed":
289
+ parsedEvent = this.parseSpvCloseEvent(event as any);
290
+ break;
291
+ }
292
+ if(parsedEvent==null) continue;
293
+ //We are not trusting pre-confs for events, so this shall never happen
294
+ if(event.blockNumber==null) throw new Error("Event block number cannot be null!");
295
+ const timestamp = await getBlockTimestamp(event.blockNumber);
296
+ parsedEvent.meta = {
297
+ blockTime: timestamp,
298
+ txId: event.txHash,
299
+ timestamp //Maybe deprecated
300
+ } as any;
301
+ parsedEvents.push(parsedEvent);
302
+ }
303
+
304
+ for(let listener of this.listeners) {
305
+ await listener(parsedEvents);
306
+ }
307
+ }
308
+
309
+ protected async checkEventsEcrowManager(lastTxHash: string, lastBlockNumber?: number, currentBlock?: {timestamp: number, block_number: number}): Promise<string> {
310
+ const currentBlockNumber: number = (currentBlock as any).block_number;
311
+ lastBlockNumber ??= currentBlockNumber;
312
+ // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
313
+ let events = await this.starknetSwapContract.Events.getContractBlockEvents(
314
+ ["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"],
315
+ [],
316
+ lastBlockNumber,
317
+ null
318
+ );
319
+ if(lastTxHash!=null) {
320
+ const latestProcessedEventIndex = findLastIndex(events, val => val.txHash===lastTxHash);
321
+ if(latestProcessedEventIndex!==-1) {
322
+ events.splice(0, latestProcessedEventIndex+1);
323
+ // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
324
+ }
325
+ }
326
+ if(events.length>0) {
327
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
328
+ lastTxHash = events[events.length-1].txHash;
329
+ }
330
+ return lastTxHash;
331
+ }
332
+
333
+ protected async checkEventsSpvVaults(lastTxHash: string, lastBlockNumber?: number, currentBlock?: {timestamp: number, block_number: number}): Promise<string> {
334
+ const currentBlockNumber: number = (currentBlock as any).block_number;
335
+ lastBlockNumber ??= currentBlockNumber;
336
+ // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
337
+ let events = await this.starknetSpvVaultContract.Events.getContractBlockEvents(
338
+ ["spv_swap_vault::events::Opened", "spv_swap_vault::events::Deposited", "spv_swap_vault::events::Closed", "spv_swap_vault::events::Fronted", "spv_swap_vault::events::Claimed"],
339
+ [],
340
+ lastBlockNumber,
341
+ null
342
+ );
343
+ if(lastTxHash!=null) {
344
+ const latestProcessedEventIndex = findLastIndex(events, val => val.txHash===lastTxHash);
345
+ if(latestProcessedEventIndex!==-1) {
346
+ events.splice(0, latestProcessedEventIndex+1);
347
+ // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
348
+ }
349
+ }
350
+ if(events.length>0) {
351
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
352
+ lastTxHash = events[events.length-1].txHash;
353
+ }
354
+ return lastTxHash;
355
+ }
356
+
357
+ protected async checkEvents(lastBlockNumber: number, lastTxHashes: string[]): Promise<{txHashes: string[], blockNumber: number}> {
358
+ lastTxHashes ??= [];
359
+
360
+ const currentBlock = await this.provider.getBlockWithTxHashes(BlockTag.LATEST);
361
+ const currentBlockNumber: number = currentBlock.block_number;
362
+
363
+ lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock as any);
364
+ lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock as any);
365
+
366
+ return {
367
+ txHashes: lastTxHashes,
368
+ blockNumber: currentBlockNumber
369
+ };
370
+ }
371
+
372
+ /**
373
+ * Sets up event handlers listening for swap events over websocket
374
+ *
375
+ * @protected
376
+ */
377
+ protected async setupPoll(
378
+ lastBlockNumber?: number,
379
+ lastTxHashes?: string[],
380
+ saveLatestProcessedBlockNumber?: (blockNumber: number, lastTxHashes: string[]) => Promise<void>
381
+ ) {
382
+ this.stopped = false;
383
+ let func;
384
+ func = async () => {
385
+ await this.checkEvents(lastBlockNumber, lastTxHashes).then(({blockNumber, txHashes}) => {
386
+ lastBlockNumber = blockNumber;
387
+ lastTxHashes = txHashes;
388
+ if(saveLatestProcessedBlockNumber!=null) return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
389
+ }).catch(e => {
390
+ this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
391
+ });
392
+ if(this.stopped) return;
393
+ this.timeout = setTimeout(func, this.pollIntervalSeconds*1000);
394
+ };
395
+ await func();
396
+ }
397
+
398
+ init(): Promise<void> {
399
+ this.setupPoll();
400
+ return Promise.resolve();
401
+ }
402
+
403
+ async stop(): Promise<void> {
404
+ this.stopped = true;
405
+ if(this.timeout!=null) clearTimeout(this.timeout);
406
+ }
407
+
408
+ registerListener(cbk: EventListener<StarknetSwapData>): void {
409
+ this.listeners.push(cbk);
410
+ }
411
+
412
+ unregisterListener(cbk: EventListener<StarknetSwapData>): boolean {
413
+ const index = this.listeners.indexOf(cbk);
414
+ if(index>=0) {
415
+ this.listeners.splice(index, 1);
416
+ return true;
417
+ }
418
+ return false;
419
+ }
420
+ }