@multiplatform.one/web3 8.1.0 → 8.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/web3",
-  "version": "8.1.0",
+  "version": "8.2.1",
   "description": "Web3 wallet integration for multiplatform.one ecosystem with ConnectKit and wagmi",
   "keywords": [
     "connectkit",
@@ -120,10 +120,10 @@
     "@aave/account": "^0.2.1",
     "@coinbase/wallet-sdk": "^4.4.0",
     "@metamask/connect-evm": "^2.1.1",
-    "@multiplatform.one/connectkit": "^8.1.0",
-    "@multiplatform.one/gpg": "^8.1.0",
-    "@multiplatform.one/platform": "^8.1.0",
-    "@multiplatform.one/theme": "^8.1.0",
+    "@multiplatform.one/connectkit": "^8.2.1",
+    "@multiplatform.one/gpg": "^8.2.1",
+    "@multiplatform.one/platform": "^8.2.1",
+    "@multiplatform.one/theme": "^8.2.1",
     "@noble/ciphers": "^1.3.0",
     "@noble/curves": "^1.9.7",
     "@phosphor-icons/react": "^2.1.10",
@@ -147,8 +147,8 @@
     "wagmi": "^3.7.1"
   },
   "devDependencies": {
-    "@multiplatform.one/config": "8.1.0",
-    "@multiplatform.one/test-utils": "8.1.0",
+    "@multiplatform.one/config": "8.2.1",
+    "@multiplatform.one/test-utils": "8.2.1",
     "@tamagui/build": "2.7.6",
     "@tanstack/react-query": "^5.104.3",
     "@testing-library/jest-dom": "^7.0.1",

package/src/bundler/metaMaskConnectTimeouts.spec.ts

@@ -54,6 +54,12 @@ const iPadCheck =
 
 const pageLoadResume =
   /resumeSession_fn = function\(session, options\)[\s\S]*?isContinuingPriorAttempt \? this\.options\.resumeTimeout : options \? this\.options\.connectionTimeout : 120 \* 1e3/;
+const extensionTimer = (seconds: number) =>
+  new RegExp(
+    `DEFAULT_REQUEST_TIMEOUT\\d* = ${seconds} \\* 1e3;\\s+var _notificationCallbacks\\d*, _transport\\d*, _defaultRequestOptions`,
+    "g",
+  );
+
 const stockConnectionTimer =
   /isContinuingPriorAttempt \? this\.options\.resumeTimeout : this\.options\.connectionTimeout/g;
 
@@ -85,6 +91,16 @@ describe("the timer patches on the installed MetaMask Connect", () => {
     }
   });
 
+  it("raises the desktop extension's request timer to 600 s", () => {
+    for (const file of multichainFiles) {
+      const code = read(file);
+      expect(code.match(extensionTimer(60))).toHaveLength(1);
+      const patched = patchMetaMaskConnectTimeouts(file, code)!.code;
+      expect(patched.match(extensionTimer(600))).toHaveLength(1);
+      expect(patched).not.toMatch(extensionTimer(60));
+    }
+  });
+
   it("gives only the option-less page-load resume the stock 120 s", () => {
     for (const file of multichainFiles) {
       const code = read(file);
@@ -149,6 +165,14 @@ describe("the timer patches on the installed MetaMask Connect", () => {
         code.replace(/(DEFAULT_REQUEST_TIMEOUT\d*) = 60 \* 1e3;/, "$1 = 90 * 1e3;"),
       ),
     ).toThrow(/timer DEFAULT_REQUEST_TIMEOUT not found/);
+    expect(() =>
+      patchMetaMaskConnectTimeouts(
+        multichain!,
+        code.replace(extensionTimer(60), (match) => match.replace("60 * 1e3", "30 * 1e3")),
+      ),
+    ).toThrow(
+      /timer DefaultTransport DEFAULT_REQUEST_TIMEOUT not found .* would lose the ten-minute desktop extension confirmation/,
+    );
     expect(() =>
       patchMetaMaskConnectTimeouts(
         dappClient!,
@@ -278,6 +302,107 @@ describe("the patched MetaMask Connect transport", () => {
   });
 });
 
+type DefaultTransportClass = new () => {
+  sendEip1193Message(payload: { method: string; params?: unknown[] }): Promise<{ result: unknown }>;
+};
+
+/** connect-multichain's desktop extension transport from its node build, patched or stock. */
+function loadDefaultTransport(patched: boolean): DefaultTransportClass {
+  const file = requireHere.resolve(multichainPkg);
+  const code = patched ? patchMetaMaskConnectTimeouts(file, read(file))!.code : read(file);
+  const wrapper = runInThisContext(
+    `(function (module, exports, require, __filename, __dirname) {${code}\nreturn DefaultTransport;\n})`,
+    { filename: file },
+  );
+  const module = { exports: {} };
+  return wrapper(module, module.exports, createRequire(file), file, dirname(file));
+}
+
+describe("the desktop extension transport", () => {
+  const origin = "https://dev.promanager.vip";
+
+  /** A page with the MetaMask extension that holds every confirmation until told. */
+  function extensionPage() {
+    const listeners: ((event: unknown) => void)[] = [];
+    const sent: { id: string; method: string }[] = [];
+    vi.stubGlobal("location", { origin });
+    vi.stubGlobal("window", {
+      addEventListener: (type: string, listener: (event: unknown) => void) => {
+        if (type === "message") listeners.push(listener);
+      },
+      removeEventListener: vi.fn(),
+      postMessage: (message: { data: { data: { id: string; method: string } } }) =>
+        sent.push(message.data.data),
+    });
+    return {
+      sent,
+      confirm(id: string, result: string) {
+        const event = {
+          origin,
+          data: {
+            target: "metamask-inpage",
+            data: { name: "metamask-provider", data: { id, result } },
+          },
+        };
+        for (const listener of listeners) listener(event);
+      },
+    };
+  }
+
+  function settle(promise: Promise<unknown>) {
+    const state: { value?: unknown; error?: unknown; settled: boolean } = { settled: false };
+    promise.then(
+      (value) => Object.assign(state, { settled: true, value }),
+      (error) => Object.assign(state, { settled: true, error }),
+    );
+    return state;
+  }
+
+  afterEach(() => {
+    vi.useRealTimers();
+    vi.unstubAllGlobals();
+  });
+
+  it("stock MetaMask Connect rejects a transaction still in MetaMask after 60 s", async () => {
+    vi.useFakeTimers();
+    extensionPage();
+    const DefaultTransport = loadDefaultTransport(false);
+    const send = settle(
+      new DefaultTransport().sendEip1193Message({ method: "eth_sendTransaction", params: [] }),
+    );
+    await vi.advanceTimersByTimeAsync(60_000);
+    expect((send.error as Error | undefined)?.message).toBe("Request timeout");
+  });
+
+  it("resolves with the hash when the user confirms three minutes later", async () => {
+    vi.useFakeTimers();
+    const page = extensionPage();
+    const DefaultTransport = loadDefaultTransport(true);
+    const send = settle(
+      new DefaultTransport().sendEip1193Message({ method: "eth_sendTransaction", params: [] }),
+    );
+    await vi.advanceTimersByTimeAsync(180_000);
+    expect(send.settled).toBe(false);
+    expect(page.sent).toHaveLength(1);
+    page.confirm(page.sent[0]!.id, "0xhash");
+    await vi.advanceTimersByTimeAsync(0);
+    expect(send.value).toMatchObject({ result: "0xhash" });
+  });
+
+  it("still gives up on a confirmation left open for ten minutes", async () => {
+    vi.useFakeTimers();
+    extensionPage();
+    const DefaultTransport = loadDefaultTransport(true);
+    const send = settle(
+      new DefaultTransport().sendEip1193Message({ method: "eth_sendTransaction", params: [] }),
+    );
+    await vi.advanceTimersByTimeAsync(599_999);
+    expect(send.settled).toBe(false);
+    await vi.advanceTimersByTimeAsync(1);
+    expect((send.error as Error | undefined)?.message).toBe("Request timeout");
+  });
+});
+
 const userAgents = {
   iPadSafari:
     "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Safari/605.1.15",
@@ -356,6 +481,12 @@ const renameGracePeriod: Plugin = {
 function expectLongTimers(code: string) {
   expect(code).toMatch(/DEFAULT_REQUEST_TIMEOUT[\w$]* = 600 \* 1e3;\s+CONNECTION_GRACE_PERIOD/);
   expect(code).toMatch(/HANDSHAKE_TIMEOUT[\w$]* = 540 \* 1e3;/);
+  expect(code).toMatch(
+    /DEFAULT_REQUEST_TIMEOUT[\w$]* = 600 \* 1e3;\s+var _notificationCallbacks[\w$]*[,;]\s+(?:var )?_transport/,
+  );
+  expect(code).not.toMatch(
+    /DEFAULT_REQUEST_TIMEOUT[\w$]* = 60 \* 1e3;\s+var _notificationCallbacks/,
+  );
   expect(code).toMatch(/resumeTimeout : [\w$]+ \? this\.options\.connectionTimeout : 120 \* 1e3/);
   expect(code).not.toMatch(/DEFAULT_REQUEST_TIMEOUT[\w$]* = 60 \* 1e3;\s+CONNECTION_GRACE_PERIOD/);
   expect(code).not.toMatch(/HANDSHAKE_TIMEOUT[\w$]* = 60 \* 1e3;/);

package/src/bundler/metaMaskConnectTimeouts.ts

@@ -7,6 +7,13 @@
 // until the user switches back; a user who lingered in MetaMask lost the request
 // to those timers. Both become ten minutes (540 s + the 60 s session expiry).
 //
+// On desktop the extension transport (DefaultTransport, window.postMessage to
+// MetaMask's content script) has its own 60 s request timer, also a module
+// constant. A transaction that sat in MetaMask's confirmation longer than that
+// was rejected as "Request timeout" while MetaMask still showed it, so a user
+// who confirmed late paid and the app never got the hash. It gets the same
+// ten minutes as the relay's request timer.
+//
 // The connection timer is the request timer plus 60 s, so it grows to 660 s with
 // it. That is right for a connect the user is approving in MetaMask, but the same
 // timer bounds resuming a stored session on page load, where nobody is in
@@ -31,6 +38,7 @@ export type MetaMaskConnectTimerRewrite = {
 };
 
 const longTimers = "the long Android timers";
+const longExtensionTimer = "the ten-minute desktop extension confirmation";
 
 export type MetaMaskConnectTimeoutPatch = {
   pkg: string;
@@ -49,6 +57,13 @@ export const metaMaskConnectTimeoutPatches: readonly MetaMaskConnectTimeoutPatch
         pattern: /(DEFAULT_REQUEST_TIMEOUT\d*) = 60 \* 1e3;(\s+CONNECTION_GRACE_PERIOD =)/,
         replacement: "$1 = 600 * 1e3;$2",
       },
+      {
+        target: "timer DefaultTransport DEFAULT_REQUEST_TIMEOUT",
+        lost: longExtensionTimer,
+        pattern:
+          /(DEFAULT_REQUEST_TIMEOUT\d*) = 60 \* 1e3;(\s+var _notificationCallbacks\d*, _transport\d*, _defaultRequestOptions\d*,)/,
+        replacement: "$1 = 600 * 1e3;$2",
+      },
       {
         target: "timer the page-load session resume",
         lost: longTimers,

package/types/bundler/metaMaskConnectTimeouts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metaMaskConnectTimeouts.d.ts","sourceRoot":"","sources":["../../src/bundler/metaMaskConnectTimeouts.ts"],"names":[],"mappings":"AAuBA,MAAM,MAAM,2BAA2B,GAAG;IACxC,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAIF,MAAM,MAAM,2BAA2B,GAAG;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAClD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,SAAS,2BAA2B,EAuC/E,CAAC;AAMF,2EAA2E;AAC3E,wBAAgB,8BAA8B,CAC5C,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GACX,2BAA2B,GAAG,SAAS,CAKzC;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GACX;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAY3C;AAED;;;GAGG;AACH,wBAAgB,mCAAmC;YAIvC,MAAM;cAGJ,MAAM,QAAQ,MAAM;aAzBxB,MAAM;cAAQ,MAAM;;IA+B1B,gFAAgF;eACrE,MAAM,GAAG,SAAS;EAShC"}
+{"version":3,"file":"metaMaskConnectTimeouts.d.ts","sourceRoot":"","sources":["../../src/bundler/metaMaskConnectTimeouts.ts"],"names":[],"mappings":"AA8BA,MAAM,MAAM,2BAA2B,GAAG;IACxC,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,2BAA2B,GAAG;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAClD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,SAAS,2BAA2B,EA8C/E,CAAC;AAMF,2EAA2E;AAC3E,wBAAgB,8BAA8B,CAC5C,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GACX,2BAA2B,GAAG,SAAS,CAKzC;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,GACX;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAY3C;AAED;;;GAGG;AACH,wBAAgB,mCAAmC;YAIvC,MAAM;cAGJ,MAAM,QAAQ,MAAM;aAzBxB,MAAM;cAAQ,MAAM;;IA+B1B,gFAAgF;eACrE,MAAM,GAAG,SAAS;EAShC"}