@metamask-previews/network-controller 36.0.0-preview-3866c0ff1 → 36.0.0-preview-e3275932a

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 (158) hide show
  1. package/CHANGELOG.md +0 -1
  2. package/dist/NetworkController-method-action-types.cjs +7 -0
  3. package/dist/NetworkController-method-action-types.cjs.map +1 -0
  4. package/dist/{NetworkController-method-action-types.d.ts → NetworkController-method-action-types.d.cts} +2 -2
  5. package/dist/NetworkController-method-action-types.d.cts.map +1 -0
  6. package/dist/NetworkController-method-action-types.d.mts +268 -0
  7. package/dist/NetworkController-method-action-types.d.mts.map +1 -0
  8. package/dist/{NetworkController-method-action-types.js → NetworkController-method-action-types.mjs} +1 -1
  9. package/dist/NetworkController-method-action-types.mjs.map +1 -0
  10. package/dist/NetworkController.cjs +1599 -0
  11. package/dist/NetworkController.cjs.map +1 -0
  12. package/dist/{NetworkController.d.ts → NetworkController.d.cts} +29 -37
  13. package/dist/NetworkController.d.cts.map +1 -0
  14. package/dist/NetworkController.d.mts +956 -0
  15. package/dist/NetworkController.d.mts.map +1 -0
  16. package/dist/{NetworkController.js → NetworkController.mjs} +612 -716
  17. package/dist/NetworkController.mjs.map +1 -0
  18. package/dist/constants.cjs +46 -0
  19. package/dist/constants.cjs.map +1 -0
  20. package/dist/{constants.d.ts → constants.d.cts} +1 -1
  21. package/dist/constants.d.cts.map +1 -0
  22. package/dist/constants.d.mts +42 -0
  23. package/dist/constants.d.mts.map +1 -0
  24. package/dist/{constants.js → constants.mjs} +1 -1
  25. package/dist/constants.mjs.map +1 -0
  26. package/dist/create-auto-managed-network-client.cjs +149 -0
  27. package/dist/create-auto-managed-network-client.cjs.map +1 -0
  28. package/dist/{create-auto-managed-network-client.d.ts → create-auto-managed-network-client.d.cts} +7 -7
  29. package/dist/create-auto-managed-network-client.d.cts.map +1 -0
  30. package/dist/create-auto-managed-network-client.d.mts +74 -0
  31. package/dist/create-auto-managed-network-client.d.mts.map +1 -0
  32. package/dist/{create-auto-managed-network-client.js → create-auto-managed-network-client.mjs} +4 -4
  33. package/dist/create-auto-managed-network-client.mjs.map +1 -0
  34. package/dist/create-network-client.cjs +439 -0
  35. package/dist/create-network-client.cjs.map +1 -0
  36. package/dist/{create-network-client.d.ts → create-network-client.d.cts} +7 -7
  37. package/dist/create-network-client.d.cts.map +1 -0
  38. package/dist/create-network-client.d.mts +60 -0
  39. package/dist/create-network-client.d.mts.map +1 -0
  40. package/dist/{create-network-client.js → create-network-client.mjs} +14 -15
  41. package/dist/create-network-client.mjs.map +1 -0
  42. package/dist/index.cjs +31 -0
  43. package/dist/index.cjs.map +1 -0
  44. package/dist/{index.d.ts → index.d.cts} +16 -16
  45. package/dist/index.d.cts.map +1 -0
  46. package/dist/index.d.mts +16 -0
  47. package/dist/index.d.mts.map +1 -0
  48. package/dist/index.mjs +6 -0
  49. package/dist/index.mjs.map +1 -0
  50. package/dist/logger.cjs +7 -0
  51. package/dist/logger.cjs.map +1 -0
  52. package/dist/logger.d.cts +5 -0
  53. package/dist/logger.d.cts.map +1 -0
  54. package/dist/logger.d.mts +5 -0
  55. package/dist/logger.d.mts.map +1 -0
  56. package/dist/logger.mjs +4 -0
  57. package/dist/logger.mjs.map +1 -0
  58. package/dist/rpc-service/abstract-rpc-service.cjs +3 -0
  59. package/dist/rpc-service/abstract-rpc-service.cjs.map +1 -0
  60. package/dist/rpc-service/{abstract-rpc-service.d.ts → abstract-rpc-service.d.cts} +2 -2
  61. package/dist/rpc-service/abstract-rpc-service.d.cts.map +1 -0
  62. package/dist/rpc-service/abstract-rpc-service.d.mts +17 -0
  63. package/dist/rpc-service/abstract-rpc-service.d.mts.map +1 -0
  64. package/dist/rpc-service/abstract-rpc-service.mjs +2 -0
  65. package/dist/rpc-service/abstract-rpc-service.mjs.map +1 -0
  66. package/dist/rpc-service/rpc-service-chain.cjs +304 -0
  67. package/dist/rpc-service/rpc-service-chain.cjs.map +1 -0
  68. package/dist/rpc-service/{rpc-service-chain.d.ts → rpc-service-chain.d.cts} +6 -6
  69. package/dist/rpc-service/rpc-service-chain.d.cts.map +1 -0
  70. package/dist/rpc-service/rpc-service-chain.d.mts +169 -0
  71. package/dist/rpc-service/rpc-service-chain.d.mts.map +1 -0
  72. package/dist/rpc-service/{rpc-service-chain.js → rpc-service-chain.mjs} +70 -57
  73. package/dist/rpc-service/rpc-service-chain.mjs.map +1 -0
  74. package/dist/rpc-service/rpc-service-requestable.cjs +3 -0
  75. package/dist/rpc-service/rpc-service-requestable.cjs.map +1 -0
  76. package/dist/rpc-service/{rpc-service-requestable.d.ts → rpc-service-requestable.d.cts} +4 -4
  77. package/dist/rpc-service/rpc-service-requestable.d.cts.map +1 -0
  78. package/dist/rpc-service/rpc-service-requestable.d.mts +63 -0
  79. package/dist/rpc-service/rpc-service-requestable.d.mts.map +1 -0
  80. package/dist/rpc-service/rpc-service-requestable.mjs +2 -0
  81. package/dist/rpc-service/rpc-service-requestable.mjs.map +1 -0
  82. package/dist/rpc-service/rpc-service.cjs +540 -0
  83. package/dist/rpc-service/rpc-service.cjs.map +1 -0
  84. package/dist/rpc-service/{rpc-service.d.ts → rpc-service.d.cts} +6 -6
  85. package/dist/rpc-service/rpc-service.d.cts.map +1 -0
  86. package/dist/rpc-service/rpc-service.d.mts +247 -0
  87. package/dist/rpc-service/rpc-service.d.mts.map +1 -0
  88. package/dist/rpc-service/{rpc-service.js → rpc-service.mjs} +197 -206
  89. package/dist/rpc-service/rpc-service.mjs.map +1 -0
  90. package/dist/rpc-service/shared.cjs +3 -0
  91. package/dist/rpc-service/shared.cjs.map +1 -0
  92. package/dist/rpc-service/{shared.d.ts → shared.d.cts} +2 -2
  93. package/dist/rpc-service/shared.d.cts.map +1 -0
  94. package/dist/rpc-service/shared.d.mts +32 -0
  95. package/dist/rpc-service/shared.d.mts.map +1 -0
  96. package/dist/rpc-service/shared.mjs +2 -0
  97. package/dist/rpc-service/shared.mjs.map +1 -0
  98. package/dist/rpc-service-analytics.cjs +180 -0
  99. package/dist/rpc-service-analytics.cjs.map +1 -0
  100. package/dist/{rpc-service-analytics.d.ts → rpc-service-analytics.d.cts} +3 -3
  101. package/dist/rpc-service-analytics.d.cts.map +1 -0
  102. package/dist/rpc-service-analytics.d.mts +85 -0
  103. package/dist/rpc-service-analytics.d.mts.map +1 -0
  104. package/dist/{rpc-service-analytics.js → rpc-service-analytics.mjs} +4 -4
  105. package/dist/rpc-service-analytics.mjs.map +1 -0
  106. package/dist/selectors.cjs +16 -0
  107. package/dist/selectors.cjs.map +1 -0
  108. package/dist/{selectors.d.ts → selectors.d.cts} +2 -2
  109. package/dist/selectors.d.cts.map +1 -0
  110. package/dist/selectors.d.mts +22 -0
  111. package/dist/selectors.d.mts.map +1 -0
  112. package/dist/{selectors.js → selectors.mjs} +1 -1
  113. package/dist/selectors.mjs.map +1 -0
  114. package/dist/types.cjs +12 -0
  115. package/dist/types.cjs.map +1 -0
  116. package/dist/{types.d.ts → types.d.cts} +5 -5
  117. package/dist/types.d.cts.map +1 -0
  118. package/dist/types.d.mts +49 -0
  119. package/dist/types.d.mts.map +1 -0
  120. package/dist/{types.js → types.mjs} +1 -1
  121. package/dist/types.mjs.map +1 -0
  122. package/package.json +18 -14
  123. package/dist/NetworkController-method-action-types.d.ts.map +0 -1
  124. package/dist/NetworkController-method-action-types.js.map +0 -1
  125. package/dist/NetworkController.d.ts.map +0 -1
  126. package/dist/NetworkController.js.map +0 -1
  127. package/dist/constants.d.ts.map +0 -1
  128. package/dist/constants.js.map +0 -1
  129. package/dist/create-auto-managed-network-client.d.ts.map +0 -1
  130. package/dist/create-auto-managed-network-client.js.map +0 -1
  131. package/dist/create-network-client.d.ts.map +0 -1
  132. package/dist/create-network-client.js.map +0 -1
  133. package/dist/index.d.ts.map +0 -1
  134. package/dist/index.js +0 -6
  135. package/dist/index.js.map +0 -1
  136. package/dist/logger.d.ts +0 -4
  137. package/dist/logger.d.ts.map +0 -1
  138. package/dist/logger.js +0 -4
  139. package/dist/logger.js.map +0 -1
  140. package/dist/rpc-service/abstract-rpc-service.d.ts.map +0 -1
  141. package/dist/rpc-service/abstract-rpc-service.js +0 -2
  142. package/dist/rpc-service/abstract-rpc-service.js.map +0 -1
  143. package/dist/rpc-service/rpc-service-chain.d.ts.map +0 -1
  144. package/dist/rpc-service/rpc-service-chain.js.map +0 -1
  145. package/dist/rpc-service/rpc-service-requestable.d.ts.map +0 -1
  146. package/dist/rpc-service/rpc-service-requestable.js +0 -2
  147. package/dist/rpc-service/rpc-service-requestable.js.map +0 -1
  148. package/dist/rpc-service/rpc-service.d.ts.map +0 -1
  149. package/dist/rpc-service/rpc-service.js.map +0 -1
  150. package/dist/rpc-service/shared.d.ts.map +0 -1
  151. package/dist/rpc-service/shared.js +0 -2
  152. package/dist/rpc-service/shared.js.map +0 -1
  153. package/dist/rpc-service-analytics.d.ts.map +0 -1
  154. package/dist/rpc-service-analytics.js.map +0 -1
  155. package/dist/selectors.d.ts.map +0 -1
  156. package/dist/selectors.js.map +0 -1
  157. package/dist/types.d.ts.map +0 -1
  158. package/dist/types.js.map +0 -1
@@ -1,6 +1,18 @@
1
- import { CircuitState, CockatielEventEmitter, } from '@metamask/controller-utils';
2
- import { projectLogger, createModuleLogger } from '../logger.js';
3
- import { RpcService } from './rpc-service.js';
1
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
+ if (kind === "m") throw new TypeError("Private method is not writable");
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
+ 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");
5
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
+ };
7
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
+ 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");
10
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
+ };
12
+ var _RpcServiceChain_onAvailableEventEmitter, _RpcServiceChain_onBreakEventEmitter, _RpcServiceChain_onDegradedEventEmitter, _RpcServiceChain_primaryService, _RpcServiceChain_services, _RpcServiceChain_status;
13
+ import { CircuitState, CockatielEventEmitter } from "@metamask/controller-utils";
14
+ import { projectLogger, createModuleLogger } from "../logger.mjs";
15
+ import { RpcService } from "./rpc-service.mjs";
4
16
  const log = createModuleLogger(projectLogger, 'RpcServiceChain');
5
17
  /**
6
18
  * Statuses that the RPC service chain can be in.
@@ -18,30 +30,6 @@ const STATUSES = {
18
30
  * network and the remaining services are used as failovers.
19
31
  */
20
32
  export class RpcServiceChain {
21
- /**
22
- * The event emitter for the `onAvailable` event.
23
- */
24
- #onAvailableEventEmitter;
25
- /**
26
- * The event emitter for the `onBreak` event.
27
- */
28
- #onBreakEventEmitter;
29
- /**
30
- * The event emitter for the `onDegraded` event.
31
- */
32
- #onDegradedEventEmitter;
33
- /**
34
- * The first RPC service that requests will be sent to.
35
- */
36
- #primaryService;
37
- /**
38
- * The RPC services in the chain.
39
- */
40
- #services;
41
- /**
42
- * The status of the RPC service chain.
43
- */
44
- #status;
45
33
  /**
46
34
  * Constructs a new RpcServiceChain object.
47
35
  *
@@ -50,29 +38,53 @@ export class RpcServiceChain {
50
38
  * {@link RpcServiceOptions}.
51
39
  */
52
40
  constructor(rpcServiceConfigurations) {
53
- this.#services = rpcServiceConfigurations.map((rpcServiceConfiguration) => new RpcService(rpcServiceConfiguration));
54
- this.#primaryService = this.#services[0];
55
- this.#status = STATUSES.Unknown;
56
- this.#onBreakEventEmitter = new CockatielEventEmitter();
57
- this.#onDegradedEventEmitter = new CockatielEventEmitter();
58
- for (const service of this.#services) {
41
+ /**
42
+ * The event emitter for the `onAvailable` event.
43
+ */
44
+ _RpcServiceChain_onAvailableEventEmitter.set(this, void 0);
45
+ /**
46
+ * The event emitter for the `onBreak` event.
47
+ */
48
+ _RpcServiceChain_onBreakEventEmitter.set(this, void 0);
49
+ /**
50
+ * The event emitter for the `onDegraded` event.
51
+ */
52
+ _RpcServiceChain_onDegradedEventEmitter.set(this, void 0);
53
+ /**
54
+ * The first RPC service that requests will be sent to.
55
+ */
56
+ _RpcServiceChain_primaryService.set(this, void 0);
57
+ /**
58
+ * The RPC services in the chain.
59
+ */
60
+ _RpcServiceChain_services.set(this, void 0);
61
+ /**
62
+ * The status of the RPC service chain.
63
+ */
64
+ _RpcServiceChain_status.set(this, void 0);
65
+ __classPrivateFieldSet(this, _RpcServiceChain_services, rpcServiceConfigurations.map((rpcServiceConfiguration) => new RpcService(rpcServiceConfiguration)), "f");
66
+ __classPrivateFieldSet(this, _RpcServiceChain_primaryService, __classPrivateFieldGet(this, _RpcServiceChain_services, "f")[0], "f");
67
+ __classPrivateFieldSet(this, _RpcServiceChain_status, STATUSES.Unknown, "f");
68
+ __classPrivateFieldSet(this, _RpcServiceChain_onBreakEventEmitter, new CockatielEventEmitter(), "f");
69
+ __classPrivateFieldSet(this, _RpcServiceChain_onDegradedEventEmitter, new CockatielEventEmitter(), "f");
70
+ for (const service of __classPrivateFieldGet(this, _RpcServiceChain_services, "f")) {
59
71
  service.onDegraded((data) => {
60
- if (this.#status !== STATUSES.Degraded) {
72
+ if (__classPrivateFieldGet(this, _RpcServiceChain_status, "f") !== STATUSES.Degraded) {
61
73
  log('Updating status to "degraded"', data);
62
- this.#status = STATUSES.Degraded;
74
+ __classPrivateFieldSet(this, _RpcServiceChain_status, STATUSES.Degraded, "f");
63
75
  const { endpointUrl, ...rest } = data;
64
- this.#onDegradedEventEmitter.emit(rest);
76
+ __classPrivateFieldGet(this, _RpcServiceChain_onDegradedEventEmitter, "f").emit(rest);
65
77
  }
66
78
  });
67
79
  }
68
- this.#onAvailableEventEmitter = new CockatielEventEmitter();
69
- for (const service of this.#services) {
80
+ __classPrivateFieldSet(this, _RpcServiceChain_onAvailableEventEmitter, new CockatielEventEmitter(), "f");
81
+ for (const service of __classPrivateFieldGet(this, _RpcServiceChain_services, "f")) {
70
82
  service.onAvailable((data) => {
71
- if (this.#status !== STATUSES.Available) {
83
+ if (__classPrivateFieldGet(this, _RpcServiceChain_status, "f") !== STATUSES.Available) {
72
84
  log('Updating status to "available"', data);
73
- this.#status = STATUSES.Available;
85
+ __classPrivateFieldSet(this, _RpcServiceChain_status, STATUSES.Available, "f");
74
86
  const { endpointUrl, ...rest } = data;
75
- this.#onAvailableEventEmitter.emit(rest);
87
+ __classPrivateFieldGet(this, _RpcServiceChain_onAvailableEventEmitter, "f").emit(rest);
76
88
  }
77
89
  });
78
90
  }
@@ -87,10 +99,10 @@ export class RpcServiceChain {
87
99
  * the event listener.
88
100
  */
89
101
  onServiceRetry(listener) {
90
- const disposables = this.#services.map((service) => service.onRetry((data) => {
102
+ const disposables = __classPrivateFieldGet(this, _RpcServiceChain_services, "f").map((service) => service.onRetry((data) => {
91
103
  listener({
92
104
  ...data,
93
- primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),
105
+ primaryEndpointUrl: __classPrivateFieldGet(this, _RpcServiceChain_primaryService, "f").endpointUrl.toString(),
94
106
  });
95
107
  }));
96
108
  return {
@@ -114,7 +126,7 @@ export class RpcServiceChain {
114
126
  * the callback.
115
127
  */
116
128
  onBreak(listener) {
117
- return this.#onBreakEventEmitter.addListener(listener);
129
+ return __classPrivateFieldGet(this, _RpcServiceChain_onBreakEventEmitter, "f").addListener(listener);
118
130
  }
119
131
  /**
120
132
  * Calls the provided callback each time when, for *any* of the RPC services
@@ -127,10 +139,10 @@ export class RpcServiceChain {
127
139
  * the callback.
128
140
  */
129
141
  onServiceBreak(listener) {
130
- const disposables = this.#services.map((service) => service.onBreak((data) => {
142
+ const disposables = __classPrivateFieldGet(this, _RpcServiceChain_services, "f").map((service) => service.onBreak((data) => {
131
143
  listener({
132
144
  ...data,
133
- primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),
145
+ primaryEndpointUrl: __classPrivateFieldGet(this, _RpcServiceChain_primaryService, "f").endpointUrl.toString(),
134
146
  });
135
147
  }));
136
148
  return {
@@ -163,7 +175,7 @@ export class RpcServiceChain {
163
175
  * the callback.
164
176
  */
165
177
  onDegraded(listener) {
166
- return this.#onDegradedEventEmitter.addListener(listener);
178
+ return __classPrivateFieldGet(this, _RpcServiceChain_onDegradedEventEmitter, "f").addListener(listener);
167
179
  }
168
180
  /**
169
181
  * Calls the provided callback each time one of the two conditions apply:
@@ -186,10 +198,10 @@ export class RpcServiceChain {
186
198
  * the callback.
187
199
  */
188
200
  onServiceDegraded(listener) {
189
- const disposables = this.#services.map((service) => service.onDegraded((data) => {
201
+ const disposables = __classPrivateFieldGet(this, _RpcServiceChain_services, "f").map((service) => service.onDegraded((data) => {
190
202
  listener({
191
203
  ...data,
192
- primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),
204
+ primaryEndpointUrl: __classPrivateFieldGet(this, _RpcServiceChain_primaryService, "f").endpointUrl.toString(),
193
205
  });
194
206
  }));
195
207
  return {
@@ -215,7 +227,7 @@ export class RpcServiceChain {
215
227
  * the callback.
216
228
  */
217
229
  onAvailable(listener) {
218
- return this.#onAvailableEventEmitter.addListener(listener);
230
+ return __classPrivateFieldGet(this, _RpcServiceChain_onAvailableEventEmitter, "f").addListener(listener);
219
231
  }
220
232
  async request(jsonRpcRequest, fetchOptions = {}) {
221
233
  // Start with the primary (first) service and switch to failovers as the
@@ -223,7 +235,7 @@ export class RpcServiceChain {
223
235
  // this works.
224
236
  let availableServiceIndex;
225
237
  let response;
226
- for (const [i, service] of this.#services.entries()) {
238
+ for (const [i, service] of __classPrivateFieldGet(this, _RpcServiceChain_services, "f").entries()) {
227
239
  log(`Trying service #${i + 1}...`);
228
240
  const previousCircuitState = service.getCircuitState();
229
241
  try {
@@ -240,19 +252,19 @@ export class RpcServiceChain {
240
252
  const isCircuitOpen = service.getCircuitState() === CircuitState.Open;
241
253
  log('Service failed! error =', error, 'lastError = ', lastError);
242
254
  if (isCircuitOpen) {
243
- if (i < this.#services.length - 1) {
255
+ if (i < __classPrivateFieldGet(this, _RpcServiceChain_services, "f").length - 1) {
244
256
  log("This service's circuit is open. Proceeding to next service...");
245
257
  continue;
246
258
  }
247
259
  if (previousCircuitState !== CircuitState.Open &&
248
- this.#status !== STATUSES.Unavailable &&
260
+ __classPrivateFieldGet(this, _RpcServiceChain_status, "f") !== STATUSES.Unavailable &&
249
261
  lastError !== undefined) {
250
262
  // If the service's circuit just broke and it's the last one in the
251
263
  // chain, then trigger the onBreak event. (But if for some reason we
252
264
  // have already done this, then don't do it.)
253
265
  log('This service\'s circuit just opened and it is the last service. Updating status to "unavailable" and triggering onBreak.');
254
- this.#status = STATUSES.Unavailable;
255
- this.#onBreakEventEmitter.emit({
266
+ __classPrivateFieldSet(this, _RpcServiceChain_status, STATUSES.Unavailable, "f");
267
+ __classPrivateFieldGet(this, _RpcServiceChain_onBreakEventEmitter, "f").emit({
256
268
  error: lastError,
257
269
  });
258
270
  }
@@ -271,7 +283,7 @@ export class RpcServiceChain {
271
283
  // error when we attempted to divert traffic to the failovers again.
272
284
  //
273
285
  if (availableServiceIndex !== undefined) {
274
- for (const [i, service] of [...this.#services.entries()].slice(availableServiceIndex + 1)) {
286
+ for (const [i, service] of [...__classPrivateFieldGet(this, _RpcServiceChain_services, "f").entries()].slice(availableServiceIndex + 1)) {
275
287
  log(`Resetting policy for service #${i + 1}.`);
276
288
  service.resetPolicy();
277
289
  }
@@ -284,4 +296,5 @@ export class RpcServiceChain {
284
296
  throw new Error('Nothing to return');
285
297
  }
286
298
  }
287
- //# sourceMappingURL=rpc-service-chain.js.map
299
+ _RpcServiceChain_onAvailableEventEmitter = new WeakMap(), _RpcServiceChain_onBreakEventEmitter = new WeakMap(), _RpcServiceChain_onDegradedEventEmitter = new WeakMap(), _RpcServiceChain_primaryService = new WeakMap(), _RpcServiceChain_services = new WeakMap(), _RpcServiceChain_status = new WeakMap();
300
+ //# sourceMappingURL=rpc-service-chain.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-service-chain.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-chain.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,YAAY,EACZ,qBAAqB,EACtB,mCAAmC;AASpC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAqB;AACjE,OAAO,EAAE,UAAU,EAAE,0BAAyB;AAS9C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,QAAQ,GAAG;IACf,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAOX;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IA8C1B;;;;;;OAMG;IACH,YACE,wBAAqE;QArDvE;;WAEG;QACM,2DAKP;QAEF;;WAEG;QACM,uDAKP;QAEF;;WAEG;QACM,0DAKP;QAEF;;WAEG;QACM,kDAA4B;QAErC;;WAEG;QACM,4CAAwB;QAEjC;;WAEG;QACH,0CAAgB;QAYd,uBAAA,IAAI,6BAAa,wBAAwB,CAAC,GAAG,CAC3C,CAAC,uBAAuB,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,uBAAuB,CAAC,CACrE,MAAA,CAAC;QACF,uBAAA,IAAI,mCAAmB,uBAAA,IAAI,iCAAU,CAAC,CAAC,CAAC,MAAA,CAAC;QAEzC,uBAAA,IAAI,2BAAW,QAAQ,CAAC,OAAO,MAAA,CAAC;QAChC,uBAAA,IAAI,wCAAwB,IAAI,qBAAqB,EAKlD,MAAA,CAAC;QAEJ,uBAAA,IAAI,2CAA2B,IAAI,qBAAqB,EAKrD,MAAA,CAAC;QACJ,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,iCAAU,EAAE,CAAC;YACrC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC1B,IAAI,uBAAA,IAAI,+BAAQ,KAAK,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBACvC,GAAG,CAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC;oBAC3C,uBAAA,IAAI,2BAAW,QAAQ,CAAC,QAAQ,MAAA,CAAC;oBACjC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;oBACtC,uBAAA,IAAI,+CAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,uBAAA,IAAI,4CAA4B,IAAI,qBAAqB,EAKtD,MAAA,CAAC;QACJ,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,iCAAU,EAAE,CAAC;YACrC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC3B,IAAI,uBAAA,IAAI,+BAAQ,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC;oBACxC,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;oBAC5C,uBAAA,IAAI,2BAAW,QAAQ,CAAC,SAAS,MAAA,CAAC;oBAClC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;oBACtC,uBAAA,IAAI,gDAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAGC;QAED,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,QAAQ,CAAC;gBACP,GAAG,IAAI;gBACP,kBAAkB,EAAE,uBAAA,IAAI,uCAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE;aAChE,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,QAKS;QAET,OAAO,uBAAA,IAAI,4CAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACH,cAAc,CACZ,QAGC;QAED,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,QAAQ,CAAC;gBACP,GAAG,IAAI;gBACP,kBAAkB,EAAE,uBAAA,IAAI,uCAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE;aAChE,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAU,CACR,QAKS;QAET,OAAO,uBAAA,IAAI,+CAAwB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CACf,QAGC;QAED,MAAM,WAAW,GAAG,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,QAAQ,CAAC;gBACP,GAAG,IAAI;gBACP,kBAAkB,EAAE,uBAAA,IAAI,uCAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE;aAChE,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,OAAO;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CACT,QAKS;QAET,OAAO,uBAAA,IAAI,gDAAyB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAkDD,KAAK,CAAC,OAAO,CACX,cAAgD,EAChD,eAA6B,EAAE;QAE/B,wEAAwE;QACxE,wEAAwE;QACxE,cAAc;QAEd,IAAI,qBAAyC,CAAC;QAC9C,IAAI,QAA6C,CAAC;QAElD,KAAK,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,uBAAA,IAAI,iCAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACpD,GAAG,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnC,MAAM,oBAAoB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;YAEvD,IAAI,CAAC;gBACH,8CAA8C;gBAC9C,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAC9B,cAAc,EACd,YAAY,CACb,CAAC;gBACF,GAAG,CAAC,wCAAwC,CAAC,CAAC;gBAC9C,qBAAqB,GAAG,CAAC,CAAC;gBAC1B,MAAM;YACR,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,0BAA0B;gBAC1B,qDAAqD;gBAErD,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;gBAC9B,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,KAAK,YAAY,CAAC,IAAI,CAAC;gBAEtE,GAAG,CAAC,yBAAyB,EAAE,KAAK,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;gBAEjE,IAAI,aAAa,EAAE,CAAC;oBAClB,IAAI,CAAC,GAAG,uBAAA,IAAI,iCAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAClC,GAAG,CACD,+DAA+D,CAChE,CAAC;wBACF,SAAS;oBACX,CAAC;oBAED,IACE,oBAAoB,KAAK,YAAY,CAAC,IAAI;wBAC1C,uBAAA,IAAI,+BAAQ,KAAK,QAAQ,CAAC,WAAW;wBACrC,SAAS,KAAK,SAAS,EACvB,CAAC;wBACD,mEAAmE;wBACnE,oEAAoE;wBACpE,6CAA6C;wBAC7C,GAAG,CACD,0HAA0H,CAC3H,CAAC;wBACF,uBAAA,IAAI,2BAAW,QAAQ,CAAC,WAAW,MAAA,CAAC;wBACpC,uBAAA,IAAI,4CAAqB,CAAC,IAAI,CAAC;4BAC7B,KAAK,EAAE,SAAS;yBACjB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBAED,sEAAsE;gBACtE,uCAAuC;gBACvC,GAAG,CACD,GAAG,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC,oBAAoB,CACjF,CAAC;gBACF,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,wEAAwE;YACxE,kEAAkE;YAClE,qEAAqE;YACrE,uEAAuE;YACvE,oEAAoE;YACpE,EAAE;YACF,IAAI,qBAAqB,KAAK,SAAS,EAAE,CAAC;gBACxC,KAAK,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,uBAAA,IAAI,iCAAU,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAC5D,qBAAqB,GAAG,CAAC,CAC1B,EAAE,CAAC;oBACF,GAAG,CAAC,iCAAiC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC/C,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxB,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,4EAA4E;QAC5E,2EAA2E;QAC3E,+CAA+C;QAC/C,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;CACF","sourcesContent":["import {\n CircuitState,\n CockatielEventEmitter,\n} from '@metamask/controller-utils';\nimport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n JsonRpcResponse,\n} from '@metamask/utils';\nimport { IDisposable } from 'cockatiel';\n\nimport { projectLogger, createModuleLogger } from '../logger.js';\nimport { RpcService } from './rpc-service.js';\nimport type { RpcServiceOptions } from './rpc-service.js';\nimport type {\n CockatielEventToEventListenerWithData,\n ExcludeCockatielEventData,\n ExtractCockatielEventData,\n FetchOptions,\n} from './shared.js';\n\nconst log = createModuleLogger(projectLogger, 'RpcServiceChain');\n\n/**\n * Statuses that the RPC service chain can be in.\n */\nconst STATUSES = {\n Available: 'available',\n Degraded: 'degraded',\n Unknown: 'unknown',\n Unavailable: 'unavailable',\n} as const;\n\n/**\n * Statuses that the RPC service chain can be in.\n */\ntype Status = (typeof STATUSES)[keyof typeof STATUSES];\n\n/**\n * This class constructs and manages requests to a chain of RpcService objects\n * which represent RPC endpoints with which to access a particular network. The\n * first service in the chain is intended to be the primary way of hitting the\n * network and the remaining services are used as failovers.\n */\nexport class RpcServiceChain {\n /**\n * The event emitter for the `onAvailable` event.\n */\n readonly #onAvailableEventEmitter: CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onAvailable']>,\n 'endpointUrl'\n >\n >;\n\n /**\n * The event emitter for the `onBreak` event.\n */\n readonly #onBreakEventEmitter: CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onBreak']>,\n 'endpointUrl'\n >\n >;\n\n /**\n * The event emitter for the `onDegraded` event.\n */\n readonly #onDegradedEventEmitter: CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onDegraded']>,\n 'endpointUrl'\n >\n >;\n\n /**\n * The first RPC service that requests will be sent to.\n */\n readonly #primaryService: RpcService;\n\n /**\n * The RPC services in the chain.\n */\n readonly #services: RpcService[];\n\n /**\n * The status of the RPC service chain.\n */\n #status: Status;\n\n /**\n * Constructs a new RpcServiceChain object.\n *\n * @param rpcServiceConfigurations - The options for the RPC services\n * that you want to construct. Each object in this array is the same as\n * {@link RpcServiceOptions}.\n */\n constructor(\n rpcServiceConfigurations: [RpcServiceOptions, ...RpcServiceOptions[]],\n ) {\n this.#services = rpcServiceConfigurations.map(\n (rpcServiceConfiguration) => new RpcService(rpcServiceConfiguration),\n );\n this.#primaryService = this.#services[0];\n\n this.#status = STATUSES.Unknown;\n this.#onBreakEventEmitter = new CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onBreak']>,\n 'endpointUrl'\n >\n >();\n\n this.#onDegradedEventEmitter = new CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onDegraded']>,\n 'endpointUrl'\n >\n >();\n for (const service of this.#services) {\n service.onDegraded((data) => {\n if (this.#status !== STATUSES.Degraded) {\n log('Updating status to \"degraded\"', data);\n this.#status = STATUSES.Degraded;\n const { endpointUrl, ...rest } = data;\n this.#onDegradedEventEmitter.emit(rest);\n }\n });\n }\n\n this.#onAvailableEventEmitter = new CockatielEventEmitter<\n ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onAvailable']>,\n 'endpointUrl'\n >\n >();\n for (const service of this.#services) {\n service.onAvailable((data) => {\n if (this.#status !== STATUSES.Available) {\n log('Updating status to \"available\"', data);\n this.#status = STATUSES.Available;\n const { endpointUrl, ...rest } = data;\n this.#onAvailableEventEmitter.emit(rest);\n }\n });\n }\n }\n\n /**\n * Calls the provided callback when any of the RPC services is retried.\n *\n * This is mainly useful for tests.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the event listener.\n */\n onServiceRetry(\n listener: CockatielEventToEventListenerWithData<\n RpcService['onRetry'],\n { primaryEndpointUrl: string }\n >,\n ): { dispose(): void } {\n const disposables = this.#services.map((service) =>\n service.onRetry((data) => {\n listener({\n ...data,\n primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),\n });\n }),\n );\n\n return {\n dispose(): void {\n disposables.forEach((disposable) => disposable.dispose());\n },\n };\n }\n\n /**\n * Calls the provided callback only when the maximum number of failed\n * consecutive attempts to receive a 2xx response has been reached for all\n * RPC services in the chain, and all services' underlying circuits have\n * broken.\n *\n * The callback will not be called if a service's circuit breaks but its\n * failover does not. Use `onServiceBreak` if you'd like a lower level of\n * granularity.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the callback.\n */\n onBreak(\n listener: (\n data: ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onBreak']>,\n 'endpointUrl'\n >,\n ) => void,\n ): IDisposable {\n return this.#onBreakEventEmitter.addListener(listener);\n }\n\n /**\n * Calls the provided callback each time when, for *any* of the RPC services\n * in this chain, the maximum number of failed consecutive attempts to receive\n * a 2xx response has been reached and the underlying circuit has broken. A\n * more granular version of `onBreak`.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the callback.\n */\n onServiceBreak(\n listener: CockatielEventToEventListenerWithData<\n RpcService['onBreak'],\n { primaryEndpointUrl: string }\n >,\n ): IDisposable {\n const disposables = this.#services.map((service) =>\n service.onBreak((data) => {\n listener({\n ...data,\n primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),\n });\n }),\n );\n\n return {\n dispose(): void {\n disposables.forEach((disposable) => disposable.dispose());\n },\n };\n }\n\n /**\n * Calls the provided callback if no requests have been initiated yet or\n * all requests to RPC services in this chain have responded successfully in a\n * timely fashion, and then one of the two conditions apply:\n *\n * 1. When a retriable error is encountered making a request to an RPC\n * service, and the request is retried until a set maximum is reached.\n * 2. When a RPC service responds successfully, but the request takes longer\n * than a set number of seconds to complete.\n *\n * Note that the callback will be called even if there are local connectivity\n * issues which prevent requests from being initiated. This is intentional.\n *\n * Also note this callback will only be called if the RPC service chain as a\n * whole is in a \"degraded\" state, and will then only be called once (e.g., it\n * will not be called if a failover service falls into a degraded state, then\n * the primary comes back online, but it is slow). Use `onServiceDegraded` if\n * you'd like a lower level of granularity.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the callback.\n */\n onDegraded(\n listener: (\n data: ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onDegraded']>,\n 'endpointUrl'\n >,\n ) => void,\n ): IDisposable {\n return this.#onDegradedEventEmitter.addListener(listener);\n }\n\n /**\n * Calls the provided callback each time one of the two conditions apply:\n *\n * 1. When a retriable error is encountered making a request to an RPC\n * service, and the request is retried until a set maximum is reached.\n * 2. When a RPC service responds successfully, but the request takes longer\n * than a set number of seconds to complete.\n *\n * Note that the callback will be called even if there are local connectivity\n * issues which prevent requests from being initiated. This is intentional.\n *\n * This is a more granular version of `onDegraded`. The callback will be\n * called for each slow request to an RPC service. It may also be called again\n * if a failover service falls into a degraded state, then the primary comes\n * back online, but it is slow.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the callback.\n */\n onServiceDegraded(\n listener: CockatielEventToEventListenerWithData<\n RpcService['onDegraded'],\n { primaryEndpointUrl: string }\n >,\n ): IDisposable {\n const disposables = this.#services.map((service) =>\n service.onDegraded((data) => {\n listener({\n ...data,\n primaryEndpointUrl: this.#primaryService.endpointUrl.toString(),\n });\n }),\n );\n\n return {\n dispose(): void {\n disposables.forEach((disposable) => disposable.dispose());\n },\n };\n }\n\n /**\n * Calls the provided callback in one of the following two conditions:\n *\n * 1. The first time that a 2xx request is made to any of the RPC services in\n * this chain.\n * 2. When requests to any the failover RPC services in this chain were\n * failing such that they were degraded or their underyling circuits broke,\n * but the first request to the primary succeeds again.\n *\n * Note this callback will only be called if the RPC service chain as a whole\n * is in an \"available\" state.\n *\n * @param listener - The callback to be called.\n * @returns An object with a `dispose` method which can be used to unregister\n * the callback.\n */\n onAvailable(\n listener: (\n data: ExcludeCockatielEventData<\n ExtractCockatielEventData<RpcService['onAvailable']>,\n 'endpointUrl'\n >,\n ) => void,\n ): IDisposable {\n return this.#onAvailableEventEmitter.addListener(listener);\n }\n\n /**\n * Uses the RPC services in the chain to make a request, using each service\n * after the first as a fallback to the previous one as necessary.\n *\n * This overload is specifically designed for `eth_getBlockByNumber`, which\n * can return a `result` of `null` despite an expected `Result` being\n * provided.\n *\n * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n * @param fetchOptions - An options bag for {@link fetch} which further\n * specifies the request.\n * @returns The decoded JSON-RPC response from the endpoint.\n * @throws A 401 error if the response status is 401.\n * @throws A \"rate limiting\" error if the response HTTP status is 429.\n * @throws A \"resource unavailable\" error if the response status is 402, 404, or any 5xx.\n * @throws A generic HTTP client error (-32100) for any other 4xx status codes.\n * @throws A \"parse\" error if the response is not valid JSON.\n */\n async request<Params extends JsonRpcParams, Result extends Json>(\n jsonRpcRequest: Readonly<JsonRpcRequest<Params>> & {\n method: 'eth_getBlockByNumber';\n },\n fetchOptions?: FetchOptions,\n ): Promise<JsonRpcResponse<Result> | JsonRpcResponse<null>>;\n\n /**\n * Uses the RPC services in the chain to make a request, using each service\n * after the first as a fallback to the previous one as necessary.\n *\n * This overload is designed for all RPC methods except for\n * `eth_getBlockByNumber`, which are expected to return a `result` of the\n * expected `Result`.\n *\n * @param jsonRpcRequest - The JSON-RPC request to send to the endpoint.\n * @param fetchOptions - An options bag for {@link fetch} which further\n * specifies the request.\n * @returns The decoded JSON-RPC response from the endpoint.\n * @throws A 401 error if the response status is 401.\n * @throws A \"rate limiting\" error if the response HTTP status is 429.\n * @throws A \"resource unavailable\" error if the response status is 402, 404, or any 5xx.\n * @throws A generic HTTP client error (-32100) for any other 4xx status codes.\n * @throws A \"parse\" error if the response is not valid JSON.\n */\n async request<Params extends JsonRpcParams, Result extends Json>(\n jsonRpcRequest: Readonly<JsonRpcRequest<Params>>,\n fetchOptions?: FetchOptions,\n ): Promise<JsonRpcResponse<Result>>;\n\n async request<Params extends JsonRpcParams, Result extends Json>(\n jsonRpcRequest: Readonly<JsonRpcRequest<Params>>,\n fetchOptions: FetchOptions = {},\n ): Promise<JsonRpcResponse<Result | null>> {\n // Start with the primary (first) service and switch to failovers as the\n // need arises. This is a bit confusing, so keep reading for more on how\n // this works.\n\n let availableServiceIndex: number | undefined;\n let response: JsonRpcResponse<Result> | undefined;\n\n for (const [i, service] of this.#services.entries()) {\n log(`Trying service #${i + 1}...`);\n const previousCircuitState = service.getCircuitState();\n\n try {\n // Try making the request through the service.\n response = await service.request<Params, Result>(\n jsonRpcRequest,\n fetchOptions,\n );\n log('Service successfully received request.');\n availableServiceIndex = i;\n break;\n } catch (error) {\n // Oops, that didn't work.\n // Capture this error so that we can handle it later.\n\n const { lastError } = service;\n const isCircuitOpen = service.getCircuitState() === CircuitState.Open;\n\n log('Service failed! error =', error, 'lastError = ', lastError);\n\n if (isCircuitOpen) {\n if (i < this.#services.length - 1) {\n log(\n \"This service's circuit is open. Proceeding to next service...\",\n );\n continue;\n }\n\n if (\n previousCircuitState !== CircuitState.Open &&\n this.#status !== STATUSES.Unavailable &&\n lastError !== undefined\n ) {\n // If the service's circuit just broke and it's the last one in the\n // chain, then trigger the onBreak event. (But if for some reason we\n // have already done this, then don't do it.)\n log(\n 'This service\\'s circuit just opened and it is the last service. Updating status to \"unavailable\" and triggering onBreak.',\n );\n this.#status = STATUSES.Unavailable;\n this.#onBreakEventEmitter.emit({\n error: lastError,\n });\n }\n }\n\n // The service failed, and we throw whatever the error is. The calling\n // code can try again if it so desires.\n log(\n `${isCircuitOpen ? '' : \"This service's circuit is closed. \"}Re-throwing error.`,\n );\n throw error;\n }\n }\n\n if (response) {\n // If one of the services is available, reset all of the circuits of the\n // following services. If we didn't do this and the service became\n // unavailable in the future, and any of the failovers' circuits were\n // open (due to previous failures), we would receive a \"circuit broken\"\n // error when we attempted to divert traffic to the failovers again.\n //\n if (availableServiceIndex !== undefined) {\n for (const [i, service] of [...this.#services.entries()].slice(\n availableServiceIndex + 1,\n )) {\n log(`Resetting policy for service #${i + 1}.`);\n service.resetPolicy();\n }\n }\n\n return response;\n }\n\n // The only way we can end up here is if there are no services to loop over.\n // That is not possible due to the types on the constructor, but TypeScript\n // doesn't know this, so we have to appease it.\n throw new Error('Nothing to return');\n }\n}\n"]}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=rpc-service-requestable.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-service-requestable.cjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServicePolicy } from '@metamask/controller-utils';\nimport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n JsonRpcResponse,\n} from '@metamask/utils';\n\nimport type {\n CockatielEventToEventListenerWithData,\n ExcludeCockatielEventData,\n ExtendCockatielEventData,\n ExtractCockatielEventData,\n FetchOptions,\n} from './shared.js';\n\n/**\n * The interface for a service class responsible for making a request to a\n * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC\n * service chain.\n *\n * @deprecated Don't use this interface (it will be removed in an upcoming major\n * version). If you need to take an \"RPC-service-like\" argument, it's best to\n * declare which properties you're interested in rather than accepting the\n * entire RPC service interface.\n */\nexport type RpcServiceRequestable = {\n /**\n * Listens for when the RPC service retries the request.\n *\n * @param listener - The callback to be called when the retry occurs.\n * @returns What {@link ServicePolicy.onRetry} returns.\n * @see {@link createServicePolicy}\n */\n onRetry(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onRetry'],\n { endpointUrl: string }\n >,\n ): ReturnType<ServicePolicy['onRetry']>;\n\n /**\n * Listens for when the RPC service retries the request too many times in a\n * row.\n *\n * @param listener - The callback to be called when the circuit is broken.\n * @returns What {@link ServicePolicy.onBreak} returns.\n * @see {@link createServicePolicy}\n */\n onBreak(\n listener: (\n data: ExcludeCockatielEventData<\n ExtendCockatielEventData<\n ExtractCockatielEventData<ServicePolicy['onBreak']>,\n { endpointUrl: string }\n >,\n 'isolated'\n >,\n ) => void,\n ): ReturnType<ServicePolicy['onBreak']>;\n\n /**\n * Listens for when the policy underlying this RPC service detects a slow\n * request.\n *\n * @param listener - The callback to be called when the request is slow.\n * @returns What {@link ServicePolicy.onDegraded} returns.\n * @see {@link createServicePolicy}\n */\n onDegraded(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onDegraded'],\n { endpointUrl: string; rpcMethodName: string }\n >,\n ): ReturnType<ServicePolicy['onDegraded']>;\n\n /**\n * Listens for when the policy underlying this RPC service is available.\n *\n * @param listener - The callback to be called when the request is available.\n * @returns What {@link ServicePolicy.onDegraded} returns.\n * @see {@link createServicePolicy}\n */\n onAvailable(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onAvailable'],\n { endpointUrl: string }\n >,\n ): ReturnType<ServicePolicy['onAvailable']>;\n\n /**\n * Makes a request to the target.\n */\n request<Params extends JsonRpcParams, Result extends Json>(\n jsonRpcRequest: Readonly<JsonRpcRequest<Params>>,\n fetchOptions?: FetchOptions,\n ): Promise<JsonRpcResponse<Result | null>>;\n};\n"]}
@@ -1,6 +1,6 @@
1
- import type { ServicePolicy } from '@metamask/controller-utils';
2
- import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from '@metamask/utils';
3
- import type { CockatielEventToEventListenerWithData, ExcludeCockatielEventData, ExtendCockatielEventData, ExtractCockatielEventData, FetchOptions } from './shared.js';
1
+ import type { ServicePolicy } from "@metamask/controller-utils";
2
+ import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
3
+ import type { CockatielEventToEventListenerWithData, ExcludeCockatielEventData, ExtendCockatielEventData, ExtractCockatielEventData, FetchOptions } from "./shared.cjs";
4
4
  /**
5
5
  * The interface for a service class responsible for making a request to a
6
6
  * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC
@@ -60,4 +60,4 @@ export type RpcServiceRequestable = {
60
60
  */
61
61
  request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: Readonly<JsonRpcRequest<Params>>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result | null>>;
62
62
  };
63
- //# sourceMappingURL=rpc-service-requestable.d.ts.map
63
+ //# sourceMappingURL=rpc-service-requestable.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-service-requestable.d.cts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,KAAK,EACV,qCAAqC,EACrC,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EACzB,YAAY,EACb,qBAAoB;AAErB;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,SAAS,CAAC,EACxB;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,OAAO,CACL,QAAQ,EAAE,CACR,IAAI,EAAE,yBAAyB,CAC7B,wBAAwB,CACtB,yBAAyB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EACnD;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,EACD,UAAU,CACX,KACE,IAAI,GACR,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,YAAY,CAAC,EAC3B;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAC/C,GACA,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,WAAW,CACT,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,aAAa,CAAC,EAC5B;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACvD,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAChD,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC5C,CAAC"}
@@ -0,0 +1,63 @@
1
+ import type { ServicePolicy } from "@metamask/controller-utils";
2
+ import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
3
+ import type { CockatielEventToEventListenerWithData, ExcludeCockatielEventData, ExtendCockatielEventData, ExtractCockatielEventData, FetchOptions } from "./shared.mjs";
4
+ /**
5
+ * The interface for a service class responsible for making a request to a
6
+ * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC
7
+ * service chain.
8
+ *
9
+ * @deprecated Don't use this interface (it will be removed in an upcoming major
10
+ * version). If you need to take an "RPC-service-like" argument, it's best to
11
+ * declare which properties you're interested in rather than accepting the
12
+ * entire RPC service interface.
13
+ */
14
+ export type RpcServiceRequestable = {
15
+ /**
16
+ * Listens for when the RPC service retries the request.
17
+ *
18
+ * @param listener - The callback to be called when the retry occurs.
19
+ * @returns What {@link ServicePolicy.onRetry} returns.
20
+ * @see {@link createServicePolicy}
21
+ */
22
+ onRetry(listener: CockatielEventToEventListenerWithData<ServicePolicy['onRetry'], {
23
+ endpointUrl: string;
24
+ }>): ReturnType<ServicePolicy['onRetry']>;
25
+ /**
26
+ * Listens for when the RPC service retries the request too many times in a
27
+ * row.
28
+ *
29
+ * @param listener - The callback to be called when the circuit is broken.
30
+ * @returns What {@link ServicePolicy.onBreak} returns.
31
+ * @see {@link createServicePolicy}
32
+ */
33
+ onBreak(listener: (data: ExcludeCockatielEventData<ExtendCockatielEventData<ExtractCockatielEventData<ServicePolicy['onBreak']>, {
34
+ endpointUrl: string;
35
+ }>, 'isolated'>) => void): ReturnType<ServicePolicy['onBreak']>;
36
+ /**
37
+ * Listens for when the policy underlying this RPC service detects a slow
38
+ * request.
39
+ *
40
+ * @param listener - The callback to be called when the request is slow.
41
+ * @returns What {@link ServicePolicy.onDegraded} returns.
42
+ * @see {@link createServicePolicy}
43
+ */
44
+ onDegraded(listener: CockatielEventToEventListenerWithData<ServicePolicy['onDegraded'], {
45
+ endpointUrl: string;
46
+ rpcMethodName: string;
47
+ }>): ReturnType<ServicePolicy['onDegraded']>;
48
+ /**
49
+ * Listens for when the policy underlying this RPC service is available.
50
+ *
51
+ * @param listener - The callback to be called when the request is available.
52
+ * @returns What {@link ServicePolicy.onDegraded} returns.
53
+ * @see {@link createServicePolicy}
54
+ */
55
+ onAvailable(listener: CockatielEventToEventListenerWithData<ServicePolicy['onAvailable'], {
56
+ endpointUrl: string;
57
+ }>): ReturnType<ServicePolicy['onAvailable']>;
58
+ /**
59
+ * Makes a request to the target.
60
+ */
61
+ request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: Readonly<JsonRpcRequest<Params>>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result | null>>;
62
+ };
63
+ //# sourceMappingURL=rpc-service-requestable.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-service-requestable.d.mts","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,wBAAwB;AAEzB,OAAO,KAAK,EACV,qCAAqC,EACrC,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EACzB,YAAY,EACb,qBAAoB;AAErB;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,SAAS,CAAC,EACxB;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,OAAO,CACL,QAAQ,EAAE,CACR,IAAI,EAAE,yBAAyB,CAC7B,wBAAwB,CACtB,yBAAyB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EACnD;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,EACD,UAAU,CACX,KACE,IAAI,GACR,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,YAAY,CAAC,EAC3B;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAC/C,GACA,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,WAAW,CACT,QAAQ,EAAE,qCAAqC,CAC7C,aAAa,CAAC,aAAa,CAAC,EAC5B;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CACxB,GACA,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,MAAM,SAAS,aAAa,EAAE,MAAM,SAAS,IAAI,EACvD,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAChD,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CAC5C,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=rpc-service-requestable.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-service-requestable.mjs","sourceRoot":"","sources":["../../src/rpc-service/rpc-service-requestable.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServicePolicy } from '@metamask/controller-utils';\nimport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n JsonRpcResponse,\n} from '@metamask/utils';\n\nimport type {\n CockatielEventToEventListenerWithData,\n ExcludeCockatielEventData,\n ExtendCockatielEventData,\n ExtractCockatielEventData,\n FetchOptions,\n} from './shared.js';\n\n/**\n * The interface for a service class responsible for making a request to a\n * target, whether that is a single RPC endpoint or an RPC endpoint in an RPC\n * service chain.\n *\n * @deprecated Don't use this interface (it will be removed in an upcoming major\n * version). If you need to take an \"RPC-service-like\" argument, it's best to\n * declare which properties you're interested in rather than accepting the\n * entire RPC service interface.\n */\nexport type RpcServiceRequestable = {\n /**\n * Listens for when the RPC service retries the request.\n *\n * @param listener - The callback to be called when the retry occurs.\n * @returns What {@link ServicePolicy.onRetry} returns.\n * @see {@link createServicePolicy}\n */\n onRetry(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onRetry'],\n { endpointUrl: string }\n >,\n ): ReturnType<ServicePolicy['onRetry']>;\n\n /**\n * Listens for when the RPC service retries the request too many times in a\n * row.\n *\n * @param listener - The callback to be called when the circuit is broken.\n * @returns What {@link ServicePolicy.onBreak} returns.\n * @see {@link createServicePolicy}\n */\n onBreak(\n listener: (\n data: ExcludeCockatielEventData<\n ExtendCockatielEventData<\n ExtractCockatielEventData<ServicePolicy['onBreak']>,\n { endpointUrl: string }\n >,\n 'isolated'\n >,\n ) => void,\n ): ReturnType<ServicePolicy['onBreak']>;\n\n /**\n * Listens for when the policy underlying this RPC service detects a slow\n * request.\n *\n * @param listener - The callback to be called when the request is slow.\n * @returns What {@link ServicePolicy.onDegraded} returns.\n * @see {@link createServicePolicy}\n */\n onDegraded(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onDegraded'],\n { endpointUrl: string; rpcMethodName: string }\n >,\n ): ReturnType<ServicePolicy['onDegraded']>;\n\n /**\n * Listens for when the policy underlying this RPC service is available.\n *\n * @param listener - The callback to be called when the request is available.\n * @returns What {@link ServicePolicy.onDegraded} returns.\n * @see {@link createServicePolicy}\n */\n onAvailable(\n listener: CockatielEventToEventListenerWithData<\n ServicePolicy['onAvailable'],\n { endpointUrl: string }\n >,\n ): ReturnType<ServicePolicy['onAvailable']>;\n\n /**\n * Makes a request to the target.\n */\n request<Params extends JsonRpcParams, Result extends Json>(\n jsonRpcRequest: Readonly<JsonRpcRequest<Params>>,\n fetchOptions?: FetchOptions,\n ): Promise<JsonRpcResponse<Result | null>>;\n};\n"]}