fix: Fix empty sessionProperties causing initial connection request to fail (#138)

* do not call connect with empty object sessionProperties

* ensure sessionProperties is not empty

* changelog

Author: jiexi

packages/connect-evm/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Fix `ConnectEvm.connect()` not being able to establish an initial connection due to empty object `sessionProperties` ([#138](https://github.com/MetaMask/connect-monorepo/pull/138))
+
 ## [0.3.0]
 
 ### Added

packages/connect-evm/src/connect.ts

@@ -325,7 +325,7 @@ export class MetamaskConnectEVM {
     await this.#core.connect(
       caipChainIds as Scope[],
       caipAccountIds as CaipAccountId[],
-      {},
+      undefined,
       forceRequest,
     );
 

packages/connect-multichain/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- `ConnectMultichain.connect()` will send `sessionProperties` as undefined when called with an empty object `{}` in order to ensure that the initial `wallet_createSession` request does not fail immediately ([#138](https://github.com/MetaMask/connect-monorepo/pull/138))
+
 ## [0.5.1]
 
 ### Fixed

packages/connect-multichain/src/multichain/index.ts

@@ -708,10 +708,13 @@ export class MetaMaskConnectMultichain extends MultichainCore {
       logger('Error tracking connection_initiated event', error);
     }
 
+    // Needed because empty object will cause wallet_createSession to return an error
+    const nonEmptySessionProperites = Object.keys(sessionProperties ?? {}).length > 0 ? sessionProperties : undefined;
+
     if (this.#transport?.isConnected() && !secure) {
       return this.#handleConnection(
         this.#transport
-          .connect({ scopes, caipAccountIds, sessionProperties, forceRequest })
+          .connect({ scopes, caipAccountIds, sessionProperties: nonEmptySessionProperites, forceRequest })
           .then(async () => {
             if (this.#transport instanceof MWPTransport) {
               return this.storage.setTransport(TransportType.MWP);
@@ -727,7 +730,7 @@ export class MetaMaskConnectMultichain extends MultichainCore {
     if (platformType === PlatformType.MetaMaskMobileWebview) {
       const defaultTransport = await this.#setupDefaultTransport();
       return this.#handleConnection(
-        defaultTransport.connect({ scopes, caipAccountIds, sessionProperties, forceRequest }),
+        defaultTransport.connect({ scopes, caipAccountIds, sessionProperties: nonEmptySessionProperites, forceRequest }),
         scopes,
         transportType,
       );
@@ -738,7 +741,7 @@ export class MetaMaskConnectMultichain extends MultichainCore {
       const defaultTransport = await this.#setupDefaultTransport();
       // Web transport has no initial payload
       return this.#handleConnection(
-        defaultTransport.connect({ scopes, caipAccountIds, sessionProperties, forceRequest }),
+        defaultTransport.connect({ scopes, caipAccountIds, sessionProperties: nonEmptySessionProperites, forceRequest }),
         scopes,
         transportType,
       );
@@ -755,15 +758,15 @@ export class MetaMaskConnectMultichain extends MultichainCore {
     if (secure && !shouldShowInstallModal) {
       // Desktop is not preferred option, so we use deeplinks (mobile web)
       return this.#handleConnection(
-        this.#deeplinkConnect(scopes, caipAccountIds, sessionProperties),
+        this.#deeplinkConnect(scopes, caipAccountIds, nonEmptySessionProperites),
         scopes,
         transportType,
       );
     }
 
     // Show install modal for RN, Web + Node
     return this.#handleConnection(
-      this.#showInstallModal(shouldShowInstallModal, scopes, caipAccountIds, sessionProperties),
+      this.#showInstallModal(shouldShowInstallModal, scopes, caipAccountIds, nonEmptySessionProperites),
       scopes,
       transportType,
     );