Release 85.0.0 (#1006)

* feat: connectwith working with connection * fix: unit tests * feat: add connectWith param * feat: unit test coverage * fix: coverage * fix: double connectWith request * fix: unit tests * fix: unit tests and cleanup * feat: release 85.0.0 * feat: changelog
MetaMask · Aug 30, 2024 · f96fb19 · f96fb19
1 parent 3e478c2
commit f96fb19
Show file tree

Hide file tree

Showing 18 changed files with 230 additions and 104 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "metamask-sdk-monorepo",
-  "version": "84.0.0",
+  "version": "85.0.0",
   "private": true,
   "repository": {
     "type": "git",

diff --git a/packages/sdk-communication-layer/CHANGELOG.md b/packages/sdk-communication-layer/CHANGELOG.md
@@ -6,15 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.28.2]
+### Added
+- feat: socket reconnection optimization ([#994](https://github.com/MetaMask/metamask-sdk/pull/994))
+
 ## [0.28.1]
-### Uncategorized
-- feat: full deeplink protocol ([#992](https://github.com/MetaMask/metamask-sdk.git/pull/992))
+### Added
+- feat: full deeplink protocol ([#992](https://github.com/MetaMask/metamask-sdk/pull/992))
 
 ## [0.28.0]
 ### Added
-- feat: experimental deeplink protocoll ([#990](https://github.com/MetaMask/metamask-sdk.git/pull/990))
-- feat: revert socket server changes ([#985](https://github.com/MetaMask/metamask-sdk.git/pull/985))
-- feat: change the default value for 'dappId' to 'N/A' instead of an empty string ([#972](https://github.com/MetaMask/metamask-sdk.git/pull/972))
+- feat: experimental deeplink protocoll ([#990](https://github.com/MetaMask/metamask-sdk/pull/990))
+- feat: revert socket server changes ([#985](https://github.com/MetaMask/metamask-sdk/pull/985))
+- feat: change the default value for 'dappId' to 'N/A' instead of an empty string ([#972](https://github.com/MetaMask/metamask-sdk/pull/972))
 
 ## [0.27.0]
 ### Added
@@ -30,14 +34,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.26.0]
 ### Added
-- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk.git/pull/902))
-- feat: update dev rn / expo and empty dappid ([#897](https://github.com/MetaMask/metamask-sdk.git/pull/897))
-- feat: prevent empty dappid ([#891](https://github.com/MetaMask/metamask-sdk.git/pull/891))
-- chore: improve unit tests coverage ([#888](https://github.com/MetaMask/metamask-sdk.git/pull/888))
+- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk/pull/902))
+- feat: update dev rn / expo and empty dappid ([#897](https://github.com/MetaMask/metamask-sdk/pull/897))
+- feat: prevent empty dappid ([#891](https://github.com/MetaMask/metamask-sdk/pull/891))
+- chore: improve unit tests coverage ([#888](https://github.com/MetaMask/metamask-sdk/pull/888))
 
 ## [0.20.5]
 ### Added
-- fix: ref crossfetch ([#871](https://github.com/MetaMask/metamask-sdk.git/pull/871))
+- fix: ref crossfetch ([#871](https://github.com/MetaMask/metamask-sdk/pull/871))
 
 ## [0.20.4]
 ### Added
@@ -245,7 +249,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - [FEAT]: improve logging + update examples ([#99](https://github.com/MetaMask/metamask-sdk/pull/99))
 
-[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[0.28.2]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.28.1]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.28.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.27.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]

diff --git a/packages/sdk-communication-layer/package.json b/packages/sdk-communication-layer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@metamask/sdk-communication-layer",
-  "version": "0.28.1",
+  "version": "0.28.2",
   "description": "",
   "homepage": "https://github.com/MetaMask/metamask-sdk#readme",
   "bugs": {

diff --git a/packages/sdk-install-modal-web/CHANGELOG.md b/packages/sdk-install-modal-web/CHANGELOG.md
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.26.0]
 ### Added
-- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk.git/pull/902))
+- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk/pull/902))
 
 ## [0.20.4]
 ### Added

diff --git a/packages/sdk-react-native/CHANGELOG.md b/packages/sdk-react-native/CHANGELOG.md
@@ -40,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.3.1]
 ### Uncategorized
-- chore: update reactNativeSdkDemo with latest sdk-react-native version ([#872](https://github.com/MetaMask/metamask-sdk.git/pull/872))
+- chore: update reactNativeSdkDemo with latest sdk-react-native version ([#872](https://github.com/MetaMask/metamask-sdk/pull/872))
 
 ## [0.3.0]
 ### Added

diff --git a/packages/sdk-react-ui/CHANGELOG.md b/packages/sdk-react-ui/CHANGELOG.md
@@ -34,7 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.26.0]
 ### Added
-- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk.git/pull/902))
+- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk/pull/902))
 
 ## [0.20.4]
 ### Added

diff --git a/packages/sdk-react/CHANGELOG.md b/packages/sdk-react/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.28.0]
+### Uncategorized
+- feat: revert socket server changes ([#985](https://github.com/MetaMask/metamask-sdk/pull/985))
+
 ## [0.27.0]
 ### Added
 - fix: adds extensionOnly default to true to SDK initialization ([#962](https://github.com/MetaMask/metamask-sdk/pull/962))
@@ -235,7 +239,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [fix] publishing config ([#135](https://github.com/MetaMask/metamask-sdk/pull/135))
 - [feat] initial beta released
 
-[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[0.28.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.27.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.26.5]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.26.4]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]

diff --git a/packages/sdk-react/package.json b/packages/sdk-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@metamask/sdk-react",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "A react component and react hooks to connect and use MetaMask",
   "homepage": "https://github.com/MetaMask/metamask-sdk",
   "bugs": {

diff --git a/packages/sdk-ui/CHANGELOG.md b/packages/sdk-ui/CHANGELOG.md
@@ -6,14 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.28.0]
+### Uncategorized
+- feat: revert socket server changes ([#985](https://github.com/MetaMask/metamask-sdk/pull/985))
+
 ## [0.26.0]
 ### Uncategorized
-- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk.git/pull/902))
+- feat: add script to align version before publishing ([#902](https://github.com/MetaMask/metamask-sdk/pull/902))
 
 ## [0.20.5]
 ### Added
 - align version with sdk package
-- chore: create wagmi demo dapp ([#669](https://github.com/MetaMask/metamask-sdk.git/pull/669))
+- chore: create wagmi demo dapp ([#669](https://github.com/MetaMask/metamask-sdk/pull/669))
 
 ## [0.4.2]
 ### Uncategorized
@@ -83,7 +87,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - feat: optimize rollup builds ([#496](https://github.com/MetaMask/metamask-sdk/pull/496))
 - fix: linting changelog issue after updating scripts ([#509](https://github.com/MetaMask/metamask-sdk/pull/509))
 
-[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[0.28.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.26.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.20.5]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.4.2]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]

diff --git a/packages/sdk-ui/package.json b/packages/sdk-ui/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@metamask/sdk-ui",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "description": "MetaMask SDK cross-platform ui library",
   "module": "dist/esm/index.js",
   "types": "dist/esm/dist/src/index.d.ts",

diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.28.0]
+### Added
+- fix: adds a unique id to RPC events for extension ([#996](https://github.com/MetaMask/metamask-sdk/pull/996))
+- feat: connectwith working with async key exchange ([#1004](https://github.com/MetaMask/metamask-sdk/pull/1004))
+- feat: socket reconnection optimization ([#994](https://github.com/MetaMask/metamask-sdk/pull/994))
+- feat: full deeplink protocol ([#992](https://github.com/MetaMask/metamask-sdk/pull/992))
+- feat: experimental deeplink protocoll ([#990](https://github.com/MetaMask/metamask-sdk/pull/990))
+- feat: revert socket server changes ([#985](https://github.com/MetaMask/metamask-sdk/pull/985))
+- feat: change the default value for 'dappId' to 'N/A' instead of an empty string ([#972](https://github.com/MetaMask/metamask-sdk/pull/972))
+
 ## [0.27.0]
 ### Added
 - fix: adds extensionOnly default to true to SDK initialization ([#962](https://github.com/MetaMask/metamask-sdk/pull/962))
@@ -364,7 +374,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - [FEAT] improve logging + update examples ([#99](https://github.com/MetaMask/metamask-sdk/pull/99))
 
-[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[Unreleased]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]
+[0.28.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.27.0]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.26.5]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.26.4]: https://github.com/MetaMask/metamask-sdk/compare/@metamask/[email protected]...@metamask/[email protected]

diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@metamask/sdk",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "",
   "homepage": "https://github.com/MetaMask/metamask-sdk#readme",
   "bugs": {

diff --git a/packages/sdk/src/Platform/MetaMaskInstaller.test.ts b/packages/sdk/src/Platform/MetaMaskInstaller.test.ts
@@ -71,8 +71,11 @@ describe('MetaMaskInstaller', () => {
   });
 
   it('should start installer with connectWith provided', async () => {
-    const connectWith = { method: 'eth_requestAccounts', params: [] };
-
+    const connectWith = {
+      method: 'eth_requestAccounts',
+      params: [],
+      id: '123',
+    };
     await installer.start({ wait: false, connectWith });
 
     expect(installer.state.connectWith).toStrictEqual(connectWith);
@@ -97,7 +100,11 @@ describe('MetaMaskInstaller', () => {
   it('should correctly handle isInstalling in start with wait set to true', async () => {
     installer.state.isInstalling = true;
 
-    const connectWith = { method: 'eth_requestAccounts', params: [] };
+    const connectWith = {
+      method: 'eth_requestAccounts',
+      params: [],
+      id: '123',
+    };
 
     const startPromise = installer.start({ wait: true, connectWith });
 

diff --git a/packages/sdk/src/Platform/MetaMaskInstaller.ts b/packages/sdk/src/Platform/MetaMaskInstaller.ts
@@ -19,6 +19,7 @@ interface InstallerProps {
 export interface RPCCall {
   method: string;
   params: unknown;
+  id: string;
 }
 
 interface MetaMaskInstallerState {
@@ -78,21 +79,10 @@ export class MetaMaskInstaller {
     connectWith,
   }: {
     wait: boolean;
-    connectWith?: { method: string; params: unknown };
+    connectWith?: RPCCall;
   }) {
     this.state.connectWith = connectWith;
     logger(`[MetaMaskInstaller: start()] wait=${wait}`, connectWith);
     await startInstaller(this, { wait });
-
-    if (wait) {
-      // wait until the installation is done
-      while (this.state.isInstalling) {
-        // FIXME: remove before release
-        console.warn(
-          `[MetaMaskInstaller: start()] isInstalling=${this.state.isInstalling}`,
-        );
-        await new Promise((resolve) => setTimeout(resolve, 1000));
-      }
-    }
   }
 }
diff --git a/packages/sdk/src/provider/initializeMobileProvider.ts b/packages/sdk/src/provider/initializeMobileProvider.ts
@@ -253,12 +253,17 @@ const initializeMobileProvider = async ({
         setInitializing(true);
 
         const isConnectWith = method === RPC_METHODS.METAMASK_CONNECTWITH;
+        // Only used with connectWith
+        const rpcInstallId = `${Date.now()}`;
         try {
           await installer.start({
             wait: false,
             connectWith: isConnectWith
               ? {
                   method,
+                  // We dont need a better id, this is only for current user session.
+                  // future rpc calls will have ids generated via JSON-RPC package.
+                  id: rpcInstallId,
                   params,
                 }
               : undefined,
@@ -361,6 +366,38 @@ const initializeMobileProvider = async ({
             `[initializeMobileProvider: sendRequest()] selectedAddress: ${selectedAddress} --- SKIP rpc call`,
           );
           return [selectedAddress];
+        } else if (method === RPC_METHODS.METAMASK_CONNECTWITH) {
+          // wait for  tracker to be updated
+
+          try {
+            const result = await new Promise((resolve, reject) => {
+              const tracker = remoteConnection
+                ?.getConnector()
+                .getRPCMethodTracker();
+              logger(`TRACKER: method ${rpcInstallId}`, tracker);
+              if (tracker?.[rpcInstallId].result) {
+                resolve(tracker?.[rpcInstallId].result);
+              } else if (tracker?.[rpcInstallId].error) {
+                reject(tracker?.[rpcInstallId].error);
+              }
+
+              remoteConnection
+                ?.getConnector()
+                .once(EventType.RPC_UPDATE, (rpcResult) => {
+                  logger(`TRACKER: update method ${rpcInstallId}`, rpcResult);
+
+                  if (rpcResult.result) {
+                    resolve(rpcResult.result);
+                  } else {
+                    reject(rpcResult.error);
+                  }
+                });
+            });
+            return result;
+          } catch (error) {
+            logger(`[initializeMobileProvider: sendRequest()] error:`, error);
+            throw error;
+          }
         }
 
         // Inform next step that this method triggered installer

diff --git a/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.test.ts b/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.test.ts
@@ -74,6 +74,7 @@ describe('startConnection', () => {
           persistChannelConfig: jest.fn(),
         },
       },
+      getRPCMethodTracker: jest.fn().mockReturnValue({}),
     };
 
     state = {
@@ -184,6 +185,7 @@ describe('startConnection', () => {
       const connectWith = {
         method: 'eth_sendTransaction',
         params: [{ from: '0x123', to: '0x456', value: '0x789' }],
+        id: '123',
       };
 
       await startConnection(state, options, { connectWith });
@@ -199,6 +201,7 @@ describe('startConnection', () => {
       const connectWith = {
         method: 'personal_sign',
         params: ['0xabcdef', '0x123456'],
+        id: '123',
       };
 
       await startConnection(state, options, { connectWith });
@@ -215,6 +218,7 @@ describe('startConnection', () => {
       const connectWith = {
         method: 'eth_sign',
         params: ['0x123456', '0xabcdef'],
+        id: '123',
       };
 
       await startConnection(state, options, { connectWith });
@@ -230,6 +234,7 @@ describe('startConnection', () => {
       const connectWith = {
         method: 'eth_sign',
         params: ['0x123456', '0xabcdef'],
+        id: '123',
       };
 
       await startConnection(state, options, { connectWith });

diff --git a/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.ts b/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.ts
@@ -156,14 +156,18 @@ export async function startConnection(
     }&pubkey=${pubKey}${qrCodeOrigin}&originatorInfo=${base64OriginatorInfo}`;
 
     if (connectWith) {
-      const rpc = {
-        id: Date.now(), // We dont need a better id, this is only for current user session.
-        // future rpc calls will have ids generated via JSON-RPC package.
-        method: connectWith.method,
-        params: connectWith.params,
-      };
-      const base64Rpc = base64Encode(JSON.stringify(rpc));
+      const base64Rpc = base64Encode(JSON.stringify(connectWith));
       linkParams += `&rpc=${base64Rpc}`;
+
+      const tracker = state.connector.getRPCMethodTracker();
+      // Add rpcMethod to tracker
+      if (tracker) {
+        tracker[`${connectWith.id}`] = {
+          ...connectWith,
+          id: `${connectWith.id}`,
+          timestamp: Date.now(),
+        };
+      }
     }
     const encodedLinkParams = encodeURI(linkParams);
     const qrcodeLink = `${