Compare commits
34
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e9f5286ca7 | ||
|
|
f4551dcb67 | ||
|
|
575f1658ae | ||
|
|
c40c7432a5 | ||
|
|
8e20a4e21c | ||
|
|
f283a5bb91 | ||
|
|
cb27281b21 | ||
|
|
00d1fecc36 | ||
|
|
dfc3a35fe3 | ||
|
|
2442441830 | ||
|
|
f1a13a50a6 | ||
|
|
b4059af827 | ||
|
|
8c08b3d467 | ||
|
|
fd5921f62e | ||
|
|
83f3549d37 | ||
|
|
eb012b9eb3 | ||
|
|
adff1e0b9d | ||
|
|
8e52528f8b | ||
|
|
b8b13ef5cd | ||
|
|
ff05bd50f7 | ||
|
|
ca18beb97f | ||
|
|
bb60b399ec | ||
|
|
447d714313 | ||
|
|
29ba54d5b6 | ||
|
|
e3dd0e44da | ||
|
|
860db6034c | ||
|
|
cd8e45ae0c | ||
|
|
eeb10c20ef | ||
|
|
0aaa94471f | ||
|
|
763b50b0e5 | ||
|
|
4dafd88fad | ||
|
|
1cfd69e72d | ||
|
|
e14f6e9eb5 | ||
|
|
e865099c5b |
@@ -35,10 +35,10 @@ on: [push]
|
||||
jobs:
|
||||
e2e-chrome:
|
||||
runs-on: ubuntu-latest
|
||||
# Bounds the image build, a cold cache included, and both Chrome
|
||||
# Bounds the image build, a cold cache included, and the three Chrome
|
||||
# programs, so a hung browser frees the shared runner. README.md
|
||||
# "In CI" has the measured times.
|
||||
timeout-minutes: 20
|
||||
timeout-minutes: 40
|
||||
steps:
|
||||
# actions/checkout v4.2.2, 2026-02-22
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.PHONY: bootstrap setup install test test-e2e test-e2e-firefox lint fmt fmt-check check check-censored docker hooks build build-debug package vendor-blocklist clean dev
|
||||
.PHONY: bootstrap setup install test test-e2e test-e2e-firefox lint fmt fmt-check check check-censored docker hooks build build-debug package vendor-blocklist icons enrich-tokens apply-enrichment clean dev
|
||||
|
||||
# Standard targets are thin shims; the implementations live in script/
|
||||
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
||||
@@ -104,6 +104,27 @@ build-debug:
|
||||
vendor-blocklist:
|
||||
@script/vendor-blocklist
|
||||
|
||||
# Redraw the toolbar icons in icons/ from script/lib/icons.js, at every size
|
||||
# manifest/chrome.json declares, leaving alone a file that already holds the
|
||||
# drawn image. Commit the result with the drawing: tests/icons.test.js fails
|
||||
# while the two disagree.
|
||||
icons:
|
||||
@node script/lib/icons.js
|
||||
|
||||
# Fetch a name and a website for every token in src/shared/tokenList.js into
|
||||
# script/lib/token-enrichment.json. Run deliberately, land the diff: the names
|
||||
# come from live data, so a later run can return different ones.
|
||||
enrich-tokens:
|
||||
@node script/lib/enrich-tokens.js
|
||||
|
||||
# Write the names and websites in script/lib/token-enrichment.json into
|
||||
# src/shared/tokenList.js. Commit the result with the data file:
|
||||
# tests/applyEnrichment.test.js fails while the list differs from what this
|
||||
# writes, or while an address in the data or in the script's table of websites
|
||||
# matches no entry in the list.
|
||||
apply-enrichment:
|
||||
@node script/lib/apply-enrichment.js
|
||||
|
||||
clean:
|
||||
@rm -rf dist/ release/
|
||||
|
||||
|
||||
@@ -218,7 +218,9 @@ development workflow, and the Makefile targets are thin shims that call them. We
|
||||
provide:
|
||||
|
||||
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
||||
yarn via corepack, `yarn install --frozen-lockfile`)
|
||||
yarn via corepack, `yarn install --frozen-lockfile`), then fail, naming the
|
||||
package, if node cannot find a package listed in `dependencies` or
|
||||
`devDependencies` of `package.json`
|
||||
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
||||
git pre-commit hook
|
||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
||||
@@ -237,18 +239,24 @@ provide:
|
||||
`make check` stays non-mutating. Linting runs only in the container, because
|
||||
an ESLint result that depends on whichever ESLint the host happens to have is
|
||||
not a result, so docker is required to lint.
|
||||
- `script/fmt` — format all files (writes), on the host
|
||||
- `script/fmt-check` — check formatting (read-only), on the host
|
||||
- `script/fmt` — format all files (writes), on the host, with the `prettier`
|
||||
that `script/bootstrap` installs in `node_modules/`; when that one is missing
|
||||
it fails and says to run `script/bootstrap`, instead of using a `prettier`
|
||||
from the `PATH`
|
||||
- `script/fmt-check` — check formatting (read-only), on the host, with the same
|
||||
`prettier` and the same refusal
|
||||
- `script/check` — run `script/test`, `script/lint` and `script/fmt-check`
|
||||
- `script/check-censored` — assert the competitor name RULES.md bars appears
|
||||
nowhere in the working tree or under `dist/` outside its documented
|
||||
exceptions: the pinned source reference in `script/vendor-blocklist`, the two
|
||||
provider-shim identifiers in `src/content/inpage.js`, and one ERC-20's
|
||||
on-chain name in `src/shared/tokenList.js`. Each is scoped to that path and
|
||||
fails anywhere else. Run by the `lint` phase, so part of `make check`; it
|
||||
inspects `dist/` when there is one and says loudly when there is not, and the
|
||||
build context of that phase never has one. `make build` re-runs it with
|
||||
`--require-dist`, so a build artifact is always covered
|
||||
on-chain name in `src/shared/tokenList.js` and in
|
||||
`script/lib/token-enrichment.json`, the fetched data that file's names are
|
||||
written from. Each is scoped to the paths named and fails anywhere else. Run
|
||||
by the `lint` phase, so part of `make check`; it inspects `dist/` when there
|
||||
is one and says loudly when there is not, and the build context of that phase
|
||||
never has one. `make build` re-runs it with `--require-dist`, so a build
|
||||
artifact is always covered
|
||||
- `script/package` — produce the release artifacts: `make build` first, so the
|
||||
archives can only ever be made from a `dist/` that has been verified against
|
||||
that build's own receipt as a RELEASE build, then one self-contained,
|
||||
@@ -275,7 +283,7 @@ provide:
|
||||
step's exit status, saying on stderr that it did and why. Every step of
|
||||
`make build` runs through it; `make build-debug` runs none of them through it.
|
||||
A step that succeeds removes nothing, and a removal that cannot be completed
|
||||
is reported as loudly as one that was
|
||||
is reported as loudly as one that was.
|
||||
- `script/test-verify-build` — exercise every failure mode of
|
||||
`script/verify-build` against a fixture tree in a temp dir, asserting the exit
|
||||
status and the message of each, assert the state of `dist/` on disk after a
|
||||
@@ -315,6 +323,24 @@ The Makefile shims to those. It also carries a few targets that have no
|
||||
- `make build-debug` — the same build with `AUTISTMASK_DEBUG=1`, verified as a
|
||||
debug build, and keeping its `dist/` on failure (see
|
||||
[Debug Builds](#debug-builds))
|
||||
- `make icons` — redraw the toolbar icons in `icons/` from
|
||||
`script/lib/icons.js`, at every size `manifest/chrome.json` declares. A file
|
||||
that already holds the drawn image, the same IHDR and every pixel, is left
|
||||
untouched. Commit the files with the drawing: `make check` fails while their
|
||||
image differs from what it draws
|
||||
- `make enrich-tokens` — fetch the name of each token in
|
||||
`src/shared/tokenList.js` from CoinGecko's coin list and its website from the
|
||||
`ethereum-lists/tokens` repository, at a pinned commit, into
|
||||
`script/lib/token-enrichment.json`, by running `script/lib/enrich-tokens.js`.
|
||||
CoinGecko's list is live and has no fixed version, so a later run can return
|
||||
different names
|
||||
- `make apply-enrichment` — write the names and URLs in
|
||||
`script/lib/token-enrichment.json` into `src/shared/tokenList.js`, by running
|
||||
`script/lib/apply-enrichment.js`, taking a URL from the table of project
|
||||
websites in that script only where the fetched data has none. Commit the list
|
||||
with the data file: `make check` fails while the list differs from what this
|
||||
writes. Neither target changes which tokens are on the list, and no build runs
|
||||
either
|
||||
- `make clean` — remove `dist/` and `release/`
|
||||
- `make dev` — run the build `make build` runs, without the checks that follow
|
||||
it, then run it again after every change to a file under `src/`, `manifest/`
|
||||
@@ -332,7 +358,9 @@ There are two suites, one per browser, and they share no code. Chrome runs on
|
||||
Playwright; Firefox has its own WebDriver client, because Playwright cannot
|
||||
observe errors on a Firefox extension page at all — see
|
||||
[Firefox](#firefox-make-test-e2e-firefox) below. Both require docker, and both
|
||||
are outside `make check`.
|
||||
are outside `make check`. Neither opens the popup from the toolbar button: both
|
||||
load its page in an ordinary tab, so what the toolbar popup itself adds, its
|
||||
size and its closing when it loses focus, is covered by neither.
|
||||
|
||||
### Chrome (`make test-e2e`)
|
||||
|
||||
@@ -405,27 +433,52 @@ content script, the inpage provider, the background worker and the approval
|
||||
popup all have to work together. A local test page is served by the route
|
||||
handler on a reserved-TLD origin, gets `window.ethereum` from the shipped
|
||||
`MAIN`-world content script like any other page, and drives
|
||||
`eth_requestAccounts`, `personal_sign`, `eth_signTypedData_v4` and
|
||||
`eth_sendTransaction` through the real prompts. Every signature is recovered in
|
||||
the runner and compared against the active address, the transaction assertions
|
||||
run against the raw signed transaction captured at `eth_sendRawTransaction`
|
||||
rather than against anything the extension reported, rejecting each prompt is
|
||||
required to return a rejection to the page rather than hang or resolve, a prompt
|
||||
raised while another approval window has focus is required to open a window of
|
||||
its own, and the password is required to be absent from every message the
|
||||
approval window sends to the background — with the message that would carry it
|
||||
required to be present, so that check cannot pass by observing nothing. That
|
||||
last one is the standing floor under
|
||||
`eth_requestAccounts`, `personal_sign`, `eth_signTypedData_v4`,
|
||||
`eth_sendTransaction` and `wallet_switchEthereumChain` through the real prompts.
|
||||
Every signature is recovered in the runner and compared against the active
|
||||
address, the transaction assertions run against the raw signed transaction
|
||||
captured at `eth_sendRawTransaction` rather than against anything the extension
|
||||
reported, rejecting each prompt is required to return a rejection to the page
|
||||
rather than hang or resolve, a network switch request is required to leave the
|
||||
stored network unchanged and send no `chainChanged` until it is approved, a
|
||||
network switch in Settings is required to send the page `chainChanged` with the
|
||||
new chain id, a prompt raised while another approval window has focus is
|
||||
required to open a window of its own, and the password is required to be absent
|
||||
from every message the approval window sends to the background — with the
|
||||
message that would carry it required to be present, so that check cannot pass by
|
||||
observing nothing. That last one is the standing floor under
|
||||
[#157](https://git.eeqj.de/sneak/AutistMask/issues/157).
|
||||
|
||||
Two limits of that coverage, neither of them papered over. The RPC is stubbed
|
||||
throughout, so this is **not** a real dApp against a real network with real
|
||||
funds; that remains a human pass before 1.0.0. The site-connection prompt is
|
||||
raised through `chrome.action.openPopup()`, and headless Chromium's
|
||||
browser-action popup is not a page Playwright can see or click, so that one
|
||||
prompt is driven at the URL the extension itself puts on the action — the same
|
||||
page and the same approval id, but whether a real toolbar click shows it is not
|
||||
observable here.
|
||||
The limits of that coverage and of the rest of the Chrome suite, none of them
|
||||
papered over:
|
||||
|
||||
- The RPC is stubbed throughout, so this is **not** a real dApp against a real
|
||||
network with real funds; that remains a human pass before 1.0.0.
|
||||
- The site-connection prompt is raised through `chrome.action.openPopup()`, and
|
||||
headless Chromium's browser-action popup is not a page Playwright can see or
|
||||
click, so that one prompt is driven at the URL the extension itself puts on
|
||||
the action — the same page and the same approval id, but whether a real
|
||||
toolbar click shows it is not observable here.
|
||||
- Each site-connection request is made 1.5 seconds after the tab it will be
|
||||
driven in is opened (`APPROVAL_TAB_SETTLE_MS` in `tests/e2e/run.js`), because
|
||||
opening that tab closes the previous prompt's toolbar popup; a request made
|
||||
just after that popup closes is not covered.
|
||||
- In the tests that approve a signature or a transaction, the approval window
|
||||
runs with `chrome.runtime.sendMessage` wrapped to record what it sends, and in
|
||||
the tests that reject a site connection the prompt gets a click listener that
|
||||
records that Reject was pressed; neither changes what the window does.
|
||||
- The tap to copy test first grants clipboard permission to every page in the
|
||||
browser, which the manifest does not ask for, so whether a real popup may
|
||||
write to the clipboard on a click alone is not covered.
|
||||
- The layout tests for an over-long flash message and for the password error
|
||||
lines write the text straight into the page instead of letting the popup's
|
||||
code put it there, and the second brings each screen up by toggling its
|
||||
`hidden` class rather than navigating to it; they cover the layout, not the
|
||||
code that fills it.
|
||||
- Leaving the recovery phrase or private key screen while its decrypt runs is
|
||||
forced by clicking Reveal and the settings gear in one page task, which a
|
||||
person cannot do; the case a person can hit, the first decrypt after the popup
|
||||
opens while libsodium is still loading, is not driven.
|
||||
|
||||
Any test that drives a failure path on purpose declares the `console.error` it
|
||||
is about to provoke, via `errors.expect()`. That is not a mute: the declaration
|
||||
@@ -439,8 +492,8 @@ collecting for a fixed grace period after the last test returns
|
||||
the context. A request whose _first_ dispatch falls after that window is never
|
||||
seen at all and cannot fail the run. In practice a request a test fires without
|
||||
awaiting reaches the route handler about 10ms later, and anything on a repeating
|
||||
timer gets observed on an earlier tick during the ~20s suite — but a one-shot
|
||||
call deliberately deferred past the window will escape.
|
||||
timer gets observed on an earlier tick during the suite — but a one-shot call
|
||||
deliberately deferred past the window will escape.
|
||||
|
||||
That interception covers the MV3 background service worker as well as the popup
|
||||
page, which it does not by default — `script/test-e2e` sets
|
||||
@@ -489,15 +542,39 @@ one profile yields a single extension id, not two: Chrome does not load a second
|
||||
copy of an id it already has. The assertions are annotated as observations, so a
|
||||
Chrome that ever changes this fails the run instead of passing it.
|
||||
|
||||
Last, `make test-e2e` runs `tests/e2e/slowApproval.js`, which leaves a
|
||||
transaction approval and a signature approval open for seven minutes with both
|
||||
windows minimized, then restores and approves both and requires the site to
|
||||
receive the hash of the transaction the stub node received and a signature that
|
||||
recovers to the address. Before the background worker kept itself running while
|
||||
an approval is pending, Chrome stopped it about six minutes in and neither
|
||||
request was ever answered
|
||||
([#540](https://git.eeqj.de/sneak/AutistMask/issues/540)). The windows are
|
||||
minimized through the DevTools protocol (`Browser.setWindowBounds`), and the run
|
||||
fails unless both pages then report themselves hidden: Chrome slows a hidden
|
||||
page's timers to once a minute, so anything the window did to keep the worker
|
||||
running would fail here. It is its own program and does not use Playwright:
|
||||
Playwright keeps DevTools attached to the background worker, and Chrome never
|
||||
stops a worker DevTools is attached to, so no wait in the suite above can show
|
||||
the worker stopping. It starts Chromium itself, speaks the DevTools protocol
|
||||
over `--remote-debugging-pipe`, and attaches to pages only. Before raising the
|
||||
approvals it requires the worker to stop on its own with nothing pending, so a
|
||||
run in which something else keeps the worker running fails. The site is
|
||||
connected and the RPC endpoint set through the extension's own screens, against
|
||||
the Firefox suite's loopback dApp page and stub node
|
||||
(`tests/e2e/firefox/dapp.js`). Unlike the suite above, it does not fail on page
|
||||
errors.
|
||||
|
||||
### Firefox (`make test-e2e-firefox`)
|
||||
|
||||
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
||||
real Firefox**, installed as an unpacked MV2 temporary add-on via geckodriver.
|
||||
It covers popup load, the StateRecovery screen (the same cases as the Chrome
|
||||
suite), wallet creation through the UI, the Add Token screen, and the four dApp
|
||||
round trips — `eth_requestAccounts`, `personal_sign`, `eth_sendTransaction`, and
|
||||
a closed approval window rejecting with EIP-1193 4001 — driven through the real
|
||||
content script, background page and approval windows.
|
||||
suite), wallet creation through the UI, the Add Token screen, and the dApp round
|
||||
trips — `eth_requestAccounts`, `personal_sign`, `wallet_switchEthereumChain`
|
||||
rejected and then approved, `eth_sendTransaction`, and a closed approval window
|
||||
rejecting with EIP-1193 4001 — driven through the real content script,
|
||||
background page and approval windows.
|
||||
|
||||
The suite lives in `tests/e2e/firefox/`. Its WebDriver client (`driver.js`) has
|
||||
**no npm dependencies at all**: it is built on global `fetch` and
|
||||
@@ -572,25 +649,18 @@ without an `await`. Demonstrated, not assumed: a `throw` placed past the first
|
||||
and on Chrome (`pageerror`), with the rest of the run unaffected because the
|
||||
approval view had already rendered.
|
||||
|
||||
One error is tolerated rather than fatal, listed in `ALLOWED_ERRORS` in
|
||||
`tests/e2e/firefox/run.js` with the issue that will delete it, and printed on
|
||||
every occurrence so the concession stays visible in the run output. It is
|
||||
Firefox reporting the site-approval popup's unawaited `sendMessage` settling
|
||||
after `window.close()` unloaded the context — the same teardown ordering as
|
||||
[#275](https://git.eeqj.de/sneak/AutistMask/issues/275), and unsuppressable from
|
||||
the calling code, because `BaseContext.wrapPromise` reports it whether or not a
|
||||
handler is attached. Errors are read from the privileged `nsIConsoleService` in
|
||||
Marionette's chrome context and filtered to non-warning entries whose
|
||||
`sourceName` is the extension origin. That mechanism is not a stylistic choice.
|
||||
WebDriver BiDi's `log.entryAdded` delivers **nothing** for extension pages: on a
|
||||
plain `http://` page it reports uncaught errors with stack traces, and on the
|
||||
`moz-extension://` popup it reports zero events, because Firefox's remote agent
|
||||
excludes extension browsing contexts from BiDi observation. Any harness built on
|
||||
Playwright-BiDi or Puppeteer-BiDi would therefore see nothing and report
|
||||
success, which is exactly the vacuous check this repo has already shipped twice.
|
||||
Do not migrate this suite to BiDi.
|
||||
Errors are read from the privileged `nsIConsoleService` in Marionette's chrome
|
||||
context and filtered to non-warning entries whose `sourceName` is the extension
|
||||
origin. That mechanism is not a stylistic choice. WebDriver BiDi's
|
||||
`log.entryAdded` delivers **nothing** for extension pages: on a plain `http://`
|
||||
page it reports uncaught errors with stack traces, and on the `moz-extension://`
|
||||
popup it reports zero events, because Firefox's remote agent excludes extension
|
||||
browsing contexts from BiDi observation. Any harness built on Playwright-BiDi or
|
||||
Puppeteer-BiDi would therefore see nothing and report success, which is exactly
|
||||
the vacuous check this repo has already shipped twice. Do not migrate this suite
|
||||
to BiDi.
|
||||
|
||||
Two limits are worth knowing, both real differences from the Chrome suite:
|
||||
Three limits are worth knowing, all real differences from the Chrome suite:
|
||||
|
||||
- **Error capture is poll-based, not event-streamed.** The console is drained at
|
||||
each step boundary, so an error is attributed to the step it was drained
|
||||
@@ -607,24 +677,30 @@ Two limits are worth knowing, both real differences from the Chrome suite:
|
||||
and silently evicts the oldest, so more than 250 console messages between two
|
||||
drains destroys the excess unread. 400 throws inside one step are reported as
|
||||
exactly the newest 250, three runs running. That buffer is shared with
|
||||
Firefox's own console noise; a clean run peaks at 4 of 250 at the install
|
||||
drain and 0 at every later drain, so the three steps here have wide headroom,
|
||||
but a step that logs heavily could evict unread errors. What poll-based costs
|
||||
is location, not coverage: an error cannot be placed within a step the way the
|
||||
Chrome suite's `pageerror` events place it.
|
||||
Firefox's own console noise; a clean run, measured when the suite had three
|
||||
steps (popup load, wallet creation and Add Token), peaked at 4 of 250 at the
|
||||
install drain and 0 at every later drain, but a step that logs heavily could
|
||||
evict unread errors. What poll-based costs is location, not coverage: an error
|
||||
cannot be placed within a step the way the Chrome suite's `pageerror` events
|
||||
place it.
|
||||
- **Almost nothing is stubbed, which inverts the coverage of network-dependent
|
||||
code.** The container still runs with `--network none`, so the run is offline
|
||||
and no request can escape. The one thing it can reach is the loopback fixture
|
||||
in `tests/e2e/firefox/dapp.js`, which serves the dApp page and a JSON-RPC node
|
||||
and which the extension's `rpcUrl` is pointed at for the dApp steps; a
|
||||
JSON-RPC method that fixture does not model fails the run rather than
|
||||
answering `null`. Everything else — Blockscout, the price feed, the phishing
|
||||
blocklist — has no fixture and simply fails, and the extension swallows its
|
||||
own fetch failures, so only the _failure_ branches of that code are ever
|
||||
executed. A `ReferenceError` in the success path of `renderTransactions`, or
|
||||
of price rendering, passes this suite green. The offline run is also weaker
|
||||
than the Chrome suite's interception for those calls: it proves nothing got
|
||||
out, but it cannot report which requests were attempted.
|
||||
answering `null`. Everything else, Blockscout and the price feed among it, has
|
||||
no fixture and simply fails, and the extension swallows its own fetch
|
||||
failures, so only the _failure_ branches of that code are ever executed. A
|
||||
`ReferenceError` in the success path of `renderTransactions`, or of price
|
||||
rendering, passes this suite green. The offline run is also weaker than the
|
||||
Chrome suite's interception for those calls: it proves nothing got out, but it
|
||||
cannot report which requests were attempted.
|
||||
- **The site-connection prompt always opens in a window of its own.** The
|
||||
profile turns off `extensions.openPopupWithoutUserGesture.enabled`, so
|
||||
`src/background/index.js` falls back from the toolbar popup, which WebDriver
|
||||
cannot see, to `windows.create()`; the toolbar popup path is not covered on
|
||||
Firefox.
|
||||
|
||||
Neither `make test-e2e` nor `make test-e2e-firefox` is part of `make check` or
|
||||
`make test`. `REPO_POLICIES.md` caps `make test` at 60 seconds and a browser
|
||||
@@ -669,11 +745,13 @@ installing Firefox, geckodriver and their system libraries. Both scripts now
|
||||
build their image with `--no-cache`, so every run pays the cold figure. Those
|
||||
`e2e-chrome` runs predate the cases that wait in real time for a receipt to end
|
||||
in error. `make test-e2e` took 3m51s locally with its image cached, so with the
|
||||
image rebuilt every run, an `e2e-chrome` run comes to about seven minutes.
|
||||
image rebuilt every run, an `e2e-chrome` run comes to about seven minutes. The
|
||||
approvals left open for seven minutes (`tests/e2e/slowApproval.js`) add about
|
||||
eight more, so about fifteen.
|
||||
|
||||
Each e2e job has a `timeout-minutes` cap, so a hung build or browser ends the
|
||||
job instead of holding the shared runner: `e2e-firefox` 15 minutes and
|
||||
`e2e-chrome` 20, each over two and a half times the job's slowest cold run. A
|
||||
`e2e-chrome` 40, each over two and a half times the job's slowest cold run. A
|
||||
job that reaches its cap has hung; read it as a hang, not as a slow run to
|
||||
retry. The `check` job has no cap: `.gitea/workflows/check.yml` is the canonical
|
||||
copy from `sneak/prompts`, kept byte-identical.
|
||||
@@ -768,6 +846,20 @@ on the next event. Two consequences shape every recurring job in the background:
|
||||
service worker at all — the one remaining user of it, `src/shared/ens.js`,
|
||||
runs only in the popup and is marked as such.
|
||||
|
||||
Pending approvals are the exception: an approval waiting for the user, and the
|
||||
site's request waiting on it, live only in the worker's memory, and only the
|
||||
worker that received the request can answer it. Left alone, Chrome stopped the
|
||||
worker about six minutes after a site's request even with the approval window
|
||||
still open, and the user's answer then reached nobody. So the worker keeps
|
||||
itself running while any approval is pending: raising an approval starts a
|
||||
`setInterval` that calls `runtime.getPlatformInfo()` every 20 seconds, and
|
||||
Chrome counts each extension call as activity. The timer stops itself once
|
||||
nothing is pending, and the worker then stops as it otherwise would. The timer
|
||||
is the worker's own, so it does not depend on the approval window being visible;
|
||||
a timer in the window would, because Chrome slows a hidden page's timers to once
|
||||
a minute. A worker that stops for another reason, a crash say, still loses the
|
||||
approvals open in it.
|
||||
|
||||
The job also carries a freshness guard, and a guard must never be timed to the
|
||||
alarm period it gates. The guard is measured from the moment the last run
|
||||
finished, which is one run-duration after the alarm that started it, so a guard
|
||||
@@ -1154,7 +1246,16 @@ The core hierarchy is **Wallets → Addresses**:
|
||||
of its stored `xpub` by `src/shared/walletDefects.js`, explained in the
|
||||
wallet list, and blocked from signing, sending and private-key export. It
|
||||
is never deleted or rewritten.
|
||||
- An **address** holds ETH and ERC-20 tokens.
|
||||
- An **address** holds ETH and ERC-20 tokens. In an HD or xprv wallet each
|
||||
address record also stores `index`, the derivation index it was made at: 0 for
|
||||
the first address, the index the import scan found it at, or `nextIndex` when
|
||||
"+" added it. An address's `index` and its position in the wallet's list
|
||||
differ once the scan has passed over an unused index or an address has been
|
||||
removed. Sending, site transactions, site signatures and private-key export
|
||||
derive the key at `index`, and refuse it unless it is that address's own key;
|
||||
an HD or xprv address with no valid `index` is refused before anything is
|
||||
derived (`getSignerForAddress()` in `src/shared/wallet.js`). Each refusal is a
|
||||
full sentence naming the address.
|
||||
- The user can have multiple wallets, each with multiple addresses (HD) or a
|
||||
single address (key).
|
||||
|
||||
@@ -1233,14 +1334,21 @@ path rather than on the home screen. Read the claim narrowly, as that file
|
||||
states it: what those boots prove is no structural dereference on the code paths
|
||||
a WHOLLY-CORRUPTED PROFILE takes, which is not every path a stored record takes.
|
||||
Not driven: any pairing of values the four slots do not produce, a view only
|
||||
forward navigation opens, anything behind a click, and everything a healthy
|
||||
profile reaches. Within that boundary the verdict is unconditional — if one of
|
||||
those boots leaves the popup unhealthy or off the view it stored, `make check`
|
||||
fails, including when it takes two corrupted fields at once, because the verdict
|
||||
is the combined boot and the per-field re-boot that names a culprit can only
|
||||
decorate the message. So does a field that gains a floor while its row still
|
||||
claims it has none, and so does a field added to `PERSISTED_FIELDS` with no row
|
||||
at all. The per-field justification that used to live in the header of
|
||||
forward navigation opens, anything behind a click or a timer, and, of what a
|
||||
healthy profile reaches, anything beyond its boot onto each view the popup can
|
||||
reopen onto. The fields the router does not read share a slot on each boot, so
|
||||
one of them truthy while another is falsy is reached only where the falsy slot
|
||||
pairs a field that cannot be falsy with one that is. Within that boundary the
|
||||
verdict is unconditional — if one of those boots leaves the popup unhealthy,
|
||||
`make check` fails, including when it takes two corrupted fields at once,
|
||||
because the verdict is the combined boot and the per-field re-boot that names a
|
||||
culprit can only decorate the message. The combined boot must also land on the
|
||||
view it stored, and each value driven only onto the restore path must land on
|
||||
its view, or fall back to Home, as its row declares; a field the router reads
|
||||
can legitimately change which view renders, so its own sweep is held to health
|
||||
alone. `make check` also fails on a field that gains a floor while its row still
|
||||
claims it has none, and on a field added to `PERSISTED_FIELDS` with no row at
|
||||
all. The per-field justification that used to live in the header of
|
||||
`src/shared/stateSchema.js` shipped a false claim in three consecutive changes,
|
||||
each caught only by a reviewer re-deriving thirty fields by hand.
|
||||
|
||||
@@ -1281,11 +1389,14 @@ behind a "···" menu.
|
||||
|
||||
Navigation uses a stack model (like iOS): each forward action pushes the current
|
||||
screen onto `state.viewStack`, and "Back" pops it (`pushCurrentView()` and
|
||||
`goBack()` in `src/popup/views/helpers.js`). The root screen is either Welcome
|
||||
(no wallets) or Home (has wallets). Each screen below gives its view id in
|
||||
parentheses; the registry of view ids is the `VIEWS` array in
|
||||
`src/popup/views/helpers.js`, and the markup for a screen is the element with id
|
||||
`view-` plus that view id in `src/popup/index.html`.
|
||||
`goBack()` in `src/popup/views/helpers.js`). "Back" skips an entry for the
|
||||
screen already showing: ShowRecoveryPhrase and the two delete screens take
|
||||
themselves off the stack when left, so the Settings gear on one of them leaves
|
||||
Settings under Settings, and "Back" from there goes to the screen before
|
||||
Settings. The root screen is either Welcome (no wallets) or Home (has wallets).
|
||||
Each screen below gives its view id in parentheses; the registry of view ids is
|
||||
the `VIEWS` array in `src/popup/views/helpers.js`, and the markup for a screen
|
||||
is the element with id `view-` plus that view id in `src/popup/index.html`.
|
||||
|
||||
Three elements sit outside the screens and are present on all of them: the title
|
||||
bar ("AutistMask by @sneak" plus the Settings gear), the flash message line
|
||||
@@ -1411,14 +1522,17 @@ view would leave a wallet one click from deletion.
|
||||
without it, the lost-password route on DeleteWallet is the first they
|
||||
would hear of it. The hint line reserves its height, so switching tabs
|
||||
cannot move the password fields under the pointer.
|
||||
- "Import" button
|
||||
- "Import" button, with the error line beside it so that it adds no height
|
||||
to a screen whose button already starts near the bottom of the popup
|
||||
- **Transitions**:
|
||||
- "Import" with a valid entry and a matching password of at least 12
|
||||
characters → creates the wallet, clears the navigation stack, and →
|
||||
**Home**. The phrase and xprv modes then scan for further used addresses
|
||||
and report the count as a flash message.
|
||||
- "Import" with an invalid entry, a duplicate wallet or address, or a short
|
||||
or mismatched password → flash message, no screen change
|
||||
- "Import" with a missing, short or mismatched password → full-sentence
|
||||
error on the error line, no screen change
|
||||
- "Import" with an invalid entry or a duplicate wallet or address → flash
|
||||
message, no screen change
|
||||
- "Back" → previous screen (Welcome, Home, or Settings)
|
||||
|
||||
#### AddressDetail (`address`)
|
||||
@@ -1457,8 +1571,8 @@ view would leave a wallet one click from deletion.
|
||||
copy)
|
||||
- Warning that anyone holding the private key can transfer all funds from
|
||||
the address
|
||||
- Error line
|
||||
- Password input and "Reveal" button, shown until the key is revealed
|
||||
- Password input, error line and "Reveal" button, shown until the key is
|
||||
revealed
|
||||
- The private key on a highlighted background, tap to copy, shown only after
|
||||
the password has been accepted
|
||||
- **Transitions**:
|
||||
@@ -1467,13 +1581,27 @@ view would leave a wallet one click from deletion.
|
||||
change)
|
||||
- "Reveal" (wrong password) → full-sentence error on the error line, nothing
|
||||
revealed (no screen change)
|
||||
- "Reveal" (correct password, but this address's key is refused, see Data
|
||||
Model) → full-sentence error saying why, nothing revealed (no screen
|
||||
change)
|
||||
- "Back" → previous screen (AddressDetail)
|
||||
- Settings gear → **Settings**, whose "Back" goes to AddressDetail: leaving
|
||||
drops the address the screen was showing, so it also takes the screen off
|
||||
the Back stack
|
||||
- **Secret handling**: nothing is decrypted, no key is derived, and nothing is
|
||||
written into the page until the password is accepted; the key is never stored
|
||||
in state, and it is wiped from the page whenever the screen is left by any
|
||||
route, including the Settings gear. A decrypt still running when the screen is
|
||||
left is discarded rather than written. The screen is not restorable, so
|
||||
reopening the popup lands on Home rather than back on the key.
|
||||
- **Clipboard**: tapping the key copies it to the clipboard, and the wallet
|
||||
never clears the clipboard afterwards; leaving the screen wipes the key from
|
||||
the page only. The clipboard is the user's, not the wallet's. Clearing it
|
||||
would go against what the user expects, and by then they may have copied
|
||||
something else vital that the clear would destroy. The user knows the key is
|
||||
secret from the warning above the password input, which says that anyone with
|
||||
it can access and transfer all funds from the address, and knows it is on the
|
||||
clipboard because they copied it. From then on it is theirs to manage.
|
||||
|
||||
#### AddressToken (`address-token`)
|
||||
|
||||
@@ -1583,8 +1711,21 @@ view would leave a wallet one click from deletion.
|
||||
the contract's own answer is read at signing time only to be compared with
|
||||
it, and a disagreement is a refusal rather than a preference for either
|
||||
value (`src/shared/transferAmount.js`)
|
||||
- "Sign & Send" after the active network was switched in Settings while this
|
||||
screen was open → nothing is signed; "The active network changed after
|
||||
this transaction was reviewed, so it was not sent. Please go back and
|
||||
review it again." in the errors box, no screen change. The transaction
|
||||
carries the chain id of the network the screen was shown for, so it cannot
|
||||
be signed for another
|
||||
- "Sign & Send" (wrong password) → "Wrong password." on the password error
|
||||
line, no screen change
|
||||
- "Sign & Send" signs as the From address above, not as whichever address is
|
||||
selected: the two are saved separately, so the popup can reopen onto this
|
||||
screen with another address selected. When the selected wallet does not
|
||||
hold the From address → full-sentence error on the password error line,
|
||||
nothing sent (no screen change)
|
||||
- "Sign & Send" (correct password, but the From address's key is refused,
|
||||
see Data Model) → nothing is signed → **ErrorTx** saying why
|
||||
- "Back" → **Send**
|
||||
|
||||
#### WaitTx (`wait-tx`)
|
||||
@@ -1728,8 +1869,12 @@ view would leave a wallet one click from deletion.
|
||||
plus a "+ Add token" button
|
||||
- Display: "Show tracked tokens with zero balance" checkbox, "UTC
|
||||
Timestamps" checkbox, and a Theme selector (System / Light / Dark)
|
||||
- Network: network selector (Ethereum Mainnet / Sepolia Testnet); switching
|
||||
resets the RPC and Blockscout endpoints to that network's defaults
|
||||
- Network: network selector (Ethereum Mainnet / Sepolia Testnet). The
|
||||
network changes only here, or when the user approves a site's request on
|
||||
**NetworkApproval**; either way, switching restores the RPC and Blockscout
|
||||
endpoints last used on that network, or that network's defaults if it has
|
||||
none, and sends `chainChanged` with the new chain id to every open tab.
|
||||
Choosing the network already active changes nothing and sends nothing
|
||||
- Ethereum RPC: endpoint URL input + "Save" button (validated against
|
||||
`eth_chainId` before being saved)
|
||||
- Blockscout API: endpoint URL input + "Save" button (validated against
|
||||
@@ -1785,8 +1930,8 @@ view would leave a wallet one click from deletion.
|
||||
- Wallet name
|
||||
- Warning box stating that anyone holding these words can take everything in
|
||||
the wallet, from any device, without the password
|
||||
- Error line
|
||||
- Password input + "Reveal" button, shown until the password is accepted
|
||||
- Password input, error line and "Reveal" button, shown until the password
|
||||
is accepted
|
||||
- The recovery phrase itself, in full and click-to-copy, shown only after a
|
||||
correct password and in place of the password prompt
|
||||
- **Transitions**:
|
||||
@@ -1795,12 +1940,18 @@ view would leave a wallet one click from deletion.
|
||||
- "Reveal" (wrong password) → full-sentence error, nothing revealed (no
|
||||
screen change)
|
||||
- "Back" → previous screen (Settings)
|
||||
- Settings gear → **Settings**, whose "Back" never lands back on this
|
||||
screen: leaving drops the wallet the screen was showing, so it also takes
|
||||
the screen off the Back stack
|
||||
- **Secret handling**: nothing is decrypted or written into the page until the
|
||||
password is accepted; the phrase is never stored in state, and it is wiped
|
||||
from the page whenever the screen is left by any route, including the Settings
|
||||
gear. A decrypt still running when the screen is left is discarded rather than
|
||||
written. The screen is not restorable, so reopening the popup lands on Home
|
||||
rather than back on the phrase.
|
||||
- **Clipboard**: tapping the phrase copies it, and the wallet never clears the
|
||||
clipboard afterwards, for the reasons given under ExportPrivKey; here the
|
||||
warning box above the password input is what tells the user it is secret.
|
||||
|
||||
#### DeleteWallet (`delete-wallet-confirm`)
|
||||
|
||||
@@ -1809,8 +1960,8 @@ view would leave a wallet one click from deletion.
|
||||
- "Back" button, "Delete Wallet" heading
|
||||
- Warning naming the wallet and stating that deletion is permanent and any
|
||||
funds are unrecoverable without the recovery phrase
|
||||
- Error line
|
||||
- Password input
|
||||
- Error line
|
||||
- "Confirm Delete" button
|
||||
- An underlined "I have lost my password" control
|
||||
- **Transitions**:
|
||||
@@ -1830,6 +1981,9 @@ view would leave a wallet one click from deletion.
|
||||
try again." on the error line, nothing deleted
|
||||
- "I have lost my password" → **DeleteWalletLostPassword**
|
||||
- "Back" → previous screen (Settings)
|
||||
- Settings gear → **Settings**, whose "Back" never lands back on this
|
||||
screen: leaving drops the wallet the screen was showing, so it also takes
|
||||
the screen off the Back stack
|
||||
|
||||
#### DeleteWalletLostPassword (`delete-wallet-lost-password`)
|
||||
|
||||
@@ -1868,6 +2022,9 @@ view would leave a wallet one click from deletion.
|
||||
selection comes back with it. The two delete screens are siblings rather
|
||||
than parent and child: nothing is pushed on the way here, so both have
|
||||
Settings as their Back target.
|
||||
- Settings gear → **Settings**, whose "Back" never lands back on this
|
||||
screen: leaving drops the wallet the screen was showing, so it also takes
|
||||
the screen off the Back stack
|
||||
- **Deliberately not password-gated.** A password in front of _discarding_ a
|
||||
secret protects nobody: an attacker at the popup who wants the wallet gone can
|
||||
uninstall the extension, so the only person such a gate stops is the owner who
|
||||
@@ -1997,7 +2154,11 @@ view would leave a wallet one click from deletion.
|
||||
artifact can be compared with it field for field. A nonce the site supplies is
|
||||
ignored: the nonce is always the account's next nonce from the node, so a site
|
||||
cannot replace one of the user's pending transactions or leave this one stuck
|
||||
behind a gap. A request that cannot be populated — unreachable node, reverting
|
||||
behind a gap. A gas limit the site supplies, as `gas` or `gasLimit`, is the
|
||||
one shown and signed in place of the node's estimate, but the node still
|
||||
estimates the transaction with that limit, as the check that it neither
|
||||
reverts nor runs out of gas; a request that gives both with different values
|
||||
is refused. A request that cannot be populated — unreachable node, reverting
|
||||
gas estimate — opens no window and is failed back to the site. Only one
|
||||
transaction approval exists at a time: populating fixes the nonce, so a second
|
||||
`eth_sendTransaction` arriving while one is unanswered is refused with
|
||||
@@ -2005,7 +2166,10 @@ view would leave a wallet one click from deletion.
|
||||
no window and takes no nonce, and the site can send it again once the pending
|
||||
one is answered. The window is centred on the browser window the user was last
|
||||
in; if that was another approval window, or the browser refuses the centred
|
||||
position, the browser picks the position.
|
||||
position, the browser picks the position. The network shown is the one the
|
||||
transaction was populated on, and a site cannot switch it without the user:
|
||||
its `wallet_switchEthereumChain` request changes the network only when the
|
||||
user approves it on **NetworkApproval**.
|
||||
- **Elements**:
|
||||
- "Transaction Request" heading
|
||||
- Phishing warning banner (shown when the hostname is on the phishing
|
||||
@@ -2029,6 +2193,9 @@ view would leave a wallet one click from deletion.
|
||||
shown, exactly as shown, hands the signed transaction to the background to
|
||||
broadcast, then → **WaitTx** in the same popup window
|
||||
- "Confirm" (wrong password) → error line, no screen change
|
||||
- "Confirm" (correct password, but the From address's key is refused, see
|
||||
Data Model) → full-sentence error on the error line saying why, nothing
|
||||
signed (no screen change)
|
||||
- "Reject" → closes popup (returns rejection to background)
|
||||
- Popup window closed without answering → the request is rejected with
|
||||
EIP-1193 code 4001
|
||||
@@ -2047,7 +2214,12 @@ view would leave a wallet one click from deletion.
|
||||
blocklist)
|
||||
- Site origin (bold, scheme and port included) + "wants you to sign a
|
||||
message"
|
||||
- Danger warning box (shown for `eth_sign`, which signs a raw hash)
|
||||
- Warning box, shown for `eth_sign`: "This site used the older eth_sign
|
||||
method. The data will be signed as a personal message." An `eth_sign`
|
||||
request names the address first and the data second. Its data is signed
|
||||
exactly as a `personal_sign` message is, as an EIP-191 personal message,
|
||||
which is what the Ethereum JSON-RPC specification defines `eth_sign` to
|
||||
return.
|
||||
- Type: "Personal message" or "Typed data (EIP-712)"
|
||||
- From: color dot + full address + etherscan link
|
||||
- Message: for `personal_sign` and `eth_sign`, the text the message's bytes
|
||||
@@ -2062,7 +2234,12 @@ view would leave a wallet one click from deletion.
|
||||
Bytes that are not UTF-8 are shown as "This message is not text." For
|
||||
typed data, formatted domain/type/message fields (EIP-712). The primary
|
||||
type shown is the one ethers signs, derived from the typed data's `types`,
|
||||
not the type the site states.
|
||||
not the type the site states. The message shows only the fields that type
|
||||
declares, at every level of nesting and in the type's order: ethers signs
|
||||
those and drops any other key. Typed data carrying other keys is not
|
||||
refused; each such key is listed after the message under "Not part of the
|
||||
signature", by its place in the message (`details.note`,
|
||||
`details[1].note`) and its value.
|
||||
- Token permission warning, at the top of the message (typed data whose
|
||||
primary type is `Permit`, as in EIP-2612, or one of Permit2's signature
|
||||
types): "⚠️ TOKEN PERMISSION: Signing this lets the spender below take the
|
||||
@@ -2083,6 +2260,13 @@ view would leave a wallet one click from deletion.
|
||||
- Typed data that states no primary type, or one other than the type it
|
||||
would be signed as, or that cannot be read → shown with the error line
|
||||
saying so and "Sign" disabled; only "Reject" remains
|
||||
- Typed data whose domain `chainId` names a chain other than the active
|
||||
network's → shown with the error line naming both chain ids and "Sign"
|
||||
disabled; only "Reject" remains. EIP-712 asks for this, because the
|
||||
signature is valid on the chain the domain names. Typed data with no
|
||||
`chainId` is not refused. The background refuses such a signature too,
|
||||
against the network active when the signature reaches it, and answers the
|
||||
site with the same sentence
|
||||
- A `personal_sign` or `eth_sign` message that is not hex (`0x` or `0X` and
|
||||
an even number of hex digits, the form ethers' `getBytes` reads when
|
||||
signing) → shown as plain text, with the error line "This message is plain
|
||||
@@ -2096,6 +2280,40 @@ view would leave a wallet one click from deletion.
|
||||
- Popup window closed without answering → the request is rejected with
|
||||
EIP-1193 code 4001
|
||||
|
||||
#### NetworkApproval (`approve-network`)
|
||||
|
||||
- **When**: A connected website asks to switch the network with
|
||||
`wallet_switchEthereumChain`, naming a supported network other than the active
|
||||
one. Only the user switches the network: until the user approves the request
|
||||
here, it changes nothing — not the network, the RPC and Blockscout endpoints,
|
||||
the balances or the cached token data — and no page is sent `chainChanged`.
|
||||
Opened the same way as TxApproval, in a separate popup window. Only one exists
|
||||
per site at a time: a further switch request from a site whose switch request
|
||||
is still unanswered is refused with EIP-1193 code `-32002` and opens no
|
||||
window. A request naming the network already active is answered at once and
|
||||
opens nothing; one naming an unsupported chain is refused with code `4902`,
|
||||
and one from a site that is not connected with code `4100`.
|
||||
`wallet_addEthereumChain` never switches the network.
|
||||
- **Elements**:
|
||||
- "Network Switch Request" heading
|
||||
- Phishing warning banner (shown when the hostname is on the phishing
|
||||
blocklist)
|
||||
- Site origin (bold, scheme and port included) + "wants to switch the
|
||||
wallet's network."
|
||||
- Current network: its name
|
||||
- Requested network: its name
|
||||
- A line saying that switching changes the network for the whole wallet and
|
||||
for every site
|
||||
- "Switch" / "Reject" buttons
|
||||
- **Transitions**:
|
||||
- "Switch" → closes popup; the background switches the network as
|
||||
**Settings** does, restoring the RPC and Blockscout endpoints last used on
|
||||
that network (or that network's defaults if it has none), sends
|
||||
`chainChanged` to every open tab, and answers the site with success
|
||||
- "Reject" → closes popup; the site is answered with EIP-1193 code 4001 and
|
||||
nothing changes
|
||||
- Popup window closed without answering → the same as "Reject"
|
||||
|
||||
#### StateRecovery (`state-recovery`)
|
||||
|
||||
- **When**: the stored profile fails `assertStateUsable()`. At open, that is
|
||||
@@ -2390,6 +2608,8 @@ logged.
|
||||
- Sign transactions requested by connected sites (`eth_sendTransaction`)
|
||||
- Sign messages (`personal_sign`, `eth_sign`)
|
||||
- Sign typed data (`eth_signTypedData_v4`, `eth_signTypedData`)
|
||||
- Switch network at a connected site's request, once the user approves it
|
||||
(`wallet_switchEthereumChain`)
|
||||
- Human-readable transaction decoding (ERC-20, Uniswap Universal Router)
|
||||
- ETH/USD and token/USD price display
|
||||
- Configurable RPC endpoint and Blockscout API
|
||||
@@ -2539,7 +2759,8 @@ plaintext list of anyone's domain names.
|
||||
When a dApp on a blocklisted domain requests a wallet connection, transaction
|
||||
approval, or signature, the approval popup displays a prominent red warning
|
||||
banner alerting the user. The domain checker matches exact hostnames and all
|
||||
parent domains (subdomain matching).
|
||||
parent domains (subdomain matching), and checks a hostname written with a
|
||||
trailing dot (`name.`) as `name`.
|
||||
|
||||
#### Transaction Decoding
|
||||
|
||||
@@ -2582,7 +2803,7 @@ Currently supported:
|
||||
|
||||
### Non-Goals for 1.0
|
||||
|
||||
- Multi-chain support (Ethereum mainnet only)
|
||||
- Chains other than Ethereum mainnet and the Sepolia testnet
|
||||
- Hardware wallet support
|
||||
|
||||
## TODO
|
||||
@@ -2616,7 +2837,10 @@ Currently supported:
|
||||
## Policies
|
||||
|
||||
- We don't mention "the other wallet" by name in code or documentation. We're
|
||||
our own thing.
|
||||
our own thing. Written exception: the injected provider in
|
||||
`src/content/inpage.js` sets the flag named after the other wallet to `true`.
|
||||
It is an interface-compatibility flag many dApps check, and without it the
|
||||
wallet stops working on their sites.
|
||||
- The README is the complete authoritative technical documentation. It's ok if
|
||||
it gets big.
|
||||
|
||||
@@ -2646,7 +2870,7 @@ exact URL, the commit it is pinned to and the sha256 of the bytes that commit
|
||||
serves, because a source reference nobody can verify is not a source reference.
|
||||
`script/check-censored` reads the name back out of that one file and fails the
|
||||
build wherever else it appears, save for three shipped-code literals it cannot
|
||||
avoid — each permitted only at the one path that carries it, and listed in that
|
||||
avoid — each permitted only at the paths that carry it, and listed in that
|
||||
script's header.
|
||||
|
||||
## Author
|
||||
|
||||
@@ -118,4 +118,7 @@ contradicts either, the originals govern.
|
||||
- [ ] "Address" not "account" or "derived key"
|
||||
- [ ] "Password" not "encryption key" or "vault passphrase"
|
||||
- [ ] Error messages are full sentences
|
||||
- [ ] No competitor mentioned by name in code or documentation
|
||||
- [ ] No competitor mentioned by name in code or documentation. Written
|
||||
exception: the injected provider in `src/content/inpage.js` sets the flag
|
||||
named after the other wallet to `true`, an interface-compatibility flag
|
||||
many dApps check (README.md, Policies)
|
||||
|
||||
@@ -2,10 +2,9 @@
|
||||
|
||||
- `git pull` `next` and cut a branch from it — one branch per issue, named
|
||||
`issue-<N>-<slug>`. Never branch from `main`.
|
||||
- Do the work as one commit whose title ends with ` (closes #N)`, with the
|
||||
`TODO.md` update in that same commit.
|
||||
- Move Next Step to the top of Completed Steps; move the top item of Future
|
||||
Steps into Next Step.
|
||||
- Do the work as one commit whose title ends with ` (closes #N)`.
|
||||
- Add no entry to Completed Steps. What landed is recorded on the tracker and in
|
||||
`git log`, where each commit title names the issue it closes.
|
||||
- Run `make fmt`, then `make check`. A feature branch may be red; `next` and
|
||||
`main` may not.
|
||||
- Rebase onto current `next` immediately before pushing — other branches land on
|
||||
@@ -23,28 +22,223 @@
|
||||
|
||||
pre-1.0, working towards the 1.0.0 milestone. Tagged v0.1.0 on 2026-02-27. The
|
||||
milestone is in flight on `next`; its `next` -> `main` PR is
|
||||
[#190](https://git.eeqj.de/sneak/AutistMask/pulls/190). `make check` verified
|
||||
green on `next` at `e9fa8be` on 2026-08-10, and `make build` produces
|
||||
`dist/chrome/` and `dist/firefox/`, verified against the build's own receipt to
|
||||
hold exactly the regular files and symlinks that build emitted, with `DEBUG`
|
||||
compiled off.
|
||||
[#388](https://git.eeqj.de/sneak/AutistMask/pulls/388). `make build` produces
|
||||
`dist/chrome/` and `dist/firefox/` with `DEBUG` compiled off, and checks them
|
||||
against the build's own receipt to hold exactly the regular files and symlinks
|
||||
that build emitted.
|
||||
|
||||
The backlog lives on the
|
||||
[Gitea tracker](https://git.eeqj.de/sneak/AutistMask/issues), which is
|
||||
authoritative; this file does not duplicate it. Full policy file set present.
|
||||
Real-browser end-to-end suites (`make test-e2e` for Chrome,
|
||||
`make test-e2e-firefox` for Firefox) sit alongside `make check`, which now does
|
||||
static analysis as well as formatting, and `.gitea/workflows/e2e.yml` runs both
|
||||
of them on every push.
|
||||
`make test-e2e-firefox` for Firefox) sit alongside `make check`, which runs the
|
||||
tests, static analysis and the formatting check, and `.gitea/workflows/e2e.yml`
|
||||
runs both of them on every push.
|
||||
|
||||
# Next Step
|
||||
|
||||
Pre-1.0 security review of the extension (key handling, DEBUG mode policy, RPC
|
||||
input validation) before any 1.0rc tag. Individual filed issues are parts of it,
|
||||
but the review is broader than any of them.
|
||||
Cut 1.0.0 once the
|
||||
[1.0.0 milestone](https://git.eeqj.de/sneak/AutistMask/milestone/6) is empty,
|
||||
then continue tagging as milestones land.
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-10-08: The browser suites no longer read a screen before the page has
|
||||
shown it ([#502](https://git.eeqj.de/sneak/AutistMask/issues/502)). Their wait
|
||||
for a screen used to pass as soon as the element laid out, which every view
|
||||
does until the page's stylesheet has applied, so an approval test could read
|
||||
the prompt's fields before the page's script had filled them. `visible()` in
|
||||
`tests/e2e/harness.js` and `waitVisible()` in `tests/e2e/firefox/driver.js`
|
||||
now also wait for the page to finish loading and for neither the element nor
|
||||
anything around it to carry the `hidden` class that `showView()` puts on every
|
||||
view but the current one. No caller changed.
|
||||
|
||||
- 2026-10-08: Switching the network in Settings now tells open pages
|
||||
([#500](https://git.eeqj.de/sneak/AutistMask/issues/500)). Once the switch is
|
||||
saved, Settings asks the background to send `chainChanged` with the new chain
|
||||
id to every open tab, through the same function an approved site request uses.
|
||||
Choosing the network already active changes nothing and sends nothing. Only
|
||||
the extension's own pages can ask for this. `tests/chainSwitchGate.test.js`
|
||||
drives the real Settings view against the background, and the Chrome suite
|
||||
checks that the test page hears both switches.
|
||||
|
||||
- 2026-10-07: A site can no longer switch the wallet's network by itself
|
||||
([#408](https://git.eeqj.de/sneak/AutistMask/issues/408)). A connected site's
|
||||
`wallet_switchEthereumChain` request for the other supported network opens a
|
||||
prompt in its own window, through the same approval machinery as the
|
||||
transaction and signature prompts, naming the site, the current network and
|
||||
the requested one. The network, its endpoints, the balances and the caches
|
||||
change, and `chainChanged` is sent, only when the user approves it; rejecting
|
||||
or closing the prompt answers 4001. One such prompt per site at a time. The
|
||||
approval window no longer shows the connection prompt while it waits for the
|
||||
background to describe the approval, because that prompt's "Allow" answers on
|
||||
the same port as the new one; `tests/approvalWindow.test.js` checks that it
|
||||
shows no screen until then. `tests/chainSwitchGate.test.js` and both browser
|
||||
suites drive the prompt.
|
||||
|
||||
- 2026-10-07: Two contradictions between the documents and the code are resolved
|
||||
as ruled on [#165](https://git.eeqj.de/sneak/AutistMask/issues/165). The
|
||||
README's 1.0 non-goal now puts Ethereum mainnet and the Sepolia testnet in
|
||||
scope and other chains out of it. The injected provider's flag named after the
|
||||
other wallet stays, as an interface-compatibility flag many dApps check, and
|
||||
is written down as an exception to the rule against naming competitors in the
|
||||
README's Policies section, in `RULES.md` and in a comment beside it in
|
||||
`src/content/inpage.js`. `script/check-censored` already allows that flag only
|
||||
in that file and its built copies, so it is unchanged.
|
||||
|
||||
- 2026-10-07: Two holes in what `tests/persistedFieldContract.test.js` checks
|
||||
are closed ([#379](https://git.eeqj.de/sneak/AutistMask/issues/379)). The
|
||||
check that every swept field is driven both truthy and falsy counts only
|
||||
`hostile` and `falsy` values, which the sweep drives onto every restorable
|
||||
view, and no longer a `hostileRestore` value, which reaches only the views its
|
||||
entry names; the stale index 5 moves into `hostile` for `selectedWallet` and
|
||||
`selectedAddress`, as the one value of either still truthy after the floor.
|
||||
Each `hostileRestore` entry declares whether its boot lands on its view or
|
||||
falls back to Home, and is held to it. The limits that remain, fields that
|
||||
share a slot on one boot and anything no stored record reaches by itself, are
|
||||
restated as built in the file's header and the README, which now also say
|
||||
which boots are held to where the popup lands and that a healthy profile is
|
||||
booted onto every restorable view.
|
||||
|
||||
- 2026-10-07: Every password error in the popup is shown the same way
|
||||
([#493](https://git.eeqj.de/sneak/AutistMask/issues/493)): with `showError()`
|
||||
and `hideError()` in a fixed-height error line below the password field, as
|
||||
the send confirmation and approval screens already did. The add wallet screen
|
||||
showed a missing, short or mismatched password in the flash line, and the
|
||||
private key export, recovery phrase and delete wallet screens each had a line
|
||||
of their own above the field. On the add wallet screen the line sits beside
|
||||
the Import button, so the button stays where it was at 360x600. Each line
|
||||
clears when the screen is shown again and when the password is tried again.
|
||||
The add wallet screen's other messages, such as an invalid recovery phrase, a
|
||||
duplicate wallet and the address scan, stay in the flash line.
|
||||
`tests/passwordErrorLines.test.js` drives all four screens in the popup.
|
||||
|
||||
- 2026-10-07: Pre-1.0 security review of the extension
|
||||
([#383](https://git.eeqj.de/sneak/AutistMask/issues/383)), reading the tree at
|
||||
`99292b9` for key handling, the DEBUG mode policy, and what the background
|
||||
accepts from pages, the configured RPC endpoint and the explorer, with what
|
||||
the approval screens show from it; the site permission model and storage were
|
||||
read as well. Its summary on that issue lists ten findings, each filed as its
|
||||
own issue, and all ten are fixed on `next`; one,
|
||||
[#399](https://git.eeqj.de/sneak/AutistMask/issues/399), put funds at risk.
|
||||
Three decisions it raised are still open with the owner: the Argon2id cost for
|
||||
the vault key ([#401](https://git.eeqj.de/sneak/AutistMask/issues/401)), a
|
||||
connected site switching the network with no prompt
|
||||
([#408](https://git.eeqj.de/sneak/AutistMask/issues/408)), and `eth_sign`
|
||||
signing as a personal message
|
||||
([#409](https://git.eeqj.de/sneak/AutistMask/issues/409)). Not covered: the
|
||||
end-to-end suites were not run, the bundled phishing blocklist and token list
|
||||
were not checked entry by entry, `ethers` and `libsodium-wrappers-sumo` were
|
||||
taken as audited, and nothing was tried against a real network with real funds
|
||||
([#385](https://git.eeqj.de/sneak/AutistMask/issues/385)). The planned
|
||||
independent second check of each finding did not run; the findings rest on the
|
||||
reviewer's own reading of the code.
|
||||
|
||||
- 2026-10-07: Stale branches pruned from `origin`
|
||||
([#167](https://git.eeqj.de/sneak/AutistMask/issues/167)). The issue
|
||||
classifies each branch it lists, with the evidence. The eighteen still on
|
||||
`origin` that it classifies as landed, or superseded by merged pull requests,
|
||||
were deleted. `feat/message-signing` and `fix/59-transaction-view-ui-policies`
|
||||
had been deleted on 2026-09-09; both landed and stay deleted. Four are kept
|
||||
because their work is not in `next`: `fix/consistent-error-display`,
|
||||
`fix/87-consistent-error-display` and `fix/87-consistent-error-display-v2`,
|
||||
the change for [#87](https://git.eeqj.de/sneak/AutistMask/issues/87) that
|
||||
never landed, as reference for
|
||||
[#493](https://git.eeqj.de/sneak/AutistMask/issues/493); and
|
||||
`chore/token-list-enrichment`, deleted on 2026-09-09 and re-created at
|
||||
`f7a2437`, whose `scripts/` tooling waits on
|
||||
[#495](https://git.eeqj.de/sneak/AutistMask/issues/495).
|
||||
|
||||
- 2026-10-07: The README says that the wallet never clears the clipboard after
|
||||
the private key or the recovery phrase is copied, and why
|
||||
([#492](https://git.eeqj.de/sneak/AutistMask/issues/492)): the clipboard is
|
||||
the user's, clearing it would go against what they expect, and it could
|
||||
destroy something else they copied since. It is under ExportPrivKey, with a
|
||||
line under ShowRecoveryPhrase, and names the warning each password screen
|
||||
actually shows, which says nothing about the clipboard.
|
||||
|
||||
- 2026-10-07: The Firefox end-to-end suite no longer tolerates any uncaught
|
||||
extension error ([#487](https://git.eeqj.de/sneak/AutistMask/issues/487)). Its
|
||||
one entry, Firefox reporting a popup promise that settled after the page
|
||||
unloaded, had lost its cause with
|
||||
[#275](https://git.eeqj.de/sneak/AutistMask/issues/275); the entry and the
|
||||
code that printed tolerated errors are gone from `tests/e2e/firefox/run.js`,
|
||||
and so is the README paragraph that described it.
|
||||
|
||||
- 2026-10-07: The toolbar icons in `icons/` can be redrawn in the tree
|
||||
([#378](https://git.eeqj.de/sneak/AutistMask/issues/378)): `make icons` runs
|
||||
`script/lib/icons.js`, which draws the mark and writes each PNG with node's
|
||||
own `zlib`, no new dependency, leaving alone a file that already holds the
|
||||
drawn image. `tests/icons.test.js` requires each committed file to hold
|
||||
exactly that image, the same IHDR and every pixel. The compressed bytes are
|
||||
not compared, because node's bundled zlib does not compress them as the stock
|
||||
zlib that made the committed files did. `build.js` now copies each manifest
|
||||
from the same path `copyIcons()` reads its icons from.
|
||||
|
||||
- 2026-10-07: The README's end-to-end limits now match what the two browser
|
||||
suites do to the extension
|
||||
([#293](https://git.eeqj.de/sneak/AutistMask/issues/293)). The `window.close`
|
||||
override the issue named went with
|
||||
[#275](https://git.eeqj.de/sneak/AutistMask/issues/275), so it needs no entry.
|
||||
Added: both suites load the popup in a tab rather than from the toolbar;
|
||||
Chrome waits 1.5 seconds before each site-connection request, records what
|
||||
approval windows send and click, grants clipboard permission, writes text
|
||||
straight into the page in two layout tests, and forces the leave during a
|
||||
decrypt; Firefox forces the site-connection prompt into a window. Corrected:
|
||||
Firefox's one tolerated error, whose cause that fix removed (the entry goes in
|
||||
[#487](https://git.eeqj.de/sneak/AutistMask/issues/487)), the phishing
|
||||
blocklist the extension no longer fetches, and two stale figures.
|
||||
|
||||
- 2026-10-07: Back from Settings no longer shows Settings again after the
|
||||
settings gear was pressed on the recovery phrase or a delete wallet screen
|
||||
opened from Settings, with or without a reopen in between
|
||||
([#481](https://git.eeqj.de/sneak/AutistMask/issues/481)). Those screens take
|
||||
themselves off the Back stack when left, which leaves Settings under Settings;
|
||||
`goBack()` now skips an entry for the screen already showing.
|
||||
`tests/showPhrase.test.js`, `tests/deleteWalletLostPassword.test.js` and
|
||||
`tests/backNavigation.test.js` drive each path.
|
||||
|
||||
- 2026-10-07: `script/discard-dist-on-failure` returns the failed step's own
|
||||
exit status even when it cannot write its message, to a closed stderr or to a
|
||||
pipe nobody reads any more
|
||||
([#342](https://git.eeqj.de/sneak/AutistMask/issues/342)); it used to return 2
|
||||
or 141 instead. An interrupt while a step runs now removes nothing and says
|
||||
nothing whichever shell `/bin/sh` is, even when the step catches it and exits
|
||||
with a status of its own, as `script/check-censored` does: the wrapper exits
|
||||
with 130 once the step has ended. Under bash such a step used to have `dist/`
|
||||
removed. A failed `check-censored --require-dist` still removes `dist/` like
|
||||
any other step, because a `dist/` not cleared of the name `RULES.md` bars must
|
||||
not ship. The header states both. `script/test-verify-build` runs the wrapper
|
||||
with stderr closed and with stderr a pipe nobody reads, and interrupts it
|
||||
under dash and under bash.
|
||||
|
||||
- 2026-10-06: Back from Settings no longer lands on the delete wallet or
|
||||
lost-password screen after either was left by the settings gear
|
||||
([#480](https://git.eeqj.de/sneak/AutistMask/issues/480)), the defect
|
||||
[#461](https://git.eeqj.de/sneak/AutistMask/issues/461) fixed for the two
|
||||
secret screens. Leaving drops the screen's wallet selection, so its leave
|
||||
handler now also takes it off the Back stack, as a reopened popup already
|
||||
does. `tests/deleteWalletLostPassword.test.js` drives the gear and then Back
|
||||
on both screens.
|
||||
|
||||
- 2026-10-06: `script/bootstrap` no longer reports success while node cannot
|
||||
find a package listed in `dependencies` or `devDependencies` of `package.json`
|
||||
([#263](https://git.eeqj.de/sneak/AutistMask/issues/263)). After the install
|
||||
it asks node for each one's `package.json`, and fails naming the missing
|
||||
package and the fix. yarn skips the install whenever
|
||||
`node_modules/.yarn-integrity` matches `yarn.lock`, so a package deleted from
|
||||
`node_modules` stayed deleted while bootstrap said it was complete. The
|
||||
fresh-clone failure the issue reports did not reproduce.
|
||||
|
||||
- 2026-10-06: Back from Settings no longer lands on the private key export or
|
||||
recovery phrase screen after either was left by the settings gear
|
||||
([#461](https://git.eeqj.de/sneak/AutistMask/issues/461)). Leaving drops the
|
||||
screen's selection, so its leave handler now also takes it off the Back stack,
|
||||
as a reopened popup already does. `tests/exportPrivkey.test.js` and
|
||||
`tests/showPhrase.test.js` drive the gear and then Back, and
|
||||
`leavePrivkeyScreen()` in `tests/e2e/run.js` expects the address screen after
|
||||
Settings.
|
||||
|
||||
- 2026-10-06: A token symbol or name read off a contract is no longer stored cut
|
||||
between the two halves of an emoji
|
||||
([#458](https://git.eeqj.de/sneak/AutistMask/issues/458)). `lookupTokenInfo()`
|
||||
@@ -1782,6 +1976,3 @@ but the review is broader than any of them.
|
||||
|
||||
Only work that has no issue of its own belongs here; everything else is on the
|
||||
tracker.
|
||||
|
||||
- Cut 1.0.0 once the milestone is empty, then continue tagging as milestones
|
||||
land.
|
||||
|
||||
@@ -588,15 +588,10 @@ async function build() {
|
||||
copyIcons(distDir);
|
||||
}
|
||||
|
||||
// copy manifests
|
||||
copyEmitted(
|
||||
path.join(__dirname, "manifest", "chrome.json"),
|
||||
path.join(DIST_CHROME, "manifest.json"),
|
||||
);
|
||||
copyEmitted(
|
||||
path.join(__dirname, "manifest", "firefox.json"),
|
||||
path.join(DIST_FIREFOX, "manifest.json"),
|
||||
);
|
||||
// copy manifests, the same files copyIcons() read
|
||||
for (const [distDir, manifestPath] of MANIFEST_SOURCES) {
|
||||
copyEmitted(manifestPath, path.join(distDir, "manifest.json"));
|
||||
}
|
||||
|
||||
assertForbiddenTableCovered(forbiddenRecord);
|
||||
|
||||
|
||||
@@ -127,6 +127,40 @@ install_js_deps() {
|
||||
fi
|
||||
}
|
||||
|
||||
# run_node: run node from the repo root, through nvm when node is not on PATH;
|
||||
# the script comes on stdin
|
||||
run_node() {
|
||||
if missing node && [ -s "$HOME/.nvm/nvm.sh" ]; then
|
||||
nvm_sh "nvm use $NODE_VERSION >/dev/null && cd \"$ROOT\" && node"
|
||||
else
|
||||
node
|
||||
fi
|
||||
}
|
||||
|
||||
# yarn install exits 0 without touching node_modules once
|
||||
# node_modules/.yarn-integrity matches yarn.lock, so a package deleted from
|
||||
# node_modules stays deleted. Fail unless node finds every package listed in
|
||||
# dependencies and devDependencies of package.json, by its package.json. When a
|
||||
# package's exports does not list that file, node throws
|
||||
# ERR_PACKAGE_PATH_NOT_EXPORTED, which it can only do once it has found the
|
||||
# package, so that error counts as found.
|
||||
check_js_deps() {
|
||||
run_node <<'EOF'
|
||||
const { dependencies, devDependencies } = require("./package.json");
|
||||
for (const name of Object.keys({ ...dependencies, ...devDependencies })) {
|
||||
try {
|
||||
require.resolve(name + "/package.json");
|
||||
} catch (e) {
|
||||
if (e.code !== "ERR_PACKAGE_PATH_NOT_EXPORTED") {
|
||||
console.error(`bootstrap: node cannot find ${name} after yarn install`);
|
||||
console.error(" fix: rm -rf node_modules && make bootstrap");
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
}
|
||||
EOF
|
||||
}
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
|
||||
@@ -136,6 +170,7 @@ main() {
|
||||
ensure_node
|
||||
ensure_yarn
|
||||
install_js_deps
|
||||
check_js_deps
|
||||
|
||||
echo "bootstrap complete"
|
||||
}
|
||||
|
||||
@@ -18,6 +18,8 @@
|
||||
# (src/shared/balances.js), and this contract's on-chain name is that
|
||||
# string, so censoring the repo cannot stop the wallet displaying it.
|
||||
# Dropping the entry instead would cost the user MUSD spoof detection.
|
||||
# script/lib/token-enrichment.json, the fetched data tokenList.js's names
|
||||
# are written from, carries the same name for the same reason.
|
||||
#
|
||||
# Everything else fails, in the working tree and under dist/. The last two are
|
||||
# literals rather than whole files, so they are enforced by counting, and each
|
||||
@@ -102,8 +104,8 @@ allowed_literals_for() {
|
||||
src/content/inpage.js | dist/*/src/content/inpage.js)
|
||||
printf 'is%s\n_%s\n' "$NAME" "$NAME" >"$ALLOWED_LITERALS_FILE"
|
||||
;;
|
||||
src/shared/tokenList.js | dist/*/src/background/index.js | \
|
||||
dist/*/src/popup/index.js)
|
||||
src/shared/tokenList.js | script/lib/token-enrichment.json | \
|
||||
dist/*/src/background/index.js | dist/*/src/popup/index.js)
|
||||
printf '%s USD\n' "$NAME" >"$ALLOWED_LITERALS_FILE"
|
||||
;;
|
||||
esac
|
||||
|
||||
@@ -3,22 +3,21 @@
|
||||
# step fails, remove dist/ before returning its exit status. Our own extension
|
||||
# to scripts-to-rule-them-all, wrapped around every step of make build.
|
||||
#
|
||||
# Why: with AUTISTMASK_DEBUG=1 exported in the calling shell, make build
|
||||
# compiles a debug bundle and then fails on it in script/verify-build — but the
|
||||
# bundle is already written. It is loadable, and every wallet it creates gets
|
||||
# the publicly committed test recovery phrase from src/shared/constants.js. A
|
||||
# failed release build that leaves that behind is a smaller version of the trap
|
||||
# the verifier exists to close, and "the failure was loud" only works on an
|
||||
# operator who does not load dist/chrome/ anyway. Removing the artifact does not
|
||||
# depend on that.
|
||||
# Why: with AUTISTMASK_DEBUG=1 exported, make build compiles a debug bundle and
|
||||
# then fails on it in script/verify-build, after the bundle is written. It is
|
||||
# loadable, and every wallet it creates gets the publicly committed test
|
||||
# recovery phrase from src/shared/constants.js, so a failed build must not leave
|
||||
# it behind. The removal is never silent: it says on stderr that dist/ is gone
|
||||
# and why.
|
||||
#
|
||||
# Two things this deliberately does not do. It does not wrap make build-debug: a
|
||||
# debug build that failed is not a mistakable artifact, and its output is the
|
||||
# evidence of what went wrong. And it never removes anything on a step that
|
||||
# SUCCEEDS, including the final check-censored --require-dist pass.
|
||||
#
|
||||
# The removal is never silent: it says dist/ is gone and why, on stderr, above
|
||||
# the build's own failure.
|
||||
# A failed check-censored --require-dist removes dist/ like any other step: a
|
||||
# dist/ not cleared of the name RULES.md bars must not ship either. A step that
|
||||
# succeeds removes nothing. An interrupt (Ctrl-C) while a step runs removes
|
||||
# nothing and says nothing, even when the step catches it and exits with a
|
||||
# status of its own: the wrapper exits with 130 once the step has ended. An
|
||||
# interrupt is not a build failure, and whoever interrupted the build knows it
|
||||
# did not finish. make build-debug is not wrapped: a debug build that failed is
|
||||
# not a mistakable artifact, and its output is the evidence of what went wrong.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
@@ -66,12 +65,20 @@ main() {
|
||||
exit 1
|
||||
}
|
||||
|
||||
# An interrupt is not a build failure: once the step has ended, exit
|
||||
# without removing anything, even if the step caught the interrupt and
|
||||
# exited with a status of its own. bash as /bin/sh would otherwise carry on.
|
||||
trap 'exit 130' INT
|
||||
|
||||
_status=0
|
||||
"$@" || _status=$?
|
||||
|
||||
[ "$_status" -ne 0 ] || return 0
|
||||
|
||||
discard_dist
|
||||
# A message that cannot be written, to a closed stderr or to a pipe nobody
|
||||
# reads any more, must not replace the step's status.
|
||||
trap '' PIPE
|
||||
discard_dist || true
|
||||
exit "$_status"
|
||||
}
|
||||
|
||||
|
||||
@@ -25,6 +25,13 @@ run_yarn() {
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
# Without the repo's own prettier, yarn runs whatever prettier is on
|
||||
# the PATH, which may be a version that formats files differently.
|
||||
if [ ! -x node_modules/.bin/prettier ]; then
|
||||
echo "fmt: this repo's prettier is not installed in node_modules/," \
|
||||
"so run script/bootstrap first." >&2
|
||||
exit 1
|
||||
fi
|
||||
echo "Formatting..."
|
||||
run_yarn run fmt
|
||||
}
|
||||
|
||||
@@ -26,6 +26,13 @@ run_yarn() {
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
# Without the repo's own prettier, yarn runs whatever prettier is on
|
||||
# the PATH, which may be a version that formats files differently.
|
||||
if [ ! -x node_modules/.bin/prettier ]; then
|
||||
echo "fmt-check: this repo's prettier is not installed in" \
|
||||
"node_modules/, so run script/bootstrap first." >&2
|
||||
exit 1
|
||||
fi
|
||||
echo "Checking formatting..."
|
||||
run_yarn run fmt-check
|
||||
}
|
||||
|
||||
@@ -0,0 +1,159 @@
|
||||
// Writes the names and URLs in script/lib/token-enrichment.json, which
|
||||
// script/lib/enrich-tokens.js fetches, into the matching entries of
|
||||
// src/shared/tokenList.js: the name and url an entry already has are replaced,
|
||||
// and an entry without them gets them after its decimals. Where the fetched
|
||||
// data has no URL for a token, EXTRA_URLS below supplies one. An entry the data
|
||||
// does not mention is left as it is. An address in the data or in EXTRA_URLS
|
||||
// that matches no entry in tokenList.js, capitals included, is an error naming
|
||||
// that address. Run by
|
||||
// `make apply-enrichment`; no build runs it. tests/applyEnrichment.test.js
|
||||
// checks that the committed tokenList.js is exactly what this writes from the
|
||||
// committed data.
|
||||
|
||||
"use strict";
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
|
||||
const TOKEN_LIST = path.join(__dirname, "..", "..", "src/shared/tokenList.js");
|
||||
|
||||
// Project websites by token address, each spelled as tokenList.js spells it. A
|
||||
// token gets its URL here only where the fetched data has none, so an address
|
||||
// the data has a URL for is never used.
|
||||
const EXTRA_URLS = {
|
||||
"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2": "https://weth.io",
|
||||
"0xdAC17F958D2ee523a2206206994597C13D831ec7": "https://tether.to",
|
||||
"0xB8c77482e45F1F44dE1745F52C74426C631bDD52": "https://www.bnbchain.org",
|
||||
"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48": "https://www.circle.com/usdc",
|
||||
"0xdC035D45d973E3EC169d2276DDab16f1e407384F": "https://sky.money",
|
||||
"0x2AF5D2aD76741191D15Dfe7bF6aC92d4Bd912Ca3": "https://www.bitfinex.com",
|
||||
"0x514910771AF9Ca656af840dff83E8264EcF986CA": "https://chain.link",
|
||||
"0x4c9EDD5852cd905f086C759E8383e09bff1E68B3": "https://ethena.fi",
|
||||
"0x8d0D000Ee44948FC98c9B98A4FA4921476f08B0d":
|
||||
"https://www.worldlibertyfinancial.com",
|
||||
"0x6B175474E89094C44Da98b954EedeAC495271d0F": "https://makerdao.com",
|
||||
"0x6c3ea9036406852006290770BEdFcAbA0e23A0e8":
|
||||
"https://www.paypal.com/us/digital-wallet/manage-money/crypto/pyusd",
|
||||
"0x95aD61b0a150d79219dCF64E1E6Cc01f0B64C4cE": "https://shibatoken.com",
|
||||
"0xdA5e1988097297dCdc1f90D4dFE7909e847CBeF6":
|
||||
"https://www.worldlibertyfinancial.com",
|
||||
"0xA0b73E1Ff0B80914AB6fe0444E65848C4C34450b": "https://crypto.com",
|
||||
"0x582d872A1B094FC48F5DE31D3B73F2D9bE47def1": "https://ton.org",
|
||||
"0x68749665FF8D2d112Fa859AA293F07A622782F38": "https://gold.tether.to",
|
||||
"0x196C20DA81Fbc324EcdF55501e95Ce9f0bD84d14": "https://polkadot.network",
|
||||
"0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984": "https://uniswap.org",
|
||||
"0x45804880De22913dAFE09f4980848ECE6EcbAf78":
|
||||
"https://www.paxos.com/paxgold",
|
||||
"0x3c3a81e81dc49A522A592e7622A7E711c06bf354": "https://www.mantle.xyz",
|
||||
"0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9": "https://aave.com",
|
||||
"0x75231F58b43240C9718Dd58B4967c5114342a86c": "https://www.okx.com",
|
||||
"0x6982508145454Ce325dDbE47a25d4ec3d2311933": "https://www.pepe.vip",
|
||||
"0x5A98FcBEA516Cf06857215779Fd812CA3beF1B32": "https://lido.fi",
|
||||
"0xC18360217D8F7Ab5e7c516566761Ea12Ce7F9D72": "https://ens.domains",
|
||||
"0xD533a949740bb3306d119CC777fa900bA034cd52": "https://curve.fi",
|
||||
"0x111111111117dC0aa78b770fA6A738034120C302": "https://1inch.io",
|
||||
"0x163f8C2467924be0ae7B5347228CABF260318753": "https://worldcoin.org",
|
||||
"0xC011a73ee8576Fb46F5E1c5751cA3B9Fe0af2a6F": "https://synthetix.io",
|
||||
"0xBBbbCA6A901c926F240b89EacB641d8Aec7AEafD": "https://loopring.org",
|
||||
"0xC669928185DbCE49d2230CC9B0979BE6DC797957": "https://bitstable.finance",
|
||||
"0xfAbA6f8e4a5E8Ab82F62fe7C39859FA577269BE3": "https://ondo.finance",
|
||||
"0x6De037ef9aD2725EB40118Bb1702EBb27e4Aeb24": "https://www.render.com",
|
||||
"0x4a220E6096B25EADb88358cb44068A3248254675": "https://www.quant.network",
|
||||
"0xba5BDe662c17e2aDFF1075610382B9B691296350": "https://superrare.com",
|
||||
"0xc00e94Cb662C3520282E6f5717214004A7f26888": "https://compound.finance",
|
||||
"0xE41d2489571d322189246DaFA5ebDe1F4699F498": "https://0x.org",
|
||||
"0x0bc529c00C6401aEF6D220BE8C6Ea1667F6Ad93e": "https://yearn.fi",
|
||||
"0x6fB3e0A217407EFFf7Ca062D46c26E5d60a14d69": "https://iotex.io",
|
||||
"0xF57e7e7C23978C3cAEC3C3548E3D615c346e79fF": "https://immutable.com",
|
||||
"0x0F5D2fB29fb7d3CFeE444a200298f468908cC942": "https://decentraland.org",
|
||||
"0x3845badAde8e6dFF049820680d1F14bD3903a5d0": "https://www.sandbox.game",
|
||||
"0x6810e776880C02933D47DB1b9fc05908e5386b96": "https://gnosis.io",
|
||||
"0x5f98805A4E8be255a32880FDeC7F6728C6568bA0": "https://www.liquity.org",
|
||||
"0x0D8775F648430679A709E98d2b0Cb6250d2887EF":
|
||||
"https://basicattentiontoken.org",
|
||||
"0xc944E90C64B2c07662A292be6244BDf05Cda44a7": "https://thegraph.com",
|
||||
"0x853d955aCEf822Db058eb8505911ED77F175b99e": "https://frax.finance",
|
||||
"0x0000000000085d4780B73119b644AE5ecd22b376": "https://www.trueusd.com",
|
||||
"0x3432B6A60D23Ca0dFCa7761B7ab56459D9C964D0": "https://frax.finance",
|
||||
"0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E": "https://curve.fi",
|
||||
"0x808507121B80c02388fAd14726482e061B8da827": "https://pendle.finance",
|
||||
"0xCa14007Eff0dB1f8135f4C25B34De49AB0d42766": "https://starknet.io",
|
||||
"0x8457CA5040ad67fdebbCC8EdCE889A335Bc0fbFB": "https://alt.layer",
|
||||
"0xB50721BCf8d664c30412Cfbc6cf7a15145234ad1": "https://arbitrum.io",
|
||||
"0x6985884C4392D348587B19cb9eAAf157F13271cd": "https://layerzero.network",
|
||||
"0xFe0c30065B384F05761f15d0CC899D4F9F9Cc0eB": "https://ethfi.org",
|
||||
"0x5283D291DBCF85356A21bA090E6db59121208b44": "https://blur.io",
|
||||
"0x43Dfc4159D86F3A37A5A4B3D4580b888ad7d4DDd": "https://dydx.exchange",
|
||||
"0xcf0C122c6b73ff809C693DB761e7BaeBe62b6a2E": "https://floki.com",
|
||||
"0xe53EC727dbDEB9E2d5456c3be40cFF031AB40A55": "https://superfarm.com",
|
||||
"0x32353A6C91143bfd6C7d363B546e62a9A2489A20": "https://www.agora.finance",
|
||||
"0x1aBaEA1f7C830bD89Acc67eC4af516284b1bC33c": "https://www.euro-coin.com",
|
||||
"0xA35923162C49cF95e6BF26623385eb431ad920D3": "https://www.turbo-eth.com",
|
||||
"0x1151CB3d861920e07a38e03eEAd12C32178567F6": "https://bonk.com",
|
||||
"0x090185f2135308BaD17527004364eBcC2D37e5F6": "https://spell.club",
|
||||
"0xAf5191B0De278C7286d6C7CC6ab6BB8A73bA2Cd6": "https://stargate.finance",
|
||||
};
|
||||
|
||||
// Returns tokenList, the text of tokenList.js, with the name and url of each
|
||||
// token in enrichment, the parsed data file, written into its entry.
|
||||
function applyEnrichment(tokenList, enrichment) {
|
||||
for (const addr of Object.keys(EXTRA_URLS)) {
|
||||
if (!tokenList.includes(`address: "${addr}"`)) {
|
||||
throw new Error(
|
||||
`No entry in src/shared/tokenList.js has the address ${addr} from EXTRA_URLS.`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
let result = tokenList;
|
||||
|
||||
for (const [addr, data] of Object.entries(enrichment)) {
|
||||
// Escape special regex characters in the address
|
||||
const escaped = addr.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||
|
||||
// Match the token block: { address: "...", symbol: "...", decimals: N, }
|
||||
// and the name: "...", url: "..." after decimals when it has them.
|
||||
// The closing }, may have trailing whitespace
|
||||
const blockRe = new RegExp(
|
||||
`(\\{\\s*address:\\s*"${escaped}",\\s*symbol:\\s*"[^"]+",\\s*decimals:\\s*\\d+)` +
|
||||
`(?:,\\s*name:\\s*"(?:[^"\\\\]|\\\\.)*",\\s*url:\\s*"(?:[^"\\\\]|\\\\.)*")?` +
|
||||
`,?(\\s*\\})`,
|
||||
);
|
||||
|
||||
const match = result.match(blockRe);
|
||||
if (!match) {
|
||||
throw new Error(
|
||||
`No entry in src/shared/tokenList.js matches the address ${addr} from script/lib/token-enrichment.json.`,
|
||||
);
|
||||
}
|
||||
|
||||
// A URL from EXTRA_URLS only where the fetched data has none.
|
||||
const url = data.url || EXTRA_URLS[addr] || "";
|
||||
|
||||
// Build replacement: original fields + name + url
|
||||
const nameEscaped = data.name
|
||||
.replace(/\\/g, "\\\\")
|
||||
.replace(/"/g, '\\"');
|
||||
const urlEscaped = url.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
|
||||
const replacement =
|
||||
match[1] +
|
||||
`,\n name: "${nameEscaped}",` +
|
||||
`\n url: "${urlEscaped}",` +
|
||||
match[2];
|
||||
|
||||
// A function, so a "$" in a name is not read as a replacement pattern.
|
||||
result = result.replace(blockRe, () => replacement);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
if (require.main === module) {
|
||||
const enrichment = JSON.parse(
|
||||
fs.readFileSync(path.join(__dirname, "token-enrichment.json"), "utf8"),
|
||||
);
|
||||
const original = fs.readFileSync(TOKEN_LIST, "utf8");
|
||||
fs.writeFileSync(TOKEN_LIST, applyEnrichment(original, enrichment));
|
||||
}
|
||||
|
||||
module.exports = { applyEnrichment };
|
||||
@@ -0,0 +1,115 @@
|
||||
// Fetches a name and a website for every token in src/shared/tokenList.js and
|
||||
// writes them, keyed by address, to script/lib/token-enrichment.json, which
|
||||
// script/lib/apply-enrichment.js then writes into tokenList.js. Run by
|
||||
// `make enrich-tokens`; no build runs it and nothing here is shipped.
|
||||
//
|
||||
// Names come from CoinGecko's coin list, fetched whole in one request, matched
|
||||
// on the token's Ethereum contract address. A token CoinGecko does not list
|
||||
// gets its symbol as its name. The list is live data with no fixed version, so
|
||||
// a later run can return different names.
|
||||
//
|
||||
// Websites come from the ethereum-lists/tokens repository, one file per token,
|
||||
// read at a pinned commit. Most tokens have no file there and get an empty URL.
|
||||
// A file that is missing is not an error; any other failed request stops the
|
||||
// run, so a network fault cannot quietly empty a URL.
|
||||
|
||||
"use strict";
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
|
||||
const TOKEN_LIST = path.join(__dirname, "..", "..", "src/shared/tokenList.js");
|
||||
const OUTPUT = path.join(__dirname, "token-enrichment.json");
|
||||
|
||||
const COINGECKO_LIST =
|
||||
"https://api.coingecko.com/api/v3/coins/list?include_platform=true";
|
||||
// ethereum-lists/tokens at its master of 2026-02-27, when the committed
|
||||
// token-enrichment.json was made.
|
||||
const ETHEREUM_LISTS =
|
||||
"https://raw.githubusercontent.com/ethereum-lists/tokens/c3560d499a380a38e94caa7c4968d59aeffde59a/tokens/eth";
|
||||
|
||||
const CONCURRENT = 10;
|
||||
|
||||
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
|
||||
|
||||
async function main() {
|
||||
const src = fs.readFileSync(TOKEN_LIST, "utf8");
|
||||
|
||||
const tokens = [];
|
||||
const re =
|
||||
/\{\s*address:\s*"(0x[a-fA-F0-9]{40})",\s*symbol:\s*"([^"]+)",\s*decimals:\s*(\d+)/g;
|
||||
let m;
|
||||
while ((m = re.exec(src)) !== null) {
|
||||
tokens.push({ address: m[1], symbol: m[2], decimals: parseInt(m[3]) });
|
||||
}
|
||||
console.error(`Parsed ${tokens.length} tokens`);
|
||||
|
||||
// --- Names from CoinGecko ---
|
||||
console.error("Fetching CoinGecko coins list...");
|
||||
const listResp = await fetch(COINGECKO_LIST);
|
||||
if (!listResp.ok) throw new Error(`CoinGecko list HTTP ${listResp.status}`);
|
||||
const coins = await listResp.json();
|
||||
|
||||
const addrMap = new Map();
|
||||
for (const coin of coins) {
|
||||
const eth = (coin.platforms?.ethereum || "").toLowerCase().trim();
|
||||
if (eth && eth.startsWith("0x")) {
|
||||
addrMap.set(eth, { name: coin.name, id: coin.id });
|
||||
}
|
||||
}
|
||||
console.error(`CoinGecko map: ${addrMap.size} Ethereum tokens`);
|
||||
|
||||
const enriched = new Map();
|
||||
let namesMatched = 0;
|
||||
for (const t of tokens) {
|
||||
const info = addrMap.get(t.address.toLowerCase());
|
||||
if (info) namesMatched++;
|
||||
enriched.set(t.address, { name: info?.name || t.symbol, url: "" });
|
||||
}
|
||||
console.error(`Matched ${namesMatched}/${tokens.length} names`);
|
||||
|
||||
// --- Websites from ethereum-lists ---
|
||||
console.error("Fetching URLs from ethereum-lists GitHub...");
|
||||
let urlsFound = 0;
|
||||
|
||||
for (let i = 0; i < tokens.length; i += CONCURRENT) {
|
||||
const batch = tokens.slice(i, i + CONCURRENT);
|
||||
await Promise.all(
|
||||
batch.map(async (t) => {
|
||||
const r = await fetch(`${ETHEREUM_LISTS}/${t.address}.json`);
|
||||
if (r.status === 404) return;
|
||||
if (!r.ok) {
|
||||
throw new Error(
|
||||
`ethereum-lists HTTP ${r.status} for ${t.address}`,
|
||||
);
|
||||
}
|
||||
const data = await r.json();
|
||||
const website = (data.website || "").trim();
|
||||
if (website && website !== "https://") {
|
||||
enriched.get(t.address).url = website;
|
||||
urlsFound++;
|
||||
}
|
||||
}),
|
||||
);
|
||||
if (i % 100 === 0) {
|
||||
console.error(
|
||||
` GitHub: ${Math.min(i + CONCURRENT, tokens.length)}/${tokens.length}, ${urlsFound} URLs`,
|
||||
);
|
||||
}
|
||||
await sleep(200);
|
||||
}
|
||||
console.error(`Found ${urlsFound} URLs in ethereum-lists`);
|
||||
|
||||
// --- Output, in the layout prettier gives it ---
|
||||
const output = {};
|
||||
for (const [addr, e] of enriched) {
|
||||
output[addr] = { name: e.name, url: e.url };
|
||||
}
|
||||
fs.writeFileSync(OUTPUT, JSON.stringify(output, null, 4) + "\n");
|
||||
console.error(`Done! ${tokens.length} names, ${urlsFound} URLs.`);
|
||||
}
|
||||
|
||||
main().catch((err) => {
|
||||
console.error(`enrich-tokens: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,203 @@
|
||||
// Draws the toolbar icon and writes it to every file manifest/chrome.json
|
||||
// declares under "icons". Run by `make icons`; tests/icons.test.js checks that
|
||||
// the committed files hold exactly the image this draws.
|
||||
//
|
||||
// The icon is a dark-navy rounded square carrying a teal triangle with a
|
||||
// smaller triangle cut out of it. Every coordinate below is a fraction of the
|
||||
// icon's side, so one drawing serves every size. A pixel's colour is the
|
||||
// average of an 8x8 grid of samples, one at the centre of each cell, which
|
||||
// smooths the edges.
|
||||
//
|
||||
// The PNG is written here rather than by a library: RGBA at 8 bits per
|
||||
// channel, filter type 0 (none) on every row, one IDAT chunk compressed by
|
||||
// node's zlib at level 9. The committed files were compressed by stock zlib,
|
||||
// which node's bundled zlib does not reproduce byte for byte, so the image is
|
||||
// compared rather than the file: the IHDR and every pixel.
|
||||
|
||||
"use strict";
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const zlib = require("zlib");
|
||||
|
||||
const { icons } = require("../../manifest/chrome.json");
|
||||
|
||||
const NAVY = [0x10, 0x1a, 0x2e];
|
||||
const TEAL = [0x35, 0xe0, 0xc2];
|
||||
const CORNER_RADIUS = 0.22;
|
||||
const OUTER_TRIANGLE = [
|
||||
[0.5, 0.15],
|
||||
[0.115, 0.855],
|
||||
[0.885, 0.855],
|
||||
];
|
||||
const INNER_TRIANGLE = [
|
||||
[0.5, 0.4],
|
||||
[0.29, 0.7],
|
||||
[0.71, 0.7],
|
||||
];
|
||||
const SAMPLES_PER_SIDE = 8;
|
||||
|
||||
const PNG_SIGNATURE = Buffer.from([
|
||||
0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a,
|
||||
]);
|
||||
|
||||
// Points are in pixels from the icon's top-left corner.
|
||||
function insideRoundedSquare(x, y, size) {
|
||||
const r = CORNER_RADIUS * size;
|
||||
// How far the point is past the start of a corner's curve, on each axis.
|
||||
const dx = Math.max(r - x, 0, x - (size - r));
|
||||
const dy = Math.max(r - y, 0, y - (size - r));
|
||||
return dx * dx + dy * dy <= r * r;
|
||||
}
|
||||
|
||||
// Inside or on an edge: the point is not on opposite sides of two edges.
|
||||
function insideTriangle(x, y, [a, b, c]) {
|
||||
const side = (p, q) =>
|
||||
(q[0] - p[0]) * (y - p[1]) - (q[1] - p[1]) * (x - p[0]);
|
||||
const sides = [side(a, b), side(b, c), side(c, a)];
|
||||
return !(sides.some((s) => s < 0) && sides.some((s) => s > 0));
|
||||
}
|
||||
|
||||
// Rounds to the nearest integer and a half to the even neighbour, as the
|
||||
// committed icons were made. Math.round takes a half up, which would change
|
||||
// some pixels by one.
|
||||
function roundHalfToEven(v) {
|
||||
const down = Math.floor(v);
|
||||
if (v - down !== 0.5) {
|
||||
return Math.round(v);
|
||||
}
|
||||
return down % 2 === 0 ? down : down + 1;
|
||||
}
|
||||
|
||||
// The RGBA bytes of the pixel whose top-left corner is (px, py).
|
||||
function pixel(px, py, size, outer, inner) {
|
||||
let inSquare = 0;
|
||||
let inTeal = 0;
|
||||
for (let j = 0; j < SAMPLES_PER_SIDE; j++) {
|
||||
const y = py + (j + 0.5) / SAMPLES_PER_SIDE;
|
||||
for (let i = 0; i < SAMPLES_PER_SIDE; i++) {
|
||||
const x = px + (i + 0.5) / SAMPLES_PER_SIDE;
|
||||
if (!insideRoundedSquare(x, y, size)) {
|
||||
continue;
|
||||
}
|
||||
inSquare++;
|
||||
if (insideTriangle(x, y, outer) && !insideTriangle(x, y, inner)) {
|
||||
inTeal++;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (inSquare === 0) {
|
||||
return [0, 0, 0, 0];
|
||||
}
|
||||
const colour = NAVY.map((navy, k) =>
|
||||
roundHalfToEven(navy + ((TEAL[k] - navy) * inTeal) / inSquare),
|
||||
);
|
||||
const alpha = roundHalfToEven((255 * inSquare) / SAMPLES_PER_SIDE ** 2);
|
||||
return [...colour, alpha];
|
||||
}
|
||||
|
||||
// A PNG chunk: the data's length, the type, the data, then the CRC-32 of the
|
||||
// type and the data.
|
||||
function chunk(type, data) {
|
||||
const typeAndData = Buffer.concat([Buffer.from(type, "ascii"), data]);
|
||||
const length = Buffer.alloc(4);
|
||||
length.writeUInt32BE(data.length);
|
||||
const crc = Buffer.alloc(4);
|
||||
crc.writeUInt32BE(zlib.crc32(typeAndData));
|
||||
return Buffer.concat([length, typeAndData, crc]);
|
||||
}
|
||||
|
||||
// The complete PNG file for the icon at `size` pixels square.
|
||||
function drawIcon(size) {
|
||||
const toPixels = (corners) => corners.map(([x, y]) => [x * size, y * size]);
|
||||
const outer = toPixels(OUTER_TRIANGLE);
|
||||
const inner = toPixels(INNER_TRIANGLE);
|
||||
|
||||
const rows = [];
|
||||
for (let py = 0; py < size; py++) {
|
||||
const row = [0]; // filter type 0: the row's bytes are stored as they are
|
||||
for (let px = 0; px < size; px++) {
|
||||
row.push(...pixel(px, py, size, outer, inner));
|
||||
}
|
||||
rows.push(Buffer.from(row));
|
||||
}
|
||||
|
||||
const header = Buffer.alloc(13); // compression, filter, interlace: all 0
|
||||
header.writeUInt32BE(size, 0); // width
|
||||
header.writeUInt32BE(size, 4); // height
|
||||
header[8] = 8; // bits per channel
|
||||
header[9] = 6; // colour type: RGBA
|
||||
|
||||
return Buffer.concat([
|
||||
PNG_SIGNATURE,
|
||||
chunk("IHDR", header),
|
||||
chunk("IDAT", zlib.deflateSync(Buffer.concat(rows), { level: 9 })),
|
||||
chunk("IEND", Buffer.alloc(0)),
|
||||
]);
|
||||
}
|
||||
|
||||
// The image in a PNG: its IHDR data, and its rows after decompression, each
|
||||
// row's filter type byte first. With filter type 0 on every row, as drawIcon
|
||||
// writes, the rows are the pixels themselves; a file using another filter does
|
||||
// not match even where its pixels do. Refuses a file that is not a PNG, a chunk
|
||||
// whose CRC-32 is wrong, and any chunk but IHDR, IDAT and IEND, rather than
|
||||
// ignoring what it cannot compare.
|
||||
function decodePng(png) {
|
||||
if (!png.subarray(0, 8).equals(PNG_SIGNATURE)) {
|
||||
throw new Error("not a PNG");
|
||||
}
|
||||
let header = null;
|
||||
const idat = [];
|
||||
for (let pos = 8; pos < png.length; ) {
|
||||
const length = png.readUInt32BE(pos);
|
||||
const typeAndData = png.subarray(pos + 4, pos + 8 + length);
|
||||
const type = typeAndData.toString("ascii", 0, 4);
|
||||
if (zlib.crc32(typeAndData) !== png.readUInt32BE(pos + 8 + length)) {
|
||||
throw new Error(`the ${type} chunk fails its CRC-32`);
|
||||
}
|
||||
if (type === "IHDR") {
|
||||
header = typeAndData.subarray(4);
|
||||
} else if (type === "IDAT") {
|
||||
idat.push(typeAndData.subarray(4));
|
||||
} else if (type !== "IEND") {
|
||||
throw new Error(`unexpected ${type} chunk`);
|
||||
}
|
||||
pos += 12 + length;
|
||||
}
|
||||
if (header === null) {
|
||||
throw new Error("no IHDR chunk");
|
||||
}
|
||||
return { header, rows: zlib.inflateSync(Buffer.concat(idat)) };
|
||||
}
|
||||
|
||||
// True when `file` already holds the image in `png`. A file that is missing or
|
||||
// cannot be read as a PNG does not, and is written over.
|
||||
function holdsSameImage(file, png) {
|
||||
let existing;
|
||||
try {
|
||||
existing = decodePng(fs.readFileSync(file));
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
const drawn = decodePng(png);
|
||||
return (
|
||||
existing.header.equals(drawn.header) && existing.rows.equals(drawn.rows)
|
||||
);
|
||||
}
|
||||
|
||||
// A file already holding the drawn image is left alone, so running this does
|
||||
// not rewrite the committed icons with node's compression.
|
||||
if (require.main === module) {
|
||||
for (const [size, file] of Object.entries(icons)) {
|
||||
const target = path.join(__dirname, "..", "..", file);
|
||||
const png = drawIcon(Number(size));
|
||||
if (holdsSameImage(target, png)) {
|
||||
console.log(`icons: ${file} already holds this image`);
|
||||
continue;
|
||||
}
|
||||
fs.writeFileSync(target, png);
|
||||
console.log(`icons: wrote ${file}`);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { drawIcon, decodePng };
|
||||
File diff suppressed because it is too large
Load Diff
@@ -97,6 +97,18 @@ main() {
|
||||
-e HOME=/tmp \
|
||||
"$(cat "$IIDFILE")" \
|
||||
node tests/e2e/storagePartition.js
|
||||
|
||||
# Approvals left open for seven minutes in minimized windows, past the
|
||||
# point where Chrome stopped the background worker when nothing kept it
|
||||
# running. Its own program, without Playwright: Playwright keeps DevTools
|
||||
# attached to the worker, and Chrome never stops a worker DevTools is
|
||||
# attached to. It reaches nothing but its own loopback server.
|
||||
echo "Running the approvals left open for seven minutes..."
|
||||
docker run --rm \
|
||||
--ipc=host \
|
||||
-e HOME=/tmp \
|
||||
"$(cat "$IIDFILE")" \
|
||||
node tests/e2e/slowApproval.js
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
@@ -915,6 +915,76 @@ run_cases() {
|
||||
discard_case "the wrapper given no command removes nothing" \
|
||||
c_control 1 kept "no command given" ""
|
||||
|
||||
# With stderr closed the wrapper cannot write its message, and must still
|
||||
# remove dist/ and return the step's own status.
|
||||
build_fixture
|
||||
_status=0
|
||||
(cd "$FIXTURE" &&
|
||||
"$FIXTURE/script/discard-dist-on-failure" sh -c 'exit 6' 2>&-) ||
|
||||
_status=$?
|
||||
if [ "$_status" -eq 6 ] && [ ! -e "$FIXTURE/dist" ]; then
|
||||
PASSED=$((PASSED + 1))
|
||||
echo " ok: a failed step's status survives a closed stderr"
|
||||
else
|
||||
FAILED=$((FAILED + 1))
|
||||
echo " FAIL: a failed step's status survives a closed stderr"
|
||||
echo " exit status $_status, wanted 6, and dist/ must be gone"
|
||||
fi
|
||||
|
||||
# The same with stderr a pipe nobody reads any more, where the write would
|
||||
# kill the wrapper with SIGPIPE. The FIFO's only reader opens it, exits and
|
||||
# is waited for before the wrapper runs, so the pipe never has a reader.
|
||||
build_fixture
|
||||
mkfifo "$WORK/stderr-fifo"
|
||||
_status=0
|
||||
(
|
||||
: <"$WORK/stderr-fifo" &
|
||||
exec 3>"$WORK/stderr-fifo"
|
||||
wait "$!"
|
||||
cd "$FIXTURE" &&
|
||||
"$FIXTURE/script/discard-dist-on-failure" sh -c 'exit 6' 2>&3
|
||||
) || _status=$?
|
||||
if [ "$_status" -eq 6 ] && [ ! -e "$FIXTURE/dist" ]; then
|
||||
PASSED=$((PASSED + 1))
|
||||
echo " ok: a failed step's status survives a pipe nobody reads"
|
||||
else
|
||||
FAILED=$((FAILED + 1))
|
||||
echo " FAIL: a failed step's status survives a pipe nobody reads"
|
||||
echo " exit status $_status, wanted 6, and dist/ must be gone"
|
||||
fi
|
||||
|
||||
# An interrupt while a step runs removes nothing and says nothing, even
|
||||
# when the step catches it and exits with a status of its own, as
|
||||
# script/check-censored does. The step interrupts the wrapper and then
|
||||
# itself, as Ctrl-C interrupts every process of the build at once. Run
|
||||
# under dash and under bash, which /bin/sh may each be: bash carries on
|
||||
# after such a step unless the wrapper stops it.
|
||||
for _shell in dash bash; do
|
||||
_name="an interrupt under $_shell removes nothing"
|
||||
if ! command -v "$_shell" >/dev/null 2>&1; then
|
||||
SKIPPED=$((SKIPPED + 1))
|
||||
SKIPPED_NAMES="$SKIPPED_NAMES## - $_name ($_shell not found)$NEWLINE"
|
||||
echo " SKIP ($_shell not found): $_name"
|
||||
continue
|
||||
fi
|
||||
build_fixture
|
||||
_status=0
|
||||
_out="$(cd "$FIXTURE" && "$_shell" \
|
||||
"$FIXTURE/script/discard-dist-on-failure" \
|
||||
sh -c 'trap "exit 4" INT; kill -INT "$PPID" $$; exit 5' 2>&1)" ||
|
||||
_status=$?
|
||||
if [ "$_status" -eq 130 ] && [ -z "$_out" ] &&
|
||||
[ -f "$FIXTURE/dist/chrome/src/popup/index.js" ]; then
|
||||
PASSED=$((PASSED + 1))
|
||||
echo " ok: $_name"
|
||||
else
|
||||
FAILED=$((FAILED + 1))
|
||||
echo " FAIL: $_name"
|
||||
echo " exit status $_status, wanted 130; dist/ must be intact" \
|
||||
"and nothing said. Output: $_out"
|
||||
fi
|
||||
done
|
||||
|
||||
check_makefile_wiring
|
||||
}
|
||||
|
||||
|
||||
+133
-26
@@ -22,6 +22,7 @@ const { debugFetch, log } = require("../shared/log");
|
||||
const {
|
||||
verifySignedTx,
|
||||
verifySignature,
|
||||
typedDataChainRefusal,
|
||||
failureIsRetryable,
|
||||
describeTxFailure,
|
||||
sameAddress,
|
||||
@@ -43,6 +44,7 @@ const {
|
||||
|
||||
const {
|
||||
actionApi,
|
||||
getPlatformInfo,
|
||||
runtimeApi,
|
||||
tabsQuery,
|
||||
tabsSendMessage,
|
||||
@@ -66,6 +68,29 @@ const connectedSites = {};
|
||||
// Pending approval requests: { id: { origin, resolve } }
|
||||
const pendingApprovals = {};
|
||||
|
||||
// An approval, and the site's request waiting on it, exist only in this
|
||||
// worker's memory. Left alone, Chrome stopped the worker about six minutes
|
||||
// after the site's request while the user was still deciding, and the approval
|
||||
// was lost with it. Chrome counts an extension call as activity, so while any
|
||||
// approval is pending this worker makes one every 20 seconds, inside Chrome's
|
||||
// 30-second idle limit. Each function below that raises an approval starts the
|
||||
// timer, and it stops itself once nothing is pending. It is the worker's own
|
||||
// timer, so it runs whether or not the approval window is visible.
|
||||
let keepRunningTimer = null;
|
||||
|
||||
function keepRunningWhileApprovalsPending() {
|
||||
if (keepRunningTimer) return;
|
||||
keepRunningTimer = setInterval(() => {
|
||||
if (Object.keys(pendingApprovals).length === 0) {
|
||||
clearInterval(keepRunningTimer);
|
||||
keepRunningTimer = null;
|
||||
return;
|
||||
}
|
||||
// Only the call matters; its answer is not used.
|
||||
getPlatformInfo().catch(() => {});
|
||||
}, 20000);
|
||||
}
|
||||
|
||||
// One transaction approval at a time, wallet-wide.
|
||||
//
|
||||
// The transaction a site asks for is populated before its approval window
|
||||
@@ -137,11 +162,12 @@ function releaseTxApprovalSlotFor(approvalId) {
|
||||
}
|
||||
}
|
||||
|
||||
// One site-connection approval and one sign approval per site at a time: a
|
||||
// page that asks again before the user has answered is refused with the code
|
||||
// above instead of opening another window, so it cannot bury the user in
|
||||
// prompts. The pending approval itself holds the place, so a caller must test
|
||||
// this and raise its approval with nothing awaited in between.
|
||||
// One site-connection approval, one sign approval and one network-switch
|
||||
// approval per site at a time: a page that asks again before the user has
|
||||
// answered is refused with the code above instead of opening another window,
|
||||
// so it cannot bury the user in prompts. The pending approval itself holds the
|
||||
// place, so a caller must test this and raise its approval with nothing awaited
|
||||
// in between.
|
||||
function findPendingApproval(origin, type) {
|
||||
return Object.values(pendingApprovals).find(
|
||||
(approval) => approval.origin === origin && approval.type === type,
|
||||
@@ -348,8 +374,9 @@ function settleApproval(id, result, options) {
|
||||
|
||||
// What a pending approval resolves to when it is given up on rather than
|
||||
// answered: the window was closed, or could not be opened at all. A tx or sign
|
||||
// approval answers the requesting page in EIP-1193 shape; a site-connection
|
||||
// approval answers the connection handler in its own.
|
||||
// approval answers the requesting page in EIP-1193 shape; a site-connection or
|
||||
// network-switch approval answers its handler in the shape the popup's
|
||||
// decision has, as a refusal.
|
||||
function abandonedResult(approval, code, message) {
|
||||
if (approval.type === "tx" || approval.type === "sign") {
|
||||
return { error: { code, message } };
|
||||
@@ -512,6 +539,7 @@ function requestApproval(origin) {
|
||||
return new Promise((resolve) => {
|
||||
const id = crypto.randomUUID();
|
||||
pendingApprovals[id] = { id, origin, resolve, type: "site" };
|
||||
keepRunningWhileApprovalsPending();
|
||||
|
||||
if (actionNs && typeof actionNs.openPopup === "function") {
|
||||
showInToolbarPopup(id);
|
||||
@@ -563,6 +591,7 @@ function requestTxApproval(origin, approvedTx, approvedFrom, slot) {
|
||||
type: "tx",
|
||||
};
|
||||
if (slot) slot.approvalId = id;
|
||||
keepRunningWhileApprovalsPending();
|
||||
|
||||
openApprovalWindow(id);
|
||||
});
|
||||
@@ -583,6 +612,28 @@ function requestSignApproval(origin, signParams, approvedFrom) {
|
||||
resolve,
|
||||
type: "sign",
|
||||
};
|
||||
keepRunningWhileApprovalsPending();
|
||||
|
||||
openApprovalWindow(id);
|
||||
});
|
||||
}
|
||||
|
||||
// Open a network-switch approval popup and return a promise that resolves with
|
||||
// { approved }. Opened in a window, as tx and sign approvals are, because a
|
||||
// site's request is not a user gesture. The popup answers on the approval port,
|
||||
// as a site-connection approval does.
|
||||
function requestNetworkApproval(origin, currentNetworkId, requestedNetworkId) {
|
||||
return new Promise((resolve) => {
|
||||
const id = crypto.randomUUID();
|
||||
pendingApprovals[id] = {
|
||||
id,
|
||||
origin,
|
||||
currentNetworkId,
|
||||
requestedNetworkId,
|
||||
resolve,
|
||||
type: "network",
|
||||
};
|
||||
keepRunningWhileApprovalsPending();
|
||||
|
||||
openApprovalWindow(id);
|
||||
});
|
||||
@@ -597,8 +648,8 @@ function isExtensionSender(sender) {
|
||||
}
|
||||
|
||||
// The approval popup's port: it carries the user's decision on a
|
||||
// site-connection approval, and its disconnect is how that approval learns the
|
||||
// popup closed without one.
|
||||
// site-connection or network-switch approval, and its disconnect is how that
|
||||
// approval learns the popup closed without one.
|
||||
//
|
||||
// The decision travels this port rather than a one-off runtime.sendMessage()
|
||||
// for exactly one reason: the port is also what the popup's window.close()
|
||||
@@ -610,8 +661,9 @@ function isExtensionSender(sender) {
|
||||
// had refused.
|
||||
//
|
||||
// TX and sign approvals do not decide here. They stay pending across a
|
||||
// disconnect — the user can reopen the toolbar popup — and are rejected by the
|
||||
// windows.onRemoved listener below.
|
||||
// disconnect. When their window closes, the windows.onRemoved listener below
|
||||
// rejects them, unless an approved attempt is still running, in which case
|
||||
// that attempt answers the page.
|
||||
runtime.onConnect.addListener((port) => {
|
||||
if (port.name.startsWith("approval:")) {
|
||||
const id = port.name.split(":")[1];
|
||||
@@ -639,7 +691,9 @@ runtime.onConnect.addListener((port) => {
|
||||
const approval = pendingApprovals[id];
|
||||
if (approval) {
|
||||
if (approval.type === "tx" || approval.type === "sign") {
|
||||
// Keep pending — user can reopen the toolbar popup
|
||||
// When its window closes, windows.onRemoved rejects it,
|
||||
// unless an approved attempt is still running, in which
|
||||
// case that attempt answers the page.
|
||||
return;
|
||||
}
|
||||
settleApproval(id, { approved: false, remember: false });
|
||||
@@ -806,6 +860,10 @@ async function handleRpc(method, params, origin) {
|
||||
// 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.
|
||||
//
|
||||
// A connected site does not switch it either: only the user does,
|
||||
// by approving the request on the prompt below
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/408).
|
||||
const s = await getState();
|
||||
const activeAddress = activeAddressOf(s);
|
||||
const allowed = s.allowedSites[activeAddress] || [];
|
||||
@@ -827,6 +885,27 @@ async function handleRpc(method, params, origin) {
|
||||
}
|
||||
if (SUPPORTED_CHAIN_IDS.has(chainId)) {
|
||||
const target = networkByChainId(chainId);
|
||||
if (findPendingApproval(origin, "network")) {
|
||||
return {
|
||||
error: {
|
||||
code: APPROVAL_PENDING_CODE,
|
||||
message: APPROVAL_PENDING_MESSAGE,
|
||||
},
|
||||
};
|
||||
}
|
||||
const decision = await requestNetworkApproval(
|
||||
origin,
|
||||
s.networkId,
|
||||
target.id,
|
||||
);
|
||||
if (!decision.approved) {
|
||||
return {
|
||||
error: {
|
||||
code: APPROVAL_REJECTED_CODE,
|
||||
message: APPROVAL_REJECTED_MESSAGE,
|
||||
},
|
||||
};
|
||||
}
|
||||
// Read-modify-write against storage. The old path went through
|
||||
// onChainSwitch(), which mutates the singleton and then persists
|
||||
// every field of it — on an unloaded worker that wrote empty
|
||||
@@ -937,9 +1016,8 @@ async function handleRpc(method, params, origin) {
|
||||
|
||||
if (method === "eth_sign") {
|
||||
signParams.dangerWarning =
|
||||
"\u26a0\ufe0f DANGER: This site is requesting to sign a raw hash. " +
|
||||
"This can be used to sign transactions that drain your funds. " +
|
||||
"Only proceed if you fully understand what you are signing.";
|
||||
"This site used the older eth_sign method. " +
|
||||
"The data will be signed as a personal message.";
|
||||
}
|
||||
|
||||
if (findPendingApproval(origin, "sign")) {
|
||||
@@ -1345,20 +1423,21 @@ startBackgroundJobs();
|
||||
// which then fails retryably settles instead of waiting in a window that no
|
||||
// longer exists.
|
||||
//
|
||||
// A site-connection approval whose popup connected its port is not decided
|
||||
// here. That popup approves and closes in the same breath, and this event
|
||||
// races the decision on a channel of its own — the same race the port exists
|
||||
// to end. Its port disconnect says the same thing this event does, in an order
|
||||
// that is defined, so the disconnect is left to say it. The window closing
|
||||
// before any port connected is the one case with nothing else to speak for it,
|
||||
// and is rejected here so the dApp is not left waiting on a window that is
|
||||
// gone.
|
||||
// A site-connection or network-switch approval whose popup connected its port
|
||||
// is not decided here. That popup approves and closes in the same breath, and
|
||||
// this event races the decision on a channel of its own — the same race the
|
||||
// port exists to end. Its port disconnect says the same thing this event does,
|
||||
// in an order that is defined, so the disconnect is left to say it. The window
|
||||
// closing before any port connected is the one case with nothing else to speak
|
||||
// for it, and is rejected here so the dApp is not left waiting on a window that
|
||||
// is gone.
|
||||
if (windowsNs && windowsNs.onRemoved) {
|
||||
windowsNs.onRemoved.addListener((windowId) => {
|
||||
for (const [id, approval] of Object.entries(pendingApprovals)) {
|
||||
if (approval.windowId !== windowId) continue;
|
||||
const isSite = approval.type !== "tx" && approval.type !== "sign";
|
||||
if (isSite && approval.portConnected) continue;
|
||||
const decidedOnPort =
|
||||
approval.type !== "tx" && approval.type !== "sign";
|
||||
if (decidedOnPort && approval.portConnected) continue;
|
||||
const rejection = abandonedResult(
|
||||
approval,
|
||||
APPROVAL_REJECTED_CODE,
|
||||
@@ -1423,6 +1502,7 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
||||
"AUTISTMASK_ADDRESSES_REMOVED",
|
||||
"AUTISTMASK_GET_CONNECTED_SITES",
|
||||
"AUTISTMASK_REMOVE_SITE",
|
||||
"AUTISTMASK_NETWORK_CHANGED",
|
||||
];
|
||||
if (POPUP_ONLY_TYPES.includes(msg.type) && !isExtensionSender(sender)) {
|
||||
sendResponse({ error: "Unauthorized sender" });
|
||||
@@ -1446,6 +1526,11 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
||||
resp.signParams = approval.signParams;
|
||||
resp.approvedFrom = approval.approvedFrom;
|
||||
}
|
||||
if (approval.type === "network") {
|
||||
resp.type = "network";
|
||||
resp.currentNetworkId = approval.currentNetworkId;
|
||||
resp.requestedNetworkId = approval.requestedNetworkId;
|
||||
}
|
||||
// Flag if the requesting domain is on the phishing blocklist.
|
||||
resp.isPhishingDomain = isPhishingDomain(
|
||||
extractHostname(approval.origin),
|
||||
@@ -1710,7 +1795,8 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const activeAddress = await getActiveAddress();
|
||||
const s = await getState();
|
||||
const activeAddress = activeAddressOf(s);
|
||||
// Same as the transaction path: the address the approval named
|
||||
// is the one that must have signed, and a switch since then is
|
||||
// a refusal rather than a signature from another account.
|
||||
@@ -1729,6 +1815,20 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
||||
signature,
|
||||
approval.approvedFrom,
|
||||
);
|
||||
// The sign screen refuses typed data whose domain names
|
||||
// another chain. A signature for it that arrives anyway is
|
||||
// refused here, against the network active now.
|
||||
const sp = approval.signParams;
|
||||
if (
|
||||
sp.method === "eth_signTypedData_v4" ||
|
||||
sp.method === "eth_signTypedData"
|
||||
) {
|
||||
const refusal = typedDataChainRefusal(
|
||||
JSON.parse(sp.typedData).domain,
|
||||
networkById(s.networkId),
|
||||
);
|
||||
if (refusal) throw new ApprovalMismatchError(refusal);
|
||||
}
|
||||
settleApproval(msg.id, { signature }, { holdsClaim: true });
|
||||
sendResponse({ signature });
|
||||
} catch (e) {
|
||||
@@ -1801,6 +1901,13 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
||||
broadcastSiteRemoved(msg.origin);
|
||||
return false;
|
||||
}
|
||||
|
||||
// Settings switched the network and has saved it. Open tabs are told the
|
||||
// new chain id the same way as after a site's approved switch request.
|
||||
if (msg.type === "AUTISTMASK_NETWORK_CHANGED") {
|
||||
broadcastChainChanged(msg.chainId);
|
||||
return false;
|
||||
}
|
||||
});
|
||||
|
||||
module.exports = { PROXY_METHODS };
|
||||
|
||||
@@ -99,7 +99,10 @@
|
||||
|
||||
const provider = {
|
||||
isAutistMask: true,
|
||||
isMetaMask: true, // compatibility — many dApps check this
|
||||
// An interface-compatibility flag many dApps check. Kept as a written
|
||||
// exception to the rule that no competitor is named in code: see
|
||||
// Policies in README.md, and RULES.md.
|
||||
isMetaMask: true,
|
||||
chainId: currentChainId,
|
||||
networkVersion: currentNetworkVersion,
|
||||
selectedAddress: null,
|
||||
|
||||
+84
-25
@@ -7,9 +7,10 @@
|
||||
<link rel="stylesheet" href="styles.css" />
|
||||
</head>
|
||||
<!-- Chrome gives extension pages a stylesheet of its own that sets the
|
||||
font on body, and a Tailwind class beats it only when marked
|
||||
important: hence font-mono! rather than font-mono. -->
|
||||
<body class="bg-bg text-fg font-mono! text-sm">
|
||||
font and its size on body, and a Tailwind class beats it only when
|
||||
marked important: hence font-mono! and text-sm! rather than
|
||||
font-mono and text-sm. -->
|
||||
<body class="bg-bg text-fg font-mono! text-sm!">
|
||||
<div id="app" class="p-2 pr-5 overflow-x-hidden">
|
||||
<!-- ============ GLOBAL TITLE BAR ============ -->
|
||||
<div
|
||||
@@ -87,11 +88,14 @@
|
||||
|
||||
<!-- Mnemonic form section -->
|
||||
<div id="add-wallet-section-mnemonic">
|
||||
<p class="mb-2">
|
||||
Enter your 12 or 24 word recovery phrase below, or click
|
||||
the button to roll the die for a new one.
|
||||
<!-- The die button shares the instruction's row: on a row
|
||||
of its own it pushes Import below the fold at
|
||||
360x600. -->
|
||||
<div class="mb-2 flex justify-between items-start gap-2">
|
||||
<p>
|
||||
Enter your 12 or 24 word recovery phrase below, or
|
||||
click the button to roll the die for a new one.
|
||||
</p>
|
||||
<div class="mb-1 flex justify-end">
|
||||
<button
|
||||
id="btn-generate-phrase"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer text-xs"
|
||||
@@ -207,12 +211,22 @@
|
||||
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||
/>
|
||||
</div>
|
||||
<!-- The error line sits beside Import, not above it: at
|
||||
360x600 the button already starts near the bottom of
|
||||
the popup, and a line of its own would push it below
|
||||
the fold. The longest error fits on one line here. -->
|
||||
<div class="flex items-center gap-2">
|
||||
<button
|
||||
id="btn-add-wallet-confirm"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
>
|
||||
Import
|
||||
</button>
|
||||
<div
|
||||
id="add-wallet-password-error"
|
||||
class="text-xs min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- ============ MAIN VIEW: ALL WALLETS & ADDRESSES ============ -->
|
||||
@@ -396,10 +410,6 @@
|
||||
Warning: anyone with this private key can access and
|
||||
transfer all funds from this address. Never share it.
|
||||
</p>
|
||||
<div
|
||||
id="export-privkey-flash"
|
||||
class="text-xs mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<div id="export-privkey-password-section" class="mb-2">
|
||||
<label class="block mb-1">Password</label>
|
||||
<input
|
||||
@@ -408,9 +418,13 @@
|
||||
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||
placeholder="Enter your password to continue"
|
||||
/>
|
||||
<div
|
||||
id="export-privkey-password-error"
|
||||
class="text-xs mt-2 mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<button
|
||||
id="btn-export-privkey-confirm"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer mt-2"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
>
|
||||
Reveal
|
||||
</button>
|
||||
@@ -1116,10 +1130,6 @@
|
||||
<strong id="delete-wallet-name"></strong> is permanent. Any
|
||||
funds will be unrecoverable without your recovery phrase.
|
||||
</p>
|
||||
<div
|
||||
id="delete-wallet-flash"
|
||||
class="text-xs text-red-500 mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<div class="mb-2">
|
||||
<label class="block mb-1">Password</label>
|
||||
<input
|
||||
@@ -1129,6 +1139,10 @@
|
||||
placeholder="Enter your password to confirm"
|
||||
/>
|
||||
</div>
|
||||
<div
|
||||
id="delete-wallet-password-error"
|
||||
class="text-xs mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<button
|
||||
id="btn-delete-wallet-confirm"
|
||||
class="border border-border text-red-500 px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
@@ -1273,10 +1287,6 @@
|
||||
this wallet, from any device, without your password. Never
|
||||
type them into a website and never show them to anyone.
|
||||
</div>
|
||||
<div
|
||||
id="show-phrase-flash"
|
||||
class="text-xs text-red-500 mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<div id="show-phrase-password-section" class="mb-2">
|
||||
<label class="block mb-1">Password</label>
|
||||
<input
|
||||
@@ -1285,9 +1295,13 @@
|
||||
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||
placeholder="Enter your password to continue"
|
||||
/>
|
||||
<div
|
||||
id="show-phrase-password-error"
|
||||
class="text-xs mt-2 mb-2 min-h-[1.25rem] invisible"
|
||||
></div>
|
||||
<button
|
||||
id="btn-show-phrase-reveal"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer mt-2"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
>
|
||||
Reveal
|
||||
</button>
|
||||
@@ -1702,10 +1716,7 @@
|
||||
<div class="text-xs text-muted mb-1">
|
||||
Address that will be shared:
|
||||
</div>
|
||||
<div
|
||||
id="approve-address"
|
||||
class="text-xs flex items-center mb-2"
|
||||
></div>
|
||||
<div id="approve-address" class="text-xs mb-2"></div>
|
||||
</div>
|
||||
<div class="mb-3">
|
||||
<label
|
||||
@@ -1731,6 +1742,54 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- ============ NETWORK SWITCH APPROVAL ============ -->
|
||||
<div id="view-approve-network" class="view hidden">
|
||||
<h2 class="font-bold mb-2">Network Switch Request</h2>
|
||||
<div
|
||||
id="approve-network-phishing-warning"
|
||||
class="mb-3 p-2 text-xs font-bold hidden bg-red-100 text-red-800 border-2 border-red-600 rounded-md"
|
||||
>
|
||||
⚠️ PHISHING WARNING: This site is on a known phishing
|
||||
blocklist. Proceed with extreme caution.
|
||||
</div>
|
||||
<p class="mb-2">
|
||||
<span id="approve-network-origin" class="font-bold"></span>
|
||||
wants to switch the wallet's network.
|
||||
</p>
|
||||
<div class="mb-3">
|
||||
<div class="text-xs text-muted mb-1">Current network</div>
|
||||
<div
|
||||
id="approve-network-current"
|
||||
class="text-xs font-bold"
|
||||
></div>
|
||||
</div>
|
||||
<div class="mb-3">
|
||||
<div class="text-xs text-muted mb-1">Requested network</div>
|
||||
<div
|
||||
id="approve-network-requested"
|
||||
class="text-xs font-bold"
|
||||
></div>
|
||||
</div>
|
||||
<p class="mb-3 text-xs">
|
||||
Switching changes the network for the whole wallet and for
|
||||
every site, not only for this one.
|
||||
</p>
|
||||
<div class="flex justify-between">
|
||||
<button
|
||||
id="btn-approve-network"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
>
|
||||
Switch
|
||||
</button>
|
||||
<button
|
||||
id="btn-reject-network"
|
||||
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||
>
|
||||
Reject
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- ============ STATE RECOVERY ============ -->
|
||||
<!--
|
||||
Shown when the stored profile cannot be read at all. Every
|
||||
|
||||
+2
-2
@@ -238,9 +238,9 @@ async function init() {
|
||||
// rejection rather than an uncaught error — measured as still failing
|
||||
// the run on both harnesses (Playwright `pageerror`, and the Firefox
|
||||
// driver's console-service drain), so nothing is lost by leaving it
|
||||
// on that path.
|
||||
// on that path. show() puts the approval's own screen up once the
|
||||
// background has described it.
|
||||
approval.show(approvalId);
|
||||
showView("approve-site");
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@ const {
|
||||
$,
|
||||
showView,
|
||||
showFlash,
|
||||
showError,
|
||||
hideError,
|
||||
goBack,
|
||||
clearViewStack,
|
||||
onViewLeave,
|
||||
@@ -98,6 +100,7 @@ function clear() {
|
||||
$("add-wallet-password").value = "";
|
||||
$("add-wallet-password-confirm").value = "";
|
||||
$("add-wallet-phrase-warning").style.visibility = "hidden";
|
||||
hideError("add-wallet-password-error");
|
||||
}
|
||||
|
||||
// Each wallet has its own password (its own encryptedSecret), so adding a
|
||||
@@ -125,15 +128,18 @@ function validatePassword() {
|
||||
const pw = $("add-wallet-password").value;
|
||||
const pw2 = $("add-wallet-password-confirm").value;
|
||||
if (!pw) {
|
||||
showFlash("Please choose a password.");
|
||||
showError("add-wallet-password-error", "Please choose a password.");
|
||||
return null;
|
||||
}
|
||||
if (pw.length < 12) {
|
||||
showFlash("Password must be at least 12 characters.");
|
||||
showError(
|
||||
"add-wallet-password-error",
|
||||
"Password must be at least 12 characters.",
|
||||
);
|
||||
return null;
|
||||
}
|
||||
if (pw !== pw2) {
|
||||
showFlash("Passwords do not match.");
|
||||
showError("add-wallet-password-error", "Passwords do not match.");
|
||||
return null;
|
||||
}
|
||||
return pw;
|
||||
@@ -178,7 +184,12 @@ async function importMnemonic(ctx) {
|
||||
encryptedSecret: encrypted,
|
||||
nextIndex: 1,
|
||||
addresses: [
|
||||
{ address: firstAddress, balance: "0.0000", tokenBalances: [] },
|
||||
{
|
||||
address: firstAddress,
|
||||
index: 0,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
},
|
||||
],
|
||||
};
|
||||
state.wallets.push(wallet);
|
||||
@@ -199,6 +210,7 @@ async function importMnemonic(ctx) {
|
||||
if (scan.addresses.length > 1) {
|
||||
wallet.addresses = scan.addresses.map((a) => ({
|
||||
address: a.address,
|
||||
index: a.index,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
}));
|
||||
@@ -293,7 +305,12 @@ async function importXprvKey(ctx) {
|
||||
encryptedSecret: encrypted,
|
||||
nextIndex: 1,
|
||||
addresses: [
|
||||
{ address: firstAddress, balance: "0.0000", tokenBalances: [] },
|
||||
{
|
||||
address: firstAddress,
|
||||
index: 0,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
},
|
||||
],
|
||||
};
|
||||
state.wallets.push(wallet);
|
||||
@@ -314,6 +331,7 @@ async function importXprvKey(ctx) {
|
||||
if (scan.addresses.length > 1) {
|
||||
wallet.addresses = scan.addresses.map((a) => ({
|
||||
address: a.address,
|
||||
index: a.index,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
}));
|
||||
@@ -342,8 +360,10 @@ function init(ctx) {
|
||||
$("add-wallet-phrase-warning").style.visibility = "visible";
|
||||
});
|
||||
|
||||
// Import / confirm
|
||||
// Import / confirm. Each press starts with no password error on screen:
|
||||
// validatePassword() puts it back if the password is still wrong.
|
||||
$("btn-add-wallet-confirm").addEventListener("click", async () => {
|
||||
hideError("add-wallet-password-error");
|
||||
if (currentMode === "mnemonic") {
|
||||
await importMnemonic(ctx);
|
||||
} else if (currentMode === "privkey") {
|
||||
|
||||
@@ -266,7 +266,7 @@ function init(_ctx) {
|
||||
// This address's private key can be derived from the stored key,
|
||||
// but export goes through getSignerForAddress, which refuses a key
|
||||
// that is not a master key. Without this the export screen would
|
||||
// take a password and then report that refusal as a wrong password.
|
||||
// take a password and then refuse.
|
||||
const defect = selectedWalletDefect();
|
||||
if (defect) {
|
||||
showFlash(defect.shortMessage);
|
||||
|
||||
+115
-30
@@ -12,8 +12,9 @@ const {
|
||||
formatFee,
|
||||
tokenLabel,
|
||||
} = require("./helpers");
|
||||
const { state, saveState } = require("../../shared/state");
|
||||
const { state, saveState, currentNetwork } = require("../../shared/state");
|
||||
const {
|
||||
networkById,
|
||||
networkByChainId,
|
||||
nativeCurrencyByChainId,
|
||||
} = require("../../shared/networks");
|
||||
@@ -45,7 +46,10 @@ const {
|
||||
const { decryptWithPassword } = require("../../shared/vault");
|
||||
const { getSignerForAddress } = require("../../shared/wallet");
|
||||
const { walletDefect } = require("../../shared/walletDefects");
|
||||
const { describeSigningFailure } = require("../../shared/approvalVerify");
|
||||
const {
|
||||
describeSigningFailure,
|
||||
typedDataChainRefusal,
|
||||
} = require("../../shared/approvalVerify");
|
||||
const txStatus = require("./txStatus");
|
||||
const uniswap = require("../../shared/uniswap");
|
||||
const { notify, runtimeApi, sendMessage } = require("../../shared/browserApi");
|
||||
@@ -328,9 +332,9 @@ function showTxApproval(details) {
|
||||
const ethUsd = ethPrice ? parseFloat(ethValueFormatted) * ethPrice : null;
|
||||
const usdStr = formatUsd(ethUsd);
|
||||
// In the native currency of the network the transaction is for, which the
|
||||
// Network line names, not the active network's: a site can switch the
|
||||
// active network after this transaction is prepared and back before it is
|
||||
// signed.
|
||||
// Network line names, not the active network's: the active network can
|
||||
// change, in Settings or when the user approves a site's request, after
|
||||
// this transaction is prepared and change back before it is signed.
|
||||
$("approve-tx-value").textContent =
|
||||
ethValueFormatted +
|
||||
" " +
|
||||
@@ -442,7 +446,8 @@ function signedPrimaryType(types) {
|
||||
// Why a signature request cannot be signed, as a sentence for the error line,
|
||||
// or null when it can. Only typed data is refused: the `primaryType` the page
|
||||
// states has to be the type ethers will sign, or this screen would name one
|
||||
// message while another is signed.
|
||||
// message while another is signed. Its domain may name no chain but the active
|
||||
// network's.
|
||||
function typedDataRefusal(sp) {
|
||||
if (sp.method === "personal_sign" || sp.method === "eth_sign") return null;
|
||||
let data;
|
||||
@@ -465,7 +470,7 @@ function typedDataRefusal(sp) {
|
||||
", so it cannot be signed."
|
||||
);
|
||||
}
|
||||
return null;
|
||||
return typedDataChainRefusal(data.domain, currentNetwork());
|
||||
}
|
||||
|
||||
// The largest amount a Permit2 allowance can hold, a uint160. Permit2 treats
|
||||
@@ -621,10 +626,38 @@ function permitWarningHtml(types, primaryType, domain, message) {
|
||||
return html;
|
||||
}
|
||||
|
||||
// What ethers signs of a message value of type `type`: a struct keeps only
|
||||
// the fields its type declares, in the type's order, and a list is read item
|
||||
// by item. ethers drops every other key, so each one is added to `notSigned`
|
||||
// with its place in the message and its value, for the screen to list apart.
|
||||
function signedValue(types, type, value, path, notSigned) {
|
||||
const itemType = type.replace(/\[\d*\]$/, "");
|
||||
if (itemType !== type) {
|
||||
if (!Array.isArray(value)) return value;
|
||||
return value.map((item, i) =>
|
||||
signedValue(types, itemType, item, `${path}[${i}]`, notSigned),
|
||||
);
|
||||
}
|
||||
const fields = types[type];
|
||||
if (!fields || !value || typeof value !== "object") return value;
|
||||
const at = (name) => (path ? `${path}.${name}` : name);
|
||||
for (const [key, val] of Object.entries(value)) {
|
||||
if (!fields.some((f) => f.name === key)) notSigned.push([at(key), val]);
|
||||
}
|
||||
return Object.fromEntries(
|
||||
fields.map((f) => [
|
||||
f.name,
|
||||
signedValue(types, f.type, value[f.name], at(f.name), notSigned),
|
||||
]),
|
||||
);
|
||||
}
|
||||
|
||||
// The typed data as the screen shows it. The primary type shown is the one
|
||||
// ethers signs, never the page's word for it; typedDataRefusal() keeps the two
|
||||
// from differing on anything that can be signed. Only typed data that cannot
|
||||
// be read at all is shown as raw text, and typedDataRefusal() refuses it.
|
||||
// from differing on anything that can be signed. The Message section shows
|
||||
// only what is signed, and any other key the page sent is listed after it as
|
||||
// not part of the signature. Only typed data that cannot be read at all is
|
||||
// shown as raw text, and typedDataRefusal() refuses it.
|
||||
function formatTypedDataHtml(jsonStr) {
|
||||
let data;
|
||||
let primaryType;
|
||||
@@ -658,12 +691,30 @@ function formatTypedDataHtml(jsonStr) {
|
||||
html += `<div class="mb-2"><div class="text-muted">Primary type</div>`;
|
||||
html += `<div class="font-bold">${escapeHtml(primaryType)}</div></div>`;
|
||||
|
||||
const lineHtml = (key, val) =>
|
||||
`<div><span class="text-muted">${escapeHtml(key)}:</span> <span class="break-all">${escapeHtml(display(val))}</span></div>`;
|
||||
|
||||
if (data.message) {
|
||||
const notSigned = [];
|
||||
const message = signedValue(
|
||||
data.types,
|
||||
primaryType,
|
||||
data.message,
|
||||
"",
|
||||
notSigned,
|
||||
);
|
||||
html += `<div class="mb-2"><div class="text-muted">Message</div>`;
|
||||
for (const [key, val] of Object.entries(data.message)) {
|
||||
html += `<div><span class="text-muted">${escapeHtml(key)}:</span> <span class="break-all">${escapeHtml(display(val))}</span></div>`;
|
||||
for (const [key, val] of Object.entries(message)) {
|
||||
html += lineHtml(key, val);
|
||||
}
|
||||
html += `</div>`;
|
||||
if (notSigned.length > 0) {
|
||||
html += `<div class="mb-2"><div class="text-muted">Not part of the signature</div>`;
|
||||
for (const [key, val] of notSigned) {
|
||||
html += lineHtml(key, val);
|
||||
}
|
||||
html += `</div>`;
|
||||
}
|
||||
}
|
||||
|
||||
return html;
|
||||
@@ -720,7 +771,7 @@ function showSignApproval(details) {
|
||||
"This message is plain text, not hex, so it cannot be signed.";
|
||||
}
|
||||
|
||||
// Display danger warning for eth_sign (raw hash signing)
|
||||
// The warning the background attaches to an eth_sign request.
|
||||
const warningEl = $("approve-sign-danger-warning");
|
||||
if (warningEl) {
|
||||
if (sp.dangerWarning) {
|
||||
@@ -752,9 +803,29 @@ function showSignApproval(details) {
|
||||
);
|
||||
}
|
||||
|
||||
function showNetworkApproval(details) {
|
||||
showPhishingWarning(
|
||||
"approve-network-phishing-warning",
|
||||
details.isPhishingDomain,
|
||||
);
|
||||
$("approve-network-origin").textContent = details.origin;
|
||||
$("approve-network-current").textContent = networkById(
|
||||
details.currentNetworkId,
|
||||
).name;
|
||||
$("approve-network-requested").textContent = networkById(
|
||||
details.requestedNetworkId,
|
||||
).name;
|
||||
showView("approve-network");
|
||||
}
|
||||
|
||||
// Awaited by nobody: the popup entry point calls this and moves on. It
|
||||
// therefore has to absorb its own failure, and a background that cannot
|
||||
// describe the approval is the same outcome as an approval that is gone.
|
||||
//
|
||||
// Nothing is on screen until the background has described the approval, so
|
||||
// the screen shown is always the one for the approval this window answers:
|
||||
// the connection prompt's "Allow" and the network switch prompt's "Switch"
|
||||
// answer on the same port, and either would approve the other.
|
||||
async function show(id) {
|
||||
approvalId = id;
|
||||
approvalPort = runtimeApi().connect({ name: "approval:" + id });
|
||||
@@ -778,6 +849,10 @@ async function show(id) {
|
||||
showSignApproval(details);
|
||||
return;
|
||||
}
|
||||
if (details.type === "network") {
|
||||
showNetworkApproval(details);
|
||||
return;
|
||||
}
|
||||
// Site connection approval
|
||||
showPhishingWarning(
|
||||
"approve-site-phishing-warning",
|
||||
@@ -787,6 +862,7 @@ async function show(id) {
|
||||
$("approve-address").innerHTML = approvalAddressHtml(state.activeAddress);
|
||||
attachCopyHandlers("view-approve-site");
|
||||
$("approve-remember").checked = state.rememberSiteChoice;
|
||||
showView("approve-site");
|
||||
}
|
||||
|
||||
let approvalId = null;
|
||||
@@ -837,15 +913,15 @@ function gateOnWalletDefect(errorId, buttonId, address) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Locate the wallet and the address index owning an address. Returns null when
|
||||
// no wallet holds it. Approvals look up the address they were raised for, not
|
||||
// whichever address is active now: the approval named one account, and signing
|
||||
// with another is what verification refuses.
|
||||
// Locate the wallet and the stored address record owning an address. Returns
|
||||
// null when no wallet holds it. Approvals look up the address they were raised
|
||||
// for, not whichever address is active now: the approval named one account,
|
||||
// and signing with another is what verification refuses.
|
||||
function findWalletFor(address) {
|
||||
for (const wallet of state.wallets) {
|
||||
for (let i = 0; i < wallet.addresses.length; i++) {
|
||||
if (wallet.addresses[i].address === address) {
|
||||
return { wallet, addrIndex: i };
|
||||
return { wallet, addr: wallet.addresses[i] };
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -866,20 +942,21 @@ function clearSignPassword() {
|
||||
hideError("approve-sign-error");
|
||||
}
|
||||
|
||||
// Answer a site-connection approval and close. The decision goes out on the
|
||||
// approval port — see approvalPort above for why — and carries no approval id,
|
||||
// because the port name already names the approval the background will settle.
|
||||
// The post is guarded because a throw must not cost the close: posting on a
|
||||
// port whose background worker has been torn down throws, and the approval it
|
||||
// would have settled died with that worker, so the only thing left to do is
|
||||
// what the user asked for — go away.
|
||||
function decideSite(approved) {
|
||||
// Answer a site-connection or network-switch approval and close. The decision
|
||||
// goes out on the approval port — see approvalPort above for why — and carries
|
||||
// no approval id, because the port name already names the approval the
|
||||
// background will settle. `remember` means something only for a site
|
||||
// connection. The post is guarded because a throw must not cost the close:
|
||||
// posting on a port whose background worker has been torn down throws, and the
|
||||
// approval it would have settled died with that worker, so the only thing left
|
||||
// to do is what the user asked for — go away.
|
||||
function decide(approved, remember) {
|
||||
if (approvalPort) {
|
||||
try {
|
||||
approvalPort.postMessage({
|
||||
type: "AUTISTMASK_APPROVAL_DECISION",
|
||||
approved,
|
||||
remember: $("approve-remember").checked,
|
||||
remember,
|
||||
});
|
||||
} catch {
|
||||
// Nothing to report it to; the window closes either way.
|
||||
@@ -898,11 +975,19 @@ function init(_ctx) {
|
||||
});
|
||||
|
||||
$("btn-approve").addEventListener("click", () => {
|
||||
decideSite(true);
|
||||
decide(true, $("approve-remember").checked);
|
||||
});
|
||||
|
||||
$("btn-reject").addEventListener("click", () => {
|
||||
decideSite(false);
|
||||
decide(false, $("approve-remember").checked);
|
||||
});
|
||||
|
||||
$("btn-approve-network").addEventListener("click", () => {
|
||||
decide(true, false);
|
||||
});
|
||||
|
||||
$("btn-reject-network").addEventListener("click", () => {
|
||||
decide(false, false);
|
||||
});
|
||||
|
||||
$("btn-approve-tx").addEventListener("click", async () => {
|
||||
@@ -963,7 +1048,7 @@ function init(_ctx) {
|
||||
try {
|
||||
const signer = getSignerForAddress(
|
||||
active.wallet,
|
||||
active.addrIndex,
|
||||
active.addr,
|
||||
decryptedSecret,
|
||||
);
|
||||
// Sign the approved transaction exactly as it was displayed. The
|
||||
@@ -1091,7 +1176,7 @@ function init(_ctx) {
|
||||
try {
|
||||
const signer = getSignerForAddress(
|
||||
active.wallet,
|
||||
active.addrIndex,
|
||||
active.addr,
|
||||
decryptedSecret,
|
||||
);
|
||||
const sp = pendingSignParams;
|
||||
|
||||
@@ -101,6 +101,10 @@ function show(txInfo) {
|
||||
feeStatus = FEE_PENDING;
|
||||
feeWei = null;
|
||||
maxSendFees = null;
|
||||
// The network this screen is drawn for, and the only one it sends on:
|
||||
// Settings can switch the active network while the screen is open. The
|
||||
// wait, success and error screens label the amount by it too.
|
||||
txInfo.chainId = currentNetwork().chainId;
|
||||
|
||||
const isErc20 = txInfo.token !== "ETH";
|
||||
// The raw symbol is the price-table key; the capped one is what the
|
||||
@@ -490,7 +494,12 @@ async function populateVerifyAndSend(connectedSigner, tx, fees = null) {
|
||||
);
|
||||
request = await contract.transfer.populateTransaction(tx.to, amount);
|
||||
}
|
||||
const populated = await connectedSigner.populateTransaction(request);
|
||||
// The chain id of the network the screen was drawn for: ethers refuses to
|
||||
// populate it for a provider on any other network.
|
||||
const populated = await connectedSigner.populateTransaction({
|
||||
...request,
|
||||
chainId: tx.chainId,
|
||||
});
|
||||
assertWithinCeilings(populated);
|
||||
return connectedSigner.sendTransaction(populated);
|
||||
}
|
||||
@@ -547,6 +556,30 @@ function init(_ctx) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Back from Settings only unhides this screen, still drawn for the
|
||||
// network that was active when it was shown.
|
||||
if (currentNetwork().chainId !== pendingTx.chainId) {
|
||||
showSendError(
|
||||
"The active network changed after this transaction was" +
|
||||
" reviewed, so it was not sent. Please go back and review" +
|
||||
" it again.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
// Sign as the From address this screen shows. The selection is saved
|
||||
// apart from this screen, so the popup can reopen onto it with another
|
||||
// address selected.
|
||||
const addr = wallet.addresses.find((a) => a.address === pendingTx.from);
|
||||
if (!addr) {
|
||||
showError(
|
||||
"confirm-tx-password-error",
|
||||
"The selected wallet does not hold the From address above, " +
|
||||
"so nothing was sent. Please go back and send again.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
const password = $("confirm-tx-password").value;
|
||||
if (!password) {
|
||||
showError(
|
||||
@@ -575,17 +608,9 @@ function init(_ctx) {
|
||||
$("btn-confirm-send").disabled = true;
|
||||
$("btn-confirm-send").classList.add("text-muted");
|
||||
|
||||
// The network it is sent on. The wait, success and error screens
|
||||
// label its amount by this, not by the network active when they draw.
|
||||
pendingTx.chainId = currentNetwork().chainId;
|
||||
|
||||
let tx;
|
||||
try {
|
||||
const signer = getSignerForAddress(
|
||||
wallet,
|
||||
state.selectedAddress,
|
||||
decryptedSecret,
|
||||
);
|
||||
const signer = getSignerForAddress(wallet, addr, decryptedSecret);
|
||||
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||
const connectedSigner = signer.connect(provider);
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@ const {
|
||||
$,
|
||||
showView,
|
||||
showFlash,
|
||||
showError,
|
||||
hideError,
|
||||
goBack,
|
||||
clearViewStack,
|
||||
onViewLeave,
|
||||
@@ -49,14 +51,13 @@ function confirmKey(name) {
|
||||
}
|
||||
|
||||
// Drop the password from the DOM and the wallet selection from the
|
||||
// closure. Registered as the view-leave handler as well as run on entry,
|
||||
// so the typed password does not sit in the hidden view after the user
|
||||
// navigates away by any route, including the Settings gear.
|
||||
// closure. Run by the view-leave handler as well as on entry, so the typed
|
||||
// password does not sit in the hidden view after the user navigates away
|
||||
// by any route, including the Settings gear.
|
||||
function clear() {
|
||||
deleteWalletIndex = null;
|
||||
$("delete-wallet-password").value = "";
|
||||
$("delete-wallet-flash").textContent = "";
|
||||
$("delete-wallet-flash").style.visibility = "hidden";
|
||||
hideError("delete-wallet-password-error");
|
||||
}
|
||||
|
||||
// The lost-password screen holds no secret — a wallet name is not one —
|
||||
@@ -147,8 +148,25 @@ async function finishDelete(walletIdx) {
|
||||
function init(_ctx) {
|
||||
ctx = _ctx;
|
||||
|
||||
onViewLeave("delete-wallet-confirm", clear);
|
||||
onViewLeave("delete-wallet-lost-password", clearLostPassword);
|
||||
// Leaving drops the wallet selection, so each screen also comes off the
|
||||
// Back stack, where the settings gear has just put it: Back from
|
||||
// Settings must not land on a screen whose button can only answer "No
|
||||
// wallet selected for deletion." A reopened popup drops them from the
|
||||
// stack the same way (https://git.eeqj.de/sneak/AutistMask/issues/480).
|
||||
onViewLeave("delete-wallet-confirm", () => {
|
||||
clear();
|
||||
const stack = state.viewStack;
|
||||
if (stack[stack.length - 1] === "delete-wallet-confirm") {
|
||||
stack.pop();
|
||||
}
|
||||
});
|
||||
onViewLeave("delete-wallet-lost-password", () => {
|
||||
clearLostPassword();
|
||||
const stack = state.viewStack;
|
||||
if (stack[stack.length - 1] === "delete-wallet-lost-password") {
|
||||
stack.pop();
|
||||
}
|
||||
});
|
||||
|
||||
// No wipe here: goBack() routes through showView(), which runs the
|
||||
// leave hook.
|
||||
@@ -215,19 +233,22 @@ function init(_ctx) {
|
||||
$("btn-delete-wallet-confirm").addEventListener("click", async () => {
|
||||
const pw = $("delete-wallet-password").value;
|
||||
if (!pw) {
|
||||
$("delete-wallet-flash").textContent =
|
||||
"Please enter your password.";
|
||||
$("delete-wallet-flash").style.visibility = "visible";
|
||||
showError(
|
||||
"delete-wallet-password-error",
|
||||
"Please enter your password.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
if (deleteWalletIndex === null) {
|
||||
$("delete-wallet-flash").textContent =
|
||||
"No wallet selected for deletion.";
|
||||
$("delete-wallet-flash").style.visibility = "visible";
|
||||
showError(
|
||||
"delete-wallet-password-error",
|
||||
"No wallet selected for deletion.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
hideError("delete-wallet-password-error");
|
||||
const btn = $("btn-delete-wallet-confirm");
|
||||
btn.disabled = true;
|
||||
btn.classList.add("text-muted");
|
||||
@@ -239,9 +260,10 @@ function init(_ctx) {
|
||||
try {
|
||||
await decryptWithPassword(wallet.encryptedSecret, pw);
|
||||
} catch {
|
||||
$("delete-wallet-flash").textContent =
|
||||
"That password is incorrect. Please try again.";
|
||||
$("delete-wallet-flash").style.visibility = "visible";
|
||||
showError(
|
||||
"delete-wallet-password-error",
|
||||
"That password is incorrect. Please try again.",
|
||||
);
|
||||
btn.disabled = false;
|
||||
btn.classList.remove("text-muted");
|
||||
return;
|
||||
|
||||
@@ -20,6 +20,8 @@ const {
|
||||
$,
|
||||
showView,
|
||||
showFlash,
|
||||
showError,
|
||||
hideError,
|
||||
flashCopyFeedback,
|
||||
goBack,
|
||||
onViewLeave,
|
||||
@@ -56,11 +58,6 @@ function isCurrentReveal(generation) {
|
||||
);
|
||||
}
|
||||
|
||||
function fail(message) {
|
||||
$("export-privkey-flash").textContent = message;
|
||||
$("export-privkey-flash").style.visibility = "visible";
|
||||
}
|
||||
|
||||
// Wipe every trace of the key and drop the address selection. Safe to call
|
||||
// when nothing was ever revealed, and safe to call twice.
|
||||
function clear() {
|
||||
@@ -71,8 +68,7 @@ function clear() {
|
||||
$("export-privkey-password").value = "";
|
||||
$("export-privkey-result").classList.add("hidden");
|
||||
$("export-privkey-password-section").classList.remove("hidden");
|
||||
$("export-privkey-flash").textContent = "";
|
||||
$("export-privkey-flash").style.visibility = "hidden";
|
||||
hideError("export-privkey-password-error");
|
||||
}
|
||||
|
||||
function show(walletIdx, addrIdx) {
|
||||
@@ -112,15 +108,19 @@ function show(walletIdx, addrIdx) {
|
||||
async function reveal() {
|
||||
const password = $("export-privkey-password").value;
|
||||
if (!password) {
|
||||
fail("Please enter your password.");
|
||||
showError(
|
||||
"export-privkey-password-error",
|
||||
"Please enter your password.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
if (walletIndex === null) {
|
||||
fail("No address is selected.");
|
||||
showError("export-privkey-password-error", "No address is selected.");
|
||||
return;
|
||||
}
|
||||
const wallet = state.wallets[walletIndex];
|
||||
|
||||
hideError("export-privkey-password-error");
|
||||
const btn = $("btn-export-privkey-confirm");
|
||||
btn.disabled = true;
|
||||
btn.classList.add("text-muted");
|
||||
@@ -135,16 +135,28 @@ async function reveal() {
|
||||
// decrypt ran, the wipe has already happened, so the key is not
|
||||
// even derived, let alone written.
|
||||
if (!isCurrentReveal(generation)) return;
|
||||
const signer = getSignerForAddress(wallet, addressIndex, secret);
|
||||
let signer;
|
||||
try {
|
||||
signer = getSignerForAddress(
|
||||
wallet,
|
||||
wallet.addresses[addressIndex],
|
||||
secret,
|
||||
);
|
||||
} catch (e) {
|
||||
// The password was right; it is the key that was refused.
|
||||
showError("export-privkey-password-error", e.message);
|
||||
return;
|
||||
}
|
||||
$("export-privkey-password").value = "";
|
||||
$("export-privkey-password-section").classList.add("hidden");
|
||||
$("export-privkey-value").textContent = signer.privateKey;
|
||||
$("export-privkey-result").classList.remove("hidden");
|
||||
$("export-privkey-flash").textContent = "";
|
||||
$("export-privkey-flash").style.visibility = "hidden";
|
||||
} catch {
|
||||
if (!isCurrentReveal(generation)) return;
|
||||
fail("That password is incorrect. Please try again.");
|
||||
showError(
|
||||
"export-privkey-password-error",
|
||||
"That password is incorrect. Please try again.",
|
||||
);
|
||||
} finally {
|
||||
btn.disabled = false;
|
||||
btn.classList.remove("text-muted");
|
||||
@@ -152,7 +164,16 @@ async function reveal() {
|
||||
}
|
||||
|
||||
function init() {
|
||||
onViewLeave(VIEW, clear);
|
||||
// Leaving drops the address selection, so the screen also comes off the
|
||||
// Back stack, where the settings gear has just put it: Back from Settings
|
||||
// must not land on a password prompt that can only fail. A reopened popup
|
||||
// drops it from the stack the same way
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/461).
|
||||
onViewLeave(VIEW, () => {
|
||||
clear();
|
||||
const stack = state.viewStack;
|
||||
if (stack[stack.length - 1] === VIEW) stack.pop();
|
||||
});
|
||||
|
||||
// No wipe here: goBack() routes through showView(), which runs the
|
||||
// leave hook. A per-button wipe would only cover this one path.
|
||||
|
||||
@@ -51,6 +51,7 @@ const VIEWS = [
|
||||
"approve-site",
|
||||
"approve-tx",
|
||||
"approve-sign",
|
||||
"approve-network",
|
||||
"export-privkey",
|
||||
"show-phrase",
|
||||
// Shown by src/popup/views/stateRecovery.js when the stored profile
|
||||
@@ -216,10 +217,21 @@ function pushCurrentView() {
|
||||
|
||||
// Pop the navigation stack and show the previous view. If the stack
|
||||
// is empty, fall back to the main (home) view.
|
||||
//
|
||||
// An entry for the view already showing is skipped: landing on it would
|
||||
// make Back seem to do nothing. Settings, the recovery phrase or delete
|
||||
// wallet screen, then the gear leaves Settings under Settings, because that
|
||||
// screen takes itself off the stack when left, and a reopened popup cuts it
|
||||
// off the restored stack the same way
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/481).
|
||||
function goBack() {
|
||||
const stack = state.viewStack;
|
||||
while (stack.length > 0 && stack[stack.length - 1] === state.currentView) {
|
||||
stack.pop();
|
||||
}
|
||||
let target;
|
||||
if (state.viewStack.length > 0) {
|
||||
target = state.viewStack.pop();
|
||||
if (stack.length > 0) {
|
||||
target = stack.pop();
|
||||
} else {
|
||||
target = "main";
|
||||
}
|
||||
|
||||
@@ -354,6 +354,7 @@ function render(ctx) {
|
||||
);
|
||||
wallet.addresses.push({
|
||||
address: newAddr,
|
||||
index: wallet.nextIndex,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
});
|
||||
|
||||
@@ -316,7 +316,11 @@ function init(ctx) {
|
||||
const networkSelect = $("settings-network");
|
||||
networkSelect.addEventListener("change", async () => {
|
||||
const newId = networkSelect.value;
|
||||
if (newId === state.networkId) return;
|
||||
const net = await onChainSwitch(newId);
|
||||
// Open pages are told by the background, as after a site's approved
|
||||
// switch request.
|
||||
notify({ type: "AUTISTMASK_NETWORK_CHANGED", chainId: net.chainId });
|
||||
$("settings-rpc").value = state.rpcUrl;
|
||||
$("settings-blockscout").value = state.blockscoutUrl;
|
||||
showFlash("Switched to " + net.name + ".");
|
||||
|
||||
@@ -21,6 +21,8 @@ const {
|
||||
$,
|
||||
showView,
|
||||
showFlash,
|
||||
showError,
|
||||
hideError,
|
||||
flashCopyFeedback,
|
||||
goBack,
|
||||
onViewLeave,
|
||||
@@ -52,11 +54,6 @@ function isCurrentReveal(generation) {
|
||||
);
|
||||
}
|
||||
|
||||
function fail(message) {
|
||||
$("show-phrase-flash").textContent = message;
|
||||
$("show-phrase-flash").style.visibility = "visible";
|
||||
}
|
||||
|
||||
// Wipe every trace of the phrase and drop the wallet selection. Safe to
|
||||
// call when nothing was ever revealed, and safe to call twice.
|
||||
function clear() {
|
||||
@@ -66,8 +63,7 @@ function clear() {
|
||||
$("show-phrase-password").value = "";
|
||||
$("show-phrase-result").classList.add("hidden");
|
||||
$("show-phrase-password-section").classList.remove("hidden");
|
||||
$("show-phrase-flash").textContent = "";
|
||||
$("show-phrase-flash").style.visibility = "hidden";
|
||||
hideError("show-phrase-password-error");
|
||||
}
|
||||
|
||||
function show(walletIdx) {
|
||||
@@ -90,19 +86,23 @@ function show(walletIdx) {
|
||||
async function reveal() {
|
||||
const password = $("show-phrase-password").value;
|
||||
if (!password) {
|
||||
fail("Please enter your password.");
|
||||
showError("show-phrase-password-error", "Please enter your password.");
|
||||
return;
|
||||
}
|
||||
if (walletIndex === null) {
|
||||
fail("No wallet is selected.");
|
||||
showError("show-phrase-password-error", "No wallet is selected.");
|
||||
return;
|
||||
}
|
||||
const wallet = state.wallets[walletIndex];
|
||||
if (!walletHasRecoveryPhrase(wallet)) {
|
||||
fail("This wallet does not have a recovery phrase.");
|
||||
showError(
|
||||
"show-phrase-password-error",
|
||||
"This wallet does not have a recovery phrase.",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
hideError("show-phrase-password-error");
|
||||
const btn = $("btn-show-phrase-reveal");
|
||||
btn.disabled = true;
|
||||
btn.classList.add("text-muted");
|
||||
@@ -120,13 +120,14 @@ async function reveal() {
|
||||
$("show-phrase-password-section").classList.add("hidden");
|
||||
$("show-phrase-value").textContent = phrase;
|
||||
$("show-phrase-result").classList.remove("hidden");
|
||||
$("show-phrase-flash").textContent = "";
|
||||
$("show-phrase-flash").style.visibility = "hidden";
|
||||
} catch {
|
||||
if (!isCurrentReveal(generation)) return;
|
||||
// Deliberately not the caught error: the message is fixed so that
|
||||
// nothing derived from the ciphertext or the attempt can surface.
|
||||
fail("That password is incorrect. Please try again.");
|
||||
showError(
|
||||
"show-phrase-password-error",
|
||||
"That password is incorrect. Please try again.",
|
||||
);
|
||||
} finally {
|
||||
btn.disabled = false;
|
||||
btn.classList.remove("text-muted");
|
||||
@@ -134,7 +135,16 @@ async function reveal() {
|
||||
}
|
||||
|
||||
function init() {
|
||||
onViewLeave(VIEW, clear);
|
||||
// Leaving drops the wallet selection, so the screen also comes off the
|
||||
// Back stack, where the settings gear has just put it: Back from Settings
|
||||
// must not land on a password prompt that can only fail. A reopened popup
|
||||
// drops it from the stack the same way
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/461).
|
||||
onViewLeave(VIEW, () => {
|
||||
clear();
|
||||
const stack = state.viewStack;
|
||||
if (stack[stack.length - 1] === VIEW) stack.pop();
|
||||
});
|
||||
|
||||
$("btn-show-phrase-back").addEventListener("click", () => {
|
||||
goBack();
|
||||
|
||||
@@ -84,8 +84,9 @@ function show(tx) {
|
||||
contractAddress: tx.contractAddress || null,
|
||||
// The network the history entry was read from. The type line and
|
||||
// the fee are in its native currency, not the active network's:
|
||||
// a site can switch the active network before a later popup
|
||||
// shows this screen again.
|
||||
// the active network can change, in Settings or when the user
|
||||
// approves a site's request, before a later popup shows this
|
||||
// screen again.
|
||||
chainId: tx.chainId,
|
||||
},
|
||||
};
|
||||
@@ -182,7 +183,7 @@ function render() {
|
||||
if (el) el.classList.add("hidden");
|
||||
}
|
||||
|
||||
loadFullTxDetails(tx.hash, tx.to, tx.chainId);
|
||||
loadFullTxDetails(tx.hash, tx.chainId);
|
||||
|
||||
const isoStr = isoDate(tx.timestamp);
|
||||
$("tx-detail-time").innerHTML =
|
||||
@@ -290,7 +291,7 @@ function populateOnChainDetails(txData, chainId) {
|
||||
}
|
||||
}
|
||||
|
||||
async function loadFullTxDetails(txHash, toAddress, chainId) {
|
||||
async function loadFullTxDetails(txHash, chainId) {
|
||||
const section = $("tx-detail-calldata-section");
|
||||
const actionEl = $("tx-detail-calldata-action");
|
||||
const detailsEl = $("tx-detail-calldata-details");
|
||||
@@ -312,7 +313,10 @@ async function loadFullTxDetails(txHash, toAddress, chainId) {
|
||||
const inputData = txData.raw_input || txData.input || null;
|
||||
if (!inputData || inputData === "0x") return;
|
||||
|
||||
const decoded = decodeCalldata(inputData, toAddress || "");
|
||||
// Decoded against the address the transaction was sent to, as the
|
||||
// explorer reports it, not the history entry's `to`: for a token
|
||||
// transfer that is the transfer's recipient, not the token contract.
|
||||
const decoded = decodeCalldata(inputData, txData.to?.hash || "");
|
||||
if (decoded) {
|
||||
// Render decoded calldata matching approval view style
|
||||
actionEl.textContent = decoded.name;
|
||||
|
||||
@@ -89,8 +89,9 @@ function startWait(txInfo, txHash, broadcastTime, pollNow) {
|
||||
|
||||
// A native amount, here and on the success and error screens, is in the
|
||||
// native currency of txInfo.chainId, the network the transaction was sent
|
||||
// on, not the active network's: a site can switch the active network
|
||||
// while this screen is open or before a later popup resumes it.
|
||||
// on, not the active network's: the active network can change, in
|
||||
// Settings or when the user approves a site's request, while this screen
|
||||
// is open or before a later popup resumes it.
|
||||
const symbol =
|
||||
txInfo.token === "ETH"
|
||||
? nativeCurrencyByChainId(txInfo.chainId)
|
||||
|
||||
+53
-15
@@ -1,13 +1,14 @@
|
||||
// Preparation of the transaction an approval screen displays.
|
||||
//
|
||||
// A dApp's eth_sendTransaction normally fixes only `to`, `value` and `data`.
|
||||
// The nonce, the gas limit and the fees have to be filled in from the network
|
||||
// before anything can be signed, and whoever fills them in decides what the
|
||||
// user is shown. That work used to happen in the popup, after the user had
|
||||
// already approved: the numbers on the approval screen came from the popup and
|
||||
// were compared against nothing, so a compromised popup could display one fee
|
||||
// and sign another, and the ceilings in approvalVerify.js were all that stood
|
||||
// between the user and a fee that hands the validator the balance.
|
||||
// A dApp's eth_sendTransaction normally fixes `to`, `value` and `data`, and
|
||||
// sometimes the gas limit. The nonce, the fees, and the gas limit when the
|
||||
// site gives none have to be filled in from the network before anything can
|
||||
// be signed, and whoever fills them in decides what the user is shown. That
|
||||
// work used to happen in the popup, after the user had already approved: the
|
||||
// numbers on the approval screen came from the popup and were compared against
|
||||
// nothing, so a compromised popup could display one fee and sign another, and
|
||||
// the ceilings in approvalVerify.js were all that stood between the user and a
|
||||
// fee that hands the validator the balance.
|
||||
//
|
||||
// So it happens here instead, in the background, before the approval window is
|
||||
// opened. The background populates the transaction, shows that object, and
|
||||
@@ -31,6 +32,7 @@ const {
|
||||
VoidSigner,
|
||||
accessListify,
|
||||
getAddress,
|
||||
getBigInt,
|
||||
getBytes,
|
||||
hexlify,
|
||||
toQuantity,
|
||||
@@ -47,10 +49,11 @@ const {
|
||||
// minutes long, which is not a wait anyone will sit through.
|
||||
const POPULATE_TIMEOUT_MS = 20000;
|
||||
|
||||
// The request fields taken from the page. Anything else is dropped rather than
|
||||
// passed to ethers: the object is page-controlled, and a future ethers that
|
||||
// learns to carry a new transaction field must not start picking one up out of
|
||||
// it without this module knowing.
|
||||
// The request fields taken from the page, plus `gas`, which requestFrom()
|
||||
// takes as the gas limit. Anything else is dropped rather than passed to
|
||||
// ethers: the object is page-controlled, and a future ethers that learns to
|
||||
// carry a new transaction field must not start picking one up out of it
|
||||
// without this module knowing.
|
||||
//
|
||||
// The nonce is not taken from the page; it is always the account's next nonce
|
||||
// from the network. A page that chose it could replace one of the user's
|
||||
@@ -84,6 +87,16 @@ function present(v) {
|
||||
return v !== null && v !== undefined && v !== "";
|
||||
}
|
||||
|
||||
// Whether two quantities from the page are the same number. One that is not a
|
||||
// number matches nothing.
|
||||
function sameQuantity(a, b) {
|
||||
try {
|
||||
return getBigInt(a) === getBigInt(b);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// These strings reach the user through the requesting page, so they are full
|
||||
// sentences even when the tail of one came from ethers or from the node.
|
||||
function sentence(text) {
|
||||
@@ -111,6 +124,20 @@ function requestFrom(txParams, from) {
|
||||
for (const key of REQUEST_FIELDS) {
|
||||
if (present(txParams[key])) request[key] = txParams[key];
|
||||
}
|
||||
// JSON-RPC calls the gas limit `gas`, and that is the name sites send.
|
||||
// ethers only reads `gasLimit`: left as `gas` it would be dropped and an
|
||||
// estimate signed in its place.
|
||||
if (present(txParams.gas)) {
|
||||
if (
|
||||
present(request.gasLimit) &&
|
||||
!sameQuantity(request.gasLimit, txParams.gas)
|
||||
) {
|
||||
throw fail(
|
||||
"The site asked for two different gas limits for this transaction.",
|
||||
);
|
||||
}
|
||||
request.gasLimit = txParams.gas;
|
||||
}
|
||||
if (
|
||||
present(request.type) &&
|
||||
!ALLOWED_TX_TYPES.includes(Number(request.type))
|
||||
@@ -174,6 +201,7 @@ async function prepareApprovalTx(provider, from, txParams) {
|
||||
throw fail("There is no active address to send this transaction from.");
|
||||
}
|
||||
const request = requestFrom(txParams || {}, from);
|
||||
const signer = new VoidSigner(getAddress(from), provider);
|
||||
|
||||
let populated;
|
||||
try {
|
||||
@@ -181,10 +209,20 @@ async function prepareApprovalTx(provider, from, txParams) {
|
||||
// nonce, gas, fee and chain id are populated exactly as they were when
|
||||
// the popup did this. VoidSigner cannot sign, which is the point: the
|
||||
// background prepares, the popup signs.
|
||||
//
|
||||
// ethers asks the node for a gas estimate only when the request has
|
||||
// no gas limit, and that estimate is the only check that the
|
||||
// transaction does not revert. So a request carrying the site's gas
|
||||
// limit is estimated first, with that limit: one that reverts, or
|
||||
// needs more gas than the site gave it, fails here as well. The
|
||||
// site's gas limit is still the one populated.
|
||||
populated = await withTimeout(
|
||||
new VoidSigner(getAddress(from), provider).populateTransaction(
|
||||
request,
|
||||
),
|
||||
(async () => {
|
||||
if (present(request.gasLimit)) {
|
||||
await signer.estimateGas(request);
|
||||
}
|
||||
return signer.populateTransaction(request);
|
||||
})(),
|
||||
POPULATE_TIMEOUT_MS,
|
||||
"The transaction could not be prepared: the network did not answer in time.",
|
||||
);
|
||||
|
||||
@@ -53,6 +53,7 @@ const {
|
||||
accessListify,
|
||||
formatEther,
|
||||
getAddress,
|
||||
getBigInt,
|
||||
getBytes,
|
||||
toQuantity,
|
||||
verifyMessage,
|
||||
@@ -635,6 +636,33 @@ function verifySignature(signParams, signature, expectedFrom) {
|
||||
return recovered;
|
||||
}
|
||||
|
||||
// Why typed data cannot be signed while `network` is the active network, as a
|
||||
// sentence, or null when it can. EIP-712 has a wallet refuse typed data whose
|
||||
// domain names another chain, because the signature is valid on that chain.
|
||||
// ethers signs no chain id when the domain's is null or absent, and reads any
|
||||
// other with getBigInt(), so 1, "1" and "0x1" are the same chain here too.
|
||||
function typedDataChainRefusal(domain, network) {
|
||||
const chainId = domain?.chainId;
|
||||
if (chainId === undefined || chainId === null) return null;
|
||||
let named;
|
||||
try {
|
||||
named = getBigInt(chainId);
|
||||
} catch {
|
||||
return "This typed data cannot be read, so it cannot be signed.";
|
||||
}
|
||||
const active = getBigInt(network.chainId);
|
||||
if (named === active) return null;
|
||||
return (
|
||||
"This typed data is for chain id " +
|
||||
named +
|
||||
", but the active network is " +
|
||||
network.name +
|
||||
" (chain id " +
|
||||
active +
|
||||
"), so it cannot be signed."
|
||||
);
|
||||
}
|
||||
|
||||
// The stage a transaction approval failed at. Which stage it is decides
|
||||
// whether the approval survives the failure.
|
||||
const TX_STAGE_SIGN = "sign";
|
||||
@@ -796,6 +824,7 @@ function describeSigningFailure(response, fallbackMessage) {
|
||||
module.exports = {
|
||||
verifySignedTx,
|
||||
verifySignature,
|
||||
typedDataChainRefusal,
|
||||
assertNoForbiddenFields,
|
||||
assertNothingUnchecked,
|
||||
assertCanonicalBytes,
|
||||
|
||||
@@ -145,6 +145,14 @@ function sendMessage(message) {
|
||||
return invoke(runtimeApi(), "sendMessage", message);
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<Object>} the operating system and processor the browser
|
||||
* runs on.
|
||||
*/
|
||||
function getPlatformInfo() {
|
||||
return invoke(runtimeApi(), "getPlatformInfo");
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a message nobody is expected to answer, and swallow the fact that
|
||||
* nobody did.
|
||||
@@ -262,6 +270,7 @@ module.exports = {
|
||||
actionApi,
|
||||
alarmsApi,
|
||||
extensionApi,
|
||||
getPlatformInfo,
|
||||
hasBrowserNamespace,
|
||||
notify,
|
||||
runtimeApi,
|
||||
|
||||
@@ -110,11 +110,14 @@ function hashListed(hash) {
|
||||
* Generate hostname variants for subdomain matching.
|
||||
* "sub.evil.com" yields ["sub.evil.com", "evil.com"].
|
||||
*
|
||||
* A trailing dot is dropped: "evil.com." is the fully qualified spelling of
|
||||
* "evil.com", and the browser loads the same site from either.
|
||||
*
|
||||
* @param {string} hostname
|
||||
* @returns {string[]}
|
||||
*/
|
||||
function hostnameVariants(hostname) {
|
||||
const h = hostname.toLowerCase();
|
||||
const h = hostname.toLowerCase().replace(/\.$/, "");
|
||||
const variants = [h];
|
||||
const parts = h.split(".");
|
||||
// Parent domains: a.b.c.d -> b.c.d, c.d
|
||||
|
||||
@@ -576,7 +576,7 @@ const TOKENS = [
|
||||
symbol: "FLOKI",
|
||||
decimals: 9,
|
||||
name: "FLOKI",
|
||||
url: "",
|
||||
url: "https://floki.com",
|
||||
},
|
||||
{
|
||||
address: "0x7420B4b9a0110cdC71fB720908340C03F9Bc03EC",
|
||||
@@ -1290,7 +1290,7 @@ const TOKENS = [
|
||||
symbol: "TURBO",
|
||||
decimals: 18,
|
||||
name: "Turbo",
|
||||
url: "",
|
||||
url: "https://www.turbo-eth.com",
|
||||
},
|
||||
{
|
||||
address: "0xA27EC0006e59f245217Ff08CD52A7E8b169E62D2",
|
||||
|
||||
+32
-6
@@ -110,16 +110,33 @@ function addressFromPrivateKey(key) {
|
||||
return w.address;
|
||||
}
|
||||
|
||||
function getSignerForAddress(walletData, addrIndex, decryptedSecret) {
|
||||
// The signer for `addr`, one of the wallet's stored address records. An HD or
|
||||
// xprv address is derived at its own `index`, never at its position in the
|
||||
// wallet's list: the two differ once an import scan passes over an unused
|
||||
// index, or once an address that is not the last is removed. An HD or xprv
|
||||
// record without a valid `index` is refused before anything is derived.
|
||||
// Whatever the wallet type, the key is refused unless it is the key of
|
||||
// `addr.address`.
|
||||
function getSignerForAddress(walletData, addr, decryptedSecret) {
|
||||
if (
|
||||
(walletData.type === "hd" || walletData.type === "xprv") &&
|
||||
!(Number.isInteger(addr.index) && addr.index >= 0)
|
||||
) {
|
||||
throw new Error(
|
||||
"No derivation index is stored for " +
|
||||
addr.address +
|
||||
", so its key cannot be derived.",
|
||||
);
|
||||
}
|
||||
let signer;
|
||||
if (walletData.type === "hd") {
|
||||
const node = HDNodeWallet.fromPhrase(
|
||||
decryptedSecret,
|
||||
"",
|
||||
BIP44_ETH_PATH,
|
||||
);
|
||||
return node.deriveChild(addrIndex);
|
||||
}
|
||||
if (walletData.type === "xprv") {
|
||||
signer = node.deriveChild(addr.index);
|
||||
} else if (walletData.type === "xprv") {
|
||||
// Checked here rather than through masterXprvOrThrow so the message
|
||||
// fits the situation: nobody is importing anything at signing time,
|
||||
// and this wallet is already in storage. src/shared/walletDefects.js
|
||||
@@ -137,9 +154,18 @@ function getSignerForAddress(walletData, addrIndex, decryptedSecret) {
|
||||
"is not a master key, so it cannot sign.",
|
||||
);
|
||||
}
|
||||
return node.derivePath(BIP44_ETH_PATH).deriveChild(addrIndex);
|
||||
signer = node.derivePath(BIP44_ETH_PATH).deriveChild(addr.index);
|
||||
} else {
|
||||
signer = new Wallet(decryptedSecret);
|
||||
}
|
||||
return new Wallet(decryptedSecret);
|
||||
if (signer.address.toLowerCase() !== addr.address.toLowerCase()) {
|
||||
throw new Error(
|
||||
"The key this wallet holds for " +
|
||||
addr.address +
|
||||
" belongs to a different address, so it was not used.",
|
||||
);
|
||||
}
|
||||
return signer;
|
||||
}
|
||||
|
||||
function isValidMnemonic(mnemonic) {
|
||||
|
||||
@@ -36,11 +36,13 @@ const DEFECTS = {
|
||||
"derivation path beneath that key instead of from a master " +
|
||||
"key, so the addresses listed here are not the ones that key " +
|
||||
"produces under the standard path.",
|
||||
"Signing and sending are disabled for this wallet. The addresses " +
|
||||
"do descend from the extended private key you imported, so " +
|
||||
"anything they hold is still reachable by software that " +
|
||||
"repeats the same non-standard derivation. Check them in a " +
|
||||
"block explorer before deciding what to do.",
|
||||
"Signing, sending and private key export are disabled for this " +
|
||||
"wallet. Anything these addresses hold can be reached outside " +
|
||||
"this wallet with the extended private key you imported, if " +
|
||||
"you kept a copy of it, or with the master extended private " +
|
||||
"key or recovery phrase it came from, in software that " +
|
||||
"repeats the same non-standard derivation. Check the " +
|
||||
"addresses in a block explorer before deciding what to do.",
|
||||
"To see the addresses this key produces under the standard path, " +
|
||||
"import the master extended private key, or the recovery " +
|
||||
"phrase it came from, as a new wallet. Nothing here has been " +
|
||||
|
||||
@@ -0,0 +1,490 @@
|
||||
// Sending, a site's transaction and signature requests and private key export
|
||||
// each use the key of the address they name: the key at the index that address
|
||||
// was derived at, not the one at its position in the wallet's list. The two
|
||||
// differ after an import whose scan passed over an unused index, and after an
|
||||
// address that is not the last is removed
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/510). A send is signed by the
|
||||
// From address its confirmation screen shows, whichever address is selected.
|
||||
//
|
||||
// Driven through the real import, "+" button, address removal, confirmation
|
||||
// screen, transaction and signature approval screens and export screen, with
|
||||
// the node, the vault and the DOM stubbed.
|
||||
|
||||
"use strict";
|
||||
|
||||
// The addresses the stub node reports a balance for, and the signed
|
||||
// transactions it was handed.
|
||||
const mockNode = { funded: new Set(), broadcast: [] };
|
||||
|
||||
jest.mock("ethers", () => {
|
||||
const actual = jest.requireActual("ethers");
|
||||
class StubProvider {
|
||||
async getBalance(address) {
|
||||
return mockNode.funded.has(address) ? 1n : 0n;
|
||||
}
|
||||
async getTransactionCount() {
|
||||
return 0;
|
||||
}
|
||||
async estimateGas() {
|
||||
return 21000n;
|
||||
}
|
||||
async getFeeData() {
|
||||
return {
|
||||
maxFeePerGas: 20000000000n,
|
||||
maxPriorityFeePerGas: 1000000000n,
|
||||
gasPrice: 10000000000n,
|
||||
};
|
||||
}
|
||||
async getNetwork() {
|
||||
return { chainId: 1n };
|
||||
}
|
||||
async getCode() {
|
||||
return "0x";
|
||||
}
|
||||
async lookupAddress() {
|
||||
return null;
|
||||
}
|
||||
async broadcastTransaction(signed) {
|
||||
mockNode.broadcast.push(signed);
|
||||
return { hash: "0x" + "ab".repeat(32) };
|
||||
}
|
||||
}
|
||||
return { ...actual, JsonRpcProvider: StubProvider };
|
||||
});
|
||||
|
||||
// No password is hashed: what the wallet stores is the phrase itself.
|
||||
jest.mock("../src/shared/vault", () => ({
|
||||
encryptWithPassword: async (secret) => secret,
|
||||
decryptWithPassword: async (secret) => secret,
|
||||
}));
|
||||
|
||||
// The wait screen polls for a receipt; these tests stop at the broadcast.
|
||||
jest.mock("../src/popup/views/txStatus", () => ({
|
||||
showWait: jest.fn(),
|
||||
showError: jest.fn(),
|
||||
}));
|
||||
|
||||
jest.mock("ethereum-blockies-base64", () => () => "data:image/png;base64,x");
|
||||
|
||||
global.fetch = jest.fn(() => {
|
||||
throw new Error("tests must not perform network requests");
|
||||
});
|
||||
|
||||
const {
|
||||
HDNodeWallet,
|
||||
Mnemonic,
|
||||
Transaction,
|
||||
getBytes,
|
||||
verifyMessage,
|
||||
} = require("ethers");
|
||||
|
||||
// Publicly known development phrase; never fund it.
|
||||
const PHRASE = "test test test test test test test test test test test junk";
|
||||
// PHRASE's master extended private key, as the xprv import takes it.
|
||||
const XPRV = HDNodeWallet.fromSeed(
|
||||
Mnemonic.fromPhrase(PHRASE).computeSeed(),
|
||||
).extendedKey;
|
||||
const PASSWORD = "correct horse battery staple";
|
||||
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||
// "Hello", as the hex a page sends.
|
||||
const MESSAGE = "0x48656c6c6f";
|
||||
|
||||
// The address and key at derivation index `index` of PHRASE, worked out with
|
||||
// ethers directly rather than through the wallet's own code.
|
||||
function derived(index) {
|
||||
return HDNodeWallet.fromPhrase(PHRASE, "", "m/44'/60'/0'/0/" + index);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------ DOM stub
|
||||
|
||||
function makeElement(id) {
|
||||
const classes = new Set();
|
||||
const el = {
|
||||
id,
|
||||
textContent: "",
|
||||
title: "",
|
||||
value: "",
|
||||
innerHTML: "",
|
||||
disabled: false,
|
||||
style: {},
|
||||
dataset: {},
|
||||
listeners: {},
|
||||
classList: {
|
||||
add: (...names) => names.forEach((n) => classes.add(n)),
|
||||
remove: (...names) => names.forEach((n) => classes.delete(n)),
|
||||
contains: (n) => classes.has(n),
|
||||
toggle: (n, force) => {
|
||||
const on = force === undefined ? !classes.has(n) : force;
|
||||
if (on) classes.add(n);
|
||||
else classes.delete(n);
|
||||
return on;
|
||||
},
|
||||
},
|
||||
addEventListener: (name, fn) => {
|
||||
el.listeners[name] = el.listeners[name] || [];
|
||||
el.listeners[name].push(fn);
|
||||
},
|
||||
querySelectorAll: () => [],
|
||||
appendChild: () => {},
|
||||
};
|
||||
// Views reach for .parentElement to hide whole sections.
|
||||
Object.defineProperty(el, "parentElement", {
|
||||
get: () => node(id + "-parent"),
|
||||
});
|
||||
return el;
|
||||
}
|
||||
|
||||
function makeDocument() {
|
||||
const els = new Map();
|
||||
return {
|
||||
getElementById(id) {
|
||||
// The debug banner is created on demand by helpers.js; absent
|
||||
// is the state a non-debug, non-testnet popup is in.
|
||||
if (id === "debug-banner") return null;
|
||||
if (!els.has(id)) els.set(id, makeElement(id));
|
||||
return els.get(id);
|
||||
},
|
||||
createElement: () => makeElement("created"),
|
||||
addEventListener: () => {},
|
||||
body: { prepend: () => {} },
|
||||
};
|
||||
}
|
||||
|
||||
function node(id) {
|
||||
return globalThis.document.getElementById(id);
|
||||
}
|
||||
|
||||
function click(element) {
|
||||
const event = { stopPropagation: () => {} };
|
||||
return Promise.all((element.listeners.click || []).map((fn) => fn(event)));
|
||||
}
|
||||
|
||||
// show() starts the fee estimate without awaiting it; this lets it settle.
|
||||
async function settle() {
|
||||
for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------ harness
|
||||
|
||||
globalThis.chrome = {
|
||||
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||
};
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const { removeAddressFromState } = require("../src/shared/walletDelete");
|
||||
const addWallet = require("../src/popup/views/addWallet");
|
||||
const home = require("../src/popup/views/home");
|
||||
const confirmTx = require("../src/popup/views/confirmTx");
|
||||
const approval = require("../src/popup/views/approval");
|
||||
const exportPrivkey = require("../src/popup/views/exportPrivkey");
|
||||
const txStatus = require("../src/popup/views/txStatus");
|
||||
|
||||
// What the background answers when the approval window asks which approval it
|
||||
// was opened for, and every message the popup sent it.
|
||||
let approvalDetails;
|
||||
let sent;
|
||||
|
||||
// The "+" button of the wallet list's last render. Each render attaches the
|
||||
// handler to the buttons it drew, as the browser's fresh list would have.
|
||||
let plusButton;
|
||||
|
||||
beforeEach(() => {
|
||||
approvalDetails = null;
|
||||
sent = [];
|
||||
mockNode.broadcast = [];
|
||||
globalThis.document = makeDocument();
|
||||
globalThis.window = { close: () => {} };
|
||||
globalThis.chrome = {
|
||||
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||
runtime: {
|
||||
connect: () => ({ postMessage: () => {} }),
|
||||
sendMessage: (msg, reply) => {
|
||||
sent.push(msg);
|
||||
if (!reply) return;
|
||||
reply(
|
||||
msg.type === "AUTISTMASK_GET_APPROVAL"
|
||||
? approvalDetails
|
||||
: null,
|
||||
);
|
||||
},
|
||||
},
|
||||
};
|
||||
node("wallet-list").querySelectorAll = (selector) => {
|
||||
if (selector !== ".btn-add-address") return [];
|
||||
plusButton = makeElement("btn-add-address");
|
||||
plusButton.dataset.wallet = "0";
|
||||
return [plusButton];
|
||||
};
|
||||
// The explorer and price lookups these screens start fail offline, and
|
||||
// say so; that is not under test.
|
||||
for (const method of ["log", "warn", "error"]) {
|
||||
jest.spyOn(console, method).mockImplementation(() => {});
|
||||
}
|
||||
txStatus.showError.mockClear();
|
||||
|
||||
state.wallets = [];
|
||||
state.rpcUrl = "https://rpc.example.invalid";
|
||||
state.networkId = "mainnet";
|
||||
state.viewStack = [];
|
||||
state.currentView = "main";
|
||||
|
||||
addWallet.init({
|
||||
renderWalletList: () => {},
|
||||
doRefreshAndRender: () => {},
|
||||
pageClosed: new AbortController().signal,
|
||||
});
|
||||
confirmTx.init({});
|
||||
approval.init({});
|
||||
exportPrivkey.init();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
jest.restoreAllMocks();
|
||||
});
|
||||
|
||||
// Import PHRASE on the add-wallet screen, with the stub node reporting a
|
||||
// balance at each of `fundedIndices`, and wait for the address scan.
|
||||
async function importPhrase(fundedIndices) {
|
||||
mockNode.funded = new Set(fundedIndices.map((i) => derived(i).address));
|
||||
await click(node("tab-mnemonic"));
|
||||
node("wallet-mnemonic").value = PHRASE;
|
||||
node("add-wallet-password").value = PASSWORD;
|
||||
node("add-wallet-password-confirm").value = PASSWORD;
|
||||
await click(node("btn-add-wallet-confirm"));
|
||||
}
|
||||
|
||||
// The same, importing XPRV on the add-wallet screen's xprv tab.
|
||||
async function importXprv(fundedIndices) {
|
||||
mockNode.funded = new Set(fundedIndices.map((i) => derived(i).address));
|
||||
await click(node("tab-xprv"));
|
||||
node("import-xprv-key").value = XPRV;
|
||||
node("add-wallet-password").value = PASSWORD;
|
||||
node("add-wallet-password-confirm").value = PASSWORD;
|
||||
await click(node("btn-add-wallet-confirm"));
|
||||
}
|
||||
|
||||
// Press the wallet's "+" button on Home.
|
||||
async function addAddress() {
|
||||
home.render({
|
||||
doRefreshAndRender: () => {},
|
||||
pageClosed: new AbortController().signal,
|
||||
});
|
||||
await click(plusButton);
|
||||
}
|
||||
|
||||
// The key the export screen reveals for the address at `position`.
|
||||
async function exportedKey(position) {
|
||||
exportPrivkey.show(0, position);
|
||||
node("export-privkey-password").value = PASSWORD;
|
||||
await click(node("btn-export-privkey-confirm"));
|
||||
return node("export-privkey-value").textContent;
|
||||
}
|
||||
|
||||
// Confirm a send whose From line shows `from`, with the address at position
|
||||
// `selected` selected; resolves to the signed transaction the node was handed,
|
||||
// or undefined when none was.
|
||||
async function confirmSend(from, selected) {
|
||||
state.selectedWallet = 0;
|
||||
state.selectedAddress = selected;
|
||||
confirmTx.show({
|
||||
from,
|
||||
to: RECIPIENT,
|
||||
amount: "0.5",
|
||||
token: "ETH",
|
||||
balance: "1.0",
|
||||
});
|
||||
await settle();
|
||||
node("confirm-tx-password").value = PASSWORD;
|
||||
await click(node("btn-confirm-send"));
|
||||
return mockNode.broadcast.pop();
|
||||
}
|
||||
|
||||
// Send from the address at `position`, with that address selected, as the Send
|
||||
// button leaves it.
|
||||
function sendFrom(position) {
|
||||
return confirmSend(state.wallets[0].addresses[position].address, position);
|
||||
}
|
||||
|
||||
// A site asks the address at `position` to sign MESSAGE; resolves to the
|
||||
// response the approval window sent the background.
|
||||
async function signFor(position) {
|
||||
const address = state.wallets[0].addresses[position].address;
|
||||
approvalDetails = {
|
||||
type: "sign",
|
||||
origin: "https://dapp.example",
|
||||
isPhishingDomain: false,
|
||||
approvedFrom: address,
|
||||
signParams: {
|
||||
method: "personal_sign",
|
||||
message: MESSAGE,
|
||||
from: address,
|
||||
},
|
||||
};
|
||||
await approval.show(1);
|
||||
node("approve-sign-password").value = PASSWORD;
|
||||
await click(node("btn-approve-sign"));
|
||||
return sent.find((msg) => msg.type === "AUTISTMASK_SIGN_RESPONSE");
|
||||
}
|
||||
|
||||
// A site asks the address at `position` to send RECIPIENT a transaction of no
|
||||
// value; resolves to the response the approval window sent the background.
|
||||
async function transactFor(position) {
|
||||
const address = state.wallets[0].addresses[position].address;
|
||||
approvalDetails = {
|
||||
type: "tx",
|
||||
origin: "https://dapp.example",
|
||||
isPhishingDomain: false,
|
||||
approvedFrom: address,
|
||||
approvedTx: {
|
||||
type: 2,
|
||||
from: address,
|
||||
chainId: "0x1",
|
||||
nonce: "0x0",
|
||||
gasLimit: "0x5208",
|
||||
maxPriorityFeePerGas: "0x3b9aca00",
|
||||
maxFeePerGas: "0x77359400",
|
||||
to: RECIPIENT,
|
||||
value: "0x0",
|
||||
data: "0x",
|
||||
accessList: [],
|
||||
},
|
||||
};
|
||||
await approval.show(1);
|
||||
node("approve-tx-password").value = PASSWORD;
|
||||
await click(node("btn-approve-tx"));
|
||||
return sent.find((msg) => msg.type === "AUTISTMASK_TX_RESPONSE");
|
||||
}
|
||||
|
||||
describe.each([
|
||||
[
|
||||
"a recovery phrase import whose scan found only the first address",
|
||||
async () => {
|
||||
await importPhrase([0]);
|
||||
},
|
||||
// The address the import stores before its scan.
|
||||
{ position: 0, index: 0 },
|
||||
],
|
||||
[
|
||||
"an xprv import whose scan found only the first address",
|
||||
async () => {
|
||||
await importXprv([0]);
|
||||
},
|
||||
{ position: 0, index: 0 },
|
||||
],
|
||||
[
|
||||
"an import whose scan passed over index 3",
|
||||
async () => {
|
||||
await importPhrase([0, 1, 2, 4]);
|
||||
},
|
||||
// Address 4 on Home, derived at index 4.
|
||||
{ position: 3, index: 4 },
|
||||
],
|
||||
[
|
||||
"an xprv import whose scan passed over index 3",
|
||||
async () => {
|
||||
await importXprv([0, 1, 2, 4]);
|
||||
},
|
||||
{ position: 3, index: 4 },
|
||||
],
|
||||
[
|
||||
"removing the middle one of three addresses",
|
||||
async () => {
|
||||
await importPhrase([0]);
|
||||
await addAddress();
|
||||
await addAddress();
|
||||
removeAddressFromState(state, 0, 1);
|
||||
},
|
||||
// Address 2 on Home after the removal, derived at index 2.
|
||||
{ position: 1, index: 2 },
|
||||
],
|
||||
])("after %s", (_name, setUp, { position, index }) => {
|
||||
beforeEach(setUp);
|
||||
|
||||
test("the wallet lists the address derived at that index there", () => {
|
||||
expect(state.wallets[0].addresses[position].address).toBe(
|
||||
derived(index).address,
|
||||
);
|
||||
});
|
||||
|
||||
test("export reveals that address's key", async () => {
|
||||
expect(await exportedKey(position)).toBe(derived(index).privateKey);
|
||||
});
|
||||
|
||||
test("a send is signed by that address", async () => {
|
||||
const signed = await sendFrom(position);
|
||||
expect(Transaction.from(signed).from).toBe(derived(index).address);
|
||||
});
|
||||
|
||||
test("a site's signature is made by that address", async () => {
|
||||
const response = await signFor(position);
|
||||
expect(verifyMessage(getBytes(MESSAGE), response.signature)).toBe(
|
||||
derived(index).address,
|
||||
);
|
||||
});
|
||||
|
||||
test("a site's transaction is signed by that address", async () => {
|
||||
const response = await transactFor(position);
|
||||
expect(Transaction.from(response.rawSignedTx).from).toBe(
|
||||
derived(index).address,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
// The selection and the confirmation screen are saved apart, so the popup can
|
||||
// reopen onto the screen with another address selected than its From line
|
||||
// shows.
|
||||
describe("a confirmation screen whose From is not the selected address", () => {
|
||||
beforeEach(async () => {
|
||||
await importPhrase([0, 1]);
|
||||
});
|
||||
|
||||
test("the send is signed by the From address shown", async () => {
|
||||
const signed = await confirmSend(derived(1).address, 0);
|
||||
expect(Transaction.from(signed).from).toBe(derived(1).address);
|
||||
});
|
||||
|
||||
test("nothing is sent when the selected wallet does not hold it", async () => {
|
||||
expect(await confirmSend(derived(5).address, 0)).toBeUndefined();
|
||||
expect(node("confirm-tx-password-error").textContent).toBe(
|
||||
"The selected wallet does not hold the From address above, " +
|
||||
"so nothing was sent. Please go back and send again.",
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("an address whose stored index derives a different address", () => {
|
||||
function refusal() {
|
||||
return (
|
||||
"The key this wallet holds for " +
|
||||
derived(0).address +
|
||||
" belongs to a different address, so it was not used."
|
||||
);
|
||||
}
|
||||
|
||||
beforeEach(async () => {
|
||||
await importPhrase([0]);
|
||||
state.wallets[0].addresses[0].index = 1;
|
||||
});
|
||||
|
||||
test("export reveals nothing and says why", async () => {
|
||||
expect(await exportedKey(0)).toBe("");
|
||||
expect(node("export-privkey-password-error").textContent).toBe(
|
||||
refusal(),
|
||||
);
|
||||
});
|
||||
|
||||
test("nothing is sent", async () => {
|
||||
expect(await sendFrom(0)).toBeUndefined();
|
||||
expect(txStatus.showError).toHaveBeenCalledWith(
|
||||
expect.anything(),
|
||||
null,
|
||||
refusal(),
|
||||
);
|
||||
});
|
||||
|
||||
test("nothing is signed", async () => {
|
||||
const response = await signFor(0);
|
||||
expect(response.signature).toBeUndefined();
|
||||
expect(response.error).toBe(refusal());
|
||||
});
|
||||
});
|
||||
@@ -39,6 +39,8 @@ jest.doMock("../src/popup/views/helpers", () => ({
|
||||
$: element,
|
||||
showView: () => {},
|
||||
showFlash: () => {},
|
||||
showError: () => {},
|
||||
hideError: () => {},
|
||||
goBack: () => {},
|
||||
clearViewStack: () => {},
|
||||
onViewLeave: () => {},
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
// The token names and URLs in src/shared/tokenList.js are written from
|
||||
// script/lib/token-enrichment.json by script/lib/apply-enrichment.js
|
||||
// (`make apply-enrichment`). This fails when the committed list differs from
|
||||
// what the script writes from the committed data, and when the data or the
|
||||
// script's table of websites has an address that no entry in the list matches.
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
|
||||
const enrichment = require("../script/lib/token-enrichment.json");
|
||||
const { applyEnrichment } = require("../script/lib/apply-enrichment");
|
||||
|
||||
test("src/shared/tokenList.js is what make apply-enrichment writes from the committed data", () => {
|
||||
const committed = fs.readFileSync(
|
||||
path.join(__dirname, "..", "src/shared/tokenList.js"),
|
||||
"utf8",
|
||||
);
|
||||
expect(applyEnrichment(committed, enrichment)).toBe(committed);
|
||||
});
|
||||
@@ -136,7 +136,9 @@ async function openTxApproval(approvedTx) {
|
||||
xpub: "xpub-wallet-1",
|
||||
encryptedSecret: "encrypted-secret-1",
|
||||
nextIndex: 1,
|
||||
addresses: [{ address: FROM, balance: "0", tokenBalances: [] }],
|
||||
addresses: [
|
||||
{ address: FROM, index: 0, balance: "0", tokenBalances: [] },
|
||||
],
|
||||
},
|
||||
];
|
||||
approval.init({});
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// The connection, transaction and signature prompts name the site by its full
|
||||
// origin, scheme and port included, not by its bare hostname
|
||||
// The connection, transaction, signature and network switch prompts name the
|
||||
// site by its full origin, scheme and port included, not by its bare hostname
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/402). A page served over http,
|
||||
// or on another port, of a host the user trusts over https must not raise a
|
||||
// prompt that reads as that trusted site.
|
||||
@@ -104,6 +104,7 @@ beforeEach(() => {
|
||||
test("the connection prompt shows the origin", async () => {
|
||||
await openApproval({});
|
||||
expect(node("approve-origin").textContent).toBe(ORIGIN);
|
||||
expect(node("view-approve-site").classList.contains("hidden")).toBe(false);
|
||||
});
|
||||
|
||||
test("the transaction prompt shows the origin", async () => {
|
||||
@@ -138,3 +139,24 @@ test("the signature prompt shows the origin", async () => {
|
||||
});
|
||||
expect(node("approve-sign-origin").textContent).toBe(ORIGIN);
|
||||
});
|
||||
|
||||
test("the network switch prompt shows the origin and both networks", async () => {
|
||||
await openApproval({
|
||||
type: "network",
|
||||
currentNetworkId: "mainnet",
|
||||
requestedNetworkId: "sepolia",
|
||||
});
|
||||
expect(node("approve-network-origin").textContent).toBe(ORIGIN);
|
||||
expect(node("approve-network-current").textContent).toBe(
|
||||
"Ethereum Mainnet",
|
||||
);
|
||||
expect(node("approve-network-requested").textContent).toBe(
|
||||
"Sepolia Testnet",
|
||||
);
|
||||
// Its own screen, and not the connection prompt, whose "Allow" answers
|
||||
// on the same port.
|
||||
expect(node("view-approve-network").classList.contains("hidden")).toBe(
|
||||
false,
|
||||
);
|
||||
expect(node("view-approve-site").classList.contains("hidden")).toBe(true);
|
||||
});
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
// requesting page or the RPC node can say turns it into an approval that
|
||||
// should never have been raised.
|
||||
|
||||
const { Network, Wallet } = require("ethers");
|
||||
const { Network, Transaction, Wallet, toQuantity } = require("ethers");
|
||||
const {
|
||||
prepareApprovalTx,
|
||||
serializeApprovedTx,
|
||||
@@ -138,6 +138,49 @@ describe("prepareApprovalTx", () => {
|
||||
expect(approved.maxFeePerGas).toBe("0x12a05f200");
|
||||
});
|
||||
|
||||
// `gas` is the JSON-RPC name for the gas limit and the one sites send.
|
||||
// The node is still asked for its estimate, with the site's gas limit,
|
||||
// because the estimate is the check that the transaction does not revert.
|
||||
// It estimates 21000; the site's 200000 is what is shown and what is
|
||||
// signed.
|
||||
test("uses the gas limit a site sends as gas", async () => {
|
||||
const estimateGas = jest.fn(async () => 21000n);
|
||||
const approved = await prepareApprovalTx(
|
||||
providerWith({ estimateGas }),
|
||||
signer.address,
|
||||
{ ...TX_PARAMS, gas: "0x30d40" },
|
||||
);
|
||||
expect(estimateGas).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ gasLimit: 200000n }),
|
||||
);
|
||||
expect(approved.gasLimit).toBe("0x30d40");
|
||||
const signed = Transaction.from(
|
||||
await signer.signTransaction({ ...approved }),
|
||||
);
|
||||
expect(signed.gasLimit).toBe(200000n);
|
||||
});
|
||||
|
||||
test("accepts gas and gasLimit that name the same number", async () => {
|
||||
const approved = await prepareApprovalTx(
|
||||
providerWith(),
|
||||
signer.address,
|
||||
{ ...TX_PARAMS, gas: "0x30d40", gasLimit: 200000 },
|
||||
);
|
||||
expect(approved.gasLimit).toBe("0x30d40");
|
||||
});
|
||||
|
||||
test("refuses gas and gasLimit that disagree", async () => {
|
||||
await expect(
|
||||
prepareApprovalTx(providerWith(), signer.address, {
|
||||
...TX_PARAMS,
|
||||
gas: "0x30d40",
|
||||
gasLimit: "0x5208",
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
"The site asked for two different gas limits for this transaction.",
|
||||
);
|
||||
});
|
||||
|
||||
test("carries an access list the request asked for", async () => {
|
||||
const approved = await prepareApprovalTx(
|
||||
providerWith(),
|
||||
@@ -212,6 +255,15 @@ describe("prepareApprovalTx", () => {
|
||||
).rejects.toThrow(/gas limit no network this wallet supports/);
|
||||
});
|
||||
|
||||
test("refuses a gas limit the site sent above the ceiling", async () => {
|
||||
await expect(
|
||||
prepareApprovalTx(providerWith(), signer.address, {
|
||||
...TX_PARAMS,
|
||||
gas: toQuantity(MAX_GAS_LIMIT + 1n),
|
||||
}),
|
||||
).rejects.toThrow(/gas limit no network this wallet supports/);
|
||||
});
|
||||
|
||||
// The combined bound at population: a gas limit and a fee that are each
|
||||
// under their own ceiling but multiply to thousands of ETH is refused
|
||||
// before the approval window opens, so the user is never shown a
|
||||
@@ -251,6 +303,22 @@ describe("prepareApprovalTx", () => {
|
||||
expect(thrown.message).toMatch(/^[A-Z].*\.$/);
|
||||
});
|
||||
|
||||
test("fails back a reverting request that sends its own gas limit", async () => {
|
||||
const reverting = providerWith({
|
||||
estimateGas: async () => {
|
||||
throw new Error("execution reverted: ERC20: transfer amount");
|
||||
},
|
||||
});
|
||||
await expect(
|
||||
prepareApprovalTx(reverting, signer.address, {
|
||||
...TX_PARAMS,
|
||||
gas: "0x30d40",
|
||||
}),
|
||||
).rejects.toThrow(
|
||||
/^The transaction could not be prepared: execution reverted/,
|
||||
);
|
||||
});
|
||||
|
||||
// Without a bound, an unreachable node leaves the page's promise pending
|
||||
// with nothing on screen to explain it.
|
||||
test("gives up on a node that never answers", async () => {
|
||||
@@ -273,6 +341,28 @@ describe("prepareApprovalTx", () => {
|
||||
jest.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
// The estimate of a request carrying the site's gas limit is a call of its
|
||||
// own, made before populating, and is bounded the same way.
|
||||
test("gives up on a node that never answers the estimate of a request that sends its own gas limit", async () => {
|
||||
jest.useFakeTimers();
|
||||
try {
|
||||
const hanging = providerWith({
|
||||
estimateGas: () => new Promise(() => {}),
|
||||
});
|
||||
const pending = prepareApprovalTx(hanging, signer.address, {
|
||||
...TX_PARAMS,
|
||||
gas: "0x30d40",
|
||||
});
|
||||
const settled = expect(pending).rejects.toThrow(
|
||||
/did not answer in time/,
|
||||
);
|
||||
await jest.advanceTimersByTimeAsync(POPULATE_TIMEOUT_MS + 1);
|
||||
await settled;
|
||||
} finally {
|
||||
jest.useRealTimers();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe("serializeApprovedTx", () => {
|
||||
|
||||
@@ -58,7 +58,6 @@ const TX_PARAMS = {
|
||||
to: RECIPIENT,
|
||||
value: "0x2386f26fc10000",
|
||||
data: "0xdeadbeef",
|
||||
gas: "0x5208",
|
||||
};
|
||||
|
||||
// The values populateTransaction() fills in when the dApp fixed none of them.
|
||||
@@ -1455,7 +1454,11 @@ describe("background population to popup signing to verification", () => {
|
||||
|
||||
// What the popup does with it: signs it as given, populating nothing.
|
||||
async function popupSigns(approvedTx) {
|
||||
const localSigner = getSignerForAddress(walletData, 0, SIGNER_KEY);
|
||||
const localSigner = getSignerForAddress(
|
||||
walletData,
|
||||
{ address: signer.address },
|
||||
SIGNER_KEY,
|
||||
);
|
||||
return localSigner.signTransaction({ ...approvedTx });
|
||||
}
|
||||
|
||||
@@ -1550,7 +1553,11 @@ describe("background population to popup signing to verification", () => {
|
||||
// address the user has switched to.
|
||||
test("the approved from stops the popup signing with another key", async () => {
|
||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
||||
const otherSigner = getSignerForAddress(walletData, 0, OTHER_KEY);
|
||||
const otherSigner = getSignerForAddress(
|
||||
walletData,
|
||||
{ address: other.address },
|
||||
OTHER_KEY,
|
||||
);
|
||||
await expect(
|
||||
otherSigner.signTransaction({ ...approvedTx }),
|
||||
).rejects.toThrow(/from address mismatch/);
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
// The approval window shows no screen until the background has described the
|
||||
// approval it answers (https://git.eeqj.de/sneak/AutistMask/issues/408). The
|
||||
// connection prompt's "Allow" and the network switch prompt's "Switch" answer
|
||||
// on the same port, so a window that showed the connection prompt while it
|
||||
// waited could approve a network switch.
|
||||
//
|
||||
// Booted through the real popup entry point, which is where the connection
|
||||
// prompt used to be put up before the background had answered.
|
||||
|
||||
const {
|
||||
bootPopup,
|
||||
cleanupPopup,
|
||||
settle,
|
||||
unversionedValidProfile,
|
||||
} = require("./support/popupBoot");
|
||||
|
||||
afterEach(cleanupPopup);
|
||||
|
||||
test("the approval window shows no screen until the background describes the approval", async () => {
|
||||
// The background's answer, held until the test gives it.
|
||||
let answer = null;
|
||||
const env = await bootPopup(unversionedValidProfile(), {
|
||||
search: "?approval=approval-1",
|
||||
runtime: {
|
||||
connect: () => ({ postMessage: () => {} }),
|
||||
sendMessage: (msg, reply) => {
|
||||
if (msg.type === "AUTISTMASK_GET_APPROVAL") answer = reply;
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(answer).not.toBeNull();
|
||||
// No screen at all, the connection prompt included.
|
||||
expect(env.visibleViews()).toEqual([]);
|
||||
|
||||
answer({
|
||||
type: "network",
|
||||
origin: "https://dapp.example",
|
||||
currentNetworkId: "mainnet",
|
||||
requestedNetworkId: "sepolia",
|
||||
isPhishingDomain: false,
|
||||
});
|
||||
await settle();
|
||||
|
||||
expect(env.visibleViews()).toEqual(["approve-network"]);
|
||||
expect(env.pageErrors).toEqual([]);
|
||||
});
|
||||
@@ -52,6 +52,7 @@ const {
|
||||
resetRenderedViews,
|
||||
} = require("../src/popup/viewRouter");
|
||||
const { state } = require("../src/shared/state");
|
||||
const { restorableStack } = require("../src/shared/persistedState");
|
||||
|
||||
const ADDRESS = "0x1111111111111111111111111111111111111111";
|
||||
const TOKEN = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
|
||||
@@ -209,6 +210,23 @@ describe("Back onto a view the reopened popup never rendered", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/481. Settings, the recovery
|
||||
// phrase or delete wallet screen, the gear, then a reopen: the restored stack
|
||||
// is cut at the screen the gear left, which leaves Settings under the Settings
|
||||
// the popup reopens onto.
|
||||
describe("Back from Settings reopened over its own entry", () => {
|
||||
test.each(["show-phrase", "delete-wallet-confirm"])(
|
||||
"goes to the screen under it after leaving %s",
|
||||
(left) => {
|
||||
const stored = ["main", "settings", left];
|
||||
reopenedOn("settings", restorableStack(stored, "settings"));
|
||||
goBack();
|
||||
expect(calls).toEqual(["main"]);
|
||||
expect(state.currentView).toBe("main");
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
// The guards are restoreView()'s, so a popped view whose backing data is
|
||||
// gone lands on Home rather than on an empty template.
|
||||
describe("Back onto a view whose backing data is gone", () => {
|
||||
|
||||
@@ -264,6 +264,7 @@ function loadBackground(options) {
|
||||
connectListener = fn;
|
||||
},
|
||||
},
|
||||
getPlatformInfo: jest.fn((cb) => cb({ os: "linux" })),
|
||||
lastError: null,
|
||||
},
|
||||
windows: {
|
||||
@@ -397,7 +398,13 @@ function loadBackground(options) {
|
||||
rpcResult = r;
|
||||
},
|
||||
);
|
||||
return { result: () => rpcResult };
|
||||
return {
|
||||
id: () =>
|
||||
new URL(created[created.length - 1].url).searchParams.get(
|
||||
"approval",
|
||||
),
|
||||
result: () => rpcResult,
|
||||
};
|
||||
}
|
||||
|
||||
// A dApp asking to connect. The origin defaults to one the persisted
|
||||
@@ -872,6 +879,43 @@ describe("one transaction approval at a time", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// Chrome stops an idle worker, and the approvals in it go with it
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/540). tests/e2e/slowApproval.js
|
||||
// shows the worker kept running in Chrome; this shows the calls stop once the
|
||||
// approval is answered, so the worker can stop again.
|
||||
describe("the worker keeps running while an approval is pending", () => {
|
||||
test("an extension call every 20 seconds until the approval is answered", async () => {
|
||||
const startTimer = jest
|
||||
.spyOn(global, "setInterval")
|
||||
.mockImplementation(() => 1);
|
||||
const stopTimer = jest
|
||||
.spyOn(global, "clearInterval")
|
||||
.mockImplementation(() => {});
|
||||
try {
|
||||
const bg = loadBackground();
|
||||
const calls = global.chrome.runtime.getPlatformInfo;
|
||||
bg.requestTx();
|
||||
await settle();
|
||||
expect(startTimer).toHaveBeenCalledTimes(1);
|
||||
expect(startTimer.mock.calls[0][1]).toBe(20000);
|
||||
const tick = startTimer.mock.calls[0][0];
|
||||
|
||||
tick();
|
||||
expect(calls).toHaveBeenCalledTimes(1);
|
||||
|
||||
// The user closes the approval window, which rejects it.
|
||||
bg.closeWindow(1);
|
||||
await settle();
|
||||
tick();
|
||||
expect(calls).toHaveBeenCalledTimes(1);
|
||||
expect(stopTimer).toHaveBeenCalledWith(1);
|
||||
} finally {
|
||||
startTimer.mockRestore();
|
||||
stopTimer.mockRestore();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// A page that asks again before the user has answered its last connection or
|
||||
// signature request is refused, instead of opening one more window per call.
|
||||
describe("one connection and one signature approval per site at a time", () => {
|
||||
@@ -1484,6 +1528,55 @@ describe("what the approval is verified against", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// Typed data whose domain names another chain is refused on the sign
|
||||
// screen; a signature for it that reaches the background anyway is not
|
||||
// handed to the page (https://git.eeqj.de/sneak/AutistMask/issues/519).
|
||||
// TYPED_DATA names mainnet.
|
||||
async function answerTypedData(bg, pending) {
|
||||
const { domain, types, message } = JSON.parse(TYPED_DATA);
|
||||
delete types.EIP712Domain;
|
||||
const signature = await signer.signTypedData(domain, types, message);
|
||||
const answer = bg.send(
|
||||
{
|
||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
||||
id: pending.id(),
|
||||
approved: true,
|
||||
signature,
|
||||
},
|
||||
{ url: bg.fromPopup.url },
|
||||
);
|
||||
await settle();
|
||||
return { answer, signature };
|
||||
}
|
||||
|
||||
test("typed data for the active chain is handed back signed", async () => {
|
||||
const bg = loadBackground();
|
||||
const pending = bg.requestTypedData();
|
||||
await settle();
|
||||
|
||||
const { answer, signature } = await answerTypedData(bg, pending);
|
||||
|
||||
expect(answer.sendResponse).toHaveBeenCalledWith({ signature });
|
||||
expect(pending.result()).toEqual({ result: signature });
|
||||
});
|
||||
|
||||
test("typed data for another chain is refused, not handed back", async () => {
|
||||
const bg = loadBackground();
|
||||
bg.setNetwork(SEPOLIA);
|
||||
const pending = bg.requestTypedData();
|
||||
await settle();
|
||||
|
||||
const { answer } = await answerTypedData(bg, pending);
|
||||
|
||||
const refusal =
|
||||
"This typed data is for chain id 1, but the active network is Sepolia Testnet (chain id 11155111), so it cannot be signed.";
|
||||
expect(answer.sendResponse).toHaveBeenCalledWith({
|
||||
error: refusal,
|
||||
retryable: false,
|
||||
});
|
||||
expect(pending.result()).toEqual({ error: { message: refusal } });
|
||||
});
|
||||
|
||||
test("a sign request from another address raises no approval at all", async () => {
|
||||
const bg = loadBackground();
|
||||
const pending = bg.requestSign(other.address);
|
||||
@@ -1551,6 +1644,55 @@ describe("what the approval is verified against", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// eth_sign names the address first and the data second, the reverse of
|
||||
// personal_sign, and is answered as the JSON-RPC specification defines it:
|
||||
// with an EIP-191 personal message signature over the data, the same
|
||||
// signature personal_sign returns
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/409). The signature below is
|
||||
// made by the test; that the sign screen makes the same one is tested in
|
||||
// tests/ethSign.test.js.
|
||||
describe("eth_sign", () => {
|
||||
test("is read address first, and returns a personal message signature over the data", async () => {
|
||||
const bg = loadBackground();
|
||||
const page = bg.send(
|
||||
{
|
||||
type: "AUTISTMASK_RPC",
|
||||
method: "eth_sign",
|
||||
params: [signer.address, MESSAGE],
|
||||
},
|
||||
{ origin: ORIGIN },
|
||||
);
|
||||
await settle();
|
||||
const id = approvalIdIn(bg.created.map((c) => c.url));
|
||||
|
||||
const details = bg.send(
|
||||
{ type: "AUTISTMASK_GET_APPROVAL", id },
|
||||
{ url: bg.fromPopup.url },
|
||||
);
|
||||
const { signParams } = details.sendResponse.mock.calls[0][0];
|
||||
expect(signParams).toMatchObject({
|
||||
method: "eth_sign",
|
||||
message: MESSAGE,
|
||||
from: signer.address,
|
||||
});
|
||||
expect(signParams.dangerWarning).toBe(
|
||||
"This site used the older eth_sign method. " +
|
||||
"The data will be signed as a personal message.",
|
||||
);
|
||||
|
||||
const signature = await signer.signMessage(
|
||||
Buffer.from(MESSAGE.slice(2), "hex"),
|
||||
);
|
||||
bg.send(
|
||||
{ type: "AUTISTMASK_SIGN_RESPONSE", id, approved: true, signature },
|
||||
{ url: bg.fromPopup.url },
|
||||
);
|
||||
await settle();
|
||||
|
||||
expect(page.sendResponse).toHaveBeenCalledWith({ result: signature });
|
||||
});
|
||||
});
|
||||
|
||||
// The interlock must not cost the retry the approval exists to allow.
|
||||
describe("the interlock releases a failed attempt", () => {
|
||||
test("a retryable failure before the broadcast leaves the approval usable", async () => {
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
|
||||
const { Wallet } = require("ethers");
|
||||
const { networkById } = require("../src/shared/networks");
|
||||
const { applyChainSwitchFields } = require("../src/shared/chainSwitchFields");
|
||||
const { makeStorageStub } = require("./support/storageStub");
|
||||
|
||||
const SIGNER_KEY =
|
||||
@@ -240,8 +241,8 @@ describe("a chain switch under a transaction already committed to a chain", () =
|
||||
// The artifact is verified against the chain read at the top of the
|
||||
// attempt. Whatever endpoint it is then broadcast to has to be that same
|
||||
// chain's — otherwise the wallet checks a transaction against Sepolia and
|
||||
// sends it to a mainnet node. A connected site can switch the chain at any
|
||||
// moment, including this one.
|
||||
// sends it to a mainnet node. The user can switch the network in Settings
|
||||
// at any moment, including this one.
|
||||
test("the artifact is broadcast to the endpoint of the chain it was verified against", async () => {
|
||||
const bg = loadWorker("sepolia");
|
||||
|
||||
@@ -264,9 +265,9 @@ describe("a chain switch under a transaction already committed to a chain", () =
|
||||
populated(Number(SEPOLIA.networkVersion)),
|
||||
);
|
||||
|
||||
// A connected site switches the chain while the attempt is running,
|
||||
// and the switch is committed to storage in full before the attempt
|
||||
// goes any further.
|
||||
// The user switches the network in Settings while the attempt is
|
||||
// running: the popup writes the switched record to storage in full
|
||||
// before the attempt goes any further.
|
||||
//
|
||||
// It is fired from inside the attempt's SECOND state read, because
|
||||
// that is where the window used to be: the chain id was captured at
|
||||
@@ -277,18 +278,18 @@ describe("a chain switch under a transaction already committed to a chain", () =
|
||||
// this to fire on, and the switch below runs after the attempt is
|
||||
// done instead — which is the point.
|
||||
let reads = 0;
|
||||
let switched = null;
|
||||
const doSwitch = async () => {
|
||||
switched = bg.rpc("wallet_switchEthereumChain", [
|
||||
{ chainId: MAINNET.chainId },
|
||||
]);
|
||||
await settle();
|
||||
let switched = false;
|
||||
const doSwitch = () => {
|
||||
const record = bg.persisted();
|
||||
applyChainSwitchFields(record, MAINNET.id);
|
||||
global.chrome.storage.write("autistmask", record);
|
||||
switched = true;
|
||||
};
|
||||
bg.setGetHook(async () => {
|
||||
reads++;
|
||||
if (reads !== 2) return;
|
||||
bg.setGetHook(null);
|
||||
await doSwitch();
|
||||
doSwitch();
|
||||
});
|
||||
|
||||
const attempt = bg.send(
|
||||
@@ -303,8 +304,7 @@ describe("a chain switch under a transaction already committed to a chain", () =
|
||||
await settle();
|
||||
|
||||
bg.setGetHook(null);
|
||||
if (!switched) await doSwitch();
|
||||
expect(switched.result()).toEqual({ result: null });
|
||||
if (!switched) doSwitch();
|
||||
expect(bg.persisted().networkId).toBe("mainnet");
|
||||
await settle();
|
||||
|
||||
|
||||
+328
-42
@@ -1,16 +1,24 @@
|
||||
// Who may move the active chain.
|
||||
// Who may move the active chain, and when.
|
||||
//
|
||||
// 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.
|
||||
// on Sepolia (https://git.eeqj.de/sneak/AutistMask/issues/308). Gated on the
|
||||
// connection, a connected site could still move the wallet between mainnet and
|
||||
// Sepolia without asking. Only the user switches the network: a connected
|
||||
// site's request opens a prompt, and nothing changes unless the user approves
|
||||
// it there (https://git.eeqj.de/sneak/AutistMask/issues/408).
|
||||
//
|
||||
// The endpoint half of that issue lives in tests/networkEndpoints.test.js,
|
||||
// which covers the popup's chain switch; this file covers the background's,
|
||||
// which goes through storage rather than the shared state singleton.
|
||||
// Every refusal is asserted as a refusal to ACT — the stored record unmoved
|
||||
// and no chainChanged broadcast — because an error code alone would not
|
||||
// distinguish a refusal from a switch that happened and then reported a
|
||||
// failure.
|
||||
//
|
||||
// The endpoint half of #308 lives in tests/networkEndpoints.test.js, which
|
||||
// covers the popup's chain switch; this file covers the background's, which
|
||||
// goes through storage rather than the shared state singleton. The last block
|
||||
// covers what the background tells open tabs when the user switches the
|
||||
// network in Settings.
|
||||
|
||||
const { networkById } = require("../src/shared/networks");
|
||||
const { makeStorageStub } = require("./support/storageStub");
|
||||
@@ -21,18 +29,23 @@ const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||
const STRANGER_ORIGIN = "https://stranger.example";
|
||||
|
||||
const EXT_URL = "chrome-extension://autistmask/";
|
||||
|
||||
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";
|
||||
|
||||
// A balance a switch would clear, so a switch that happens is visible here too.
|
||||
function walletFixture() {
|
||||
return [
|
||||
{
|
||||
name: "Wallet 1",
|
||||
type: "hd",
|
||||
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
||||
addresses: [
|
||||
{ address: ADDRESS, balance: "1.5", tokenBalances: [] },
|
||||
],
|
||||
},
|
||||
];
|
||||
}
|
||||
@@ -47,10 +60,6 @@ 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 and persistence modules behind it, and return the handles to
|
||||
// drive it.
|
||||
@@ -91,30 +100,46 @@ function loadBackground() {
|
||||
const storage = makeStorageStub({ autistmask: persisted });
|
||||
|
||||
let messageListener = null;
|
||||
let connectListener = null;
|
||||
let windowRemovedListener = null;
|
||||
// The URL of every approval window the background opened. The approval id
|
||||
// is in it, and that is how the popup learns which approval it answers.
|
||||
const opened = [];
|
||||
// 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.
|
||||
// is what tells a page the wallet moved, so a switch is visible here as
|
||||
// well as in the state.
|
||||
const toTabs = [];
|
||||
|
||||
global.chrome = {
|
||||
storage,
|
||||
runtime: {
|
||||
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||
getURL: (path) => EXT_URL + path,
|
||||
onMessage: {
|
||||
addListener: (fn) => {
|
||||
messageListener = fn;
|
||||
},
|
||||
},
|
||||
onConnect: { addListener: () => {} },
|
||||
onConnect: {
|
||||
addListener: (fn) => {
|
||||
connectListener = fn;
|
||||
},
|
||||
},
|
||||
lastError: null,
|
||||
},
|
||||
windows: {
|
||||
getLastFocused: (cb) => cb(null),
|
||||
create: (options, cb) => cb({ id: 1 }),
|
||||
create: (options, cb) => {
|
||||
opened.push(options.url);
|
||||
cb({ id: opened.length });
|
||||
},
|
||||
remove: (id, cb) => {
|
||||
if (cb) cb();
|
||||
},
|
||||
onRemoved: { addListener: () => {} },
|
||||
onRemoved: {
|
||||
addListener: (fn) => {
|
||||
windowRemovedListener = fn;
|
||||
},
|
||||
},
|
||||
},
|
||||
tabs: {
|
||||
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||
@@ -128,6 +153,8 @@ function loadBackground() {
|
||||
|
||||
require("../src/background/index");
|
||||
|
||||
// A page's request. Its answer is read with result(), which is null for as
|
||||
// long as the request is waiting on the user.
|
||||
async function switchChain(chainId, origin) {
|
||||
let result = null;
|
||||
messageListener(
|
||||
@@ -142,55 +169,309 @@ function loadBackground() {
|
||||
},
|
||||
);
|
||||
await settle();
|
||||
return result;
|
||||
return { result: () => result };
|
||||
}
|
||||
|
||||
function promptId() {
|
||||
return new URL(opened[opened.length - 1]).searchParams.get("approval");
|
||||
}
|
||||
|
||||
// What the popup is told to show for the prompt.
|
||||
function describePrompt() {
|
||||
let reply = null;
|
||||
messageListener(
|
||||
{ type: "AUTISTMASK_GET_APPROVAL", id: promptId() },
|
||||
{ url: EXT_URL + "src/popup/index.html" },
|
||||
(r) => {
|
||||
reply = r;
|
||||
},
|
||||
);
|
||||
return reply;
|
||||
}
|
||||
|
||||
// The user's answer, as the popup sends it: on the port named for the
|
||||
// approval, from the extension's own page, and then the window closes.
|
||||
async function answerPrompt(approved) {
|
||||
const onMessage = [];
|
||||
const onDisconnect = [];
|
||||
const port = {
|
||||
name: "approval:" + promptId(),
|
||||
sender: { url: EXT_URL + "src/popup/index.html" },
|
||||
onMessage: { addListener: (fn) => onMessage.push(fn) },
|
||||
onDisconnect: { addListener: (fn) => onDisconnect.push(fn) },
|
||||
};
|
||||
connectListener(port);
|
||||
for (const fn of onMessage) {
|
||||
fn(
|
||||
{
|
||||
type: "AUTISTMASK_APPROVAL_DECISION",
|
||||
approved,
|
||||
remember: false,
|
||||
},
|
||||
port,
|
||||
);
|
||||
}
|
||||
for (const fn of onDisconnect) fn(port);
|
||||
await settle();
|
||||
}
|
||||
|
||||
// The user closes the prompt window without answering it.
|
||||
async function closePrompt() {
|
||||
windowRemovedListener(opened.length);
|
||||
await settle();
|
||||
}
|
||||
|
||||
return {
|
||||
switchChain,
|
||||
describePrompt,
|
||||
answerPrompt,
|
||||
closePrompt,
|
||||
opened,
|
||||
// A message to the background from `sender`, and its answer.
|
||||
send: (msg, sender) => {
|
||||
let reply = null;
|
||||
messageListener(msg, sender, (r) => {
|
||||
reply = r;
|
||||
});
|
||||
return reply;
|
||||
},
|
||||
walletState: () => storage.read("autistmask"),
|
||||
chainChangedEvents: () =>
|
||||
toTabs.filter((m) => m.eventName === "chainChanged"),
|
||||
};
|
||||
}
|
||||
|
||||
const USER_REJECTED = { code: 4001, message: "User rejected the request." };
|
||||
|
||||
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 before = bg.walletState();
|
||||
|
||||
const result = await bg.switchChain(SEPOLIA.chainId, STRANGER_ORIGIN);
|
||||
const request = await bg.switchChain(SEPOLIA.chainId, STRANGER_ORIGIN);
|
||||
|
||||
expect(result.error).toEqual({ code: 4100, message: "Unauthorized" });
|
||||
expect(result.result).toBeUndefined();
|
||||
expect(request.result().error).toEqual({
|
||||
code: 4100,
|
||||
message: "Unauthorized",
|
||||
});
|
||||
expect(request.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);
|
||||
// no page was told the chain moved. Nor was the user asked.
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
expect(bg.opened).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);
|
||||
const request = await bg.switchChain(MAINNET.chainId, STRANGER_ORIGIN);
|
||||
|
||||
expect(result.error).toEqual({ code: 4100, message: "Unauthorized" });
|
||||
expect(request.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);
|
||||
const request = await bg.switchChain("0x89", STRANGER_ORIGIN);
|
||||
|
||||
expect(result.error.code).toBe(4100);
|
||||
expect(request.result().error.code).toBe(4100);
|
||||
});
|
||||
});
|
||||
|
||||
describe("only the user switches the network", () => {
|
||||
test("a connected site's request changes nothing while the prompt is open", async () => {
|
||||
const bg = loadBackground();
|
||||
const before = bg.walletState();
|
||||
|
||||
const request = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
|
||||
// Waiting on the user, with one prompt on screen naming the site and
|
||||
// both networks.
|
||||
expect(request.result()).toBeNull();
|
||||
expect(bg.opened).toHaveLength(1);
|
||||
expect(bg.describePrompt()).toMatchObject({
|
||||
origin: CONNECTED_ORIGIN,
|
||||
type: "network",
|
||||
currentNetworkId: "mainnet",
|
||||
requestedNetworkId: "sepolia",
|
||||
});
|
||||
|
||||
test("a connected origin switches the chain", async () => {
|
||||
// The network, the endpoints and the balances are as they were, and
|
||||
// no page was told otherwise.
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
test("approving the prompt switches the network", async () => {
|
||||
const bg = loadBackground();
|
||||
|
||||
const result = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
const request = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
await bg.answerPrompt(true);
|
||||
|
||||
expect(request.result()).toEqual({ result: null });
|
||||
const after = bg.walletState();
|
||||
expect(after.networkId).toBe("sepolia");
|
||||
expect(after.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||
expect(after.wallets[0].addresses[0].balance).toBe("0");
|
||||
expect(bg.chainChangedEvents()).toEqual([
|
||||
{
|
||||
type: "AUTISTMASK_EVENT",
|
||||
eventName: "chainChanged",
|
||||
data: SEPOLIA.chainId,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
test("rejecting the prompt changes nothing and answers 4001", async () => {
|
||||
const bg = loadBackground();
|
||||
const before = bg.walletState();
|
||||
|
||||
const request = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
await bg.answerPrompt(false);
|
||||
|
||||
expect(request.result()).toEqual({ error: USER_REJECTED });
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
test("closing the prompt without answering changes nothing and answers 4001", async () => {
|
||||
const bg = loadBackground();
|
||||
const before = bg.walletState();
|
||||
|
||||
const request = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
await bg.closePrompt();
|
||||
|
||||
expect(request.result()).toEqual({ error: USER_REJECTED });
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
test("a request for the chain already active opens no prompt", async () => {
|
||||
const bg = loadBackground();
|
||||
const before = bg.walletState();
|
||||
|
||||
const request = await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
||||
|
||||
expect(request.result()).toEqual({ result: null });
|
||||
expect(bg.opened).toEqual([]);
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
test("a second request while the prompt is open is refused with -32002", async () => {
|
||||
const bg = loadBackground();
|
||||
|
||||
const first = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
const second = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
|
||||
expect(second.result().error.code).toBe(-32002);
|
||||
expect(bg.opened).toHaveLength(1);
|
||||
|
||||
// The first prompt still decides.
|
||||
await bg.answerPrompt(true);
|
||||
expect(first.result()).toEqual({ result: null });
|
||||
expect(bg.walletState().networkId).toBe("sepolia");
|
||||
});
|
||||
|
||||
test("a request for an unsupported chain still gets 4902 and no prompt", async () => {
|
||||
const bg = loadBackground();
|
||||
|
||||
const request = await bg.switchChain("0x89", CONNECTED_ORIGIN);
|
||||
|
||||
expect(request.result().error.code).toBe(4902);
|
||||
expect(bg.opened).toEqual([]);
|
||||
expect(bg.walletState().networkId).toBe("mainnet");
|
||||
});
|
||||
|
||||
test("an approved switch keeps the user's endpoint", async () => {
|
||||
const bg = loadBackground();
|
||||
|
||||
await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
await bg.answerPrompt(true);
|
||||
expect(bg.walletState().rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||
|
||||
await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
||||
await bg.answerPrompt(true);
|
||||
expect(bg.walletState().rpcUrl).toBe(CUSTOM_RPC);
|
||||
});
|
||||
});
|
||||
|
||||
// Switching the network in Settings tells open pages, as an approved site
|
||||
// request does (https://git.eeqj.de/sneak/AutistMask/issues/500). These drive
|
||||
// the real Settings view over the background's storage, with what it sends
|
||||
// delivered to the background from the extension's own page.
|
||||
describe("switching the network in Settings tells every open tab", () => {
|
||||
const POPUP = { url: EXT_URL + "src/popup/index.html" };
|
||||
|
||||
// A stand-in for one DOM node: enough of an element for init() to set
|
||||
// properties on it and hang listeners off it.
|
||||
function fakeElement() {
|
||||
return {
|
||||
value: "",
|
||||
checked: false,
|
||||
textContent: "",
|
||||
style: {},
|
||||
dataset: {},
|
||||
classList: { add() {}, remove() {} },
|
||||
listeners: {},
|
||||
addEventListener(event, handler) {
|
||||
this.listeners[event] = handler;
|
||||
},
|
||||
querySelectorAll: () => [],
|
||||
};
|
||||
}
|
||||
|
||||
// Settings, opened the way the popup opens it. Returns its network
|
||||
// selector.
|
||||
async function openSettings(bg) {
|
||||
const elements = {};
|
||||
const element = (id) => (elements[id] ||= fakeElement());
|
||||
jest.doMock("../src/popup/views/helpers", () => ({
|
||||
$: element,
|
||||
showView: () => {},
|
||||
updateDebugBanner: () => {},
|
||||
showFlash: () => {},
|
||||
escapeHtml: (s) => s,
|
||||
flashCopyFeedback: () => {},
|
||||
goBack: () => {},
|
||||
pushCurrentView: () => {},
|
||||
onViewLeave: () => {},
|
||||
VIEWS: [],
|
||||
}));
|
||||
global.chrome.runtime.sendMessage = (msg) => {
|
||||
bg.send(msg, POPUP);
|
||||
};
|
||||
await require("../src/shared/state").loadState();
|
||||
require("../src/popup/views/settings").init({
|
||||
pageClosed: new AbortController().signal,
|
||||
});
|
||||
const select = element("settings-network");
|
||||
select.value = "mainnet";
|
||||
return select;
|
||||
}
|
||||
|
||||
// The user picks `networkId` in the selector.
|
||||
async function choose(select, networkId) {
|
||||
select.value = networkId;
|
||||
await select.listeners.change();
|
||||
await settle();
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
jest.dontMock("../src/popup/views/helpers");
|
||||
});
|
||||
|
||||
test("switching to the other network sends chainChanged once, with its chain id", async () => {
|
||||
const bg = loadBackground();
|
||||
const select = await openSettings(bg);
|
||||
|
||||
await choose(select, "sepolia");
|
||||
|
||||
expect(result).toEqual({ result: null });
|
||||
expect(bg.walletState().networkId).toBe("sepolia");
|
||||
expect(bg.chainChangedEvents()).toEqual([
|
||||
{
|
||||
@@ -201,22 +482,27 @@ describe("wallet_switchEthereumChain is gated on the connection", () => {
|
||||
]);
|
||||
});
|
||||
|
||||
test("a connected origin asking for an unsupported chain still gets 4902", async () => {
|
||||
test("choosing the network already active changes nothing and sends nothing", async () => {
|
||||
const bg = loadBackground();
|
||||
const select = await openSettings(bg);
|
||||
const before = bg.walletState();
|
||||
|
||||
const result = await bg.switchChain("0x89", CONNECTED_ORIGIN);
|
||||
await choose(select, "mainnet");
|
||||
|
||||
expect(result.error.code).toBe(4902);
|
||||
expect(bg.walletState().networkId).toBe("mainnet");
|
||||
expect(bg.walletState()).toEqual(before);
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
test("a switch by a connected origin keeps the user's endpoint", async () => {
|
||||
test("a page cannot make the background send chainChanged", async () => {
|
||||
const bg = loadBackground();
|
||||
|
||||
await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||
expect(bg.walletState().rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||
const reply = bg.send(
|
||||
{ type: "AUTISTMASK_NETWORK_CHANGED", chainId: SEPOLIA.chainId },
|
||||
{ url: CONNECTED_ORIGIN + "/" },
|
||||
);
|
||||
await settle();
|
||||
|
||||
await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
||||
expect(bg.walletState().rpcUrl).toBe(CUSTOM_RPC);
|
||||
expect(reply).toEqual({ error: "Unauthorized sender" });
|
||||
expect(bg.chainChangedEvents()).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -14,6 +14,10 @@
|
||||
// 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.
|
||||
//
|
||||
// A site's switch happens only once the user approves it on a prompt
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/408), so every switch here is
|
||||
// approved the way the popup approves one.
|
||||
|
||||
const { networkById } = require("../src/shared/networks");
|
||||
const { makeStorageStub } = require("./support/storageStub");
|
||||
@@ -90,6 +94,9 @@ function loadColdWorker(networkId) {
|
||||
const storage = makeStorageStub({ autistmask: storedProfile(networkId) });
|
||||
|
||||
let messageListener = null;
|
||||
let connectListener = null;
|
||||
// The URL of every approval window opened; the approval id is in it.
|
||||
const opened = [];
|
||||
const toTabs = [];
|
||||
|
||||
global.chrome = {
|
||||
@@ -101,12 +108,19 @@ function loadColdWorker(networkId) {
|
||||
messageListener = fn;
|
||||
},
|
||||
},
|
||||
onConnect: { addListener: () => {} },
|
||||
onConnect: {
|
||||
addListener: (fn) => {
|
||||
connectListener = fn;
|
||||
},
|
||||
},
|
||||
lastError: null,
|
||||
},
|
||||
windows: {
|
||||
getLastFocused: (cb) => cb(null),
|
||||
create: (options, cb) => cb({ id: 1 }),
|
||||
create: (options, cb) => {
|
||||
opened.push(options.url);
|
||||
cb({ id: opened.length });
|
||||
},
|
||||
remove: (id, cb) => {
|
||||
if (cb) cb();
|
||||
},
|
||||
@@ -124,6 +138,32 @@ function loadColdWorker(networkId) {
|
||||
|
||||
require("../src/background/index");
|
||||
|
||||
// The user approves the prompt the request opened, as the popup does: a
|
||||
// decision on the port named for the approval, from the extension's own
|
||||
// page.
|
||||
function approvePrompt() {
|
||||
const id = new URL(opened[opened.length - 1]).searchParams.get(
|
||||
"approval",
|
||||
);
|
||||
let onDecision = null;
|
||||
const port = {
|
||||
name: "approval:" + id,
|
||||
sender: { url: "chrome-extension://autistmask/src/popup/" },
|
||||
onMessage: {
|
||||
addListener: (fn) => {
|
||||
onDecision = fn;
|
||||
},
|
||||
},
|
||||
onDisconnect: { addListener: () => {} },
|
||||
};
|
||||
connectListener(port);
|
||||
onDecision(
|
||||
{ type: "AUTISTMASK_APPROVAL_DECISION", approved: true },
|
||||
port,
|
||||
);
|
||||
}
|
||||
|
||||
// A connected site asks for `chainId`, and the user approves it.
|
||||
async function switchChain(chainId) {
|
||||
let result = null;
|
||||
messageListener(
|
||||
@@ -138,6 +178,8 @@ function loadColdWorker(networkId) {
|
||||
},
|
||||
);
|
||||
await settle();
|
||||
approvePrompt();
|
||||
await settle();
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,259 @@
|
||||
// A transfer is sent only on the network its confirmation screen was drawn for
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/524).
|
||||
//
|
||||
// Settings is reachable from the confirmation screen, and Back from it only
|
||||
// unhides the screen, still labelled for the network it was drawn for. Sign &
|
||||
// Send used to take the network at the moment of the click, so 1 SepoliaETH
|
||||
// reviewed on Sepolia went out as 1 ETH on mainnet once mainnet was chosen in
|
||||
// Settings in between.
|
||||
//
|
||||
// Driven through the real confirmation screen, signer and chain switch, with
|
||||
// only the node and the DOM stubbed. The stub node is on the network its
|
||||
// provider was built for, so a broadcast records the network it went to.
|
||||
|
||||
"use strict";
|
||||
|
||||
// The signed transactions the stub node was handed, with its network's chain id.
|
||||
const mockNode = { broadcast: [] };
|
||||
|
||||
jest.mock("ethers", () => {
|
||||
const actual = jest.requireActual("ethers");
|
||||
class StubProvider {
|
||||
constructor(url, network) {
|
||||
this.network = network;
|
||||
}
|
||||
async getNetwork() {
|
||||
return this.network;
|
||||
}
|
||||
async getFeeData() {
|
||||
return {
|
||||
maxFeePerGas: 20000000000n,
|
||||
maxPriorityFeePerGas: 1000000000n,
|
||||
gasPrice: 10000000000n,
|
||||
};
|
||||
}
|
||||
async estimateGas() {
|
||||
return 21000n;
|
||||
}
|
||||
async getCode() {
|
||||
return "0x";
|
||||
}
|
||||
async getTransactionCount() {
|
||||
return 1;
|
||||
}
|
||||
async lookupAddress() {
|
||||
return null;
|
||||
}
|
||||
async broadcastTransaction(signed) {
|
||||
mockNode.broadcast.push({ chainId: this.network.chainId, signed });
|
||||
return { hash: "0x" + "ab".repeat(32) };
|
||||
}
|
||||
}
|
||||
return { ...actual, JsonRpcProvider: StubProvider };
|
||||
});
|
||||
|
||||
jest.mock("../src/shared/log", () => ({
|
||||
log: {
|
||||
debugf: () => {},
|
||||
infof: () => {},
|
||||
warnf: () => {},
|
||||
errorf: () => {},
|
||||
},
|
||||
debugFetch: jest.fn(async () => ({
|
||||
ok: true,
|
||||
status: 200,
|
||||
json: async () => ({ items: [] }),
|
||||
})),
|
||||
urlOrigin: () => "",
|
||||
setRuntimeDebug: () => {},
|
||||
isDebug: () => false,
|
||||
}));
|
||||
|
||||
// The wait screen polls for a receipt; these tests stop at the broadcast.
|
||||
jest.mock("../src/popup/views/txStatus", () => ({
|
||||
showWait: jest.fn(),
|
||||
showError: jest.fn(),
|
||||
}));
|
||||
|
||||
global.fetch = jest.fn(() => {
|
||||
throw new Error("tests must not perform network requests");
|
||||
});
|
||||
|
||||
const { makeStorageStub } = require("./support/storageStub");
|
||||
global.chrome = { storage: makeStorageStub(), runtime: { sendMessage() {} } };
|
||||
|
||||
// A stub DOM: every id resolves to a recording element.
|
||||
const elements = new Map();
|
||||
|
||||
function makeEl(id) {
|
||||
const handlers = new Map();
|
||||
return {
|
||||
id,
|
||||
textContent: "",
|
||||
innerHTML: "",
|
||||
value: "",
|
||||
disabled: false,
|
||||
style: {},
|
||||
dataset: {},
|
||||
classList: {
|
||||
add() {},
|
||||
remove() {},
|
||||
toggle() {},
|
||||
contains: () => false,
|
||||
},
|
||||
handlers,
|
||||
addEventListener(name, fn) {
|
||||
handlers.set(name, fn);
|
||||
},
|
||||
querySelectorAll: () => [],
|
||||
querySelector: () => null,
|
||||
remove() {},
|
||||
focus() {},
|
||||
};
|
||||
}
|
||||
|
||||
global.document = {
|
||||
getElementById(id) {
|
||||
if (!elements.has(id)) elements.set(id, makeEl(id));
|
||||
return elements.get(id);
|
||||
},
|
||||
createElement: (tag) => makeEl(tag),
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { BaseWallet, Transaction, Wallet } = require("ethers");
|
||||
const { encryptWithPassword } = require("../src/shared/vault");
|
||||
const { state, loadState } = require("../src/shared/state");
|
||||
const { onChainSwitch } = require("../src/shared/chainSwitch");
|
||||
const { NETWORKS } = require("../src/shared/networks");
|
||||
const txStatus = require("../src/popup/views/txStatus");
|
||||
const confirmTx = require("../src/popup/views/confirmTx");
|
||||
|
||||
const PRIVATE_KEY = "0x" + "11".repeat(32);
|
||||
const HOLDER = new Wallet(PRIVATE_KEY).address;
|
||||
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||
const PASSWORD = "correct horse battery staple";
|
||||
|
||||
function el(id) {
|
||||
return global.document.getElementById(id);
|
||||
}
|
||||
|
||||
let encryptedSecret;
|
||||
let signTransaction;
|
||||
|
||||
beforeAll(async () => {
|
||||
await loadState();
|
||||
encryptedSecret = await encryptWithPassword(PRIVATE_KEY, PASSWORD);
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
elements.clear();
|
||||
mockNode.broadcast = [];
|
||||
txStatus.showWait.mockClear();
|
||||
txStatus.showError.mockClear();
|
||||
signTransaction = jest.spyOn(BaseWallet.prototype, "signTransaction");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
signTransaction.mockRestore();
|
||||
});
|
||||
|
||||
// Show the confirmation screen for 1 of the native token on `networkId`, as
|
||||
// Review on the Send screen does, with its fee estimate settled.
|
||||
async function review(networkId) {
|
||||
await onChainSwitch(networkId);
|
||||
state.wallets = [
|
||||
{
|
||||
type: "key",
|
||||
name: "Wallet 1",
|
||||
encryptedSecret,
|
||||
addresses: [{ address: HOLDER, balance: "5.0" }],
|
||||
},
|
||||
];
|
||||
state.selectedWallet = 0;
|
||||
state.selectedAddress = 0;
|
||||
confirmTx.init({});
|
||||
confirmTx.show({
|
||||
from: HOLDER,
|
||||
to: RECIPIENT,
|
||||
ensName: null,
|
||||
amount: "1",
|
||||
token: "ETH",
|
||||
balance: "5.0",
|
||||
tokenSymbol: null,
|
||||
tokenBalance: null,
|
||||
tokenDecimals: null,
|
||||
max: false,
|
||||
});
|
||||
for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
|
||||
}
|
||||
|
||||
async function signAndSend() {
|
||||
el("confirm-tx-password").value = PASSWORD;
|
||||
await el("btn-confirm-send").handlers.get("click")();
|
||||
}
|
||||
|
||||
test("a transfer reviewed on Sepolia and sent goes out on Sepolia", async () => {
|
||||
await review("sepolia");
|
||||
expect(el("confirm-type").textContent).toBe("Native SepoliaETH transfer");
|
||||
expect(el("btn-confirm-send").disabled).toBe(false);
|
||||
await signAndSend();
|
||||
expect(mockNode.broadcast).toHaveLength(1);
|
||||
expect(mockNode.broadcast[0].chainId).toBe(11155111n);
|
||||
expect(Transaction.from(mockNode.broadcast[0].signed).chainId).toBe(
|
||||
11155111n,
|
||||
);
|
||||
expect(txStatus.showWait).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
describe.each([
|
||||
["sepolia", "mainnet", "SepoliaETH"],
|
||||
["mainnet", "sepolia", "ETH"],
|
||||
])(
|
||||
"a transfer reviewed on %s, with %s chosen in Settings before Sign & Send",
|
||||
(reviewedOn, switchedTo, symbol) => {
|
||||
test("is neither signed nor sent, and the screen says why", async () => {
|
||||
await review(reviewedOn);
|
||||
expect(el("confirm-type").textContent).toBe(
|
||||
"Native " + symbol + " transfer",
|
||||
);
|
||||
// Settings' network select, then Back, which only unhides the
|
||||
// screen as it was drawn.
|
||||
await onChainSwitch(switchedTo);
|
||||
await signAndSend();
|
||||
|
||||
expect(signTransaction).not.toHaveBeenCalled();
|
||||
expect(mockNode.broadcast).toEqual([]);
|
||||
expect(txStatus.showWait).not.toHaveBeenCalled();
|
||||
expect(txStatus.showError).not.toHaveBeenCalled();
|
||||
expect(el("confirm-errors").style.visibility).toBe("visible");
|
||||
expect(el("confirm-errors").innerHTML).toContain(
|
||||
"The active network changed after this transaction was" +
|
||||
" reviewed, so it was not sent. Please go back and review" +
|
||||
" it again.",
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
// The check in the click handler tells the user; the send itself carries the
|
||||
// chain id the screen was drawn for, so a signer on another network's node
|
||||
// cannot sign it even if the network changes after that check.
|
||||
test("the send is refused by a signer on another network's node", async () => {
|
||||
const { getProvider } = require("../src/shared/balances");
|
||||
const signer = new Wallet(PRIVATE_KEY).connect(
|
||||
getProvider("https://rpc.example.invalid", "mainnet"),
|
||||
);
|
||||
await expect(
|
||||
confirmTx.populateVerifyAndSend(signer, {
|
||||
token: "ETH",
|
||||
to: RECIPIENT,
|
||||
amount: "1",
|
||||
chainId: NETWORKS.sepolia.chainId,
|
||||
}),
|
||||
).rejects.toThrow("transaction chainId mismatch");
|
||||
expect(signTransaction).not.toHaveBeenCalled();
|
||||
expect(mockNode.broadcast).toEqual([]);
|
||||
});
|
||||
@@ -253,7 +253,7 @@ describe("reaching the screen", () => {
|
||||
const { decryptWithPassword } = require("../src/shared/vault");
|
||||
decryptWithPassword.mockRejectedValue(new Error("nope"));
|
||||
await click("btn-delete-wallet-confirm");
|
||||
expect(node("delete-wallet-flash").textContent).toBe(
|
||||
expect(node("delete-wallet-password-error").textContent).toBe(
|
||||
"That password is incorrect. Please try again.",
|
||||
);
|
||||
});
|
||||
@@ -615,3 +615,46 @@ describe("the password route's confirm button", () => {
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/480: leaving either delete
|
||||
// screen drops its wallet selection, so Back onto one showed a screen whose
|
||||
// button could only answer "No wallet selected for deletion." Taking the
|
||||
// screen off the stack leaves Settings under Settings, and Back must not land
|
||||
// there either (https://git.eeqj.de/sneak/AutistMask/issues/481).
|
||||
describe("Back from Settings after leaving by the settings gear", () => {
|
||||
test("goes past the delete screen to the screen under Settings", () => {
|
||||
const { helpers, deleteWallet, state } = load();
|
||||
deleteWallet.show(1);
|
||||
// The settings gear: push the current view, then show Settings.
|
||||
helpers.pushCurrentView();
|
||||
helpers.showView("settings");
|
||||
|
||||
expect(state.viewStack).toEqual(["main", "settings"]);
|
||||
helpers.goBack();
|
||||
expect(state.currentView).toBe("main");
|
||||
});
|
||||
|
||||
test("goes past the lost-password screen to the screen under Settings", async () => {
|
||||
const { helpers, deleteWallet, state } = load();
|
||||
await openLostPassword(deleteWallet, 1);
|
||||
// The settings gear: push the current view, then show Settings.
|
||||
helpers.pushCurrentView();
|
||||
helpers.showView("settings");
|
||||
|
||||
expect(state.viewStack).toEqual(["main", "settings"]);
|
||||
helpers.goBack();
|
||||
expect(state.currentView).toBe("main");
|
||||
});
|
||||
|
||||
// The lost-password screen's own Back is "Back returns to the delete
|
||||
// screen with its wallet still chosen", above.
|
||||
test("the delete screen's own Back leaves the rest of the stack alone", async () => {
|
||||
const { deleteWallet, state } = load();
|
||||
deleteWallet.show(1);
|
||||
|
||||
await click("btn-delete-wallet-back");
|
||||
|
||||
expect(state.currentView).toBe("settings");
|
||||
expect(state.viewStack).toEqual(["main"]);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -279,12 +279,18 @@ class Driver {
|
||||
|
||||
// Shown means shown: in the popup a view is switched by toggling a
|
||||
// "hidden" class, and an element that is present but collapsed is not
|
||||
// the thing a test means by visible.
|
||||
// the thing a test means by visible. Until the page's stylesheet has
|
||||
// applied that class hides nothing and every view lays out, so the page
|
||||
// must also have finished loading, which it does only after its
|
||||
// stylesheet, and neither the element nor anything enclosing it may
|
||||
// carry the class (https://git.eeqj.de/sneak/AutistMask/issues/502).
|
||||
async waitVisible(selector, timeout = DEFAULT_WAIT_MS) {
|
||||
return this.waitFor(
|
||||
"selector " + selector + " to be visible",
|
||||
`const el = document.querySelector(arguments[0]);
|
||||
if (!el) return false;
|
||||
if (document.readyState !== "complete" || !el) return false;
|
||||
if (el.closest(".hidden")) return false;
|
||||
if (getComputedStyle(el).visibility !== "visible") return false;
|
||||
const r = el.getBoundingClientRect();
|
||||
return r.width > 0 && r.height > 0;`,
|
||||
[selector],
|
||||
|
||||
+167
-52
@@ -63,6 +63,7 @@ const {
|
||||
const { ConsoleErrors, EXTENSION_ORIGIN, start, sleep } = require("./driver");
|
||||
const { startDappServer } = require("./dapp");
|
||||
const { STUB_COUNTERPARTY } = require("../network");
|
||||
const { NETWORKS } = require("../../../src/shared/networks");
|
||||
const {
|
||||
STATE_SCHEMA_VERSION,
|
||||
stateProblem,
|
||||
@@ -127,6 +128,18 @@ step("the popup is drawn in the monospace font it declares", async (env) => {
|
||||
);
|
||||
});
|
||||
|
||||
// The same check as the Chrome suite's (#456), so both browsers are held to
|
||||
// the same size.
|
||||
step("the popup's text is drawn at the 14px text-sm declares", async (env) => {
|
||||
const size = await env.driver.execute(
|
||||
"return getComputedStyle(document.body).fontSize;",
|
||||
);
|
||||
assert(
|
||||
size === "14px",
|
||||
"the popup's text is drawn at " + size + ", not at the 14px of text-sm",
|
||||
);
|
||||
});
|
||||
|
||||
// The recovery screen (#361): the Chrome suite's four cases, run before any
|
||||
// wallet exists for the same reason. With no wallet nothing saves on a timer,
|
||||
// so no save can write a good record over the unreadable one. The last of them
|
||||
@@ -684,6 +697,159 @@ step(
|
||||
},
|
||||
);
|
||||
|
||||
// The network fields of the stored record, read on the popup page, the one
|
||||
// moz-extension:// document the suite has open.
|
||||
async function storedNetwork(env) {
|
||||
const d = env.driver;
|
||||
await d.switchToWindow(env.popupWindow);
|
||||
const stored = await d.executeAsync(
|
||||
`const done = arguments[arguments.length - 1];
|
||||
const api = typeof browser !== "undefined" ? browser : chrome;
|
||||
Promise.resolve(api.storage.local.get("autistmask")).then(
|
||||
(r) => done({
|
||||
networkId: r.autistmask.networkId,
|
||||
rpcUrl: r.autistmask.rpcUrl,
|
||||
blockscoutUrl: r.autistmask.blockscoutUrl,
|
||||
}),
|
||||
(e) => done({ error: String((e && e.message) || e) }),
|
||||
);`,
|
||||
);
|
||||
assert(
|
||||
stored && !stored.error,
|
||||
"could not read the stored network: " + (stored && stored.error),
|
||||
);
|
||||
return stored;
|
||||
}
|
||||
|
||||
// Every chainChanged event the test page has been sent, waiting up to
|
||||
// `timeout` for there to be `count` of them: the background sends the event
|
||||
// alongside its answer to the request, so it can arrive just after it. Leaves
|
||||
// the driver on the page.
|
||||
async function chainChangedEvents(env, count = 0, timeout = 5000) {
|
||||
const d = env.driver;
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
const deadline = Date.now() + timeout;
|
||||
for (;;) {
|
||||
const events = (await dappMessages(d, "AUTISTMASK_EVENT")).filter(
|
||||
(m) => m.eventName === "chainChanged",
|
||||
);
|
||||
if (events.length >= count || Date.now() > deadline) return events;
|
||||
await sleep(100);
|
||||
}
|
||||
}
|
||||
|
||||
// Ask, from the page, to switch from network `from` to network `to`, and
|
||||
// return the prompt that opens, checked to name the site and both networks.
|
||||
// Leaves the driver on the prompt.
|
||||
async function openNetworkPrompt(env, key, from, to) {
|
||||
const d = env.driver;
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
await startRequest(d, key, "wallet_switchEthereumChain", [
|
||||
{ chainId: to.chainId },
|
||||
]);
|
||||
const popup = await waitForApprovalWindow(d);
|
||||
await d.switchToWindow(popup);
|
||||
await d.waitVisible("#view-approve-network");
|
||||
const screen = {
|
||||
origin: await d.text("#approve-network-origin"),
|
||||
current: await d.text("#approve-network-current"),
|
||||
requested: await d.text("#approve-network-requested"),
|
||||
};
|
||||
assert(
|
||||
isDeepStrictEqual(screen, {
|
||||
origin: env.server.origin,
|
||||
current: from.name,
|
||||
requested: to.name,
|
||||
}),
|
||||
"the network switch prompt shows " + JSON.stringify(screen),
|
||||
);
|
||||
return popup;
|
||||
}
|
||||
|
||||
// Only the user switches the network. A connected site's request opens a
|
||||
// prompt, and until the user approves it the stored network does not move and
|
||||
// no page is told it did (https://git.eeqj.de/sneak/AutistMask/issues/408).
|
||||
// The wallet goes back to mainnet the same way at the end, for the transaction
|
||||
// step after this one.
|
||||
step(
|
||||
"a site's network switch changes nothing until the user approves it",
|
||||
async (env) => {
|
||||
const d = env.driver;
|
||||
const { mainnet, sepolia } = NETWORKS;
|
||||
const before = await storedNetwork(env);
|
||||
assert(
|
||||
before.networkId === "mainnet",
|
||||
"this step starts on mainnet, not on " + before.networkId,
|
||||
);
|
||||
const eventsBefore = (await chainChangedEvents(env)).length;
|
||||
|
||||
const rejected = await openNetworkPrompt(
|
||||
env,
|
||||
"switch-reject",
|
||||
mainnet,
|
||||
sepolia,
|
||||
);
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env), before),
|
||||
"the network moved while its prompt was still open",
|
||||
);
|
||||
// Nothing else closes this window, so a click that did not land
|
||||
// leaves the request unanswered and the assertion below fails.
|
||||
await d.switchToWindow(rejected);
|
||||
await d.click("#btn-reject-network");
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
await assertUserRejection(
|
||||
d,
|
||||
"switch-reject",
|
||||
"the network switch rejection",
|
||||
);
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env), before),
|
||||
"a rejected network switch moved the network",
|
||||
);
|
||||
assert(
|
||||
(await chainChangedEvents(env)).length === eventsBefore,
|
||||
"a rejected network switch told the page the chain changed",
|
||||
);
|
||||
|
||||
await openNetworkPrompt(env, "switch-approve", mainnet, sepolia);
|
||||
await d.click("#btn-approve-network");
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
let outcome = await settleRequest(d, "switch-approve");
|
||||
assert(
|
||||
outcome.settled === "resolved" && outcome.result === null,
|
||||
"the approved network switch did not resolve: " +
|
||||
JSON.stringify(outcome),
|
||||
);
|
||||
assert(
|
||||
(await storedNetwork(env)).networkId === "sepolia",
|
||||
"the approved network switch did not move the network",
|
||||
);
|
||||
const events = await chainChangedEvents(env, eventsBefore + 1);
|
||||
assert(
|
||||
events.length === eventsBefore + 1 &&
|
||||
events[events.length - 1].data === sepolia.chainId,
|
||||
"the page was not told of the approved switch: " +
|
||||
JSON.stringify(events),
|
||||
);
|
||||
|
||||
await openNetworkPrompt(env, "switch-restore", sepolia, mainnet);
|
||||
await d.click("#btn-approve-network");
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
outcome = await settleRequest(d, "switch-restore");
|
||||
assert(
|
||||
outcome.settled === "resolved",
|
||||
"switching back to mainnet did not resolve: " +
|
||||
JSON.stringify(outcome),
|
||||
);
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env), before),
|
||||
"switching back did not restore the mainnet network and endpoints",
|
||||
);
|
||||
await d.switchToWindow(env.dappWindow);
|
||||
},
|
||||
);
|
||||
|
||||
step(
|
||||
"eth_sendTransaction shows the transaction and returns its hash",
|
||||
async (env) => {
|
||||
@@ -854,37 +1020,6 @@ step(
|
||||
|
||||
// ------------------------------------------------------------- runner
|
||||
|
||||
// Uncaught extension errors that are known, tracked and deliberately
|
||||
// tolerated, in the same spirit as ALLOWED_ERRORS in tests/e2e/harness.js:
|
||||
// every entry names the issue that will delete it, and every occurrence is
|
||||
// still printed, so tolerating one is visible in the log rather than silent.
|
||||
// This is the only concession in an otherwise zero-tolerance policy.
|
||||
const ALLOWED_ERRORS = [
|
||||
{
|
||||
// The site-connection buttons in src/popup/views/approval.js send
|
||||
// their decision and call window.close() on the next line. Firefox's
|
||||
// BaseContext.wrapPromise reports, through Cu.reportError, any
|
||||
// extension-API promise that settles after its context unloaded —
|
||||
// whether or not the caller attached a handler, so notify()'s catch
|
||||
// cannot suppress it.
|
||||
//
|
||||
// Pre-existing, and not introduced by the promise shim: the send was
|
||||
// already unawaited, and this suite is merely the first thing to
|
||||
// drive that window on Firefox. It is the same teardown ordering as
|
||||
// the issue below, whose fix — making the outcome independent of when
|
||||
// the popup closes — removes this entry with it.
|
||||
pattern: /Promise (?:resolved|rejected) after context unloaded/,
|
||||
source: /\/src\/popup\/index\.js$/,
|
||||
issue: "https://git.eeqj.de/sneak/AutistMask/issues/275",
|
||||
},
|
||||
];
|
||||
|
||||
function allowedFor(e) {
|
||||
return ALLOWED_ERRORS.find(
|
||||
(a) => a.pattern.test(e.msg) && a.source.test(e.src),
|
||||
);
|
||||
}
|
||||
|
||||
function formatError(e) {
|
||||
return (
|
||||
e.msg + " (" + e.src + ":" + e.line + (e.cat ? ", " + e.cat : "") + ")"
|
||||
@@ -1001,20 +1136,6 @@ async function main() {
|
||||
installFailure = null;
|
||||
}
|
||||
|
||||
// Tolerated errors are set aside, never dropped: each one is
|
||||
// printed with the issue that keeps it on the list, so the
|
||||
// concession stays in the run output.
|
||||
const tolerated = found.filter((e) => allowedFor(e));
|
||||
found = found.filter((e) => !allowedFor(e));
|
||||
for (const e of tolerated) {
|
||||
console.log(
|
||||
"# tolerated (" +
|
||||
allowedFor(e).issue +
|
||||
"): " +
|
||||
formatError(e),
|
||||
);
|
||||
}
|
||||
|
||||
// Any uncaught error from an extension source fails the step
|
||||
// that provoked it, whether or not its assertions passed.
|
||||
if (!failure && found.length > 0) {
|
||||
@@ -1039,13 +1160,7 @@ async function main() {
|
||||
// blamed on any one step, but they are still reported and they
|
||||
// still fail the run.
|
||||
await sleep(1000);
|
||||
const trailingAll = await errors.take();
|
||||
for (const e of trailingAll.filter((x) => allowedFor(x))) {
|
||||
console.log(
|
||||
"# tolerated (" + allowedFor(e).issue + "): " + formatError(e),
|
||||
);
|
||||
}
|
||||
const trailing = trailingAll.filter((e) => !allowedFor(e));
|
||||
const trailing = await errors.take();
|
||||
console.log(
|
||||
"# " +
|
||||
(steps.length - failed) +
|
||||
|
||||
+26
-1
@@ -333,8 +333,33 @@ async function launch(routeOpts) {
|
||||
|
||||
const PASSWORD = "e2e-harness-password";
|
||||
|
||||
// Waits until the page shows `selector`, not only until it lays out. Until the
|
||||
// page's stylesheet has applied, the `hidden` class that showView() keeps on
|
||||
// every view but the current one hides nothing and every view lays out, so a
|
||||
// test could read a screen before the page's script had filled it
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/502). So the page must also
|
||||
// have finished loading, which it does only after its stylesheet, and neither
|
||||
// the element nor anything enclosing it may carry `hidden`. Polled on a timer:
|
||||
// animation frames are not guaranteed to a window that is not in front.
|
||||
async function visible(page, selector, timeout = 15000) {
|
||||
await page.waitForSelector(selector, { state: "visible", timeout });
|
||||
await page
|
||||
.waitForFunction(
|
||||
(sel) => {
|
||||
const el = document.querySelector(sel);
|
||||
if (document.readyState !== "complete" || !el) return false;
|
||||
if (el.closest(".hidden")) return false;
|
||||
if (getComputedStyle(el).visibility !== "visible") return false;
|
||||
const r = el.getBoundingClientRect();
|
||||
return r.width > 0 && r.height > 0;
|
||||
},
|
||||
selector,
|
||||
{ polling: 50, timeout },
|
||||
)
|
||||
.catch((e) => {
|
||||
throw new Error(
|
||||
"the page did not show " + selector + ": " + e.message,
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
// An empty WebAssembly module: magic number and version header, no
|
||||
|
||||
+319
-16
@@ -113,6 +113,18 @@ test("the popup is drawn in the monospace font it declares (#418)", async (env)
|
||||
);
|
||||
});
|
||||
|
||||
// The same stylesheet sets the size on body to 75%, which would draw the
|
||||
// popup at 12px.
|
||||
test("the popup's text is drawn at the 14px text-sm declares (#456)", async (env) => {
|
||||
const size = await env.page.evaluate(
|
||||
() => getComputedStyle(document.body).fontSize,
|
||||
);
|
||||
assert(
|
||||
size === "14px",
|
||||
"the popup's text is drawn at " + size + ", not at the 14px of text-sm",
|
||||
);
|
||||
});
|
||||
|
||||
// The empirical half of #182. The manifest change is only a claim about
|
||||
// what the CSP permits; this is the observation. Two things have to hold
|
||||
// together, and the run covers both: the popup realm compiles WASM (here),
|
||||
@@ -809,7 +821,7 @@ async function secretScreenState(page, view) {
|
||||
return page.evaluate(
|
||||
(v) => ({
|
||||
value: document.getElementById(v + "-value").textContent,
|
||||
error: document.getElementById(v + "-flash").textContent,
|
||||
error: document.getElementById(v + "-password-error").textContent,
|
||||
html: document.getElementById("view-" + v).innerHTML,
|
||||
resultHidden: document
|
||||
.getElementById(v + "-result")
|
||||
@@ -906,7 +918,8 @@ test("a wrong password reveals nothing (#161)", async (env) => {
|
||||
await env.page.click("#btn-show-phrase-reveal");
|
||||
await env.page.waitForFunction(
|
||||
() =>
|
||||
document.getElementById("show-phrase-flash").textContent.length > 0,
|
||||
document.getElementById("show-phrase-password-error").textContent
|
||||
.length > 0,
|
||||
null,
|
||||
{ timeout: 60000 },
|
||||
);
|
||||
@@ -1075,13 +1088,13 @@ async function revealPrivkey(page) {
|
||||
}
|
||||
|
||||
// Leave the export screen, or the Settings screen the gear left it for, for
|
||||
// Home. The gear put the export screen on the Back stack, so from Settings the
|
||||
// way home passes through it, already emptied
|
||||
// Home. Leaving takes the export screen off the Back stack, so from Settings
|
||||
// Back goes to the address screen it was opened from
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/461).
|
||||
async function leavePrivkeyScreen(page) {
|
||||
if (await page.isVisible("#view-settings")) {
|
||||
await page.click("#btn-settings-back");
|
||||
await visible(page, "#view-export-privkey");
|
||||
await visible(page, "#view-address");
|
||||
}
|
||||
if (await page.isVisible("#view-export-privkey")) {
|
||||
await page.click("#btn-export-privkey-back");
|
||||
@@ -1993,13 +2006,14 @@ test("an over-long flash message keeps to one line (#252)", async (env) => {
|
||||
|
||||
// Every screen that asks for a password reserves room for one line of error.
|
||||
// The two on the dApp approval screens also have a border and padding, which
|
||||
// that reserved height has to cover too.
|
||||
// that reserved height has to cover too. The add wallet screen's line sits
|
||||
// beside its button rather than above it, and has its own test below.
|
||||
const PASSWORD_ERROR_CONTAINERS = [
|
||||
"approve-tx-error",
|
||||
"approve-sign-error",
|
||||
"export-privkey-flash",
|
||||
"show-phrase-flash",
|
||||
"delete-wallet-flash",
|
||||
"export-privkey-password-error",
|
||||
"show-phrase-password-error",
|
||||
"delete-wallet-password-error",
|
||||
"confirm-tx-password-error",
|
||||
];
|
||||
|
||||
@@ -2064,6 +2078,107 @@ test("a password error moves nothing on any screen (#297)", async (env) => {
|
||||
}
|
||||
});
|
||||
|
||||
// ------------------------------------------ add wallet Import button (#493)
|
||||
|
||||
// At 360x600 the add wallet screen's Import button already starts near the
|
||||
// bottom of the popup, so its password error line sits beside the button
|
||||
// rather than above it. Measures the button and the line empty and again
|
||||
// filled with the longest error addWallet.js puts there. Runs in the page.
|
||||
function measureImportButton() {
|
||||
const button = document.getElementById("btn-add-wallet-confirm");
|
||||
const line = document.getElementById("add-wallet-password-error");
|
||||
const measure = () => {
|
||||
const b = button.getBoundingClientRect();
|
||||
const l = line.getBoundingClientRect();
|
||||
return {
|
||||
buttonTop: b.top + window.scrollY,
|
||||
buttonBottom: b.bottom + window.scrollY,
|
||||
lineTop: l.top + window.scrollY,
|
||||
lineBottom: l.bottom + window.scrollY,
|
||||
};
|
||||
};
|
||||
const empty = measure();
|
||||
line.textContent = "Password must be at least 12 characters.";
|
||||
line.style.visibility = "visible";
|
||||
const filled = measure();
|
||||
line.textContent = "";
|
||||
line.style.visibility = "hidden";
|
||||
return { empty, filled };
|
||||
}
|
||||
|
||||
test("the add wallet password error leaves Import where it was (#493)", async (env) => {
|
||||
const page = await openPopup(env.ctx, env.popupUrl);
|
||||
try {
|
||||
await page.setViewportSize(POPUP_VIEWPORT);
|
||||
// Brought up by toggling classes, as in the test above. The note
|
||||
// addWallet.js shows once a wallet exists is the only part of the
|
||||
// screen that differs between the first wallet and a later one.
|
||||
await page.evaluate(() => {
|
||||
const screen = document.getElementById("view-add-wallet");
|
||||
for (const view of document.querySelectorAll(".view")) {
|
||||
view.classList.toggle("hidden", view !== screen);
|
||||
}
|
||||
});
|
||||
for (const walletExists of [false, true]) {
|
||||
await page.evaluate(
|
||||
(shown) =>
|
||||
document
|
||||
.getElementById("add-wallet-separate-password-note")
|
||||
.classList.toggle("hidden", !shown),
|
||||
walletExists,
|
||||
);
|
||||
for (const tab of ["tab-mnemonic", "tab-privkey", "tab-xprv"]) {
|
||||
await page.click("#" + tab);
|
||||
const { empty, filled } =
|
||||
await page.evaluate(measureImportButton);
|
||||
const where =
|
||||
"#" +
|
||||
tab +
|
||||
(walletExists
|
||||
? " with a wallet already added"
|
||||
: " for the first wallet");
|
||||
// Printed pass or fail, as the dust threshold test does.
|
||||
console.log(
|
||||
"# add wallet Import top, " +
|
||||
where +
|
||||
": " +
|
||||
empty.buttonTop +
|
||||
"px",
|
||||
);
|
||||
for (const m of [empty, filled]) {
|
||||
assert(
|
||||
m.lineTop >= m.buttonTop &&
|
||||
m.lineBottom <= m.buttonBottom,
|
||||
"the error line on " +
|
||||
where +
|
||||
" does not fit beside Import, so it adds height: " +
|
||||
JSON.stringify(m),
|
||||
);
|
||||
}
|
||||
assert(
|
||||
filled.buttonTop === empty.buttonTop,
|
||||
"Import moved " +
|
||||
(filled.buttonTop - empty.buttonTop) +
|
||||
"px when the error appeared on " +
|
||||
where,
|
||||
);
|
||||
if (!walletExists) {
|
||||
assert(
|
||||
empty.buttonTop < POPUP_VIEWPORT.height,
|
||||
"Import starts at " +
|
||||
empty.buttonTop +
|
||||
"px on " +
|
||||
where +
|
||||
", below the fold",
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
await page.close();
|
||||
}
|
||||
});
|
||||
|
||||
// --------------------------------------------- confirmation screen (#238)
|
||||
//
|
||||
// The screen that decides what gets signed. The arithmetic underneath it
|
||||
@@ -3396,7 +3511,7 @@ async function closeApprovalPages(ctx) {
|
||||
}
|
||||
|
||||
// Click a button whose own handler closes the window it lives in — every
|
||||
// Reject, and Allow on the site prompt.
|
||||
// Reject, Allow on the site prompt, and Switch on the network switch prompt.
|
||||
//
|
||||
// page.click() dispatches the click and then waits for the renderer to
|
||||
// acknowledge it, and a page torn down by the handler never gets to. The
|
||||
@@ -3411,12 +3526,13 @@ async function closeApprovalPages(ctx) {
|
||||
// #btn-reject-sign, #btn-reject-tx — their disconnect leaves the approval
|
||||
// pending, so a click that never landed leaves the dApp promise unsettled
|
||||
// and the assertion after the call fails on its own.
|
||||
// #btn-approve — only a decision resolves the promise, and a swallowed click
|
||||
// cannot produce settled === "resolved".
|
||||
// #btn-reject on the site prompt — NOT self-proving. A page that went away
|
||||
// without the click landing disconnects the approval port, the background
|
||||
// settles that as 4001, and 4001 is exactly what assertUserRejection
|
||||
// accepts. Both call sites arm the click trace below and assert it.
|
||||
// #btn-approve, #btn-approve-network — only a decision resolves the promise,
|
||||
// and a swallowed click cannot produce settled === "resolved".
|
||||
// #btn-reject on the site prompt, #btn-reject-network — NOT self-proving. A
|
||||
// page that went away without the click landing disconnects the approval
|
||||
// port, the background settles that as 4001, and 4001 is exactly what
|
||||
// assertUserRejection accepts. Every call site arms the click trace below
|
||||
// and asserts it.
|
||||
//
|
||||
// A button that is missing or unclickable raises a different error, which is
|
||||
// rethrown.
|
||||
@@ -3741,6 +3857,9 @@ test("eth_requestAccounts approved returns the selected address (#183)", async (
|
||||
shown.toLowerCase().includes(env.expectedAddress.toLowerCase()),
|
||||
"the site prompt shows the wrong address: " + JSON.stringify(shown),
|
||||
);
|
||||
// The text above is there even when the row is too narrow to show it
|
||||
// all; this measures that the whole address is visible (#517).
|
||||
await assertAddressesFit(popup, "the connection prompt");
|
||||
|
||||
// Remembered, so the connection survives a background worker that MV3
|
||||
// terminates after 30 seconds idle. The in-memory connectedSites map
|
||||
@@ -4286,6 +4405,190 @@ test("a prompt raised while another approval window has focus opens its own (#29
|
||||
await assertUserRejection(env.dapp, "focus-sign", "the sign prompt");
|
||||
});
|
||||
|
||||
// The network fields of the stored record.
|
||||
async function storedNetwork(page) {
|
||||
const s = await storedRecord(page);
|
||||
return {
|
||||
networkId: s.networkId,
|
||||
rpcUrl: s.rpcUrl,
|
||||
blockscoutUrl: s.blockscoutUrl,
|
||||
};
|
||||
}
|
||||
|
||||
// Every chainChanged event the test page has been sent, waiting up to
|
||||
// `timeout` for there to be `count` of them: the background sends the event
|
||||
// alongside its answer to the request, so it can arrive just after it.
|
||||
async function chainChangedEvents(page, count = 0, timeout = 5000) {
|
||||
const deadline = Date.now() + timeout;
|
||||
for (;;) {
|
||||
const events = (await dappMessages(page, "AUTISTMASK_EVENT")).filter(
|
||||
(m) => m.eventName === "chainChanged",
|
||||
);
|
||||
if (events.length >= count || Date.now() > deadline) return events;
|
||||
await sleep(50);
|
||||
}
|
||||
}
|
||||
|
||||
// Ask, from the test page, to switch from network `from` to network `to`, and
|
||||
// return the prompt that opens, checked to name the site and both networks.
|
||||
async function openNetworkPrompt(env, key, from, to) {
|
||||
await startRequest(env.dapp, key, "wallet_switchEthereumChain", [
|
||||
{ chainId: to.chainId },
|
||||
]);
|
||||
const popup = await waitForApprovalWindow(env.ctx);
|
||||
await visible(popup, "#view-approve-network");
|
||||
const screen = await popup.evaluate(() => ({
|
||||
origin: document.getElementById("approve-network-origin").textContent,
|
||||
current: document.getElementById("approve-network-current").textContent,
|
||||
requested: document.getElementById("approve-network-requested")
|
||||
.textContent,
|
||||
}));
|
||||
assert(
|
||||
isDeepStrictEqual(screen, {
|
||||
origin: DAPP_ORIGIN,
|
||||
current: from.name,
|
||||
requested: to.name,
|
||||
}),
|
||||
"the network switch prompt shows " + JSON.stringify(screen),
|
||||
);
|
||||
return popup;
|
||||
}
|
||||
|
||||
// Only the user switches the network. A connected site's request opens a
|
||||
// prompt, and until the user approves it the stored network does not move and
|
||||
// no page is told it did (https://git.eeqj.de/sneak/AutistMask/issues/408).
|
||||
// The wallet goes back to mainnet the same way at the end, for the tests after
|
||||
// this one.
|
||||
test("a site's network switch changes nothing until the user approves it (#408)", async (env) => {
|
||||
const { mainnet, sepolia } = NETWORKS;
|
||||
const before = await storedNetwork(env.page);
|
||||
assert(
|
||||
before.networkId === "mainnet",
|
||||
"this test starts on mainnet, not on " + before.networkId,
|
||||
);
|
||||
const eventsBefore = (await chainChangedEvents(env.dapp)).length;
|
||||
|
||||
const rejected = await openNetworkPrompt(
|
||||
env,
|
||||
"switch-reject",
|
||||
mainnet,
|
||||
sepolia,
|
||||
);
|
||||
try {
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env.page), before),
|
||||
"the network moved while its prompt was still open",
|
||||
);
|
||||
// Closing the prompt unanswered is also a rejection, so the click
|
||||
// itself is witnessed.
|
||||
await armClickTrace(env, rejected, "#btn-reject-network");
|
||||
await clickAndClose(rejected, "#btn-reject-network");
|
||||
await assertClickLanded(env, "#btn-reject-network");
|
||||
await assertUserRejection(
|
||||
env.dapp,
|
||||
"switch-reject",
|
||||
"the network switch rejection",
|
||||
);
|
||||
} finally {
|
||||
await closeApprovalPages(env.ctx);
|
||||
}
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env.page), before),
|
||||
"a rejected network switch moved the network",
|
||||
);
|
||||
assert(
|
||||
(await chainChangedEvents(env.dapp)).length === eventsBefore,
|
||||
"a rejected network switch told the page the chain changed",
|
||||
);
|
||||
|
||||
const approved = await openNetworkPrompt(
|
||||
env,
|
||||
"switch-approve",
|
||||
mainnet,
|
||||
sepolia,
|
||||
);
|
||||
let outcome;
|
||||
try {
|
||||
await clickAndClose(approved, "#btn-approve-network");
|
||||
outcome = await settleRequest(env.dapp, "switch-approve");
|
||||
} finally {
|
||||
await closeApprovalPages(env.ctx);
|
||||
}
|
||||
assert(
|
||||
outcome.settled === "resolved" && outcome.result === null,
|
||||
"the approved network switch did not resolve: " +
|
||||
JSON.stringify(outcome),
|
||||
);
|
||||
assert(
|
||||
(await storedNetwork(env.page)).networkId === "sepolia",
|
||||
"the approved network switch did not move the network",
|
||||
);
|
||||
const events = await chainChangedEvents(env.dapp, eventsBefore + 1);
|
||||
assert(
|
||||
events.length === eventsBefore + 1 &&
|
||||
events[events.length - 1].data === sepolia.chainId,
|
||||
"the page was not told of the approved switch: " +
|
||||
JSON.stringify(events),
|
||||
);
|
||||
|
||||
const restored = await openNetworkPrompt(
|
||||
env,
|
||||
"switch-restore",
|
||||
sepolia,
|
||||
mainnet,
|
||||
);
|
||||
try {
|
||||
await clickAndClose(restored, "#btn-approve-network");
|
||||
outcome = await settleRequest(env.dapp, "switch-restore");
|
||||
} finally {
|
||||
await closeApprovalPages(env.ctx);
|
||||
}
|
||||
assert(
|
||||
outcome.settled === "resolved",
|
||||
"switching back to mainnet did not resolve: " + JSON.stringify(outcome),
|
||||
);
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env.page), before),
|
||||
"switching back did not restore the mainnet network and endpoints",
|
||||
);
|
||||
});
|
||||
|
||||
// Switching the network in Settings tells the page too, as an approved site
|
||||
// request does (https://git.eeqj.de/sneak/AutistMask/issues/500). The wallet
|
||||
// goes back to mainnet the same way at the end.
|
||||
test("a network switch in Settings tells the page (#500)", async (env) => {
|
||||
const { mainnet, sepolia } = NETWORKS;
|
||||
const before = await storedNetwork(env.page);
|
||||
assert(
|
||||
before.networkId === "mainnet",
|
||||
"this test starts on mainnet, not on " + before.networkId,
|
||||
);
|
||||
const eventsBefore = (await chainChangedEvents(env.dapp)).length;
|
||||
await openSettings(env.page);
|
||||
|
||||
await env.page.selectOption("#settings-network", "sepolia");
|
||||
let events = await chainChangedEvents(env.dapp, eventsBefore + 1);
|
||||
assert(
|
||||
events.length === eventsBefore + 1 &&
|
||||
events[events.length - 1].data === sepolia.chainId,
|
||||
"the page was not told of the switch to Sepolia: " +
|
||||
JSON.stringify(events),
|
||||
);
|
||||
|
||||
await env.page.selectOption("#settings-network", "mainnet");
|
||||
events = await chainChangedEvents(env.dapp, eventsBefore + 2);
|
||||
assert(
|
||||
events.length === eventsBefore + 2 &&
|
||||
events[events.length - 1].data === mainnet.chainId,
|
||||
"the page was not told of the switch back to mainnet: " +
|
||||
JSON.stringify(events),
|
||||
);
|
||||
assert(
|
||||
isDeepStrictEqual(await storedNetwork(env.page), before),
|
||||
"switching back did not restore the mainnet network and endpoints",
|
||||
);
|
||||
});
|
||||
|
||||
// The closing pass over both boundaries at once. Every message the section
|
||||
// put on either channel is re-read here and required to be free of the
|
||||
// password — and required to be there at all, method by method, so the
|
||||
|
||||
@@ -0,0 +1,530 @@
|
||||
// A transaction approval and a signature approval the user leaves open for
|
||||
// seven minutes, their windows minimized, are still answered, and the site
|
||||
// receives both results (https://git.eeqj.de/sneak/AutistMask/issues/540).
|
||||
//
|
||||
// Both approvals, and the site's requests waiting on them, live only in the
|
||||
// background worker's memory. With nothing else going on, Chrome stopped that
|
||||
// worker about six minutes after the site's request, while the window was
|
||||
// still open, and the user's answer then reached nobody. While an approval is
|
||||
// pending, the worker now makes an extension call every 20 seconds, which
|
||||
// keeps it running (keepRunningWhileApprovalsPending() in
|
||||
// src/background/index.js). The windows are minimized for the wait because
|
||||
// Chrome slows a hidden page's timers to once a minute after a few minutes,
|
||||
// so anything the window itself did to keep the worker running would fail
|
||||
// here.
|
||||
//
|
||||
// A separate program from run.js, and not driven by Playwright: Playwright
|
||||
// keeps DevTools attached to the background worker, and Chrome never stops a
|
||||
// worker DevTools is attached to, so in run.js the worker outlives any wait
|
||||
// and a wait there proves nothing. This program starts Chromium itself and
|
||||
// speaks the DevTools protocol over the pipe Chromium opens for it
|
||||
// (--remote-debugging-pipe), attaching to pages only, never to the worker.
|
||||
// Before the approvals are raised it watches the worker stop on its own, so a
|
||||
// run in which something else keeps the worker running cannot pass.
|
||||
//
|
||||
// The dApp page and the stub node are the Firefox suite's loopback ones
|
||||
// (tests/e2e/firefox/dapp.js). The site is connected and the node chosen
|
||||
// through the extension's own screens, so nothing is written to its storage
|
||||
// from outside.
|
||||
//
|
||||
// Run through script/test-e2e, which builds the extension and the pinned
|
||||
// container.
|
||||
//
|
||||
// node tests/e2e/slowApproval.js
|
||||
|
||||
"use strict";
|
||||
|
||||
const fs = require("fs");
|
||||
const os = require("os");
|
||||
const path = require("path");
|
||||
const { spawn } = require("child_process");
|
||||
|
||||
const { chromium } = require("playwright-core");
|
||||
const {
|
||||
Transaction,
|
||||
getAddress,
|
||||
getBytes,
|
||||
hexlify,
|
||||
parseEther,
|
||||
toQuantity,
|
||||
toUtf8Bytes,
|
||||
verifyMessage,
|
||||
} = require("ethers");
|
||||
|
||||
const { PASSWORD } = require("./harness");
|
||||
const { STUB_COUNTERPARTY } = require("./network");
|
||||
const { startDappServer } = require("./firefox/dapp");
|
||||
|
||||
const DIST_CHROME = path.resolve(__dirname, "..", "..", "dist", "chrome");
|
||||
|
||||
// Chrome stopped the worker six minutes after the site's request when nothing
|
||||
// kept it running, so the approvals are left open for longer than that.
|
||||
const APPROVAL_WAIT_MS = 7 * 60 * 1000;
|
||||
|
||||
// With nothing pending, Chrome stops the worker 30 seconds after its last
|
||||
// event; this is how long the program waits to see that.
|
||||
const IDLE_STOP_TIMEOUT_MS = 90000;
|
||||
|
||||
const SIGN_HEX = hexlify(toUtf8Bytes("AutistMask e2e: a slow signature"));
|
||||
|
||||
const checks = [];
|
||||
let failed = 0;
|
||||
|
||||
function check(name, cond, detail) {
|
||||
checks.push(name);
|
||||
if (cond) {
|
||||
console.log("ok " + checks.length + " - " + name);
|
||||
} else {
|
||||
failed += 1;
|
||||
console.log("not ok " + checks.length + " - " + name);
|
||||
if (detail) console.log(" " + detail);
|
||||
}
|
||||
}
|
||||
|
||||
function sleep(ms) {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
}
|
||||
|
||||
// Poll `probe` until it returns something truthy, and return that.
|
||||
async function until(what, probe, timeout = 30000) {
|
||||
const deadline = Date.now() + timeout;
|
||||
for (;;) {
|
||||
const value = await probe().catch(() => null);
|
||||
if (value) return value;
|
||||
if (Date.now() > deadline) {
|
||||
throw new Error(
|
||||
"gave up after " + timeout + "ms waiting for " + what,
|
||||
);
|
||||
}
|
||||
await sleep(250);
|
||||
}
|
||||
}
|
||||
|
||||
// The DevTools protocol over Chromium's pipe: commands go to its fd 3, and
|
||||
// replies and events come back on its fd 4, each one JSON message ended by a
|
||||
// NUL byte. Events are not used and are dropped. Returns send(method, params,
|
||||
// sessionId), which resolves with the command's result.
|
||||
function devtools(browser) {
|
||||
const waiting = new Map();
|
||||
let nextId = 1;
|
||||
let pending = "";
|
||||
const replies = browser.stdio[4];
|
||||
replies.setEncoding("utf8");
|
||||
replies.on("data", (chunk) => {
|
||||
pending += chunk;
|
||||
let end;
|
||||
while ((end = pending.indexOf("\0")) !== -1) {
|
||||
const message = JSON.parse(pending.slice(0, end));
|
||||
pending = pending.slice(end + 1);
|
||||
const caller = waiting.get(message.id);
|
||||
if (!caller) continue;
|
||||
waiting.delete(message.id);
|
||||
if (message.error) {
|
||||
caller.reject(
|
||||
new Error(caller.method + ": " + message.error.message),
|
||||
);
|
||||
} else {
|
||||
caller.resolve(message.result);
|
||||
}
|
||||
}
|
||||
});
|
||||
replies.on("close", () => {
|
||||
for (const caller of waiting.values()) {
|
||||
caller.reject(new Error("the browser exited"));
|
||||
}
|
||||
waiting.clear();
|
||||
});
|
||||
return (method, params = {}, sessionId) =>
|
||||
new Promise((resolve, reject) => {
|
||||
const id = nextId++;
|
||||
waiting.set(id, { method, resolve, reject });
|
||||
browser.stdio[3].write(
|
||||
JSON.stringify({ id, method, params, sessionId }) + "\0",
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
// Attach to a page and return a function that evaluates an expression in it,
|
||||
// awaiting a promise it returns, and resolves with the value.
|
||||
async function attach(send, targetId) {
|
||||
const { sessionId } = await send("Target.attachToTarget", {
|
||||
targetId,
|
||||
flatten: true,
|
||||
});
|
||||
return async (expression) => {
|
||||
const r = await send(
|
||||
"Runtime.evaluate",
|
||||
{ expression, awaitPromise: true, returnByValue: true },
|
||||
sessionId,
|
||||
);
|
||||
if (r.exceptionDetails) {
|
||||
throw new Error(
|
||||
"evaluating " +
|
||||
expression.slice(0, 80) +
|
||||
" threw: " +
|
||||
JSON.stringify(r.exceptionDetails.exception || {}),
|
||||
);
|
||||
}
|
||||
return r.result.value;
|
||||
};
|
||||
}
|
||||
|
||||
// Whether the page has loaded and shows the element with this id: the
|
||||
// `hidden` class showView() keeps on every other view is on neither it nor
|
||||
// anything around it.
|
||||
function shows(id) {
|
||||
return (
|
||||
"document.readyState === 'complete' &&" +
|
||||
" !!document.getElementById(" +
|
||||
JSON.stringify(id) +
|
||||
") && !document.getElementById(" +
|
||||
JSON.stringify(id) +
|
||||
").closest('.hidden')"
|
||||
);
|
||||
}
|
||||
|
||||
// Set an input's value and fire the input event typing would fire.
|
||||
function typeInto(id, value) {
|
||||
return (
|
||||
"(() => { const el = document.getElementById(" +
|
||||
JSON.stringify(id) +
|
||||
"); el.value = " +
|
||||
JSON.stringify(value) +
|
||||
"; el.dispatchEvent(new Event('input', { bubbles: true })); })()"
|
||||
);
|
||||
}
|
||||
|
||||
function click(id) {
|
||||
return "document.getElementById(" + JSON.stringify(id) + ").click()";
|
||||
}
|
||||
|
||||
// The outcome of a request the dApp page started with __dapp.start(), or
|
||||
// {settled: "pending"} if it has not settled within `timeout`.
|
||||
function settled(key, timeout = 30000) {
|
||||
return (
|
||||
"Promise.race([window.__dapp.settle(" +
|
||||
JSON.stringify(key) +
|
||||
"), new Promise((r) => setTimeout(() => r({ settled: 'pending' }), " +
|
||||
timeout +
|
||||
"))])"
|
||||
);
|
||||
}
|
||||
|
||||
async function main() {
|
||||
if (!fs.existsSync(path.join(DIST_CHROME, "manifest.json"))) {
|
||||
console.error(
|
||||
"slowApproval: no unpacked build at " +
|
||||
DIST_CHROME +
|
||||
" — run make build first",
|
||||
);
|
||||
process.exitCode = 1;
|
||||
return;
|
||||
}
|
||||
|
||||
const node = await startDappServer();
|
||||
const profile = fs.mkdtempSync(
|
||||
path.join(os.tmpdir(), "autistmask-slow-approval-"),
|
||||
);
|
||||
const browser = spawn(
|
||||
chromium.executablePath(),
|
||||
[
|
||||
"--headless",
|
||||
// The container runs unprivileged, as in harness.js.
|
||||
"--no-sandbox",
|
||||
"--remote-debugging-pipe",
|
||||
"--user-data-dir=" + profile,
|
||||
"--disable-extensions-except=" + DIST_CHROME,
|
||||
"--load-extension=" + DIST_CHROME,
|
||||
// Nothing but the loopback dApp page and stub node can be reached.
|
||||
"--host-resolver-rules=MAP * ~NOTFOUND, EXCLUDE 127.0.0.1",
|
||||
"about:blank",
|
||||
],
|
||||
{ stdio: ["ignore", "ignore", "ignore", "pipe", "pipe"] },
|
||||
);
|
||||
|
||||
try {
|
||||
const send = devtools(browser);
|
||||
const targets = async () =>
|
||||
(await send("Target.getTargets")).targetInfos;
|
||||
|
||||
const worker = await until("the background worker", async () =>
|
||||
(await targets()).find(
|
||||
(t) =>
|
||||
t.type === "service_worker" &&
|
||||
t.url.startsWith("chrome-extension://"),
|
||||
),
|
||||
);
|
||||
// The extension id is the host of the worker's URL, as in harness.js.
|
||||
const popupUrl =
|
||||
"chrome-extension://" +
|
||||
new URL(worker.url).host +
|
||||
"/src/popup/index.html";
|
||||
const workerRunning = async () =>
|
||||
(await targets()).some((t) => t.url === worker.url);
|
||||
const openPage = async (url) => {
|
||||
const { targetId } = await send("Target.createTarget", { url });
|
||||
return { targetId, evaluate: await attach(send, targetId) };
|
||||
};
|
||||
const approvalPages = async () =>
|
||||
(await targets()).filter(
|
||||
(t) => t.type === "page" && t.url.includes("?approval="),
|
||||
);
|
||||
|
||||
// A wallet, through the popup's own screens, and the stub node as its
|
||||
// RPC endpoint, through Settings.
|
||||
const popup = await openPage(popupUrl);
|
||||
await until("the welcome screen", () =>
|
||||
popup.evaluate(shows("view-welcome")),
|
||||
);
|
||||
await popup.evaluate(click("btn-welcome-add"));
|
||||
await until("the add wallet screen", () =>
|
||||
popup.evaluate(shows("view-add-wallet")),
|
||||
);
|
||||
await popup.evaluate(click("btn-generate-phrase"));
|
||||
await until("a generated recovery phrase", () =>
|
||||
popup.evaluate(
|
||||
"document.getElementById('wallet-mnemonic').value.trim()" +
|
||||
".split(/\\s+/).length >= 12",
|
||||
),
|
||||
);
|
||||
await popup.evaluate(typeInto("add-wallet-password", PASSWORD));
|
||||
await popup.evaluate(typeInto("add-wallet-password-confirm", PASSWORD));
|
||||
await popup.evaluate(click("btn-add-wallet-confirm"));
|
||||
await until(
|
||||
"the main screen",
|
||||
() => popup.evaluate(shows("view-main")),
|
||||
60000,
|
||||
);
|
||||
await popup.evaluate(click("btn-settings"));
|
||||
await until("the settings screen", () =>
|
||||
popup.evaluate(shows("view-settings")),
|
||||
);
|
||||
await popup.evaluate(typeInto("settings-rpc", node.rpcUrl));
|
||||
await popup.evaluate(click("btn-save-rpc"));
|
||||
await until("the stub node saved as the RPC endpoint", () =>
|
||||
popup.evaluate(
|
||||
"new Promise((resolve) => chrome.storage.local.get(" +
|
||||
"'autistmask', (r) => resolve(r.autistmask.rpcUrl === " +
|
||||
JSON.stringify(node.rpcUrl) +
|
||||
")))",
|
||||
),
|
||||
);
|
||||
await send("Target.closeTarget", { targetId: popup.targetId });
|
||||
|
||||
// The site, connected through the real prompt with "Remember", so
|
||||
// the connection is stored rather than held by the worker.
|
||||
const dapp = await openPage(node.url);
|
||||
await until("the injected provider", () =>
|
||||
dapp.evaluate("!!window.ethereum && !!window.__dapp"),
|
||||
);
|
||||
await dapp.evaluate(
|
||||
"window.__dapp.start('accounts', 'eth_requestAccounts', [])",
|
||||
);
|
||||
const prompt = await until(
|
||||
"the connection prompt",
|
||||
async () => (await approvalPages())[0],
|
||||
);
|
||||
const inPrompt = await attach(send, prompt.targetId);
|
||||
await until("the connection prompt's screen", () =>
|
||||
inPrompt(shows("view-approve-site")),
|
||||
);
|
||||
await inPrompt(
|
||||
"document.getElementById('approve-remember').checked = true",
|
||||
);
|
||||
// The prompt closes itself on the click.
|
||||
await inPrompt(click("btn-approve")).catch(() => {});
|
||||
const accounts = await dapp.evaluate(settled("accounts"));
|
||||
if (accounts.settled !== "resolved") {
|
||||
throw new Error(
|
||||
"the site could not be connected: " + JSON.stringify(accounts),
|
||||
);
|
||||
}
|
||||
const address = getAddress(accounts.result[0]);
|
||||
console.log("# address " + address + ", site " + node.origin);
|
||||
|
||||
// The control: with nothing pending, the worker stops on its own.
|
||||
// Were something else keeping it running, the wait below would
|
||||
// prove nothing.
|
||||
const idleStart = Date.now();
|
||||
const stoppedWhenIdle = await until(
|
||||
"the idle worker to stop",
|
||||
async () => !(await workerRunning()),
|
||||
IDLE_STOP_TIMEOUT_MS,
|
||||
).catch(() => false);
|
||||
check(
|
||||
"with nothing pending, Chrome stops the background worker on its own",
|
||||
stoppedWhenIdle,
|
||||
"the worker was still running " +
|
||||
IDLE_STOP_TIMEOUT_MS / 1000 +
|
||||
"s after its last event, so something other than the " +
|
||||
"approval windows is keeping it running",
|
||||
);
|
||||
console.log(
|
||||
"# idle worker stopped after " +
|
||||
Math.round((Date.now() - idleStart) / 1000) +
|
||||
"s",
|
||||
);
|
||||
|
||||
// A transaction approval and a signature approval, both open at once.
|
||||
await dapp.evaluate(
|
||||
"window.__dapp.start('tx', 'eth_sendTransaction', [" +
|
||||
JSON.stringify({
|
||||
from: address,
|
||||
to: STUB_COUNTERPARTY,
|
||||
value: toQuantity(parseEther("0.01")),
|
||||
}) +
|
||||
"])",
|
||||
);
|
||||
await until("the transaction approval window", async () =>
|
||||
(await approvalPages()).length === 1 ? true : null,
|
||||
);
|
||||
await dapp.evaluate(
|
||||
"window.__dapp.start('sign', 'personal_sign', [" +
|
||||
JSON.stringify(SIGN_HEX) +
|
||||
", " +
|
||||
JSON.stringify(address) +
|
||||
"])",
|
||||
);
|
||||
const windows = await until("both approval windows", async () => {
|
||||
const pages = await approvalPages();
|
||||
return pages.length === 2 ? pages : null;
|
||||
});
|
||||
let txWindow = null;
|
||||
let signWindow = null;
|
||||
const windowIds = [];
|
||||
for (const page of windows) {
|
||||
const evaluate = await attach(send, page.targetId);
|
||||
const view = await until("an approval screen", () =>
|
||||
evaluate(
|
||||
"(" +
|
||||
shows("view-approve-tx") +
|
||||
") ? 'tx' : (" +
|
||||
shows("view-approve-sign") +
|
||||
") ? 'sign' : null",
|
||||
),
|
||||
);
|
||||
if (view === "tx") txWindow = evaluate;
|
||||
if (view === "sign") signWindow = evaluate;
|
||||
const { windowId } = await send("Browser.getWindowForTarget", {
|
||||
targetId: page.targetId,
|
||||
});
|
||||
windowIds.push(windowId);
|
||||
}
|
||||
if (!txWindow || !signWindow) {
|
||||
throw new Error("the two windows are not one of each kind");
|
||||
}
|
||||
const setWindowState = (windowState) =>
|
||||
Promise.all(
|
||||
windowIds.map((windowId) =>
|
||||
send("Browser.setWindowBounds", {
|
||||
windowId,
|
||||
bounds: { windowState },
|
||||
}),
|
||||
),
|
||||
);
|
||||
|
||||
// The user minimizes both windows while deciding.
|
||||
await setWindowState("minimized");
|
||||
const bothHidden = await until(
|
||||
"both approval pages hidden",
|
||||
async () =>
|
||||
(await txWindow("document.visibilityState")) === "hidden" &&
|
||||
(await signWindow("document.visibilityState")) === "hidden",
|
||||
).catch(() => false);
|
||||
check(
|
||||
"both approval windows are minimized, and their pages are hidden",
|
||||
bothHidden,
|
||||
"a page still reports itself visible, so the wait below would " +
|
||||
"not show what happens to a minimized approval",
|
||||
);
|
||||
|
||||
// The user takes seven minutes. The worker is checked every two
|
||||
// seconds, and the wait ends early if Chrome stops it.
|
||||
const opened = Date.now();
|
||||
let stoppedAfter = null;
|
||||
while (Date.now() - opened < APPROVAL_WAIT_MS) {
|
||||
if (!(await workerRunning())) {
|
||||
stoppedAfter = Math.round((Date.now() - opened) / 1000);
|
||||
break;
|
||||
}
|
||||
await sleep(2000);
|
||||
}
|
||||
check(
|
||||
"the background worker keeps running while both approvals wait in minimized windows",
|
||||
stoppedAfter === null,
|
||||
"Chrome stopped the worker " +
|
||||
stoppedAfter +
|
||||
"s after the approvals opened",
|
||||
);
|
||||
|
||||
// Back on screen to be answered.
|
||||
await setWindowState("normal");
|
||||
await txWindow(typeInto("approve-tx-password", PASSWORD));
|
||||
await txWindow(click("btn-approve-tx"));
|
||||
await signWindow(typeInto("approve-sign-password", PASSWORD));
|
||||
// The window closes itself once the signature is handed over.
|
||||
await signWindow(click("btn-approve-sign")).catch(() => {});
|
||||
|
||||
const tx = await dapp.evaluate(settled("tx"));
|
||||
const broadcast = node.broadcast.map((raw) => Transaction.from(raw));
|
||||
check(
|
||||
"the transaction approved after seven minutes reaches the site",
|
||||
tx.settled === "resolved" &&
|
||||
broadcast.length === 1 &&
|
||||
tx.result === broadcast[0].hash &&
|
||||
getAddress(broadcast[0].from) === address,
|
||||
"the page got " +
|
||||
JSON.stringify(tx) +
|
||||
" and the node received " +
|
||||
broadcast.length +
|
||||
" transaction(s)",
|
||||
);
|
||||
|
||||
const sign = await dapp.evaluate(settled("sign"));
|
||||
check(
|
||||
"the signature approved after seven minutes reaches the site",
|
||||
sign.settled === "resolved" &&
|
||||
getAddress(verifyMessage(getBytes(SIGN_HEX), sign.result)) ===
|
||||
address,
|
||||
"the page got " + JSON.stringify(sign),
|
||||
);
|
||||
} catch (e) {
|
||||
failed += 1;
|
||||
console.log("# ERROR: " + (e && e.stack ? e.stack : e));
|
||||
} finally {
|
||||
if (browser.exitCode === null && browser.signalCode === null) {
|
||||
const exited = new Promise((resolve) =>
|
||||
browser.once("exit", resolve),
|
||||
);
|
||||
browser.kill();
|
||||
await exited;
|
||||
}
|
||||
await node.close();
|
||||
// Chromium's helper processes can still be writing to the profile
|
||||
// for a moment after the browser process itself has exited.
|
||||
fs.rmSync(profile, { recursive: true, force: true, maxRetries: 5 });
|
||||
}
|
||||
|
||||
console.log("1.." + checks.length);
|
||||
if (checks.length === 0) {
|
||||
console.log("# FAILED: this program asserted nothing");
|
||||
process.exitCode = 1;
|
||||
return;
|
||||
}
|
||||
console.log(
|
||||
"# " +
|
||||
(checks.length - failed) +
|
||||
"/" +
|
||||
checks.length +
|
||||
" checks passed",
|
||||
);
|
||||
if (failed > 0) {
|
||||
console.log("# FAILED");
|
||||
process.exitCode = 1;
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
console.error("slowApproval: " + (e && e.stack ? e.stack : e));
|
||||
process.exitCode = 1;
|
||||
});
|
||||
@@ -0,0 +1,102 @@
|
||||
// The sign screen signs an eth_sign request the way it signs personal_sign: as
|
||||
// an EIP-191 personal message over the bytes of the data
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/409). Booted through the real
|
||||
// popup entry point as the approval window. The background's half, which reads
|
||||
// the address first and the data second and checks the signature, is tested in
|
||||
// tests/backgroundApproval.test.js.
|
||||
|
||||
// Mocked so that no password has to be hashed: the stored secret decrypts to
|
||||
// the test key below.
|
||||
jest.mock("../src/shared/vault", () => ({
|
||||
decryptWithPassword: jest.fn(),
|
||||
encryptWithPassword: jest.fn(),
|
||||
}));
|
||||
|
||||
const { Wallet, getBytes } = require("ethers");
|
||||
const {
|
||||
bootPopup,
|
||||
cleanupPopup,
|
||||
unversionedValidProfile,
|
||||
} = require("./support/popupBoot");
|
||||
|
||||
// A published test key, never used for real funds.
|
||||
const SIGNER_KEY =
|
||||
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
||||
const signer = new Wallet(SIGNER_KEY);
|
||||
// "Hello AutistMask", as the hex a page sends.
|
||||
const MESSAGE = "0x48656c6c6f204175746973744d61736b";
|
||||
const ORIGIN = "https://dapp.example";
|
||||
|
||||
afterEach(cleanupPopup);
|
||||
|
||||
test("the sign screen answers eth_sign with a personal message signature over the data", async () => {
|
||||
const sent = [];
|
||||
const page = await bootPopup(
|
||||
unversionedValidProfile({
|
||||
wallets: [
|
||||
{
|
||||
type: "key",
|
||||
name: "Wallet 1",
|
||||
encryptedSecret: "encrypted-key",
|
||||
addresses: [
|
||||
{
|
||||
address: signer.address,
|
||||
balance: "0.0000",
|
||||
tokenBalances: [],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
activeAddress: signer.address,
|
||||
allowedSites: { [signer.address]: [ORIGIN] },
|
||||
}),
|
||||
{
|
||||
search: "?approval=approval-1",
|
||||
runtime: {
|
||||
connect: () => ({ postMessage: () => {} }),
|
||||
// Answered as the background answers: with the eth_sign
|
||||
// approval this window was opened for, and by handing back
|
||||
// the signature the popup sends.
|
||||
sendMessage: (msg, reply) => {
|
||||
sent.push(msg);
|
||||
if (msg.type === "AUTISTMASK_GET_APPROVAL") {
|
||||
reply({
|
||||
type: "sign",
|
||||
origin: ORIGIN,
|
||||
isPhishingDomain: false,
|
||||
approvedFrom: signer.address,
|
||||
signParams: {
|
||||
method: "eth_sign",
|
||||
message: MESSAGE,
|
||||
from: signer.address,
|
||||
},
|
||||
});
|
||||
} else if (msg.type === "AUTISTMASK_SIGN_RESPONSE") {
|
||||
reply({ signature: msg.signature });
|
||||
} else {
|
||||
reply(undefined);
|
||||
}
|
||||
},
|
||||
},
|
||||
},
|
||||
);
|
||||
globalThis.window.close = jest.fn();
|
||||
const { decryptWithPassword } = require("../src/shared/vault");
|
||||
decryptWithPassword.mockResolvedValue(SIGNER_KEY);
|
||||
|
||||
expect(page.visibleViews()).toEqual(["approve-sign"]);
|
||||
page.node("approve-sign-password").value = "any password";
|
||||
await page.click("btn-approve-sign");
|
||||
|
||||
expect(
|
||||
sent.filter((msg) => msg.type === "AUTISTMASK_SIGN_RESPONSE"),
|
||||
).toEqual([
|
||||
{
|
||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
||||
id: "approval-1",
|
||||
approved: true,
|
||||
signature: await signer.signMessage(getBytes(MESSAGE)),
|
||||
},
|
||||
]);
|
||||
expect(globalThis.window.close).toHaveBeenCalled();
|
||||
});
|
||||
@@ -207,7 +207,7 @@ describe("a decrypt still running when the screen is left", () => {
|
||||
});
|
||||
|
||||
// Same hole on the failure path: a wrong-password error written after
|
||||
// the wipe would restore the flash line on a screen the user has left.
|
||||
// the wipe would restore the error line on a screen the user has left.
|
||||
test("never writes the failure message either", async () => {
|
||||
const { helpers, vault, exportPrivkey } = load();
|
||||
exportPrivkey.show(0, 0);
|
||||
@@ -217,8 +217,10 @@ describe("a decrypt still running when the screen is left", () => {
|
||||
reveal.reject(new Error("decryption failed"));
|
||||
await reveal.pending;
|
||||
|
||||
expect(node("export-privkey-flash").textContent).toBe("");
|
||||
expect(node("export-privkey-flash").style.visibility).toBe("hidden");
|
||||
expect(node("export-privkey-password-error").textContent).toBe("");
|
||||
expect(node("export-privkey-password-error").style.visibility).toBe(
|
||||
"hidden",
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -260,7 +262,7 @@ describe("a reveal that is not interrupted", () => {
|
||||
await reveal.pending;
|
||||
|
||||
expect(node("export-privkey-value").textContent).toBe("");
|
||||
expect(node("export-privkey-flash").textContent).toBe(
|
||||
expect(node("export-privkey-password-error").textContent).toBe(
|
||||
"That password is incorrect. Please try again.",
|
||||
);
|
||||
});
|
||||
@@ -336,6 +338,36 @@ describe("opening the screen again in the same popup session", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("Back from Settings after leaving by the settings gear", () => {
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/461: leaving drops the
|
||||
// address selection, so Back onto this screen showed a password prompt
|
||||
// that could only answer "No address is selected."
|
||||
test("goes to the address screen it was opened from", () => {
|
||||
const { helpers, state, exportPrivkey } = load();
|
||||
state.viewStack = ["main"];
|
||||
exportPrivkey.show(0, 0);
|
||||
// The settings gear: push the current view, then show Settings.
|
||||
helpers.pushCurrentView();
|
||||
helpers.showView("settings");
|
||||
|
||||
helpers.goBack();
|
||||
|
||||
expect(state.currentView).toBe("address");
|
||||
expect(state.viewStack).toEqual(["main"]);
|
||||
});
|
||||
|
||||
test("its own Back button leaves the rest of the stack alone", async () => {
|
||||
const { state, exportPrivkey } = load();
|
||||
state.viewStack = ["main"];
|
||||
exportPrivkey.show(0, 0);
|
||||
|
||||
await click("btn-export-privkey-back");
|
||||
|
||||
expect(state.currentView).toBe("address");
|
||||
expect(state.viewStack).toEqual(["main"]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("views the popup may reopen onto", () => {
|
||||
// Restoring onto this screen would put a private key on display with no
|
||||
// password prompt in front of it, on a popup reopened by accident.
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
// The toolbar icons in icons/ are drawn by script/lib/icons.js (`make icons`).
|
||||
// Each committed file must hold exactly the image it draws, the same IHDR and
|
||||
// every pixel, so the drawing and the files cannot drift apart. The compressed
|
||||
// bytes are not compared: the committed files were compressed by stock zlib,
|
||||
// and node's bundled zlib compresses the same pixels differently.
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
|
||||
const { icons } = require("../manifest/chrome.json");
|
||||
const { drawIcon, decodePng } = require("../script/lib/icons");
|
||||
|
||||
describe("toolbar icons", () => {
|
||||
test.each(Object.entries(icons))(
|
||||
"the %spx icon %s holds the image script/lib/icons.js draws",
|
||||
(size, file) => {
|
||||
const side = Number(size);
|
||||
const committed = decodePng(
|
||||
fs.readFileSync(path.join(__dirname, "..", file)),
|
||||
);
|
||||
const drawn = decodePng(drawIcon(side));
|
||||
|
||||
expect(committed.header).toEqual(drawn.header);
|
||||
// Each row is its filter type byte, then 4 bytes per pixel.
|
||||
expect(drawn.rows.length).toBe(side * (side * 4 + 1));
|
||||
expect(committed.rows.length).toBe(drawn.rows.length);
|
||||
// The offset of the first byte that differs, not a diff of all.
|
||||
expect(
|
||||
committed.rows.findIndex((byte, i) => byte !== drawn.rows[i]),
|
||||
).toBe(-1);
|
||||
},
|
||||
);
|
||||
});
|
||||
@@ -345,10 +345,10 @@ describe.each([
|
||||
});
|
||||
|
||||
// A transaction's value and fee are in the native currency of the network the
|
||||
// transaction is on, which need not be the active one. A site can switch the
|
||||
// active network after its transaction is prepared and back before it is
|
||||
// signed, and a popup opened after a switch shows a sent or listed transaction
|
||||
// again. The wallet's balances follow the active network; these do not.
|
||||
// transaction is on, which need not be the active one. The active network can
|
||||
// change, in Settings or when the user approves a site's request, after a
|
||||
// transaction is prepared and change back before it is signed, and a popup
|
||||
// opened after a switch shows a sent or listed transaction again. The wallet's balances follow the active network; these do not.
|
||||
describe.each([
|
||||
["mainnet", "sepolia", "ETH"],
|
||||
["sepolia", "mainnet", "SepoliaETH"],
|
||||
|
||||
@@ -0,0 +1,159 @@
|
||||
// Every screen that asks for a password shows a password error the same way:
|
||||
// through showError() and hideError() in src/popup/views/helpers.js, in a
|
||||
// fixed-height error line below the password field, and never in the flash
|
||||
// line at the top of the popup
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/493). These boot the real popup
|
||||
// over src/popup/index.html, so each error line has to exist in the markup,
|
||||
// and check that the error appears in it and clears again.
|
||||
|
||||
jest.mock("../src/shared/vault", () => ({
|
||||
decryptWithPassword: jest.fn(),
|
||||
encryptWithPassword: jest.fn(),
|
||||
}));
|
||||
|
||||
const {
|
||||
bootPopup,
|
||||
cleanupPopup,
|
||||
unversionedValidProfile,
|
||||
} = require("./support/popupBoot");
|
||||
|
||||
const PASSWORD = "correct horse battery staple";
|
||||
const WRONG_PASSWORD = "That password is incorrect. Please try again.";
|
||||
|
||||
afterEach(() => {
|
||||
cleanupPopup();
|
||||
});
|
||||
|
||||
// The error line as the user sees it.
|
||||
function errorLine(page, id) {
|
||||
return {
|
||||
inMarkup: page.document.authoredIds.has(id),
|
||||
text: page.text(id),
|
||||
visibility: page.node(id).style.visibility,
|
||||
};
|
||||
}
|
||||
|
||||
function shown(text) {
|
||||
return { inMarkup: true, text, visibility: "visible" };
|
||||
}
|
||||
|
||||
const cleared = { inMarkup: true, text: "", visibility: "hidden" };
|
||||
|
||||
describe("the add wallet screen", () => {
|
||||
const ERROR = "add-wallet-password-error";
|
||||
|
||||
// First run: Welcome, "Add wallet", then the die for a valid phrase.
|
||||
async function openAddWallet() {
|
||||
const page = await bootPopup(undefined);
|
||||
await page.click("btn-welcome-add");
|
||||
await page.click("btn-generate-phrase");
|
||||
return page;
|
||||
}
|
||||
|
||||
function setPasswords(page, password, confirm) {
|
||||
page.node("add-wallet-password").value = password;
|
||||
page.node("add-wallet-password-confirm").value = confirm;
|
||||
}
|
||||
|
||||
test("shows a password problem below the password fields, and clears it on the next press", async () => {
|
||||
const page = await openAddWallet();
|
||||
setPasswords(page, "short", "short");
|
||||
await page.click("btn-add-wallet-confirm");
|
||||
expect(errorLine(page, ERROR)).toEqual(
|
||||
shown("Password must be at least 12 characters."),
|
||||
);
|
||||
expect(page.text("flash-msg")).toBe("");
|
||||
|
||||
// The password is fixed and the phrase emptied: the password error
|
||||
// goes, and the phrase problem is still reported in the flash line.
|
||||
setPasswords(page, PASSWORD, PASSWORD);
|
||||
page.node("wallet-mnemonic").value = "";
|
||||
await page.click("btn-add-wallet-confirm");
|
||||
expect(errorLine(page, ERROR)).toEqual(cleared);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"Enter a recovery phrase, or press the die.",
|
||||
);
|
||||
|
||||
// Leaving clears the flash line and stops its timer, which would
|
||||
// otherwise fire after this page is gone.
|
||||
await page.click("btn-add-wallet-back");
|
||||
});
|
||||
|
||||
test("clears the error when the screen is shown again", async () => {
|
||||
const page = await openAddWallet();
|
||||
setPasswords(page, PASSWORD, PASSWORD + " typo");
|
||||
await page.click("btn-add-wallet-confirm");
|
||||
expect(errorLine(page, ERROR)).toEqual(
|
||||
shown("Passwords do not match."),
|
||||
);
|
||||
|
||||
await page.click("btn-add-wallet-back");
|
||||
await page.click("btn-welcome-add");
|
||||
expect(errorLine(page, ERROR)).toEqual(cleared);
|
||||
});
|
||||
});
|
||||
|
||||
describe.each([
|
||||
{
|
||||
screen: "the private key export screen",
|
||||
open: () => require("../src/popup/views/exportPrivkey").show(0, 0),
|
||||
field: "export-privkey-password",
|
||||
button: "btn-export-privkey-confirm",
|
||||
error: "export-privkey-password-error",
|
||||
},
|
||||
{
|
||||
screen: "the recovery phrase screen",
|
||||
open: () => require("../src/popup/views/showPhrase").show(0),
|
||||
field: "show-phrase-password",
|
||||
button: "btn-show-phrase-reveal",
|
||||
error: "show-phrase-password-error",
|
||||
},
|
||||
{
|
||||
screen: "the delete wallet screen",
|
||||
open: () => require("../src/popup/views/deleteWallet").show(0),
|
||||
field: "delete-wallet-password",
|
||||
button: "btn-delete-wallet-confirm",
|
||||
error: "delete-wallet-password-error",
|
||||
},
|
||||
])("$screen", ({ open, field, button, error }) => {
|
||||
// Opens the screen and enters a password the vault rejects.
|
||||
async function failedAttempt() {
|
||||
const page = await bootPopup(unversionedValidProfile());
|
||||
open();
|
||||
const { decryptWithPassword } = require("../src/shared/vault");
|
||||
decryptWithPassword.mockRejectedValue(new Error("wrong password"));
|
||||
page.node(field).value = "not the password";
|
||||
await page.click(button);
|
||||
return { page, decryptWithPassword };
|
||||
}
|
||||
|
||||
test("shows a wrong password below the password field", async () => {
|
||||
const { page } = await failedAttempt();
|
||||
expect(errorLine(page, error)).toEqual(shown(WRONG_PASSWORD));
|
||||
});
|
||||
|
||||
test("clears the error while the next password is checked", async () => {
|
||||
const { page, decryptWithPassword } = await failedAttempt();
|
||||
let rejectDecrypt;
|
||||
decryptWithPassword.mockReturnValue(
|
||||
new Promise((resolve, reject) => {
|
||||
rejectDecrypt = reject;
|
||||
}),
|
||||
);
|
||||
|
||||
page.node(field).value = "another guess";
|
||||
const pressed = page.click(button);
|
||||
await page.settle();
|
||||
expect(errorLine(page, error)).toEqual(cleared);
|
||||
|
||||
rejectDecrypt(new Error("wrong password"));
|
||||
await pressed;
|
||||
expect(errorLine(page, error)).toEqual(shown(WRONG_PASSWORD));
|
||||
});
|
||||
|
||||
test("clears the error when the screen is shown again", async () => {
|
||||
const { page } = await failedAttempt();
|
||||
open();
|
||||
expect(errorLine(page, error)).toEqual(cleared);
|
||||
});
|
||||
});
|
||||
@@ -49,22 +49,37 @@
|
||||
// every path a stored record takes, and the difference is the whole of what
|
||||
// this file does not cover:
|
||||
//
|
||||
// - Only the values in the table, in the SLOT arrangement below: four value
|
||||
// combinations per view, not the product of twelve fields. A dereference
|
||||
// reached only under a pairing no slot produces is not driven at all.
|
||||
// - Only what a stored record reaches by ITSELF. A view only forward
|
||||
// navigation opens, and anything behind a click, is not driven.
|
||||
// - Nothing about the paths a HEALTHY profile takes, which is most of the
|
||||
// popup. This file is a floor under one defect class, not a proof about
|
||||
// the renderers.
|
||||
// - Only the values in the table, in the SLOT arrangement below. On the
|
||||
// restore path the twelve fields the router does not read are corrupted
|
||||
// together, every field on the same slot, so a view gets four value
|
||||
// combinations of them, not their product. A branch entered only when one
|
||||
// of them is truthy and another falsy is reached only where the falsy
|
||||
// slot happens to pair a field that cannot be falsy with one that is.
|
||||
// Each field the router reads is corrupted alone, over an otherwise
|
||||
// well-formed record.
|
||||
// - Only what a stored record reaches by ITSELF, as the boot renders it. A
|
||||
// view only forward navigation opens, anything behind a click, and
|
||||
// anything behind a timer (bootPopup() records every interval, and this
|
||||
// file never runs one) is not driven.
|
||||
// - Of the paths a HEALTHY profile takes, only its boot onto each
|
||||
// restorable view ("the base profile the sweep corrupts" below). The rest
|
||||
// of the popup is not covered: this file is a floor under one defect
|
||||
// class, not a proof about the renderers.
|
||||
//
|
||||
// Within that boundary it is unconditional: if one of these boots leaves the
|
||||
// popup unhealthy or off the view it stored, this file goes red — including
|
||||
// when it takes two corrupted fields at once, because the verdict is the
|
||||
// combined boot itself and the per-field re-boot below can only decorate the
|
||||
// message. That last part is the one thing an earlier version got wrong: it
|
||||
// asserted on the per-field list, so an observed dead popup that no single
|
||||
// field reproduced was reported green.
|
||||
// Within that boundary it is unconditional: if a boot that corrupts a field
|
||||
// leaves the popup unhealthy, this file goes red — including when it takes
|
||||
// two corrupted fields at once, because the verdict is the combined boot
|
||||
// itself and the per-field re-boot below can only decorate the message. That
|
||||
// last part is the one thing an earlier version got wrong: it asserted on the
|
||||
// per-field list, so an observed dead popup that no single field reproduced
|
||||
// was reported green.
|
||||
//
|
||||
// Where the popup lands is held for some of those boots and not others. The
|
||||
// combined boot must land on the view it stored, and each `hostileRestore`
|
||||
// value must land on its view, or fall back to Home, as its entry declares.
|
||||
// The boots in "a hostile routing value restoring onto" are held to health
|
||||
// alone, because a value in a field the router reads legitimately changes
|
||||
// which view renders; so are the boots onto Home, which store no view.
|
||||
//
|
||||
// Booting every field separately at every value would be several hundred boots
|
||||
// and most of the suite's budget; this is forty-four. Widening it further is
|
||||
@@ -128,7 +143,11 @@ const sweptValues = (row) => [...row.hostile, ...(row.falsy || [])];
|
||||
// list short and pointed. `floorOnly` is extra values checked against the
|
||||
// floor alone, which is pure and free. `hostileRestore` is extra values driven
|
||||
// through the restore path only, for a value that means nothing until a
|
||||
// particular branch's gate has let it past.
|
||||
// particular branch's gate has let it past. Each of its entries names the
|
||||
// `views` it is driven onto and declares whether the boot lands on them
|
||||
// (`restored: true`) or falls back to Home (`restored: false`), so a value
|
||||
// written for one renderer cannot stop reaching it unnoticed. A value driven
|
||||
// onto every restorable view is written with everyRestorableView() below.
|
||||
//
|
||||
// `falsy` is the other POLARITY of a swept field, driven for the same reason.
|
||||
// It is not a value src/ never writes — for three of these fields it is the
|
||||
@@ -139,6 +158,23 @@ const sweptValues = (row) => [...row.hostile, ...(row.falsy || [])];
|
||||
// falsy value stored under that field comes back TRUTHY from the floor, so no
|
||||
// `!state.x` branch is reachable from a stored record at all.
|
||||
|
||||
// The `hostileRestore` entries for a value driven onto every restorable view:
|
||||
// it falls back to Home on the views listed in `fallsBackOn` and lands on every
|
||||
// other one, so a view added to RESTORABLE_VIEWS is driven, and expected to
|
||||
// land, without editing the row.
|
||||
function everyRestorableView(value, fallsBackOn) {
|
||||
return [
|
||||
{ value, views: fallsBackOn, restored: false },
|
||||
{
|
||||
value,
|
||||
views: [...RESTORABLE_VIEWS].filter(
|
||||
(view) => !fallsBackOn.includes(view),
|
||||
),
|
||||
restored: true,
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
const CONTRACT = [
|
||||
{
|
||||
field: "wallets",
|
||||
@@ -280,28 +316,38 @@ const CONTRACT = [
|
||||
kind: KIND.SCALAR,
|
||||
// The prototype members are the whole point: `wallets["map"]` is
|
||||
// TRUTHY, so hasValidAddress()'s `&&` does not short-circuit and
|
||||
// `.addresses[…]` throws. A stale INTEGER is the safe case.
|
||||
hostile: ["map", "__proto__", { a: 1 }],
|
||||
// `.addresses[…]` throws. A stale INTEGER is the safe case and has to
|
||||
// stay so. 5 is one, out of range for the one wallet in the profile,
|
||||
// and it is also this field's truthy polarity: every other value here
|
||||
// comes back from the floor as null.
|
||||
hostile: ["map", "__proto__", { a: 1 }, 5],
|
||||
floorOnly: ["length", "constructor", "toString", "0", -1, 1.5, true],
|
||||
holds: isIndexOrNull,
|
||||
// SCALAR, and swept anyway: the restore path is precisely why this
|
||||
// field gained a floor, so the sweep is the regression guard on it.
|
||||
alsoSweep: true,
|
||||
routes: true,
|
||||
// A stale INTEGER index, which reaches the restore path by a different
|
||||
// route from the prototype members above — falsy or out of range
|
||||
// rather than truthy — and has to keep being the safe case.
|
||||
hostileRestore: [{ value: "length" }, { value: 5 }],
|
||||
// Comes back from the floor as null, which hasValidAddress() reads as
|
||||
// nothing selected: the popup falls back to Home on the five views
|
||||
// that need an address, and lands on every other one.
|
||||
hostileRestore: everyRestorableView("length", [
|
||||
"address",
|
||||
"address-token",
|
||||
"receive",
|
||||
"transaction",
|
||||
"confirm-tx",
|
||||
]),
|
||||
},
|
||||
{
|
||||
field: "selectedAddress",
|
||||
kind: KIND.SCALAR,
|
||||
hostile: ["map", "__proto__", { a: 1 }],
|
||||
// 5 for the same reason as in selectedWallet: a stale index, and the
|
||||
// one value here still truthy after the floor.
|
||||
hostile: ["map", "__proto__", { a: 1 }, 5],
|
||||
floorOnly: ["length", "constructor", "toString", "0", -1, 1.5, true],
|
||||
holds: isIndexOrNull,
|
||||
alsoSweep: true,
|
||||
routes: true,
|
||||
hostileRestore: [{ value: 5 }],
|
||||
},
|
||||
{
|
||||
field: "currentView",
|
||||
@@ -325,7 +371,9 @@ const CONTRACT = [
|
||||
// container shapes below onto every restorable view; hostileRestore
|
||||
// adds the records that PASS a branch's gate and then hand its
|
||||
// renderer something it dereferences, which is where the entries are
|
||||
// actually decided.
|
||||
// actually decided. The guard refuses each single-view record below,
|
||||
// so each is declared to fall back to Home: one that started landing
|
||||
// would be reaching the renderer it was written against.
|
||||
hostile: [42, "notarecord", { a: 1 }, [1, 2]],
|
||||
// `structuredClone(saved.viewData || {})`: the container is never falsy
|
||||
// in state whatever was stored, so no `!state.viewData` branch exists to
|
||||
@@ -334,11 +382,20 @@ const CONTRACT = [
|
||||
hostileRestore: [
|
||||
// success-tx passes on `data.hash`, and renderSuccess() then calls
|
||||
// toAddressHtml(d.to) -> addressTitle() -> address.toLowerCase().
|
||||
{ value: { hash: "0x1" }, views: ["success-tx"] },
|
||||
{ value: { hash: "0x1", to: 42 }, views: ["success-tx"] },
|
||||
{
|
||||
value: { hash: "0x1" },
|
||||
views: ["success-tx"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: { hash: "0x1", to: 42 },
|
||||
views: ["success-tx"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: { hash: "0x1", to: ADDRESS, decoded: { details: 7 } },
|
||||
views: ["success-tx"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: {
|
||||
@@ -347,12 +404,25 @@ const CONTRACT = [
|
||||
decoded: { details: [{ address: 42 }] },
|
||||
},
|
||||
views: ["success-tx"],
|
||||
restored: false,
|
||||
},
|
||||
// error-tx passes on `data.message`, same dereference.
|
||||
{ value: { message: "boom" }, views: ["error-tx"] },
|
||||
{ value: { message: "boom", to: 42 }, views: ["error-tx"] },
|
||||
{
|
||||
value: { message: "boom" },
|
||||
views: ["error-tx"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: { message: "boom", to: 42 },
|
||||
views: ["error-tx"],
|
||||
restored: false,
|
||||
},
|
||||
// transaction passes on `data.tx`.
|
||||
{ value: { tx: { hash: "0x1" } }, views: ["transaction"] },
|
||||
{
|
||||
value: { tx: { hash: "0x1" } },
|
||||
views: ["transaction"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: {
|
||||
tx: {
|
||||
@@ -363,9 +433,14 @@ const CONTRACT = [
|
||||
},
|
||||
},
|
||||
views: ["transaction"],
|
||||
restored: false,
|
||||
},
|
||||
// confirm-tx passes on `data.pendingTx`.
|
||||
{ value: { pendingTx: { amount: "1" } }, views: ["confirm-tx"] },
|
||||
{
|
||||
value: { pendingTx: { amount: "1" } },
|
||||
views: ["confirm-tx"],
|
||||
restored: false,
|
||||
},
|
||||
{
|
||||
value: {
|
||||
pendingTx: {
|
||||
@@ -376,6 +451,7 @@ const CONTRACT = [
|
||||
},
|
||||
},
|
||||
views: ["confirm-tx"],
|
||||
restored: false,
|
||||
},
|
||||
// wait-tx passes on `pendingWait.hash`; restoreWait() has checked
|
||||
// the fields below it since it was written, and this is the
|
||||
@@ -388,20 +464,29 @@ const CONTRACT = [
|
||||
},
|
||||
},
|
||||
views: ["wait-tx"],
|
||||
restored: false,
|
||||
},
|
||||
// A record that passes EVERY branch's gate at once, driven onto
|
||||
// every restorable view: a branch a view does not read must stay
|
||||
// one it does not read, and each renderer must survive the fields
|
||||
// another branch left behind.
|
||||
// one it does not read. The five views with a viewData branch
|
||||
// refuse it; every other one renders it, and must survive the
|
||||
// fields every branch left behind.
|
||||
...everyRestorableView(
|
||||
{
|
||||
value: {
|
||||
hash: "0x1",
|
||||
message: "boom",
|
||||
tx: { hash: "0x1" },
|
||||
pendingTx: { amount: "1" },
|
||||
pendingWait: { hash: "0x1" },
|
||||
},
|
||||
},
|
||||
[
|
||||
"confirm-tx",
|
||||
"transaction",
|
||||
"wait-tx",
|
||||
"success-tx",
|
||||
"error-tx",
|
||||
],
|
||||
),
|
||||
],
|
||||
},
|
||||
{
|
||||
@@ -583,6 +668,11 @@ const HEALTHY = { errors: [], blank: false };
|
||||
// set is all-truthy by construction, so without a falsy slot a dereference
|
||||
// behind `if (!state.x)` is never reached on the boot that corrupts x — the
|
||||
// same falsy-collapse blind spot the fields below were floored for.
|
||||
//
|
||||
// Only `hostile` and `falsy` values count. Those go through the sweep below,
|
||||
// which covers every restorable view; a `hostileRestore` entry is driven onto
|
||||
// only the views it names, so a polarity it alone supplied might reach a single
|
||||
// renderer.
|
||||
describe("both polarities of every swept field are driven", () => {
|
||||
const FALSY_STORED = [0, "", false, null];
|
||||
const floored = (field, value) =>
|
||||
@@ -606,10 +696,9 @@ describe("both polarities of every swept field are driven", () => {
|
||||
test(`${row.field}: truthy and falsy`, () => {
|
||||
// What the boots below actually drive, floored the way a renderer
|
||||
// sees it — not what the row says it drives.
|
||||
const driven = [
|
||||
...sweptValues(row),
|
||||
...(row.hostileRestore || []).map((entry) => entry.value),
|
||||
].map((value) => floored(row.field, value));
|
||||
const driven = sweptValues(row).map((value) =>
|
||||
floored(row.field, value),
|
||||
);
|
||||
|
||||
expect({
|
||||
truthy: driven.some((value) => Boolean(value)),
|
||||
@@ -865,20 +954,27 @@ describe("every field the router does not read, corrupted at once, onto", () =>
|
||||
|
||||
// The values that only mean something on the restore path: a viewData that
|
||||
// PASSES a branch's gate and then hands its renderer something dereferenced,
|
||||
// and the index values whose route through hasValidAddress() differs from the
|
||||
// row's own hostile set.
|
||||
// and a selectedWallet the floor turns into nothing selected. Each boot must
|
||||
// throw nothing and show exactly the view its entry says it lands on: its own,
|
||||
// or Home, so a value written for one renderer cannot stop reaching it and
|
||||
// still pass.
|
||||
describe("a restore-only hostile value onto", () => {
|
||||
for (const row of CONTRACT) {
|
||||
for (const entry of row.hostileRestore || []) {
|
||||
for (const view of entry.views || RESTORABLE_VIEWS) {
|
||||
for (const view of entry.views) {
|
||||
test(`${view}: ${row.field} = ${JSON.stringify(
|
||||
entry.value,
|
||||
)}`, async () => {
|
||||
await expect(
|
||||
bootHealth(
|
||||
const env = await bootPopup(
|
||||
restoringOnto(view, { [row.field]: entry.value }),
|
||||
),
|
||||
).resolves.toEqual(HEALTHY);
|
||||
);
|
||||
expect({
|
||||
errors: env.pageErrors,
|
||||
visible: env.visibleViews(),
|
||||
}).toEqual({
|
||||
errors: [],
|
||||
visible: [entry.restored ? view : "main"],
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -89,6 +89,12 @@ describe("vendored blocklist", () => {
|
||||
expect(isPhishingDomain(LISTED[0].toUpperCase())).toBe(true);
|
||||
});
|
||||
|
||||
test("a hostname ending in a dot is the same host", () => {
|
||||
expect(isPhishingDomain(LISTED[1] + ".")).toBe(true);
|
||||
expect(isPhishingDomain("wallet." + LISTED[1] + ".")).toBe(true);
|
||||
expect(isPhishingDomain(CLEAN[0] + ".")).toBe(false);
|
||||
});
|
||||
|
||||
test("returns false for an empty or missing hostname", () => {
|
||||
expect(isPhishingDomain("")).toBe(false);
|
||||
expect(isPhishingDomain(null)).toBe(false);
|
||||
@@ -133,6 +139,13 @@ describe("hostnameVariants", () => {
|
||||
test("lowercases hostnames", () => {
|
||||
expect(hostnameVariants("Evil.COM")).toEqual(["evil.com"]);
|
||||
});
|
||||
|
||||
test("drops the trailing dot of a fully qualified hostname", () => {
|
||||
expect(hostnameVariants("sub.evil.com.")).toEqual([
|
||||
"sub.evil.com",
|
||||
"evil.com",
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("domain hashing", () => {
|
||||
|
||||
+108
-7
@@ -1,12 +1,17 @@
|
||||
// Tests for the recovery phrase display (issue #161).
|
||||
//
|
||||
// These cover the parts that do not need a DOM: which wallet types may be
|
||||
// offered the action at all, the exclusion of the screen from the set of
|
||||
// views the popup may reopen onto, and the absence of any path from this
|
||||
// module to the logger. The DOM behaviour it guards — nothing rendered
|
||||
// before the password is accepted, a wrong password revealing nothing, and
|
||||
// the wipe on leaving — is driven against the real popup in a real browser
|
||||
// by tests/e2e/run.js, which is where every other view behaviour is tested.
|
||||
// These cover which wallet types may be offered the action at all, the
|
||||
// exclusion of the screen from the set of views the popup may reopen onto,
|
||||
// the absence of any path from this module to the logger, and, against a
|
||||
// minimal DOM stub, where Back goes after the screen is left by the settings
|
||||
// gear or by its own Back. The rest of the DOM behaviour it guards — nothing rendered before the
|
||||
// password is accepted, a wrong password revealing nothing, and the wipe on
|
||||
// leaving — is driven against the real popup in a real browser by
|
||||
// tests/e2e/run.js, which is where every other view behaviour is tested.
|
||||
|
||||
jest.mock("../src/shared/vault", () => ({
|
||||
decryptWithPassword: jest.fn(),
|
||||
}));
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
@@ -74,6 +79,102 @@ describe("views the popup may reopen onto", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// Just enough document for helpers.showView() and this view: every element
|
||||
// is made on first lookup and keeps what the view writes to it, its click
|
||||
// handler included.
|
||||
function makeDocument() {
|
||||
const els = new Map();
|
||||
function makeElement() {
|
||||
const classes = new Set();
|
||||
const el = {
|
||||
textContent: "",
|
||||
value: "",
|
||||
style: {},
|
||||
classList: {
|
||||
add: (name) => classes.add(name),
|
||||
remove: (name) => classes.delete(name),
|
||||
contains: (name) => classes.has(name),
|
||||
toggle: (name, on) =>
|
||||
on ? classes.add(name) : classes.delete(name),
|
||||
},
|
||||
addEventListener: (name, fn) => {
|
||||
if (name === "click") el.onClick = fn;
|
||||
},
|
||||
};
|
||||
return el;
|
||||
}
|
||||
return {
|
||||
getElementById(id) {
|
||||
// Created on demand by helpers.js; absent on a mainnet popup
|
||||
// that is not a debug build.
|
||||
if (id === "debug-banner") return null;
|
||||
if (!els.has(id)) els.set(id, makeElement());
|
||||
return els.get(id);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
describe("Back from Settings after leaving by the settings gear", () => {
|
||||
// On Settings, opened from Home.
|
||||
function load() {
|
||||
jest.resetModules();
|
||||
globalThis.document = makeDocument();
|
||||
const helpers = loadHelpers();
|
||||
const { state } = require("../src/shared/state");
|
||||
const showPhrase = require("../src/popup/views/showPhrase");
|
||||
showPhrase.init();
|
||||
state.wallets = [{ name: "Wallet 1", type: "hd", addresses: [] }];
|
||||
state.currentView = "settings";
|
||||
state.viewStack = ["main"];
|
||||
return { helpers, state, showPhrase };
|
||||
}
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/461: leaving drops the
|
||||
// wallet selection, so Back onto this screen showed a password prompt
|
||||
// that could only answer "No wallet is selected." Taking the screen off
|
||||
// the stack leaves Settings under Settings, and Back must not land there
|
||||
// either (https://git.eeqj.de/sneak/AutistMask/issues/481).
|
||||
test("goes to the screen under Settings", () => {
|
||||
const { helpers, state, showPhrase } = load();
|
||||
|
||||
// Opened from the wallet list in Settings, then left by the gear:
|
||||
// push the current view, then show Settings.
|
||||
showPhrase.show(0);
|
||||
helpers.pushCurrentView();
|
||||
helpers.showView("settings");
|
||||
|
||||
expect(state.viewStack).toEqual(["main", "settings"]);
|
||||
helpers.goBack();
|
||||
expect(state.currentView).toBe("main");
|
||||
});
|
||||
|
||||
// Each round trip leaves one more Settings under Settings.
|
||||
test("goes to the screen under Settings after two round trips", () => {
|
||||
const { helpers, state, showPhrase } = load();
|
||||
for (let i = 0; i < 2; i++) {
|
||||
showPhrase.show(0);
|
||||
helpers.pushCurrentView();
|
||||
helpers.showView("settings");
|
||||
}
|
||||
|
||||
expect(state.viewStack).toEqual(["main", "settings", "settings"]);
|
||||
helpers.goBack();
|
||||
expect(state.currentView).toBe("main");
|
||||
});
|
||||
|
||||
// This Back takes Settings off the stack before the screen is left, so
|
||||
// the stack's top is then the entry Back from Settings will need.
|
||||
test("its own Back button leaves the rest of the stack alone", () => {
|
||||
const { state, showPhrase } = load();
|
||||
showPhrase.show(0);
|
||||
|
||||
globalThis.document.getElementById("btn-show-phrase-back").onClick();
|
||||
|
||||
expect(state.currentView).toBe("settings");
|
||||
expect(state.viewStack).toEqual(["main"]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("the phrase cannot reach the logger", () => {
|
||||
const source = fs.readFileSync(
|
||||
path.join(__dirname, "..", "src", "popup", "views", "showPhrase.js"),
|
||||
|
||||
@@ -238,6 +238,10 @@ async function settle() {
|
||||
* @param {object} [options]
|
||||
* @param {object} [options.storage] a storage stub from makeStorageStub(), for
|
||||
* a test that needs to make writes fail or to watch the round trips.
|
||||
* @param {string} [options.search] the page URL's query string, such as
|
||||
* "?approval=" and an id for the popup opened as an approval window.
|
||||
* @param {object} [options.runtime] members of chrome.runtime that replace the
|
||||
* stub's own, for a test that has to answer the background's messages.
|
||||
* @returns {Promise<object>} handles onto the booted page.
|
||||
*/
|
||||
async function bootPopup(stored, options) {
|
||||
@@ -281,12 +285,13 @@ async function bootPopup(stored, options) {
|
||||
sendMessage: jest.fn(async () => ({})),
|
||||
getURL: (p) => "chrome-extension://autistmask/" + p,
|
||||
onMessage: { addListener: () => {} },
|
||||
...(options && options.runtime),
|
||||
},
|
||||
};
|
||||
globalThis.document = document;
|
||||
globalThis.window = {
|
||||
location: {
|
||||
search: "",
|
||||
search: (options && options.search) || "",
|
||||
href: "chrome-extension://autistmask/src/popup/index.html",
|
||||
reload: () => reloads.push(Date.now()),
|
||||
},
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
// The decoded details on the transaction detail screen of a token transfer
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/515).
|
||||
//
|
||||
// A history row for a token transfer holds the transfer's recipient as its
|
||||
// `to`, not the contract the transaction was sent to. The screen used to decode
|
||||
// the transaction's data against that `to`, so its Token line named the
|
||||
// recipient, and the amount read "decimals unknown" for a token the wallet
|
||||
// tracks. It decodes against the address the explorer reports the transaction
|
||||
// was sent to.
|
||||
//
|
||||
// The row is the one the real history parser makes from the explorer's answer,
|
||||
// opened through transactionDetail.show(), which is what a click on the row
|
||||
// calls. Driven against a minimal DOM stub in the shape
|
||||
// tests/contractCreation.test.js uses.
|
||||
|
||||
const { Interface } = require("ethers");
|
||||
|
||||
jest.mock("../src/shared/log", () => ({
|
||||
log: {
|
||||
debugf: () => {},
|
||||
infof: () => {},
|
||||
warnf: () => {},
|
||||
errorf: () => {},
|
||||
},
|
||||
debugFetch: async (url) => ({
|
||||
ok: true,
|
||||
json: async () => mockExplorerAnswer(url),
|
||||
}),
|
||||
setRuntimeDebug: () => {},
|
||||
isDebug: () => false,
|
||||
}));
|
||||
|
||||
globalThis.chrome = {
|
||||
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||
};
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const { fetchRecentTransactions } = require("../src/shared/transactions");
|
||||
const transactionDetail = require("../src/popup/views/transactionDetail");
|
||||
|
||||
const EXPLORER = "https://explorer.example/api/v2";
|
||||
const HOLDER = "0x0000000000000000000000000000000000000a11";
|
||||
const RECIPIENT = "0x711e691962E5c054b78071C789A0C8CE657377aD";
|
||||
// A token the wallet tracks and the bundled token list does not name.
|
||||
const TOKEN = "0x74de5d4FCbf63E00296fd95d33236B9794016631";
|
||||
const TX_HASH =
|
||||
"0x85215772ed26ea8b39c2b3b18779030487efbe0b5fd7e882592b2f62b837be84";
|
||||
|
||||
// HOLDER sends 1234.5 of the 6-decimal token to RECIPIENT.
|
||||
const TRANSFER_DATA = new Interface([
|
||||
"function transfer(address to, uint256 amount)",
|
||||
]).encodeFunctionData("transfer", [RECIPIENT, 1234500000n]);
|
||||
|
||||
// The explorer's answers: the transfer in HOLDER's token transfers, and the
|
||||
// transaction itself, sent to the token contract.
|
||||
function mockExplorerAnswer(url) {
|
||||
if (
|
||||
url ===
|
||||
EXPLORER + "/addresses/" + HOLDER + "/token-transfers?type=ERC-20"
|
||||
) {
|
||||
return {
|
||||
items: [
|
||||
{
|
||||
transaction_hash: TX_HASH,
|
||||
block_number: 100,
|
||||
timestamp: "2026-10-01T00:00:00Z",
|
||||
from: { hash: HOLDER },
|
||||
to: { hash: RECIPIENT },
|
||||
total: { value: "1234500000", decimals: "6" },
|
||||
token: {
|
||||
address_hash: TOKEN,
|
||||
symbol: "TDOL",
|
||||
holders_count: "5000",
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
if (url === EXPLORER + "/transactions/" + TX_HASH) {
|
||||
return { to: { hash: TOKEN }, raw_input: TRANSFER_DATA };
|
||||
}
|
||||
return { items: [] };
|
||||
}
|
||||
|
||||
function makeElement(id) {
|
||||
const classes = new Set();
|
||||
const el = {
|
||||
id,
|
||||
textContent: "",
|
||||
value: "",
|
||||
innerHTML: "",
|
||||
style: {},
|
||||
dataset: {},
|
||||
classList: {
|
||||
add: (...names) => names.forEach((n) => classes.add(n)),
|
||||
remove: (...names) => names.forEach((n) => classes.delete(n)),
|
||||
contains: (n) => classes.has(n),
|
||||
toggle: () => false,
|
||||
},
|
||||
addEventListener: () => {},
|
||||
querySelectorAll: () => [],
|
||||
appendChild: () => {},
|
||||
};
|
||||
// Views reach for .parentElement to hide whole sections.
|
||||
Object.defineProperty(el, "parentElement", {
|
||||
get: () => node(id + "-parent"),
|
||||
});
|
||||
return el;
|
||||
}
|
||||
|
||||
function makeDocument() {
|
||||
const els = new Map();
|
||||
return {
|
||||
getElementById(id) {
|
||||
// The debug banner is created on demand by helpers.js; absent
|
||||
// is the state a non-debug, non-testnet popup is in.
|
||||
if (id === "debug-banner") return null;
|
||||
if (!els.has(id)) els.set(id, makeElement(id));
|
||||
return els.get(id);
|
||||
},
|
||||
createElement: () => makeElement("created"),
|
||||
body: { prepend: () => {} },
|
||||
};
|
||||
}
|
||||
|
||||
function node(id) {
|
||||
return globalThis.document.getElementById(id);
|
||||
}
|
||||
|
||||
// One line of the decoded details: its label and what is drawn under it.
|
||||
function decodedLine(label) {
|
||||
return node("tx-detail-calldata-details")
|
||||
.innerHTML.split('<div class="mb-2">')
|
||||
.find((line) =>
|
||||
line.startsWith(`<div class="text-muted">${label}</div>`),
|
||||
);
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
globalThis.document = makeDocument();
|
||||
globalThis.window = { location: { search: "" } };
|
||||
state.blockscoutUrl = EXPLORER;
|
||||
state.wallets = [
|
||||
{
|
||||
name: "Main",
|
||||
type: "key",
|
||||
addresses: [{ address: HOLDER, balance: "0.0000" }],
|
||||
},
|
||||
];
|
||||
state.trackedTokens = [{ address: TOKEN, symbol: "TDOL", decimals: 6 }];
|
||||
state.viewData = {};
|
||||
state.viewStack = [];
|
||||
state.currentView = null;
|
||||
});
|
||||
|
||||
test("a token transfer's decoded details name the token contract and the amount at its scale", async () => {
|
||||
const [row] = await fetchRecentTransactions(HOLDER, EXPLORER, 1);
|
||||
expect(row.to).toBe(RECIPIENT);
|
||||
expect(row.contractAddress).toBe(TOKEN.toLowerCase());
|
||||
|
||||
transactionDetail.show(row);
|
||||
// The decoded details are drawn once the explorer has answered.
|
||||
for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
|
||||
|
||||
expect(node("tx-detail-calldata-action").textContent).toBe(
|
||||
"Token Transfer",
|
||||
);
|
||||
const token = decodedLine("Token");
|
||||
expect(token).toContain('<div class="font-bold">TDOL</div>');
|
||||
expect(token).toContain(TOKEN);
|
||||
expect(token).not.toContain(RECIPIENT);
|
||||
expect(decodedLine("Recipient")).toContain(RECIPIENT);
|
||||
expect(decodedLine("Amount")).toContain(
|
||||
'<div class="font-bold">1234.5000 TDOL</div>',
|
||||
);
|
||||
});
|
||||
@@ -233,6 +233,26 @@ function warningOf(data) {
|
||||
return html.slice(0, html.indexOf(">Domain<"));
|
||||
}
|
||||
|
||||
const NOT_SIGNED = ">Not part of the signature<";
|
||||
|
||||
// The Message section alone, without the keys listed after it as not part of
|
||||
// the signature.
|
||||
function messageOf(data) {
|
||||
const html = formatTypedDataHtml(JSON.stringify(data));
|
||||
const end = html.indexOf(NOT_SIGNED);
|
||||
return html.slice(
|
||||
html.indexOf(">Message<"),
|
||||
end === -1 ? html.length : end,
|
||||
);
|
||||
}
|
||||
|
||||
// The keys listed as not part of the signature, or "" when there are none.
|
||||
function notSignedOf(data) {
|
||||
const html = formatTypedDataHtml(JSON.stringify(data));
|
||||
const start = html.indexOf(NOT_SIGNED);
|
||||
return start === -1 ? "" : html.slice(start);
|
||||
}
|
||||
|
||||
function request(data) {
|
||||
return { method: "eth_signTypedData_v4", typedData: JSON.stringify(data) };
|
||||
}
|
||||
@@ -240,6 +260,7 @@ function request(data) {
|
||||
beforeEach(() => {
|
||||
state.trackedTokens = [];
|
||||
state.wallets = [];
|
||||
state.networkId = "mainnet";
|
||||
});
|
||||
|
||||
describe("a token permission is warned about, naming spender and amount", () => {
|
||||
@@ -311,7 +332,8 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
});
|
||||
|
||||
// A Permit whose type names its spender `operator`; the page adds a
|
||||
// `spender` key the type does not declare.
|
||||
// `spender` key the type does not declare. The Message section names
|
||||
// only the operator, and the added key is listed apart as not signed.
|
||||
test("an added key is not named as the spender", () => {
|
||||
const data = {
|
||||
...PERMIT,
|
||||
@@ -330,6 +352,10 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
const warning = warningOf(data);
|
||||
expect(warning).toContain(WARNING);
|
||||
expect(warning).not.toContain(DECOY);
|
||||
expect(messageOf(data)).toContain(SPENDER);
|
||||
expect(messageOf(data)).not.toContain(DECOY);
|
||||
expect(notSignedOf(data)).toContain("spender:");
|
||||
expect(notSignedOf(data)).toContain(DECOY);
|
||||
});
|
||||
|
||||
// The permit for a Uniswap v3 position NFT: a `Permit` with no amount
|
||||
@@ -370,6 +396,47 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// ethers signs only the declared fields at every level of nesting, so an
|
||||
// added key inside a struct is not signed either. Such typed data is not
|
||||
// refused; the added key is listed apart, with where it sits in the message.
|
||||
describe("the Message section shows only the fields that are signed", () => {
|
||||
const NOTE = "This signature only signs you in";
|
||||
|
||||
test("an added key inside a nested struct is listed as not signed", () => {
|
||||
const data = {
|
||||
...PERMIT_SINGLE,
|
||||
message: {
|
||||
...PERMIT_SINGLE.message,
|
||||
details: { ...PERMIT_SINGLE.message.details, note: NOTE },
|
||||
},
|
||||
};
|
||||
expect(messageOf(data)).toContain("expiration");
|
||||
expect(messageOf(data)).not.toContain(NOTE);
|
||||
expect(notSignedOf(data)).toContain("details.note:");
|
||||
expect(notSignedOf(data)).toContain(NOTE);
|
||||
expect(typedDataRefusal(request(data))).toBeNull();
|
||||
});
|
||||
|
||||
test("an added key inside a list item is listed with its index", () => {
|
||||
const [first, second] = PERMIT_BATCH.message.details;
|
||||
const data = {
|
||||
...PERMIT_BATCH,
|
||||
message: {
|
||||
...PERMIT_BATCH.message,
|
||||
details: [first, { ...second, note: NOTE }],
|
||||
},
|
||||
};
|
||||
expect(messageOf(data)).not.toContain(NOTE);
|
||||
expect(notSignedOf(data)).toContain("details[1].note:");
|
||||
expect(notSignedOf(data)).toContain(NOTE);
|
||||
});
|
||||
|
||||
test("nothing is listed apart when every key is declared", () => {
|
||||
expect(notSignedOf(PERMIT_SINGLE)).toBe("");
|
||||
expect(notSignedOf(LOGIN)).toBe("");
|
||||
});
|
||||
});
|
||||
|
||||
describe("the primary type shown is the one ethers signs", () => {
|
||||
// A drain stated as a sign-in: the page says Login, the types say
|
||||
// PermitSingle, and ethers would sign PermitSingle.
|
||||
@@ -532,3 +599,66 @@ describe("the sign screen refuses a mismatched primary type", () => {
|
||||
expect(node("btn-approve-sign").disabled).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
// EIP-712: a wallet refuses typed data whose domain names a chain other than
|
||||
// the active one, because the signature is valid on the chain it names
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/519). The wallet is on Sepolia
|
||||
// and the site asks for a mainnet USDC Permit.
|
||||
describe("the sign screen refuses typed data for another chain", () => {
|
||||
const REFUSAL =
|
||||
"This typed data is for chain id 1, but the active network is Sepolia Testnet (chain id 11155111), so it cannot be signed.";
|
||||
|
||||
function withChainId(chainId) {
|
||||
return { ...PERMIT, domain: { ...PERMIT.domain, chainId } };
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
decryptWithPassword.mockClear();
|
||||
state.networkId = "sepolia";
|
||||
});
|
||||
|
||||
test("another chain shows the error, with Sign disabled", async () => {
|
||||
await openSignScreen(PERMIT);
|
||||
expect(node("approve-sign-error").textContent).toBe(REFUSAL);
|
||||
expect(node("btn-approve-sign").disabled).toBe(true);
|
||||
});
|
||||
|
||||
test("Sign clicked anyway decrypts and signs nothing", async () => {
|
||||
const sent = await openSignScreen(PERMIT);
|
||||
node("approve-sign-password").value = "any password";
|
||||
await click("btn-approve-sign");
|
||||
|
||||
expect(decryptWithPassword).not.toHaveBeenCalled();
|
||||
expect(sent.map((msg) => msg.type)).not.toContain(
|
||||
"AUTISTMASK_SIGN_RESPONSE",
|
||||
);
|
||||
expect(node("approve-sign-error").textContent).toBe(REFUSAL);
|
||||
});
|
||||
|
||||
// ethers signs 1, "1" and "0x1" as the same chain id.
|
||||
test("the chain id is refused in each form ethers signs", () => {
|
||||
for (const chainId of [1, "1", "0x1"]) {
|
||||
expect(typedDataRefusal(request(withChainId(chainId)))).toBe(
|
||||
REFUSAL,
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("a chain id that is not a number is refused", () => {
|
||||
expect(typedDataRefusal(request(withChainId("mainnet")))).toBe(
|
||||
"This typed data cannot be read, so it cannot be signed.",
|
||||
);
|
||||
});
|
||||
|
||||
test("the active chain leaves Sign enabled", async () => {
|
||||
await openSignScreen(withChainId("0xaa36a7"));
|
||||
expect(node("approve-sign-error").textContent).toBe("");
|
||||
expect(node("btn-approve-sign").disabled).toBe(false);
|
||||
});
|
||||
|
||||
test("no chain id leaves Sign enabled", async () => {
|
||||
await openSignScreen(withChainId(undefined));
|
||||
expect(node("approve-sign-error").textContent).toBe("");
|
||||
expect(node("btn-approve-sign").disabled).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
+49
-5
@@ -416,7 +416,7 @@ describe("extended key depth", () => {
|
||||
expect(() =>
|
||||
wallet.getSignerForAddress(
|
||||
{ type: "xprv" },
|
||||
0,
|
||||
{ address: VECTOR_ADDRESSES[0], index: 0 },
|
||||
accountXprv(VECTOR_PHRASE),
|
||||
),
|
||||
).toThrow(/master/i);
|
||||
@@ -504,7 +504,7 @@ describe("getSignerForAddress", () => {
|
||||
test.each([0, 1, 2])("hd wallet, address index %i", (index) => {
|
||||
const signer = wallet.getSignerForAddress(
|
||||
{ type: "hd" },
|
||||
index,
|
||||
{ address: VECTOR_ADDRESSES[index], index },
|
||||
VECTOR_PHRASE,
|
||||
);
|
||||
|
||||
@@ -515,7 +515,7 @@ describe("getSignerForAddress", () => {
|
||||
test.each([0, 1, 2])("xprv wallet, address index %i", (index) => {
|
||||
const signer = wallet.getSignerForAddress(
|
||||
{ type: "xprv" },
|
||||
index,
|
||||
{ address: VECTOR_ADDRESSES[index], index },
|
||||
masterXprv(VECTOR_PHRASE),
|
||||
);
|
||||
|
||||
@@ -527,7 +527,7 @@ describe("getSignerForAddress", () => {
|
||||
for (const index of [0, 1, 2]) {
|
||||
const signer = wallet.getSignerForAddress(
|
||||
{ type: "privkey" },
|
||||
index,
|
||||
{ address: VECTOR_ADDRESSES[1], index },
|
||||
VECTOR_PRIVATE_KEYS[1],
|
||||
);
|
||||
|
||||
@@ -535,10 +535,54 @@ describe("getSignerForAddress", () => {
|
||||
}
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/510: an address whose stored
|
||||
// index does not derive it, or a private key that is not its key.
|
||||
test.each([
|
||||
["hd", { address: VECTOR_ADDRESSES[2], index: 1 }, VECTOR_PHRASE],
|
||||
[
|
||||
"xprv",
|
||||
{ address: VECTOR_ADDRESSES[2], index: 1 },
|
||||
masterXprv(VECTOR_PHRASE),
|
||||
],
|
||||
["privkey", { address: VECTOR_ADDRESSES[2] }, VECTOR_PRIVATE_KEYS[1]],
|
||||
])(
|
||||
"%s wallet refuses a key that is not the address's own",
|
||||
(type, addr, secret) => {
|
||||
expect(() =>
|
||||
wallet.getSignerForAddress({ type }, addr, secret),
|
||||
).toThrow(
|
||||
"The key this wallet holds for " +
|
||||
VECTOR_ADDRESSES[2] +
|
||||
" belongs to a different address, so it was not used.",
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
// An HD or xprv address record without a usable `index` is refused in a
|
||||
// sentence, not with what ethers says about the value it was handed.
|
||||
test.each([
|
||||
["hd", VECTOR_PHRASE],
|
||||
["xprv", masterXprv(VECTOR_PHRASE)],
|
||||
])("%s wallet refuses an address with no valid index", (type, secret) => {
|
||||
for (const index of [undefined, null, -1, 1.5, "1"]) {
|
||||
expect(() =>
|
||||
wallet.getSignerForAddress(
|
||||
{ type },
|
||||
{ address: VECTOR_ADDRESSES[1], index },
|
||||
secret,
|
||||
),
|
||||
).toThrow(
|
||||
"No derivation index is stored for " +
|
||||
VECTOR_ADDRESSES[1] +
|
||||
", so its key cannot be derived.",
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("the returned signer signs recoverably as the expected address", async () => {
|
||||
const signer = wallet.getSignerForAddress(
|
||||
{ type: "hd" },
|
||||
1,
|
||||
{ address: VECTOR_ADDRESSES[1], index: 1 },
|
||||
VECTOR_PHRASE,
|
||||
);
|
||||
const message = "AutistMask derivation test";
|
||||
|
||||
@@ -55,7 +55,7 @@ function healthyXprvWallet(name = "Master") {
|
||||
xpub,
|
||||
nextIndex: 1,
|
||||
encryptedSecret: "irrelevant-to-these-tests",
|
||||
addresses: [{ address: firstAddress, balance: "0.0000" }],
|
||||
addresses: [{ address: firstAddress, index: 0, balance: "0.0000" }],
|
||||
};
|
||||
}
|
||||
|
||||
@@ -74,7 +74,11 @@ function brokenXprvWallet(name = "Imported xprv") {
|
||||
nextIndex: 1,
|
||||
encryptedSecret: "irrelevant-to-these-tests",
|
||||
addresses: [
|
||||
{ address: node.deriveChild(0).address, balance: "0.0000" },
|
||||
{
|
||||
address: node.deriveChild(0).address,
|
||||
index: 0,
|
||||
balance: "0.0000",
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -153,6 +157,18 @@ describe("the explanatory copy", () => {
|
||||
expect(all).not.toMatch(/\blost\b|\bstolen\b|\bgone\b/i);
|
||||
});
|
||||
|
||||
// The wallet holds the imported key but will not export it, so the copy
|
||||
// must name every key the user may hold that reaches the addresses
|
||||
// outside it.
|
||||
test("it names the keys that reach the addresses outside this wallet", () => {
|
||||
const body = defect.paragraphs.join(" ");
|
||||
|
||||
expect(body).toMatch(/private key export are disabled/);
|
||||
expect(body).toMatch(
|
||||
/with the extended private key you imported, if you kept a copy of it, or with the master extended private key or recovery phrase it came from, in software that repeats the same non-standard derivation/,
|
||||
);
|
||||
});
|
||||
|
||||
test("it says the wallet is not deleted and what the user can do", () => {
|
||||
const body = defect.paragraphs.join(" ");
|
||||
|
||||
@@ -558,7 +574,7 @@ describe("no path throws an unhandled error for a defective wallet", () => {
|
||||
try {
|
||||
wallet.getSignerForAddress(
|
||||
{ type: "xprv" },
|
||||
0,
|
||||
brokenXprvWallet().addresses[0],
|
||||
accountXprv(VECTOR_PHRASE),
|
||||
);
|
||||
} catch (e) {
|
||||
@@ -573,7 +589,7 @@ describe("no path throws an unhandled error for a defective wallet", () => {
|
||||
test("a healthy xprv wallet signs as it always did", () => {
|
||||
const signer = wallet.getSignerForAddress(
|
||||
{ type: "xprv" },
|
||||
0,
|
||||
healthyXprvWallet().addresses[0],
|
||||
masterXprv(VECTOR_PHRASE),
|
||||
);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user