@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,294 +1,292 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.StarknetChainEventsBrowser = void 0;
4
- const base_1 = require("@atomiqlabs/base");
5
- const Utils_1 = require("../../utils/Utils");
6
- const starknet_1 = require("starknet");
7
- /**
8
- * Solana on-chain event handler for front-end systems without access to fs, uses pure WS to subscribe, might lose
9
- * out on some events if the network is unreliable, front-end systems should take this into consideration and not
10
- * rely purely on events
11
- */
12
- class StarknetChainEventsBrowser {
13
- constructor(chainInterface, starknetSwapContract, starknetSpvVaultContract, pollIntervalSeconds = 5) {
14
- this.listeners = [];
15
- this.eventListeners = [];
16
- this.logger = (0, Utils_1.getLogger)("StarknetChainEventsBrowser: ");
17
- this.initFunctionName = "initialize";
18
- this.initEntryPointSelector = BigInt(starknet_1.hash.starknetKeccak(this.initFunctionName));
19
- this.provider = chainInterface.provider;
20
- this.starknetSwapContract = starknetSwapContract;
21
- this.starknetSpvVaultContract = starknetSpvVaultContract;
22
- this.pollIntervalSeconds = pollIntervalSeconds;
23
- }
24
- findInitSwapData(call, escrowHash, claimHandler) {
25
- if (BigInt(call.contract_address) === BigInt(this.starknetSwapContract.contract.address) &&
26
- BigInt(call.entry_point_selector) === this.initEntryPointSelector) {
27
- //Found, check correct escrow hash
28
- const { escrow, extraData } = (0, Utils_1.parseInitFunctionCalldata)(call.calldata, claimHandler);
29
- if ("0x" + escrow.getEscrowHash() === (0, Utils_1.toHex)(escrowHash)) {
30
- if (extraData.length !== 0) {
31
- escrow.setExtraData((0, Utils_1.bytes31SpanToBuffer)(extraData, 42).toString("hex"));
32
- }
33
- return escrow;
34
- }
35
- }
36
- for (let _call of call.calls) {
37
- const found = this.findInitSwapData(_call, escrowHash, claimHandler);
38
- if (found != null)
39
- return found;
40
- }
41
- return null;
42
- }
43
- /**
44
- * Returns async getter for fetching on-demand initialize event swap data
45
- *
46
- * @param event
47
- * @param claimHandler
48
- * @private
49
- * @returns {() => Promise<StarknetSwapData>} getter to be passed to InitializeEvent constructor
50
- */
51
- getSwapDataGetter(event, claimHandler) {
52
- return async () => {
53
- const trace = await this.provider.getTransactionTrace(event.txHash);
54
- if (trace == null)
55
- return null;
56
- if (trace.execute_invocation.revert_reason != null)
57
- return null;
58
- return this.findInitSwapData(trace.execute_invocation, event.params.escrow_hash, claimHandler);
59
- };
60
- }
61
- parseInitializeEvent(event) {
62
- const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
63
- const escrowHash = escrowHashBuffer.toString("hex");
64
- const claimHandlerHex = (0, Utils_1.toHex)(event.params.claim_handler);
65
- const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
66
- if (claimHandler == null) {
67
- this.logger.warn("parseInitializeEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
68
- return null;
69
- }
70
- const swapType = claimHandler.getType();
71
- this.logger.debug("InitializeEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) + " escrowHash: " + escrowHash);
72
- return new base_1.InitializeEvent(escrowHash, swapType, (0, Utils_1.onceAsync)(this.getSwapDataGetter(event, claimHandler)));
73
- }
74
- parseRefundEvent(event) {
75
- const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
76
- const escrowHash = escrowHashBuffer.toString("hex");
77
- this.logger.debug("RefundEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) + " escrowHash: " + escrowHash);
78
- return new base_1.RefundEvent(escrowHash);
79
- }
80
- parseClaimEvent(event) {
81
- const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
82
- const escrowHash = escrowHashBuffer.toString("hex");
83
- const claimHandlerHex = (0, Utils_1.toHex)(event.params.claim_handler);
84
- const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
85
- if (claimHandler == null) {
86
- this.logger.warn("parseClaimEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
87
- return null;
88
- }
89
- const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
90
- this.logger.debug("ClaimEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) +
91
- " witnessResult: " + witnessResult + " escrowHash: " + escrowHash);
92
- return new base_1.ClaimEvent(escrowHash, witnessResult);
93
- }
94
- parseSpvOpenEvent(event) {
95
- const owner = (0, Utils_1.toHex)(event.params.owner);
96
- const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
97
- const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
98
- const vout = Number((0, Utils_1.toBigInt)(event.params.vout));
99
- this.logger.debug("SpvOpenEvent owner: " + owner + " vaultId: " + vaultId + " utxo: " + btcTxId + ":" + vout);
100
- return new base_1.SpvVaultOpenEvent(owner, vaultId, btcTxId, vout);
101
- }
102
- parseSpvDepositEvent(event) {
103
- const owner = (0, Utils_1.toHex)(event.params.owner);
104
- const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
105
- const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
106
- const depositCount = Number((0, Utils_1.toBigInt)(event.params.deposit_count));
107
- this.logger.debug("SpvDepositEvent owner: " + owner + " vaultId: " + vaultId + " depositCount: " + depositCount + " amounts: ", amounts);
108
- return new base_1.SpvVaultDepositEvent(owner, vaultId, amounts, depositCount);
109
- }
110
- parseSpvFrontEvent(event) {
111
- const owner = (0, Utils_1.toHex)(event.params.owner);
112
- const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
113
- const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
114
- const recipient = (0, Utils_1.toHex)(event.params.recipient);
115
- const executionHash = (0, Utils_1.toHex)(event.params.execution_hash);
116
- const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
117
- const frontingAddress = (0, Utils_1.toHex)(event.params.caller);
118
- this.logger.debug("SpvFrontEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId +
119
- " recipient: " + recipient + " frontedBy: " + frontingAddress + " amounts: ", amounts);
120
- return new base_1.SpvVaultFrontEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, frontingAddress);
121
- }
122
- parseSpvClaimEvent(event) {
123
- const owner = (0, Utils_1.toHex)(event.params.owner);
124
- const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
125
- const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
126
- const recipient = (0, Utils_1.toHex)(event.params.recipient);
127
- const executionHash = (0, Utils_1.toHex)(event.params.execution_hash);
128
- const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
129
- const caller = (0, Utils_1.toHex)(event.params.caller);
130
- const frontingAddress = (0, Utils_1.toHex)(event.params.fronting_address);
131
- const withdrawCount = Number((0, Utils_1.toBigInt)(event.params.withdraw_count));
132
- this.logger.debug("SpvClaimEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId + " withdrawCount: " + withdrawCount +
133
- " recipient: " + recipient + " frontedBy: " + frontingAddress + " claimedBy: " + caller + " amounts: ", amounts);
134
- return new base_1.SpvVaultClaimEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, caller, frontingAddress, withdrawCount);
135
- }
136
- parseSpvCloseEvent(event) {
137
- const owner = (0, Utils_1.toHex)(event.params.owner);
138
- const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
139
- const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
140
- const error = (0, Utils_1.bigNumberishToBuffer)(event.params.error).toString();
141
- return new base_1.SpvVaultCloseEvent(owner, vaultId, btcTxId, error);
142
- }
143
- /**
144
- * Processes event as received from the chain, parses it & calls event listeners
145
- *
146
- * @param events
147
- * @param currentBlockNumber
148
- * @param currentBlockTimestamp
149
- * @param pendingEventTime
150
- * @protected
151
- */
152
- async processEvents(events, currentBlockNumber, currentBlockTimestamp, pendingEventTime) {
153
- const blockTimestampsCache = {};
154
- const getBlockTimestamp = async (blockNumber) => {
155
- if (blockNumber === currentBlockNumber)
156
- return currentBlockTimestamp;
157
- const blockNumberString = blockNumber.toString();
158
- blockTimestampsCache[blockNumberString] ?? (blockTimestampsCache[blockNumberString] = (await this.provider.getBlockWithTxHashes(blockNumber)).timestamp);
159
- return blockTimestampsCache[blockNumberString];
160
- };
161
- const parsedEvents = [];
162
- for (let event of events) {
163
- let parsedEvent;
164
- switch (event.name) {
165
- case "escrow_manager::events::Claim":
166
- parsedEvent = this.parseClaimEvent(event);
167
- break;
168
- case "escrow_manager::events::Refund":
169
- parsedEvent = this.parseRefundEvent(event);
170
- break;
171
- case "escrow_manager::events::Initialize":
172
- parsedEvent = this.parseInitializeEvent(event);
173
- break;
174
- case "spv_swap_vault::events::Opened":
175
- parsedEvent = this.parseSpvOpenEvent(event);
176
- break;
177
- case "spv_swap_vault::events::Deposited":
178
- parsedEvent = this.parseSpvDepositEvent(event);
179
- break;
180
- case "spv_swap_vault::events::Fronted":
181
- parsedEvent = this.parseSpvFrontEvent(event);
182
- break;
183
- case "spv_swap_vault::events::Claimed":
184
- parsedEvent = this.parseSpvClaimEvent(event);
185
- break;
186
- case "spv_swap_vault::events::Closed":
187
- parsedEvent = this.parseSpvCloseEvent(event);
188
- break;
189
- }
190
- const timestamp = event.blockNumber == null ? pendingEventTime : await getBlockTimestamp(event.blockNumber);
191
- parsedEvent.meta = {
192
- blockTime: timestamp,
193
- txId: event.txHash,
194
- timestamp //Maybe deprecated
195
- };
196
- parsedEvents.push(parsedEvent);
197
- }
198
- for (let listener of this.listeners) {
199
- await listener(parsedEvents);
200
- }
201
- }
202
- async checkEventsEcrowManager(lastTxHash, lastBlockNumber, currentBlock) {
203
- const currentBlockNumber = currentBlock.block_number;
204
- lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
205
- // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
206
- let events = await this.starknetSwapContract.Events.getContractBlockEvents(["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"], [], lastBlockNumber, null);
207
- if (lastTxHash != null) {
208
- const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
209
- if (latestProcessedEventIndex !== -1) {
210
- events.splice(0, latestProcessedEventIndex + 1);
211
- // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
212
- }
213
- }
214
- if (events.length > 0) {
215
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
216
- lastTxHash = events[events.length - 1].txHash;
217
- }
218
- return lastTxHash;
219
- }
220
- async checkEventsSpvVaults(lastTxHash, lastBlockNumber, currentBlock) {
221
- const currentBlockNumber = currentBlock.block_number;
222
- lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
223
- // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
224
- let events = await this.starknetSpvVaultContract.Events.getContractBlockEvents(["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"], [], lastBlockNumber, null);
225
- if (lastTxHash != null) {
226
- const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
227
- if (latestProcessedEventIndex !== -1) {
228
- events.splice(0, latestProcessedEventIndex + 1);
229
- // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
230
- }
231
- }
232
- if (events.length > 0) {
233
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
234
- lastTxHash = events[events.length - 1].txHash;
235
- }
236
- return lastTxHash;
237
- }
238
- async checkEvents(lastBlockNumber, lastTxHashes) {
239
- lastTxHashes ?? (lastTxHashes = []);
240
- const currentBlock = await this.provider.getBlockWithTxHashes("latest");
241
- const currentBlockNumber = currentBlock.block_number;
242
- lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock);
243
- lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock);
244
- return {
245
- txHashes: lastTxHashes,
246
- blockNumber: currentBlockNumber
247
- };
248
- }
249
- /**
250
- * Sets up event handlers listening for swap events over websocket
251
- *
252
- * @protected
253
- */
254
- async setupPoll(lastBlockNumber, lastTxHashes, saveLatestProcessedBlockNumber) {
255
- this.stopped = false;
256
- let func;
257
- func = async () => {
258
- await this.checkEvents(lastBlockNumber, lastTxHashes).then(({ blockNumber, txHashes }) => {
259
- lastBlockNumber = blockNumber;
260
- lastTxHashes = txHashes;
261
- if (saveLatestProcessedBlockNumber != null)
262
- return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
263
- }).catch(e => {
264
- this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
265
- });
266
- if (this.stopped)
267
- return;
268
- this.timeout = setTimeout(func, this.pollIntervalSeconds * 1000);
269
- };
270
- await func();
271
- }
272
- init() {
273
- this.setupPoll();
274
- return Promise.resolve();
275
- }
276
- async stop() {
277
- this.stopped = true;
278
- if (this.timeout != null)
279
- clearTimeout(this.timeout);
280
- this.eventListeners = [];
281
- }
282
- registerListener(cbk) {
283
- this.listeners.push(cbk);
284
- }
285
- unregisterListener(cbk) {
286
- const index = this.listeners.indexOf(cbk);
287
- if (index >= 0) {
288
- this.listeners.splice(index, 1);
289
- return true;
290
- }
291
- return false;
292
- }
293
- }
294
- exports.StarknetChainEventsBrowser = StarknetChainEventsBrowser;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StarknetChainEventsBrowser = void 0;
4
+ const base_1 = require("@atomiqlabs/base");
5
+ const Utils_1 = require("../../utils/Utils");
6
+ const starknet_1 = require("starknet");
7
+ /**
8
+ * Starknet on-chain event handler for front-end systems without access to fs, uses WS or long-polling to subscribe, might lose
9
+ * out on some events if the network is unreliable, front-end systems should take this into consideration and not
10
+ * rely purely on events
11
+ */
12
+ class StarknetChainEventsBrowser {
13
+ constructor(chainInterface, starknetSwapContract, starknetSpvVaultContract, pollIntervalSeconds = 5) {
14
+ this.listeners = [];
15
+ this.logger = (0, Utils_1.getLogger)("StarknetChainEventsBrowser: ");
16
+ this.initFunctionName = "initialize";
17
+ this.initEntryPointSelector = BigInt(starknet_1.hash.starknetKeccak(this.initFunctionName));
18
+ this.provider = chainInterface.provider;
19
+ this.starknetSwapContract = starknetSwapContract;
20
+ this.starknetSpvVaultContract = starknetSpvVaultContract;
21
+ this.pollIntervalSeconds = pollIntervalSeconds;
22
+ }
23
+ findInitSwapData(call, escrowHash, claimHandler) {
24
+ if (BigInt(call.contract_address) === BigInt(this.starknetSwapContract.contract.address) &&
25
+ BigInt(call.entry_point_selector) === this.initEntryPointSelector) {
26
+ //Found, check correct escrow hash
27
+ const { escrow, extraData } = (0, Utils_1.parseInitFunctionCalldata)(call.calldata, claimHandler);
28
+ if ("0x" + escrow.getEscrowHash() === (0, Utils_1.toHex)(escrowHash)) {
29
+ if (extraData.length !== 0) {
30
+ escrow.setExtraData((0, Utils_1.bytes31SpanToBuffer)(extraData, 42).toString("hex"));
31
+ }
32
+ return escrow;
33
+ }
34
+ }
35
+ for (let _call of call.calls) {
36
+ const found = this.findInitSwapData(_call, escrowHash, claimHandler);
37
+ if (found != null)
38
+ return found;
39
+ }
40
+ return null;
41
+ }
42
+ /**
43
+ * Returns async getter for fetching on-demand initialize event swap data
44
+ *
45
+ * @param event
46
+ * @param claimHandler
47
+ * @private
48
+ * @returns {() => Promise<StarknetSwapData>} getter to be passed to InitializeEvent constructor
49
+ */
50
+ getSwapDataGetter(event, claimHandler) {
51
+ return async () => {
52
+ const trace = await this.provider.getTransactionTrace(event.txHash);
53
+ if (trace == null)
54
+ return null;
55
+ if (trace.execute_invocation.revert_reason != null)
56
+ return null;
57
+ return this.findInitSwapData(trace.execute_invocation, event.params.escrow_hash, claimHandler);
58
+ };
59
+ }
60
+ parseInitializeEvent(event) {
61
+ const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
62
+ const escrowHash = escrowHashBuffer.toString("hex");
63
+ const claimHandlerHex = (0, Utils_1.toHex)(event.params.claim_handler);
64
+ const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
65
+ if (claimHandler == null) {
66
+ this.logger.warn("parseInitializeEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
67
+ return null;
68
+ }
69
+ const swapType = claimHandler.getType();
70
+ this.logger.debug("InitializeEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) + " escrowHash: " + escrowHash);
71
+ return new base_1.InitializeEvent(escrowHash, swapType, (0, Utils_1.onceAsync)(this.getSwapDataGetter(event, claimHandler)));
72
+ }
73
+ parseRefundEvent(event) {
74
+ const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
75
+ const escrowHash = escrowHashBuffer.toString("hex");
76
+ this.logger.debug("RefundEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) + " escrowHash: " + escrowHash);
77
+ return new base_1.RefundEvent(escrowHash);
78
+ }
79
+ parseClaimEvent(event) {
80
+ const escrowHashBuffer = (0, Utils_1.bigNumberishToBuffer)(event.params.escrow_hash, 32);
81
+ const escrowHash = escrowHashBuffer.toString("hex");
82
+ const claimHandlerHex = (0, Utils_1.toHex)(event.params.claim_handler);
83
+ const claimHandler = this.starknetSwapContract.claimHandlersByAddress[claimHandlerHex];
84
+ if (claimHandler == null) {
85
+ this.logger.warn("parseClaimEvent(" + escrowHash + "): Unknown claim handler with claim: " + claimHandlerHex);
86
+ return null;
87
+ }
88
+ const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
89
+ this.logger.debug("ClaimEvent claimHash: " + (0, Utils_1.toHex)(event.params.claim_data) +
90
+ " witnessResult: " + witnessResult + " escrowHash: " + escrowHash);
91
+ return new base_1.ClaimEvent(escrowHash, witnessResult);
92
+ }
93
+ parseSpvOpenEvent(event) {
94
+ const owner = (0, Utils_1.toHex)(event.params.owner);
95
+ const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
96
+ const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
97
+ const vout = Number((0, Utils_1.toBigInt)(event.params.vout));
98
+ this.logger.debug("SpvOpenEvent owner: " + owner + " vaultId: " + vaultId + " utxo: " + btcTxId + ":" + vout);
99
+ return new base_1.SpvVaultOpenEvent(owner, vaultId, btcTxId, vout);
100
+ }
101
+ parseSpvDepositEvent(event) {
102
+ const owner = (0, Utils_1.toHex)(event.params.owner);
103
+ const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
104
+ const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
105
+ const depositCount = Number((0, Utils_1.toBigInt)(event.params.deposit_count));
106
+ this.logger.debug("SpvDepositEvent owner: " + owner + " vaultId: " + vaultId + " depositCount: " + depositCount + " amounts: ", amounts);
107
+ return new base_1.SpvVaultDepositEvent(owner, vaultId, amounts, depositCount);
108
+ }
109
+ parseSpvFrontEvent(event) {
110
+ const owner = (0, Utils_1.toHex)(event.params.owner);
111
+ const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
112
+ const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
113
+ const recipient = (0, Utils_1.toHex)(event.params.recipient);
114
+ const executionHash = (0, Utils_1.toHex)(event.params.execution_hash);
115
+ const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
116
+ const frontingAddress = (0, Utils_1.toHex)(event.params.caller);
117
+ this.logger.debug("SpvFrontEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId +
118
+ " recipient: " + recipient + " frontedBy: " + frontingAddress + " amounts: ", amounts);
119
+ return new base_1.SpvVaultFrontEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, frontingAddress);
120
+ }
121
+ parseSpvClaimEvent(event) {
122
+ const owner = (0, Utils_1.toHex)(event.params.owner);
123
+ const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
124
+ const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
125
+ const recipient = (0, Utils_1.toHex)(event.params.recipient);
126
+ const executionHash = (0, Utils_1.toHex)(event.params.execution_hash);
127
+ const amounts = [(0, Utils_1.toBigInt)(event.params.amounts["0"]), (0, Utils_1.toBigInt)(event.params.amounts["1"])];
128
+ const caller = (0, Utils_1.toHex)(event.params.caller);
129
+ const frontingAddress = (0, Utils_1.toHex)(event.params.fronting_address);
130
+ const withdrawCount = Number((0, Utils_1.toBigInt)(event.params.withdraw_count));
131
+ this.logger.debug("SpvClaimEvent owner: " + owner + " vaultId: " + vaultId + " btcTxId: " + btcTxId + " withdrawCount: " + withdrawCount +
132
+ " recipient: " + recipient + " frontedBy: " + frontingAddress + " claimedBy: " + caller + " amounts: ", amounts);
133
+ return new base_1.SpvVaultClaimEvent(owner, vaultId, btcTxId, recipient, executionHash, amounts, caller, frontingAddress, withdrawCount);
134
+ }
135
+ parseSpvCloseEvent(event) {
136
+ const owner = (0, Utils_1.toHex)(event.params.owner);
137
+ const vaultId = (0, Utils_1.toBigInt)(event.params.vault_id);
138
+ const btcTxId = (0, Utils_1.bigNumberishToBuffer)(event.params.btc_tx_hash, 32).reverse().toString("hex");
139
+ const error = (0, Utils_1.bigNumberishToBuffer)(event.params.error).toString();
140
+ return new base_1.SpvVaultCloseEvent(owner, vaultId, btcTxId, error);
141
+ }
142
+ /**
143
+ * Processes event as received from the chain, parses it & calls event listeners
144
+ *
145
+ * @param events
146
+ * @param currentBlockNumber
147
+ * @param currentBlockTimestamp
148
+ * @param pendingEventTime
149
+ * @protected
150
+ */
151
+ async processEvents(events, currentBlockNumber, currentBlockTimestamp, pendingEventTime) {
152
+ const blockTimestampsCache = {};
153
+ const getBlockTimestamp = async (blockNumber) => {
154
+ if (blockNumber === currentBlockNumber)
155
+ return currentBlockTimestamp;
156
+ const blockNumberString = blockNumber.toString();
157
+ blockTimestampsCache[blockNumberString] ?? (blockTimestampsCache[blockNumberString] = (await this.provider.getBlockWithTxHashes(blockNumber)).timestamp);
158
+ return blockTimestampsCache[blockNumberString];
159
+ };
160
+ const parsedEvents = [];
161
+ for (let event of events) {
162
+ let parsedEvent;
163
+ switch (event.name) {
164
+ case "escrow_manager::events::Claim":
165
+ parsedEvent = this.parseClaimEvent(event);
166
+ break;
167
+ case "escrow_manager::events::Refund":
168
+ parsedEvent = this.parseRefundEvent(event);
169
+ break;
170
+ case "escrow_manager::events::Initialize":
171
+ parsedEvent = this.parseInitializeEvent(event);
172
+ break;
173
+ case "spv_swap_vault::events::Opened":
174
+ parsedEvent = this.parseSpvOpenEvent(event);
175
+ break;
176
+ case "spv_swap_vault::events::Deposited":
177
+ parsedEvent = this.parseSpvDepositEvent(event);
178
+ break;
179
+ case "spv_swap_vault::events::Fronted":
180
+ parsedEvent = this.parseSpvFrontEvent(event);
181
+ break;
182
+ case "spv_swap_vault::events::Claimed":
183
+ parsedEvent = this.parseSpvClaimEvent(event);
184
+ break;
185
+ case "spv_swap_vault::events::Closed":
186
+ parsedEvent = this.parseSpvCloseEvent(event);
187
+ break;
188
+ }
189
+ const timestamp = event.blockNumber == null ? pendingEventTime : await getBlockTimestamp(event.blockNumber);
190
+ parsedEvent.meta = {
191
+ blockTime: timestamp,
192
+ txId: event.txHash,
193
+ timestamp //Maybe deprecated
194
+ };
195
+ parsedEvents.push(parsedEvent);
196
+ }
197
+ for (let listener of this.listeners) {
198
+ await listener(parsedEvents);
199
+ }
200
+ }
201
+ async checkEventsEcrowManager(lastTxHash, lastBlockNumber, currentBlock) {
202
+ const currentBlockNumber = currentBlock.block_number;
203
+ lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
204
+ // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
205
+ let events = await this.starknetSwapContract.Events.getContractBlockEvents(["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"], [], lastBlockNumber, null);
206
+ if (lastTxHash != null) {
207
+ const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
208
+ if (latestProcessedEventIndex !== -1) {
209
+ events.splice(0, latestProcessedEventIndex + 1);
210
+ // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
211
+ }
212
+ }
213
+ if (events.length > 0) {
214
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
215
+ lastTxHash = events[events.length - 1].txHash;
216
+ }
217
+ return lastTxHash;
218
+ }
219
+ async checkEventsSpvVaults(lastTxHash, lastBlockNumber, currentBlock) {
220
+ const currentBlockNumber = currentBlock.block_number;
221
+ lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
222
+ // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
223
+ let events = await this.starknetSpvVaultContract.Events.getContractBlockEvents(["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"], [], lastBlockNumber, null);
224
+ if (lastTxHash != null) {
225
+ const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
226
+ if (latestProcessedEventIndex !== -1) {
227
+ events.splice(0, latestProcessedEventIndex + 1);
228
+ // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
229
+ }
230
+ }
231
+ if (events.length > 0) {
232
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
233
+ lastTxHash = events[events.length - 1].txHash;
234
+ }
235
+ return lastTxHash;
236
+ }
237
+ async checkEvents(lastBlockNumber, lastTxHashes) {
238
+ lastTxHashes ?? (lastTxHashes = []);
239
+ const currentBlock = await this.provider.getBlockWithTxHashes("latest");
240
+ const currentBlockNumber = currentBlock.block_number;
241
+ lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock);
242
+ lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock);
243
+ return {
244
+ txHashes: lastTxHashes,
245
+ blockNumber: currentBlockNumber
246
+ };
247
+ }
248
+ /**
249
+ * Sets up event handlers listening for swap events over websocket
250
+ *
251
+ * @protected
252
+ */
253
+ async setupPoll(lastBlockNumber, lastTxHashes, saveLatestProcessedBlockNumber) {
254
+ this.stopped = false;
255
+ let func;
256
+ func = async () => {
257
+ await this.checkEvents(lastBlockNumber, lastTxHashes).then(({ blockNumber, txHashes }) => {
258
+ lastBlockNumber = blockNumber;
259
+ lastTxHashes = txHashes;
260
+ if (saveLatestProcessedBlockNumber != null)
261
+ return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
262
+ }).catch(e => {
263
+ this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
264
+ });
265
+ if (this.stopped)
266
+ return;
267
+ this.timeout = setTimeout(func, this.pollIntervalSeconds * 1000);
268
+ };
269
+ await func();
270
+ }
271
+ init() {
272
+ this.setupPoll();
273
+ return Promise.resolve();
274
+ }
275
+ async stop() {
276
+ this.stopped = true;
277
+ if (this.timeout != null)
278
+ clearTimeout(this.timeout);
279
+ }
280
+ registerListener(cbk) {
281
+ this.listeners.push(cbk);
282
+ }
283
+ unregisterListener(cbk) {
284
+ const index = this.listeners.indexOf(cbk);
285
+ if (index >= 0) {
286
+ this.listeners.splice(index, 1);
287
+ return true;
288
+ }
289
+ return false;
290
+ }
291
+ }
292
+ exports.StarknetChainEventsBrowser = StarknetChainEventsBrowser;