2.1.3 -> 2.1.4, optional namespaces, network error reconnection

Author: Sterling Long

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.0
+
+- Added setOptionalNamespaces to WalletConnectModalService
+- Renamed setDefaultNamespaces to setRequiredNamespaces
+- Network Error (Default connect button) now attempts to reconnect if you click on it
+
 ## 1.2.4
 
 - Added small size constraint back to WalletConnectModalConnect button

example/sign/lib/main.dart

@@ -36,7 +36,7 @@ class _MyAppState extends State<MyApp> {
       DeviceOrientation.portraitDown,
     ]);
 
-    LoggerUtil.setLogLevel(Level.verbose);
+    LoggerUtil.setLogLevel(Level.info);
   }
 
   // This widget is the root of your application.

example/sign/lib/pages/sign_page.dart

@@ -87,6 +87,12 @@ class SignPageState extends State<SignPage>
 
     await _walletConnectModalService?.init();
 
+    for (final PairingInfo p
+        in _walletConnectModalService!.web3App!.pairings.getAll()) {
+      LoggerUtil.logger.i('Deleting pairing: ${p.topic}');
+      await _walletConnectModalService!.web3App!.pairings.delete(p.topic);
+    }
+
     if (_walletConnectModalService!.isInitialized) {
       // Loop through all the chain data
       for (final ChainMetadata chain in ChainData.allChains) {
@@ -369,8 +375,8 @@ class SignPageState extends State<SignPage>
         .i('Updated Required Namespaces, namespaces: $requiredNamespaces');
     LoggerUtil.logger
         .i('Updated Required Namespaces, service: $_walletConnectModalService');
-    _walletConnectModalService?.setDefaultChain(
-      requiredNamespaces: requiredNamespaces,
+    _walletConnectModalService?.setOptionalNamespaces(
+      optionalNamespaces: requiredNamespaces,
     );
   }
 

lib/constants/constants.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 class WalletConnectModalConstants {
-  static const WALLETCONNECT_MODAL_VERSION = '1.2.4';
+  static const WALLETCONNECT_MODAL_VERSION = '2.0.0';
 
   static const Key helpPageKey = Key('helpPageKey');
   static const Key qrCodePageKey = Key('qrCodePageKey');

lib/constants/string_constants.dart

@@ -5,6 +5,7 @@ class StringConstants {
 
   // TEXT
   static const String connectButtonError = 'Network Error';
+  static const String connectButtonReconnecting = 'Reconnecting';
   static const String connectButtonIdle = 'Connect Wallet';
   static const String connectButtonConnecting = 'Connecting...';
   static const String connectButtonConnected = 'Disconnect';

lib/services/utils/logger/logger_util.dart

@@ -1,12 +1,17 @@
 import 'package:logger/logger.dart';
 
 class LoggerUtil {
-  static final Logger logger = Logger(
+  static Logger logger = Logger(
     level: Level.nothing,
     printer: PrettyPrinter(),
   );
 
   static void setLogLevel(Level level) {
-    Logger.level = level;
+    logger = Logger(
+      level: level,
+      printer: PrettyPrinter(
+        methodCount: 10,
+      ),
+    );
   }
 }

lib/services/walletconnect_modal/i_walletconnect_modal_service.dart

@@ -62,12 +62,23 @@ abstract class IWalletConnectModalService implements ChangeNotifier {
   /// The required namespaces that will be used when connecting to the wallet
   Map<String, RequiredNamespace> get requiredNamespaces;
 
+  /// The optional namespaces that will be used when connecting to the wallet
+  Map<String, RequiredNamespace> get optionalNamespaces;
+
   /// Sets the required namespaces that will be used when connecting to the wallet
-  /// The default is set to the [NamespaceConstants.ethereum] namespace.
-  void setDefaultChain({
+  /// The default is blank. If you are building a multichain dApp it is recommended
+  /// you use the optional namespaces instead so you dApp can function with more
+  /// wallets.
+  void setRequiredNamespaces({
     required Map<String, RequiredNamespace> requiredNamespaces,
   });
 
+  /// Sets the optional namespaces that will be used when connecting to the wallet
+  /// The default is set to the [NamespaceConstants.ethereum] namespace.
+  void setOptionalNamespaces({
+    required Map<String, RequiredNamespace> optionalNamespaces,
+  });
+
   /// Rebuilds the connection URI.
   /// If the dapp attempts to connect to a wallet, and the connection proposal is consumed,
   /// but not accepted or rejected (no response), and they navigate back to the dapp and try again

lib/services/walletconnect_modal/walletconnect_modal_service.dart

@@ -2,6 +2,7 @@
 
 import 'dart:async';
 
+import 'package:event/event.dart';
 import 'package:flutter/material.dart';
 import 'package:w_common/disposable.dart';
 import 'package:walletconnect_flutter_v2/walletconnect_flutter_v2.dart';
@@ -58,11 +59,15 @@ class WalletConnectModalService extends ChangeNotifier
   @override
   String? get wcUri => connectResponse?.uri.toString();
 
-  Map<String, RequiredNamespace> _requiredNamespaces =
-      NamespaceConstants.ethereum;
+  Map<String, RequiredNamespace> _requiredNamespaces = {};
   @override
   Map<String, RequiredNamespace> get requiredNamespaces => _requiredNamespaces;
 
+  Map<String, RequiredNamespace> _optionalNamespaces =
+      NamespaceConstants.ethereum;
+  @override
+  Map<String, RequiredNamespace> get optionalNamespaces => _optionalNamespaces;
+
   ConnectResponse? connectResponse;
   Future<SessionData>? get sessionFuture => connectResponse?.session.future;
   BuildContext? context;
@@ -83,6 +88,7 @@ class WalletConnectModalService extends ChangeNotifier
     String? projectId,
     PairingMetadata? metadata,
     Map<String, RequiredNamespace>? requiredNamespaces,
+    Map<String, RequiredNamespace>? optionalNamespaces,
     Set<String>? recommendedWalletIds,
     ExcludedWalletState excludedWalletState = ExcludedWalletState.list,
     Set<String>? excludedWalletIds,
@@ -104,6 +110,9 @@ class WalletConnectModalService extends ChangeNotifier
     if (requiredNamespaces != null) {
       _requiredNamespaces = requiredNamespaces;
     }
+    if (optionalNamespaces != null) {
+      _optionalNamespaces = optionalNamespaces;
+    }
 
     explorerService.instance = ExplorerService(
       projectId: _projectId,
@@ -120,14 +129,14 @@ class WalletConnectModalService extends ChangeNotifier
       return;
     }
 
+    _registerListeners();
+
     _initError = null;
     try {
       await _web3App!.init();
       await WalletConnectModalServices.init();
     } catch (_) {}
 
-    _registerListeners();
-
     if (_web3App!.sessions.getAll().isNotEmpty) {
       _isConnected = true;
       _session = _web3App!.sessions.getAll().first;
@@ -225,17 +234,17 @@ class WalletConnectModalService extends ChangeNotifier
 
   @override
   void close() {
+    // If we aren't open, then we can't and shouldn't close
     if (!_isOpen) {
       return;
     }
-    // _isOpen = false;
 
     toastUtils.instance.clear();
     if (context != null) {
+      // _isOpen and notifyListeners() are handled when we call Navigator.pop()
+      // by the open() method
       Navigator.pop(context!);
     }
-
-    // notifyListeners();
   }
 
   @override
@@ -246,6 +255,15 @@ class WalletConnectModalService extends ChangeNotifier
       return;
     }
 
+    // Disconnect both the pairing and session
+    await web3App!.disconnectSession(
+      topic: session!.pairingTopic,
+      // ignore: prefer_const_constructors
+      reason: WalletConnectError(
+        code: 0,
+        message: 'User disconnected',
+      ),
+    );
     await web3App!.disconnectSession(
       topic: session!.topic,
       // ignore: prefer_const_constructors
@@ -328,18 +346,31 @@ class WalletConnectModalService extends ChangeNotifier
   }
 
   @override
-  void setDefaultChain({
+  void setRequiredNamespaces({
     required Map<String, RequiredNamespace> requiredNamespaces,
   }) {
     _checkInitialized();
 
-    LoggerUtil.logger.i('Setting default chain: $requiredNamespaces');
+    LoggerUtil.logger.i('Setting required namespaces: $requiredNamespaces');
 
     _requiredNamespaces = requiredNamespaces;
 
     notifyListeners();
   }
 
+  @override
+  void setOptionalNamespaces({
+    required Map<String, RequiredNamespace> optionalNamespaces,
+  }) {
+    _checkInitialized();
+
+    LoggerUtil.logger.i('Setting optional namespaces: $optionalNamespaces');
+
+    _optionalNamespaces = optionalNamespaces;
+
+    notifyListeners();
+  }
+
   @override
   String getReferer() {
     _checkInitialized();
@@ -365,6 +396,7 @@ class WalletConnectModalService extends ChangeNotifier
 
       connectResponse = await web3App!.connect(
         requiredNamespaces: _requiredNamespaces,
+        optionalNamespaces: optionalNamespaces,
       );
 
       notifyListeners();
@@ -398,29 +430,50 @@ class WalletConnectModalService extends ChangeNotifier
   }
 
   void _registerListeners() {
-    // web3App!.onSessionConnect.subscribe(
-    //   _onSessionConnect,
-    // );
+    web3App!.onSessionConnect.subscribe(
+      _onSessionConnect,
+    );
     web3App!.onSessionDelete.subscribe(
       _onSessionDelete,
     );
+    web3App!.core.relayClient.onRelayClientConnect.subscribe(
+      _onRelayClientConnect,
+    );
     web3App!.core.relayClient.onRelayClientError.subscribe(
       _onRelayClientError,
     );
   }
 
   void _unregisterListeners() {
-    // web3App!.onSessionConnect.unsubscribe(
-    //   _onSessionConnect,
-    // );
+    web3App!.onSessionConnect.unsubscribe(
+      _onSessionConnect,
+    );
     web3App!.onSessionDelete.unsubscribe(
       _onSessionDelete,
     );
+    web3App!.core.relayClient.onRelayClientConnect.unsubscribe(
+      _onRelayClientConnect,
+    );
     web3App!.core.relayClient.onRelayClientError.unsubscribe(
       _onRelayClientError,
     );
   }
 
+  void _onSessionConnect(SessionConnect? args) {
+    print('Session connected: $args');
+    _isConnected = true;
+    _session = args!.session;
+    _address = NamespaceUtils.getAccount(
+      _session!.namespaces.values.first.accounts.first,
+    );
+
+    if (_isOpen) {
+      close();
+    } else {
+      notifyListeners();
+    }
+  }
+
   void _onSessionDelete(SessionDelete? args) {
     _isConnected = false;
     _address = '';
@@ -429,9 +482,15 @@ class WalletConnectModalService extends ChangeNotifier
     notifyListeners();
   }
 
+  void _onRelayClientConnect(EventArgs? args) {
+    _initError = null;
+
+    notifyListeners();
+  }
+
   void _onRelayClientError(ErrorEvent? args) {
-    LoggerUtil.logger.e('Relay client error: $args');
-    _initError = args!.error;
+    LoggerUtil.logger.e('Relay client error: ${args?.error}');
+    _initError = args?.error;
 
     notifyListeners();
   }
@@ -449,18 +508,7 @@ class WalletConnectModalService extends ChangeNotifier
     }
 
     try {
-      final SessionData session = await connectResponse!.session.future;
-      _isConnected = true;
-      _session = session;
-      _address = NamespaceUtils.getAccount(
-        _session!.namespaces.values.first.accounts.first,
-      );
-      // await _toastService.show(
-      //   ToastMessage(
-      //     type: ToastType.info,
-      //     text: 'Connected to Wallet',
-      //   ),
-      // );
+      await connectResponse!.session.future;
     } on TimeoutException {
       LoggerUtil.logger.i('Rebuilding session, ending future');
       return;
@@ -474,12 +522,6 @@ class WalletConnectModalService extends ChangeNotifier
       );
       return;
     }
-
-    if (_isOpen) {
-      close();
-    } else {
-      notifyListeners();
-    }
   }
 
   void _checkInitialized() {

lib/widgets/walletconnect_modal_button.dart

@@ -7,11 +7,13 @@ class WalletConnectModalButton extends StatelessWidget {
     super.key,
     required this.child,
     this.onPressed,
+    this.disabled = false,
     this.borderRadius = 100,
   });
 
   final Widget child;
   final void Function()? onPressed;
+  final bool disabled;
   final double borderRadius;
 
   @override
@@ -20,9 +22,9 @@ class WalletConnectModalButton extends StatelessWidget {
         WalletConnectModalTheme.getData(context);
 
     // No onPressed means the button is disabled and grayed out.
-    if (onPressed == null) {
+    if (disabled) {
       return MaterialButton(
-        onPressed: () {},
+        onPressed: onPressed ?? () {},
         color: themeData.overlay030,
         disabledColor: themeData.overlay030,
         shape: RoundedRectangleBorder(