@metamask-previews/network-connection-banner-controller 0.2.1-preview-3866c0ff1 → 0.2.1-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.
- package/CHANGELOG.md +0 -4
- package/dist/NetworkConnectionBannerController-method-action-types.cjs +7 -0
- package/dist/NetworkConnectionBannerController-method-action-types.cjs.map +1 -0
- package/dist/{NetworkConnectionBannerController-method-action-types.d.ts → NetworkConnectionBannerController-method-action-types.d.cts} +2 -2
- package/dist/NetworkConnectionBannerController-method-action-types.d.cts.map +1 -0
- package/dist/NetworkConnectionBannerController-method-action-types.d.mts +30 -0
- package/dist/NetworkConnectionBannerController-method-action-types.d.mts.map +1 -0
- package/dist/{NetworkConnectionBannerController-method-action-types.js → NetworkConnectionBannerController-method-action-types.mjs} +1 -1
- package/dist/NetworkConnectionBannerController-method-action-types.mjs.map +1 -0
- package/dist/NetworkConnectionBannerController.cjs +440 -0
- package/dist/NetworkConnectionBannerController.cjs.map +1 -0
- package/dist/{NetworkConnectionBannerController.d.ts → NetworkConnectionBannerController.d.cts} +11 -11
- package/dist/NetworkConnectionBannerController.d.cts.map +1 -0
- package/dist/NetworkConnectionBannerController.d.mts +202 -0
- package/dist/NetworkConnectionBannerController.d.mts.map +1 -0
- package/dist/NetworkConnectionBannerController.mjs +435 -0
- package/dist/NetworkConnectionBannerController.mjs.map +1 -0
- package/dist/index.cjs +11 -0
- package/dist/index.cjs.map +1 -0
- package/dist/{index.d.ts → index.d.cts} +5 -5
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +5 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +3 -0
- package/dist/index.mjs.map +1 -0
- package/dist/selectors.cjs +37 -0
- package/dist/selectors.cjs.map +1 -0
- package/dist/{selectors.d.ts → selectors.d.cts} +5 -21
- package/dist/selectors.d.cts.map +1 -0
- package/dist/selectors.d.mts +31 -0
- package/dist/selectors.d.mts.map +1 -0
- package/dist/{selectors.js → selectors.mjs} +2 -2
- package/dist/selectors.mjs.map +1 -0
- package/dist/url-utils.cjs +28 -0
- package/dist/url-utils.cjs.map +1 -0
- package/dist/{url-utils.d.ts → url-utils.d.cts} +1 -1
- package/dist/url-utils.d.cts.map +1 -0
- package/dist/url-utils.d.mts +13 -0
- package/dist/url-utils.d.mts.map +1 -0
- package/dist/{url-utils.js → url-utils.mjs} +1 -1
- package/dist/url-utils.mjs.map +1 -0
- package/package.json +16 -12
- package/dist/NetworkConnectionBannerController-method-action-types.d.ts.map +0 -1
- package/dist/NetworkConnectionBannerController-method-action-types.js.map +0 -1
- package/dist/NetworkConnectionBannerController.d.ts.map +0 -1
- package/dist/NetworkConnectionBannerController.js +0 -444
- package/dist/NetworkConnectionBannerController.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -3
- package/dist/index.js.map +0 -1
- package/dist/selectors.d.ts.map +0 -1
- package/dist/selectors.js.map +0 -1
- package/dist/url-utils.d.ts.map +0 -1
- package/dist/url-utils.js.map +0 -1
package/dist/{NetworkConnectionBannerController.d.ts → NetworkConnectionBannerController.d.cts}
RENAMED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import type { ControllerGetStateAction, ControllerStateChangedEvent } from
|
|
2
|
-
import { BaseController } from
|
|
3
|
-
import type { ClientControllerStateChangeEvent } from
|
|
4
|
-
import type { ConnectivityControllerGetStateAction, ConnectivityControllerStateChangeEvent } from
|
|
5
|
-
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from
|
|
6
|
-
import type { Messenger } from
|
|
7
|
-
import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkControllerSetActiveNetworkAction, NetworkControllerStateChangeEvent } from
|
|
8
|
-
import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerStateChangeEvent } from
|
|
9
|
-
import type { Hex } from
|
|
10
|
-
import type { NetworkConnectionBannerControllerMethodActions } from
|
|
1
|
+
import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
|
|
2
|
+
import { BaseController } from "@metamask/base-controller";
|
|
3
|
+
import type { ClientControllerStateChangeEvent } from "@metamask/client-controller";
|
|
4
|
+
import type { ConnectivityControllerGetStateAction, ConnectivityControllerStateChangeEvent } from "@metamask/connectivity-controller";
|
|
5
|
+
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
|
|
6
|
+
import type { Messenger } from "@metamask/messenger";
|
|
7
|
+
import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkControllerSetActiveNetworkAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
|
|
8
|
+
import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerStateChangeEvent } from "@metamask/network-enablement-controller";
|
|
9
|
+
import type { Hex } from "@metamask/utils";
|
|
10
|
+
import type { NetworkConnectionBannerControllerMethodActions } from "./NetworkConnectionBannerController-method-action-types.cjs";
|
|
11
11
|
/**
|
|
12
12
|
* The name of the {@link NetworkConnectionBannerController}, used to namespace
|
|
13
13
|
* the controller's actions and events and to namespace the controller's state
|
|
@@ -199,4 +199,4 @@ export declare class NetworkConnectionBannerController extends BaseController<ty
|
|
|
199
199
|
switchToDefaultInfuraRpcEndpoint(chainId: Hex): Promise<void>;
|
|
200
200
|
}
|
|
201
201
|
export {};
|
|
202
|
-
//# sourceMappingURL=NetworkConnectionBannerController.d.
|
|
202
|
+
//# sourceMappingURL=NetworkConnectionBannerController.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NetworkConnectionBannerController.d.cts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,oCAAoC;AAKpF,OAAO,KAAK,EACV,oCAAoC,EAEpC,sCAAsC,EACvC,0CAA0C;AAC3C,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAEV,uDAAuD,EACvD,+BAA+B,EAC/B,oCAAoC,EACpC,uCAAuC,EACvC,iCAAiC,EAGlC,qCAAqC;AAEtC,OAAO,KAAK,EACV,yCAAyC,EAEzC,2CAA2C,EAC5C,gDAAgD;AAEjD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C,OAAO,KAAK,EAAE,8CAA8C,EAAE,oEAAmE;AAGjI;;;;GAIG;AACH,QAAA,MAAM,eAAe,sCAAsC,CAAC;AAiE5D;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,WAAW,GACX,UAAU,GACV,aAAa,CAAC;AAgBlB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,OAAO,EAAE,GAAG,CAAC;IACb,iEAAiE;IACjE,eAAe,EAAE,MAAM,CAAC;IACxB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,+BAA+B,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,8BAA8B,EAAE,aAAa,GAAG,IAAI,CAAC;CACtD,CAAC;AAiBF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAKzG;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,OAAQ,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,kCAAkC,QAAS,CAAC;AAOzD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,KAAK,cAAc,GACf,+BAA+B,GAC/B,uDAAuD,GACvD,oCAAoC,GACpC,uCAAuC,GACvC,yCAAyC,GACzC,oCAAoC,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,kDAAkD,GAC5D,2BAA2B,CACzB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,kDAAkD,CAAC;AAErD;;;GAGG;AACH,KAAK,aAAa,GACd,iCAAiC,GACjC,2CAA2C,GAC3C,sCAAsC,GACtC,gCAAgC,GAChC,4BAA4B,GAC5B,0BAA0B,CAAC;AAE/B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,eAAe,EACtB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IAEtD;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,eAAe,EACtB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAqBC;;;;;;;;;;;;;OAaG;gBACS,EACV,SAAS,EACT,eAAe,EACf,qBAAuD,EACvD,wBAA6D,GAC9D,EAAE,wCAAwC;IAqI3C;;OAEG;IACH,aAAa,IAAI,IAAI;IAIrB;;;;;;;;OAQG;IACG,gCAAgC,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CA0SpE"}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
|
|
2
|
+
import { BaseController } from "@metamask/base-controller";
|
|
3
|
+
import type { ClientControllerStateChangeEvent } from "@metamask/client-controller";
|
|
4
|
+
import type { ConnectivityControllerGetStateAction, ConnectivityControllerStateChangeEvent } from "@metamask/connectivity-controller";
|
|
5
|
+
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
|
|
6
|
+
import type { Messenger } from "@metamask/messenger";
|
|
7
|
+
import type { NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetStateAction, NetworkControllerUpdateNetworkAction, NetworkControllerSetActiveNetworkAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
|
|
8
|
+
import type { NetworkEnablementControllerGetStateAction, NetworkEnablementControllerStateChangeEvent } from "@metamask/network-enablement-controller";
|
|
9
|
+
import type { Hex } from "@metamask/utils";
|
|
10
|
+
import type { NetworkConnectionBannerControllerMethodActions } from "./NetworkConnectionBannerController-method-action-types.mjs";
|
|
11
|
+
/**
|
|
12
|
+
* The name of the {@link NetworkConnectionBannerController}, used to namespace
|
|
13
|
+
* the controller's actions and events and to namespace the controller's state
|
|
14
|
+
* data when composed with other controllers.
|
|
15
|
+
*/
|
|
16
|
+
declare const CONTROLLER_NAME = "NetworkConnectionBannerController";
|
|
17
|
+
/**
|
|
18
|
+
* Status the banner can be in. `available` means no banner is shown; the
|
|
19
|
+
* `degraded` and `unavailable` values mirror the two-tier escalation that the
|
|
20
|
+
* UI renders.
|
|
21
|
+
*/
|
|
22
|
+
export type NetworkConnectionBannerStatus = 'available' | 'degraded' | 'unavailable';
|
|
23
|
+
/**
|
|
24
|
+
* Details of a failing network the banner describes.
|
|
25
|
+
*/
|
|
26
|
+
export type FailedNetwork = {
|
|
27
|
+
/** The chain id of the failing network. */
|
|
28
|
+
chainId: Hex;
|
|
29
|
+
/** The `networkClientId` of the failing default RPC endpoint. */
|
|
30
|
+
networkClientId: string;
|
|
31
|
+
/** The display name for the failing network. */
|
|
32
|
+
name: string;
|
|
33
|
+
/** The URL of the failing default RPC endpoint. */
|
|
34
|
+
rpcUrl: string;
|
|
35
|
+
/** Whether the failing endpoint is a MetaMask Infura endpoint. */
|
|
36
|
+
isInfuraEndpoint: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* The networkClientId of an Infura endpoint on the same chain that the user
|
|
39
|
+
* can switch to. `null` when the failing endpoint is already Infura or when
|
|
40
|
+
* no Infura alternative exists.
|
|
41
|
+
*/
|
|
42
|
+
switchableInfuraNetworkClientId: string | null;
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* State for the {@link NetworkConnectionBannerController}.
|
|
46
|
+
*
|
|
47
|
+
* The keys carry the controller-domain prefix (like
|
|
48
|
+
* `ConnectivityController`'s `connectivityStatus`) because some clients merge
|
|
49
|
+
* all controller states into one flat object, where generic names like
|
|
50
|
+
* `status` collide across controllers.
|
|
51
|
+
*/
|
|
52
|
+
export type NetworkConnectionBannerControllerState = {
|
|
53
|
+
networkConnectionBannerStatus: NetworkConnectionBannerStatus;
|
|
54
|
+
networkConnectionBannerNetwork: FailedNetwork | null;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Constructs the default {@link NetworkConnectionBannerController} state.
|
|
58
|
+
*
|
|
59
|
+
* @returns The default state.
|
|
60
|
+
*/
|
|
61
|
+
export declare function getDefaultNetworkConnectionBannerControllerState(): NetworkConnectionBannerControllerState;
|
|
62
|
+
/**
|
|
63
|
+
* The default for how long (in milliseconds) a failing network must remain
|
|
64
|
+
* in a "failed" status ("degraded" or "unavailable") before the degraded
|
|
65
|
+
* banner appears.
|
|
66
|
+
*/
|
|
67
|
+
export declare const DEFAULT_DEGRADED_BANNER_TIMEOUT = 5000;
|
|
68
|
+
/**
|
|
69
|
+
* The default for how long (in milliseconds) a failing network must remain
|
|
70
|
+
* in a "failed" status before the banner escalates to "unavailable".
|
|
71
|
+
*/
|
|
72
|
+
export declare const DEFAULT_UNAVAILABLE_BANNER_TIMEOUT = 30000;
|
|
73
|
+
/**
|
|
74
|
+
* Retrieves the state of the {@link NetworkConnectionBannerController}.
|
|
75
|
+
*/
|
|
76
|
+
export type NetworkConnectionBannerControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, NetworkConnectionBannerControllerState>;
|
|
77
|
+
/**
|
|
78
|
+
* Actions that {@link NetworkConnectionBannerControllerMessenger} exposes to
|
|
79
|
+
* other consumers.
|
|
80
|
+
*/
|
|
81
|
+
export type NetworkConnectionBannerControllerActions = NetworkConnectionBannerControllerGetStateAction | NetworkConnectionBannerControllerMethodActions;
|
|
82
|
+
/**
|
|
83
|
+
* Actions from other messengers that
|
|
84
|
+
* {@link NetworkConnectionBannerControllerMessenger} calls.
|
|
85
|
+
*/
|
|
86
|
+
type AllowedActions = NetworkControllerGetStateAction | NetworkControllerGetNetworkConfigurationByChainIdAction | NetworkControllerUpdateNetworkAction | NetworkControllerSetActiveNetworkAction | NetworkEnablementControllerGetStateAction | ConnectivityControllerGetStateAction;
|
|
87
|
+
/**
|
|
88
|
+
* Published when the state of {@link NetworkConnectionBannerController}
|
|
89
|
+
* changes.
|
|
90
|
+
*/
|
|
91
|
+
export type NetworkConnectionBannerControllerStateChangedEvent = ControllerStateChangedEvent<typeof CONTROLLER_NAME, NetworkConnectionBannerControllerState>;
|
|
92
|
+
/**
|
|
93
|
+
* Events that {@link NetworkConnectionBannerControllerMessenger} exposes to
|
|
94
|
+
* other consumers.
|
|
95
|
+
*/
|
|
96
|
+
export type NetworkConnectionBannerControllerEvents = NetworkConnectionBannerControllerStateChangedEvent;
|
|
97
|
+
/**
|
|
98
|
+
* Events from other messengers that
|
|
99
|
+
* {@link NetworkConnectionBannerControllerMessenger} subscribes to.
|
|
100
|
+
*/
|
|
101
|
+
type AllowedEvents = NetworkControllerStateChangeEvent | NetworkEnablementControllerStateChangeEvent | ConnectivityControllerStateChangeEvent | ClientControllerStateChangeEvent | KeyringControllerUnlockEvent | KeyringControllerLockEvent;
|
|
102
|
+
/**
|
|
103
|
+
* The messenger restricted to actions and events accessed by
|
|
104
|
+
* {@link NetworkConnectionBannerController}.
|
|
105
|
+
*/
|
|
106
|
+
export type NetworkConnectionBannerControllerMessenger = Messenger<typeof CONTROLLER_NAME, NetworkConnectionBannerControllerActions | AllowedActions, NetworkConnectionBannerControllerEvents | AllowedEvents>;
|
|
107
|
+
/**
|
|
108
|
+
* Options for constructing the {@link NetworkConnectionBannerController}.
|
|
109
|
+
*/
|
|
110
|
+
export type NetworkConnectionBannerControllerOptions = {
|
|
111
|
+
/**
|
|
112
|
+
* The messenger for inter-controller communication.
|
|
113
|
+
*/
|
|
114
|
+
messenger: NetworkConnectionBannerControllerMessenger;
|
|
115
|
+
/**
|
|
116
|
+
* The wallet's Infura project id, used to recognize MetaMask Infura
|
|
117
|
+
* endpoints whose URL was persisted with the id already substituted.
|
|
118
|
+
*/
|
|
119
|
+
infuraProjectId: string;
|
|
120
|
+
/**
|
|
121
|
+
* How long (in milliseconds) a failing network must remain in a "failed"
|
|
122
|
+
* status before the degraded banner appears. Defaults to
|
|
123
|
+
* {@link DEFAULT_DEGRADED_BANNER_TIMEOUT}.
|
|
124
|
+
*/
|
|
125
|
+
degradedBannerTimeout?: number;
|
|
126
|
+
/**
|
|
127
|
+
* How long (in milliseconds), measured from the same failure start as
|
|
128
|
+
* `degradedBannerTimeout`, before the banner escalates to "unavailable".
|
|
129
|
+
* Must be greater than `degradedBannerTimeout`. Defaults to
|
|
130
|
+
* {@link DEFAULT_UNAVAILABLE_BANNER_TIMEOUT}.
|
|
131
|
+
*/
|
|
132
|
+
unavailableBannerTimeout?: number;
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* Drives the "network connection banner", a notice that appears within clients
|
|
136
|
+
* whose goal is to inform users about networks which have exhibited repeated
|
|
137
|
+
* request failures and offer potential workarounds.
|
|
138
|
+
*
|
|
139
|
+
* Some terminology: A "network" in this case is an RPC endpoint, and a network
|
|
140
|
+
* that has exhibited repeated request failures has entered a "failed" state (or
|
|
141
|
+
* is a "failed network").
|
|
142
|
+
*
|
|
143
|
+
* For simplicity, the banner always represents a single failed network. If
|
|
144
|
+
* multiple networks are failing, the first custom network takes priority over
|
|
145
|
+
* the first Infura network.
|
|
146
|
+
*
|
|
147
|
+
* To ensure that the banner is actionable, the banner does not always appear
|
|
148
|
+
* even if there is a failed network to display. Instead it appears under these
|
|
149
|
+
* conditions:
|
|
150
|
+
*
|
|
151
|
+
* - The failed network is a custom (non-Infura) endpoint (we want to inform
|
|
152
|
+
* users about endpoints they've added so they don't cast blame on MetaMask).
|
|
153
|
+
* - Every enabled EVM network has entered a failed state (this indicates a
|
|
154
|
+
* broad connectivity issue).
|
|
155
|
+
*
|
|
156
|
+
* Assuming that these conditions have been met, there are two variants of the
|
|
157
|
+
* banner which will be displayed at different times.
|
|
158
|
+
*
|
|
159
|
+
* - A "degraded" variant which will appear when 5 seconds has elapsed and there
|
|
160
|
+
* is an eligible failed network to display
|
|
161
|
+
* - An "unavailable" variant which will appear when 30 seconds have elapsed and
|
|
162
|
+
* there is an eligible failed network to display
|
|
163
|
+
*
|
|
164
|
+
* Finally, the controller contains actions that drive interactions with the
|
|
165
|
+
* banner. Namely, if the banner represents a custom network, then it will offer
|
|
166
|
+
* the user a way to switch to the default Infura network. The controller
|
|
167
|
+
* contains the logic to carry out that action.
|
|
168
|
+
*/
|
|
169
|
+
export declare class NetworkConnectionBannerController extends BaseController<typeof CONTROLLER_NAME, NetworkConnectionBannerControllerState, NetworkConnectionBannerControllerMessenger> {
|
|
170
|
+
#private;
|
|
171
|
+
/**
|
|
172
|
+
* Constructs a new {@link NetworkConnectionBannerController}.
|
|
173
|
+
*
|
|
174
|
+
* @param args - The arguments to this controller.
|
|
175
|
+
* @param args.messenger - The messenger suited for this controller.
|
|
176
|
+
* @param args.infuraProjectId - The wallet's Infura project id.
|
|
177
|
+
* @param args.degradedBannerTimeout - How long (in milliseconds) a failing
|
|
178
|
+
* network must remain failed before the degraded banner appears.
|
|
179
|
+
* @param args.unavailableBannerTimeout - How long (in milliseconds) before
|
|
180
|
+
* the banner escalates to "unavailable". Must be greater than
|
|
181
|
+
* `degradedBannerTimeout`.
|
|
182
|
+
* @throws If `unavailableBannerTimeout` is not greater than
|
|
183
|
+
* `degradedBannerTimeout`.
|
|
184
|
+
*/
|
|
185
|
+
constructor({ messenger, infuraProjectId, degradedBannerTimeout, unavailableBannerTimeout, }: NetworkConnectionBannerControllerOptions);
|
|
186
|
+
/**
|
|
187
|
+
* Clears the banner state such that the banner will be hidden.
|
|
188
|
+
*/
|
|
189
|
+
dismissBanner(): void;
|
|
190
|
+
/**
|
|
191
|
+
* Switches the chain's default RPC endpoint to its Infura endpoint and
|
|
192
|
+
* makes it the active network, causing the banner to clear once the
|
|
193
|
+
* network becomes available again.
|
|
194
|
+
*
|
|
195
|
+
* @param chainId - The chain whose default RPC endpoint should be switched.
|
|
196
|
+
* @throws If the chain configuration cannot be found, or if it has no
|
|
197
|
+
* Infura endpoint to switch to, or if the default is already Infura.
|
|
198
|
+
*/
|
|
199
|
+
switchToDefaultInfuraRpcEndpoint(chainId: Hex): Promise<void>;
|
|
200
|
+
}
|
|
201
|
+
export {};
|
|
202
|
+
//# sourceMappingURL=NetworkConnectionBannerController.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NetworkConnectionBannerController.d.mts","sourceRoot":"","sources":["../src/NetworkConnectionBannerController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,oCAAoC;AAKpF,OAAO,KAAK,EACV,oCAAoC,EAEpC,sCAAsC,EACvC,0CAA0C;AAC3C,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAEV,uDAAuD,EACvD,+BAA+B,EAC/B,oCAAoC,EACpC,uCAAuC,EACvC,iCAAiC,EAGlC,qCAAqC;AAEtC,OAAO,KAAK,EACV,yCAAyC,EAEzC,2CAA2C,EAC5C,gDAAgD;AAEjD,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAI3C,OAAO,KAAK,EAAE,8CAA8C,EAAE,oEAAmE;AAGjI;;;;GAIG;AACH,QAAA,MAAM,eAAe,sCAAsC,CAAC;AAiE5D;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,WAAW,GACX,UAAU,GACV,aAAa,CAAC;AAgBlB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,OAAO,EAAE,GAAG,CAAC;IACb,iEAAiE;IACjE,eAAe,EAAE,MAAM,CAAC;IACxB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,+BAA+B,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,8BAA8B,EAAE,aAAa,GAAG,IAAI,CAAC;CACtD,CAAC;AAiBF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAKzG;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,OAAQ,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,kCAAkC,QAAS,CAAC;AAOzD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,KAAK,cAAc,GACf,+BAA+B,GAC/B,uDAAuD,GACvD,oCAAoC,GACpC,uCAAuC,GACvC,yCAAyC,GACzC,oCAAoC,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,kDAAkD,GAC5D,2BAA2B,CACzB,OAAO,eAAe,EACtB,sCAAsC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,kDAAkD,CAAC;AAErD;;;GAGG;AACH,KAAK,aAAa,GACd,iCAAiC,GACjC,2CAA2C,GAC3C,sCAAsC,GACtC,gCAAgC,GAChC,4BAA4B,GAC5B,0BAA0B,CAAC;AAE/B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,eAAe,EACtB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IAEtD;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,eAAe,EACtB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAqBC;;;;;;;;;;;;;OAaG;gBACS,EACV,SAAS,EACT,eAAe,EACf,qBAAuD,EACvD,wBAA6D,GAC9D,EAAE,wCAAwC;IAqI3C;;OAEG;IACH,aAAa,IAAI,IAAI;IAIrB;;;;;;;;OAQG;IACG,gCAAgC,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CA0SpE"}
|