-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
OptionsController.ts
220 lines (195 loc) · 7 KB
/
OptionsController.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
import { subscribeKey as subKey } from 'valtio/vanilla/utils'
import { proxy } from 'valtio/vanilla'
import type { CustomWallet, Metadata, ProjectId, SdkVersion, Tokens } from '../utils/TypeUtil.js'
import { ApiController } from './ApiController.js'
import { ConstantsUtil } from '../utils/ConstantsUtil.js'
// -- Types --------------------------------------------- //
export interface OptionsControllerState {
projectId: ProjectId
sdkType: 'w3m'
sdkVersion: SdkVersion
/**
* A boolean that allows you to add or remove the "All Wallets" button on the modal
* @default 'SHOW'
* @see https://docs.walletconnect.com/appkit/react/core/options#allwallets
*/
allWallets?: 'SHOW' | 'HIDE' | 'ONLY_MOBILE'
/**
* Array of wallet ids to be shown in the modal's connection view with priority. These wallets will also show up first in `All Wallets` view
* @default []
* @see https://docs.walletconnect.com/appkit/react/core/options#featuredwalletids
*/
featuredWalletIds?: string[]
/**
* Array of wallet ids to be shown (order is respected). Unlike `featuredWalletIds`, these wallets will be the only ones shown in `All Wallets` view and as recommended wallets.
* @default []
* @see https://docs.walletconnect.com/appkit/react/core/options#includewalletids
*/
includeWalletIds?: string[]
/**
* Array of wallet ids to be excluded from the wallet list in the modal.
* @default []
* @see https://docs.walletconnect.com/appkit/react/core/options#excludewalletids
*/
excludeWalletIds?: string[]
/**
* Array of tokens to show the user's balance of. Each key represents the chain id of the token's blockchain
* @default {}
* @see https://docs.walletconnect.com/appkit/react/core/options#tokens
*/
tokens?: Tokens
/**
* Add custom wallets to the modal. CustomWallets is an array of objects, where each object contains specific information of a custom wallet.
* @default []
* @see https://docs.walletconnect.com/appkit/react/core/options#customwallets
*
*/
customWallets?: CustomWallet[]
/**
* You can add an url for the terms and conditions link.
* @default undefined
*/
termsConditionsUrl?: string
/**
* You can add an url for the privacy policy link.
* @default undefined
*/
privacyPolicyUrl?: string
/**
* You can enable or disable the SIWE feature in your AppKit.
* @default false
*/
isSiweEnabled?: boolean
/**
* Enable analytics to get more insights on your users activity within your WalletConnect Cloud's dashboard.
* @default true
* @see https://cloud.walletconnect.com/
*/
enableAnalytics?: boolean
/**
* Set of fields that related to your project which will be used to populate the metadata of the modal.
* @default {}
*/
metadata?: Metadata
/**
* Enable or disable the onramp feature in your AppKit.
* @default true
*/
enableOnramp?: boolean
/**
* Enable or disable the appending the AppKit to the DOM. Created for specific use cases like WebGL.
* @default false
*/
disableAppend?: boolean
/**
* Enable or disable the EIP6963 feature in your AppKit.
* @default false
*/
enableEIP6963?: boolean
/**
* Enable or disable the onramp feature in your AppKit.
* @default true
*/
enableSwaps?: boolean
// -- Internal options ---------------------------------- //
isUniversalProvider?: boolean
hasMultipleAddresses?: boolean
}
type StateKey = keyof OptionsControllerState
// -- State --------------------------------------------- //
const state = proxy<OptionsControllerState>({
projectId: '',
sdkType: 'w3m',
sdkVersion: 'html-wagmi-undefined',
enableAnalytics: ConstantsUtil.DEFAULT_FEATURES.analytics,
enableOnramp: ConstantsUtil.DEFAULT_FEATURES.onramp,
enableSwaps: ConstantsUtil.DEFAULT_FEATURES.swaps,
allWallets: ConstantsUtil.DEFAULT_FEATURES.allWallets,
disableAppend: ConstantsUtil.DEFAULT_FEATURES.disableAppend,
enableEIP6963: ConstantsUtil.DEFAULT_FEATURES.enableEIP6963
})
// -- Controller ---------------------------------------- //
export const OptionsController = {
state,
subscribeKey<K extends StateKey>(key: K, callback: (value: OptionsControllerState[K]) => void) {
return subKey(state, key, callback)
},
setOptions(options: OptionsControllerState) {
Object.assign(state, options)
},
setProjectId(projectId: OptionsControllerState['projectId']) {
state.projectId = projectId
},
setAllWallets(
allWallets: OptionsControllerState['allWallets'] = ConstantsUtil.DEFAULT_FEATURES.allWallets
) {
state.allWallets = allWallets
},
setIncludeWalletIds(includeWalletIds: OptionsControllerState['includeWalletIds']) {
state.includeWalletIds = includeWalletIds
},
setExcludeWalletIds(excludeWalletIds: OptionsControllerState['excludeWalletIds']) {
state.excludeWalletIds = excludeWalletIds
if (excludeWalletIds) {
ApiController.searchWalletByIds({ ids: excludeWalletIds })
}
},
setFeaturedWalletIds(featuredWalletIds: OptionsControllerState['featuredWalletIds']) {
state.featuredWalletIds = featuredWalletIds
},
setTokens(tokens: OptionsControllerState['tokens']) {
state.tokens = tokens
},
setTermsConditionsUrl(termsConditionsUrl: OptionsControllerState['termsConditionsUrl']) {
state.termsConditionsUrl = termsConditionsUrl
},
setPrivacyPolicyUrl(privacyPolicyUrl: OptionsControllerState['privacyPolicyUrl']) {
state.privacyPolicyUrl = privacyPolicyUrl
},
setCustomWallets(customWallets: OptionsControllerState['customWallets']) {
state.customWallets = customWallets
},
setIsSiweEnabled(isSiweEnabled: OptionsControllerState['isSiweEnabled']) {
state.isSiweEnabled = isSiweEnabled
},
setIsUniversalProvider(isUniversalProvider: OptionsControllerState['isUniversalProvider']) {
state.isUniversalProvider = isUniversalProvider
},
setEnableAnalytics(
enableAnalytics: OptionsControllerState['enableAnalytics'] = ConstantsUtil.DEFAULT_FEATURES
.analytics
) {
state.enableAnalytics = enableAnalytics
},
setSdkVersion(sdkVersion: OptionsControllerState['sdkVersion']) {
state.sdkVersion = sdkVersion
},
setMetadata(metadata: OptionsControllerState['metadata']) {
state.metadata = metadata
},
setOnrampEnabled(
enableOnramp: OptionsControllerState['enableOnramp'] = ConstantsUtil.DEFAULT_FEATURES.onramp
) {
state.enableOnramp = enableOnramp
},
setDisableAppend(
disableAppend: OptionsControllerState['disableAppend'] = ConstantsUtil.DEFAULT_FEATURES
.disableAppend
) {
state.disableAppend = disableAppend
},
setEIP6963Enabled(
enableEIP6963: OptionsControllerState['enableEIP6963'] = ConstantsUtil.DEFAULT_FEATURES
.enableEIP6963
) {
state.enableEIP6963 = enableEIP6963
},
setHasMultipleAddresses(hasMultipleAddresses: OptionsControllerState['hasMultipleAddresses']) {
state.hasMultipleAddresses = hasMultipleAddresses
},
setEnableSwaps(
enableSwaps: OptionsControllerState['enableSwaps'] = ConstantsUtil.DEFAULT_FEATURES.swaps
) {
state.enableSwaps = enableSwaps
}
}