@metamask/connect-multichain 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0]
+
+### Added
+
+- Enable `ConnectMultichain` to automatically handle `wallet_sessionChanged` events when MetaMask extension is detected (Desktop Chrome/Firefox, or Mobile In-App Browser) and `preferExtension: true` without needing the user to explicitly connect via `ConnectMultichain.connect()` ([#198](https://github.com/MetaMask/connect-monorepo/pull/198/))
+
+### Changed
+
+- Bump `@metamask/mobile-wallet-protocol-core` to `^0.4.0` ([#201](https://github.com/MetaMask/connect-monorepo/pull/201))
+- Bump `@metamask/mobile-wallet-protocol-dapp-client` to `^0.3.0` ([#201](https://github.com/MetaMask/connect-monorepo/pull/201))
+
 ## [0.7.0]
 
 ### Changed
@@ -170,7 +181,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.7.0...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.8.0...HEAD
+[0.8.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.7.0...@metamask/connect-multichain@0.8.0
 [0.7.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.6.0...@metamask/connect-multichain@0.7.0
 [0.6.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.3...@metamask/connect-multichain@0.6.0
 [0.5.3]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.2...@metamask/connect-multichain@0.5.3

package/dist/browser/es/connect-multichain.d.mts

@@ -455,6 +455,7 @@ type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' |
  */
 type CreateMultichainFN = (options: MultiChainFNOptions) => Promise<MultichainCore>;
 type ExtendedTransport = Omit<Transport, 'connect'> & {
+    init: () => Promise<void>;
     connect: (props?: {
         scopes: Scope[];
         caipAccountIds: CaipAccountId[];

package/dist/browser/es/connect-multichain.mjs

@@ -1588,7 +1588,7 @@ import {
   getDefaultTransport
 } from "@metamask/multichain-api-client";
 var DEFAULT_REQUEST_TIMEOUT = 60 * 1e3;
-var _notificationCallbacks, _transport, _defaultRequestOptions, _pendingRequests, _handleResponseListener, _handleNotificationListener, _DefaultTransport_instances, notifyCallbacks_fn, isMetamaskProviderEvent_fn, handleResponse_fn, handleNotification_fn, setupMessageListener_fn;
+var _notificationCallbacks, _transport, _defaultRequestOptions, _pendingRequests, _handleResponseListener, _handleNotificationListener, _DefaultTransport_instances, notifyCallbacks_fn, isMetamaskProviderEvent_fn, handleResponse_fn, handleNotification_fn, setupMessageListener_fn, init_fn;
 var DefaultTransport = class {
   constructor() {
     __privateAdd(this, _DefaultTransport_instances);
@@ -1636,11 +1636,31 @@ var DefaultTransport = class {
       });
     });
   }
+  init() {
+    return __async(this, null, function* () {
+      yield __privateMethod(this, _DefaultTransport_instances, init_fn).call(this);
+      let walletSession = { sessionScopes: {} };
+      try {
+        const sessionRequest = yield this.request(
+          { method: "wallet_getSession" },
+          __privateGet(this, _defaultRequestOptions)
+        );
+        walletSession = sessionRequest.result;
+      } catch (e) {
+        console.error(
+          "Failed to get wallet session during DefaultTransport init"
+        );
+      }
+      __privateMethod(this, _DefaultTransport_instances, notifyCallbacks_fn).call(this, {
+        method: "wallet_sessionChanged",
+        params: walletSession
+      });
+    });
+  }
   connect(options) {
     return __async(this, null, function* () {
       var _a3, _b, _c, _d, _e;
-      __privateMethod(this, _DefaultTransport_instances, setupMessageListener_fn).call(this);
-      yield __privateGet(this, _transport).connect();
+      yield __privateMethod(this, _DefaultTransport_instances, init_fn).call(this);
       const sessionRequest = yield this.request(
         { method: "wallet_getSession" },
         __privateGet(this, _defaultRequestOptions)
@@ -1697,26 +1717,6 @@ var DefaultTransport = class {
   disconnect() {
     return __async(this, arguments, function* (scopes = []) {
       yield this.request({ method: "wallet_revokeSession", params: { scopes } });
-      const response = yield this.request({ method: "wallet_getSession" });
-      const { sessionScopes } = response.result;
-      if (Object.keys(sessionScopes).length > 0) {
-        return;
-      }
-      __privateGet(this, _notificationCallbacks).clear();
-      if (__privateGet(this, _handleResponseListener)) {
-        window.removeEventListener("message", __privateGet(this, _handleResponseListener));
-        __privateSet(this, _handleResponseListener, void 0);
-      }
-      if (__privateGet(this, _handleNotificationListener)) {
-        window.removeEventListener("message", __privateGet(this, _handleNotificationListener));
-        __privateSet(this, _handleNotificationListener, void 0);
-      }
-      for (const [, request] of __privateGet(this, _pendingRequests)) {
-        clearTimeout(request.timeout);
-        request.reject(new Error("Transport disconnected"));
-      }
-      __privateGet(this, _pendingRequests).clear();
-      yield __privateGet(this, _transport).disconnect();
     });
   }
   isConnected() {
@@ -1805,7 +1805,7 @@ handleNotification_fn = function(event) {
     return;
   }
   const responseData = (_b = (_a3 = event == null ? void 0 : event.data) == null ? void 0 : _a3.data) == null ? void 0 : _b.data;
-  if (typeof responseData === "object" && responseData.method === "metamask_chainChanged" || responseData.method === "metamask_accountsChanged") {
+  if (typeof responseData === "object" && responseData !== null && (responseData.method === "metamask_chainChanged" || responseData.method === "metamask_accountsChanged")) {
     __privateMethod(this, _DefaultTransport_instances, notifyCallbacks_fn).call(this, responseData);
   }
 };
@@ -1818,6 +1818,12 @@ setupMessageListener_fn = function() {
   window.addEventListener("message", __privateGet(this, _handleResponseListener));
   window.addEventListener("message", __privateGet(this, _handleNotificationListener));
 };
+init_fn = function() {
+  return __async(this, null, function* () {
+    __privateMethod(this, _DefaultTransport_instances, setupMessageListener_fn).call(this);
+    yield __privateGet(this, _transport).connect();
+  });
+};
 
 // src/multichain/transports/multichainApiClientWrapper/index.ts
 init_utils2();
@@ -2217,6 +2223,10 @@ var MWPTransport = class {
       }
     });
   }
+  init() {
+    return __async(this, null, function* () {
+    });
+  }
   // TODO: Rename this
   sendEip1193Message(payload, options) {
     return __async(this, null, function* () {
@@ -2569,7 +2579,7 @@ var MWPTransport = class {
   getActiveSession() {
     return __async(this, null, function* () {
       const { kvstore } = this;
-      const sessionStore = new SessionStore(kvstore);
+      const sessionStore = yield SessionStore.create(kvstore);
       try {
         const [activeSession] = yield sessionStore.list();
         return activeSession;
@@ -2620,7 +2630,7 @@ var MWPTransport = class {
 };
 
 // src/multichain/transports/mwp/KeyManager.ts
-import { decrypt, encrypt, PrivateKey } from "eciesjs";
+import { decrypt, encrypt, PrivateKey, PublicKey } from "eciesjs";
 var KeyManager = class {
   generateKeyPair() {
     const privateKey = new PrivateKey();
@@ -2643,6 +2653,9 @@ var KeyManager = class {
       return Buffer.from(decryptedBuffer).toString("utf8");
     });
   }
+  validatePeerKey(key) {
+    PublicKey.fromHex(Buffer.from(key).toString("hex"));
+  }
 };
 var keymanager = new KeyManager();
 
@@ -2650,7 +2663,7 @@ var keymanager = new KeyManager();
 init_utils2();
 var logger2 = createLogger("metamask-sdk:core");
 var SINGLETON_KEY = "__METAMASK_CONNECT_MULTICHAIN_SINGLETON__";
-var _a2, _provider, _providerTransportWrapper, _transport2, _dappClient, _beforeUnloadListener, _listener, _sdkInfo, _MetaMaskConnectMultichain_instances, setupAnalytics_fn, onTransportNotification_fn, getStoredTransport_fn, setupTransport_fn, init_fn, createDappClient_fn, setupMWP_fn, onBeforeUnload_fn, createBeforeUnloadListener_fn, renderInstallModalAsync_fn, showInstallModal_fn, headlessConnect_fn, setupDefaultTransport_fn, deeplinkConnect_fn, handleConnection_fn, getCaipSession_fn, openConnectDeeplinkIfNeeded_fn;
+var _a2, _provider, _providerTransportWrapper, _transport2, _dappClient, _beforeUnloadListener, _listener, _sdkInfo, _MetaMaskConnectMultichain_instances, setupAnalytics_fn, onTransportNotification_fn, getStoredTransport_fn, setupTransport_fn, init_fn2, createDappClient_fn, setupMWP_fn, onBeforeUnload_fn, createBeforeUnloadListener_fn, renderInstallModalAsync_fn, showInstallModal_fn, headlessConnect_fn, setupDefaultTransport_fn, deeplinkConnect_fn, handleConnection_fn, getCaipSession_fn, openConnectDeeplinkIfNeeded_fn;
 var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends MultichainCore {
   constructor(options) {
     var _a3, _b, _c, _d, _e, _f;
@@ -2688,6 +2701,9 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   }
   set status(value) {
     var _a3, _b;
+    if (this._status === value) {
+      return;
+    }
     this._status = value;
     (_b = (_a3 = this.options.transport) == null ? void 0 : _a3.onNotification) == null ? void 0 : _b.call(_a3, {
       method: "stateChanged",
@@ -2743,7 +2759,7 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
         if (isEnabled2) {
           enableDebug("metamask-sdk:core");
         }
-        yield __privateMethod(_a3 = instance, _MetaMaskConnectMultichain_instances, init_fn).call(_a3);
+        yield __privateMethod(_a3 = instance, _MetaMaskConnectMultichain_instances, init_fn2).call(_a3);
         return instance;
       }))();
       globalObject[SINGLETON_KEY] = instancePromise;
@@ -2853,14 +2869,16 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
       );
       yield (_a3 = __privateGet(this, _transport2)) == null ? void 0 : _a3.disconnect(scopes);
       if (remainingScopes.length === 0) {
-        yield (_b = __privateGet(this, _listener)) == null ? void 0 : _b.call(this);
-        (_c = __privateGet(this, _beforeUnloadListener)) == null ? void 0 : _c.call(this);
         yield this.storage.removeTransport();
-        __privateSet(this, _listener, void 0);
-        __privateSet(this, _beforeUnloadListener, void 0);
-        __privateSet(this, _transport2, void 0);
-        __privateGet(this, _providerTransportWrapper).clearTransportNotificationListener();
-        __privateSet(this, _dappClient, void 0);
+        if (this.transportType !== "browser" /* Browser */) {
+          yield (_b = __privateGet(this, _listener)) == null ? void 0 : _b.call(this);
+          (_c = __privateGet(this, _beforeUnloadListener)) == null ? void 0 : _c.call(this);
+          __privateSet(this, _listener, void 0);
+          __privateSet(this, _beforeUnloadListener, void 0);
+          __privateSet(this, _transport2, void 0);
+          __privateGet(this, _providerTransportWrapper).clearTransportNotificationListener();
+          __privateSet(this, _dappClient, void 0);
+        }
         this.status = "disconnected";
       }
     });
@@ -2899,16 +2917,16 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   // without having to concern themselves with the current transport connection status.
   emitSessionChanged() {
     return __async(this, null, function* () {
-      var _a3;
+      var _a3, _b;
       const emptySession = { sessionScopes: {} };
-      if (this.status !== "connected" && this.status !== "connecting") {
+      if (!((_a3 = __privateGet(this, _transport2)) == null ? void 0 : _a3.isConnected())) {
         this.emit("wallet_sessionChanged", emptySession);
         return;
       }
       const response = yield this.transport.request({
         method: "wallet_getSession"
       });
-      this.emit("wallet_sessionChanged", (_a3 = response.result) != null ? _a3 : emptySession);
+      this.emit("wallet_sessionChanged", (_b = response.result) != null ? _b : emptySession);
     });
   }
 };
@@ -2945,9 +2963,17 @@ setupAnalytics_fn = function() {
 };
 onTransportNotification_fn = function(payload) {
   return __async(this, null, function* () {
-    var _a3;
+    var _a3, _b, _c;
     if (typeof payload === "object" && payload !== null && "method" in payload) {
-      this.emit(payload.method, (_a3 = payload.params) != null ? _a3 : payload.result);
+      if (payload.method === "wallet_sessionChanged") {
+        const sessionScopes = (_b = (_a3 = payload.params) == null ? void 0 : _a3.sessionScopes) != null ? _b : {};
+        const hasScopes = Object.keys(sessionScopes).length > 0;
+        if (this.status === "loaded" && !hasScopes) {
+          return;
+        }
+        this.status = hasScopes ? "connected" : "disconnected";
+      }
+      this.emit(payload.method, (_c = payload.params) != null ? _c : payload.result);
     }
   });
 };
@@ -2985,6 +3011,7 @@ getStoredTransport_fn = function() {
 };
 setupTransport_fn = function() {
   return __async(this, null, function* () {
+    var _a3;
     const transport = yield __privateMethod(this, _MetaMaskConnectMultichain_instances, getStoredTransport_fn).call(this);
     if (transport) {
       if (!this.transport.isConnected()) {
@@ -2999,10 +3026,20 @@ setupTransport_fn = function() {
       }
     } else {
       this.status = "loaded";
+      const hasExtensionInstalled = yield hasExtension();
+      const preferExtension = (_a3 = this.options.ui.preferExtension) != null ? _a3 : true;
+      if (hasExtensionInstalled && preferExtension) {
+        yield __privateMethod(this, _MetaMaskConnectMultichain_instances, setupDefaultTransport_fn).call(this, { persist: false });
+        try {
+          yield this.transport.init();
+        } catch (error) {
+          console.error("Passive init failed:", error);
+        }
+      }
     }
   });
 };
-init_fn = function() {
+init_fn2 = function() {
   return __async(this, null, function* () {
     try {
       yield __privateMethod(this, _MetaMaskConnectMultichain_instances, setupAnalytics_fn).call(this);
@@ -3026,7 +3063,7 @@ init_fn = function() {
 createDappClient_fn = function() {
   return __async(this, null, function* () {
     const { adapter: kvstore } = this.options.storage;
-    const sessionstore = new SessionStore2(kvstore);
+    const sessionstore = yield SessionStore2.create(kvstore);
     const websocket = (
       // eslint-disable-next-line no-negated-condition
       typeof window !== "undefined" ? WebSocket : (yield import("ws")).WebSocket
@@ -3203,9 +3240,13 @@ headlessConnect_fn = function(scopes, caipAccountIds, sessionProperties) {
   });
 };
 setupDefaultTransport_fn = function() {
-  return __async(this, null, function* () {
-    this.status = "connecting";
-    yield this.storage.setTransport("browser" /* Browser */);
+  return __async(this, arguments, function* (options = { persist: true }) {
+    if (__privateGet(this, _transport2) instanceof DefaultTransport) {
+      return __privateGet(this, _transport2);
+    }
+    if (options == null ? void 0 : options.persist) {
+      yield this.storage.setTransport("browser" /* Browser */);
+    }
     const transport = new DefaultTransport();
     __privateSet(this, _listener, transport.onNotification(
       __privateMethod(this, _MetaMaskConnectMultichain_instances, onTransportNotification_fn).bind(this)
@@ -3323,16 +3364,20 @@ handleConnection_fn = function(promise, scopes, transportType) {
 };
 getCaipSession_fn = function() {
   return __async(this, null, function* () {
+    var _a3;
     let sessionData = {
       sessionScopes: {},
       sessionProperties: {}
     };
-    if (this.status === "connected") {
-      const response = yield this.transport.request({
-        method: "wallet_getSession"
-      });
-      if (response.result) {
-        sessionData = response.result;
+    if ((_a3 = __privateGet(this, _transport2)) == null ? void 0 : _a3.isConnected()) {
+      try {
+        const response = yield this.transport.request({
+          method: "wallet_getSession"
+        });
+        if (response.result) {
+          sessionData = response.result;
+        }
+      } catch (e) {
       }
     }
     return sessionData;