Skip to content

Commit 324639f

Browse files
author
Sterling Long
committed
Updated readme to show how to exclude/include wallets
1 parent e741380 commit 324639f

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,49 @@ WalletConnectModalConnect(
5656
),
5757
```
5858

59+
### Excluding, Recommending, and Including Wallets
60+
61+
You can pass a list of wallet IDs into the `WalletConnectModalService` to exclude, recommend, or include wallets.
62+
63+
All wallet IDs can be found on the [explorer](https://walletconnect.com/explorer?type=wallet), just click on the wallet you want to copy the ID for.
64+
65+
Example 1: Exclude all wallets except MetaMask and Trust
66+
67+
```dart
68+
WalletConnectModalService(
69+
web3App: web3App,
70+
recommendedWalletIds: {
71+
'c57ca95b47569778a828d19178114f4db188b89b763c899ba0be274e97267d96', // MetaMask
72+
'4622a2b2d6af1c9844944291e5e7351a6aa24cd7b23099efac1b2fd875da31a0', // Trust
73+
},
74+
excludedWalletState: ExcludedWalletState.all, // Exclude all wallets except the two above
75+
);
76+
```
77+
78+
Example 2: Recommend (Sort to the top) MetaMask and Trust
79+
80+
```dart
81+
WalletConnectModalService(
82+
web3App: web3App,
83+
recommendedWalletIds: {
84+
'c57ca95b47569778a828d19178114f4db188b89b763c899ba0be274e97267d96', // MetaMask
85+
'4622a2b2d6af1c9844944291e5e7351a6aa24cd7b23099efac1b2fd875da31a0', // Trust
86+
},
87+
);
88+
```
89+
90+
Example 3: Exclude MetaMask and Trust
91+
92+
```dart
93+
WalletConnectModalService(
94+
web3App: web3App,
95+
excludedWalletIds: {
96+
'c57ca95b47569778a828d19178114f4db188b89b763c899ba0be274e97267d96', // MetaMask
97+
'4622a2b2d6af1c9844944291e5e7351a6aa24cd7b23099efac1b2fd875da31a0', // Trust
98+
},
99+
);
100+
```
101+
59102
## Notes
60103

61104
Swapping the required or optional namespaces will not do anything if your dApp has already connected.

0 commit comments

Comments
 (0)