@atomiqlabs/chain-starknet 4.0.0-dev.12 → 4.0.0-dev.13

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 -27
  7. package/dist/starknet/StarknetInitializer.js +69 -69
  8. package/dist/starknet/btcrelay/BtcRelayAbi.d.ts +250 -250
  9. package/dist/starknet/btcrelay/BtcRelayAbi.js +341 -341
  10. package/dist/starknet/btcrelay/StarknetBtcRelay.d.ts +186 -186
  11. package/dist/starknet/btcrelay/StarknetBtcRelay.js +379 -379
  12. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.d.ts +31 -31
  13. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.js +74 -74
  14. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.d.ts +51 -51
  15. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.js +113 -113
  16. package/dist/starknet/chain/StarknetAction.d.ts +19 -19
  17. package/dist/starknet/chain/StarknetAction.js +73 -73
  18. package/dist/starknet/chain/StarknetChainInterface.d.ts +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 -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 +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 +102 -98
  38. package/dist/starknet/chain/modules/StarknetTransactions.d.ts +93 -93
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +261 -260
  40. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -13
  41. package/dist/starknet/contract/StarknetContractBase.js +20 -16
  42. package/dist/starknet/contract/StarknetContractModule.d.ts +8 -8
  43. package/dist/starknet/contract/StarknetContractModule.js +11 -11
  44. package/dist/starknet/contract/modules/StarknetContractEvents.d.ts +51 -51
  45. package/dist/starknet/contract/modules/StarknetContractEvents.js +97 -97
  46. package/dist/starknet/events/StarknetChainEvents.d.ts +21 -21
  47. package/dist/starknet/events/StarknetChainEvents.js +52 -52
  48. package/dist/starknet/events/StarknetChainEventsBrowser.d.ts +89 -90
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +296 -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 -66
  55. package/dist/starknet/spv_swap/StarknetSpvVaultContract.js +382 -382
  56. package/dist/starknet/spv_swap/StarknetSpvVaultData.d.ts +49 -49
  57. package/dist/starknet/spv_swap/StarknetSpvVaultData.js +145 -145
  58. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.d.ts +25 -25
  59. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.js +72 -72
  60. package/dist/starknet/swaps/EscrowManagerAbi.d.ts +431 -431
  61. package/dist/starknet/swaps/EscrowManagerAbi.js +583 -583
  62. package/dist/starknet/swaps/StarknetSwapContract.d.ts +191 -191
  63. package/dist/starknet/swaps/StarknetSwapContract.js +424 -424
  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 -87
  89. package/dist/starknet/swaps/modules/StarknetSwapInit.js +235 -225
  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 +35 -30
  94. package/dist/starknet/wallet/StarknetSigner.d.ts +12 -12
  95. package/dist/starknet/wallet/StarknetSigner.js +47 -46
  96. package/dist/utils/Utils.d.ts +37 -37
  97. package/dist/utils/Utils.js +260 -261
  98. package/package.json +43 -37
  99. package/src/index.ts +47 -47
  100. package/src/starknet/StarknetChainType.ts +28 -28
  101. package/src/starknet/StarknetInitializer.ts +108 -108
  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 +75 -74
  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 +120 -116
  117. package/src/starknet/chain/modules/StarknetTransactions.ts +285 -283
  118. package/src/starknet/contract/StarknetContractBase.ts +30 -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 +411 -411
  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 -483
  126. package/src/starknet/spv_swap/StarknetSpvVaultData.ts +195 -195
  127. package/src/starknet/spv_swap/StarknetSpvWithdrawalData.ts +79 -79
  128. package/src/starknet/swaps/EscrowManagerAbi.ts +582 -582
  129. package/src/starknet/swaps/StarknetSwapContract.ts +647 -647
  130. package/src/starknet/swaps/StarknetSwapData.ts +455 -455
  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 +300 -287
  143. package/src/starknet/swaps/modules/StarknetSwapRefund.ts +196 -196
  144. package/src/starknet/wallet/StarknetKeypairWallet.ts +44 -39
  145. package/src/starknet/wallet/StarknetSigner.ts +55 -55
  146. package/src/utils/Utils.ts +251 -252
@@ -1,294 +1,296 @@
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
- if (parsedEvent == null)
190
- continue;
191
- const timestamp = event.blockNumber == null ? pendingEventTime : await getBlockTimestamp(event.blockNumber);
192
- parsedEvent.meta = {
193
- blockTime: timestamp,
194
- txId: event.txHash,
195
- timestamp //Maybe deprecated
196
- };
197
- parsedEvents.push(parsedEvent);
198
- }
199
- for (let listener of this.listeners) {
200
- await listener(parsedEvents);
201
- }
202
- }
203
- async checkEventsEcrowManager(lastTxHash, lastBlockNumber, currentBlock) {
204
- const currentBlockNumber = currentBlock.block_number;
205
- lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
206
- // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
207
- let events = await this.starknetSwapContract.Events.getContractBlockEvents(["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"], [], lastBlockNumber, null);
208
- if (lastTxHash != null) {
209
- const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
210
- if (latestProcessedEventIndex !== -1) {
211
- events.splice(0, latestProcessedEventIndex + 1);
212
- // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
213
- }
214
- }
215
- if (events.length > 0) {
216
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
217
- lastTxHash = events[events.length - 1].txHash;
218
- }
219
- return lastTxHash;
220
- }
221
- async checkEventsSpvVaults(lastTxHash, lastBlockNumber, currentBlock) {
222
- const currentBlockNumber = currentBlock.block_number;
223
- lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
224
- // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
225
- 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);
226
- if (lastTxHash != null) {
227
- const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
228
- if (latestProcessedEventIndex !== -1) {
229
- events.splice(0, latestProcessedEventIndex + 1);
230
- // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
231
- }
232
- }
233
- if (events.length > 0) {
234
- await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp, Math.floor(Date.now() / 1000));
235
- lastTxHash = events[events.length - 1].txHash;
236
- }
237
- return lastTxHash;
238
- }
239
- async checkEvents(lastBlockNumber, lastTxHashes) {
240
- lastTxHashes ?? (lastTxHashes = []);
241
- const currentBlock = await this.provider.getBlockWithTxHashes("latest");
242
- const currentBlockNumber = currentBlock.block_number;
243
- lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock);
244
- lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock);
245
- return {
246
- txHashes: lastTxHashes,
247
- blockNumber: currentBlockNumber
248
- };
249
- }
250
- /**
251
- * Sets up event handlers listening for swap events over websocket
252
- *
253
- * @protected
254
- */
255
- async setupPoll(lastBlockNumber, lastTxHashes, saveLatestProcessedBlockNumber) {
256
- this.stopped = false;
257
- let func;
258
- func = async () => {
259
- await this.checkEvents(lastBlockNumber, lastTxHashes).then(({ blockNumber, txHashes }) => {
260
- lastBlockNumber = blockNumber;
261
- lastTxHashes = txHashes;
262
- if (saveLatestProcessedBlockNumber != null)
263
- return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
264
- }).catch(e => {
265
- this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
266
- });
267
- if (this.stopped)
268
- return;
269
- this.timeout = setTimeout(func, this.pollIntervalSeconds * 1000);
270
- };
271
- await func();
272
- }
273
- init() {
274
- this.setupPoll();
275
- return Promise.resolve();
276
- }
277
- async stop() {
278
- this.stopped = true;
279
- if (this.timeout != null)
280
- clearTimeout(this.timeout);
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
+ * @protected
149
+ */
150
+ async processEvents(events, currentBlockNumber, currentBlockTimestamp) {
151
+ const blockTimestampsCache = {};
152
+ const getBlockTimestamp = async (blockNumber) => {
153
+ if (blockNumber === currentBlockNumber)
154
+ return currentBlockTimestamp;
155
+ const blockNumberString = blockNumber.toString();
156
+ blockTimestampsCache[blockNumberString] ?? (blockTimestampsCache[blockNumberString] = (await this.provider.getBlockWithTxHashes(blockNumber)).timestamp);
157
+ return blockTimestampsCache[blockNumberString];
158
+ };
159
+ const parsedEvents = [];
160
+ for (let event of events) {
161
+ let parsedEvent;
162
+ switch (event.name) {
163
+ case "escrow_manager::events::Claim":
164
+ parsedEvent = this.parseClaimEvent(event);
165
+ break;
166
+ case "escrow_manager::events::Refund":
167
+ parsedEvent = this.parseRefundEvent(event);
168
+ break;
169
+ case "escrow_manager::events::Initialize":
170
+ parsedEvent = this.parseInitializeEvent(event);
171
+ break;
172
+ case "spv_swap_vault::events::Opened":
173
+ parsedEvent = this.parseSpvOpenEvent(event);
174
+ break;
175
+ case "spv_swap_vault::events::Deposited":
176
+ parsedEvent = this.parseSpvDepositEvent(event);
177
+ break;
178
+ case "spv_swap_vault::events::Fronted":
179
+ parsedEvent = this.parseSpvFrontEvent(event);
180
+ break;
181
+ case "spv_swap_vault::events::Claimed":
182
+ parsedEvent = this.parseSpvClaimEvent(event);
183
+ break;
184
+ case "spv_swap_vault::events::Closed":
185
+ parsedEvent = this.parseSpvCloseEvent(event);
186
+ break;
187
+ }
188
+ if (parsedEvent == null)
189
+ continue;
190
+ //We are not trusting pre-confs for events, so this shall never happen
191
+ if (event.blockNumber == null)
192
+ throw new Error("Event block number cannot be null!");
193
+ const timestamp = await getBlockTimestamp(event.blockNumber);
194
+ parsedEvent.meta = {
195
+ blockTime: timestamp,
196
+ txId: event.txHash,
197
+ timestamp //Maybe deprecated
198
+ };
199
+ parsedEvents.push(parsedEvent);
200
+ }
201
+ for (let listener of this.listeners) {
202
+ await listener(parsedEvents);
203
+ }
204
+ }
205
+ async checkEventsEcrowManager(lastTxHash, lastBlockNumber, currentBlock) {
206
+ const currentBlockNumber = currentBlock.block_number;
207
+ lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
208
+ // this.logger.debug("checkEvents(EscrowManager): Requesting logs: "+logStartHeight+"...pending");
209
+ let events = await this.starknetSwapContract.Events.getContractBlockEvents(["escrow_manager::events::Initialize", "escrow_manager::events::Claim", "escrow_manager::events::Refund"], [], lastBlockNumber, null);
210
+ if (lastTxHash != null) {
211
+ const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
212
+ if (latestProcessedEventIndex !== -1) {
213
+ events.splice(0, latestProcessedEventIndex + 1);
214
+ // this.logger.debug("checkEvents(EscrowManager): Splicing processed events, resulting size: "+events.length);
215
+ }
216
+ }
217
+ if (events.length > 0) {
218
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
219
+ lastTxHash = events[events.length - 1].txHash;
220
+ }
221
+ return lastTxHash;
222
+ }
223
+ async checkEventsSpvVaults(lastTxHash, lastBlockNumber, currentBlock) {
224
+ const currentBlockNumber = currentBlock.block_number;
225
+ lastBlockNumber ?? (lastBlockNumber = currentBlockNumber);
226
+ // this.logger.debug("checkEvents(SpvVaults): Requesting logs: "+logStartHeight+"...pending");
227
+ 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);
228
+ if (lastTxHash != null) {
229
+ const latestProcessedEventIndex = (0, Utils_1.findLastIndex)(events, val => val.txHash === lastTxHash);
230
+ if (latestProcessedEventIndex !== -1) {
231
+ events.splice(0, latestProcessedEventIndex + 1);
232
+ // this.logger.debug("checkEvents(SpvVaults): Splicing processed events, resulting size: "+events.length);
233
+ }
234
+ }
235
+ if (events.length > 0) {
236
+ await this.processEvents(events, currentBlock?.block_number, currentBlock?.timestamp);
237
+ lastTxHash = events[events.length - 1].txHash;
238
+ }
239
+ return lastTxHash;
240
+ }
241
+ async checkEvents(lastBlockNumber, lastTxHashes) {
242
+ lastTxHashes ?? (lastTxHashes = []);
243
+ const currentBlock = await this.provider.getBlockWithTxHashes(starknet_1.BlockTag.LATEST);
244
+ const currentBlockNumber = currentBlock.block_number;
245
+ lastTxHashes[0] = await this.checkEventsEcrowManager(lastTxHashes[0], lastBlockNumber, currentBlock);
246
+ lastTxHashes[1] = await this.checkEventsSpvVaults(lastTxHashes[1], lastBlockNumber, currentBlock);
247
+ return {
248
+ txHashes: lastTxHashes,
249
+ blockNumber: currentBlockNumber
250
+ };
251
+ }
252
+ /**
253
+ * Sets up event handlers listening for swap events over websocket
254
+ *
255
+ * @protected
256
+ */
257
+ async setupPoll(lastBlockNumber, lastTxHashes, saveLatestProcessedBlockNumber) {
258
+ this.stopped = false;
259
+ let func;
260
+ func = async () => {
261
+ await this.checkEvents(lastBlockNumber, lastTxHashes).then(({ blockNumber, txHashes }) => {
262
+ lastBlockNumber = blockNumber;
263
+ lastTxHashes = txHashes;
264
+ if (saveLatestProcessedBlockNumber != null)
265
+ return saveLatestProcessedBlockNumber(blockNumber, lastTxHashes);
266
+ }).catch(e => {
267
+ this.logger.error("setupPoll(): Failed to fetch starknet log: ", e);
268
+ });
269
+ if (this.stopped)
270
+ return;
271
+ this.timeout = setTimeout(func, this.pollIntervalSeconds * 1000);
272
+ };
273
+ await func();
274
+ }
275
+ init() {
276
+ this.setupPoll();
277
+ return Promise.resolve();
278
+ }
279
+ async stop() {
280
+ this.stopped = true;
281
+ if (this.timeout != null)
282
+ clearTimeout(this.timeout);
283
+ }
284
+ registerListener(cbk) {
285
+ this.listeners.push(cbk);
286
+ }
287
+ unregisterListener(cbk) {
288
+ const index = this.listeners.indexOf(cbk);
289
+ if (index >= 0) {
290
+ this.listeners.splice(index, 1);
291
+ return true;
292
+ }
293
+ return false;
294
+ }
295
+ }
296
+ exports.StarknetChainEventsBrowser = StarknetChainEventsBrowser;