fix: Blockscout and Etherscan lookups are off until the user turns them on (closes #668)

Out of the box the wallet sent the user's addresses to Blockscout for history
and token lookups, and each recipient to Etherscan for its label. Two settings,
"Use Blockscout" and "Check recipients on Etherscan", now gate those requests
where they are made. Both are off in a new profile and offered unticked on
Welcome and in Settings. While one is off, the screens that relied on it say so
in a plain line naming the setting; after either changes in Settings, Back
draws the screen it lands on again. README and the user guide say what is
contacted by default and what each setting adds.

Model: opus-5-5

README.md

@@ -18,13 +18,14 @@ don't implement any crypto, and don't send user-specific data anywhere but a
 unless the user turns on one of the two lookups below. Out of the box the
 extension contacts the configured RPC node for blockchain interactions and a
 public CoinDesk API (no API key) for realtime price information, which is sent
-token symbols and nothing else. Two more services are asked nothing until the
+token symbols and nothing else. Two more services are sent none of the user's
-user turns them on, on the Welcome screen or in Settings: a Blockscout
+data until the user turns them on, on the Welcome screen or in Settings: a
-block-explorer API for transaction history, the tokens the user has not tracked
+Blockscout block-explorer API for transaction history, the tokens the user has
-and transaction details ("Use Blockscout"), and best-effort Etherscan address
+not tracked and transaction details ("Use Blockscout"), and best-effort
-label lookups during transaction confirmation ("Check recipients on Etherscan").
+Etherscan address label lookups during transaction confirmation ("Check
-A community-maintained phishing domain blocklist is built into the extension at
+recipients on Etherscan"). A community-maintained phishing domain blocklist is
-build time and checked locally; nothing is fetched for it at runtime.
+built into the extension at build time and checked locally; nothing is fetched
+for it at runtime.
 
 In the extension is a hardcoded list of the top ERC20 contract addresses. You
 can add any ERC20 contract by contract address if you wish, but the hardcoded
@@ -428,16 +429,20 @@ mainnet must take it down, both while Settings is still on screen.
 It also covers what a new install sends to Blockscout and Etherscan
 ([#668](https://git.eeqj.de/sneak/AutistMask/issues/668)). The route handler
 records every request the extension makes, from its pages and its background
-worker, from the moment the browser starts. Welcome must offer "Use Blockscout"
+worker, from when the harness installs it, before the first popup page opens; a
-and "Check recipients on Etherscan" unticked. With neither changed, Home,
+request the background worker makes while it starts up, before then, is not
-AddressDetail, AddressToken and ConfirmTx must show the lines saying what is
+recorded. Welcome must offer "Use Blockscout" and "Check recipients on
-off; the popup is then closed until the background has run a balance refresh of
+Etherscan" unticked. With neither changed, Home, AddressDetail, AddressToken and
-its own, and not one recorded request may have gone to Blockscout or Etherscan.
+ConfirmTx must show the lines saying what is off; the popup is then closed until
-Each is then ticked in Settings, after which Blockscout must be asked for the
+the background has run a balance refresh of its own, and not one recorded
-history and the token balances, and ConfirmTx must ask Etherscan about the
+request may have gone to Blockscout or Etherscan. "Use Blockscout" is then
-recipient and show the label the stub page gives it. Both stay on for the rest
+ticked from AddressDetail's gear: on "Back", AddressDetail must ask Blockscout
-of the run. TransactionDetail with "Use Blockscout" off is not driven here,
+for its history and no longer say it is off, and Blockscout must then be asked
-since no history row leads to it then; the unit tests cover it.
+for the token balances. "Check recipients on Etherscan" is ticked from
+ConfirmTx's gear: on "Back", ConfirmTx must ask Etherscan about the recipient
+and show the label the stub page gives it. Both stay on for the rest of the run.
+TransactionDetail with "Use Blockscout" off is not driven here, since no history
+row leads to it then; the unit tests cover it.
 
 It also covers the confirmation screen, for both a native ETH send and an ERC-20
 send: Send disabled while the fee estimate is in flight, enabled once it lands,
@@ -1599,7 +1604,10 @@ renders as it goes, and `viewRouter.js` records every screen that reaches
 more — rendering it a second time would re-fetch and overwrite what it holds,
 such as an edit typed into Settings and not yet saved. Home is the one screen
 "Back" always re-renders, so the wallet list reflects anything that changed
-while the user was away from it.
+while the user was away from it. Changing "Use Blockscout" or "Check recipients
+on Etherscan" in Settings makes every screen but Settings count as not yet
+rendered, so "Back" renders the screen it lands on under the new setting; the
+stack is left as it is.
 
 A network switch leaves every screen on the page showing the previous network.
 The user makes it in Settings, or approves a site's request and the background
@@ -2732,10 +2740,10 @@ view would leave a wallet one click from deletion.
 AutistMask is not a fully self-contained offline tool. By default it sends the
 user's data to one service only, the Ethereum RPC endpoint, and asks one more,
 the CoinDesk price API, for prices with nothing but token symbols. Two more
-services are asked nothing until the user turns on the setting for each, on the
+services are sent none of the user's data until the user turns on the setting
-Welcome screen or in Settings: Blockscout ("Use Blockscout") and Etherscan
+for each, on the Welcome screen or in Settings: Blockscout ("Use Blockscout")
-("Check recipients on Etherscan"). Both settings are off in a new profile, and
+and Etherscan ("Check recipients on Etherscan"). Both settings are off in a new
-each is one setting for every network.
+profile, and each is one setting for every network.
 
 Contacted by default:
 

docs/README.md

@@ -72,9 +72,9 @@ analytics, use a portfolio tracker. The wallet is not the place for any of that.
 AutistMask is a browser extension that runs entirely in your browser. It does
 not have a backend server. Out of the box it sends your data only to the
 Ethereum RPC endpoint, and asks the CoinDesk price API for prices with nothing
-but token symbols. Blockscout and Etherscan are asked nothing until you turn on
+but token symbols. Blockscout and Etherscan are sent none of your data until you
-"Use Blockscout" or "Check recipients on Etherscan", on the Welcome screen or
+turn on "Use Blockscout" or "Check recipients on Etherscan", on the Welcome
-later in Settings. Both are off in a new install.
+screen or later in Settings. Both are off in a new install.
 
 ### External Services
 

src/popup/viewRouter.js

@@ -40,9 +40,11 @@ function markViewRendered(view) {
 
 // Begin a fresh page-load scope. The popup gets one by being loaded, and
 // asks for one after a network switch, because every screen then on the page
-// shows the previous network (showNewNetwork() in views/settings.js); the
+// shows the previous network (showNewNetwork() in views/settings.js), and
-// unit tests, which simulate several page loads against one module
+// after "Use Blockscout" or "Check recipients on Etherscan" changes in
-// instance, ask for one too.
+// Settings, because every screen then on the page was drawn under the old
+// setting; the unit tests, which simulate several page loads against one
+// module instance, ask for one too.
 function resetRenderedViews() {
     renderedViews.clear();
 }

src/popup/views/settings.js

@@ -367,11 +367,16 @@ function init(_ctx) {
         showFlash("Saved.");
     });
 
-    // Welcome offers the same two settings, and Back from here to Welcome only
+    // The screens under Settings were drawn under the old setting, so each
-    // unhides it, so its boxes are set here too.
+    // change makes every screen but Settings count as not yet drawn, as a
+    // network switch does, and Back draws the one it lands on again. Welcome
+    // offers the same two settings and is only unhidden on Back, so its boxes
+    // are set here too.
     $("settings-use-blockscout").addEventListener("change", async () => {
         state.useBlockscout = $("settings-use-blockscout").checked;
         $("welcome-use-blockscout").checked = state.useBlockscout;
+        resetRenderedViews();
+        markViewRendered("settings");
         await saveState();
     });
 
@@ -383,6 +388,8 @@ function init(_ctx) {
             ).checked;
             $("welcome-check-recipients-on-etherscan").checked =
                 state.checkRecipientsOnEtherscan;
+            resetRenderedViews();
+            markViewRendered("settings");
             await saveState();
         },
     );

tests/e2e/run.js

@@ -274,10 +274,13 @@ test("the exact confirmation phrase erases the record and reloads into Welcome (
 // A fresh install asks neither Blockscout nor Etherscan anything until the
 // user turns on "Use Blockscout" or "Check recipients on Etherscan". The route
 // handler in tests/e2e/network.js records every request the extension makes,
-// from its pages and its background worker, from the moment the browser
+// from its pages and its background worker, in env.routeOpts.requests.
-// starts, in env.routeOpts.requests. These tests drive every screen that
+// Recording starts when launch() in tests/e2e/harness.js installs that
-// would ask either service, and the background's own balance refresh, before
+// handler, before the first popup page opens; a request the background worker
-// either setting is changed, then turn each on and watch its requests start.
+// makes while it starts up, before then, is not recorded. These tests drive
+// every screen that would ask either service, and the background's own
+// balance refresh, before either setting is changed, then turn each on and
+// watch its requests start.
 
 // What the three transaction lists say while Use Blockscout is off. Written
 // out here rather than imported, so the assertion does not compare the popup
@@ -444,23 +447,41 @@ test("with neither setting changed, nothing has reached Blockscout or Etherscan,
     await visible(env.page, "#view-address");
 });
 
-test("turning on Use Blockscout in Settings asks Blockscout for the history and the tokens (#668)", async (env) => {
+// Ticked from AddressDetail's gear, so Back lands on the screen that said the
+// setting is off.
+test("turning on Use Blockscout from AddressDetail's gear asks Blockscout for that screen's history on Back, then for the tokens (#668)", async (env) => {
+    await openAddressDetail(env.page);
+    await waitForHistoryOff(env.page, "tx-list");
     await openSettings(env.page);
     await env.page.check("#settings-use-blockscout");
     await waitForPersisted(env.page, "useBlockscout", true, "once ticked");
-    const asked = Promise.all([
+    const historyAsked = env.page.waitForRequest(
-        env.page.waitForRequest(
+        (r) =>
-            (r) =>
+            r.url().includes("blockscout.com") &&
-                r.url().includes("blockscout.com") &&
+            r.url().endsWith("/transactions"),
-                r.url().endsWith("/transactions"),
+    );
-        ),
+    const tokensAsked = env.page.waitForRequest(
-        env.page.waitForRequest((r) => r.url().endsWith("/token-balances"), {
+        (r) => r.url().endsWith("/token-balances"),
-            timeout: 30000,
+        { timeout: 30000 },
-        }),
+    );
-    ]);
     await env.page.click("#btn-settings-back");
+    await visible(env.page, "#view-address");
+    await historyAsked;
+    await env.page.waitForFunction(
+        () =>
+            document
+                .getElementById("tx-list")
+                .textContent.includes("No transactions found."),
+        null,
+        { timeout: 15000 },
+    );
+    assert(
+        !(await env.page.isVisible("#address-tokens-note")),
+        "AddressDetail still says only tracked tokens are listed",
+    );
+
     await goHome(env.page);
-    await asked;
+    await tokensAsked;
     await env.page.waitForFunction(
         () =>
             document
@@ -475,11 +496,21 @@ test("turning on Use Blockscout in Settings asks Blockscout for the history and
     );
 });
 
-// Left on for the rest of the run, as the check was always made before #668.
+// Ticked from ConfirmTx's gear, so Back lands on the screen that said no
-test("turning on Check recipients on Etherscan in Settings has ConfirmTx ask Etherscan and show its label (#668)", async (env) => {
+// Etherscan check was made. Left on for the rest of the run, as the check was
+// always made before #668.
+test("turning on Check recipients on Etherscan from ConfirmTx's gear has ConfirmTx ask Etherscan on Back and show its label (#668)", async (env) => {
     env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
     env.routeOpts.etherscanLabel = "Fake_Phishing668";
     try {
+        await settleOnMain(env, { ethWei: FUNDED_ETH_WEI });
+        await goToConfirm(env.page, {
+            token: "ETH",
+            balance: FUNDED_ETH_TEXT + " ETH",
+            amount: COMFORTABLE_AMOUNT,
+        });
+        await visible(env.page, "#confirm-etherscan-note");
+
         await openSettings(env.page);
         await env.page.check("#settings-check-recipients-on-etherscan");
         await waitForPersisted(
@@ -488,15 +519,9 @@ test("turning on Check recipients on Etherscan in Settings has ConfirmTx ask Eth
             true,
             "once ticked",
         );
-        await env.page.click("#btn-settings-back");
-        await settleOnMain(env, { ethWei: FUNDED_ETH_WEI });
-
         const before = env.routeOpts.requests.length;
-        await goToConfirm(env.page, {
+        await env.page.click("#btn-settings-back");
-            token: "ETH",
+        await visible(env.page, "#view-confirm-tx");
-            balance: FUNDED_ETH_TEXT + " ETH",
-            amount: COMFORTABLE_AMOUNT,
-        });
         await visible(env.page, "#confirm-etherscan-warning", 30000);
         assert(
             !(await env.page.isVisible("#confirm-etherscan-note")),
@@ -5488,8 +5513,9 @@ async function main() {
         // order. The dApp transaction round trip asserts against these bytes
         // rather than against anything the extension reported about them.
         broadcastTransactions: [],
-        // Every request the extension makes, from the browser's start, in
+        // Every request the extension makes, in order, from when launch()
-        // order (#668).
+        // installs the route handler, before the first popup page opens
+        // (#668).
         requests: [],
     };