Compare commits
3 Commits
issue-308-
...
issue-317-
| Author | SHA1 | Date | |
|---|---|---|---|
| 5c4a671d4a | |||
| 50078b3566 | |||
| 6350aad591 |
54
TODO.md
54
TODO.md
@@ -44,6 +44,60 @@ but the review is broader than any of them.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-08-20: A page asking which chain the wallet is on is told the chain the
|
||||||
|
user is actually on ([#317](https://git.eeqj.de/sneak/AutistMask/issues/317)).
|
||||||
|
`eth_chainId` and `net_version` answered from `currentNetwork()`, which reads
|
||||||
|
the module-level `state` singleton that nothing populates at module scope, so
|
||||||
|
a service worker revived by the page's own message answered out of
|
||||||
|
`DEFAULT_STATE` and reported mainnet `0x1`/`1` to a user on Sepolia — a dApp
|
||||||
|
building its interaction for the wrong chain. Both now answer from
|
||||||
|
`getState()`, the per-call detached storage read the other read handlers use,
|
||||||
|
rather than from the singleton: these two are reachable by any page on every
|
||||||
|
provider init, and mutating the shared singleton on that path would detach the
|
||||||
|
wallet objects an in-flight `backgroundRefresh()` is mutating. The read side
|
||||||
|
of the background was audited with it: the remaining singleton reads are the
|
||||||
|
chain switch, the transaction verification path and `backgroundRefresh`, which
|
||||||
|
each already load, and everything else answers from storage per call through
|
||||||
|
`getState()`. One stale read is left named but unfixed, outside this issue's
|
||||||
|
scope: `handleSendTransaction` builds its provider with no network name, so
|
||||||
|
`getProvider()` falls back to the same unloaded singleton for ethers' static
|
||||||
|
network hint.
|
||||||
|
- 2026-08-20: The dApp approval screen no longer shows a token transfer it
|
||||||
|
cannot scale as `0.0000`
|
||||||
|
([#306](https://git.eeqj.de/sneak/AutistMask/issues/306)). `decodeCalldata`
|
||||||
|
read decimals from the 512-entry bundled token list alone and fell back to 18,
|
||||||
|
so every token outside it — most of them, including anything the user added by
|
||||||
|
contract address — was displayed at the wrong scale: a `transfer` of 5,000
|
||||||
|
units of a 6-decimal token read as `0.0000`, and a user who reads zero
|
||||||
|
confirms the drain. The new `src/shared/approvalAmount.js` resolves the scale
|
||||||
|
from the bundled list, then `state.trackedTokens`, then the decimals the block
|
||||||
|
explorer already reported in `addr.tokenBalances`, and refuses one the
|
||||||
|
explorer's own entries disagree about. Where no source knows it, the amount
|
||||||
|
line is not formatted at all: it shows the base-unit integer and states that
|
||||||
|
the scale is unknown, for `approve` as well as `transfer`. An unbounded
|
||||||
|
allowance still reads `Unlimited`, which needs no scale.
|
||||||
|
- 2026-08-20: A web page can no longer switch the wallet's chain, and switching
|
||||||
|
no longer destroys the user's endpoints
|
||||||
|
([#308](https://git.eeqj.de/sneak/AutistMask/issues/308)).
|
||||||
|
`wallet_switchEthereumChain` was answered for any origin at all, with no
|
||||||
|
connection check and no prompt: any page could clear the `[TESTNET]` banner
|
||||||
|
under a user who believed they were on Sepolia. It now takes the same
|
||||||
|
`allowedSites`/`connectedSites` gate the signing methods take, ahead of the
|
||||||
|
same-chain and unsupported-chain answers, and refuses an unconnected origin
|
||||||
|
with `4100`. The switch itself also overwrote `state.rpcUrl` and
|
||||||
|
`state.blockscoutUrl` with the network defaults, so a user running their own
|
||||||
|
node lost that url permanently and silently to a public endpoint that then
|
||||||
|
sees every address they hold. Endpoints are now remembered per network in
|
||||||
|
`state.networkEndpoints`, snapshotted from the network being left and restored
|
||||||
|
for the network being entered; `state.rpcUrl` stays the live value for the
|
||||||
|
active network, so no reader changed. A profile written before the map existed
|
||||||
|
has its stored pair adopted for the network it was stored under, and loses
|
||||||
|
nothing. The handler now loads state before it switches
|
||||||
|
([#316](https://git.eeqj.de/sneak/AutistMask/issues/316)): the service worker
|
||||||
|
populates nothing at module scope, so a worker revived by the page's own
|
||||||
|
message held `DEFAULT_STATE`, and the switch persisted every field of it —
|
||||||
|
wiping every wallet, every site approval and every tracked token from storage
|
||||||
|
along with the endpoint.
|
||||||
- 2026-08-20: The wallet's own ERC-20 send signs the amount it displayed
|
- 2026-08-20: The wallet's own ERC-20 send signs the amount it displayed
|
||||||
([#305](https://git.eeqj.de/sneak/AutistMask/issues/305)). The confirmation
|
([#305](https://git.eeqj.de/sneak/AutistMask/issues/305)). The confirmation
|
||||||
screen renders from the block explorer's cached decimals; the transfer was
|
screen renders from the block explorer's cached decimals; the transfer was
|
||||||
|
|||||||
@@ -3,7 +3,11 @@
|
|||||||
// non-sensitive calls to the configured Ethereum JSON-RPC endpoint.
|
// non-sensitive calls to the configured Ethereum JSON-RPC endpoint.
|
||||||
|
|
||||||
const { DEFAULT_RPC_URL } = require("../shared/constants");
|
const { DEFAULT_RPC_URL } = require("../shared/constants");
|
||||||
const { SUPPORTED_CHAIN_IDS, networkByChainId } = require("../shared/networks");
|
const {
|
||||||
|
SUPPORTED_CHAIN_IDS,
|
||||||
|
networkById,
|
||||||
|
networkByChainId,
|
||||||
|
} = require("../shared/networks");
|
||||||
const { onChainSwitch } = require("../shared/chainSwitch");
|
const { onChainSwitch } = require("../shared/chainSwitch");
|
||||||
const {
|
const {
|
||||||
state,
|
state,
|
||||||
@@ -663,15 +667,59 @@ async function handleRpc(method, params, origin) {
|
|||||||
return { result: [] };
|
return { result: [] };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (method === "eth_chainId") {
|
// Both answered from currentNetwork(), which reads the module-level state
|
||||||
return { result: currentNetwork().chainId };
|
// singleton, and nothing populates that at module scope. A worker revived
|
||||||
}
|
// by the page's own message therefore held DEFAULT_STATE and told a page
|
||||||
|
// it was on mainnet while the user was on Sepolia
|
||||||
if (method === "net_version") {
|
// (https://git.eeqj.de/sneak/AutistMask/issues/317).
|
||||||
return { result: currentNetwork().networkVersion };
|
//
|
||||||
|
// Answered from getState() rather than by loading the singleton. Any page
|
||||||
|
// reaches these two — neither is gated on a connection, and the injected
|
||||||
|
// provider sends eth_chainId on every page load — and loadState() replaces
|
||||||
|
// state.wallets wholesale, which would detach the address objects an
|
||||||
|
// in-flight backgroundRefresh() is mutating across its network round trip,
|
||||||
|
// so its saveState() would persist the pre-refresh balances while still
|
||||||
|
// stamping lastBalanceRefresh. getState() is the detached per-call storage
|
||||||
|
// read the other read handlers here already use.
|
||||||
|
// networkById(undefined) falls back to mainnet, matching the default for a
|
||||||
|
// profile with no stored networkId.
|
||||||
|
if (method === "eth_chainId" || method === "net_version") {
|
||||||
|
const s = await getState();
|
||||||
|
const net = networkById(s.networkId);
|
||||||
|
return {
|
||||||
|
result: method === "eth_chainId" ? net.chainId : net.networkVersion,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
if (method === "wallet_switchEthereumChain") {
|
if (method === "wallet_switchEthereumChain") {
|
||||||
|
// Gated exactly like the signing methods, and gated before the
|
||||||
|
// same-chain early return. Switching the chain is wallet-wide: it
|
||||||
|
// moves the network the popup shows and the endpoints every other
|
||||||
|
// tab is served from, so a page the user never connected to must
|
||||||
|
// not be able to do it. Ungated, any page could clear the
|
||||||
|
// [TESTNET] banner under a user who believed they were on Sepolia.
|
||||||
|
const s = await getState();
|
||||||
|
const activeAddress = await getActiveAddress();
|
||||||
|
const hostname = extractHostname(origin);
|
||||||
|
const allowed = s.allowedSites[activeAddress] || [];
|
||||||
|
if (
|
||||||
|
!allowed.includes(hostname) &&
|
||||||
|
!connectedSites[origin + ":" + activeAddress]
|
||||||
|
) {
|
||||||
|
return { error: { code: 4100, message: "Unauthorized" } };
|
||||||
|
}
|
||||||
|
|
||||||
|
// onChainSwitch() mutates the module-level state singleton and then
|
||||||
|
// saves every field of it, and currentNetwork() reads the same
|
||||||
|
// singleton. This worker may have been started by this very message:
|
||||||
|
// nothing loads state at module scope, so without this the singleton
|
||||||
|
// is DEFAULT_STATE, the same-chain check compares against the wrong
|
||||||
|
// network, and the save writes empty wallets, empty allowedSites and
|
||||||
|
// the default endpoints over the user's stored profile
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/316). Same precedent
|
||||||
|
// as the transaction path below.
|
||||||
|
await loadState();
|
||||||
|
|
||||||
const chainId = params?.[0]?.chainId;
|
const chainId = params?.[0]?.chainId;
|
||||||
if (chainId === currentNetwork().chainId) {
|
if (chainId === currentNetwork().chainId) {
|
||||||
return { result: null };
|
return { result: null };
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ const {
|
|||||||
const { getPrice, formatUsd } = require("../../shared/prices");
|
const { getPrice, formatUsd } = require("../../shared/prices");
|
||||||
const { ERC20_ABI } = require("../../shared/constants");
|
const { ERC20_ABI } = require("../../shared/constants");
|
||||||
const { TOKEN_BY_ADDRESS } = require("../../shared/tokenList");
|
const { TOKEN_BY_ADDRESS } = require("../../shared/tokenList");
|
||||||
|
const {
|
||||||
|
resolveTokenDecimals,
|
||||||
|
unknownDecimalsAmount,
|
||||||
|
} = require("../../shared/approvalAmount");
|
||||||
const { decryptWithPassword } = require("../../shared/vault");
|
const { decryptWithPassword } = require("../../shared/vault");
|
||||||
const { getSignerForAddress } = require("../../shared/wallet");
|
const { getSignerForAddress } = require("../../shared/wallet");
|
||||||
const { walletDefect } = require("../../shared/walletDefects");
|
const { walletDefect } = require("../../shared/walletDefects");
|
||||||
@@ -43,6 +47,23 @@ function formatTxValue(val) {
|
|||||||
return parts[0] + "." + dec;
|
return parts[0] + "." + dec;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The amount line for a decoded ERC-20 call. With a known scale it is the
|
||||||
|
// token quantity; with `decimals` null it is the base-unit integer with the
|
||||||
|
// unknown scale stated, because formatting it with an assumed scale is what
|
||||||
|
// showed a 5,000-token transfer as `0.0000`. `raw` is what the status screens
|
||||||
|
// carry, `display` is what the approval screen shows.
|
||||||
|
function tokenAmountText(rawAmount, decimals, symbol) {
|
||||||
|
if (decimals === null) {
|
||||||
|
const unknown = unknownDecimalsAmount(rawAmount);
|
||||||
|
return { raw: unknown, display: unknown };
|
||||||
|
}
|
||||||
|
const formatted = formatTxValue(formatUnits(rawAmount, decimals));
|
||||||
|
return {
|
||||||
|
raw: formatted,
|
||||||
|
display: formatted + (symbol ? " " + symbol : ""),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
function tokenLabel(address) {
|
function tokenLabel(address) {
|
||||||
const t = TOKEN_BY_ADDRESS.get(address.toLowerCase());
|
const t = TOKEN_BY_ADDRESS.get(address.toLowerCase());
|
||||||
return t ? t.symbol : null;
|
return t ? t.symbol : null;
|
||||||
@@ -59,7 +80,15 @@ function decodeCalldata(data, toAddress) {
|
|||||||
if (parsed) {
|
if (parsed) {
|
||||||
const token = TOKEN_BY_ADDRESS.get(toAddress.toLowerCase());
|
const token = TOKEN_BY_ADDRESS.get(toAddress.toLowerCase());
|
||||||
const tokenSymbol = token ? token.symbol : null;
|
const tokenSymbol = token ? token.symbol : null;
|
||||||
const tokenDecimals = token ? token.decimals : 18;
|
// null when no source knows this token's scale. It is not
|
||||||
|
// defaulted to 18: an amount formatted with a guessed scale is
|
||||||
|
// the wrong number, and for a token with fewer decimals than the
|
||||||
|
// guess it is the wrong number in the direction that reads as
|
||||||
|
// zero. See tokenAmountText().
|
||||||
|
const tokenDecimals = resolveTokenDecimals(toAddress, {
|
||||||
|
trackedTokens: state.trackedTokens,
|
||||||
|
wallets: state.wallets,
|
||||||
|
});
|
||||||
const contractLabel = tokenSymbol
|
const contractLabel = tokenSymbol
|
||||||
? tokenSymbol + " (" + toAddress + ")"
|
? tokenSymbol + " (" + toAddress + ")"
|
||||||
: toAddress;
|
: toAddress;
|
||||||
@@ -71,12 +100,11 @@ function decodeCalldata(data, toAddress) {
|
|||||||
"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
|
"0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
|
||||||
);
|
);
|
||||||
const isUnlimited = rawAmount === maxUint;
|
const isUnlimited = rawAmount === maxUint;
|
||||||
const amountRaw = isUnlimited
|
// An unbounded allowance needs no scale to describe, so it is
|
||||||
? "Unlimited"
|
// still named rather than refused.
|
||||||
: formatTxValue(formatUnits(rawAmount, tokenDecimals));
|
const amount = isUnlimited
|
||||||
const amountStr = isUnlimited
|
? { raw: "Unlimited", display: "Unlimited" }
|
||||||
? "Unlimited"
|
: tokenAmountText(rawAmount, tokenDecimals, tokenSymbol);
|
||||||
: amountRaw + (tokenSymbol ? " " + tokenSymbol : "");
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
name: "Token Approval",
|
name: "Token Approval",
|
||||||
@@ -97,8 +125,8 @@ function decodeCalldata(data, toAddress) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Amount",
|
label: "Amount",
|
||||||
value: amountStr,
|
value: amount.display,
|
||||||
rawValue: amountRaw,
|
rawValue: amount.raw,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
@@ -107,11 +135,11 @@ function decodeCalldata(data, toAddress) {
|
|||||||
if (parsed.name === "transfer") {
|
if (parsed.name === "transfer") {
|
||||||
const to = parsed.args[0];
|
const to = parsed.args[0];
|
||||||
const rawAmount = parsed.args[1];
|
const rawAmount = parsed.args[1];
|
||||||
const amountRaw = formatTxValue(
|
const amount = tokenAmountText(
|
||||||
formatUnits(rawAmount, tokenDecimals),
|
rawAmount,
|
||||||
|
tokenDecimals,
|
||||||
|
tokenSymbol,
|
||||||
);
|
);
|
||||||
const amountStr =
|
|
||||||
amountRaw + (tokenSymbol ? " " + tokenSymbol : "");
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
name: "Token Transfer",
|
name: "Token Transfer",
|
||||||
@@ -128,8 +156,8 @@ function decodeCalldata(data, toAddress) {
|
|||||||
{ label: "Recipient", value: to, address: to },
|
{ label: "Recipient", value: to, address: to },
|
||||||
{
|
{
|
||||||
label: "Amount",
|
label: "Amount",
|
||||||
value: amountStr,
|
value: amount.display,
|
||||||
rawValue: amountRaw,
|
rawValue: amount.raw,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|||||||
103
src/shared/approvalAmount.js
Normal file
103
src/shared/approvalAmount.js
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
// The scale an ERC-20 amount in a dApp's calldata is displayed with, and what
|
||||||
|
// to display when there is no such scale.
|
||||||
|
//
|
||||||
|
// The approval screen decodes `transfer` and `approve` calldata into a
|
||||||
|
// quantity the user confirms against. That quantity is a base-unit integer,
|
||||||
|
// and turning it into a number a person can read needs the token's decimals.
|
||||||
|
// Assuming a scale is how a drain gets confirmed: a `transfer` of 5000000000
|
||||||
|
// units of a 6-decimal token is 5,000 tokens, but formatted with the ERC-20
|
||||||
|
// default of 18 it reads `0.0000`, and a user who reads zero signs.
|
||||||
|
//
|
||||||
|
// So a scale is either found or the amount is not formatted. Decimals are
|
||||||
|
// looked for in the bundled token list, then in the tokens the user tracks,
|
||||||
|
// then in what the block explorer reported for the contract; where none of
|
||||||
|
// them answers, unknownDecimalsAmount() renders the base-unit integer with the
|
||||||
|
// unknown scale stated, and no formatUnits() call is reached at all.
|
||||||
|
//
|
||||||
|
// This is the display counterpart to transferAmount.js, which takes the same
|
||||||
|
// stance on the wallet's own send path: an amount whose scale is unknown or
|
||||||
|
// disputed is refused rather than guessed at.
|
||||||
|
|
||||||
|
// Solidity's decimals() is a uint8, and every source here is ultimately
|
||||||
|
// reporting that call's result.
|
||||||
|
const { MAX_DECIMALS } = require("./transferAmount");
|
||||||
|
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
|
|
||||||
|
// A decimals value as a number, or null if it is not one. The bundled list
|
||||||
|
// stores numbers, the explorer's copy arrives as a string, and a token the
|
||||||
|
// user added by hand can carry whatever lookupTokenInfo() got back, so the
|
||||||
|
// accepted types are enumerated rather than coerced: Number([]) is 0 and
|
||||||
|
// Number(true) is 1, so a coercing check would read an empty array as a scale
|
||||||
|
// of zero and format the amount as whole tokens.
|
||||||
|
function toDecimals(value) {
|
||||||
|
let n;
|
||||||
|
if (typeof value === "number") {
|
||||||
|
n = value;
|
||||||
|
} else if (typeof value === "bigint") {
|
||||||
|
if (value < 0n || value > BigInt(MAX_DECIMALS)) return null;
|
||||||
|
n = Number(value);
|
||||||
|
} else if (typeof value === "string") {
|
||||||
|
if (!/^[0-9]+$/.test(value)) return null;
|
||||||
|
n = Number(value);
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
if (!Number.isInteger(n) || n < 0 || n > MAX_DECIMALS) return null;
|
||||||
|
return n;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every decimals the explorer reported for this contract, across all the
|
||||||
|
// addresses whose balances have been fetched. They describe one contract, so
|
||||||
|
// they should agree; a set that does not agree is a scale in dispute, and this
|
||||||
|
// screen has no way to tell which member is the true one.
|
||||||
|
function explorerDecimals(lower, wallets) {
|
||||||
|
let found = null;
|
||||||
|
for (const wallet of wallets || []) {
|
||||||
|
for (const addr of wallet.addresses || []) {
|
||||||
|
for (const tb of addr.tokenBalances || []) {
|
||||||
|
if ((tb.address || "").toLowerCase() !== lower) continue;
|
||||||
|
const d = toDecimals(tb.decimals);
|
||||||
|
if (d === null) continue;
|
||||||
|
if (found !== null && found !== d) return null;
|
||||||
|
found = d;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return found;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The decimals to render a token amount with, or null when nothing knows.
|
||||||
|
// `sources` is { trackedTokens, wallets }, both shaped as they are on `state`.
|
||||||
|
function resolveTokenDecimals(tokenAddress, sources) {
|
||||||
|
const lower = (tokenAddress || "").toLowerCase();
|
||||||
|
if (!lower) return null;
|
||||||
|
|
||||||
|
const bundled = TOKEN_BY_ADDRESS.get(lower);
|
||||||
|
if (bundled) {
|
||||||
|
const d = toDecimals(bundled.decimals);
|
||||||
|
if (d !== null) return d;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tracked = ((sources && sources.trackedTokens) || []).find(
|
||||||
|
(t) => (t.address || "").toLowerCase() === lower,
|
||||||
|
);
|
||||||
|
if (tracked) {
|
||||||
|
const d = toDecimals(tracked.decimals);
|
||||||
|
if (d !== null) return d;
|
||||||
|
}
|
||||||
|
|
||||||
|
return explorerDecimals(lower, sources && sources.wallets);
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the amount line reads when the scale is unknown. The base units are
|
||||||
|
// exact and the caveat is part of the same string, so the number on the screen
|
||||||
|
// cannot be mistaken for a token quantity, and it can never read as zero for a
|
||||||
|
// transfer that is not zero.
|
||||||
|
function unknownDecimalsAmount(rawAmount) {
|
||||||
|
return String(rawAmount) + " base units (decimals unknown)";
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
resolveTokenDecimals,
|
||||||
|
unknownDecimalsAmount,
|
||||||
|
};
|
||||||
@@ -19,9 +19,26 @@ async function onChainSwitch(newNetworkId) {
|
|||||||
const net = networkById(newNetworkId);
|
const net = networkById(newNetworkId);
|
||||||
|
|
||||||
// --- core identity ---
|
// --- core identity ---
|
||||||
|
// Endpoints are remembered per network rather than reset to the
|
||||||
|
// defaults, because a user who points the wallet at their own node has
|
||||||
|
// no way to get that URL back once it is gone: overwriting it moved
|
||||||
|
// every address and every transaction onto a third-party endpoint
|
||||||
|
// silently and permanently.
|
||||||
|
//
|
||||||
|
// state.rpcUrl / state.blockscoutUrl stay the live endpoints of the
|
||||||
|
// active network, so nothing that reads them changes. The invariant is
|
||||||
|
// that for the ACTIVE network those two fields are authoritative and
|
||||||
|
// the map entry may be stale (Settings writes the fields directly);
|
||||||
|
// for every other network the map is authoritative. Snapshotting the
|
||||||
|
// outgoing network here, before the switch, is what reconciles them.
|
||||||
|
state.networkEndpoints[state.networkId] = {
|
||||||
|
rpcUrl: state.rpcUrl,
|
||||||
|
blockscoutUrl: state.blockscoutUrl,
|
||||||
|
};
|
||||||
|
const remembered = state.networkEndpoints[net.id] || {};
|
||||||
state.networkId = net.id;
|
state.networkId = net.id;
|
||||||
state.rpcUrl = net.defaultRpcUrl;
|
state.rpcUrl = remembered.rpcUrl || net.defaultRpcUrl;
|
||||||
state.blockscoutUrl = net.defaultBlockscoutUrl;
|
state.blockscoutUrl = remembered.blockscoutUrl || net.defaultBlockscoutUrl;
|
||||||
|
|
||||||
// --- price cache ---
|
// --- price cache ---
|
||||||
// Prices are chain-specific (testnet tokens are worthless,
|
// Prices are chain-specific (testnet tokens are worthless,
|
||||||
|
|||||||
@@ -14,6 +14,11 @@ const DEFAULT_STATE = {
|
|||||||
networkId: "mainnet",
|
networkId: "mainnet",
|
||||||
rpcUrl: DEFAULT_RPC_URL,
|
rpcUrl: DEFAULT_RPC_URL,
|
||||||
blockscoutUrl: DEFAULT_BLOCKSCOUT_URL,
|
blockscoutUrl: DEFAULT_BLOCKSCOUT_URL,
|
||||||
|
// Endpoints remembered per network: { [networkId]: { rpcUrl,
|
||||||
|
// blockscoutUrl } }. rpcUrl/blockscoutUrl above are the live endpoints
|
||||||
|
// of the active network; this is what the others are restored from
|
||||||
|
// when the active network changes. See onChainSwitch().
|
||||||
|
networkEndpoints: {},
|
||||||
lastBalanceRefresh: 0,
|
lastBalanceRefresh: 0,
|
||||||
activeAddress: null,
|
activeAddress: null,
|
||||||
allowedSites: {},
|
allowedSites: {},
|
||||||
@@ -34,6 +39,9 @@ const DEFAULT_STATE = {
|
|||||||
|
|
||||||
const state = {
|
const state = {
|
||||||
...DEFAULT_STATE,
|
...DEFAULT_STATE,
|
||||||
|
// Its own object, not the one DEFAULT_STATE holds: onChainSwitch()
|
||||||
|
// mutates this map in place, and a spread copies the reference.
|
||||||
|
networkEndpoints: {},
|
||||||
currentView: null,
|
currentView: null,
|
||||||
selectedWallet: null,
|
selectedWallet: null,
|
||||||
selectedAddress: null,
|
selectedAddress: null,
|
||||||
@@ -88,6 +96,7 @@ async function saveState() {
|
|||||||
networkId: state.networkId,
|
networkId: state.networkId,
|
||||||
rpcUrl: state.rpcUrl,
|
rpcUrl: state.rpcUrl,
|
||||||
blockscoutUrl: state.blockscoutUrl,
|
blockscoutUrl: state.blockscoutUrl,
|
||||||
|
networkEndpoints: state.networkEndpoints,
|
||||||
lastBalanceRefresh: state.lastBalanceRefresh,
|
lastBalanceRefresh: state.lastBalanceRefresh,
|
||||||
activeAddress: state.activeAddress,
|
activeAddress: state.activeAddress,
|
||||||
allowedSites: state.allowedSites,
|
allowedSites: state.allowedSites,
|
||||||
@@ -128,6 +137,30 @@ async function loadState() {
|
|||||||
state.rpcUrl = saved.rpcUrl || DEFAULT_STATE.rpcUrl;
|
state.rpcUrl = saved.rpcUrl || DEFAULT_STATE.rpcUrl;
|
||||||
state.blockscoutUrl =
|
state.blockscoutUrl =
|
||||||
saved.blockscoutUrl || DEFAULT_STATE.blockscoutUrl;
|
saved.blockscoutUrl || DEFAULT_STATE.blockscoutUrl;
|
||||||
|
// An actual object is required, not merely a truthy non-array: the
|
||||||
|
// code below and onChainSwitch() index and ASSIGN INTO this value,
|
||||||
|
// and assigning a property to a string or a number is a silent no-op
|
||||||
|
// in sloppy mode. A stored primitive would therefore be re-persisted
|
||||||
|
// unchanged forever, and every switch would fall back to the network
|
||||||
|
// default — the endpoint loss this map exists to prevent, with no
|
||||||
|
// self-healing. The allowedSites/deniedSites guards below are only
|
||||||
|
// read from, which is why they can be looser.
|
||||||
|
state.networkEndpoints =
|
||||||
|
typeof saved.networkEndpoints === "object" &&
|
||||||
|
saved.networkEndpoints !== null &&
|
||||||
|
!Array.isArray(saved.networkEndpoints)
|
||||||
|
? saved.networkEndpoints
|
||||||
|
: {};
|
||||||
|
// A profile written before this map existed carries exactly one pair
|
||||||
|
// of endpoints, belonging to whatever network it was last on. Adopt
|
||||||
|
// it as that network's remembered pair, so a custom endpoint set on
|
||||||
|
// the old build is not lost by the first switch away and back.
|
||||||
|
if (!state.networkEndpoints[state.networkId]) {
|
||||||
|
state.networkEndpoints[state.networkId] = {
|
||||||
|
rpcUrl: state.rpcUrl,
|
||||||
|
blockscoutUrl: state.blockscoutUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
state.lastBalanceRefresh = saved.lastBalanceRefresh || 0;
|
state.lastBalanceRefresh = saved.lastBalanceRefresh || 0;
|
||||||
state.activeAddress = saved.activeAddress || null;
|
state.activeAddress = saved.activeAddress || null;
|
||||||
state.allowedSites =
|
state.allowedSites =
|
||||||
|
|||||||
208
tests/approvalAmount.test.js
Normal file
208
tests/approvalAmount.test.js
Normal file
@@ -0,0 +1,208 @@
|
|||||||
|
// The quantity the dApp approval screen shows for a decoded ERC-20 call.
|
||||||
|
//
|
||||||
|
// The screen's amount line is the only place a user sees how much a page is
|
||||||
|
// asking for, and it is decoded from calldata, which carries base units and
|
||||||
|
// no scale. Issue #306: decodeCalldata read decimals from the bundled token
|
||||||
|
// list alone and fell back to 18, so a `transfer` of 5000000000 units of a
|
||||||
|
// 6-decimal token — 5,000 tokens — was displayed as `0.0000` and confirmed.
|
||||||
|
//
|
||||||
|
// What is asserted here is that the scale is found wherever the wallet
|
||||||
|
// already has it, and that where it is nowhere at all no formatted number is
|
||||||
|
// produced: the amount line has to say base units and say the scale is
|
||||||
|
// unknown, because a wrong quantity that reads as zero is worse than an
|
||||||
|
// unwieldy correct one.
|
||||||
|
|
||||||
|
globalThis.chrome = {
|
||||||
|
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||||
|
};
|
||||||
|
|
||||||
|
const { Interface } = require("ethers");
|
||||||
|
const { ERC20_ABI } = require("../src/shared/constants");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
const {
|
||||||
|
resolveTokenDecimals,
|
||||||
|
unknownDecimalsAmount,
|
||||||
|
} = require("../src/shared/approvalAmount");
|
||||||
|
const { decodeCalldata } = require("../src/popup/views/approval");
|
||||||
|
|
||||||
|
const iface = new Interface(ERC20_ABI);
|
||||||
|
|
||||||
|
// Outside the bundled list, as the great majority of ERC-20s are.
|
||||||
|
const NOVEL_TOKEN = "0xE2E0000000000000000000000000000000000E2e";
|
||||||
|
// In the bundled list, at 6 decimals.
|
||||||
|
const USDC = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
|
||||||
|
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||||
|
const SPENDER = "0x1111111111111111111111111111111111111111";
|
||||||
|
|
||||||
|
// 5,000 units of a 6-decimal token, the amount from the issue.
|
||||||
|
const FIVE_THOUSAND_AT_SIX = 5000000000n;
|
||||||
|
const MAX_UINT256 = (1n << 256n) - 1n;
|
||||||
|
|
||||||
|
function transferData(amount) {
|
||||||
|
return iface.encodeFunctionData("transfer", [RECIPIENT, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function approveData(amount) {
|
||||||
|
return iface.encodeFunctionData("approve", [SPENDER, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Amount line as the approval screen renders it.
|
||||||
|
function amountLine(data, tokenAddress) {
|
||||||
|
const decoded = decodeCalldata(data, tokenAddress);
|
||||||
|
const detail = decoded.details.find((d) => d.label === "Amount");
|
||||||
|
return detail.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A wallet holding `token` with the decimals the block explorer reported,
|
||||||
|
// shaped as balances.js writes it onto state.
|
||||||
|
function walletsHolding(token, decimals) {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
addresses: [
|
||||||
|
{
|
||||||
|
address: "0x" + "a".repeat(40),
|
||||||
|
balance: "1.0",
|
||||||
|
tokenBalances: [
|
||||||
|
{
|
||||||
|
address: token,
|
||||||
|
symbol: "NOVEL",
|
||||||
|
decimals,
|
||||||
|
balance: "5000.0",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
state.trackedTokens = [];
|
||||||
|
state.wallets = [];
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("resolveTokenDecimals", () => {
|
||||||
|
test("prefers the bundled list", () => {
|
||||||
|
state.trackedTokens = [{ address: USDC, symbol: "USDC", decimals: 2 }];
|
||||||
|
expect(resolveTokenDecimals(USDC, state)).toBe(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("reads a token the user tracks", () => {
|
||||||
|
state.trackedTokens = [
|
||||||
|
{
|
||||||
|
address: NOVEL_TOKEN.toLowerCase(),
|
||||||
|
symbol: "NOVEL",
|
||||||
|
decimals: 6,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBe(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("reads the decimals the explorer reported", () => {
|
||||||
|
// Blockscout's copy arrives as a string.
|
||||||
|
state.wallets = walletsHolding(NOVEL_TOKEN, "6");
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBe(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("falls past a tracked entry whose decimals are unusable", () => {
|
||||||
|
state.trackedTokens = [
|
||||||
|
{ address: NOVEL_TOKEN, symbol: "NOVEL", decimals: NaN },
|
||||||
|
];
|
||||||
|
state.wallets = walletsHolding(NOVEL_TOKEN, 6);
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBe(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("refuses a scale the explorer's own entries disagree about", () => {
|
||||||
|
const wallets = walletsHolding(NOVEL_TOKEN, 6);
|
||||||
|
wallets[0].addresses.push({
|
||||||
|
address: "0x" + "b".repeat(40),
|
||||||
|
balance: "0.0",
|
||||||
|
tokenBalances: [
|
||||||
|
{ address: NOVEL_TOKEN, symbol: "NOVEL", decimals: 18 },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
state.wallets = wallets;
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects values that are not a uint8", () => {
|
||||||
|
for (const decimals of [-1, 256, 1.5, true, [], {}, null, "6.0", ""]) {
|
||||||
|
state.trackedTokens = [{ address: NOVEL_TOKEN, decimals }];
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBeNull();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("is null when nothing knows the token", () => {
|
||||||
|
expect(resolveTokenDecimals(NOVEL_TOKEN, state)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("decodeCalldata amount", () => {
|
||||||
|
test("transfer of a tracked 6-decimal token shows the true quantity", () => {
|
||||||
|
state.trackedTokens = [
|
||||||
|
{ address: NOVEL_TOKEN, symbol: "NOVEL", decimals: 6 },
|
||||||
|
];
|
||||||
|
expect(
|
||||||
|
amountLine(transferData(FIVE_THOUSAND_AT_SIX), NOVEL_TOKEN),
|
||||||
|
).toBe("5000.0000");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("transfer priced off the explorer's decimals shows the true quantity", () => {
|
||||||
|
state.wallets = walletsHolding(NOVEL_TOKEN, "6");
|
||||||
|
expect(
|
||||||
|
amountLine(transferData(FIVE_THOUSAND_AT_SIX), NOVEL_TOKEN),
|
||||||
|
).toBe("5000.0000");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("transfer of an unknown-decimals token shows base units, not a number", () => {
|
||||||
|
const line = amountLine(
|
||||||
|
transferData(FIVE_THOUSAND_AT_SIX),
|
||||||
|
NOVEL_TOKEN,
|
||||||
|
);
|
||||||
|
expect(line).toBe("5000000000 base units (decimals unknown)");
|
||||||
|
expect(line).toBe(unknownDecimalsAmount(FIVE_THOUSAND_AT_SIX));
|
||||||
|
// The defect: any rendering that reads as a token quantity, and above
|
||||||
|
// all one that reads as zero.
|
||||||
|
expect(line).not.toMatch(/0\.0000/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("approve of a tracked 6-decimal token shows the true quantity", () => {
|
||||||
|
state.trackedTokens = [
|
||||||
|
{ address: NOVEL_TOKEN, symbol: "NOVEL", decimals: 6 },
|
||||||
|
];
|
||||||
|
expect(amountLine(approveData(FIVE_THOUSAND_AT_SIX), NOVEL_TOKEN)).toBe(
|
||||||
|
"5000.0000",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("approve of an unknown-decimals token shows base units, not a number", () => {
|
||||||
|
const line = amountLine(approveData(FIVE_THOUSAND_AT_SIX), NOVEL_TOKEN);
|
||||||
|
expect(line).toBe("5000000000 base units (decimals unknown)");
|
||||||
|
expect(line).not.toMatch(/0\.0000/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unbounded allowance is still named, with or without a scale", () => {
|
||||||
|
expect(amountLine(approveData(MAX_UINT256), NOVEL_TOKEN)).toBe(
|
||||||
|
"Unlimited",
|
||||||
|
);
|
||||||
|
expect(amountLine(approveData(MAX_UINT256), USDC)).toBe("Unlimited");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a bundled token keeps its symbol and its scale", () => {
|
||||||
|
expect(amountLine(transferData(FIVE_THOUSAND_AT_SIX), USDC)).toBe(
|
||||||
|
"5000.0000 USDC",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the amount carried to the status screens is the same string", () => {
|
||||||
|
const decoded = decodeCalldata(
|
||||||
|
transferData(FIVE_THOUSAND_AT_SIX),
|
||||||
|
NOVEL_TOKEN,
|
||||||
|
);
|
||||||
|
const detail = decoded.details.find((d) => d.label === "Amount");
|
||||||
|
expect(detail.rawValue).toBe(
|
||||||
|
"5000000000 base units (decimals unknown)",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
232
tests/chainSwitchGate.test.js
Normal file
232
tests/chainSwitchGate.test.js
Normal file
@@ -0,0 +1,232 @@
|
|||||||
|
// Who may move the active chain.
|
||||||
|
//
|
||||||
|
// wallet_switchEthereumChain used to be answered for any origin at all, with
|
||||||
|
// no connection check and no prompt, so a page the user had never connected
|
||||||
|
// to could clear the [TESTNET] banner under someone who believed they were
|
||||||
|
// on Sepolia (https://git.eeqj.de/sneak/AutistMask/issues/308). The refusal
|
||||||
|
// is asserted as a refusal to ACT — the state unmoved and no chainChanged
|
||||||
|
// broadcast — because an error code alone would not distinguish a gate from
|
||||||
|
// a switch that happened and then reported a failure.
|
||||||
|
//
|
||||||
|
// The endpoint half of that issue lives in tests/networkEndpoints.test.js;
|
||||||
|
// this file mocks the state module, which that one exercises for real.
|
||||||
|
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
|
||||||
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
// The site the persisted state has connected, and one it has never heard of.
|
||||||
|
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||||
|
const CONNECTED_HOSTNAME = "dapp.example";
|
||||||
|
const STRANGER_ORIGIN = "https://stranger.example";
|
||||||
|
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
|
||||||
|
// The user's own node, so a switch that happens is visible as the loss of it.
|
||||||
|
const CUSTOM_RPC = "http://127.0.0.1:8545";
|
||||||
|
|
||||||
|
function walletFixture() {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Let the handler's promise chain run to the next suspension point. The gate
|
||||||
|
// reads storage before it answers, so the response is several awaits deep.
|
||||||
|
async function settle() {
|
||||||
|
for (let i = 0; i < 50; i++) await Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// The gate: which origins the background will switch the chain for.
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
// Load the background worker against stubbed browser APIs, with the real
|
||||||
|
// chain-switch module behind it, and return the handles to drive it. The
|
||||||
|
// wallet state is a plain object so that a switch that DID happen is visible
|
||||||
|
// as a mutation of it, and one that did not is visible as its absence.
|
||||||
|
function loadBackground() {
|
||||||
|
jest.resetModules();
|
||||||
|
|
||||||
|
const walletState = {
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: MAINNET.defaultBlockscoutUrl,
|
||||||
|
networkEndpoints: {},
|
||||||
|
wallets: walletFixture(),
|
||||||
|
lastBalanceRefresh: 1,
|
||||||
|
tokenHolderCache: {},
|
||||||
|
fraudContracts: [],
|
||||||
|
};
|
||||||
|
|
||||||
|
jest.doMock("../src/shared/state", () => ({
|
||||||
|
state: walletState,
|
||||||
|
loadState: jest.fn(async () => {}),
|
||||||
|
saveState: jest.fn(async () => {}),
|
||||||
|
currentNetwork: () => networkById(walletState.networkId),
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
|
getProvider: () => ({}),
|
||||||
|
refreshBalances: jest.fn(async () => {}),
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
|
isPhishingDomain: () => false,
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/alarms", () => ({
|
||||||
|
BALANCE_REFRESH_ALARM: "balance",
|
||||||
|
BALANCE_REFRESH_PERIOD_MINUTES: 1,
|
||||||
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
|
registerAlarmHandlers: jest.fn(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const persisted = {
|
||||||
|
wallets: walletFixture(),
|
||||||
|
activeAddress: ADDRESS,
|
||||||
|
allowedSites: { [ADDRESS]: [CONNECTED_HOSTNAME] },
|
||||||
|
deniedSites: {},
|
||||||
|
};
|
||||||
|
|
||||||
|
let messageListener = null;
|
||||||
|
// Every message the background pushed at a content script. chainChanged
|
||||||
|
// is what tells a page the wallet moved, so an ungated switch is visible
|
||||||
|
// here as well as in the state.
|
||||||
|
const toTabs = [];
|
||||||
|
|
||||||
|
global.chrome = {
|
||||||
|
storage: {
|
||||||
|
local: {
|
||||||
|
get: jest.fn(async () => ({ autistmask: persisted })),
|
||||||
|
set: jest.fn(async () => {}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
runtime: {
|
||||||
|
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||||
|
onMessage: {
|
||||||
|
addListener: (fn) => {
|
||||||
|
messageListener = fn;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
onConnect: { addListener: () => {} },
|
||||||
|
lastError: null,
|
||||||
|
},
|
||||||
|
windows: {
|
||||||
|
getLastFocused: (cb) => cb(null),
|
||||||
|
create: (options, cb) => cb({ id: 1 }),
|
||||||
|
remove: (id, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
onRemoved: { addListener: () => {} },
|
||||||
|
},
|
||||||
|
tabs: {
|
||||||
|
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||||
|
sendMessage: (tabId, message, cb) => {
|
||||||
|
toTabs.push(message);
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
action: { setPopup: () => {} },
|
||||||
|
};
|
||||||
|
|
||||||
|
require("../src/background/index");
|
||||||
|
|
||||||
|
async function switchChain(chainId, origin) {
|
||||||
|
let result = null;
|
||||||
|
messageListener(
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_RPC",
|
||||||
|
method: "wallet_switchEthereumChain",
|
||||||
|
params: [{ chainId }],
|
||||||
|
},
|
||||||
|
{ origin },
|
||||||
|
(r) => {
|
||||||
|
result = r;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
await settle();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
switchChain,
|
||||||
|
walletState,
|
||||||
|
chainChangedEvents: () =>
|
||||||
|
toTabs.filter((m) => m.eventName === "chainChanged"),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("wallet_switchEthereumChain is gated on the connection", () => {
|
||||||
|
test("an origin the wallet was never connected to is refused with 4100", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
const result = await bg.switchChain(SEPOLIA.chainId, STRANGER_ORIGIN);
|
||||||
|
|
||||||
|
expect(result.error).toEqual({ code: 4100, message: "Unauthorized" });
|
||||||
|
expect(result.result).toBeUndefined();
|
||||||
|
// The refusal has to be a refusal to ACT, not just an error string:
|
||||||
|
// the wallet is still on mainnet, still on the user's own node, and
|
||||||
|
// no page was told the chain moved.
|
||||||
|
expect(bg.walletState.networkId).toBe("mainnet");
|
||||||
|
expect(bg.walletState.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(bg.chainChangedEvents()).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unconnected origin is refused even for the chain already active", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
const result = await bg.switchChain(MAINNET.chainId, STRANGER_ORIGIN);
|
||||||
|
|
||||||
|
expect(result.error).toEqual({ code: 4100, message: "Unauthorized" });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unconnected origin is refused before the unsupported-chain answer", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
const result = await bg.switchChain("0x89", STRANGER_ORIGIN);
|
||||||
|
|
||||||
|
expect(result.error.code).toBe(4100);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a connected origin switches the chain", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
const result = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||||
|
|
||||||
|
expect(result).toEqual({ result: null });
|
||||||
|
expect(bg.walletState.networkId).toBe("sepolia");
|
||||||
|
expect(bg.chainChangedEvents()).toEqual([
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_EVENT",
|
||||||
|
eventName: "chainChanged",
|
||||||
|
data: SEPOLIA.chainId,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a connected origin asking for an unsupported chain still gets 4902", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
const result = await bg.switchChain("0x89", CONNECTED_ORIGIN);
|
||||||
|
|
||||||
|
expect(result.error.code).toBe(4902);
|
||||||
|
expect(bg.walletState.networkId).toBe("mainnet");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a switch by a connected origin keeps the user's endpoint", async () => {
|
||||||
|
const bg = loadBackground();
|
||||||
|
|
||||||
|
await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||||
|
expect(bg.walletState.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
|
||||||
|
await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
||||||
|
expect(bg.walletState.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
});
|
||||||
|
});
|
||||||
258
tests/coldWorkerChainId.test.js
Normal file
258
tests/coldWorkerChainId.test.js
Normal file
@@ -0,0 +1,258 @@
|
|||||||
|
// What eth_chainId and net_version answer on a worker that has not loaded
|
||||||
|
// state yet.
|
||||||
|
//
|
||||||
|
// The MV3 service worker is terminated when idle and revived by the next
|
||||||
|
// message, and nothing loads state at module scope. Both methods answered from
|
||||||
|
// currentNetwork(), which reads the module-level `state` singleton, so a
|
||||||
|
// worker revived by the page's own message answered out of DEFAULT_STATE and
|
||||||
|
// told a page it was on mainnet while the user was on Sepolia
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/317).
|
||||||
|
//
|
||||||
|
// This file therefore uses the REAL state module and never calls loadState()
|
||||||
|
// itself: the handler has to answer from storage on its own. Same shape as
|
||||||
|
// tests/coldWorkerChainSwitch.test.js, which covers the write side.
|
||||||
|
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
|
||||||
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||||
|
const CONNECTED_HOSTNAME = "dapp.example";
|
||||||
|
const UNKNOWN_ORIGIN = "https://stranger.example";
|
||||||
|
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
|
||||||
|
const REFRESHED_BALANCE = "1.5";
|
||||||
|
|
||||||
|
function storedProfile(networkId) {
|
||||||
|
return {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [
|
||||||
|
{ address: ADDRESS, balance: "0", tokenBalances: [] },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
activeAddress: ADDRESS,
|
||||||
|
networkId,
|
||||||
|
rpcUrl: networkById(networkId).defaultRpcUrl,
|
||||||
|
blockscoutUrl: networkById(networkId).defaultBlockscoutUrl,
|
||||||
|
allowedSites: { [ADDRESS]: [CONNECTED_HOSTNAME] },
|
||||||
|
deniedSites: {},
|
||||||
|
trackedTokens: [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function settle() {
|
||||||
|
for (let i = 0; i < 50; i++) await Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
// Load the background worker with the real state module behind it, over a
|
||||||
|
// storage stub that keeps what is written.
|
||||||
|
//
|
||||||
|
// The stub structured-clones in both directions, as the real
|
||||||
|
// chrome.storage.local does. A stub that handed back the live stored object
|
||||||
|
// would alias it into whatever read it, so an in-place mutation of a detached
|
||||||
|
// copy would appear to have reached storage and this whole class of defect
|
||||||
|
// would be invisible here.
|
||||||
|
//
|
||||||
|
// opts.refreshBalances replaces the balances stub, so a test can hold a
|
||||||
|
// refresh open across a message.
|
||||||
|
function loadColdWorker(networkId, opts) {
|
||||||
|
jest.resetModules();
|
||||||
|
|
||||||
|
const options = opts || {};
|
||||||
|
|
||||||
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
|
getProvider: () => ({}),
|
||||||
|
refreshBalances: options.refreshBalances || jest.fn(async () => {}),
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
|
isPhishingDomain: () => false,
|
||||||
|
}));
|
||||||
|
|
||||||
|
let alarmHandlers = {};
|
||||||
|
jest.doMock("../src/shared/alarms", () => ({
|
||||||
|
BALANCE_REFRESH_ALARM: "balance",
|
||||||
|
BALANCE_REFRESH_PERIOD_MINUTES: 1,
|
||||||
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
|
registerAlarmHandlers: jest.fn((handlers) => {
|
||||||
|
alarmHandlers = handlers;
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const store = { autistmask: storedProfile(networkId) };
|
||||||
|
|
||||||
|
let messageListener = null;
|
||||||
|
const set = jest.fn(async (items) => {
|
||||||
|
store.autistmask = structuredClone(items.autistmask);
|
||||||
|
});
|
||||||
|
|
||||||
|
global.chrome = {
|
||||||
|
storage: {
|
||||||
|
local: {
|
||||||
|
get: jest.fn(async () => structuredClone(store)),
|
||||||
|
set,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
runtime: {
|
||||||
|
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||||
|
onMessage: {
|
||||||
|
addListener: (fn) => {
|
||||||
|
messageListener = fn;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
onConnect: { addListener: () => {} },
|
||||||
|
lastError: null,
|
||||||
|
},
|
||||||
|
windows: {
|
||||||
|
getLastFocused: (cb) => cb(null),
|
||||||
|
create: (options, cb) => cb({ id: 1 }),
|
||||||
|
remove: (id, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
onRemoved: { addListener: () => {} },
|
||||||
|
},
|
||||||
|
tabs: {
|
||||||
|
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||||
|
sendMessage: (tabId, message, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
action: { setPopup: () => {} },
|
||||||
|
};
|
||||||
|
|
||||||
|
require("../src/background/index");
|
||||||
|
|
||||||
|
async function rpc(method, origin) {
|
||||||
|
let result = null;
|
||||||
|
messageListener(
|
||||||
|
{ type: "AUTISTMASK_RPC", method, params: [] },
|
||||||
|
{ origin: origin || CONNECTED_ORIGIN },
|
||||||
|
(r) => {
|
||||||
|
result = r;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
await settle();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
rpc,
|
||||||
|
persisted: () => store.autistmask,
|
||||||
|
storageSet: set,
|
||||||
|
fireBalanceAlarm: () => alarmHandlers.balance(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("chain identity read by a worker that never loaded state", () => {
|
||||||
|
test("eth_chainId answers the stored chain, not the default", async () => {
|
||||||
|
// The first message this worker ever sees. Reading the unloaded
|
||||||
|
// singleton answers mainnet's 0x1 to a user who is on Sepolia.
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
expect(await bg.rpc("eth_chainId")).toEqual({
|
||||||
|
result: SEPOLIA.chainId,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("net_version answers the stored chain, not the default", async () => {
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
expect(await bg.rpc("net_version")).toEqual({
|
||||||
|
result: SEPOLIA.networkVersion,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("answers the stored chain to an origin that never connected", async () => {
|
||||||
|
// Neither method is gated on a connection, so the stale answer reached
|
||||||
|
// any page at all; the fixed answer has to as well.
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
expect(await bg.rpc("eth_chainId", UNKNOWN_ORIGIN)).toEqual({
|
||||||
|
result: SEPOLIA.chainId,
|
||||||
|
});
|
||||||
|
expect(await bg.rpc("net_version", UNKNOWN_ORIGIN)).toEqual({
|
||||||
|
result: SEPOLIA.networkVersion,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("answers mainnet for a profile stored on mainnet", async () => {
|
||||||
|
// The default and the stored value agree here, so this case cannot
|
||||||
|
// catch the defect; it is what keeps the fix from being a swap.
|
||||||
|
const bg = loadColdWorker("mainnet");
|
||||||
|
|
||||||
|
expect(await bg.rpc("eth_chainId")).toEqual({
|
||||||
|
result: MAINNET.chainId,
|
||||||
|
});
|
||||||
|
expect(await bg.rpc("net_version")).toEqual({
|
||||||
|
result: MAINNET.networkVersion,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("persists nothing: these are reads", async () => {
|
||||||
|
// The load must not turn a read into a write. saveState() persists
|
||||||
|
// every field of the singleton, and a read path that reached it would
|
||||||
|
// be the wipe https://git.eeqj.de/sneak/AutistMask/issues/316 fixed.
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
await bg.rpc("eth_chainId");
|
||||||
|
await bg.rpc("net_version");
|
||||||
|
|
||||||
|
expect(bg.storageSet).not.toHaveBeenCalled();
|
||||||
|
expect(bg.persisted()).toEqual(storedProfile("sepolia"));
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a chain read arriving mid-refresh does not discard the refresh", async () => {
|
||||||
|
// Any page reaches these two methods, and the injected provider sends
|
||||||
|
// eth_chainId on every page load, so this overlap is ordinary traffic
|
||||||
|
// rather than a contrived race.
|
||||||
|
//
|
||||||
|
// backgroundRefresh() hands the singleton's wallets to
|
||||||
|
// refreshBalances(), which mutates those address objects in place once
|
||||||
|
// the network round trip resolves, and only then saves. Answering the
|
||||||
|
// page by calling loadState() would replace state.wallets mid-flight,
|
||||||
|
// so the refreshed balances would land on detached objects and the
|
||||||
|
// save that follows would persist the pre-refresh values — while still
|
||||||
|
// stamping lastBalanceRefresh, suppressing the redo.
|
||||||
|
let releaseRoundTrip;
|
||||||
|
const roundTrip = new Promise((resolve) => {
|
||||||
|
releaseRoundTrip = resolve;
|
||||||
|
});
|
||||||
|
let refreshReachedNetwork;
|
||||||
|
const inFlight = new Promise((resolve) => {
|
||||||
|
refreshReachedNetwork = resolve;
|
||||||
|
});
|
||||||
|
|
||||||
|
const bg = loadColdWorker("sepolia", {
|
||||||
|
refreshBalances: async (wallets) => {
|
||||||
|
refreshReachedNetwork();
|
||||||
|
await roundTrip;
|
||||||
|
// In place, on the objects handed in — as balances.js does.
|
||||||
|
wallets[0].addresses[0].balance = REFRESHED_BALANCE;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const refresh = bg.fireBalanceAlarm();
|
||||||
|
await inFlight;
|
||||||
|
|
||||||
|
expect(await bg.rpc("eth_chainId", UNKNOWN_ORIGIN)).toEqual({
|
||||||
|
result: SEPOLIA.chainId,
|
||||||
|
});
|
||||||
|
|
||||||
|
releaseRoundTrip();
|
||||||
|
await refresh;
|
||||||
|
|
||||||
|
expect(bg.persisted().wallets[0].addresses[0].balance).toBe(
|
||||||
|
REFRESHED_BALANCE,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
212
tests/coldWorkerChainSwitch.test.js
Normal file
212
tests/coldWorkerChainSwitch.test.js
Normal file
@@ -0,0 +1,212 @@
|
|||||||
|
// What a chain switch does to a worker that has not loaded state yet.
|
||||||
|
//
|
||||||
|
// The MV3 service worker is terminated when idle and revived by the next
|
||||||
|
// message, and nothing loads state at module scope. The chain-switch handler
|
||||||
|
// reaches onChainSwitch(), which mutates the module-level `state` singleton
|
||||||
|
// and then persists EVERY field of it, so a handler that runs before a load
|
||||||
|
// writes DEFAULT_STATE over the user's stored profile — every wallet, every
|
||||||
|
// site approval, every tracked token and the custom endpoint
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/316). The same singleton is
|
||||||
|
// what currentNetwork() answers from, so the same-chain early return also
|
||||||
|
// compares against the wrong network.
|
||||||
|
//
|
||||||
|
// This file therefore uses the REAL state module and never calls loadState()
|
||||||
|
// itself: the handler has to do it. tests/chainSwitchGate.test.js mocks the
|
||||||
|
// state module wholesale and tests/networkEndpoints.test.js always loads
|
||||||
|
// first, so neither can see this.
|
||||||
|
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
|
||||||
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||||
|
const CONNECTED_HOSTNAME = "dapp.example";
|
||||||
|
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
|
||||||
|
// The user's own node, and a wallet whose loss is the whole point.
|
||||||
|
const CUSTOM_RPC = "http://127.0.0.1:8545";
|
||||||
|
const CUSTOM_BLOCKSCOUT = "http://127.0.0.1:4000/api/v2";
|
||||||
|
const TOKEN = "0x6B175474E89094C44Da98b954EedeAC495271d0F";
|
||||||
|
|
||||||
|
function walletFixture() {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// A profile as an installed extension holds it, on `networkId`.
|
||||||
|
function storedProfile(networkId) {
|
||||||
|
return {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: walletFixture(),
|
||||||
|
activeAddress: ADDRESS,
|
||||||
|
networkId,
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
allowedSites: { [ADDRESS]: [CONNECTED_HOSTNAME] },
|
||||||
|
deniedSites: {},
|
||||||
|
trackedTokens: [{ address: TOKEN, symbol: "DAI", decimals: 18 }],
|
||||||
|
theme: "dark",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function settle() {
|
||||||
|
for (let i = 0; i < 50; i++) await Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
// Load the background worker with the real state and chain-switch modules
|
||||||
|
// behind it, over a storage stub that actually keeps what is written — a
|
||||||
|
// wipe is only observable against storage that remembers.
|
||||||
|
function loadColdWorker(networkId) {
|
||||||
|
jest.resetModules();
|
||||||
|
|
||||||
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
|
getProvider: () => ({}),
|
||||||
|
refreshBalances: jest.fn(async () => {}),
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
|
isPhishingDomain: () => false,
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/alarms", () => ({
|
||||||
|
BALANCE_REFRESH_ALARM: "balance",
|
||||||
|
BALANCE_REFRESH_PERIOD_MINUTES: 1,
|
||||||
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
|
registerAlarmHandlers: jest.fn(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const store = { autistmask: storedProfile(networkId) };
|
||||||
|
|
||||||
|
let messageListener = null;
|
||||||
|
const toTabs = [];
|
||||||
|
|
||||||
|
global.chrome = {
|
||||||
|
storage: {
|
||||||
|
local: {
|
||||||
|
get: jest.fn(async () => ({ autistmask: store.autistmask })),
|
||||||
|
set: jest.fn(async (items) => {
|
||||||
|
store.autistmask = items.autistmask;
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
runtime: {
|
||||||
|
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||||
|
onMessage: {
|
||||||
|
addListener: (fn) => {
|
||||||
|
messageListener = fn;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
onConnect: { addListener: () => {} },
|
||||||
|
lastError: null,
|
||||||
|
},
|
||||||
|
windows: {
|
||||||
|
getLastFocused: (cb) => cb(null),
|
||||||
|
create: (options, cb) => cb({ id: 1 }),
|
||||||
|
remove: (id, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
onRemoved: { addListener: () => {} },
|
||||||
|
},
|
||||||
|
tabs: {
|
||||||
|
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||||
|
sendMessage: (tabId, message, cb) => {
|
||||||
|
toTabs.push(message);
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
action: { setPopup: () => {} },
|
||||||
|
};
|
||||||
|
|
||||||
|
require("../src/background/index");
|
||||||
|
|
||||||
|
async function switchChain(chainId) {
|
||||||
|
let result = null;
|
||||||
|
messageListener(
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_RPC",
|
||||||
|
method: "wallet_switchEthereumChain",
|
||||||
|
params: [{ chainId }],
|
||||||
|
},
|
||||||
|
{ origin: CONNECTED_ORIGIN },
|
||||||
|
(r) => {
|
||||||
|
result = r;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
await settle();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
switchChain,
|
||||||
|
persisted: () => store.autistmask,
|
||||||
|
chainChangedEvents: () =>
|
||||||
|
toTabs.filter((m) => m.eventName === "chainChanged"),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("a chain switch on a worker that never loaded state", () => {
|
||||||
|
test("keeps the wallets, approvals, tokens and custom endpoint", async () => {
|
||||||
|
const bg = loadColdWorker("mainnet");
|
||||||
|
|
||||||
|
const result = await bg.switchChain(SEPOLIA.chainId);
|
||||||
|
expect(result).toEqual({ result: null });
|
||||||
|
|
||||||
|
const after = bg.persisted();
|
||||||
|
// The switch itself happened.
|
||||||
|
expect(after.networkId).toBe("sepolia");
|
||||||
|
expect(after.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
|
||||||
|
// And it took nothing else with it. Without the load these come back
|
||||||
|
// as [], {}, [] and "system" from DEFAULT_STATE — every wallet in the
|
||||||
|
// extension gone, encrypted secrets included.
|
||||||
|
expect(after.wallets).toEqual(walletFixture());
|
||||||
|
expect(after.hasWallet).toBe(true);
|
||||||
|
expect(after.activeAddress).toBe(ADDRESS);
|
||||||
|
expect(after.allowedSites).toEqual({ [ADDRESS]: [CONNECTED_HOSTNAME] });
|
||||||
|
expect(after.trackedTokens).toEqual([
|
||||||
|
{ address: TOKEN, symbol: "DAI", decimals: 18 },
|
||||||
|
]);
|
||||||
|
expect(after.theme).toBe("dark");
|
||||||
|
|
||||||
|
// The user's mainnet endpoint is remembered rather than replaced by
|
||||||
|
// the public default, so switching back returns it.
|
||||||
|
expect(after.networkEndpoints.mainnet).toEqual({
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
});
|
||||||
|
|
||||||
|
await bg.switchChain(MAINNET.chainId);
|
||||||
|
expect(bg.persisted().rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(bg.persisted().blockscoutUrl).toBe(CUSTOM_BLOCKSCOUT);
|
||||||
|
expect(bg.persisted().wallets).toEqual(walletFixture());
|
||||||
|
});
|
||||||
|
|
||||||
|
test("compares the requested chain against the stored one, not the default", async () => {
|
||||||
|
// Stored on Sepolia, asked for mainnet. Reading the unloaded
|
||||||
|
// singleton makes this look like the chain already active, so the
|
||||||
|
// page is told the switch succeeded while the wallet stays on the
|
||||||
|
// testnet it was on.
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
const result = await bg.switchChain(MAINNET.chainId);
|
||||||
|
expect(result).toEqual({ result: null });
|
||||||
|
|
||||||
|
expect(bg.persisted().networkId).toBe("mainnet");
|
||||||
|
expect(bg.chainChangedEvents()).toEqual([
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_EVENT",
|
||||||
|
eventName: "chainChanged",
|
||||||
|
data: MAINNET.chainId,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1193,8 +1193,9 @@ test("the theme and network selectors carry a non-default persisted value (#229)
|
|||||||
// and a selector stuck on `dark`/`sepolia` would otherwise be
|
// and a selector stuck on `dark`/`sepolia` would otherwise be
|
||||||
// indistinguishable here from one that persists correctly. Switching
|
// indistinguishable here from one that persists correctly. Switching
|
||||||
// the network back also returns state.rpcUrl and state.blockscoutUrl
|
// the network back also returns state.rpcUrl and state.blockscoutUrl
|
||||||
// to the mainnet defaults that onChainSwitch() overwrote, which are
|
// to the mainnet endpoints onChainSwitch() remembered, which this
|
||||||
// the values src/shared/state.js starts with.
|
// fixture never customised and so are the mainnet defaults
|
||||||
|
// src/shared/state.js starts with.
|
||||||
await env.page.selectOption("#settings-theme", "system");
|
await env.page.selectOption("#settings-theme", "system");
|
||||||
await env.page.selectOption("#settings-network", "mainnet");
|
await env.page.selectOption("#settings-network", "mainnet");
|
||||||
|
|
||||||
|
|||||||
192
tests/networkEndpoints.test.js
Normal file
192
tests/networkEndpoints.test.js
Normal file
@@ -0,0 +1,192 @@
|
|||||||
|
// What a chain switch is allowed to do to the endpoints the user configured.
|
||||||
|
//
|
||||||
|
// A switch used to overwrite state.rpcUrl and state.blockscoutUrl with the
|
||||||
|
// network defaults, so a user pointing the wallet at their own node lost that
|
||||||
|
// url the first time anything switched chains — with no notification and no
|
||||||
|
// way to recover it, having been moved onto a public endpoint that then sees
|
||||||
|
// every address they hold (https://git.eeqj.de/sneak/AutistMask/issues/308).
|
||||||
|
// Endpoints are now remembered per network, which is why the round trips
|
||||||
|
// below assert the ORIGINAL url comes back rather than only that the switch
|
||||||
|
// happened.
|
||||||
|
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
|
||||||
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
|
||||||
|
// The user's own node: the pair the switch used to throw away.
|
||||||
|
const CUSTOM_RPC = "http://127.0.0.1:8545";
|
||||||
|
const CUSTOM_BLOCKSCOUT = "http://127.0.0.1:4000/api/v2";
|
||||||
|
|
||||||
|
function walletFixture() {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// The real state module against stubbed storage, plus whatever the last
|
||||||
|
// saveState() wrote — so a case can reload a fresh module from the bytes an
|
||||||
|
// earlier one persisted, which is what an extension restart does. `state` is
|
||||||
|
// a module-level singleton, so the registry has to be reset per load.
|
||||||
|
function loadModuleWith(persisted) {
|
||||||
|
jest.resetModules();
|
||||||
|
let written = null;
|
||||||
|
global.chrome = {
|
||||||
|
storage: {
|
||||||
|
local: {
|
||||||
|
get: jest.fn(async () =>
|
||||||
|
persisted ? { autistmask: persisted } : {},
|
||||||
|
),
|
||||||
|
set: jest.fn(async (items) => {
|
||||||
|
written = items.autistmask;
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return {
|
||||||
|
mod: require("../src/shared/state"),
|
||||||
|
chainSwitch: require("../src/shared/chainSwitch"),
|
||||||
|
written: () => written,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a custom endpoint survives a chain switch", () => {
|
||||||
|
test("switching away and back restores the user's rpc and blockscout urls", async () => {
|
||||||
|
const { mod, chainSwitch } = loadModuleWith({
|
||||||
|
wallets: walletFixture(),
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
networkEndpoints: {
|
||||||
|
mainnet: {
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await mod.loadState();
|
||||||
|
|
||||||
|
await chainSwitch.onChainSwitch("sepolia");
|
||||||
|
// The new chain gets its own endpoints, not the ones belonging to the
|
||||||
|
// chain just left: a mainnet node cannot answer for Sepolia.
|
||||||
|
expect(mod.state.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
expect(mod.state.blockscoutUrl).toBe(SEPOLIA.defaultBlockscoutUrl);
|
||||||
|
|
||||||
|
await chainSwitch.onChainSwitch("mainnet");
|
||||||
|
expect(mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(mod.state.blockscoutUrl).toBe(CUSTOM_BLOCKSCOUT);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an endpoint set on the network being left is remembered, not lost", async () => {
|
||||||
|
const { mod, chainSwitch } = loadModuleWith({
|
||||||
|
wallets: walletFixture(),
|
||||||
|
networkId: "sepolia",
|
||||||
|
rpcUrl: SEPOLIA.defaultRpcUrl,
|
||||||
|
blockscoutUrl: SEPOLIA.defaultBlockscoutUrl,
|
||||||
|
networkEndpoints: {},
|
||||||
|
});
|
||||||
|
await mod.loadState();
|
||||||
|
|
||||||
|
// What the Settings screen does: write the live field, then save. The
|
||||||
|
// map entry for the active network is stale until the switch, which
|
||||||
|
// is what snapshotting the outgoing network exists to reconcile.
|
||||||
|
mod.state.rpcUrl = CUSTOM_RPC;
|
||||||
|
await mod.saveState();
|
||||||
|
|
||||||
|
await chainSwitch.onChainSwitch("mainnet");
|
||||||
|
expect(mod.state.rpcUrl).toBe(MAINNET.defaultRpcUrl);
|
||||||
|
|
||||||
|
await chainSwitch.onChainSwitch("sepolia");
|
||||||
|
expect(mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the remembered endpoints survive an extension restart", async () => {
|
||||||
|
const first = loadModuleWith({
|
||||||
|
wallets: walletFixture(),
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
});
|
||||||
|
await first.mod.loadState();
|
||||||
|
await first.chainSwitch.onChainSwitch("sepolia");
|
||||||
|
|
||||||
|
// Reload from exactly the bytes the switch persisted.
|
||||||
|
const second = loadModuleWith(first.written());
|
||||||
|
await second.mod.loadState();
|
||||||
|
expect(second.mod.state.networkId).toBe("sepolia");
|
||||||
|
expect(second.mod.state.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
|
||||||
|
await second.chainSwitch.onChainSwitch("mainnet");
|
||||||
|
expect(second.mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(second.mod.state.blockscoutUrl).toBe(CUSTOM_BLOCKSCOUT);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a profile written before networkEndpoints existed keeps its endpoint", async () => {
|
||||||
|
// Exactly the stored shape the current release writes: one pair of
|
||||||
|
// urls and no map. It is adopted as the remembered pair of the
|
||||||
|
// network it was stored under.
|
||||||
|
const { mod, chainSwitch } = loadModuleWith({
|
||||||
|
wallets: walletFixture(),
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
});
|
||||||
|
await mod.loadState();
|
||||||
|
|
||||||
|
expect(mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(mod.state.networkEndpoints).toEqual({
|
||||||
|
mainnet: { rpcUrl: CUSTOM_RPC, blockscoutUrl: CUSTOM_BLOCKSCOUT },
|
||||||
|
});
|
||||||
|
|
||||||
|
await chainSwitch.onChainSwitch("sepolia");
|
||||||
|
await chainSwitch.onChainSwitch("mainnet");
|
||||||
|
expect(mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(mod.state.blockscoutUrl).toBe(CUSTOM_BLOCKSCOUT);
|
||||||
|
});
|
||||||
|
|
||||||
|
// A primitive is the dangerous case, not the array: assigning a property
|
||||||
|
// to a string throws nothing and stores nothing, so a stored string would
|
||||||
|
// be carried through loadState() and re-persisted by every save, and each
|
||||||
|
// switch would fall back to the public default in place of the user's
|
||||||
|
// endpoint, permanently.
|
||||||
|
test.each([
|
||||||
|
["an array", ["not", "a", "map"]],
|
||||||
|
["a string", "junk"],
|
||||||
|
["a number", 7],
|
||||||
|
])("a stored networkEndpoints that is %s is discarded", async (_, bad) => {
|
||||||
|
const { mod, chainSwitch } = loadModuleWith({
|
||||||
|
wallets: walletFixture(),
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
networkEndpoints: bad,
|
||||||
|
});
|
||||||
|
await mod.loadState();
|
||||||
|
|
||||||
|
// Discarded, then seeded from the live endpoints the same way an old
|
||||||
|
// profile is — never left as something onChainSwitch() would index.
|
||||||
|
expect(mod.state.networkEndpoints).toEqual({
|
||||||
|
mainnet: {
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: CUSTOM_BLOCKSCOUT,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// And the endpoint really survives the round trip, which is the point
|
||||||
|
// of discarding it rather than only of the shape being right.
|
||||||
|
await chainSwitch.onChainSwitch("sepolia");
|
||||||
|
await chainSwitch.onChainSwitch("mainnet");
|
||||||
|
expect(mod.state.rpcUrl).toBe(CUSTOM_RPC);
|
||||||
|
expect(mod.state.blockscoutUrl).toBe(CUSTOM_BLOCKSCOUT);
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user