@atomiqlabs/chain-evm 1.0.0-dev.62 → 1.0.0-dev.64

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 (187) hide show
  1. package/LICENSE +201 -201
  2. package/dist/chains/botanix/BotanixChainType.d.ts +13 -13
  3. package/dist/chains/botanix/BotanixChainType.js +2 -2
  4. package/dist/chains/botanix/BotanixInitializer.d.ts +30 -30
  5. package/dist/chains/botanix/BotanixInitializer.js +122 -122
  6. package/dist/chains/citrea/CitreaBtcRelay.d.ts +21 -21
  7. package/dist/chains/citrea/CitreaBtcRelay.js +43 -43
  8. package/dist/chains/citrea/CitreaChainType.d.ts +13 -13
  9. package/dist/chains/citrea/CitreaChainType.js +2 -2
  10. package/dist/chains/citrea/CitreaFees.d.ts +29 -29
  11. package/dist/chains/citrea/CitreaFees.js +67 -67
  12. package/dist/chains/citrea/CitreaInitializer.d.ts +30 -30
  13. package/dist/chains/citrea/CitreaInitializer.js +129 -129
  14. package/dist/chains/citrea/CitreaSpvVaultContract.d.ts +15 -15
  15. package/dist/chains/citrea/CitreaSpvVaultContract.js +74 -74
  16. package/dist/chains/citrea/CitreaSwapContract.d.ts +22 -22
  17. package/dist/chains/citrea/CitreaSwapContract.js +96 -96
  18. package/dist/chains/citrea/CitreaTokens.d.ts +9 -9
  19. package/dist/chains/citrea/CitreaTokens.js +20 -20
  20. package/dist/evm/btcrelay/BtcRelayAbi.d.ts +198 -198
  21. package/dist/evm/btcrelay/BtcRelayAbi.js +261 -261
  22. package/dist/evm/btcrelay/BtcRelayTypechain.d.ts +172 -172
  23. package/dist/evm/btcrelay/BtcRelayTypechain.js +2 -2
  24. package/dist/evm/btcrelay/EVMBtcRelay.d.ts +195 -195
  25. package/dist/evm/btcrelay/EVMBtcRelay.js +423 -423
  26. package/dist/evm/btcrelay/headers/EVMBtcHeader.d.ts +33 -33
  27. package/dist/evm/btcrelay/headers/EVMBtcHeader.js +84 -84
  28. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.d.ts +56 -56
  29. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js +123 -123
  30. package/dist/evm/chain/EVMChainInterface.d.ts +51 -51
  31. package/dist/evm/chain/EVMChainInterface.js +89 -89
  32. package/dist/evm/chain/EVMModule.d.ts +9 -9
  33. package/dist/evm/chain/EVMModule.js +13 -13
  34. package/dist/evm/chain/modules/ERC20Abi.d.ts +168 -168
  35. package/dist/evm/chain/modules/ERC20Abi.js +225 -225
  36. package/dist/evm/chain/modules/EVMAddresses.d.ts +10 -10
  37. package/dist/evm/chain/modules/EVMAddresses.js +30 -30
  38. package/dist/evm/chain/modules/EVMBlocks.d.ts +20 -20
  39. package/dist/evm/chain/modules/EVMBlocks.js +64 -64
  40. package/dist/evm/chain/modules/EVMEvents.d.ts +36 -36
  41. package/dist/evm/chain/modules/EVMEvents.js +122 -122
  42. package/dist/evm/chain/modules/EVMFees.d.ts +36 -36
  43. package/dist/evm/chain/modules/EVMFees.js +73 -73
  44. package/dist/evm/chain/modules/EVMSignatures.d.ts +29 -29
  45. package/dist/evm/chain/modules/EVMSignatures.js +68 -68
  46. package/dist/evm/chain/modules/EVMTokens.d.ts +70 -70
  47. package/dist/evm/chain/modules/EVMTokens.js +142 -142
  48. package/dist/evm/chain/modules/EVMTransactions.d.ts +89 -89
  49. package/dist/evm/chain/modules/EVMTransactions.js +235 -235
  50. package/dist/evm/contract/EVMContractBase.d.ts +22 -22
  51. package/dist/evm/contract/EVMContractBase.js +34 -34
  52. package/dist/evm/contract/EVMContractModule.d.ts +8 -8
  53. package/dist/evm/contract/EVMContractModule.js +11 -11
  54. package/dist/evm/contract/modules/EVMContractEvents.d.ts +42 -42
  55. package/dist/evm/contract/modules/EVMContractEvents.js +75 -75
  56. package/dist/evm/events/EVMChainEvents.d.ts +22 -22
  57. package/dist/evm/events/EVMChainEvents.js +69 -69
  58. package/dist/evm/events/EVMChainEventsBrowser.d.ts +102 -102
  59. package/dist/evm/events/EVMChainEventsBrowser.js +402 -400
  60. package/dist/evm/providers/JsonRpcProviderWithRetries.d.ts +15 -15
  61. package/dist/evm/providers/JsonRpcProviderWithRetries.js +19 -19
  62. package/dist/evm/providers/ReconnectingWebSocketProvider.d.ts +22 -20
  63. package/dist/evm/providers/ReconnectingWebSocketProvider.js +87 -77
  64. package/dist/evm/providers/SocketProvider.d.ts +111 -111
  65. package/dist/evm/providers/SocketProvider.js +334 -334
  66. package/dist/evm/providers/WebSocketProviderWithRetries.d.ts +17 -17
  67. package/dist/evm/providers/WebSocketProviderWithRetries.js +19 -19
  68. package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts +78 -78
  69. package/dist/evm/spv_swap/EVMSpvVaultContract.js +478 -478
  70. package/dist/evm/spv_swap/EVMSpvVaultData.d.ts +39 -39
  71. package/dist/evm/spv_swap/EVMSpvVaultData.js +180 -180
  72. package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts +19 -19
  73. package/dist/evm/spv_swap/EVMSpvWithdrawalData.js +55 -55
  74. package/dist/evm/spv_swap/SpvVaultContractAbi.d.ts +91 -91
  75. package/dist/evm/spv_swap/SpvVaultContractAbi.js +849 -849
  76. package/dist/evm/spv_swap/SpvVaultContractTypechain.d.ts +450 -450
  77. package/dist/evm/spv_swap/SpvVaultContractTypechain.js +2 -2
  78. package/dist/evm/swaps/EVMSwapContract.d.ts +193 -193
  79. package/dist/evm/swaps/EVMSwapContract.js +378 -378
  80. package/dist/evm/swaps/EVMSwapData.d.ts +66 -66
  81. package/dist/evm/swaps/EVMSwapData.js +260 -260
  82. package/dist/evm/swaps/EVMSwapModule.d.ts +9 -9
  83. package/dist/evm/swaps/EVMSwapModule.js +11 -11
  84. package/dist/evm/swaps/EscrowManagerAbi.d.ts +120 -120
  85. package/dist/evm/swaps/EscrowManagerAbi.js +985 -985
  86. package/dist/evm/swaps/EscrowManagerTypechain.d.ts +475 -475
  87. package/dist/evm/swaps/EscrowManagerTypechain.js +2 -2
  88. package/dist/evm/swaps/handlers/IHandler.d.ts +13 -13
  89. package/dist/evm/swaps/handlers/IHandler.js +2 -2
  90. package/dist/evm/swaps/handlers/claim/ClaimHandlers.d.ts +10 -10
  91. package/dist/evm/swaps/handlers/claim/ClaimHandlers.js +13 -13
  92. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.d.ts +20 -20
  93. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.js +39 -39
  94. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  95. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +59 -59
  96. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  97. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +51 -51
  98. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +21 -21
  99. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +28 -28
  100. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +48 -48
  101. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +63 -63
  102. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  103. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.js +28 -28
  104. package/dist/evm/swaps/modules/EVMLpVault.d.ts +69 -69
  105. package/dist/evm/swaps/modules/EVMLpVault.js +134 -134
  106. package/dist/evm/swaps/modules/EVMSwapClaim.d.ts +54 -54
  107. package/dist/evm/swaps/modules/EVMSwapClaim.js +137 -137
  108. package/dist/evm/swaps/modules/EVMSwapInit.d.ts +88 -88
  109. package/dist/evm/swaps/modules/EVMSwapInit.js +274 -274
  110. package/dist/evm/swaps/modules/EVMSwapRefund.d.ts +62 -62
  111. package/dist/evm/swaps/modules/EVMSwapRefund.js +167 -167
  112. package/dist/evm/typechain/common.d.ts +50 -50
  113. package/dist/evm/typechain/common.js +2 -2
  114. package/dist/evm/wallet/EVMSigner.d.ts +10 -10
  115. package/dist/evm/wallet/EVMSigner.js +17 -17
  116. package/dist/index.d.ts +43 -43
  117. package/dist/index.js +59 -59
  118. package/dist/utils/Utils.d.ts +15 -15
  119. package/dist/utils/Utils.js +71 -71
  120. package/package.json +37 -37
  121. package/src/chains/botanix/BotanixChainType.ts +28 -28
  122. package/src/chains/botanix/BotanixInitializer.ts +171 -171
  123. package/src/chains/citrea/CitreaBtcRelay.ts +57 -57
  124. package/src/chains/citrea/CitreaChainType.ts +28 -28
  125. package/src/chains/citrea/CitreaFees.ts +77 -77
  126. package/src/chains/citrea/CitreaInitializer.ts +178 -178
  127. package/src/chains/citrea/CitreaSpvVaultContract.ts +75 -75
  128. package/src/chains/citrea/CitreaSwapContract.ts +102 -102
  129. package/src/chains/citrea/CitreaTokens.ts +21 -21
  130. package/src/evm/btcrelay/BtcRelayAbi.ts +258 -258
  131. package/src/evm/btcrelay/BtcRelayTypechain.ts +371 -371
  132. package/src/evm/btcrelay/EVMBtcRelay.ts +522 -522
  133. package/src/evm/btcrelay/headers/EVMBtcHeader.ts +109 -109
  134. package/src/evm/btcrelay/headers/EVMBtcStoredHeader.ts +152 -152
  135. package/src/evm/chain/EVMChainInterface.ts +155 -155
  136. package/src/evm/chain/EVMModule.ts +21 -21
  137. package/src/evm/chain/modules/ERC20Abi.ts +222 -222
  138. package/src/evm/chain/modules/EVMAddresses.ts +28 -28
  139. package/src/evm/chain/modules/EVMBlocks.ts +75 -75
  140. package/src/evm/chain/modules/EVMEvents.ts +139 -139
  141. package/src/evm/chain/modules/EVMFees.ts +104 -104
  142. package/src/evm/chain/modules/EVMSignatures.ts +76 -76
  143. package/src/evm/chain/modules/EVMTokens.ts +155 -155
  144. package/src/evm/chain/modules/EVMTransactions.ts +263 -263
  145. package/src/evm/contract/EVMContractBase.ts +63 -63
  146. package/src/evm/contract/EVMContractModule.ts +16 -16
  147. package/src/evm/contract/modules/EVMContractEvents.ts +102 -102
  148. package/src/evm/events/EVMChainEvents.ts +82 -82
  149. package/src/evm/events/EVMChainEventsBrowser.ts +524 -523
  150. package/src/evm/providers/JsonRpcProviderWithRetries.ts +26 -26
  151. package/src/evm/providers/ReconnectingWebSocketProvider.ts +101 -93
  152. package/src/evm/providers/SocketProvider.ts +368 -368
  153. package/src/evm/providers/WebSocketProviderWithRetries.ts +28 -28
  154. package/src/evm/spv_swap/EVMSpvVaultContract.ts +608 -608
  155. package/src/evm/spv_swap/EVMSpvVaultData.ts +224 -224
  156. package/src/evm/spv_swap/EVMSpvWithdrawalData.ts +70 -70
  157. package/src/evm/spv_swap/SpvVaultContractAbi.ts +846 -846
  158. package/src/evm/spv_swap/SpvVaultContractTypechain.ts +685 -685
  159. package/src/evm/swaps/EVMSwapContract.ts +600 -600
  160. package/src/evm/swaps/EVMSwapData.ts +378 -378
  161. package/src/evm/swaps/EVMSwapModule.ts +16 -16
  162. package/src/evm/swaps/EscrowManagerAbi.ts +982 -982
  163. package/src/evm/swaps/EscrowManagerTypechain.ts +723 -723
  164. package/src/evm/swaps/handlers/IHandler.ts +17 -17
  165. package/src/evm/swaps/handlers/claim/ClaimHandlers.ts +20 -20
  166. package/src/evm/swaps/handlers/claim/HashlockClaimHandler.ts +46 -46
  167. package/src/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +82 -82
  168. package/src/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +76 -76
  169. package/src/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +46 -46
  170. package/src/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +115 -115
  171. package/src/evm/swaps/handlers/refund/TimelockRefundHandler.ts +37 -37
  172. package/src/evm/swaps/modules/EVMLpVault.ts +154 -154
  173. package/src/evm/swaps/modules/EVMSwapClaim.ts +172 -172
  174. package/src/evm/swaps/modules/EVMSwapInit.ts +328 -328
  175. package/src/evm/swaps/modules/EVMSwapRefund.ts +229 -229
  176. package/src/evm/typechain/common.ts +131 -131
  177. package/src/evm/wallet/EVMSigner.ts +25 -25
  178. package/src/index.ts +52 -52
  179. package/src/utils/Utils.ts +81 -81
  180. package/dist/evm/JsonRpcProviderWithRetries.d.ts +0 -15
  181. package/dist/evm/JsonRpcProviderWithRetries.js +0 -19
  182. package/dist/evm/ReconnectingWebSocketProvider.d.ts +0 -20
  183. package/dist/evm/ReconnectingWebSocketProvider.js +0 -77
  184. package/dist/evm/SocketProvider.d.ts +0 -111
  185. package/dist/evm/SocketProvider.js +0 -334
  186. package/dist/evm/WebSocketProviderWithRetries.d.ts +0 -17
  187. package/dist/evm/WebSocketProviderWithRetries.js +0 -19
@@ -1,77 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ReconnectingWebSocketProvider = void 0;
4
- const SocketProvider_1 = require("./SocketProvider");
5
- class ReconnectingWebSocketProvider extends SocketProvider_1.SocketProvider {
6
- constructor(url, network, options) {
7
- super(network, options);
8
- this.requestTimeoutSeconds = 10;
9
- this.reconnectSeconds = 5;
10
- this.pingIntervalSeconds = 30;
11
- this.wsCtor = typeof (url) === "string" ? () => new WebSocket(url) : url;
12
- this.connect();
13
- }
14
- connect() {
15
- this.websocket = this.wsCtor();
16
- this.websocket.onopen = () => {
17
- this._connected();
18
- this._start();
19
- this.pingInterval = setInterval(() => {
20
- this._send({ method: "eth_blockNumber", params: [], id: 1000000000, jsonrpc: "2.0" }).catch(e => {
21
- //Error
22
- if (e.code === "NETWORK_ERROR") {
23
- console.error("Websocket ping error: ", e);
24
- if (this.websocket != null) {
25
- this.websocket.close();
26
- this.disconnectedAndScheduleReconnect();
27
- }
28
- }
29
- });
30
- }, this.pingIntervalSeconds * 1000);
31
- };
32
- this.websocket.onerror = (err) => {
33
- console.error(`Websocket connection error: `, err);
34
- this.disconnectedAndScheduleReconnect();
35
- };
36
- this.websocket.onmessage = (message) => {
37
- this._processMessage(message.data);
38
- };
39
- this.websocket.onclose = (event) => {
40
- console.error(`Websocket connection closed: `, event);
41
- this.disconnectedAndScheduleReconnect();
42
- };
43
- }
44
- disconnectedAndScheduleReconnect() {
45
- if (this.destroyed)
46
- return;
47
- if (this.websocket == null)
48
- return;
49
- this.websocket.onclose = null;
50
- this.websocket.onerror = null;
51
- this.websocket.onmessage = null;
52
- this.websocket.onopen = null;
53
- this.websocket = null;
54
- if (this.pingInterval != null)
55
- clearInterval(this.pingInterval);
56
- this._disconnected();
57
- console.error(`Retrying in ${this.reconnectSeconds} seconds...`);
58
- this.reconnectTimer = setTimeout(() => this.connect(), this.reconnectSeconds * 1000);
59
- }
60
- async _write(message) {
61
- this.websocket.send(message);
62
- }
63
- async destroy() {
64
- if (this.websocket != null) {
65
- this.websocket.close();
66
- this.websocket = null;
67
- }
68
- if (this.reconnectTimer != null) {
69
- clearTimeout(this.reconnectTimer);
70
- }
71
- if (this.pingInterval != null) {
72
- clearInterval(this.pingInterval);
73
- }
74
- super.destroy();
75
- }
76
- }
77
- exports.ReconnectingWebSocketProvider = ReconnectingWebSocketProvider;
@@ -1,111 +0,0 @@
1
- /**
2
- * Generic long-lived socket provider.
3
- *
4
- * Sub-classing notes
5
- * - a sub-class MUST call the `_start()` method once connected
6
- * - a sub-class MUST override the `_write(string)` method
7
- * - a sub-class MUST call `_processMessage(string)` for each message
8
- *
9
- * @_subsection: api/providers/abstract-provider:Socket Providers [about-socketProvider]
10
- */
11
- import { EventFilter, JsonRpcApiProvider, JsonRpcApiProviderOptions, JsonRpcError, JsonRpcPayload, JsonRpcResult, Networkish, Subscriber, Subscription } from "ethers";
12
- /**
13
- * A **SocketSubscriber** uses a socket transport to handle events and
14
- * should use [[_emit]] to manage the events.
15
- */
16
- export declare class SocketSubscriber implements Subscriber {
17
- #private;
18
- /**
19
- * The filter.
20
- */
21
- get filter(): Array<any>;
22
- /**
23
- * Creates a new **SocketSubscriber** attached to %%provider%% listening
24
- * to %%filter%%.
25
- */
26
- constructor(provider: SocketProvider, filter: Array<any>);
27
- start(): void;
28
- stop(): void;
29
- pause(dropWhilePaused?: boolean): void;
30
- resume(): void;
31
- /**
32
- * @_ignore:
33
- */
34
- _handleMessage(message: any): void;
35
- /**
36
- * Sub-classes **must** override this to emit the events on the
37
- * provider.
38
- */
39
- _emit(provider: SocketProvider, message: any): Promise<void>;
40
- }
41
- /**
42
- * A **SocketBlockSubscriber** listens for ``newHeads`` events and emits
43
- * ``"block"`` events.
44
- */
45
- export declare class SocketBlockSubscriber extends SocketSubscriber {
46
- /**
47
- * @_ignore:
48
- */
49
- constructor(provider: SocketProvider);
50
- _emit(provider: SocketProvider, message: any): Promise<void>;
51
- }
52
- /**
53
- * A **SocketPendingSubscriber** listens for pending transacitons and emits
54
- * ``"pending"`` events.
55
- */
56
- export declare class SocketPendingSubscriber extends SocketSubscriber {
57
- /**
58
- * @_ignore:
59
- */
60
- constructor(provider: SocketProvider);
61
- _emit(provider: SocketProvider, message: any): Promise<void>;
62
- }
63
- /**
64
- * A **SocketEventSubscriber** listens for event logs.
65
- */
66
- export declare class SocketEventSubscriber extends SocketSubscriber {
67
- #private;
68
- /**
69
- * The filter.
70
- */
71
- get logFilter(): EventFilter;
72
- /**
73
- * @_ignore:
74
- */
75
- constructor(provider: SocketProvider, filter: EventFilter);
76
- _emit(provider: SocketProvider, message: any): Promise<void>;
77
- }
78
- /**
79
- * A **SocketProvider** is backed by a long-lived connection over a
80
- * socket, which can subscribe and receive real-time messages over
81
- * its communication channel.
82
- */
83
- export declare class SocketProvider extends JsonRpcApiProvider {
84
- #private;
85
- requestTimeoutSeconds: number;
86
- /**
87
- * Creates a new **SocketProvider** connected to %%network%%.
88
- *
89
- * If unspecified, the network will be discovered.
90
- */
91
- constructor(network?: Networkish, _options?: JsonRpcApiProviderOptions);
92
- _getSubscriber(sub: Subscription): Subscriber;
93
- /**
94
- * Register a new subscriber. This is used internalled by Subscribers
95
- * and generally is unecessary unless extending capabilities.
96
- */
97
- _register(filterId: number | string, subscriber: SocketSubscriber): void;
98
- _send(payload: JsonRpcPayload | Array<JsonRpcPayload>): Promise<Array<JsonRpcResult | JsonRpcError>>;
99
- _connected(): void;
100
- _disconnected(): void;
101
- /**
102
- * Sub-classes **must** call this with messages received over their
103
- * transport to be processed and dispatched.
104
- */
105
- _processMessage(message: string): Promise<void>;
106
- /**
107
- * Sub-classes **must** override this to send %%message%% over their
108
- * transport.
109
- */
110
- _write(message: string): Promise<void>;
111
- }
@@ -1,334 +0,0 @@
1
- "use strict";
2
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
4
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
5
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
6
- };
7
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
8
- if (kind === "m") throw new TypeError("Private method is not writable");
9
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
10
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
11
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
- };
13
- var _SocketSubscriber_provider, _SocketSubscriber_filter, _SocketSubscriber_filterId, _SocketSubscriber_paused, _SocketSubscriber_emitPromise, _SocketEventSubscriber_logFilter, _SocketProvider_callbacks, _SocketProvider_subs, _SocketProvider_pending, _SocketProvider_connected;
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.SocketProvider = exports.SocketEventSubscriber = exports.SocketPendingSubscriber = exports.SocketBlockSubscriber = exports.SocketSubscriber = void 0;
16
- /**
17
- * Generic long-lived socket provider.
18
- *
19
- * Sub-classing notes
20
- * - a sub-class MUST call the `_start()` method once connected
21
- * - a sub-class MUST override the `_write(string)` method
22
- * - a sub-class MUST call `_processMessage(string)` for each message
23
- *
24
- * @_subsection: api/providers/abstract-provider:Socket Providers [about-socketProvider]
25
- */
26
- const ethers_1 = require("ethers");
27
- /**
28
- * A **SocketSubscriber** uses a socket transport to handle events and
29
- * should use [[_emit]] to manage the events.
30
- */
31
- class SocketSubscriber {
32
- /**
33
- * The filter.
34
- */
35
- get filter() { return JSON.parse(__classPrivateFieldGet(this, _SocketSubscriber_filter, "f")); }
36
- /**
37
- * Creates a new **SocketSubscriber** attached to %%provider%% listening
38
- * to %%filter%%.
39
- */
40
- constructor(provider, filter) {
41
- _SocketSubscriber_provider.set(this, void 0);
42
- _SocketSubscriber_filter.set(this, void 0);
43
- _SocketSubscriber_filterId.set(this, void 0);
44
- _SocketSubscriber_paused.set(this, void 0);
45
- _SocketSubscriber_emitPromise.set(this, void 0);
46
- __classPrivateFieldSet(this, _SocketSubscriber_provider, provider, "f");
47
- __classPrivateFieldSet(this, _SocketSubscriber_filter, JSON.stringify(filter), "f");
48
- __classPrivateFieldSet(this, _SocketSubscriber_filterId, null, "f");
49
- __classPrivateFieldSet(this, _SocketSubscriber_paused, null, "f");
50
- __classPrivateFieldSet(this, _SocketSubscriber_emitPromise, null, "f");
51
- }
52
- start() {
53
- __classPrivateFieldSet(this, _SocketSubscriber_filterId, __classPrivateFieldGet(this, _SocketSubscriber_provider, "f").send("eth_subscribe", this.filter).then((filterId) => {
54
- ;
55
- __classPrivateFieldGet(this, _SocketSubscriber_provider, "f")._register(filterId, this);
56
- return filterId;
57
- }), "f");
58
- }
59
- stop() {
60
- (__classPrivateFieldGet(this, _SocketSubscriber_filterId, "f")).then((filterId) => {
61
- if (__classPrivateFieldGet(this, _SocketSubscriber_provider, "f").destroyed) {
62
- return;
63
- }
64
- __classPrivateFieldGet(this, _SocketSubscriber_provider, "f").send("eth_unsubscribe", [filterId]);
65
- });
66
- __classPrivateFieldSet(this, _SocketSubscriber_filterId, null, "f");
67
- }
68
- // @TODO: pause should trap the current blockNumber, unsub, and on resume use getLogs
69
- // and resume
70
- pause(dropWhilePaused) {
71
- (0, ethers_1.assert)(dropWhilePaused, "preserve logs while paused not supported by SocketSubscriber yet", "UNSUPPORTED_OPERATION", { operation: "pause(false)" });
72
- __classPrivateFieldSet(this, _SocketSubscriber_paused, !!dropWhilePaused, "f");
73
- }
74
- resume() {
75
- __classPrivateFieldSet(this, _SocketSubscriber_paused, null, "f");
76
- }
77
- /**
78
- * @_ignore:
79
- */
80
- _handleMessage(message) {
81
- if (__classPrivateFieldGet(this, _SocketSubscriber_filterId, "f") == null) {
82
- return;
83
- }
84
- if (__classPrivateFieldGet(this, _SocketSubscriber_paused, "f") === null) {
85
- let emitPromise = __classPrivateFieldGet(this, _SocketSubscriber_emitPromise, "f");
86
- if (emitPromise == null) {
87
- emitPromise = this._emit(__classPrivateFieldGet(this, _SocketSubscriber_provider, "f"), message);
88
- }
89
- else {
90
- emitPromise = emitPromise.then(async () => {
91
- await this._emit(__classPrivateFieldGet(this, _SocketSubscriber_provider, "f"), message);
92
- });
93
- }
94
- __classPrivateFieldSet(this, _SocketSubscriber_emitPromise, emitPromise.then(() => {
95
- if (__classPrivateFieldGet(this, _SocketSubscriber_emitPromise, "f") === emitPromise) {
96
- __classPrivateFieldSet(this, _SocketSubscriber_emitPromise, null, "f");
97
- }
98
- }), "f");
99
- }
100
- }
101
- /**
102
- * Sub-classes **must** override this to emit the events on the
103
- * provider.
104
- */
105
- async _emit(provider, message) {
106
- throw new Error("sub-classes must implemente this; _emit");
107
- }
108
- }
109
- exports.SocketSubscriber = SocketSubscriber;
110
- _SocketSubscriber_provider = new WeakMap(), _SocketSubscriber_filter = new WeakMap(), _SocketSubscriber_filterId = new WeakMap(), _SocketSubscriber_paused = new WeakMap(), _SocketSubscriber_emitPromise = new WeakMap();
111
- /**
112
- * A **SocketBlockSubscriber** listens for ``newHeads`` events and emits
113
- * ``"block"`` events.
114
- */
115
- class SocketBlockSubscriber extends SocketSubscriber {
116
- /**
117
- * @_ignore:
118
- */
119
- constructor(provider) {
120
- super(provider, ["newHeads"]);
121
- }
122
- async _emit(provider, message) {
123
- provider.emit("block", parseInt(message.number));
124
- }
125
- }
126
- exports.SocketBlockSubscriber = SocketBlockSubscriber;
127
- /**
128
- * A **SocketPendingSubscriber** listens for pending transacitons and emits
129
- * ``"pending"`` events.
130
- */
131
- class SocketPendingSubscriber extends SocketSubscriber {
132
- /**
133
- * @_ignore:
134
- */
135
- constructor(provider) {
136
- super(provider, ["newPendingTransactions"]);
137
- }
138
- async _emit(provider, message) {
139
- provider.emit("pending", message);
140
- }
141
- }
142
- exports.SocketPendingSubscriber = SocketPendingSubscriber;
143
- /**
144
- * A **SocketEventSubscriber** listens for event logs.
145
- */
146
- class SocketEventSubscriber extends SocketSubscriber {
147
- /**
148
- * The filter.
149
- */
150
- get logFilter() { return JSON.parse(__classPrivateFieldGet(this, _SocketEventSubscriber_logFilter, "f")); }
151
- /**
152
- * @_ignore:
153
- */
154
- constructor(provider, filter) {
155
- super(provider, ["logs", filter]);
156
- _SocketEventSubscriber_logFilter.set(this, void 0);
157
- __classPrivateFieldSet(this, _SocketEventSubscriber_logFilter, JSON.stringify(filter), "f");
158
- }
159
- async _emit(provider, message) {
160
- provider.emit(this.logFilter, provider._wrapLog(message, provider._network));
161
- }
162
- }
163
- exports.SocketEventSubscriber = SocketEventSubscriber;
164
- _SocketEventSubscriber_logFilter = new WeakMap();
165
- /**
166
- * A **SocketProvider** is backed by a long-lived connection over a
167
- * socket, which can subscribe and receive real-time messages over
168
- * its communication channel.
169
- */
170
- class SocketProvider extends ethers_1.JsonRpcApiProvider {
171
- /**
172
- * Creates a new **SocketProvider** connected to %%network%%.
173
- *
174
- * If unspecified, the network will be discovered.
175
- */
176
- constructor(network, _options) {
177
- // Copy the options
178
- const options = Object.assign({}, (_options != null) ? _options : {});
179
- // Support for batches is generally not supported for
180
- // connection-base providers; if this changes in the future
181
- // the _send should be updated to reflect this
182
- (0, ethers_1.assertArgument)(options.batchMaxCount == null || options.batchMaxCount === 1, "sockets-based providers do not support batches", "options.batchMaxCount", _options);
183
- options.batchMaxCount = 1;
184
- // Socket-based Providers (generally) cannot change their network,
185
- // since they have a long-lived connection; but let people override
186
- // this if they have just cause.
187
- if (options.staticNetwork == null) {
188
- options.staticNetwork = true;
189
- }
190
- super(network, options);
191
- this.requestTimeoutSeconds = 10;
192
- _SocketProvider_callbacks.set(this, void 0);
193
- // Maps each filterId to its subscriber
194
- _SocketProvider_subs.set(this, void 0);
195
- // If any events come in before a subscriber has finished
196
- // registering, queue them
197
- _SocketProvider_pending.set(this, void 0);
198
- _SocketProvider_connected.set(this, void 0);
199
- __classPrivateFieldSet(this, _SocketProvider_callbacks, new Map(), "f");
200
- __classPrivateFieldSet(this, _SocketProvider_subs, new Map(), "f");
201
- __classPrivateFieldSet(this, _SocketProvider_pending, new Map(), "f");
202
- }
203
- // This value is only valid after _start has been called
204
- /*
205
- get _network(): Network {
206
- if (this.#network == null) {
207
- throw new Error("this shouldn't happen");
208
- }
209
- return this.#network.clone();
210
- }
211
- */
212
- _getSubscriber(sub) {
213
- switch (sub.type) {
214
- case "close":
215
- return new ethers_1.UnmanagedSubscriber("close");
216
- case "block":
217
- return new SocketBlockSubscriber(this);
218
- case "pending":
219
- return new SocketPendingSubscriber(this);
220
- case "event":
221
- return new SocketEventSubscriber(this, sub.filter);
222
- case "orphan":
223
- // Handled auto-matically within AbstractProvider
224
- // when the log.removed = true
225
- if (sub.filter.orphan === "drop-log") {
226
- return new ethers_1.UnmanagedSubscriber("drop-log");
227
- }
228
- }
229
- return super._getSubscriber(sub);
230
- }
231
- /**
232
- * Register a new subscriber. This is used internalled by Subscribers
233
- * and generally is unecessary unless extending capabilities.
234
- */
235
- _register(filterId, subscriber) {
236
- __classPrivateFieldGet(this, _SocketProvider_subs, "f").set(filterId, subscriber);
237
- const pending = __classPrivateFieldGet(this, _SocketProvider_pending, "f").get(filterId);
238
- if (pending) {
239
- for (const message of pending) {
240
- subscriber._handleMessage(message);
241
- }
242
- __classPrivateFieldGet(this, _SocketProvider_pending, "f").delete(filterId);
243
- }
244
- }
245
- async _send(payload) {
246
- // WebSocket provider doesn't accept batches
247
- (0, ethers_1.assertArgument)(!Array.isArray(payload), "WebSocket does not support batch send", "payload", payload);
248
- // Wait until the socket is connected before writing to it
249
- await this._waitUntilReady();
250
- if (!__classPrivateFieldGet(this, _SocketProvider_connected, "f") && payload.method === "eth_subscribe")
251
- return Promise.reject((0, ethers_1.makeError)("WebSocket not connected!", "NETWORK_ERROR"));
252
- // Prepare a promise to respond to
253
- const promise = new Promise((resolve, reject) => {
254
- const timeout = setTimeout(() => {
255
- if (__classPrivateFieldGet(this, _SocketProvider_callbacks, "f").delete(payload.id)) {
256
- reject((0, ethers_1.makeError)("Request timed out!", "NETWORK_ERROR"));
257
- }
258
- }, this.requestTimeoutSeconds * 1000);
259
- __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").set(payload.id, { payload, resolve, reject, timeout });
260
- });
261
- // Write the request to the socket
262
- if (__classPrivateFieldGet(this, _SocketProvider_connected, "f"))
263
- await this._write(JSON.stringify(payload));
264
- return [await promise];
265
- }
266
- _connected() {
267
- __classPrivateFieldSet(this, _SocketProvider_connected, true, "f");
268
- this.resume();
269
- this._forEachSubscriber(subscriber => subscriber.start());
270
- __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").forEach(val => {
271
- this._write(JSON.stringify(val.payload));
272
- });
273
- }
274
- _disconnected() {
275
- __classPrivateFieldSet(this, _SocketProvider_connected, false, "f");
276
- this.pause(true);
277
- __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").forEach(val => {
278
- clearTimeout(val.timeout);
279
- val.reject((0, ethers_1.makeError)("WebSocket disconnected!", "NETWORK_ERROR"));
280
- });
281
- __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").clear();
282
- }
283
- /**
284
- * Sub-classes **must** call this with messages received over their
285
- * transport to be processed and dispatched.
286
- */
287
- async _processMessage(message) {
288
- const result = (JSON.parse(message));
289
- if (result && typeof (result) === "object" && "id" in result) {
290
- const callback = __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").get(result.id);
291
- if (callback == null) {
292
- this.emit("error", (0, ethers_1.makeError)("received result for unknown id", "UNKNOWN_ERROR", {
293
- reasonCode: "UNKNOWN_ID",
294
- result
295
- }));
296
- return;
297
- }
298
- __classPrivateFieldGet(this, _SocketProvider_callbacks, "f").delete(result.id);
299
- clearTimeout(callback.timeout);
300
- callback.resolve(result);
301
- }
302
- else if (result && result.method === "eth_subscription") {
303
- const filterId = result.params.subscription;
304
- const subscriber = __classPrivateFieldGet(this, _SocketProvider_subs, "f").get(filterId);
305
- if (subscriber) {
306
- subscriber._handleMessage(result.params.result);
307
- }
308
- else {
309
- let pending = __classPrivateFieldGet(this, _SocketProvider_pending, "f").get(filterId);
310
- if (pending == null) {
311
- pending = [];
312
- __classPrivateFieldGet(this, _SocketProvider_pending, "f").set(filterId, pending);
313
- }
314
- pending.push(result.params.result);
315
- }
316
- }
317
- else {
318
- this.emit("error", (0, ethers_1.makeError)("received unexpected message", "UNKNOWN_ERROR", {
319
- reasonCode: "UNEXPECTED_MESSAGE",
320
- result
321
- }));
322
- return;
323
- }
324
- }
325
- /**
326
- * Sub-classes **must** override this to send %%message%% over their
327
- * transport.
328
- */
329
- async _write(message) {
330
- throw new Error("sub-classes must override this");
331
- }
332
- }
333
- exports.SocketProvider = SocketProvider;
334
- _SocketProvider_callbacks = new WeakMap(), _SocketProvider_subs = new WeakMap(), _SocketProvider_pending = new WeakMap(), _SocketProvider_connected = new WeakMap();
@@ -1,17 +0,0 @@
1
- import { JsonRpcApiProviderOptions } from "ethers";
2
- import type { Networkish } from "ethers";
3
- import { ReconnectingWebSocketProvider } from "./ReconnectingWebSocketProvider";
4
- import type { WebSocketLike } from "ethers/lib.esm";
5
- export declare class WebSocketProviderWithRetries extends ReconnectingWebSocketProvider {
6
- readonly retryPolicy?: {
7
- maxRetries?: number;
8
- delay?: number;
9
- exponential?: boolean;
10
- };
11
- constructor(url: string | (() => WebSocketLike), network?: Networkish, options?: JsonRpcApiProviderOptions & {
12
- maxRetries?: number;
13
- delay?: number;
14
- exponential?: boolean;
15
- });
16
- send(method: string, params: Array<any> | Record<string, any>): Promise<any>;
17
- }
@@ -1,19 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WebSocketProviderWithRetries = void 0;
4
- const Utils_1 = require("../utils/Utils");
5
- const ReconnectingWebSocketProvider_1 = require("./ReconnectingWebSocketProvider");
6
- class WebSocketProviderWithRetries extends ReconnectingWebSocketProvider_1.ReconnectingWebSocketProvider {
7
- constructor(url, network, options) {
8
- super(url, network, options);
9
- this.retryPolicy = options;
10
- }
11
- send(method, params) {
12
- return (0, Utils_1.tryWithRetries)(() => super.send(method, params), this.retryPolicy, e => {
13
- return false;
14
- // if(e?.error?.code!=null) return false; //Error returned by the RPC
15
- // return true;
16
- });
17
- }
18
- }
19
- exports.WebSocketProviderWithRetries = WebSocketProviderWithRetries;