-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
client.ts
438 lines (351 loc) · 13.7 KB
/
client.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
import type {
EventsControllerState,
PublicStateControllerState,
ThemeControllerState,
ModalControllerState,
ConnectedWalletInfo,
RouterControllerState,
ChainAdapter,
CaipNetwork
} from '@web3modal/core'
import {
AccountController,
BlockchainApiController,
ConnectionController,
ConnectorController,
CoreHelperUtil,
EventsController,
ModalController,
ChainController,
PublicStateController,
ThemeController,
SnackController,
RouterController,
EnsController,
OptionsController,
NetworkController,
AssetUtil
} from '@web3modal/core'
import { setColorTheme, setThemeVariables } from '@web3modal/ui'
import { ConstantsUtil, type Chain } from '@web3modal/common'
import type { AppKitOptions } from '../utils/TypesUtil.js'
// -- Types --------------------------------------------------------------------
export interface OpenOptions {
view: 'Account' | 'Connect' | 'Networks' | 'ApproveTransaction' | 'OnRampProviders'
}
// -- Helpers -------------------------------------------------------------------
let isInitialized = false
// -- Client --------------------------------------------------------------------
export class AppKit<AdapterStoreState = unknown, SwitchNetworkParam = unknown> {
private static instance?: AppKit
public adapter?: ChainAdapter<AdapterStoreState, SwitchNetworkParam>
public adapters?: ChainAdapter<AdapterStoreState, SwitchNetworkParam>[]
private initPromise?: Promise<void> = undefined
public constructor(
options: AppKitOptions & {
adapters?: ChainAdapter<AdapterStoreState, SwitchNetworkParam>[]
}
) {
// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
this.adapter = options.adapters?.[0] as ChainAdapter<AdapterStoreState, SwitchNetworkParam>
this.initControllers(options)
this.initOrContinue()
}
public static getInstance() {
return this.instance
}
// -- Public -------------------------------------------------------------------
public async open(options?: OpenOptions) {
await this.initOrContinue()
ModalController.open(options)
}
public async close() {
await this.initOrContinue()
ModalController.close()
}
public setLoading(loading: ModalControllerState['loading']) {
ModalController.setLoading(loading)
}
// -- Adapter Methods ----------------------------------------------------------
public getError() {
return this.adapter?.getError?.()
}
public getChainId() {
return this.adapter?.getChainId?.()
}
public getAddress() {
return this.adapter?.getAddress?.()
}
public switchNetwork(chainId: SwitchNetworkParam) {
return this.adapter?.switchNetwork?.(chainId)
}
public getIsConnected() {
return this.adapter?.getIsConnected?.()
}
public getWalletProvider() {
return this.adapter?.getWalletProvider?.()
}
public getWalletProviderType() {
return this.adapter?.getWalletProviderType?.()
}
public subscribeProvider(callback: (newState: AdapterStoreState) => void) {
return this.adapter?.subscribeProvider?.(callback)
}
public getThemeMode() {
return ThemeController.state.themeMode
}
public getThemeVariables() {
return ThemeController.state.themeVariables
}
public setThemeMode(themeMode: ThemeControllerState['themeMode']) {
ThemeController.setThemeMode(themeMode)
setColorTheme(ThemeController.state.themeMode)
}
public setThemeVariables(themeVariables: ThemeControllerState['themeVariables']) {
ThemeController.setThemeVariables(themeVariables)
setThemeVariables(ThemeController.state.themeVariables)
}
public subscribeTheme(callback: (newState: ThemeControllerState) => void) {
return ThemeController.subscribe(callback)
}
public getWalletInfo() {
return AccountController.state.connectedWalletInfo
}
public subscribeWalletInfo(callback: (newState: ConnectedWalletInfo) => void) {
return AccountController.subscribeKey('connectedWalletInfo', callback)
}
public subscribeShouldUpdateToAddress(callback: (newState?: string) => void) {
AccountController.subscribeKey('shouldUpdateToAddress', callback)
}
public subscribeCaipNetworkChange(callback: (newState?: CaipNetwork) => void) {
NetworkController.subscribeKey('caipNetwork', callback)
}
public getState() {
return PublicStateController.state
}
public subscribeState(callback: (newState: PublicStateControllerState) => void) {
return PublicStateController.subscribe(callback)
}
public showErrorMessage(message: string) {
SnackController.showError(message)
}
public showSuccessMessage(message: string) {
SnackController.showSuccess(message)
}
public getEvent() {
return { ...EventsController.state }
}
public subscribeEvents(callback: (newEvent: EventsControllerState) => void) {
return EventsController.subscribe(callback)
}
public replace(route: RouterControllerState['view']) {
RouterController.replace(route)
}
public redirect(route: RouterControllerState['view']) {
RouterController.push(route)
}
public popTransactionStack(cancel?: boolean) {
RouterController.popTransactionStack(cancel)
}
public isOpen() {
return ModalController.state.open
}
public isTransactionStackEmpty() {
return RouterController.state.transactionStack.length === 0
}
public isTransactionShouldReplaceView() {
return RouterController.state.transactionStack[
RouterController.state.transactionStack.length - 1
]?.replace
}
public setIsConnected: (typeof AccountController)['setIsConnected'] = (isConnected, chain) => {
AccountController.setIsConnected(isConnected, chain)
}
public getIsConnectedState = () => AccountController.state.isConnected
public setAllAccounts: (typeof AccountController)['setAllAccounts'] = (addresses, chain) => {
AccountController.setAllAccounts(addresses, chain)
OptionsController.setHasMultipleAddresses(addresses?.length > 1)
}
public addAddressLabel: (typeof AccountController)['addAddressLabel'] = (
address,
label,
chain
) => {
AccountController.addAddressLabel(address, label, chain)
}
public removeAddressLabel: (typeof AccountController)['removeAddressLabel'] = (
address,
chain
) => {
AccountController.removeAddressLabel(address, chain)
}
public getCaipAddress = () => AccountController.state.caipAddress
public setCaipAddress: (typeof AccountController)['setCaipAddress'] = (caipAddress, chain) => {
AccountController.setCaipAddress(caipAddress, chain)
}
public setBalance: (typeof AccountController)['setBalance'] = (balance, balanceSymbol, chain) => {
AccountController.setBalance(balance, balanceSymbol, chain)
}
public setProfileName: (typeof AccountController)['setProfileName'] = (profileName, chain) => {
AccountController.setProfileName(profileName, chain)
}
public setProfileImage: (typeof AccountController)['setProfileImage'] = (profileImage, chain) => {
AccountController.setProfileImage(profileImage, chain)
}
public resetAccount: (typeof AccountController)['resetAccount'] = (chain: Chain) => {
AccountController.resetAccount(chain)
}
public setCaipNetwork: (typeof NetworkController)['setCaipNetwork'] = caipNetwork => {
NetworkController.setCaipNetwork(caipNetwork)
}
public getCaipNetwork = () => NetworkController.state.caipNetwork
public setRequestedCaipNetworks: (typeof NetworkController)['setRequestedCaipNetworks'] = (
requestedCaipNetworks,
chain: Chain
) => {
NetworkController.setRequestedCaipNetworks(requestedCaipNetworks, chain)
}
public getApprovedCaipNetworkIds: (typeof NetworkController)['getApprovedCaipNetworkIds'] = () =>
NetworkController.getApprovedCaipNetworkIds()
public setApprovedCaipNetworksData: (typeof NetworkController)['setApprovedCaipNetworksData'] =
chain => NetworkController.setApprovedCaipNetworksData(chain)
public resetNetwork: (typeof NetworkController)['resetNetwork'] = () => {
NetworkController.resetNetwork()
}
public setConnectors: (typeof ConnectorController)['setConnectors'] = connectors => {
ConnectorController.setConnectors(connectors)
}
public addConnector: (typeof ConnectorController)['addConnector'] = connector => {
ConnectorController.addConnector(connector)
}
public getConnectors: (typeof ConnectorController)['getConnectors'] = () =>
ConnectorController.getConnectors()
public resetWcConnection: (typeof ConnectionController)['resetWcConnection'] = () => {
ConnectionController.resetWcConnection()
}
public fetchIdentity: (typeof BlockchainApiController)['fetchIdentity'] = request =>
BlockchainApiController.fetchIdentity(request)
public setAddressExplorerUrl: (typeof AccountController)['setAddressExplorerUrl'] = (
addressExplorerUrl,
chain
) => {
AccountController.setAddressExplorerUrl(addressExplorerUrl, chain)
}
public setSmartAccountDeployed: (typeof AccountController)['setSmartAccountDeployed'] = (
isDeployed,
chain
) => {
AccountController.setSmartAccountDeployed(isDeployed, chain)
}
public setConnectedWalletInfo: (typeof AccountController)['setConnectedWalletInfo'] = (
connectedWalletInfo,
chain
) => {
AccountController.setConnectedWalletInfo(connectedWalletInfo, chain)
}
public setSmartAccountEnabledNetworks: (typeof NetworkController)['setSmartAccountEnabledNetworks'] =
(smartAccountEnabledNetworks, chain) => {
NetworkController.setSmartAccountEnabledNetworks(smartAccountEnabledNetworks, chain)
}
public setPreferredAccountType: (typeof AccountController)['setPreferredAccountType'] = (
preferredAccountType,
chain
) => {
AccountController.setPreferredAccountType(preferredAccountType, chain)
}
public getWalletConnectName: (typeof EnsController)['getNamesForAddress'] = address =>
EnsController.getNamesForAddress(address)
public resolveWalletConnectName = async (name: string) => {
const trimmedName = name.replace(ConstantsUtil.WC_NAME_SUFFIX, '')
const wcNameAddress = await EnsController.resolveName(trimmedName)
const networkNameAddresses = Object.values(wcNameAddress?.addresses) || []
return networkNameAddresses[0]?.address || false
}
public setEIP6963Enabled: (typeof OptionsController)['setEIP6963Enabled'] = enabled => {
OptionsController.setEIP6963Enabled(enabled)
}
public setClientId: (typeof BlockchainApiController)['setClientId'] = clientId => {
BlockchainApiController.setClientId(clientId)
}
public getConnectorImage: (typeof AssetUtil)['getConnectorImage'] = connector =>
AssetUtil.getConnectorImage(connector)
public handleUnsafeRPCRequest = () => {
if (this.isOpen()) {
// If we are on the modal but there is no transaction stack, close the modal
if (this.isTransactionStackEmpty()) {
return
}
// Check if we need to replace or redirect
if (this.isTransactionShouldReplaceView()) {
this.replace('ApproveTransaction')
} else {
this.redirect('ApproveTransaction')
}
} else {
// If called from outside the modal, open ApproveTransaction
this.open({ view: 'ApproveTransaction' })
}
}
// -- Private ------------------------------------------------------------------
private async initControllers(
options: AppKitOptions & {
adapters?: ChainAdapter<AdapterStoreState, SwitchNetworkParam>[]
}
) {
OptionsController.setProjectId(options.projectId)
OptionsController.setSdkVersion(options.sdkVersion)
ChainController.initialize(options.adapters || [])
options.adapters?.forEach(adapter => {
// @ts-expect-error will introduce construct later
adapter.construct?.(this, options)
// Set this value for all chains
NetworkController.setAllowUnsupportedChain(options.allowUnsupportedChain, adapter.chain)
NetworkController.setDefaultCaipNetwork(options.defaultChain)
})
OptionsController.setAllWallets(options.allWallets)
OptionsController.setIncludeWalletIds(options.includeWalletIds)
OptionsController.setExcludeWalletIds(options.excludeWalletIds)
OptionsController.setFeaturedWalletIds(options.featuredWalletIds)
OptionsController.setTokens(options.tokens)
OptionsController.setTermsConditionsUrl(options.termsConditionsUrl)
OptionsController.setPrivacyPolicyUrl(options.privacyPolicyUrl)
OptionsController.setCustomWallets(options.customWallets)
OptionsController.setEnableAnalytics(options.enableAnalytics)
OptionsController.setOnrampEnabled(options.enableOnramp !== false)
OptionsController.setEnableSwaps(options.enableSwaps !== false)
if (options.metadata) {
OptionsController.setMetadata(options.metadata)
}
if (options.themeMode) {
ThemeController.setThemeMode(options.themeMode)
}
if (options.themeVariables) {
ThemeController.setThemeVariables(options.themeVariables)
}
if (options.disableAppend) {
OptionsController.setDisableAppend(Boolean(options.disableAppend))
}
const evmAdapter = options.adapters?.find(adapter => adapter.chain === ConstantsUtil.CHAIN.EVM)
// Set the SIWE client for EVM chains
if (evmAdapter) {
if (options.siweConfig) {
const { SIWEController } = await import('@web3modal/siwe')
SIWEController.setSIWEClient(options.siweConfig)
}
}
}
private async initOrContinue() {
if (!this.initPromise && !isInitialized && CoreHelperUtil.isClient()) {
isInitialized = true
this.initPromise = new Promise<void>(async resolve => {
await Promise.all([import('@web3modal/ui'), import('@web3modal/scaffold-ui/w3m-modal')])
const modal = document.createElement('w3m-modal')
if (!OptionsController.state.disableAppend) {
document.body.insertAdjacentElement('beforeend', modal)
}
resolve()
})
}
return this.initPromise
}
}