Compare commits
1 Commits
fix/issue-
...
295ceffaa7
| Author | SHA1 | Date | |
|---|---|---|---|
| 295ceffaa7 |
7
Makefile
7
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: bootstrap setup install test test-e2e test-e2e-firefox lint fmt fmt-check check docker hooks build build-debug verify-build clean dev
|
.PHONY: bootstrap setup install test test-e2e lint fmt fmt-check check docker hooks build build-debug verify-build clean dev
|
||||||
|
|
||||||
# Standard targets are thin shims; the implementations live in script/
|
# Standard targets are thin shims; the implementations live in script/
|
||||||
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
# per the scripts-to-rule-them-all pattern (see the Entrypoints section
|
||||||
@@ -16,13 +16,10 @@ install:
|
|||||||
test:
|
test:
|
||||||
@script/test
|
@script/test
|
||||||
|
|
||||||
# Browser end-to-end suites. Both require docker; neither is part of check.
|
# Browser end-to-end suite. Requires docker; not part of check.
|
||||||
test-e2e:
|
test-e2e:
|
||||||
@script/test-e2e
|
@script/test-e2e
|
||||||
|
|
||||||
test-e2e-firefox:
|
|
||||||
@script/test-e2e-firefox
|
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
@script/lint
|
@script/lint
|
||||||
|
|
||||||
|
|||||||
184
README.md
184
README.md
@@ -83,10 +83,7 @@ provide:
|
|||||||
git pre-commit hook
|
git pre-commit hook
|
||||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
- `script/projectname` — print the project name (used for the Docker image tag)
|
||||||
- `script/test` — run the test suite (jest)
|
- `script/test` — run the test suite (jest)
|
||||||
- `script/test-e2e` — run the Chrome browser end-to-end suite (docker required;
|
- `script/test-e2e` — run the browser end-to-end suite (docker required; see
|
||||||
see [End-to-End Tests](#end-to-end-tests))
|
|
||||||
- `script/test-e2e-firefox` — run the Firefox browser end-to-end suite (docker
|
|
||||||
required; builds its own pinned image, see
|
|
||||||
[End-to-End Tests](#end-to-end-tests))
|
[End-to-End Tests](#end-to-end-tests))
|
||||||
- `script/lint` — run the linter
|
- `script/lint` — run the linter
|
||||||
- `script/fmt` — format all files (writes)
|
- `script/fmt` — format all files (writes)
|
||||||
@@ -126,14 +123,6 @@ The Makefile shims to those. It also carries a few targets that have no
|
|||||||
|
|
||||||
## End-to-End Tests
|
## End-to-End Tests
|
||||||
|
|
||||||
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`.
|
|
||||||
|
|
||||||
### Chrome (`make test-e2e`)
|
|
||||||
|
|
||||||
`make test-e2e` builds `dist/chrome/` and drives the **real popup in a real
|
`make test-e2e` builds `dist/chrome/` and drives the **real popup in a real
|
||||||
Chrome**, loaded as an unpacked MV3 extension inside a pinned
|
Chrome**, loaded as an unpacked MV3 extension inside a pinned
|
||||||
`mcr.microsoft.com/playwright` container (pinned by digest in `script/test-e2e`;
|
`mcr.microsoft.com/playwright` container (pinned by digest in `script/test-e2e`;
|
||||||
@@ -157,51 +146,6 @@ fixtures in `tests/e2e/network.js`, so the run is deterministic and fully
|
|||||||
offline; unrecognised outbound requests are reported as failures rather than
|
offline; unrecognised outbound requests are reported as failures rather than
|
||||||
silently allowed.
|
silently allowed.
|
||||||
|
|
||||||
It also covers the confirmation screen, for both a native ETH send and an ERC-20
|
|
||||||
send: Send disabled while the fee estimate is in flight, enabled once it lands,
|
|
||||||
the fee block quoting the expected cost and the reserve separately, the distinct
|
|
||||||
message for an estimate that failed, and the view height staying constant across
|
|
||||||
every one of those transitions. The load-bearing one is that the spend gate uses
|
|
||||||
the **reserve** and not the displayed **estimate** — the two are stubbed far
|
|
||||||
apart on purpose, and the funded and refused sends sit on opposite sides of the
|
|
||||||
reserve while sitting on the same side of the estimate, so swapping the two in
|
|
||||||
`src/popup/views/confirmTx.js` fails the suite instead of passing it. That is
|
|
||||||
what [#154](https://git.eeqj.de/sneak/AutistMask/issues/154) was, and it was
|
|
||||||
previously correct by reading only.
|
|
||||||
|
|
||||||
It also covers the **dApp approval round trips** — the one place where the
|
|
||||||
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, 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).
|
|
||||||
|
|
||||||
Three limits of that coverage, 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. And the EIP-1193 error code does not survive the last hop: the
|
|
||||||
rejection that crosses the boundary carries code 4001 and is asserted to, but
|
|
||||||
`src/content/inpage.js` rebuilds it as `new Error(message)`, so the calling page
|
|
||||||
catches an error with no `code` property.
|
|
||||||
|
|
||||||
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
|
|
||||||
consumes exactly one matching record, and a declaration nothing matched fails
|
|
||||||
its test just as an undeclared error does.
|
|
||||||
|
|
||||||
That reporting has one bound worth knowing. Observation ends when the browser
|
That reporting has one bound worth knowing. Observation ends when the browser
|
||||||
context is torn down, and nothing can watch traffic after that, so the run keeps
|
context is torn down, and nothing can watch traffic after that, so the run keeps
|
||||||
collecting for a fixed grace period after the last test returns
|
collecting for a fixed grace period after the last test returns
|
||||||
@@ -239,110 +183,12 @@ a `ReferenceError` from a used-but-not-imported identifier is invisible to
|
|||||||
`make check` (`script/lint` is only `prettier --check`) but fatal in a browser,
|
`make check` (`script/lint` is only `prettier --check`) but fatal in a browser,
|
||||||
and this suite exists because exactly that class of bug shipped twice.
|
and this suite exists because exactly that class of bug shipped twice.
|
||||||
|
|
||||||
### Firefox (`make test-e2e-firefox`)
|
`make test-e2e` is deliberately **not** part of `make check` or `make test`.
|
||||||
|
`REPO_POLICIES.md` caps `make test` at 20 seconds and a browser suite does not
|
||||||
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
fit; nothing in `tests/e2e/` is named `*.test.js`, so jest cannot pick it up
|
||||||
real Firefox**, installed as an unpacked MV2 temporary add-on via geckodriver.
|
either. It is also not wired into the Gitea workflow yet — docker-in-docker in
|
||||||
It covers popup load, wallet creation through the UI, the Add Token screen, and
|
CI is a separate question. Run it locally before changing anything under
|
||||||
the four dApp round trips — `eth_requestAccounts`, `personal_sign`,
|
`src/popup/views/`.
|
||||||
`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
|
|
||||||
`child_process` against geckodriver's HTTP API. The dApp fixture (`dapp.js`) and
|
|
||||||
the assertions do use `ethers`, and have to — a signature is recovered in the
|
|
||||||
runner rather than believed from the extension, and the stub node has to answer
|
|
||||||
`eth_sendRawTransaction` with the hash `ethers` computes for the artifact it
|
|
||||||
sent, or `provider.broadcastTransaction()` refuses the answer.
|
|
||||||
|
|
||||||
Unlike the Chrome suite it builds its own container image rather than pulling a
|
|
||||||
published one, because no published image carries both a pinned Firefox and a
|
|
||||||
matching geckodriver. `tests/e2e/firefox/Dockerfile` pins all three external
|
|
||||||
artifacts by digest — the `node` base image, the Firefox 153.0.3 tarball, and
|
|
||||||
geckodriver 0.36.0 — and the Firefox version in particular must not float:
|
|
||||||
`-remote-allow-system-access` is **mandatory** on 153 and was not on 142.
|
|
||||||
Without that flag, both navigating to `moz-extension://` and running
|
|
||||||
chrome-context script fail with `unsupported operation`. The flag grants the
|
|
||||||
driver full chrome privileges over that browser, which is acceptable only
|
|
||||||
because it is a throwaway container.
|
|
||||||
|
|
||||||
The popup's `moz-extension://` uuid is **pinned, not discovered**: the profile
|
|
||||||
pref `extensions.webextensions.uuids` maps the extension id that
|
|
||||||
`manifest/firefox.json` already declares to a fixed uuid, so the popup URL is
|
|
||||||
deterministic. Navigation uses **classic** WebDriver `POST /session/{id}/url`,
|
|
||||||
because BiDi's `browsingContext.navigate` refuses `moz-extension://` outright.
|
|
||||||
|
|
||||||
**Any uncaught error from a `moz-extension://` source fails the run**, including
|
|
||||||
errors from the background page, which the suite never navigates to: a `throw`
|
|
||||||
at the top of `src/background/index.js` kills the background page and fails
|
|
||||||
step 1. Content scripts **are** exercised now — the dApp steps drive a page
|
|
||||||
served from loopback, which survives `--network none` — but the _capture_ of a
|
|
||||||
content-script error by this route is still unproven: no probe has forced a
|
|
||||||
throw inside one and watched it fail the run, so it remains an expectation
|
|
||||||
rather than a demonstrated fact. Errors from add-on install and background
|
|
||||||
startup are folded into step 1 rather than discarded.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Two limits are worth knowing, both 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
|
|
||||||
after, not to a moment within it. The window that is drained runs from add-on
|
|
||||||
install to **≈1.5s** after the last step returns — a 500ms settle, a 1000ms
|
|
||||||
tail sleep and two drain round trips — and then the browser is torn down. That
|
|
||||||
cut-off is not a hard boundary: with throws scheduled at fixed offsets, three
|
|
||||||
runs reported everything up to +1.5s and one of the three also reported +1.6s,
|
|
||||||
so an error landing near it may or may not be seen, and anything well past it
|
|
||||||
is not. Inside the window there is no race — each drain reads and clears the
|
|
||||||
console in a single chrome round trip, so an error logged mid-drain lands in
|
|
||||||
that batch or the next rather than being destroyed unread — but there is a
|
|
||||||
**capacity limit**: `nsIConsoleService` keeps a ring buffer of 250 messages
|
|
||||||
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.
|
|
||||||
- **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.
|
|
||||||
|
|
||||||
Neither `make test-e2e` nor `make test-e2e-firefox` is part of `make check` or
|
|
||||||
`make test`. `REPO_POLICIES.md` caps `make test` at 20 seconds and a browser
|
|
||||||
suite does not fit; nothing in `tests/e2e/` is named `*.test.js`, so jest cannot
|
|
||||||
pick it up either. Neither is wired into the Gitea workflow yet —
|
|
||||||
docker-in-docker in CI is a separate question. Run them locally before changing
|
|
||||||
anything under `src/popup/views/`.
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
@@ -1178,12 +1024,7 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- **When**: A connected website requests a transaction via
|
- **When**: A connected website requests a transaction via
|
||||||
`eth_sendTransaction`. Always opened in a separate popup window by the
|
`eth_sendTransaction`. Always opened in a separate popup window by the
|
||||||
background script (`windows.create()`), because the request is triggered
|
background script (`windows.create()`), because the request is triggered
|
||||||
programmatically rather than by a user gesture. The background populates the
|
programmatically rather than by a user gesture.
|
||||||
transaction (nonce, gas limit, fees, chain id) against the RPC node _before_
|
|
||||||
opening the window, so the screen shows a complete transaction and the signed
|
|
||||||
artifact can be compared with it field for field. A request that cannot be
|
|
||||||
populated — unreachable node, reverting gas estimate — opens no window and is
|
|
||||||
failed back to the site.
|
|
||||||
- **Elements**:
|
- **Elements**:
|
||||||
- "Transaction Request" heading
|
- "Transaction Request" heading
|
||||||
- Phishing warning banner (shown when the hostname is on the phishing
|
- Phishing warning banner (shown when the hostname is on the phishing
|
||||||
@@ -1195,16 +1036,13 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- Contract: color dot + full address + etherscan link (or "contract
|
- Contract: color dot + full address + etherscan link (or "contract
|
||||||
creation"), token symbol label if known
|
creation"), token symbol label if known
|
||||||
- Value: amount in ETH (4 decimal places, USD in parentheses)
|
- Value: amount in ETH (4 decimal places, USD in parentheses)
|
||||||
- Network fee (max): gas limit × fee per gas in ETH (4 decimal places, USD
|
|
||||||
in parentheses), with the gas limit and the fee per gas in gwei below it
|
|
||||||
- Network and nonce
|
|
||||||
- Raw data: full calldata displayed inline (shown if present)
|
- Raw data: full calldata displayed inline (shown if present)
|
||||||
- Password input and an error line
|
- Password input and an error line
|
||||||
- "Confirm" / "Reject" buttons
|
- "Confirm" / "Reject" buttons
|
||||||
- **Transitions**:
|
- **Transitions**:
|
||||||
- "Confirm" (correct password) → decrypts and signs the transaction it was
|
- "Confirm" (correct password) → decrypts and signs in the popup, hands the
|
||||||
shown, exactly as shown, hands the signed transaction to the background to
|
signed transaction to the background to broadcast, then → **WaitTx** in
|
||||||
broadcast, then → **WaitTx** in the same popup window
|
the same popup window
|
||||||
- "Confirm" (wrong password) → error line, no screen change
|
- "Confirm" (wrong password) → error line, no screen change
|
||||||
- "Reject" → closes popup (returns rejection to background)
|
- "Reject" → closes popup (returns rejection to background)
|
||||||
- Popup window closed without answering → the request is rejected with
|
- Popup window closed without answering → the request is rejected with
|
||||||
|
|||||||
142
TODO.md
142
TODO.md
@@ -30,10 +30,9 @@ compiled off.
|
|||||||
|
|
||||||
The backlog lives on the
|
The backlog lives on the
|
||||||
[Gitea tracker](https://git.eeqj.de/sneak/AutistMask/issues), which is
|
[Gitea tracker](https://git.eeqj.de/sneak/AutistMask/issues), which is
|
||||||
authoritative; this file does not duplicate it. Full policy file set present.
|
authoritative; this file does not duplicate it. Full policy file set present. A
|
||||||
Real-browser end-to-end suites (`make test-e2e` for Chrome,
|
real-browser end-to-end suite (`make test-e2e`) now sits alongside `make check`,
|
||||||
`make test-e2e-firefox` for Firefox) now sit alongside `make check`, which
|
which cannot see a runtime `ReferenceError` in a popup view.
|
||||||
cannot see a runtime `ReferenceError` in a popup view.
|
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -45,133 +44,6 @@ undefined identifiers, which is how
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-12: One shared extension-API module,
|
|
||||||
[`src/shared/browserApi.js`](src/shared/browserApi.js), is the only place in
|
|
||||||
the tree that names `browser` or `chrome`. Every call site returns a promise;
|
|
||||||
`runtime.lastError` is gone. The same commit gives the Firefox suite the four
|
|
||||||
dApp round trips — `eth_requestAccounts`, `personal_sign`,
|
|
||||||
`eth_sendTransaction` and a closed approval window rejecting with EIP-1193
|
|
||||||
4001 — against a page and a JSON-RPC node served from loopback, which survives
|
|
||||||
`--network none`. **The premise of
|
|
||||||
[#153](https://git.eeqj.de/sneak/AutistMask/issues/153) does not survive that
|
|
||||||
harness**: Firefox's `browser.*` honours a trailing Chrome-style callback and
|
|
||||||
populates `runtime.lastError`, both measured directly on Firefox 153.0.3, and
|
|
||||||
all four flows pass against the unconverted code. What landed is a uniformity
|
|
||||||
and coverage change, not a repair of a broken target.
|
|
||||||
- 2026-08-12: EIP-1193 error codes now reach the page. `src/content/inpage.js`
|
|
||||||
rebuilt every failure as `new Error(error.message)`, so the code the
|
|
||||||
background produced and the content script relayed intact was dropped in the
|
|
||||||
last hop and a dApp checking `err.code === 4001` saw `undefined` — a wallet
|
|
||||||
the user deliberately declined was indistinguishable from one that broke. The
|
|
||||||
provider now rejects with a `ProviderRpcError` carrying `code` and, where the
|
|
||||||
boundary sent one, `data`, passed through verbatim rather than matched against
|
|
||||||
a list, so 4001, 4100 and 4902 all arrive and a future code needs no edit
|
|
||||||
here. An error the background sent with no code stays a plain `Error` with no
|
|
||||||
`code` property, and `message` is unchanged in every case. All four request
|
|
||||||
entry points (`request`, `enable`, `send`, `sendAsync`) are covered by
|
|
||||||
`tests/inpageErrors.test.js`, and the e2e probe that printed the missing code
|
|
||||||
now requires it on the page's Error as well as on the wire, for all four
|
|
||||||
rejected flows ([#274](https://git.eeqj.de/sneak/AutistMask/issues/274)).
|
|
||||||
- 2026-08-12: `KNOWN_SYMBOLS` now maps a symbol to the set of contract addresses
|
|
||||||
that bear it, not to one of them. A ticker is not unique: seven of the 512
|
|
||||||
bundled tokens — `FRAX`, `REUSD`, `TON`, `EURE`, `MSUSD`, `MUSD` and `JPYC` —
|
|
||||||
share a symbol with another bundled entry at a different real contract, and
|
|
||||||
the table, built from the list first-wins, kept only the earlier one. The
|
|
||||||
other seven were judged spoofs of their own symbol at their own address and
|
|
||||||
hidden from the balance list, the history and the send selector, so a holder
|
|
||||||
could not spend them. Both contracts of each pair come from the same CoinGecko
|
|
||||||
fetch of 2026-02-27, so neither was stale and neither was dropped.
|
|
||||||
`isSpoofedSymbol()` asks set membership instead of equality, which does not
|
|
||||||
loosen the rule — a contract outside the set is still a spoof — and a test now
|
|
||||||
walks `TOKENS` asserting no bundled token is filtered at its own address,
|
|
||||||
which is the walk the suite lacked
|
|
||||||
([#276](https://git.eeqj.de/sneak/AutistMask/issues/276)).
|
|
||||||
- 2026-08-12: The dApp approval round trips are driven end to end in the
|
|
||||||
browser. A test page served by the harness speaks EIP-1193 to the real inpage
|
|
||||||
provider through the real content script, background worker and approval popup
|
|
||||||
for `eth_requestAccounts`, `personal_sign`, `eth_signTypedData_v4` and
|
|
||||||
`eth_sendTransaction`. Every signature is recovered and compared against the
|
|
||||||
active address, the transaction is checked against the bytes handed to the
|
|
||||||
stubbed RPC, each rejection must reach the page as a rejection, and the
|
|
||||||
password must appear in no message the approval window sends — the assertion
|
|
||||||
that gives [#157](https://git.eeqj.de/sneak/AutistMask/issues/157) a permanent
|
|
||||||
floor. This does not discharge a real dApp with real funds against mainnet
|
|
||||||
([#183](https://git.eeqj.de/sneak/AutistMask/issues/183)).
|
|
||||||
- 2026-08-12: The known-symbol spoof rule now judges the symbol a user actually
|
|
||||||
sees. `isSpoofedSymbol()` normalizes before the lookup — NFKC, then every
|
|
||||||
character that paints nothing removed (the format and default-ignorable
|
|
||||||
characters, plus U+007F), then trimmed — so `" ETH "`, a no-break space, a
|
|
||||||
zero-width space, a Hangul filler, a variation selector, a DELETE and a
|
|
||||||
fullwidth `ETH` are all caught on the balance list, the history and the
|
|
||||||
send selector at once. Confusables that are distinct letters (Cyrillic `Е`),
|
|
||||||
bidi reordering and the visible C0/C1 controls — which measure 48.00px, a box,
|
|
||||||
in the pinned e2e Chromium where an invisible prefix measures 32.00px — stay
|
|
||||||
knowingly open and are asserted as open in the suite. No bundled symbol
|
|
||||||
contains whitespace or a non-ASCII character, so nothing legitimate is newly
|
|
||||||
filtered; the balance list's token-type gate also became case-insensitive,
|
|
||||||
which no longer drops a real holding if an explorer writes `erc-20`
|
|
||||||
([#260](https://git.eeqj.de/sneak/AutistMask/issues/260)).
|
|
||||||
- 2026-08-12: A containerized Firefox end-to-end harness
|
|
||||||
(`make test-e2e-firefox`) drives the real popup in a real Firefox with the MV2
|
|
||||||
build installed as a temporary add-on. Zero npm dependencies — a WebDriver
|
|
||||||
client over `fetch` against geckodriver — with `node`, Firefox 153.0.3 and
|
|
||||||
geckodriver 0.36.0 all pinned by digest. Uncaught errors are read from the
|
|
||||||
privileged console service in Marionette's chrome context, because BiDi
|
|
||||||
`log.entryAdded` reports nothing at all for extension pages; each drain reads
|
|
||||||
and clears the console in one chrome round trip, so no error is destroyed
|
|
||||||
unread by the drain itself, and errors logged during add-on install and
|
|
||||||
background startup are folded into step 1 instead of being cleared. The two
|
|
||||||
measured limits are documented rather than claimed away: the console ring
|
|
||||||
buffer holds 250 messages (a clean run peaks at 4), and the drained window
|
|
||||||
ends ≈1.5s after the last step returns. Demonstrated discriminating by exiting
|
|
||||||
1 on a `throw` at the top of `src/background/index.js`, on a build with one
|
|
||||||
import removed, on a `setTimeout` throw whose UI assertions all pass, on an
|
|
||||||
unhandled `Promise.reject` and on an undefined identifier in `home.js`, and 0
|
|
||||||
on the branch as it stands
|
|
||||||
([#184](https://git.eeqj.de/sneak/AutistMask/issues/184)).
|
|
||||||
- 2026-08-12: The transaction a dApp asks for is now populated in the background
|
|
||||||
before the approval window opens, so the object the user is shown is the
|
|
||||||
object the signed artifact is verified against — nonce, gas limit and every
|
|
||||||
fee field are compared exactly instead of being left to the ceilings, which
|
|
||||||
stay as a backstop against what a lying RPC node can talk the wallet into
|
|
||||||
displaying. The approval also pins the address it was raised for, so an
|
|
||||||
address switch between approval and signing refuses rather than signing from
|
|
||||||
an account the screen never named, and a request naming an address that is not
|
|
||||||
the active one is refused outright. The approval screen now shows the fee, gas
|
|
||||||
limit, network and nonce it vouches for
|
|
||||||
([#216](https://git.eeqj.de/sneak/AutistMask/issues/216)).
|
|
||||||
- 2026-08-12: The restored navigation stack is filtered against
|
|
||||||
`RESTORABLE_VIEWS` on load, truncated at the first entry the popup would not
|
|
||||||
render so that every surviving entry keeps the Back target it had. Back after
|
|
||||||
reopening can no longer land on a view the popup declined to restore, such as
|
|
||||||
`export-privkey` or `show-phrase`
|
|
||||||
([#224](https://git.eeqj.de/sneak/AutistMask/issues/224)). Restorable views in
|
|
||||||
the stack are still unhidden without being re-rendered; that is tracked
|
|
||||||
separately in ([#268](https://git.eeqj.de/sneak/AutistMask/issues/268)).
|
|
||||||
- 2026-08-12: One wording for a rejected password on every screen that asks for
|
|
||||||
one — the send confirmation and the delete-wallet confirmation no longer say
|
|
||||||
"Wrong password." (a fragment, which `RULES.md` Language & Labeling forbids)
|
|
||||||
and the two reveal screens no longer say "not correct", so all five
|
|
||||||
`decryptWithPassword` call sites now show the sentence the dApp approval paths
|
|
||||||
introduced. Strings only, no behaviour change, and each error container
|
|
||||||
measured at a 360px viewport in the pinned Playwright container
|
|
||||||
([#172](https://git.eeqj.de/sneak/AutistMask/issues/172)).
|
|
||||||
- 2026-08-12: Closed the empty-array hole in the end-to-end unstubbed-request
|
|
||||||
guard. `batch.every()` is vacuously true on `[]`, so a POST with body `[]` was
|
|
||||||
answered `200 []` instead of failing the suite; the guard now rejects an empty
|
|
||||||
batch, demonstrated green-before/red-after with a throwaway probe. The comment
|
|
||||||
claiming `postData()` returns `null` for undecodable bodies was corrected to
|
|
||||||
the two real paths — an absent or empty body decodes to `null`, a binary body
|
|
||||||
decodes lossily into invalid JSON
|
|
||||||
([#187](https://git.eeqj.de/sneak/AutistMask/issues/187)).
|
|
||||||
- 2026-08-12: The transaction confirmation screen has browser coverage. The
|
|
||||||
end-to-end suite reaches ConfirmTx for both the native ETH and the ERC-20 path
|
|
||||||
off a funded-balance fixture, and asserts the pending, funded, over-balance
|
|
||||||
and estimate-failed states, the fee block quoting the estimate and the reserve
|
|
||||||
separately, and a constant view height across every one of those transitions.
|
|
||||||
The load-bearing assertion is that the spend gate reads the reserve and not
|
|
||||||
the displayed estimate: swapping the two fails the suite
|
|
||||||
([#238](https://git.eeqj.de/sneak/AutistMask/issues/238)).
|
|
||||||
- 2026-08-12: The dust threshold field now explains a rejection instead of
|
- 2026-08-12: The dust threshold field now explains a rejection instead of
|
||||||
snapping back in silence, with the parse in a pure, unit-tested module that
|
snapping back in silence, with the parse in a pure, unit-tested module that
|
||||||
accepts plain decimal digits only — hex and exponent notation are refused
|
accepts plain decimal digits only — hex and exponent notation are refused
|
||||||
@@ -364,9 +236,9 @@ tracker.
|
|||||||
- Pre-1.0 security review of the extension (key handling, DEBUG mode policy, RPC
|
- 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
|
input validation) before any 1.0rc tag. Individual filed issues are parts of
|
||||||
it, but the review is broader than any of them.
|
it, but the review is broader than any of them.
|
||||||
- Decide whether docker-in-docker makes `make test-e2e` and
|
- Decide whether docker-in-docker makes `make test-e2e` runnable in the Gitea
|
||||||
`make test-e2e-firefox` runnable in the Gitea workflow. Extending the Chrome
|
workflow. Extending the suite itself is tracked as
|
||||||
suite itself is tracked as
|
[#183](https://git.eeqj.de/sneak/AutistMask/issues/183) and
|
||||||
[#183](https://git.eeqj.de/sneak/AutistMask/issues/183).
|
[#184](https://git.eeqj.de/sneak/AutistMask/issues/184).
|
||||||
- Cut 1.0.0 once the milestone is empty, then continue tagging as milestones
|
- Cut 1.0.0 once the milestone is empty, then continue tagging as milestones
|
||||||
land.
|
land.
|
||||||
|
|||||||
@@ -311,15 +311,10 @@ pages. When a site requests access to your wallet:
|
|||||||
time.
|
time.
|
||||||
|
|
||||||
When a connected site requests a transaction, a separate approval popup appears
|
When a connected site requests a transaction, a separate approval popup appears
|
||||||
showing the transaction details (from, to, value, data, network fee, network and
|
showing the transaction details (from, to, value, data). You must enter your
|
||||||
nonce). Every one of those values is checked against the transaction that is
|
password and click "Confirm" to authorize it. Message and typed-data signature
|
||||||
actually signed before anything is broadcast, so what you read on that screen is
|
requests work the same way, with a "Sign" button, and also require your
|
||||||
what goes out or nothing does. The popup appears once the wallet has worked out
|
password.
|
||||||
the fee and gas from the network, which takes a moment; if that fails, no popup
|
|
||||||
appears and the site is told the transaction could not be prepared. You must
|
|
||||||
enter your password and click "Confirm" to authorize it. Message and typed-data
|
|
||||||
signature requests work the same way, with a "Sign" button, and also require
|
|
||||||
your password.
|
|
||||||
|
|
||||||
If the requesting site's domain is on the phishing blocklist, all three approval
|
If the requesting site's domain is on the phishing blocklist, all three approval
|
||||||
screens show a red phishing warning before you decide.
|
screens show a red phishing warning before you decide.
|
||||||
|
|||||||
@@ -1,63 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/test-e2e-firefox: build the extension and drive the real popup in
|
|
||||||
# a real Firefox inside a pinned container. The Firefox counterpart to
|
|
||||||
# script/test-e2e. Our own extension to scripts-to-rule-them-all.
|
|
||||||
#
|
|
||||||
# Deliberately NOT called by script/check or script/test, for the same
|
|
||||||
# reason as the Chrome suite: REPO_POLICIES.md caps make test at 20 seconds
|
|
||||||
# and a browser suite does not fit.
|
|
||||||
#
|
|
||||||
# Unlike script/test-e2e this builds its image locally, because no
|
|
||||||
# published image carries both a pinned Firefox and a matching geckodriver.
|
|
||||||
# All three external artifacts are pinned by digest inside the Dockerfile;
|
|
||||||
# see tests/e2e/firefox/Dockerfile.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
IMAGE="$("$SCRIPT_DIR/projectname")-e2e-firefox"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
|
|
||||||
if ! command -v docker >/dev/null 2>&1; then
|
|
||||||
echo "test-e2e-firefox: docker is required to run the e2e suite" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Building extension for e2e..."
|
|
||||||
yarn run build 2>&1
|
|
||||||
|
|
||||||
# The build context is tests/e2e/firefox/ and holds nothing but the
|
|
||||||
# Dockerfile: the harness itself arrives over the bind mount below, so
|
|
||||||
# editing it never invalidates an image layer.
|
|
||||||
echo "Building the pinned Firefox e2e image..."
|
|
||||||
docker build -t "$IMAGE" "$ROOT/tests/e2e/firefox"
|
|
||||||
|
|
||||||
echo "Running the Firefox e2e suite..."
|
|
||||||
# --shm-size=1g: Firefox needs more than the default 64MB /dev/shm.
|
|
||||||
# --network none: the suite stubs nothing, so this is what keeps the
|
|
||||||
# run offline and deterministic. The extension swallows its own
|
|
||||||
# fetch failures, so the popup flows work unchanged; see the
|
|
||||||
# network note in README.md. Weaker than the Chrome suite's
|
|
||||||
# fixture interception, and honestly so — it proves no request
|
|
||||||
# escaped, but it cannot report which ones were attempted.
|
|
||||||
# --user: keep files the suite touches owned by the caller, not root.
|
|
||||||
# HOME=/tmp: the mapped uid has no home directory in the image.
|
|
||||||
#
|
|
||||||
# No --privileged. Firefox's sandbox logs
|
|
||||||
# "CanCreateUserNamespace() clone() failure: EPERM" on startup here;
|
|
||||||
# it is cosmetic and headless Firefox runs fine without it.
|
|
||||||
docker run --rm \
|
|
||||||
--shm-size=1g \
|
|
||||||
--network none \
|
|
||||||
--user "$(id -u):$(id -g)" \
|
|
||||||
-e HOME=/tmp \
|
|
||||||
-v "$ROOT:/work" \
|
|
||||||
-w /work \
|
|
||||||
"$IMAGE" \
|
|
||||||
node tests/e2e/firefox/run.js dist/firefox
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -18,14 +18,11 @@ const {
|
|||||||
verifySignature,
|
verifySignature,
|
||||||
failureIsRetryable,
|
failureIsRetryable,
|
||||||
describeTxFailure,
|
describeTxFailure,
|
||||||
sameAddress,
|
|
||||||
ApprovalMismatchError,
|
|
||||||
TX_STAGE_SIGN,
|
TX_STAGE_SIGN,
|
||||||
TX_STAGE_VERIFY,
|
TX_STAGE_VERIFY,
|
||||||
TX_STAGE_BROADCAST,
|
TX_STAGE_BROADCAST,
|
||||||
TX_STAGE_INFLIGHT,
|
TX_STAGE_INFLIGHT,
|
||||||
} = require("../shared/approvalVerify");
|
} = require("../shared/approvalVerify");
|
||||||
const { prepareApprovalTx } = require("../shared/approvalTx");
|
|
||||||
const {
|
const {
|
||||||
isPhishingDomain,
|
isPhishingDomain,
|
||||||
refreshPhishingListOnSchedule,
|
refreshPhishingListOnSchedule,
|
||||||
@@ -39,21 +36,17 @@ const {
|
|||||||
registerAlarmHandlers,
|
registerAlarmHandlers,
|
||||||
} = require("../shared/alarms");
|
} = require("../shared/alarms");
|
||||||
|
|
||||||
const {
|
const storageApi =
|
||||||
actionApi,
|
typeof browser !== "undefined"
|
||||||
runtimeApi,
|
? browser.storage.local
|
||||||
storageGet,
|
: chrome.storage.local;
|
||||||
tabsQuery,
|
const runtime =
|
||||||
tabsSendMessage,
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
windowsApi,
|
const windowsApi =
|
||||||
windowsCreate,
|
typeof browser !== "undefined" ? browser.windows : chrome.windows;
|
||||||
windowsGetLastFocused,
|
const tabsApi = typeof browser !== "undefined" ? browser.tabs : chrome.tabs;
|
||||||
windowsRemove,
|
const actionApi =
|
||||||
} = require("../shared/browserApi");
|
typeof browser !== "undefined" ? browser.browserAction : chrome.action;
|
||||||
|
|
||||||
const runtime = runtimeApi();
|
|
||||||
const windowsNs = windowsApi();
|
|
||||||
const actionNs = actionApi();
|
|
||||||
|
|
||||||
// Connected sites (in-memory, non-persisted): { "origin:address": true }
|
// Connected sites (in-memory, non-persisted): { "origin:address": true }
|
||||||
const connectedSites = {};
|
const connectedSites = {};
|
||||||
@@ -62,7 +55,7 @@ const connectedSites = {};
|
|||||||
const pendingApprovals = {};
|
const pendingApprovals = {};
|
||||||
|
|
||||||
async function getState() {
|
async function getState() {
|
||||||
const result = await storageGet("autistmask");
|
const result = await storageApi.get("autistmask");
|
||||||
return (
|
return (
|
||||||
result.autistmask || {
|
result.autistmask || {
|
||||||
wallets: [],
|
wallets: [],
|
||||||
@@ -84,14 +77,6 @@ async function getActiveAddress() {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Whether a request names a signing address other than the active one. Such a
|
|
||||||
// request is refused rather than quietly signed as whichever address happens
|
|
||||||
// to be active: the page asked for account A and would otherwise be handed
|
|
||||||
// something from account B.
|
|
||||||
function namesAnotherAddress(requested, activeAddress) {
|
|
||||||
return !!requested && !sameAddress(requested, activeAddress);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getRpcUrl() {
|
async function getRpcUrl() {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
return s.rpcUrl || DEFAULT_RPC_URL;
|
return s.rpcUrl || DEFAULT_RPC_URL;
|
||||||
@@ -126,8 +111,8 @@ async function proxyRpc(method, params) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function resetPopupUrl() {
|
function resetPopupUrl() {
|
||||||
if (actionNs && typeof actionNs.setPopup === "function") {
|
if (actionApi && typeof actionApi.setPopup === "function") {
|
||||||
actionNs.setPopup({ popup: "src/popup/index.html" });
|
actionApi.setPopup({ popup: "src/popup/index.html" });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -183,55 +168,32 @@ function releaseApproval(approval) {
|
|||||||
// Open approval in a separate popup window.
|
// Open approval in a separate popup window.
|
||||||
// This is the primary mechanism for tx/sign approvals (triggered programmatically,
|
// This is the primary mechanism for tx/sign approvals (triggered programmatically,
|
||||||
// not from a user gesture) and the fallback for site-connection approvals.
|
// not from a user gesture) and the fallback for site-connection approvals.
|
||||||
// Never rejects. Its callers raise it from inside a Promise executor and drop
|
function openApprovalWindow(id) {
|
||||||
// the result on the floor, so a rejection here would be unhandled.
|
|
||||||
async function openApprovalWindow(id) {
|
|
||||||
const popupUrl = runtime.getURL("src/popup/index.html?approval=" + id);
|
const popupUrl = runtime.getURL("src/popup/index.html?approval=" + id);
|
||||||
const popupWidth = 360;
|
const popupWidth = 360;
|
||||||
const popupHeight = 600;
|
const popupHeight = 600;
|
||||||
|
|
||||||
let currentWin = null;
|
windowsApi.getLastFocused((currentWin) => {
|
||||||
try {
|
const opts = {
|
||||||
currentWin = await windowsGetLastFocused();
|
url: popupUrl,
|
||||||
} catch {
|
type: "popup",
|
||||||
// Nothing focused to centre on. The window still opens, at whatever
|
width: popupWidth,
|
||||||
// position the browser picks.
|
height: popupHeight,
|
||||||
}
|
};
|
||||||
|
if (currentWin) {
|
||||||
const opts = {
|
opts.left = Math.round(
|
||||||
url: popupUrl,
|
currentWin.left + (currentWin.width - popupWidth) / 2,
|
||||||
type: "popup",
|
);
|
||||||
width: popupWidth,
|
opts.top = Math.round(
|
||||||
height: popupHeight,
|
currentWin.top + (currentWin.height - popupHeight) / 2,
|
||||||
};
|
);
|
||||||
if (currentWin) {
|
}
|
||||||
opts.left = Math.round(
|
windowsApi.create(opts, (win) => {
|
||||||
currentWin.left + (currentWin.width - popupWidth) / 2,
|
if (win) {
|
||||||
);
|
pendingApprovals[id].windowId = win.id;
|
||||||
opts.top = Math.round(
|
}
|
||||||
currentWin.top + (currentWin.height - popupHeight) / 2,
|
});
|
||||||
);
|
});
|
||||||
}
|
|
||||||
|
|
||||||
let win = null;
|
|
||||||
try {
|
|
||||||
win = await windowsCreate(opts);
|
|
||||||
} catch (e) {
|
|
||||||
// No window means no approval screen and no way for the user to
|
|
||||||
// answer. The request stays pending rather than being settled behind
|
|
||||||
// their back; say so rather than failing silently.
|
|
||||||
log.errorf("could not open the approval window:", e);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The id the onRemoved listener matches on to turn a closed window into a
|
|
||||||
// rejection. Guarded because the create() above is a real await now: an
|
|
||||||
// address switch can settle and remove the approval while the window is
|
|
||||||
// opening, and writing the id back would resurrect a bare entry that
|
|
||||||
// nothing would ever resolve.
|
|
||||||
if (win && pendingApprovals[id]) {
|
|
||||||
pendingApprovals[id].windowId = win.id;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Open an approval popup and return a promise that resolves with the user decision.
|
// Open an approval popup and return a promise that resolves with the user decision.
|
||||||
@@ -241,12 +203,12 @@ function requestApproval(origin, hostname) {
|
|||||||
const id = crypto.randomUUID();
|
const id = crypto.randomUUID();
|
||||||
pendingApprovals[id] = { origin, hostname, resolve };
|
pendingApprovals[id] = { origin, hostname, resolve };
|
||||||
|
|
||||||
if (actionNs && typeof actionNs.openPopup === "function") {
|
if (actionApi && typeof actionApi.openPopup === "function") {
|
||||||
actionNs.setPopup({
|
actionApi.setPopup({
|
||||||
popup: "src/popup/index.html?approval=" + id,
|
popup: "src/popup/index.html?approval=" + id,
|
||||||
});
|
});
|
||||||
try {
|
try {
|
||||||
const result = actionNs.openPopup();
|
const result = actionApi.openPopup();
|
||||||
if (result && typeof result.catch === "function") {
|
if (result && typeof result.catch === "function") {
|
||||||
result.catch(() => openApprovalWindow(id));
|
result.catch(() => openApprovalWindow(id));
|
||||||
}
|
}
|
||||||
@@ -263,21 +225,13 @@ function requestApproval(origin, hostname) {
|
|||||||
// Uses windows.create() directly because tx approvals are triggered programmatically
|
// Uses windows.create() directly because tx approvals are triggered programmatically
|
||||||
// (from a dApp RPC call), not from a user gesture, so action.openPopup() is
|
// (from a dApp RPC call), not from a user gesture, so action.openPopup() is
|
||||||
// unreliable in this context.
|
// unreliable in this context.
|
||||||
//
|
function requestTxApproval(origin, hostname, txParams) {
|
||||||
// `approvedTx` is the fully populated transaction (see approvalTx.js): the
|
|
||||||
// object the popup displays, the object it signs, and the object the artifact
|
|
||||||
// is verified against. `approvedFrom` is the address that is active now, and
|
|
||||||
// it is pinned here rather than read again at signing time — an address switch
|
|
||||||
// between approval and signing must refuse, not sign from an account this
|
|
||||||
// screen never named.
|
|
||||||
function requestTxApproval(origin, hostname, approvedTx, approvedFrom) {
|
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
const id = crypto.randomUUID();
|
const id = crypto.randomUUID();
|
||||||
pendingApprovals[id] = {
|
pendingApprovals[id] = {
|
||||||
origin,
|
origin,
|
||||||
hostname,
|
hostname,
|
||||||
approvedTx,
|
txParams,
|
||||||
approvedFrom,
|
|
||||||
resolve,
|
resolve,
|
||||||
type: "tx",
|
type: "tx",
|
||||||
};
|
};
|
||||||
@@ -290,14 +244,13 @@ function requestTxApproval(origin, hostname, approvedTx, approvedFrom) {
|
|||||||
// Uses windows.create() directly because sign approvals are triggered programmatically
|
// Uses windows.create() directly because sign approvals are triggered programmatically
|
||||||
// (from a dApp RPC call), not from a user gesture, so action.openPopup() is
|
// (from a dApp RPC call), not from a user gesture, so action.openPopup() is
|
||||||
// unreliable in this context.
|
// unreliable in this context.
|
||||||
function requestSignApproval(origin, hostname, signParams, approvedFrom) {
|
function requestSignApproval(origin, hostname, signParams) {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
const id = crypto.randomUUID();
|
const id = crypto.randomUUID();
|
||||||
pendingApprovals[id] = {
|
pendingApprovals[id] = {
|
||||||
origin,
|
origin,
|
||||||
hostname,
|
hostname,
|
||||||
signParams,
|
signParams,
|
||||||
approvedFrom,
|
|
||||||
resolve,
|
resolve,
|
||||||
type: "sign",
|
type: "sign",
|
||||||
};
|
};
|
||||||
@@ -308,7 +261,7 @@ function requestSignApproval(origin, hostname, signParams, approvedFrom) {
|
|||||||
|
|
||||||
// Detect when an approval popup (browser-action) closes without a response.
|
// Detect when an approval popup (browser-action) closes without a response.
|
||||||
// TX and sign approvals now use windows.create() and are handled by the
|
// TX and sign approvals now use windows.create() and are handled by the
|
||||||
// windows.onRemoved listener below, but we still handle site-connection
|
// windowsApi.onRemoved listener below, but we still handle site-connection
|
||||||
// approval disconnects here.
|
// approval disconnects here.
|
||||||
runtime.onConnect.addListener((port) => {
|
runtime.onConnect.addListener((port) => {
|
||||||
if (port.name.startsWith("approval:")) {
|
if (port.name.startsWith("approval:")) {
|
||||||
@@ -549,16 +502,6 @@ async function handleRpc(method, params, origin) {
|
|||||||
? { method, message: params[0], from: params[1] }
|
? { method, message: params[0], from: params[1] }
|
||||||
: { method, message: params[1], from: params[0] };
|
: { method, message: params[1], from: params[0] };
|
||||||
|
|
||||||
if (namesAnotherAddress(signParams.from, activeAddress)) {
|
|
||||||
return {
|
|
||||||
error: {
|
|
||||||
code: 4100,
|
|
||||||
message:
|
|
||||||
"This site asked to sign as an address that is not the active one.",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
if (method === "eth_sign") {
|
if (method === "eth_sign") {
|
||||||
signParams.dangerWarning =
|
signParams.dangerWarning =
|
||||||
"\u26a0\ufe0f DANGER: This site is requesting to sign a raw hash. " +
|
"\u26a0\ufe0f DANGER: This site is requesting to sign a raw hash. " +
|
||||||
@@ -570,7 +513,6 @@ async function handleRpc(method, params, origin) {
|
|||||||
origin,
|
origin,
|
||||||
hostname,
|
hostname,
|
||||||
signParams,
|
signParams,
|
||||||
activeAddress,
|
|
||||||
);
|
);
|
||||||
if (decision.error) return { error: decision.error };
|
if (decision.error) return { error: decision.error };
|
||||||
return { result: decision.signature };
|
return { result: decision.signature };
|
||||||
@@ -592,20 +534,10 @@ async function handleRpc(method, params, origin) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const signParams = { method, typedData: params[1], from: params[0] };
|
const signParams = { method, typedData: params[1], from: params[0] };
|
||||||
if (namesAnotherAddress(signParams.from, activeAddress)) {
|
|
||||||
return {
|
|
||||||
error: {
|
|
||||||
code: 4100,
|
|
||||||
message:
|
|
||||||
"This site asked to sign as an address that is not the active one.",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
const decision = await requestSignApproval(
|
const decision = await requestSignApproval(
|
||||||
origin,
|
origin,
|
||||||
hostname,
|
hostname,
|
||||||
signParams,
|
signParams,
|
||||||
activeAddress,
|
|
||||||
);
|
);
|
||||||
if (decision.error) return { error: decision.error };
|
if (decision.error) return { error: decision.error };
|
||||||
return { result: decision.signature };
|
return { result: decision.signature };
|
||||||
@@ -627,51 +559,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const txParams = params?.[0] || {};
|
const txParams = params?.[0] || {};
|
||||||
if (namesAnotherAddress(txParams.from, activeAddress)) {
|
const decision = await requestTxApproval(origin, hostname, txParams);
|
||||||
return {
|
|
||||||
error: {
|
|
||||||
code: 4100,
|
|
||||||
message:
|
|
||||||
"This site asked to send from an address that is not the active one.",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// Populate here, before any window opens, so that the transaction the
|
|
||||||
// user is shown is a complete one and is the same object the signed
|
|
||||||
// artifact is checked against. A failure raises no approval at all and
|
|
||||||
// is reported to the requesting page; see approvalTx.js.
|
|
||||||
let approvedTx;
|
|
||||||
try {
|
|
||||||
approvedTx = await prepareApprovalTx(
|
|
||||||
getProvider(await getRpcUrl()),
|
|
||||||
activeAddress,
|
|
||||||
txParams,
|
|
||||||
);
|
|
||||||
} catch (e) {
|
|
||||||
return { error: { message: e.message } };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Population is a network round trip, and the user can switch address
|
|
||||||
// during it. Raising the approval anyway would put an account on the
|
|
||||||
// screen that the wallet is no longer on, and it could never be signed
|
|
||||||
// — the signing handler refuses exactly that. Refuse it here instead,
|
|
||||||
// while the page is still waiting and nothing has been displayed.
|
|
||||||
if (!sameAddress(await getActiveAddress(), activeAddress)) {
|
|
||||||
return {
|
|
||||||
error: {
|
|
||||||
message:
|
|
||||||
"The active address changed while this transaction was being prepared, so it was not sent.",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const decision = await requestTxApproval(
|
|
||||||
origin,
|
|
||||||
hostname,
|
|
||||||
approvedTx,
|
|
||||||
activeAddress,
|
|
||||||
);
|
|
||||||
if (decision.error) return { error: decision.error };
|
if (decision.error) return { error: decision.error };
|
||||||
return { result: decision.txHash };
|
return { result: decision.txHash };
|
||||||
}
|
}
|
||||||
@@ -690,26 +578,24 @@ async function handleRpc(method, params, origin) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Broadcast chainChanged to all tabs when the network is switched.
|
// Broadcast chainChanged to all tabs when the network is switched.
|
||||||
//
|
function broadcastChainChanged(chainId) {
|
||||||
// Never rejects: its caller is an RPC handler that must answer the page
|
tabsApi.query({}, (tabs) => {
|
||||||
// whatever the browser made of the broadcast.
|
for (const tab of tabs) {
|
||||||
async function broadcastChainChanged(chainId) {
|
tabsApi.sendMessage(
|
||||||
let tabs;
|
tab.id,
|
||||||
try {
|
{
|
||||||
tabs = await tabsQuery({});
|
type: "AUTISTMASK_EVENT",
|
||||||
} catch {
|
eventName: "chainChanged",
|
||||||
return;
|
data: chainId,
|
||||||
}
|
},
|
||||||
for (const tab of tabs) {
|
() => {
|
||||||
// A tab with no content script has no receiver, and that is the
|
if (runtime.lastError) {
|
||||||
// ordinary case rather than a fault. The rejection it produces is the
|
// expected for tabs without our content script
|
||||||
// promise-shaped form of the runtime.lastError this used to read.
|
}
|
||||||
tabsSendMessage(tab.id, {
|
},
|
||||||
type: "AUTISTMASK_EVENT",
|
);
|
||||||
eventName: "chainChanged",
|
}
|
||||||
data: chainId,
|
});
|
||||||
}).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Broadcast accountsChanged to all tabs, respecting per-address permissions
|
// Broadcast accountsChanged to all tabs, respecting per-address permissions
|
||||||
@@ -734,36 +620,41 @@ async function broadcastAccountsChanged() {
|
|||||||
: { approved: false, remember: false };
|
: { approved: false, remember: false };
|
||||||
if (!settleApproval(id, rejection)) continue;
|
if (!settleApproval(id, rejection)) continue;
|
||||||
if (approval.windowId) {
|
if (approval.windowId) {
|
||||||
// Rejects when the window has already gone, which is a race the
|
windowsApi.remove(approval.windowId, () => {
|
||||||
// user wins routinely by closing it themselves.
|
if (runtime.lastError) {
|
||||||
windowsRemove(approval.windowId).catch(() => {});
|
// window already closed
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
resetPopupUrl();
|
resetPopupUrl();
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = await getActiveAddress();
|
||||||
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
||||||
let tabs;
|
tabsApi.query({}, (tabs) => {
|
||||||
try {
|
for (const tab of tabs) {
|
||||||
tabs = await tabsQuery({});
|
const origin = tab.url ? new URL(tab.url).origin : "";
|
||||||
} catch {
|
const hostname = extractHostname(origin);
|
||||||
return;
|
const hasPermission =
|
||||||
}
|
activeAddress &&
|
||||||
for (const tab of tabs) {
|
(allowed.includes(hostname) ||
|
||||||
const origin = tab.url ? new URL(tab.url).origin : "";
|
connectedSites[origin + ":" + activeAddress]);
|
||||||
const hostname = extractHostname(origin);
|
tabsApi.sendMessage(
|
||||||
const hasPermission =
|
tab.id,
|
||||||
activeAddress &&
|
{
|
||||||
(allowed.includes(hostname) ||
|
type: "AUTISTMASK_EVENT",
|
||||||
connectedSites[origin + ":" + activeAddress]);
|
eventName: "accountsChanged",
|
||||||
// Same as chainChanged above: a tab without our content script
|
data: hasPermission ? [activeAddress] : [],
|
||||||
// rejects, and that is expected rather than a fault.
|
},
|
||||||
tabsSendMessage(tab.id, {
|
() => {
|
||||||
type: "AUTISTMASK_EVENT",
|
// Ignore errors for tabs without content script
|
||||||
eventName: "accountsChanged",
|
if (runtime.lastError) {
|
||||||
data: hasPermission ? [activeAddress] : [],
|
// expected for tabs without our content script
|
||||||
}).catch(() => {});
|
}
|
||||||
}
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Background balance refresh: every 60 seconds when the popup isn't open.
|
// Background balance refresh: every 60 seconds when the popup isn't open.
|
||||||
@@ -856,8 +747,8 @@ startBackgroundJobs();
|
|||||||
// window is an ordinary event with an attempt already in flight behind it.
|
// window is an ordinary event with an attempt already in flight behind it.
|
||||||
// settleApproval() refuses those, which leaves the attempt to report its real
|
// settleApproval() refuses those, which leaves the attempt to report its real
|
||||||
// outcome to the page.
|
// outcome to the page.
|
||||||
if (windowsNs && windowsNs.onRemoved) {
|
if (windowsApi && windowsApi.onRemoved) {
|
||||||
windowsNs.onRemoved.addListener((windowId) => {
|
windowsApi.onRemoved.addListener((windowId) => {
|
||||||
for (const [id, approval] of Object.entries(pendingApprovals)) {
|
for (const [id, approval] of Object.entries(pendingApprovals)) {
|
||||||
if (approval.windowId !== windowId) continue;
|
if (approval.windowId !== windowId) continue;
|
||||||
const rejection =
|
const rejection =
|
||||||
@@ -919,16 +810,11 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
};
|
};
|
||||||
if (approval.type === "tx") {
|
if (approval.type === "tx") {
|
||||||
resp.type = "tx";
|
resp.type = "tx";
|
||||||
// The populated transaction, and the address it was raised
|
resp.txParams = approval.txParams;
|
||||||
// for. The popup displays and signs exactly this and does not
|
|
||||||
// populate or re-read anything itself.
|
|
||||||
resp.approvedTx = approval.approvedTx;
|
|
||||||
resp.approvedFrom = approval.approvedFrom;
|
|
||||||
}
|
}
|
||||||
if (approval.type === "sign") {
|
if (approval.type === "sign") {
|
||||||
resp.type = "sign";
|
resp.type = "sign";
|
||||||
resp.signParams = approval.signParams;
|
resp.signParams = approval.signParams;
|
||||||
resp.approvedFrom = approval.approvedFrom;
|
|
||||||
}
|
}
|
||||||
// Flag if the requesting domain is on the phishing blocklist.
|
// Flag if the requesting domain is on the phishing blocklist.
|
||||||
resp.isPhishingDomain = isPhishingDomain(approval.hostname);
|
resp.isPhishingDomain = isPhishingDomain(approval.hostname);
|
||||||
@@ -1002,27 +888,14 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
try {
|
try {
|
||||||
await loadState();
|
await loadState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = await getActiveAddress();
|
||||||
// An address switch between approval and signing refuses. The
|
|
||||||
// approval named one account; signing from whichever account
|
|
||||||
// is active now would send funds from an account this screen
|
|
||||||
// never showed. A switch normally rejects every pending
|
|
||||||
// approval on its way through broadcastAccountsChanged(), so
|
|
||||||
// this is the case where that did not reach the approval —
|
|
||||||
// and it is a refusal, not a retry, because the transaction
|
|
||||||
// the user saw is no longer the transaction that would go out.
|
|
||||||
if (!sameAddress(activeAddress, approval.approvedFrom)) {
|
|
||||||
throw new ApprovalMismatchError(
|
|
||||||
"The active address changed after this transaction was approved, so it was not sent.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// The popup holds the secret, but the background stays the
|
// The popup holds the secret, but the background stays the
|
||||||
// authority on what is broadcast: the raw transaction must be
|
// authority on what is broadcast: the raw transaction must be
|
||||||
// the transaction that was displayed, signed by the address
|
// the approved one, signed by the approved address, on the
|
||||||
// the approval named, on the network that is selected.
|
// network that is selected.
|
||||||
verifySignedTx(
|
verifySignedTx(
|
||||||
msg.rawSignedTx,
|
msg.rawSignedTx,
|
||||||
approval.approvedTx,
|
approval.txParams,
|
||||||
approval.approvedFrom,
|
activeAddress,
|
||||||
currentNetwork().chainId,
|
currentNetwork().chainId,
|
||||||
);
|
);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
@@ -1059,10 +932,10 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
sendResponse({ txHash: tx.hash });
|
sendResponse({ txHash: tx.hash });
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
// Terminal, never retried: the node may have accepted the
|
// Terminal, never retried: the node may have accepted the
|
||||||
// transaction and still failed to answer, so the wallet cannot
|
// transaction and still failed to answer, and the popup's
|
||||||
// tell a transaction that never left from one already in the
|
// retry re-signs at a freshly fetched nonce rather than
|
||||||
// mempool. The page has been given its outcome for this
|
// re-broadcasting these bytes. Retrying would send the
|
||||||
// request; a second attempt would report a second one.
|
// approved transfer a second time.
|
||||||
const outcome = describeTxFailure(TX_STAGE_BROADCAST, e);
|
const outcome = describeTxFailure(TX_STAGE_BROADCAST, e);
|
||||||
settleApproval(
|
settleApproval(
|
||||||
msg.id,
|
msg.id,
|
||||||
@@ -1125,24 +998,12 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
(async () => {
|
(async () => {
|
||||||
try {
|
try {
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = await getActiveAddress();
|
||||||
// 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.
|
|
||||||
if (!sameAddress(activeAddress, approval.approvedFrom)) {
|
|
||||||
throw new ApprovalMismatchError(
|
|
||||||
"The active address changed after this request was approved, so it was not signed.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// The popup holds the secret, but the background stays the
|
// The popup holds the secret, but the background stays the
|
||||||
// authority on what is handed back to the page: the signature
|
// authority on what is handed back to the page: the signature
|
||||||
// must cover the approved payload and recover to the address
|
// must cover the approved payload and recover to the approved
|
||||||
// the approval named.
|
// address.
|
||||||
const signature = msg.signature;
|
const signature = msg.signature;
|
||||||
verifySignature(
|
verifySignature(approval.signParams, signature, activeAddress);
|
||||||
approval.signParams,
|
|
||||||
signature,
|
|
||||||
approval.approvedFrom,
|
|
||||||
);
|
|
||||||
settleApproval(msg.id, { signature }, { holdsClaim: true });
|
settleApproval(msg.id, { signature }, { holdsClaim: true });
|
||||||
sendResponse({ signature });
|
sendResponse({ signature });
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
|||||||
@@ -1,20 +1,12 @@
|
|||||||
// AutistMask content script — bridges between inpage (window.ethereum)
|
// AutistMask content script — bridges between inpage (window.ethereum)
|
||||||
// and the background service worker via extension messaging.
|
// and the background service worker via extension messaging.
|
||||||
|
|
||||||
const {
|
|
||||||
hasBrowserNamespace,
|
|
||||||
runtimeApi,
|
|
||||||
sendMessage,
|
|
||||||
storageGet,
|
|
||||||
storageSet,
|
|
||||||
} = require("../shared/browserApi");
|
|
||||||
|
|
||||||
// In Chrome (MV3), inpage.js runs as a MAIN-world content script declared
|
// In Chrome (MV3), inpage.js runs as a MAIN-world content script declared
|
||||||
// in the manifest, so no injection is needed here. In Firefox (MV2), the
|
// in the manifest, so no injection is needed here. In Firefox (MV2), the
|
||||||
// "world" key is not supported, so we inject via a <script> tag.
|
// "world" key is not supported, so we inject via a <script> tag.
|
||||||
if (hasBrowserNamespace()) {
|
if (typeof browser !== "undefined") {
|
||||||
const script = document.createElement("script");
|
const script = document.createElement("script");
|
||||||
script.src = runtimeApi().getURL("src/content/inpage.js");
|
script.src = browser.runtime.getURL("src/content/inpage.js");
|
||||||
script.onload = function () {
|
script.onload = function () {
|
||||||
this.remove();
|
this.remove();
|
||||||
};
|
};
|
||||||
@@ -22,27 +14,23 @@ if (hasBrowserNamespace()) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Send the persisted EIP-6963 provider UUID to the inpage script.
|
// Send the persisted EIP-6963 provider UUID to the inpage script.
|
||||||
// Generated once at install time and stored in extension storage.
|
// Generated once at install time and stored in chrome.storage.local.
|
||||||
(async function sendProviderUuid() {
|
(function sendProviderUuid() {
|
||||||
let uuid = null;
|
const storage =
|
||||||
try {
|
typeof browser !== "undefined"
|
||||||
const items = await storageGet("eip6963Uuid");
|
? browser.storage.local
|
||||||
uuid = items?.eip6963Uuid;
|
: chrome.storage.local;
|
||||||
|
storage.get("eip6963Uuid", (items) => {
|
||||||
|
let uuid = items?.eip6963Uuid;
|
||||||
if (!uuid) {
|
if (!uuid) {
|
||||||
uuid = crypto.randomUUID();
|
uuid = crypto.randomUUID();
|
||||||
await storageSet({ eip6963Uuid: uuid });
|
storage.set({ eip6963Uuid: uuid });
|
||||||
}
|
}
|
||||||
} catch {
|
window.postMessage(
|
||||||
// Storage was unavailable or refused the write. The announcement
|
{ type: "AUTISTMASK_PROVIDER_UUID", uuid },
|
||||||
// still has to go out — a provider that never announces is invisible
|
location.origin,
|
||||||
// to every EIP-6963 dApp — so it goes under a fresh uuid that this
|
);
|
||||||
// page load will not outlive.
|
});
|
||||||
if (!uuid) uuid = crypto.randomUUID();
|
|
||||||
}
|
|
||||||
window.postMessage(
|
|
||||||
{ type: "AUTISTMASK_PROVIDER_UUID", uuid },
|
|
||||||
location.origin,
|
|
||||||
);
|
|
||||||
})();
|
})();
|
||||||
|
|
||||||
// Relay requests from the page to the background script
|
// Relay requests from the page to the background script
|
||||||
@@ -51,31 +39,27 @@ window.addEventListener("message", (event) => {
|
|||||||
if (event.data?.type !== "AUTISTMASK_REQUEST") return;
|
if (event.data?.type !== "AUTISTMASK_REQUEST") return;
|
||||||
const { id, method, params } = event.data;
|
const { id, method, params } = event.data;
|
||||||
|
|
||||||
sendMessage({
|
const runtime =
|
||||||
type: "AUTISTMASK_RPC",
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
id,
|
|
||||||
method,
|
runtime.sendMessage(
|
||||||
params,
|
{ type: "AUTISTMASK_RPC", id, method, params, origin: location.origin },
|
||||||
origin: location.origin,
|
(response) => {
|
||||||
})
|
|
||||||
.then((response) => {
|
|
||||||
if (response) {
|
if (response) {
|
||||||
window.postMessage(
|
window.postMessage(
|
||||||
{ type: "AUTISTMASK_RESPONSE", id, ...response },
|
{ type: "AUTISTMASK_RESPONSE", id, ...response },
|
||||||
"*",
|
"*",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
})
|
},
|
||||||
.catch(() => {
|
);
|
||||||
// No receiver: the background context is gone. The page's promise
|
|
||||||
// stays pending, which is what it did before this was a promise
|
|
||||||
// at all; turning it into a rejection here is a change to what
|
|
||||||
// dApps see and belongs to its own issue.
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Listen for events pushed from the background (e.g. accountsChanged)
|
// Listen for events pushed from the background (e.g. accountsChanged)
|
||||||
runtimeApi().onMessage.addListener((msg) => {
|
const runtime =
|
||||||
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
|
|
||||||
|
runtime.onMessage.addListener((msg) => {
|
||||||
if (msg.type === "AUTISTMASK_EVENT") {
|
if (msg.type === "AUTISTMASK_EVENT") {
|
||||||
window.postMessage(
|
window.postMessage(
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -11,39 +11,6 @@
|
|||||||
let nextId = 1;
|
let nextId = 1;
|
||||||
const pending = {};
|
const pending = {};
|
||||||
|
|
||||||
// EIP-1193 ProviderRpcError: `code`, `message`, optional `data`. A class
|
|
||||||
// rather than properties bolted onto an Error because this object crosses
|
|
||||||
// no boundary after construction — it is built in the page's own realm and
|
|
||||||
// handed straight to the caller's catch — so the prototype survives and
|
|
||||||
// `error.name` is a stable thing for a dApp to see.
|
|
||||||
class ProviderRpcError extends Error {
|
|
||||||
constructor(code, message, data) {
|
|
||||||
super(message);
|
|
||||||
this.name = "ProviderRpcError";
|
|
||||||
this.code = code;
|
|
||||||
if (data !== undefined) this.data = data;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rebuild a boundary error as the error the page catches, carrying the
|
|
||||||
// code (and data) the extension reported. Without this a dApp cannot tell
|
|
||||||
// a user's refusal (4001) from a wallet that broke, and retries or shows
|
|
||||||
// an error instead of accepting the refusal.
|
|
||||||
//
|
|
||||||
// Whatever code arrived is passed through verbatim rather than being
|
|
||||||
// matched against a list: the extension emits 4001, 4100 and 4902 today,
|
|
||||||
// and a code this file has never heard of is still the truth about what
|
|
||||||
// happened. An error reported with no code at all stays a plain Error —
|
|
||||||
// a ProviderRpcError whose `code` is undefined would advertise a
|
|
||||||
// conformance it does not have. `message` is untouched in every case.
|
|
||||||
function toPageError(error) {
|
|
||||||
const message = (error && error.message) || "Request failed";
|
|
||||||
if (error && error.code !== undefined && error.code !== null) {
|
|
||||||
return new ProviderRpcError(error.code, message, error.data);
|
|
||||||
}
|
|
||||||
return new Error(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Listen for responses from the content script
|
// Listen for responses from the content script
|
||||||
window.addEventListener("message", function onUuid(event) {
|
window.addEventListener("message", function onUuid(event) {
|
||||||
if (event.source !== window) return;
|
if (event.source !== window) return;
|
||||||
@@ -53,7 +20,7 @@
|
|||||||
if (!p) return;
|
if (!p) return;
|
||||||
delete pending[id];
|
delete pending[id];
|
||||||
if (error) {
|
if (error) {
|
||||||
p.reject(toPageError(error));
|
p.reject(new Error(error.message || "Request failed"));
|
||||||
} else {
|
} else {
|
||||||
p.resolve(result);
|
p.resolve(result);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1496,33 +1496,6 @@
|
|||||||
<div class="text-xs text-muted mb-1">Value</div>
|
<div class="text-xs text-muted mb-1">Value</div>
|
||||||
<div id="approve-tx-value" class="text-xs font-bold"></div>
|
<div id="approve-tx-value" class="text-xs font-bold"></div>
|
||||||
</div>
|
</div>
|
||||||
<div class="mb-3">
|
|
||||||
<div class="text-xs text-muted mb-1">Network fee (max)</div>
|
|
||||||
<div
|
|
||||||
id="approve-tx-fee"
|
|
||||||
class="text-xs font-bold min-h-[1rem]"
|
|
||||||
></div>
|
|
||||||
<div
|
|
||||||
id="approve-tx-fee-detail"
|
|
||||||
class="text-xs text-muted min-h-[1rem]"
|
|
||||||
></div>
|
|
||||||
</div>
|
|
||||||
<div class="mb-3 flex justify-between">
|
|
||||||
<div>
|
|
||||||
<div class="text-xs text-muted mb-1">Network</div>
|
|
||||||
<div
|
|
||||||
id="approve-tx-network"
|
|
||||||
class="text-xs min-h-[1rem]"
|
|
||||||
></div>
|
|
||||||
</div>
|
|
||||||
<div>
|
|
||||||
<div class="text-xs text-muted mb-1">Nonce</div>
|
|
||||||
<div
|
|
||||||
id="approve-tx-nonce"
|
|
||||||
class="text-xs min-h-[1rem]"
|
|
||||||
></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div id="approve-tx-data-section" class="mb-3 hidden">
|
<div id="approve-tx-data-section" class="mb-3 hidden">
|
||||||
<div class="text-xs text-muted mb-1">Raw data</div>
|
<div class="text-xs text-muted mb-1">Raw data</div>
|
||||||
<div id="approve-tx-data" class="text-xs break-all"></div>
|
<div id="approve-tx-data" class="text-xs break-all"></div>
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ const {
|
|||||||
onViewLeave,
|
onViewLeave,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
const { state, saveState, currentNetwork } = require("../../shared/state");
|
const { state, saveState, currentNetwork } = require("../../shared/state");
|
||||||
const { networkByChainId } = require("../../shared/networks");
|
|
||||||
const {
|
const {
|
||||||
formatEther,
|
formatEther,
|
||||||
formatUnits,
|
formatUnits,
|
||||||
@@ -24,10 +23,12 @@ const { TOKEN_BY_ADDRESS } = require("../../shared/tokenList");
|
|||||||
const { decryptWithPassword } = require("../../shared/vault");
|
const { decryptWithPassword } = require("../../shared/vault");
|
||||||
const { getSignerForAddress } = require("../../shared/wallet");
|
const { getSignerForAddress } = require("../../shared/wallet");
|
||||||
const { walletDefect } = require("../../shared/walletDefects");
|
const { walletDefect } = require("../../shared/walletDefects");
|
||||||
|
const { getProvider } = require("../../shared/balances");
|
||||||
const { describeSigningFailure } = require("../../shared/approvalVerify");
|
const { describeSigningFailure } = require("../../shared/approvalVerify");
|
||||||
const txStatus = require("./txStatus");
|
const txStatus = require("./txStatus");
|
||||||
const uniswap = require("../../shared/uniswap");
|
const uniswap = require("../../shared/uniswap");
|
||||||
const { notify, runtimeApi, sendMessage } = require("../../shared/browserApi");
|
const runtime =
|
||||||
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
|
|
||||||
const erc20Iface = new Interface(ERC20_ABI);
|
const erc20Iface = new Interface(ERC20_ABI);
|
||||||
|
|
||||||
@@ -158,61 +159,21 @@ function showPhishingWarning(elementId, isPhishing) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The fields of the approved transaction the value and recipient lines do not
|
|
||||||
// already carry: network, gas limit, fee per gas, the most the fee can come to,
|
|
||||||
// and the nonce. The background compares every one of them against the signed
|
|
||||||
// artifact, so every one of them has to be on the screen — a number that is
|
|
||||||
// verified but never displayed is verified against nothing the user agreed to.
|
|
||||||
function showTxFee(approvedTx, ethPrice) {
|
|
||||||
const network = networkByChainId(approvedTx.chainId);
|
|
||||||
$("approve-tx-network").textContent = network
|
|
||||||
? network.name
|
|
||||||
: "Unknown network (chain id " + BigInt(approvedTx.chainId) + ")";
|
|
||||||
|
|
||||||
const gasLimit = BigInt(approvedTx.gasLimit);
|
|
||||||
const feePerGas = BigInt(approvedTx.maxFeePerGas || approvedTx.gasPrice);
|
|
||||||
const maxFeeEth = formatTxValue(formatEther(gasLimit * feePerGas));
|
|
||||||
const usdStr = formatUsd(
|
|
||||||
ethPrice ? parseFloat(maxFeeEth) * ethPrice : null,
|
|
||||||
);
|
|
||||||
$("approve-tx-fee").textContent =
|
|
||||||
maxFeeEth + " ETH" + (usdStr ? " (" + usdStr + ")" : "");
|
|
||||||
|
|
||||||
let detail =
|
|
||||||
gasLimit.toString() +
|
|
||||||
" gas at up to " +
|
|
||||||
formatUnits(feePerGas, 9) +
|
|
||||||
" gwei";
|
|
||||||
if (approvedTx.maxPriorityFeePerGas) {
|
|
||||||
detail +=
|
|
||||||
", " +
|
|
||||||
formatUnits(approvedTx.maxPriorityFeePerGas, 9) +
|
|
||||||
" gwei priority";
|
|
||||||
}
|
|
||||||
$("approve-tx-fee-detail").textContent = detail;
|
|
||||||
$("approve-tx-nonce").textContent = BigInt(approvedTx.nonce).toString();
|
|
||||||
}
|
|
||||||
|
|
||||||
function showTxApproval(details) {
|
function showTxApproval(details) {
|
||||||
showPhishingWarning(
|
showPhishingWarning(
|
||||||
"approve-tx-phishing-warning",
|
"approve-tx-phishing-warning",
|
||||||
details.isPhishingDomain,
|
details.isPhishingDomain,
|
||||||
);
|
);
|
||||||
|
|
||||||
// The transaction the background populated. It is displayed as it stands,
|
pendingTxParams = details.txParams;
|
||||||
// signed as it stands, and verified against as it stands — the popup fills
|
|
||||||
// nothing in, so there is no number on this screen that the background
|
|
||||||
// cannot compare with the artifact it gets back.
|
|
||||||
pendingTxParams = details.approvedTx;
|
|
||||||
const approvedTx = details.approvedTx;
|
|
||||||
|
|
||||||
const toAddr = approvedTx.to;
|
const toAddr = details.txParams.to;
|
||||||
const token = toAddr ? TOKEN_BY_ADDRESS.get(toAddr.toLowerCase()) : null;
|
const token = toAddr ? TOKEN_BY_ADDRESS.get(toAddr.toLowerCase()) : null;
|
||||||
const ethValue = formatEther(approvedTx.value || "0");
|
const ethValue = formatEther(details.txParams.value || "0");
|
||||||
|
|
||||||
// Build txInfo for status screens
|
// Build txInfo for status screens
|
||||||
pendingTxDetails = {
|
pendingTxDetails = {
|
||||||
from: details.approvedFrom,
|
from: state.activeAddress,
|
||||||
to: toAddr || "",
|
to: toAddr || "",
|
||||||
amount: formatTxValue(ethValue),
|
amount: formatTxValue(ethValue),
|
||||||
token: "ETH",
|
token: "ETH",
|
||||||
@@ -220,7 +181,7 @@ function showTxApproval(details) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// If this is an ERC-20 call, try to extract the real recipient and amount
|
// If this is an ERC-20 call, try to extract the real recipient and amount
|
||||||
const decoded = decodeCalldata(approvedTx.data, toAddr || "");
|
const decoded = decodeCalldata(details.txParams.data, toAddr || "");
|
||||||
if (decoded && decoded.details) {
|
if (decoded && decoded.details) {
|
||||||
let decodedTokenAddr = null;
|
let decodedTokenAddr = null;
|
||||||
let decodedTokenSymbol = null;
|
let decodedTokenSymbol = null;
|
||||||
@@ -258,7 +219,7 @@ function showTxApproval(details) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
$("approve-tx-hostname").textContent = details.hostname;
|
$("approve-tx-hostname").textContent = details.hostname;
|
||||||
$("approve-tx-from").innerHTML = approvalAddressHtml(details.approvedFrom);
|
$("approve-tx-from").innerHTML = approvalAddressHtml(state.activeAddress);
|
||||||
|
|
||||||
// Show token symbol next to contract address if known
|
// Show token symbol next to contract address if known
|
||||||
const symbol = toAddr ? tokenLabel(toAddr) : null;
|
const symbol = toAddr ? tokenLabel(toAddr) : null;
|
||||||
@@ -274,7 +235,7 @@ function showTxApproval(details) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const ethValueFormatted = formatTxValue(
|
const ethValueFormatted = formatTxValue(
|
||||||
formatEther(approvedTx.value || "0"),
|
formatEther(details.txParams.value || "0"),
|
||||||
);
|
);
|
||||||
const ethPrice = getPrice("ETH");
|
const ethPrice = getPrice("ETH");
|
||||||
const ethUsd = ethPrice ? parseFloat(ethValueFormatted) * ethPrice : null;
|
const ethUsd = ethPrice ? parseFloat(ethValueFormatted) * ethPrice : null;
|
||||||
@@ -282,8 +243,6 @@ function showTxApproval(details) {
|
|||||||
$("approve-tx-value").textContent =
|
$("approve-tx-value").textContent =
|
||||||
ethValueFormatted + " ETH" + (usdStr ? " (" + usdStr + ")" : "");
|
ethValueFormatted + " ETH" + (usdStr ? " (" + usdStr + ")" : "");
|
||||||
|
|
||||||
showTxFee(approvedTx, ethPrice);
|
|
||||||
|
|
||||||
// Decode calldata (reuse decoded from above)
|
// Decode calldata (reuse decoded from above)
|
||||||
const decodedEl = $("approve-tx-decoded");
|
const decodedEl = $("approve-tx-decoded");
|
||||||
if (decoded) {
|
if (decoded) {
|
||||||
@@ -312,8 +271,8 @@ function showTxApproval(details) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Always show raw data when present
|
// Always show raw data when present
|
||||||
if (approvedTx.data && approvedTx.data !== "0x") {
|
if (details.txParams.data && details.txParams.data !== "0x") {
|
||||||
$("approve-tx-data").textContent = approvedTx.data;
|
$("approve-tx-data").textContent = details.txParams.data;
|
||||||
$("approve-tx-data-section").classList.remove("hidden");
|
$("approve-tx-data-section").classList.remove("hidden");
|
||||||
} else {
|
} else {
|
||||||
$("approve-tx-data-section").classList.add("hidden");
|
$("approve-tx-data-section").classList.add("hidden");
|
||||||
@@ -324,11 +283,7 @@ function showTxApproval(details) {
|
|||||||
|
|
||||||
showView("approve-tx");
|
showView("approve-tx");
|
||||||
attachCopyHandlers("view-approve-tx");
|
attachCopyHandlers("view-approve-tx");
|
||||||
gateOnWalletDefect(
|
gateOnWalletDefect("approve-tx-error", "btn-approve-tx");
|
||||||
"approve-tx-error",
|
|
||||||
"btn-approve-tx",
|
|
||||||
details.approvedFrom,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function decodeHexMessage(hex) {
|
function decodeHexMessage(hex) {
|
||||||
@@ -387,12 +342,9 @@ function showSignApproval(details) {
|
|||||||
|
|
||||||
const sp = details.signParams;
|
const sp = details.signParams;
|
||||||
pendingSignParams = sp;
|
pendingSignParams = sp;
|
||||||
pendingSignFrom = details.approvedFrom;
|
|
||||||
|
|
||||||
$("approve-sign-hostname").textContent = details.hostname;
|
$("approve-sign-hostname").textContent = details.hostname;
|
||||||
$("approve-sign-from").innerHTML = approvalAddressHtml(
|
$("approve-sign-from").innerHTML = approvalAddressHtml(sp.from);
|
||||||
details.approvedFrom,
|
|
||||||
);
|
|
||||||
|
|
||||||
const isTyped =
|
const isTyped =
|
||||||
sp.method === "eth_signTypedData_v4" ||
|
sp.method === "eth_signTypedData_v4" ||
|
||||||
@@ -431,61 +383,46 @@ function showSignApproval(details) {
|
|||||||
|
|
||||||
showView("approve-sign");
|
showView("approve-sign");
|
||||||
attachCopyHandlers("view-approve-sign");
|
attachCopyHandlers("view-approve-sign");
|
||||||
gateOnWalletDefect(
|
gateOnWalletDefect("approve-sign-error", "btn-approve-sign");
|
||||||
"approve-sign-error",
|
|
||||||
"btn-approve-sign",
|
|
||||||
details.approvedFrom,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Awaited by nobody: the popup entry point calls this and moves on. It
|
function show(id) {
|
||||||
// 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.
|
|
||||||
async function show(id) {
|
|
||||||
approvalId = id;
|
approvalId = id;
|
||||||
runtimeApi().connect({ name: "approval:" + id });
|
runtime.connect({ name: "approval:" + id });
|
||||||
|
runtime.sendMessage({ type: "AUTISTMASK_GET_APPROVAL", id }, (details) => {
|
||||||
let details = null;
|
if (!details) {
|
||||||
try {
|
window.close();
|
||||||
details = await sendMessage({ type: "AUTISTMASK_GET_APPROVAL", id });
|
return;
|
||||||
} catch {
|
}
|
||||||
details = null;
|
if (details.type === "tx") {
|
||||||
}
|
showTxApproval(details);
|
||||||
|
return;
|
||||||
if (!details) {
|
}
|
||||||
window.close();
|
if (details.type === "sign") {
|
||||||
return;
|
showSignApproval(details);
|
||||||
}
|
return;
|
||||||
if (details.type === "tx") {
|
}
|
||||||
showTxApproval(details);
|
// Site connection approval
|
||||||
return;
|
showPhishingWarning(
|
||||||
}
|
"approve-site-phishing-warning",
|
||||||
if (details.type === "sign") {
|
details.isPhishingDomain,
|
||||||
showSignApproval(details);
|
);
|
||||||
return;
|
$("approve-hostname").textContent = details.hostname;
|
||||||
}
|
$("approve-address").innerHTML = approvalAddressHtml(
|
||||||
// Site connection approval
|
state.activeAddress,
|
||||||
showPhishingWarning(
|
);
|
||||||
"approve-site-phishing-warning",
|
attachCopyHandlers("view-approve-site");
|
||||||
details.isPhishingDomain,
|
$("approve-remember").checked = state.rememberSiteChoice;
|
||||||
);
|
});
|
||||||
$("approve-hostname").textContent = details.hostname;
|
|
||||||
$("approve-address").innerHTML = approvalAddressHtml(state.activeAddress);
|
|
||||||
attachCopyHandlers("view-approve-site");
|
|
||||||
$("approve-remember").checked = state.rememberSiteChoice;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let approvalId = null;
|
let approvalId = null;
|
||||||
let pendingTxDetails = null;
|
let pendingTxDetails = null;
|
||||||
// The exact objects shown to the user, kept so the popup signs what it
|
// The exact parameters shown to the user, kept so the popup signs what it
|
||||||
// displayed rather than re-fetching or re-populating anything at approval
|
// displayed rather than re-fetching anything at approval time. Both are
|
||||||
// time. All are repopulated by show() when the popup is closed and reopened.
|
// repopulated by show() when the popup is closed and reopened.
|
||||||
let pendingTxParams = null;
|
let pendingTxParams = null;
|
||||||
let pendingSignParams = null;
|
let pendingSignParams = null;
|
||||||
// The address the approval was raised for. Signing uses this rather than the
|
|
||||||
// active address, so that an address switch since the approval fails here
|
|
||||||
// instead of producing a signature from an account the screen never named.
|
|
||||||
let pendingSignFrom = null;
|
|
||||||
|
|
||||||
// Approve buttons stay disabled and muted while the popup derives the key and
|
// Approve buttons stay disabled and muted while the popup derives the key and
|
||||||
// signs, which is slow enough (Argon2id) that a double click is likely.
|
// signs, which is slow enough (Argon2id) that a double click is likely.
|
||||||
@@ -500,13 +437,12 @@ function setSignButtonBusy(busy) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Say so on the approval screen itself, and disable the approve button, when
|
// Say so on the approval screen itself, and disable the approve button, when
|
||||||
// the address the approval was raised for belongs to a wallet whose keys
|
// the active address belongs to a wallet whose keys cannot be derived. Without
|
||||||
// cannot be derived. Without this the screen would take a password and fail
|
// this the screen would take a password and fail after deriving it. Reject
|
||||||
// after deriving it. Reject stays available; the wallet is not touched.
|
// stays available; the wallet is not touched. Returns true when it gated.
|
||||||
// Returns true when it gated.
|
function gateOnWalletDefect(errorId, buttonId) {
|
||||||
function gateOnWalletDefect(errorId, buttonId, address) {
|
const active = findActiveWallet();
|
||||||
const owner = findWalletFor(address);
|
const defect = active ? walletDefect(active.wallet) : null;
|
||||||
const defect = owner ? walletDefect(owner.wallet) : null;
|
|
||||||
if (!defect) return false;
|
if (!defect) return false;
|
||||||
showError(errorId, defect.shortMessage);
|
showError(errorId, defect.shortMessage);
|
||||||
$(buttonId).disabled = true;
|
$(buttonId).disabled = true;
|
||||||
@@ -514,14 +450,12 @@ function gateOnWalletDefect(errorId, buttonId, address) {
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Locate the wallet and the address index owning an address. Returns null when
|
// Locate the wallet and the address index owning the currently active
|
||||||
// no wallet holds it. Approvals look up the address they were raised for, not
|
// address. Returns null when no wallet holds it.
|
||||||
// whichever address is active now: the approval named one account, and signing
|
function findActiveWallet() {
|
||||||
// with another is what verification refuses.
|
|
||||||
function findWalletFor(address) {
|
|
||||||
for (const wallet of state.wallets) {
|
for (const wallet of state.wallets) {
|
||||||
for (let i = 0; i < wallet.addresses.length; i++) {
|
for (let i = 0; i < wallet.addresses.length; i++) {
|
||||||
if (wallet.addresses[i].address === address) {
|
if (wallet.addresses[i].address === state.activeAddress) {
|
||||||
return { wallet, addrIndex: i };
|
return { wallet, addrIndex: i };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -554,7 +488,7 @@ function init(ctx) {
|
|||||||
|
|
||||||
$("btn-approve").addEventListener("click", () => {
|
$("btn-approve").addEventListener("click", () => {
|
||||||
const remember = $("approve-remember").checked;
|
const remember = $("approve-remember").checked;
|
||||||
notify({
|
runtime.sendMessage({
|
||||||
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: true,
|
approved: true,
|
||||||
@@ -565,7 +499,7 @@ function init(ctx) {
|
|||||||
|
|
||||||
$("btn-reject").addEventListener("click", () => {
|
$("btn-reject").addEventListener("click", () => {
|
||||||
const remember = $("approve-remember").checked;
|
const remember = $("approve-remember").checked;
|
||||||
notify({
|
runtime.sendMessage({
|
||||||
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
@@ -583,12 +517,12 @@ function init(ctx) {
|
|||||||
hideError("approve-tx-error");
|
hideError("approve-tx-error");
|
||||||
setTxButtonBusy(true);
|
setTxButtonBusy(true);
|
||||||
|
|
||||||
const active = findWalletFor(pendingTxParams.from);
|
const active = findActiveWallet();
|
||||||
if (!active) {
|
if (!active) {
|
||||||
password = null;
|
password = null;
|
||||||
showError(
|
showError(
|
||||||
"approve-tx-error",
|
"approve-tx-error",
|
||||||
"No wallet was found for the address this transaction was approved for.",
|
"No wallet was found for the active address.",
|
||||||
);
|
);
|
||||||
setTxButtonBusy(false);
|
setTxButtonBusy(false);
|
||||||
return;
|
return;
|
||||||
@@ -635,16 +569,15 @@ function init(ctx) {
|
|||||||
active.addrIndex,
|
active.addrIndex,
|
||||||
decryptedSecret,
|
decryptedSecret,
|
||||||
);
|
);
|
||||||
// Sign the approved transaction exactly as it was displayed. The
|
const provider = getProvider(state.rpcUrl);
|
||||||
// background populated it before this screen was drawn and checks
|
const connected = signer.connect(provider);
|
||||||
// the artifact against it field for field, so there is nothing to
|
// This is the sequence ethers' own sendTransaction() runs
|
||||||
// fill in here and no provider to fill it in from. The copy is
|
// internally, so nonce, gas, fee and chain id population are
|
||||||
// because ethers may strip `from` off what it is handed, and the
|
// identical to when the background did the signing.
|
||||||
// approval has to survive a retry intact; keeping `from` on it
|
const populated =
|
||||||
// makes ethers refuse a key that is not the approved address.
|
await connected.populateTransaction(pendingTxParams);
|
||||||
payload.rawSignedTx = await signer.signTransaction({
|
delete populated.from;
|
||||||
...pendingTxParams,
|
payload.rawSignedTx = await connected.signTransaction(populated);
|
||||||
});
|
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
payload.error =
|
payload.error =
|
||||||
e.shortMessage || e.message || "Transaction signing failed.";
|
e.shortMessage || e.message || "Transaction signing failed.";
|
||||||
@@ -654,37 +587,29 @@ function init(ctx) {
|
|||||||
decryptedSecret = null;
|
decryptedSecret = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
// A send that never reaches the background is reported to the user
|
runtime.sendMessage(payload, (response) => {
|
||||||
// the same way a background that refused it is: describeSigningFailure
|
if (response && response.txHash) {
|
||||||
// turns a null response into the generic message below.
|
txStatus.showWait(pendingTxDetails, response.txHash);
|
||||||
let response = null;
|
return;
|
||||||
try {
|
}
|
||||||
response = await sendMessage(payload);
|
// A retryable failure leaves the approval pending in the
|
||||||
} catch {
|
// background, so stay on this screen with a live button rather
|
||||||
response = null;
|
// than sending the user to a dead end.
|
||||||
}
|
const outcome = describeSigningFailure(
|
||||||
|
response,
|
||||||
if (response && response.txHash) {
|
"The transaction could not be sent.",
|
||||||
txStatus.showWait(pendingTxDetails, response.txHash);
|
);
|
||||||
return;
|
if (outcome.retryable) {
|
||||||
}
|
showError("approve-tx-error", outcome.message);
|
||||||
// A retryable failure leaves the approval pending in the
|
setTxButtonBusy(false);
|
||||||
// background, so stay on this screen with a live button rather
|
} else {
|
||||||
// than sending the user to a dead end.
|
txStatus.showError(pendingTxDetails, null, outcome.message);
|
||||||
const outcome = describeSigningFailure(
|
}
|
||||||
response,
|
});
|
||||||
"The transaction could not be sent.",
|
|
||||||
);
|
|
||||||
if (outcome.retryable) {
|
|
||||||
showError("approve-tx-error", outcome.message);
|
|
||||||
setTxButtonBusy(false);
|
|
||||||
} else {
|
|
||||||
txStatus.showError(pendingTxDetails, null, outcome.message);
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
$("btn-reject-tx").addEventListener("click", () => {
|
$("btn-reject-tx").addEventListener("click", () => {
|
||||||
notify({
|
runtime.sendMessage({
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
@@ -701,12 +626,12 @@ function init(ctx) {
|
|||||||
hideError("approve-sign-error");
|
hideError("approve-sign-error");
|
||||||
setSignButtonBusy(true);
|
setSignButtonBusy(true);
|
||||||
|
|
||||||
const active = findWalletFor(pendingSignFrom);
|
const active = findActiveWallet();
|
||||||
if (!active) {
|
if (!active) {
|
||||||
password = null;
|
password = null;
|
||||||
showError(
|
showError(
|
||||||
"approve-sign-error",
|
"approve-sign-error",
|
||||||
"No wallet was found for the address this request was approved for.",
|
"No wallet was found for the active address.",
|
||||||
);
|
);
|
||||||
setSignButtonBusy(false);
|
setSignButtonBusy(false);
|
||||||
return;
|
return;
|
||||||
@@ -778,31 +703,26 @@ function init(ctx) {
|
|||||||
decryptedSecret = null;
|
decryptedSecret = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
let response = null;
|
runtime.sendMessage(payload, (response) => {
|
||||||
try {
|
if (response && response.signature) {
|
||||||
response = await sendMessage(payload);
|
window.close();
|
||||||
} catch {
|
return;
|
||||||
response = null;
|
}
|
||||||
}
|
// The button comes back only when the approval is still pending in
|
||||||
|
// the background; otherwise it stays disabled and the message says
|
||||||
if (response && response.signature) {
|
// why, because a control that cannot succeed must not look like it
|
||||||
window.close();
|
// can.
|
||||||
return;
|
const outcome = describeSigningFailure(
|
||||||
}
|
response,
|
||||||
// The button comes back only when the approval is still pending in
|
"The message could not be signed.",
|
||||||
// the background; otherwise it stays disabled and the message says
|
);
|
||||||
// why, because a control that cannot succeed must not look like it
|
showError("approve-sign-error", outcome.message);
|
||||||
// can.
|
if (outcome.retryable) setSignButtonBusy(false);
|
||||||
const outcome = describeSigningFailure(
|
});
|
||||||
response,
|
|
||||||
"The message could not be signed.",
|
|
||||||
);
|
|
||||||
showError("approve-sign-error", outcome.message);
|
|
||||||
if (outcome.retryable) setSignButtonBusy(false);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
$("btn-reject-sign").addEventListener("click", () => {
|
$("btn-reject-sign").addEventListener("click", () => {
|
||||||
notify({
|
runtime.sendMessage({
|
||||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
type: "AUTISTMASK_SIGN_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
|
|||||||
@@ -422,10 +422,7 @@ function init(ctx) {
|
|||||||
password,
|
password,
|
||||||
);
|
);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
showError(
|
showError("confirm-tx-password-error", "Wrong password.");
|
||||||
"confirm-tx-password-error",
|
|
||||||
"That password is incorrect. Please try again.",
|
|
||||||
);
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -74,8 +74,7 @@ function init(_ctx) {
|
|||||||
try {
|
try {
|
||||||
await decryptWithPassword(wallet.encryptedSecret, pw);
|
await decryptWithPassword(wallet.encryptedSecret, pw);
|
||||||
} catch (_e) {
|
} catch (_e) {
|
||||||
$("delete-wallet-flash").textContent =
|
$("delete-wallet-flash").textContent = "Wrong password.";
|
||||||
"That password is incorrect. Please try again.";
|
|
||||||
$("delete-wallet-flash").style.visibility = "visible";
|
$("delete-wallet-flash").style.visibility = "visible";
|
||||||
btn.disabled = false;
|
btn.disabled = false;
|
||||||
btn.classList.remove("text-muted");
|
btn.classList.remove("text-muted");
|
||||||
|
|||||||
@@ -144,7 +144,7 @@ async function reveal() {
|
|||||||
$("export-privkey-flash").style.visibility = "hidden";
|
$("export-privkey-flash").style.visibility = "hidden";
|
||||||
} catch {
|
} catch {
|
||||||
if (!isCurrentReveal(generation)) return;
|
if (!isCurrentReveal(generation)) return;
|
||||||
fail("That password is incorrect. Please try again.");
|
fail("That password is not correct. Please try again.");
|
||||||
} finally {
|
} finally {
|
||||||
btn.disabled = false;
|
btn.disabled = false;
|
||||||
btn.classList.remove("text-muted");
|
btn.classList.remove("text-muted");
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ const {
|
|||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
const { state, saveState, currentAddress } = require("../../shared/state");
|
const { state, saveState, currentAddress } = require("../../shared/state");
|
||||||
const { notify } = require("../../shared/browserApi");
|
|
||||||
const {
|
const {
|
||||||
updateSendBalance,
|
updateSendBalance,
|
||||||
renderSendTokenSelect,
|
renderSendTokenSelect,
|
||||||
@@ -294,7 +293,11 @@ function render(ctx) {
|
|||||||
state.activeAddress = addr;
|
state.activeAddress = addr;
|
||||||
await saveState();
|
await saveState();
|
||||||
render(ctx);
|
render(ctx);
|
||||||
notify({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
const runtime =
|
||||||
|
typeof browser !== "undefined"
|
||||||
|
? browser.runtime
|
||||||
|
: chrome.runtime;
|
||||||
|
runtime.sendMessage({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -29,7 +29,8 @@ const {
|
|||||||
GITEA_COMMIT_URL,
|
GITEA_COMMIT_URL,
|
||||||
} = require("../../shared/buildInfo");
|
} = require("../../shared/buildInfo");
|
||||||
|
|
||||||
const { notify } = require("../../shared/browserApi");
|
const runtime =
|
||||||
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
|
|
||||||
let versionClickCount = 0;
|
let versionClickCount = 0;
|
||||||
let versionClickTimer = null;
|
let versionClickTimer = null;
|
||||||
@@ -60,7 +61,7 @@ function renderSiteList(containerId, siteMap, stateKey) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
await saveState();
|
await saveState();
|
||||||
notify({ type: "AUTISTMASK_REMOVE_SITE" });
|
runtime.sendMessage({ type: "AUTISTMASK_REMOVE_SITE" });
|
||||||
renderSiteList(containerId, state[key], key);
|
renderSiteList(containerId, state[key], key);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ async function reveal() {
|
|||||||
if (!isCurrentReveal(generation)) return;
|
if (!isCurrentReveal(generation)) return;
|
||||||
// Deliberately not the caught error: the message is fixed so that
|
// Deliberately not the caught error: the message is fixed so that
|
||||||
// nothing derived from the ciphertext or the attempt can surface.
|
// nothing derived from the ciphertext or the attempt can surface.
|
||||||
fail("That password is incorrect. Please try again.");
|
fail("That password is not correct. Please try again.");
|
||||||
} finally {
|
} finally {
|
||||||
btn.disabled = false;
|
btn.disabled = false;
|
||||||
btn.classList.remove("text-muted");
|
btn.classList.remove("text-muted");
|
||||||
|
|||||||
@@ -19,8 +19,6 @@
|
|||||||
// be bypassed on the scheduled tick — see backgroundRefresh() in
|
// be bypassed on the scheduled tick — see backgroundRefresh() in
|
||||||
// src/background/index.js and updatePhishingList() in shared/phishingDomains.js.
|
// src/background/index.js and updatePhishingList() in shared/phishingDomains.js.
|
||||||
|
|
||||||
const { alarmsApi } = require("./browserApi");
|
|
||||||
|
|
||||||
const BALANCE_REFRESH_ALARM = "autistmask-balance-refresh";
|
const BALANCE_REFRESH_ALARM = "autistmask-balance-refresh";
|
||||||
const PHISHING_REFRESH_ALARM = "autistmask-phishing-refresh";
|
const PHISHING_REFRESH_ALARM = "autistmask-phishing-refresh";
|
||||||
|
|
||||||
@@ -28,10 +26,14 @@ const MIN_ALARM_PERIOD_MINUTES = 1;
|
|||||||
const BALANCE_REFRESH_PERIOD_MINUTES = 1;
|
const BALANCE_REFRESH_PERIOD_MINUTES = 1;
|
||||||
const PHISHING_REFRESH_PERIOD_MINUTES = 24 * 60;
|
const PHISHING_REFRESH_PERIOD_MINUTES = 24 * 60;
|
||||||
|
|
||||||
// alarmsApi() resolves on use rather than at module load: the worker is torn
|
// Resolved on use rather than captured at module load: the worker is torn
|
||||||
// down and re-evaluated repeatedly, and tests install a stub after requiring
|
// down and re-evaluated repeatedly, and tests install a stub after requiring
|
||||||
// this module. It returns null where the API is absent, which is why every
|
// the module.
|
||||||
// entry point below degrades instead of throwing.
|
function alarmsApi() {
|
||||||
|
if (typeof browser !== "undefined" && browser.alarms) return browser.alarms;
|
||||||
|
if (typeof chrome !== "undefined" && chrome.alarms) return chrome.alarms;
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create an alarm unless one with the requested period already exists.
|
* Create an alarm unless one with the requested period already exists.
|
||||||
|
|||||||
@@ -1,213 +0,0 @@
|
|||||||
// 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.
|
|
||||||
//
|
|
||||||
// So it happens here instead, in the background, before the approval window is
|
|
||||||
// opened. The background populates the transaction, shows that object, and
|
|
||||||
// verifies the signed artifact against that same object — the popup is handed
|
|
||||||
// a finished transaction and signs it as given. Every field the user reads is
|
|
||||||
// then a field that is compared.
|
|
||||||
//
|
|
||||||
// The cost is an RPC round trip before the approval window exists. Nothing is
|
|
||||||
// displayed while it is in flight, and a failure — an unreachable node, a
|
|
||||||
// reverting gas estimate, a transaction type this wallet does not sign, a fee
|
|
||||||
// past the ceilings — means no approval and no window at all: the error goes
|
|
||||||
// back to the requesting page, which is where the user's click came from. That
|
|
||||||
// is deliberate. The alternative, opening the window first and populating
|
|
||||||
// behind a spinner, needs a pending approval that exists before it can be
|
|
||||||
// displayed or signed, and a half-initialised approval is exactly the state
|
|
||||||
// the settle interlock in the background exists to keep out of that record.
|
|
||||||
// The failure also lands earlier than it used to rather than later: the same
|
|
||||||
// estimate previously failed after the user had typed their password.
|
|
||||||
|
|
||||||
const {
|
|
||||||
VoidSigner,
|
|
||||||
accessListify,
|
|
||||||
getAddress,
|
|
||||||
getBytes,
|
|
||||||
hexlify,
|
|
||||||
toQuantity,
|
|
||||||
} = require("ethers");
|
|
||||||
const {
|
|
||||||
ALLOWED_TX_TYPES,
|
|
||||||
SERIALIZED_FIELDS,
|
|
||||||
assertWithinCeilings,
|
|
||||||
} = require("./approvalVerify");
|
|
||||||
|
|
||||||
// How long the population may take before the request is failed back to the
|
|
||||||
// page. Without a bound a hung RPC endpoint leaves the dApp's promise pending
|
|
||||||
// forever with nothing on screen to explain it; ethers' own request timeout is
|
|
||||||
// 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.
|
|
||||||
const REQUEST_FIELDS = [
|
|
||||||
"to",
|
|
||||||
"value",
|
|
||||||
"data",
|
|
||||||
"nonce",
|
|
||||||
"gasLimit",
|
|
||||||
"gasPrice",
|
|
||||||
"maxFeePerGas",
|
|
||||||
"maxPriorityFeePerGas",
|
|
||||||
"chainId",
|
|
||||||
"accessList",
|
|
||||||
"type",
|
|
||||||
];
|
|
||||||
|
|
||||||
class ApprovalPrepareError extends Error {
|
|
||||||
constructor(message) {
|
|
||||||
super(message);
|
|
||||||
this.name = "ApprovalPrepareError";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function fail(message) {
|
|
||||||
return new ApprovalPrepareError(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
function present(v) {
|
|
||||||
return v !== null && v !== undefined && v !== "";
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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) {
|
|
||||||
return /[.!?]$/.test(text) ? text : text + ".";
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reject a promise that has taken too long, and never leave the timer behind.
|
|
||||||
async function withTimeout(promise, ms, message) {
|
|
||||||
let timer = null;
|
|
||||||
try {
|
|
||||||
return await Promise.race([
|
|
||||||
promise,
|
|
||||||
new Promise((_resolve, reject) => {
|
|
||||||
timer = setTimeout(() => reject(fail(message)), ms);
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
} finally {
|
|
||||||
if (timer !== null) clearTimeout(timer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The page's request, reduced to the fields this wallet acts on.
|
|
||||||
function requestFrom(txParams, from) {
|
|
||||||
const request = { from: getAddress(from) };
|
|
||||||
for (const key of REQUEST_FIELDS) {
|
|
||||||
if (present(txParams[key])) request[key] = txParams[key];
|
|
||||||
}
|
|
||||||
if (
|
|
||||||
present(request.type) &&
|
|
||||||
!ALLOWED_TX_TYPES.includes(Number(request.type))
|
|
||||||
) {
|
|
||||||
throw fail(
|
|
||||||
"The site asked for a transaction of a type this wallet does not sign.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return request;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Turn a populated transaction into the object that crosses to the popup, is
|
|
||||||
// displayed, and is compared with the signed artifact. It carries exactly the
|
|
||||||
// fields its type serializes, plus the address it is to be signed by, and
|
|
||||||
// every quantity as a hex string: extension messaging is JSON, which has no
|
|
||||||
// bigint, and a field that did not survive the trip would be a field the user
|
|
||||||
// was shown and nothing compared.
|
|
||||||
function serializeApprovedTx(populated, from) {
|
|
||||||
const type = Number(populated.type);
|
|
||||||
if (!ALLOWED_TX_TYPES.includes(type)) {
|
|
||||||
throw fail(
|
|
||||||
"This transaction would have to be sent as a type this wallet does not sign.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
const approved = { type, from: getAddress(from) };
|
|
||||||
for (const key of SERIALIZED_FIELDS[type]) {
|
|
||||||
if (key === "to") {
|
|
||||||
approved.to = present(populated.to)
|
|
||||||
? getAddress(populated.to)
|
|
||||||
: null;
|
|
||||||
} else if (key === "data") {
|
|
||||||
approved.data = present(populated.data)
|
|
||||||
? hexlify(getBytes(populated.data))
|
|
||||||
: "0x";
|
|
||||||
} else if (key === "accessList") {
|
|
||||||
approved.accessList = accessListify(populated.accessList || []);
|
|
||||||
} else if (key === "value") {
|
|
||||||
approved.value = toQuantity(populated.value || 0);
|
|
||||||
} else if (!present(populated[key])) {
|
|
||||||
// Unreachable while populateTransaction() fills every quantity of
|
|
||||||
// the type it produced. If it ever does not, the approval must not
|
|
||||||
// be raised: an unfixed quantity is one the artifact cannot be
|
|
||||||
// checked against.
|
|
||||||
throw fail(
|
|
||||||
"The transaction could not be prepared: the network did not supply a " +
|
|
||||||
key +
|
|
||||||
".",
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
approved[key] = toQuantity(populated[key]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return approved;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Populate the transaction a site asked for, as the address it will be signed
|
|
||||||
// by, and return the object to display, sign and verify against. Throws with a
|
|
||||||
// full sentence when no approval can be raised.
|
|
||||||
async function prepareApprovalTx(provider, from, txParams) {
|
|
||||||
if (!present(from)) {
|
|
||||||
throw fail("There is no active address to send this transaction from.");
|
|
||||||
}
|
|
||||||
const request = requestFrom(txParams || {}, from);
|
|
||||||
|
|
||||||
let populated;
|
|
||||||
try {
|
|
||||||
// The sequence ethers' own sendTransaction() runs internally, so the
|
|
||||||
// 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.
|
|
||||||
populated = await withTimeout(
|
|
||||||
new VoidSigner(getAddress(from), provider).populateTransaction(
|
|
||||||
request,
|
|
||||||
),
|
|
||||||
POPULATE_TIMEOUT_MS,
|
|
||||||
"The transaction could not be prepared: the network did not answer in time.",
|
|
||||||
);
|
|
||||||
} catch (e) {
|
|
||||||
if (e instanceof ApprovalPrepareError) throw e;
|
|
||||||
throw fail(
|
|
||||||
sentence(
|
|
||||||
"The transaction could not be prepared: " +
|
|
||||||
(e.shortMessage ||
|
|
||||||
e.message ||
|
|
||||||
"the network did not answer"),
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const approved = serializeApprovedTx(populated, from);
|
|
||||||
// The backstop, applied before the user is shown anything rather than
|
|
||||||
// after they have approved it: what is displayed here is what gets signed,
|
|
||||||
// so an RPC node reporting an absurd fee has to be refused here.
|
|
||||||
assertWithinCeilings(approved);
|
|
||||||
return approved;
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
prepareApprovalTx,
|
|
||||||
serializeApprovedTx,
|
|
||||||
ApprovalPrepareError,
|
|
||||||
POPULATE_TIMEOUT_MS,
|
|
||||||
REQUEST_FIELDS,
|
|
||||||
};
|
|
||||||
@@ -7,13 +7,6 @@
|
|||||||
// the signer from the artifact and checks it against the approval it is
|
// the signer from the artifact and checks it against the approval it is
|
||||||
// holding before acting on it. All recovery is delegated to ethers.
|
// holding before acting on it. All recovery is delegated to ethers.
|
||||||
//
|
//
|
||||||
// What the artifact is checked against is the transaction the background
|
|
||||||
// populated and the popup displayed (see approvalTx.js), not the request the
|
|
||||||
// dApp made. The two differ in every field a dApp normally leaves out — nonce,
|
|
||||||
// gas limit, fees — and those are the fields the user reads off the approval
|
|
||||||
// screen, so comparing against the request would leave the numbers on screen
|
|
||||||
// vouched for by nothing.
|
|
||||||
//
|
|
||||||
// The check is an allowlist, in both directions, because a denylist cannot be
|
// The check is an allowlist, in both directions, because a denylist cannot be
|
||||||
// correct against a transaction format that keeps gaining fields:
|
// correct against a transaction format that keeps gaining fields:
|
||||||
//
|
//
|
||||||
@@ -38,12 +31,14 @@
|
|||||||
// never a warning: what the user approved is what gets broadcast, or nothing
|
// never a warning: what the user approved is what gets broadcast, or nothing
|
||||||
// does.
|
// does.
|
||||||
//
|
//
|
||||||
// The approved transaction is required to fix every field its type serializes,
|
// Fields the approval does not carry are not treated as zero. The popup
|
||||||
// so there is no "the approval did not say" branch to fall through: a quantity
|
// populates nonce, gas limit, fee and chain id through populateTransaction()
|
||||||
// the approval does not carry is a refusal, because an artifact that cannot be
|
// when the requesting page did not fix them, so there is no approved value to
|
||||||
// compared with what was displayed has not been checked. The chain id is
|
// compare against; treating absent as zero would refuse every legitimate
|
||||||
// checked against the selected network as well as against the approval, which
|
// transaction. Those fields are instead held to the absolute ceilings below,
|
||||||
// is what makes a cross-chain replay impossible.
|
// and the chain id is always checked against the selected network rather than
|
||||||
|
// against the approval alone, which is what makes a cross-chain replay
|
||||||
|
// impossible.
|
||||||
//
|
//
|
||||||
// Every failure message is a full sentence, because these strings are shown to
|
// Every failure message is a full sentence, because these strings are shown to
|
||||||
// the user and returned to the dApp.
|
// the user and returned to the dApp.
|
||||||
@@ -118,17 +113,6 @@ const FORBIDDEN_FIELDS = [
|
|||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
// Absolute ceilings — a BACKSTOP, not the primary control.
|
|
||||||
//
|
|
||||||
// The primary control is equality: every field of the artifact is compared
|
|
||||||
// with the populated transaction the user was shown, so nothing the popup
|
|
||||||
// signs can differ from the screen. What equality cannot bound is the
|
|
||||||
// populated transaction itself, which is built from what the configured RPC
|
|
||||||
// node answered — a node that reports an absurd fee gets that fee displayed,
|
|
||||||
// and a user who does not read the fee line would approve it. These ceilings
|
|
||||||
// bound that, and they are therefore applied where the transaction is
|
|
||||||
// populated (approvalTx.js) as well as here.
|
|
||||||
//
|
|
||||||
// Above the block gas limit of every supported network (see networks.js), so
|
// Above the block gas limit of every supported network (see networks.js), so
|
||||||
// no transaction that could ever be included is refused by it.
|
// no transaction that could ever be included is refused by it.
|
||||||
const MAX_GAS_LIMIT = 100000000n;
|
const MAX_GAS_LIMIT = 100000000n;
|
||||||
@@ -240,151 +224,40 @@ function normalizeData(v) {
|
|||||||
return String(v).toLowerCase();
|
return String(v).toLowerCase();
|
||||||
}
|
}
|
||||||
|
|
||||||
// How each field of an approved transaction is compared with the artifact.
|
// Quantity fields the requesting page may fix in the approval. Each is
|
||||||
// There is an entry here for every field any allowed type serializes — a test
|
// compared exactly when the approval carries it, and left to the ceilings
|
||||||
// pins that against SERIALIZED_FIELDS — so the comparison loop covers the
|
// above when it does not.
|
||||||
// whole of what gets signed and cannot silently skip a field for want of a
|
const APPROVED_QUANTITIES = [
|
||||||
// comparator.
|
{
|
||||||
//
|
key: "nonce",
|
||||||
// `kind` decides how the two sides are made comparable. A `quantity` must be
|
|
||||||
// fixed by the approval: it is one of the numbers on the approval screen, and
|
|
||||||
// an absent one means the artifact cannot be checked against what was
|
|
||||||
// displayed. `to`, `value`, `data` and `accessList` have canonical absent
|
|
||||||
// forms — contract creation, zero, "0x" and the empty list — so they are
|
|
||||||
// normalized on both sides instead.
|
|
||||||
const APPROVED_FIELDS = {
|
|
||||||
chainId: {
|
|
||||||
kind: "quantity",
|
|
||||||
label: "network",
|
|
||||||
message:
|
|
||||||
"The signed transaction is for a different network than the one that was approved.",
|
|
||||||
},
|
|
||||||
nonce: {
|
|
||||||
kind: "quantity",
|
|
||||||
label: "nonce",
|
label: "nonce",
|
||||||
message: "The signed transaction does not carry the approved nonce.",
|
message: "The signed transaction does not carry the approved nonce.",
|
||||||
},
|
},
|
||||||
gasLimit: {
|
{
|
||||||
kind: "quantity",
|
key: "gasLimit",
|
||||||
label: "gas limit",
|
label: "gas limit",
|
||||||
message:
|
message:
|
||||||
"The signed transaction does not carry the approved gas limit.",
|
"The signed transaction does not carry the approved gas limit.",
|
||||||
},
|
},
|
||||||
gasPrice: {
|
{
|
||||||
kind: "quantity",
|
key: "gasPrice",
|
||||||
label: "gas price",
|
label: "gas price",
|
||||||
message:
|
message:
|
||||||
"The signed transaction does not carry the approved gas price.",
|
"The signed transaction does not carry the approved gas price.",
|
||||||
},
|
},
|
||||||
maxFeePerGas: {
|
{
|
||||||
kind: "quantity",
|
key: "maxFeePerGas",
|
||||||
label: "maximum fee per gas",
|
label: "maximum fee per gas",
|
||||||
message:
|
message:
|
||||||
"The signed transaction does not carry the approved maximum fee per gas.",
|
"The signed transaction does not carry the approved maximum fee per gas.",
|
||||||
},
|
},
|
||||||
maxPriorityFeePerGas: {
|
{
|
||||||
kind: "quantity",
|
key: "maxPriorityFeePerGas",
|
||||||
label: "maximum priority fee per gas",
|
label: "maximum priority fee per gas",
|
||||||
message:
|
message:
|
||||||
"The signed transaction does not carry the approved maximum priority fee per gas.",
|
"The signed transaction does not carry the approved maximum priority fee per gas.",
|
||||||
},
|
},
|
||||||
to: {
|
];
|
||||||
kind: "address",
|
|
||||||
label: "recipient",
|
|
||||||
message:
|
|
||||||
"The signed transaction does not go to the approved recipient.",
|
|
||||||
},
|
|
||||||
value: {
|
|
||||||
kind: "value",
|
|
||||||
label: "value",
|
|
||||||
message: "The signed transaction does not carry the approved value.",
|
|
||||||
},
|
|
||||||
data: {
|
|
||||||
kind: "data",
|
|
||||||
label: "call data",
|
|
||||||
message:
|
|
||||||
"The signed transaction does not carry the approved call data.",
|
|
||||||
},
|
|
||||||
accessList: {
|
|
||||||
kind: "accessList",
|
|
||||||
label: "access list",
|
|
||||||
message:
|
|
||||||
"The signed transaction does not carry the approved access list.",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// Compare one field of the artifact with the approved transaction. A field
|
|
||||||
// with no entry in the table above is refused rather than skipped: the loop
|
|
||||||
// below runs over the fields the type serializes, so an unmatched key means
|
|
||||||
// something that gets signed has no comparator at all.
|
|
||||||
function assertFieldMatches(key, parsed, approvedTx) {
|
|
||||||
const field = APPROVED_FIELDS[key];
|
|
||||||
if (!field) {
|
|
||||||
throw refuse(
|
|
||||||
"The signed transaction carries a field this wallet cannot compare with the approval.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
switch (field.kind) {
|
|
||||||
case "quantity": {
|
|
||||||
if (!present(approvedTx[key])) {
|
|
||||||
throw refuse(
|
|
||||||
"The approved transaction fixes no " +
|
|
||||||
field.label +
|
|
||||||
", so the signed transaction cannot be checked" +
|
|
||||||
" against what was shown.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
const approved = normalizeQuantity(approvedTx[key], field.label);
|
|
||||||
if (normalizeQuantity(parsed[key], field.label) !== approved) {
|
|
||||||
throw refuse(field.message);
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
case "address":
|
|
||||||
if (!sameAddress(parsed[key], approvedTx[key])) {
|
|
||||||
throw refuse(field.message);
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
case "value":
|
|
||||||
if (normalizeValue(parsed[key]) !== normalizeValue(approvedTx[key]))
|
|
||||||
throw refuse(field.message);
|
|
||||||
return;
|
|
||||||
case "data":
|
|
||||||
if (normalizeData(parsed[key]) !== normalizeData(approvedTx[key]))
|
|
||||||
throw refuse(field.message);
|
|
||||||
return;
|
|
||||||
default:
|
|
||||||
if (
|
|
||||||
normalizeAccessList(parsed[key]) !==
|
|
||||||
normalizeAccessList(approvedTx[key])
|
|
||||||
) {
|
|
||||||
throw refuse(field.message);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The ceilings, applied to a transaction that is either about to be displayed
|
|
||||||
// or about to be broadcast. See MAX_GAS_LIMIT above for what they are for:
|
|
||||||
// they bound what the RPC node can talk this wallet into showing the user,
|
|
||||||
// which is the one thing comparing the artifact with the screen cannot do.
|
|
||||||
function assertWithinCeilings(tx) {
|
|
||||||
if (
|
|
||||||
present(tx.gasLimit) &&
|
|
||||||
normalizeQuantity(tx.gasLimit, "gas limit") > MAX_GAS_LIMIT
|
|
||||||
) {
|
|
||||||
throw refuse(
|
|
||||||
"The signed transaction sets a gas limit no network this wallet supports can accept.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
for (const key of ["gasPrice", "maxFeePerGas", "maxPriorityFeePerGas"]) {
|
|
||||||
if (!present(tx[key])) continue;
|
|
||||||
if (normalizeQuantity(tx[key], "fee per gas") > MAX_FEE_PER_GAS) {
|
|
||||||
throw refuse(
|
|
||||||
"The signed transaction sets a fee per gas far above any plausible value.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Refuse a field only a transaction type this wallet does not sign can carry.
|
// Refuse a field only a transaction type this wallet does not sign can carry.
|
||||||
// The type allowlist keeps these unreachable in production, which is exactly
|
// The type allowlist keeps these unreachable in production, which is exactly
|
||||||
@@ -444,28 +317,10 @@ function assertCanonicalBytes(parsed, rawSignedTx) {
|
|||||||
// signed by the address the approval was raised for, on the network that is
|
// signed by the address the approval was raised for, on the network that is
|
||||||
// selected. Returns the parsed ethers Transaction on success, throws
|
// selected. Returns the parsed ethers Transaction on success, throws
|
||||||
// otherwise.
|
// otherwise.
|
||||||
//
|
function verifySignedTx(rawSignedTx, txParams, expectedFrom, selectedChainId) {
|
||||||
// `approvedTx` is the populated transaction the approval screen displayed, and
|
|
||||||
// `expectedFrom` is the address that was active when the approval was raised —
|
|
||||||
// not whichever address is active now. An address switch between approval and
|
|
||||||
// signing therefore refuses here rather than producing a transaction from an
|
|
||||||
// account the approval did not name.
|
|
||||||
function verifySignedTx(
|
|
||||||
rawSignedTx,
|
|
||||||
approvedTx,
|
|
||||||
expectedFrom,
|
|
||||||
selectedChainId,
|
|
||||||
) {
|
|
||||||
if (typeof rawSignedTx !== "string" || !rawSignedTx.startsWith("0x")) {
|
if (typeof rawSignedTx !== "string" || !rawSignedTx.startsWith("0x")) {
|
||||||
throw refuse("The signed transaction is missing or malformed.");
|
throw refuse("The signed transaction is missing or malformed.");
|
||||||
}
|
}
|
||||||
// Nothing to compare against is a refusal like any other: an approval that
|
|
||||||
// does not carry the transaction it displayed cannot vouch for one.
|
|
||||||
if (!approvedTx || typeof approvedTx !== "object") {
|
|
||||||
throw refuse(
|
|
||||||
"There is no approved transaction to check the signed transaction against.",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
let parsed;
|
let parsed;
|
||||||
try {
|
try {
|
||||||
@@ -505,15 +360,46 @@ function verifySignedTx(
|
|||||||
"The signed transaction is for a different network than the one that is selected.",
|
"The signed transaction is for a different network than the one that is selected.",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
if (
|
||||||
|
present(txParams.chainId) &&
|
||||||
|
parsed.chainId !== normalizeQuantity(txParams.chainId, "network")
|
||||||
|
) {
|
||||||
|
throw refuse(
|
||||||
|
"The signed transaction is for a different network than the one that was approved.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// The approved fee mechanism, named before the type comparison below
|
if (!sameAddress(parsed.to, txParams.to)) {
|
||||||
// subsumes it: the fee the user agreed to is only meaningful under the
|
throw refuse(
|
||||||
// mechanism it was quoted in, and saying so is more use than "a different
|
"The signed transaction does not go to the approved recipient.",
|
||||||
// transaction type".
|
);
|
||||||
|
}
|
||||||
|
if (normalizeValue(parsed.value) !== normalizeValue(txParams.value)) {
|
||||||
|
throw refuse(
|
||||||
|
"The signed transaction does not carry the approved value.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (normalizeData(parsed.data) !== normalizeData(txParams.data)) {
|
||||||
|
throw refuse(
|
||||||
|
"The signed transaction does not carry the approved call data.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
normalizeAccessList(parsed.accessList) !==
|
||||||
|
normalizeAccessList(txParams.accessList)
|
||||||
|
) {
|
||||||
|
throw refuse(
|
||||||
|
"The signed transaction does not carry the approved access list.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// An approval that fixed EIP-1559 fees must not be signed as a legacy
|
||||||
|
// transaction, and vice versa: the fee the user agreed to is only
|
||||||
|
// meaningful under the mechanism it was quoted in.
|
||||||
const approvedEip1559 =
|
const approvedEip1559 =
|
||||||
present(approvedTx.maxFeePerGas) ||
|
present(txParams.maxFeePerGas) ||
|
||||||
present(approvedTx.maxPriorityFeePerGas);
|
present(txParams.maxPriorityFeePerGas);
|
||||||
const approvedLegacy = present(approvedTx.gasPrice);
|
const approvedLegacy = present(txParams.gasPrice);
|
||||||
const signedEip1559 = parsed.type === 2;
|
const signedEip1559 = parsed.type === 2;
|
||||||
if (
|
if (
|
||||||
(approvedEip1559 && !signedEip1559) ||
|
(approvedEip1559 && !signedEip1559) ||
|
||||||
@@ -524,32 +410,27 @@ function verifySignedTx(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The type decides which fields are compared, so it is compared first and
|
for (const field of APPROVED_QUANTITIES) {
|
||||||
// against the approval, not merely checked for membership of the
|
if (!present(txParams[field.key])) continue;
|
||||||
// allowlist above.
|
const approved = normalizeQuantity(txParams[field.key], field.label);
|
||||||
if (!present(approvedTx.type)) {
|
if (normalizeQuantity(parsed[field.key], field.label) !== approved) {
|
||||||
throw refuse(
|
throw refuse(field.message);
|
||||||
"The approved transaction fixes no transaction type, so the signed transaction cannot be checked against what was shown.",
|
}
|
||||||
);
|
|
||||||
}
|
|
||||||
if (
|
|
||||||
BigInt(parsed.type) !==
|
|
||||||
normalizeQuantity(approvedTx.type, "transaction type")
|
|
||||||
) {
|
|
||||||
throw refuse(
|
|
||||||
"The signed transaction does not use the approved transaction type.",
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Every field this type serializes, compared with the transaction the user
|
if (parsed.gasLimit > MAX_GAS_LIMIT) {
|
||||||
// was shown. Driving the loop off SERIALIZED_FIELDS is what keeps this
|
throw refuse(
|
||||||
// exhaustive: the same table decides what assertNothingUnchecked() rebuilds
|
"The signed transaction sets a gas limit no network this wallet supports can accept.",
|
||||||
// from, so a field that gets signed and is not compared here cannot exist.
|
);
|
||||||
for (const key of SERIALIZED_FIELDS[parsed.type]) {
|
}
|
||||||
assertFieldMatches(key, parsed, approvedTx);
|
for (const key of ["gasPrice", "maxFeePerGas", "maxPriorityFeePerGas"]) {
|
||||||
|
const fee = parsed[key];
|
||||||
|
if (fee !== null && fee !== undefined && fee > MAX_FEE_PER_GAS) {
|
||||||
|
throw refuse(
|
||||||
|
"The signed transaction sets a fee per gas far above any plausible value.",
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
assertWithinCeilings(parsed);
|
|
||||||
|
|
||||||
assertNothingUnchecked(parsed);
|
assertNothingUnchecked(parsed);
|
||||||
assertCanonicalBytes(parsed, rawSignedTx);
|
assertCanonicalBytes(parsed, rawSignedTx);
|
||||||
@@ -623,10 +504,10 @@ function errorText(err) {
|
|||||||
// approval. Anything else failed before the check ran and is retryable.
|
// approval. Anything else failed before the check ran and is retryable.
|
||||||
// - broadcast: always terminal. A broadcast that throws after the node
|
// - broadcast: always terminal. A broadcast that throws after the node
|
||||||
// accepted the transaction is routine (a timeout, a dropped response, a
|
// accepted the transaction is routine (a timeout, a dropped response, a
|
||||||
// node answering "already known"), so the wallet cannot tell a transaction
|
// node answering "already known"), and the popup's retry does not
|
||||||
// that never left from one that is already in the mempool. The approval is
|
// re-broadcast these bytes — it re-runs populateTransaction() and signs
|
||||||
// spent and the requesting page has been given its outcome; a second
|
// again at a freshly fetched pending-tag nonce. Retrying would therefore
|
||||||
// attempt against it would report a second outcome for one request.
|
// put a second transaction on the chain for one approval.
|
||||||
function describeTxFailure(stage, err) {
|
function describeTxFailure(stage, err) {
|
||||||
const error = errorText(err);
|
const error = errorText(err);
|
||||||
const retryable =
|
const retryable =
|
||||||
@@ -672,7 +553,6 @@ module.exports = {
|
|||||||
assertNoForbiddenFields,
|
assertNoForbiddenFields,
|
||||||
assertNothingUnchecked,
|
assertNothingUnchecked,
|
||||||
assertCanonicalBytes,
|
assertCanonicalBytes,
|
||||||
assertWithinCeilings,
|
|
||||||
sameAddress,
|
sameAddress,
|
||||||
failureIsRetryable,
|
failureIsRetryable,
|
||||||
describeTxFailure,
|
describeTxFailure,
|
||||||
@@ -681,7 +561,6 @@ module.exports = {
|
|||||||
ALLOWED_TX_TYPES,
|
ALLOWED_TX_TYPES,
|
||||||
SERIALIZED_FIELDS,
|
SERIALIZED_FIELDS,
|
||||||
FORBIDDEN_FIELDS,
|
FORBIDDEN_FIELDS,
|
||||||
APPROVED_FIELDS,
|
|
||||||
TX_STAGE_SIGN,
|
TX_STAGE_SIGN,
|
||||||
TX_STAGE_VERIFY,
|
TX_STAGE_VERIFY,
|
||||||
TX_STAGE_BROADCAST,
|
TX_STAGE_BROADCAST,
|
||||||
|
|||||||
@@ -66,12 +66,7 @@ async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
|||||||
|
|
||||||
const balances = [];
|
const balances = [];
|
||||||
for (const item of items) {
|
for (const item of items) {
|
||||||
// Case-insensitive: the token type is an explorer's label, not a
|
if (item.token?.type !== "ERC-20") continue;
|
||||||
// protocol value, and an exact comparison silently drops a real
|
|
||||||
// holding if one ever writes "erc-20". Which types are admitted
|
|
||||||
// is unchanged.
|
|
||||||
const type = String(item.token?.type || "").toUpperCase();
|
|
||||||
if (type !== "ERC-20") continue;
|
|
||||||
const decimals = parseInt(item.token.decimals || "18", 10);
|
const decimals = parseInt(item.token.decimals || "18", 10);
|
||||||
const bal = formatTokenBalance(item.value || "0", decimals);
|
const bal = formatTokenBalance(item.value || "0", decimals);
|
||||||
if (bal === "0.0") continue;
|
if (bal === "0.0") continue;
|
||||||
|
|||||||
@@ -1,245 +0,0 @@
|
|||||||
// The one place in this tree that names `browser` or `chrome`.
|
|
||||||
//
|
|
||||||
// The two targets do not agree on either the namespace or the call shape.
|
|
||||||
// Chrome MV3 exposes `chrome.*`, where tabs, windows and messaging take a
|
|
||||||
// trailing callback and report failure through the global
|
|
||||||
// `chrome.runtime.lastError`. Firefox MV2 exposes `browser.*`, where those
|
|
||||||
// same methods return promises and take no callback at all — a function
|
|
||||||
// passed where an options argument is expected is simply never invoked, so
|
|
||||||
// the call looks like it succeeded and silently never completes. Resolving
|
|
||||||
// the namespace with a ternary and then calling it Chrome-style, which is
|
|
||||||
// what this codebase used to do, is broken on Firefox in exactly that way:
|
|
||||||
// see https://git.eeqj.de/sneak/AutistMask/issues/153.
|
|
||||||
//
|
|
||||||
// The strategy is promises out, everywhere. Callers `await`; nothing outside
|
|
||||||
// this file has to know which browser it is running on.
|
|
||||||
//
|
|
||||||
// Two deliberate asymmetries, because they are what the browsers actually do
|
|
||||||
// rather than what a uniform-looking shim would pretend:
|
|
||||||
//
|
|
||||||
// - Storage is called in its PROMISE form on both namespaces.
|
|
||||||
// `chrome.storage.local.get()` returns a promise on MV3 and the popup
|
|
||||||
// already depends on that — src/shared/state.js has always awaited it, and
|
|
||||||
// that is precisely why the Firefox popup flows work today while
|
|
||||||
// everything in the issue above does not. Wrapping it in a callback here
|
|
||||||
// would be a change, not a fix.
|
|
||||||
// - notify() sends without a callback. It is for a message whose answer
|
|
||||||
// nobody reads; appending a callback would only manufacture a
|
|
||||||
// lastError/rejection for a receiver that was never expected to reply.
|
|
||||||
//
|
|
||||||
// Everything is resolved on use rather than captured at module load. The MV3
|
|
||||||
// service worker is torn down and re-evaluated repeatedly, and the unit
|
|
||||||
// suite installs its stubs on `global.chrome` around a require().
|
|
||||||
|
|
||||||
// The extension API namespace, preferring `browser.*` where it exists.
|
|
||||||
//
|
|
||||||
// Whole-namespace, never per-method: mixing `browser.tabs` with
|
|
||||||
// `chrome.windows` would also mix promise and callback semantics inside a
|
|
||||||
// single call path, which is the bug this module exists to remove.
|
|
||||||
function extensionApi() {
|
|
||||||
if (typeof browser !== "undefined" && browser) return browser;
|
|
||||||
if (typeof chrome !== "undefined" && chrome) return chrome;
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// True when the resolved namespace is the promise-flavoured one.
|
|
||||||
//
|
|
||||||
// It doubles as "this is the Gecko/MV2 build", which is a second question
|
|
||||||
// with the same answer and one real caller: src/content/index.js has to
|
|
||||||
// inject the inpage provider itself there, because MV2 has no
|
|
||||||
// `"world": "MAIN"` for a manifest-declared content script.
|
|
||||||
function hasBrowserNamespace() {
|
|
||||||
return typeof browser !== "undefined" && !!browser;
|
|
||||||
}
|
|
||||||
|
|
||||||
function namespaceMember(name) {
|
|
||||||
const api = extensionApi();
|
|
||||||
return (api && api[name]) || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
function runtimeApi() {
|
|
||||||
return namespaceMember("runtime");
|
|
||||||
}
|
|
||||||
|
|
||||||
function tabsApi() {
|
|
||||||
return namespaceMember("tabs");
|
|
||||||
}
|
|
||||||
|
|
||||||
function windowsApi() {
|
|
||||||
return namespaceMember("windows");
|
|
||||||
}
|
|
||||||
|
|
||||||
function alarmsApi() {
|
|
||||||
return namespaceMember("alarms");
|
|
||||||
}
|
|
||||||
|
|
||||||
// The toolbar button. MV3 calls it `action`, MV2 calls it `browserAction`.
|
|
||||||
function actionApi() {
|
|
||||||
const api = extensionApi();
|
|
||||||
if (!api) return null;
|
|
||||||
return api.action || api.browserAction || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// `storage.local`, or null in a context that has no storage permission. Null
|
|
||||||
// rather than a throw because two callers degrade rather than fail on it.
|
|
||||||
function storageLocal() {
|
|
||||||
const storage = namespaceMember("storage");
|
|
||||||
return (storage && storage.local) || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The Chrome-only error channel. Never populated for a `browser.*` call,
|
|
||||||
// which is why the checks that used to guard callbacks in the background are
|
|
||||||
// gone: on this side it becomes a rejection, and on the other side there was
|
|
||||||
// never anything to read.
|
|
||||||
function lastError() {
|
|
||||||
const runtime = runtimeApi();
|
|
||||||
return (runtime && runtime.lastError) || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Call `owner[method](...args)` and return a promise for its result.
|
|
||||||
//
|
|
||||||
// On the promise namespace the method already returns one. On the callback
|
|
||||||
// namespace the callback is appended here and lastError becomes a rejection,
|
|
||||||
// because a caller holding a promise has nowhere to check a global flag.
|
|
||||||
function invoke(owner, method, ...args) {
|
|
||||||
if (!owner || typeof owner[method] !== "function") {
|
|
||||||
return Promise.reject(
|
|
||||||
new Error(
|
|
||||||
"extension API " +
|
|
||||||
method +
|
|
||||||
"() is not available in this context",
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
if (hasBrowserNamespace()) {
|
|
||||||
try {
|
|
||||||
return Promise.resolve(owner[method](...args));
|
|
||||||
} catch (e) {
|
|
||||||
return Promise.reject(e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
owner[method](...args, (result) => {
|
|
||||||
const err = lastError();
|
|
||||||
if (err) reject(new Error(err.message || String(err)));
|
|
||||||
else resolve(result);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a message to the extension's own contexts and resolve with the reply.
|
|
||||||
*
|
|
||||||
* Rejects when nothing is listening, on both browsers. A caller that does not
|
|
||||||
* care must say so — see notify().
|
|
||||||
*
|
|
||||||
* @param {Object} message
|
|
||||||
* @returns {Promise<*>} the receiver's response.
|
|
||||||
*/
|
|
||||||
function sendMessage(message) {
|
|
||||||
return invoke(runtimeApi(), "sendMessage", message);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a message nobody is expected to answer, and swallow the fact that
|
|
||||||
* nobody did.
|
|
||||||
*
|
|
||||||
* @param {Object} message
|
|
||||||
* @returns {void}
|
|
||||||
*/
|
|
||||||
function notify(message) {
|
|
||||||
const runtime = runtimeApi();
|
|
||||||
if (!runtime || typeof runtime.sendMessage !== "function") return;
|
|
||||||
const result = runtime.sendMessage(message);
|
|
||||||
// MV3 hands back a promise for a one-argument send, and it rejects when
|
|
||||||
// the background is not listening. Unhandled, that surfaces as an error
|
|
||||||
// the e2e suites fail the run on.
|
|
||||||
if (result && typeof result.catch === "function") result.catch(() => {});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string|string[]|Object} keys
|
|
||||||
* @returns {Promise<Object>} the stored items, or {} where storage is absent.
|
|
||||||
*/
|
|
||||||
function storageGet(keys) {
|
|
||||||
const storage = storageLocal();
|
|
||||||
if (!storage) return Promise.resolve({});
|
|
||||||
return Promise.resolve(storage.get(keys));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {Object} items
|
|
||||||
* @returns {Promise<void>}
|
|
||||||
*/
|
|
||||||
function storageSet(items) {
|
|
||||||
const storage = storageLocal();
|
|
||||||
if (!storage) return Promise.resolve();
|
|
||||||
return Promise.resolve(storage.set(items));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {Object} queryInfo
|
|
||||||
* @returns {Promise<Array>} the matching tabs.
|
|
||||||
*/
|
|
||||||
function tabsQuery(queryInfo) {
|
|
||||||
return invoke(tabsApi(), "query", queryInfo);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a message to one tab's content script.
|
|
||||||
*
|
|
||||||
* Rejects for a tab that has no receiver, which is most of them. That
|
|
||||||
* rejection is the promise-shaped replacement for the runtime.lastError
|
|
||||||
* checks the broadcast helpers used to make, and callers ignore it the same
|
|
||||||
* way.
|
|
||||||
*
|
|
||||||
* @param {number} tabId
|
|
||||||
* @param {Object} message
|
|
||||||
* @returns {Promise<*>}
|
|
||||||
*/
|
|
||||||
function tabsSendMessage(tabId, message) {
|
|
||||||
return invoke(tabsApi(), "sendMessage", tabId, message);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {Object} createData
|
|
||||||
* @returns {Promise<Object>} the created window.
|
|
||||||
*/
|
|
||||||
function windowsCreate(createData) {
|
|
||||||
return invoke(windowsApi(), "create", createData);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns {Promise<Object>} the last focused window.
|
|
||||||
*/
|
|
||||||
function windowsGetLastFocused() {
|
|
||||||
return invoke(windowsApi(), "getLastFocused");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {number} windowId
|
|
||||||
* @returns {Promise<void>}
|
|
||||||
*/
|
|
||||||
function windowsRemove(windowId) {
|
|
||||||
return invoke(windowsApi(), "remove", windowId);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
actionApi,
|
|
||||||
alarmsApi,
|
|
||||||
extensionApi,
|
|
||||||
hasBrowserNamespace,
|
|
||||||
notify,
|
|
||||||
runtimeApi,
|
|
||||||
sendMessage,
|
|
||||||
storageGet,
|
|
||||||
storageLocal,
|
|
||||||
storageSet,
|
|
||||||
tabsApi,
|
|
||||||
tabsQuery,
|
|
||||||
tabsSendMessage,
|
|
||||||
windowsApi,
|
|
||||||
windowsCreate,
|
|
||||||
windowsGetLastFocused,
|
|
||||||
windowsRemove,
|
|
||||||
};
|
|
||||||
@@ -18,7 +18,6 @@
|
|||||||
// its own refresh — see updatePhishingList().
|
// its own refresh — see updatePhishingList().
|
||||||
|
|
||||||
const vendoredConfig = require("./phishingBlocklist.json");
|
const vendoredConfig = require("./phishingBlocklist.json");
|
||||||
const { storageLocal } = require("./browserApi");
|
|
||||||
|
|
||||||
const BLOCKLIST_URL =
|
const BLOCKLIST_URL =
|
||||||
"https://raw.githubusercontent.com/MetaMask/eth-phishing-detect/main/src/config.json";
|
"https://raw.githubusercontent.com/MetaMask/eth-phishing-detect/main/src/config.json";
|
||||||
@@ -47,10 +46,18 @@ let lastAttemptTime = 0;
|
|||||||
let fetchPromise = null;
|
let fetchPromise = null;
|
||||||
let loadPromise = null;
|
let loadPromise = null;
|
||||||
|
|
||||||
// storageLocal() resolves on use rather than at module load, so a test can
|
// Resolved on use rather than captured at module load, so a test can install
|
||||||
// install a stub after requiring this module, and it returns null where the
|
// a stub after requiring the module and so the popup — which has no reason to
|
||||||
// API is absent — which is why the popup, with no reason to touch the delta,
|
// touch the delta — does not fail to load where the API is absent.
|
||||||
// loads fine without it.
|
function storageApi() {
|
||||||
|
if (typeof browser !== "undefined" && browser.storage) {
|
||||||
|
return browser.storage.local;
|
||||||
|
}
|
||||||
|
if (typeof chrome !== "undefined" && chrome.storage) {
|
||||||
|
return chrome.storage.local;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sanitise a timestamp read back from storage.
|
* Sanitise a timestamp read back from storage.
|
||||||
@@ -79,7 +86,7 @@ function sanitizeTimestamp(value) {
|
|||||||
* @returns {Promise<void>}
|
* @returns {Promise<void>}
|
||||||
*/
|
*/
|
||||||
async function loadDeltaFromStorage() {
|
async function loadDeltaFromStorage() {
|
||||||
const storage = storageLocal();
|
const storage = storageApi();
|
||||||
if (!storage) return;
|
if (!storage) return;
|
||||||
try {
|
try {
|
||||||
const result = await storage.get(DELTA_STORAGE_KEY);
|
const result = await storage.get(DELTA_STORAGE_KEY);
|
||||||
@@ -115,7 +122,7 @@ function ensureDeltaLoaded() {
|
|||||||
* @returns {Promise<void>}
|
* @returns {Promise<void>}
|
||||||
*/
|
*/
|
||||||
async function saveDeltaToStorage() {
|
async function saveDeltaToStorage() {
|
||||||
const storage = storageLocal();
|
const storage = storageApi();
|
||||||
if (!storage) return;
|
if (!storage) return;
|
||||||
try {
|
try {
|
||||||
const data = {
|
const data = {
|
||||||
|
|||||||
@@ -2,10 +2,11 @@
|
|||||||
|
|
||||||
const { DEFAULT_RPC_URL, DEFAULT_BLOCKSCOUT_URL } = require("./constants");
|
const { DEFAULT_RPC_URL, DEFAULT_BLOCKSCOUT_URL } = require("./constants");
|
||||||
const { networkById } = require("./networks");
|
const { networkById } = require("./networks");
|
||||||
// Dependency-free constant module; safe to pull into a background bundle.
|
|
||||||
const { RESTORABLE_VIEWS } = require("../popup/restorableViews");
|
|
||||||
|
|
||||||
const { storageGet, storageSet } = require("./browserApi");
|
const storageApi =
|
||||||
|
typeof browser !== "undefined"
|
||||||
|
? browser.storage.local
|
||||||
|
: chrome.storage.local;
|
||||||
|
|
||||||
const DEFAULT_STATE = {
|
const DEFAULT_STATE = {
|
||||||
hasWallet: false,
|
hasWallet: false,
|
||||||
@@ -42,39 +43,6 @@ const state = {
|
|||||||
viewStack: [],
|
viewStack: [],
|
||||||
};
|
};
|
||||||
|
|
||||||
// Keep only the leading run of stored views the popup is willing to render.
|
|
||||||
//
|
|
||||||
// restoreView() refuses to reopen ONTO a non-restorable view, but the stack
|
|
||||||
// behind it used to be restored verbatim, so Back could walk onto a screen
|
|
||||||
// whose content is deliberately never re-rendered — and "show-phrase" has no
|
|
||||||
// Back control to leave by. Truncating at the first such entry instead of
|
|
||||||
// splicing it out keeps the result a prefix of the stored stack, so every
|
|
||||||
// surviving entry's Back target is exactly the one it had; splicing would
|
|
||||||
// silently re-point the entry above the hole at a different screen.
|
|
||||||
//
|
|
||||||
// Filtering happens here on load rather than in saveState(): the live
|
|
||||||
// in-session stack is legitimate (the screen really is rendered while the
|
|
||||||
// popup is open), and only a load-side filter also repairs the stacks
|
|
||||||
// already in storage, including ones written before a view left the set.
|
|
||||||
function restorableStack(stored, currentView) {
|
|
||||||
// A stored stack that is missing or not an array keeps nothing, but it
|
|
||||||
// still goes through the never-empty rule below rather than returning
|
|
||||||
// early: otherwise a corrupt stack would depend on exactly the goBack()
|
|
||||||
// fallback that the explicit ["main"] exists in order not to depend on.
|
|
||||||
const source = Array.isArray(stored) ? stored : [];
|
|
||||||
const cut = source.findIndex((view) => !RESTORABLE_VIEWS.has(view));
|
|
||||||
const kept = cut === -1 ? source.slice() : source.slice(0, cut);
|
|
||||||
// A view restored below the root still needs somewhere for Back to go.
|
|
||||||
if (
|
|
||||||
kept.length === 0 &&
|
|
||||||
currentView !== "main" &&
|
|
||||||
RESTORABLE_VIEWS.has(currentView)
|
|
||||||
) {
|
|
||||||
return ["main"];
|
|
||||||
}
|
|
||||||
return kept;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Return the network configuration for the currently selected network.
|
// Return the network configuration for the currently selected network.
|
||||||
function currentNetwork() {
|
function currentNetwork() {
|
||||||
return networkById(state.networkId);
|
return networkById(state.networkId);
|
||||||
@@ -111,11 +79,11 @@ async function saveState() {
|
|||||||
viewData: state.viewData,
|
viewData: state.viewData,
|
||||||
viewStack: state.viewStack,
|
viewStack: state.viewStack,
|
||||||
};
|
};
|
||||||
await storageSet({ autistmask: persisted });
|
await storageApi.set({ autistmask: persisted });
|
||||||
}
|
}
|
||||||
|
|
||||||
async function loadState() {
|
async function loadState() {
|
||||||
const result = await storageGet("autistmask");
|
const result = await storageApi.get("autistmask");
|
||||||
if (result.autistmask) {
|
if (result.autistmask) {
|
||||||
const saved = result.autistmask;
|
const saved = result.autistmask;
|
||||||
state.wallets = saved.wallets || [];
|
state.wallets = saved.wallets || [];
|
||||||
@@ -182,7 +150,7 @@ async function loadState() {
|
|||||||
saved.selectedAddress !== undefined ? saved.selectedAddress : null;
|
saved.selectedAddress !== undefined ? saved.selectedAddress : null;
|
||||||
state.selectedToken = saved.selectedToken || null;
|
state.selectedToken = saved.selectedToken || null;
|
||||||
state.viewData = saved.viewData || {};
|
state.viewData = saved.viewData || {};
|
||||||
state.viewStack = restorableStack(saved.viewStack, state.currentView);
|
state.viewStack = Array.isArray(saved.viewStack) ? saved.viewStack : [];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -8,23 +8,11 @@
|
|||||||
// either verdict alone, because the balance list is where the user forms
|
// either verdict alone, because the balance list is where the user forms
|
||||||
// their belief about what they own (issue #235).
|
// their belief about what they own (issue #235).
|
||||||
//
|
//
|
||||||
// KNOWN_SYMBOLS maps a symbol to the set of lowercased contract addresses
|
// KNOWN_SYMBOLS maps a symbol to the lowercased contract address that may
|
||||||
// that may bear it, or to null. Null means the symbol belongs to the native
|
// bear it, or to null. Null means the symbol belongs to the native asset,
|
||||||
// asset, which has no contract at all, so no contract may bear it and every
|
// which has no contract at all, so no contract may bear it and every one
|
||||||
// one that does is a spoof. "ETH" is the only such entry today; the rule is
|
// that does is a spoof. "ETH" is the only such entry today; the rule is
|
||||||
// written so that a second one needs no change here or at any call site.
|
// written so that a second one needs no change here or at any call site.
|
||||||
//
|
|
||||||
// The value is a set because a ticker is not unique: seven symbols in the
|
|
||||||
// bundled list belong to two real contracts each, and answering with one of
|
|
||||||
// them hid the other one's holders' money (issue #276). Membership, not
|
|
||||||
// equality, is therefore the question — but it is the same question, asked of
|
|
||||||
// a table that can now state the truth. Every address in a set is one the
|
|
||||||
// wallet ships as a real token; a contract outside the set is still a spoof.
|
|
||||||
//
|
|
||||||
// The symbol is attacker-controlled — it is whatever the ERC-20 contract
|
|
||||||
// returns — so the lookup is done on a normalized form (issue #260): the
|
|
||||||
// question is whether the symbol reaches the user's eye as a known one,
|
|
||||||
// since that is what the user acts on.
|
|
||||||
|
|
||||||
const { KNOWN_SYMBOLS } = require("./tokenList");
|
const { KNOWN_SYMBOLS } = require("./tokenList");
|
||||||
|
|
||||||
@@ -34,59 +22,6 @@ function normalizeAddress(addr) {
|
|||||||
return (addr || "").toLowerCase();
|
return (addr || "").toLowerCase();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Fold a symbol onto what a user actually sees, and no further:
|
|
||||||
//
|
|
||||||
// NFKC collapses compatibility variants that render as the ASCII
|
|
||||||
// letters they imitate — fullwidth ETH, styled mathematical
|
|
||||||
// letters — and maps the non-ASCII spaces onto U+0020.
|
|
||||||
// strip drops what paints nothing: \p{Cf} plus
|
|
||||||
// \p{Default_Ignorable_Code_Point} plus U+007F. That covers
|
|
||||||
// the format characters (zero-width space, joiner and
|
|
||||||
// non-joiner, word joiner, soft hyphen, byte-order mark, bidi
|
|
||||||
// marks and overrides), the variation selectors, the Hangul
|
|
||||||
// fillers, and DELETE. Removed everywhere, not merely at the
|
|
||||||
// ends.
|
|
||||||
// trim removes surrounding whitespace, which HTML collapses:
|
|
||||||
// `" ETH "` is painted next to the user's real ETH as `ETH`.
|
|
||||||
// toUpperCase makes the comparison case-insensitive, as before.
|
|
||||||
//
|
|
||||||
// The rule is "strip what paints nothing". The Unicode classes are how
|
|
||||||
// that is spelled, not what it means, which is why U+007F is named on its
|
|
||||||
// own: it is a control rather than a default-ignorable character, so no
|
|
||||||
// class here reaches it, yet it paints nothing all the same. Measured in
|
|
||||||
// the repo's pinned e2e Chromium (16px sans-serif, plain `ETH` = 32.00px,
|
|
||||||
// so an invisible prefix leaves 32.00px):
|
|
||||||
//
|
|
||||||
// U+007F, U+3164, U+115F, U+FE0F, U+FE00 32.00px — invisible
|
|
||||||
// U+FFA0 40.00px — a box
|
|
||||||
// U+1160 48.00px — a box
|
|
||||||
// U+0001, U+0085, U+0090 48.00px — a box
|
|
||||||
//
|
|
||||||
// U+1160 and U+FFA0 are `Default_Ignorable_Code_Point` members that font
|
|
||||||
// fallback nonetheless draws, and they are stripped anyway: erring toward
|
|
||||||
// hiding a token that does not look like `ETH` is the harmless direction of
|
|
||||||
// the two. The other controls are left alone for the same reason read the
|
|
||||||
// other way — a symbol carrying a visible box does not reach the eye as
|
|
||||||
// `ETH`, so filtering it would hide a token the user could not have
|
|
||||||
// confused with the native asset.
|
|
||||||
//
|
|
||||||
// Deliberately not folded, and asserted as open in tests/symbolSpoof.test.js:
|
|
||||||
// interior whitespace (`E T H` renders as `E T H`, so folding it would filter
|
|
||||||
// a token nobody could confuse with the native asset), confusables that are
|
|
||||||
// distinct letters rather than compatibility variants (Cyrillic capital Ie,
|
|
||||||
// U+0415; Greek capital Epsilon, U+0395), bidi reordering, which needs the
|
|
||||||
// bidi algorithm rather than a character filter, and the visible controls.
|
|
||||||
//
|
|
||||||
// This decides only how the question is asked. Nothing here changes what a
|
|
||||||
// surface displays; a token still shows the symbol it reports.
|
|
||||||
function normalizeSymbol(symbol) {
|
|
||||||
return String(symbol || "")
|
|
||||||
.normalize("NFKC")
|
|
||||||
.replace(/[\p{Cf}\p{Default_Ignorable_Code_Point}\x7F]/gu, "")
|
|
||||||
.trim()
|
|
||||||
.toUpperCase();
|
|
||||||
}
|
|
||||||
|
|
||||||
// True when a token bearing `symbol` from contract `contractAddress` is
|
// True when a token bearing `symbol` from contract `contractAddress` is
|
||||||
// impersonating a known symbol.
|
// impersonating a known symbol.
|
||||||
//
|
//
|
||||||
@@ -96,11 +31,11 @@ function normalizeSymbol(symbol) {
|
|||||||
function isSpoofedSymbol(symbol, contractAddress) {
|
function isSpoofedSymbol(symbol, contractAddress) {
|
||||||
const contract = normalizeAddress(contractAddress);
|
const contract = normalizeAddress(contractAddress);
|
||||||
if (!contract) return false;
|
if (!contract) return false;
|
||||||
const sym = normalizeSymbol(symbol);
|
const sym = (symbol || "").toUpperCase();
|
||||||
if (!KNOWN_SYMBOLS.has(sym)) return false;
|
if (!KNOWN_SYMBOLS.has(sym)) return false;
|
||||||
const legit = KNOWN_SYMBOLS.get(sym);
|
const legit = KNOWN_SYMBOLS.get(sym);
|
||||||
if (legit === null) return true;
|
if (legit === null) return true;
|
||||||
return !legit.has(contract);
|
return contract !== normalizeAddress(legit);
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
|||||||
@@ -3607,33 +3607,14 @@ for (const t of TOKENS) {
|
|||||||
TOKEN_BY_ADDRESS.set(t.address.toLowerCase(), t);
|
TOKEN_BY_ADDRESS.set(t.address.toLowerCase(), t);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Build a map of symbol (uppercased) -> the set of contract addresses
|
// Build a map of symbol (uppercased) -> legitimate contract address (lowercased).
|
||||||
// (lowercased) that legitimately bear it. Used for spoofed-symbol detection.
|
// Used for spoofed-symbol detection. "ETH" maps to null (native token).
|
||||||
// "ETH" maps to null: the native asset has no contract, so no contract may
|
|
||||||
// bear its symbol.
|
|
||||||
//
|
|
||||||
// The value is a set and not a single address because tickers are not unique
|
|
||||||
// and the list above proves it: seven of these 512 tokens share a symbol with
|
|
||||||
// another entry — FRAX, REUSD, TON, EURE, MSUSD, MUSD and JPYC — at two
|
|
||||||
// different real contracts each, all of them from the same source fetch. A
|
|
||||||
// one-address-per-symbol table can only answer that by picking a winner, and
|
|
||||||
// the loser is then a token in our own bundled list that the spoof filter
|
|
||||||
// hides from the balance list, the history and the send selector at its own
|
|
||||||
// address, so the user cannot spend it (issue #276). Naming every address
|
|
||||||
// that bears the symbol is the only shape that says what is true; it does not
|
|
||||||
// loosen the rule, because a contract outside the set is still a spoof.
|
|
||||||
const KNOWN_SYMBOLS = new Map();
|
const KNOWN_SYMBOLS = new Map();
|
||||||
KNOWN_SYMBOLS.set("ETH", null);
|
KNOWN_SYMBOLS.set("ETH", null);
|
||||||
for (const t of TOKENS) {
|
for (const t of TOKENS) {
|
||||||
const upper = t.symbol.toUpperCase();
|
const upper = t.symbol.toUpperCase();
|
||||||
if (!KNOWN_SYMBOLS.has(upper)) {
|
if (!KNOWN_SYMBOLS.has(upper)) {
|
||||||
KNOWN_SYMBOLS.set(upper, new Set());
|
KNOWN_SYMBOLS.set(upper, t.address.toLowerCase());
|
||||||
}
|
|
||||||
const addresses = KNOWN_SYMBOLS.get(upper);
|
|
||||||
// A null entry is the native asset and stays null: an ERC-20 that reports
|
|
||||||
// the native symbol does not thereby become entitled to it.
|
|
||||||
if (addresses !== null) {
|
|
||||||
addresses.add(t.address.toLowerCase());
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
// Wallet and address deletion state transitions, kept out of the views so the
|
// Wallet and address deletion state transitions, kept out of the views so the
|
||||||
// selection and broadcast rules are testable without a DOM.
|
// selection and broadcast rules are testable without a DOM.
|
||||||
|
|
||||||
const { notify } = require("./browserApi");
|
|
||||||
|
|
||||||
// Two records of the same address can be stored in different cases, so
|
// Two records of the same address can be stored in different cases, so
|
||||||
// address equality is never a literal string comparison.
|
// address equality is never a literal string comparison.
|
||||||
function sameAddress(a, b) {
|
function sameAddress(a, b) {
|
||||||
@@ -146,7 +144,9 @@ function removeAddressFromState(state, walletIdx, addrIdx) {
|
|||||||
// accountsChanged to connected sites. Same call shape as the address
|
// accountsChanged to connected sites. Same call shape as the address
|
||||||
// switch in the home view.
|
// switch in the home view.
|
||||||
function broadcastActiveChanged() {
|
function broadcastActiveChanged() {
|
||||||
notify({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
const runtime =
|
||||||
|
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||||
|
runtime.sendMessage({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
|||||||
@@ -1,309 +0,0 @@
|
|||||||
// Preparation of the transaction the approval screen displays.
|
|
||||||
//
|
|
||||||
// This is the half of the fix that makes the verification in
|
|
||||||
// approvalVerify.test.js mean anything: the numbers the user reads have to be
|
|
||||||
// produced before the screen is drawn and be the numbers that get signed. What
|
|
||||||
// is asserted here is that the object leaving this module is complete (nothing
|
|
||||||
// is left for the popup to fill in), that it survives the messaging boundary
|
|
||||||
// (extension messaging is JSON, which has no bigint), and that nothing the
|
|
||||||
// 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 {
|
|
||||||
prepareApprovalTx,
|
|
||||||
serializeApprovedTx,
|
|
||||||
POPULATE_TIMEOUT_MS,
|
|
||||||
} = require("../src/shared/approvalTx");
|
|
||||||
const {
|
|
||||||
SERIALIZED_FIELDS,
|
|
||||||
MAX_FEE_PER_GAS,
|
|
||||||
MAX_GAS_LIMIT,
|
|
||||||
} = require("../src/shared/approvalVerify");
|
|
||||||
|
|
||||||
const SIGNER_KEY =
|
|
||||||
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
|
||||||
const signer = new Wallet(SIGNER_KEY);
|
|
||||||
const RECIPIENT = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
|
||||||
|
|
||||||
// The ordinary dApp request: recipient, value, call data, and nothing else.
|
|
||||||
const TX_PARAMS = {
|
|
||||||
from: signer.address,
|
|
||||||
to: RECIPIENT,
|
|
||||||
value: "0x2386f26fc10000",
|
|
||||||
data: "0xdeadbeef",
|
|
||||||
};
|
|
||||||
|
|
||||||
function providerWith(overrides) {
|
|
||||||
return {
|
|
||||||
getNetwork: async () => Network.from(1),
|
|
||||||
getTransactionCount: async () => 7,
|
|
||||||
estimateGas: async () => 21000n,
|
|
||||||
getFeeData: async () => ({
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: 2000000000n,
|
|
||||||
maxPriorityFeePerGas: 1000000000n,
|
|
||||||
}),
|
|
||||||
...(overrides || {}),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// A node that only quotes a flat gas price, so populateTransaction produces a
|
|
||||||
// legacy transaction rather than an EIP-1559 one.
|
|
||||||
const legacyProvider = providerWith({
|
|
||||||
getFeeData: async () => ({
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: null,
|
|
||||||
maxPriorityFeePerGas: null,
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("prepareApprovalTx", () => {
|
|
||||||
test("fills in everything the request left out", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
TX_PARAMS,
|
|
||||||
);
|
|
||||||
expect(approved).toEqual({
|
|
||||||
type: 2,
|
|
||||||
from: signer.address,
|
|
||||||
chainId: "0x1",
|
|
||||||
nonce: "0x7",
|
|
||||||
gasLimit: "0x5208",
|
|
||||||
maxPriorityFeePerGas: "0x3b9aca00",
|
|
||||||
maxFeePerGas: "0x77359400",
|
|
||||||
to: RECIPIENT,
|
|
||||||
value: TX_PARAMS.value,
|
|
||||||
data: TX_PARAMS.data,
|
|
||||||
accessList: [],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// The object is displayed, signed and verified against on the far side of
|
|
||||||
// chrome.runtime.sendMessage, which is JSON: a bigint would throw on the
|
|
||||||
// way out and a field that did not survive the trip would be a field the
|
|
||||||
// user was shown and nothing compared.
|
|
||||||
test("survives the messaging boundary unchanged", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
TX_PARAMS,
|
|
||||||
);
|
|
||||||
expect(JSON.parse(JSON.stringify(approved))).toEqual(approved);
|
|
||||||
for (const value of Object.values(approved)) {
|
|
||||||
expect(typeof value).not.toBe("bigint");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("carries exactly the fields its type serializes, and the signer", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
TX_PARAMS,
|
|
||||||
);
|
|
||||||
expect(Object.keys(approved).sort()).toEqual(
|
|
||||||
["type", "from", ...SERIALIZED_FIELDS[2]].sort(),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("produces a legacy transaction when that is all the node quotes", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
legacyProvider,
|
|
||||||
signer.address,
|
|
||||||
TX_PARAMS,
|
|
||||||
);
|
|
||||||
expect(approved.type).toBe(0);
|
|
||||||
expect(approved.gasPrice).toBe("0x77359400");
|
|
||||||
expect(approved.maxFeePerGas).toBeUndefined();
|
|
||||||
expect(Object.keys(approved).sort()).toEqual(
|
|
||||||
["type", "from", ...SERIALIZED_FIELDS[0]].sort(),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("keeps a nonce, gas limit and fee the request did fix", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
{
|
|
||||||
...TX_PARAMS,
|
|
||||||
nonce: "0x2",
|
|
||||||
gasLimit: "0x30d40",
|
|
||||||
maxFeePerGas: "0x12a05f200",
|
|
||||||
maxPriorityFeePerGas: "0x3b9aca00",
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(approved.nonce).toBe("0x2");
|
|
||||||
expect(approved.gasLimit).toBe("0x30d40");
|
|
||||||
expect(approved.maxFeePerGas).toBe("0x12a05f200");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("carries an access list the request asked for", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
{
|
|
||||||
...TX_PARAMS,
|
|
||||||
accessList: [{ address: RECIPIENT, storageKeys: [] }],
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(approved.accessList).toEqual([
|
|
||||||
{ address: RECIPIENT, storageKeys: [] },
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The request is page-controlled. Anything this wallet does not act on is
|
|
||||||
// dropped before ethers sees it, so a field a future ethers learns to
|
|
||||||
// carry cannot be picked up out of it without this module knowing.
|
|
||||||
test("drops request fields this wallet does not act on", async () => {
|
|
||||||
const approved = await prepareApprovalTx(
|
|
||||||
providerWith(),
|
|
||||||
signer.address,
|
|
||||||
{
|
|
||||||
...TX_PARAMS,
|
|
||||||
authorizationList: [{ address: RECIPIENT }],
|
|
||||||
blobVersionedHashes: ["0x01" + "ab".repeat(31)],
|
|
||||||
customData: { anything: true },
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(approved.authorizationList).toBeUndefined();
|
|
||||||
expect(approved.blobVersionedHashes).toBeUndefined();
|
|
||||||
expect(approved.customData).toBeUndefined();
|
|
||||||
expect(approved.type).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refuses a transaction type this wallet does not sign", async () => {
|
|
||||||
await expect(
|
|
||||||
prepareApprovalTx(providerWith(), signer.address, {
|
|
||||||
...TX_PARAMS,
|
|
||||||
type: 4,
|
|
||||||
}),
|
|
||||||
).rejects.toThrow(/type this wallet does not sign/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refuses to raise an approval with no active address", async () => {
|
|
||||||
await expect(
|
|
||||||
prepareApprovalTx(providerWith(), null, TX_PARAMS),
|
|
||||||
).rejects.toThrow(/no active address/);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The ceilings as a backstop: equality with the screen cannot bound what
|
|
||||||
// the node talks the wallet into putting on the screen, so it is refused
|
|
||||||
// before the user is shown anything.
|
|
||||||
test("refuses a fee the node quoted above the ceiling", async () => {
|
|
||||||
const gouging = providerWith({
|
|
||||||
getFeeData: async () => ({
|
|
||||||
gasPrice: MAX_FEE_PER_GAS + 1n,
|
|
||||||
maxFeePerGas: MAX_FEE_PER_GAS + 1n,
|
|
||||||
maxPriorityFeePerGas: 1000000000n,
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
await expect(
|
|
||||||
prepareApprovalTx(gouging, signer.address, TX_PARAMS),
|
|
||||||
).rejects.toThrow(/fee per gas far above any plausible value/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refuses a gas limit the node estimated above the ceiling", async () => {
|
|
||||||
const absurd = providerWith({
|
|
||||||
estimateGas: async () => MAX_GAS_LIMIT + 1n,
|
|
||||||
});
|
|
||||||
await expect(
|
|
||||||
prepareApprovalTx(absurd, signer.address, TX_PARAMS),
|
|
||||||
).rejects.toThrow(/gas limit no network this wallet supports/);
|
|
||||||
});
|
|
||||||
|
|
||||||
// No approval and no window: the failure goes back to the page the click
|
|
||||||
// came from, in a sentence.
|
|
||||||
test("reports a failed estimate as a full sentence", async () => {
|
|
||||||
const reverting = providerWith({
|
|
||||||
estimateGas: async () => {
|
|
||||||
throw new Error("execution reverted: ERC20: transfer amount");
|
|
||||||
},
|
|
||||||
});
|
|
||||||
let thrown;
|
|
||||||
try {
|
|
||||||
await prepareApprovalTx(reverting, signer.address, TX_PARAMS);
|
|
||||||
} catch (e) {
|
|
||||||
thrown = e;
|
|
||||||
}
|
|
||||||
expect(thrown.message).toMatch(
|
|
||||||
/^The transaction could not be prepared/,
|
|
||||||
);
|
|
||||||
expect(thrown.message).toMatch(/execution reverted/);
|
|
||||||
expect(thrown.message).toMatch(/^[A-Z].*\.$/);
|
|
||||||
});
|
|
||||||
|
|
||||||
// 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 () => {
|
|
||||||
jest.useFakeTimers();
|
|
||||||
try {
|
|
||||||
const hanging = providerWith({
|
|
||||||
estimateGas: () => new Promise(() => {}),
|
|
||||||
});
|
|
||||||
const pending = prepareApprovalTx(
|
|
||||||
hanging,
|
|
||||||
signer.address,
|
|
||||||
TX_PARAMS,
|
|
||||||
);
|
|
||||||
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", () => {
|
|
||||||
// Unreachable through prepareApprovalTx while the request type is checked
|
|
||||||
// first, which is what it is for: a node or an ethers upgrade that
|
|
||||||
// populates a type this wallet does not sign must not produce an approval.
|
|
||||||
test("refuses a populated transaction of a type this wallet does not sign", () => {
|
|
||||||
expect(() =>
|
|
||||||
serializeApprovedTx(
|
|
||||||
{ type: 3, to: RECIPIENT, nonce: 7 },
|
|
||||||
signer.address,
|
|
||||||
),
|
|
||||||
).toThrow(/type this wallet does not sign/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("refuses a populated transaction missing a quantity", () => {
|
|
||||||
expect(() =>
|
|
||||||
serializeApprovedTx(
|
|
||||||
{
|
|
||||||
type: 2,
|
|
||||||
chainId: 1n,
|
|
||||||
nonce: 7,
|
|
||||||
gasLimit: 21000n,
|
|
||||||
maxFeePerGas: 2000000000n,
|
|
||||||
to: RECIPIENT,
|
|
||||||
value: 0n,
|
|
||||||
data: "0x",
|
|
||||||
},
|
|
||||||
signer.address,
|
|
||||||
),
|
|
||||||
).toThrow(/did not supply a maxPriorityFeePerGas/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("keeps a contract creation's absent recipient absent", () => {
|
|
||||||
const approved = serializeApprovedTx(
|
|
||||||
{
|
|
||||||
type: 0,
|
|
||||||
chainId: 1n,
|
|
||||||
nonce: 7,
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
gasLimit: 21000n,
|
|
||||||
to: null,
|
|
||||||
value: 0n,
|
|
||||||
data: "0x600160005500",
|
|
||||||
},
|
|
||||||
signer.address,
|
|
||||||
);
|
|
||||||
expect(approved.to).toBeNull();
|
|
||||||
expect(approved.value).toBe("0x0");
|
|
||||||
expect(approved.data).toBe("0x600160005500");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -11,7 +11,6 @@ const {
|
|||||||
assertNoForbiddenFields,
|
assertNoForbiddenFields,
|
||||||
assertNothingUnchecked,
|
assertNothingUnchecked,
|
||||||
assertCanonicalBytes,
|
assertCanonicalBytes,
|
||||||
assertWithinCeilings,
|
|
||||||
sameAddress,
|
sameAddress,
|
||||||
failureIsRetryable,
|
failureIsRetryable,
|
||||||
describeTxFailure,
|
describeTxFailure,
|
||||||
@@ -19,14 +18,12 @@ const {
|
|||||||
ALLOWED_TX_TYPES,
|
ALLOWED_TX_TYPES,
|
||||||
SERIALIZED_FIELDS,
|
SERIALIZED_FIELDS,
|
||||||
FORBIDDEN_FIELDS,
|
FORBIDDEN_FIELDS,
|
||||||
APPROVED_FIELDS,
|
|
||||||
TX_STAGE_SIGN,
|
TX_STAGE_SIGN,
|
||||||
TX_STAGE_VERIFY,
|
TX_STAGE_VERIFY,
|
||||||
TX_STAGE_BROADCAST,
|
TX_STAGE_BROADCAST,
|
||||||
MAX_GAS_LIMIT,
|
MAX_GAS_LIMIT,
|
||||||
MAX_FEE_PER_GAS,
|
MAX_FEE_PER_GAS,
|
||||||
} = require("../src/shared/approvalVerify");
|
} = require("../src/shared/approvalVerify");
|
||||||
const { prepareApprovalTx } = require("../src/shared/approvalTx");
|
|
||||||
const { getSignerForAddress } = require("../src/shared/wallet");
|
const { getSignerForAddress } = require("../src/shared/wallet");
|
||||||
|
|
||||||
// Fixed test keys — never used for anything but these tests.
|
// Fixed test keys — never used for anything but these tests.
|
||||||
@@ -45,10 +42,7 @@ const OTHER_RECIPIENT = "0xdAC17F958D2ee523a2206206994597C13D831ec7";
|
|||||||
const SELECTED = "0x1";
|
const SELECTED = "0x1";
|
||||||
const SEPOLIA = "0xaa36a7";
|
const SEPOLIA = "0xaa36a7";
|
||||||
|
|
||||||
// Parameters as a dApp would supply them over eth_sendTransaction. Note what
|
// Approved parameters as a dApp would supply them over eth_sendTransaction.
|
||||||
// is missing: nonce, gas limit and fees. The background fills those in before
|
|
||||||
// the approval screen is drawn, which is why the approval below and not this
|
|
||||||
// object is what every comparison runs against.
|
|
||||||
const TX_PARAMS = {
|
const TX_PARAMS = {
|
||||||
from: signer.address,
|
from: signer.address,
|
||||||
to: RECIPIENT,
|
to: RECIPIENT,
|
||||||
@@ -67,8 +61,8 @@ const POPULATED = {
|
|||||||
type: 2,
|
type: 2,
|
||||||
};
|
};
|
||||||
|
|
||||||
// Build a signable transaction from a request. The background populates the
|
// Build a signable transaction from approved params. The popup does the same
|
||||||
// same fields through populateTransaction(); here they are fixed so the test
|
// thing through populateTransaction(); here the fields are fixed so the test
|
||||||
// needs no provider. `overrides` stands in for what a tampered or misbuilt
|
// needs no provider. `overrides` stands in for what a tampered or misbuilt
|
||||||
// popup would put on the wire.
|
// popup would put on the wire.
|
||||||
function txFor(params, overrides) {
|
function txFor(params, overrides) {
|
||||||
@@ -81,21 +75,6 @@ function txFor(params, overrides) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// The populated transaction the approval screen displayed, which is the object
|
|
||||||
// the artifact is verified against. Built from the same fields as the signable
|
|
||||||
// transaction above, because that is the point: displayed and verified are one
|
|
||||||
// object.
|
|
||||||
function approvedFor(params, overrides) {
|
|
||||||
return {
|
|
||||||
from: signer.address,
|
|
||||||
accessList: [],
|
|
||||||
...txFor(params, overrides),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// The ordinary case: the dApp's request, populated.
|
|
||||||
const APPROVED = approvedFor(TX_PARAMS);
|
|
||||||
|
|
||||||
async function signedFor(params, withWallet, overrides) {
|
async function signedFor(params, withWallet, overrides) {
|
||||||
return (withWallet || signer).signTransaction(txFor(params, overrides));
|
return (withWallet || signer).signTransaction(txFor(params, overrides));
|
||||||
}
|
}
|
||||||
@@ -129,7 +108,7 @@ describe("sameAddress", () => {
|
|||||||
describe("verifySignedTx", () => {
|
describe("verifySignedTx", () => {
|
||||||
test("accepts the approved transaction signed by the approved address", async () => {
|
test("accepts the approved transaction signed by the approved address", async () => {
|
||||||
const raw = await signedFor(TX_PARAMS);
|
const raw = await signedFor(TX_PARAMS);
|
||||||
const parsed = verifySignedTx(raw, APPROVED, signer.address, SELECTED);
|
const parsed = verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED);
|
||||||
expect(parsed.from).toBe(signer.address);
|
expect(parsed.from).toBe(signer.address);
|
||||||
expect(parsed.hash).toBe(Transaction.from(raw).hash);
|
expect(parsed.hash).toBe(Transaction.from(raw).hash);
|
||||||
});
|
});
|
||||||
@@ -138,23 +117,23 @@ describe("verifySignedTx", () => {
|
|||||||
const params = { to: undefined, value: "0x0", data: "0x600160005500" };
|
const params = { to: undefined, value: "0x0", data: "0x600160005500" };
|
||||||
const raw = await signedFor(params);
|
const raw = await signedFor(params);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approvedFor(params), signer.address, SELECTED),
|
verifySignedTx(raw, params, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("accepts an absent value as zero", async () => {
|
test("accepts an absent value as zero", async () => {
|
||||||
const params = { to: RECIPIENT, data: "0x" };
|
const approved = { to: RECIPIENT, data: "0x" };
|
||||||
const raw = await signedFor(params);
|
const raw = await signedFor(approved);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approvedFor(params), signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("accepts call data whose case differs from the approval", async () => {
|
test("accepts call data whose case differs from the approval", async () => {
|
||||||
const params = { to: RECIPIENT, value: "0x0", data: "0xDEADBEEF" };
|
const approved = { to: RECIPIENT, value: "0x0", data: "0xDEADBEEF" };
|
||||||
const raw = await signedFor(params);
|
const raw = await signedFor(approved);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approvedFor(params), signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -164,7 +143,7 @@ describe("verifySignedTx", () => {
|
|||||||
to: OTHER_RECIPIENT,
|
to: OTHER_RECIPIENT,
|
||||||
});
|
});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/approved recipient/);
|
).toThrow(/approved recipient/);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -174,64 +153,47 @@ describe("verifySignedTx", () => {
|
|||||||
value: "0x4563918244f40000",
|
value: "0x4563918244f40000",
|
||||||
});
|
});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/approved value/);
|
).toThrow(/approved value/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects substituted call data", async () => {
|
test("rejects substituted call data", async () => {
|
||||||
const raw = await signedFor({ ...TX_PARAMS, data: "0xc0ffee" });
|
const raw = await signedFor({ ...TX_PARAMS, data: "0xc0ffee" });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/approved call data/);
|
).toThrow(/approved call data/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a transaction signed by a different address", async () => {
|
test("rejects a transaction signed by a different address", async () => {
|
||||||
const raw = await signedFor(TX_PARAMS, other);
|
const raw = await signedFor(TX_PARAMS, other);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/different address/);
|
).toThrow(/different address/);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The address the approval named, not whichever address is active when the
|
|
||||||
// artifact comes back: an approval raised for one account cannot be
|
|
||||||
// satisfied by a signature from another, whatever the wallet switched to
|
|
||||||
// in between.
|
|
||||||
test("rejects a signature from the address that is active now", async () => {
|
|
||||||
const raw = await signedFor(TX_PARAMS, other);
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
|
||||||
).toThrow(/different address than the one that was approved/);
|
|
||||||
// The same artifact against the same approval, verified for the other
|
|
||||||
// address, is what would have happened had expectedFrom been read from
|
|
||||||
// the wallet's current state.
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, APPROVED, other.address, SELECTED),
|
|
||||||
).not.toThrow();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("rejects an unsigned transaction", () => {
|
test("rejects an unsigned transaction", () => {
|
||||||
const unsigned = Transaction.from(txFor(TX_PARAMS)).unsignedSerialized;
|
const unsigned = Transaction.from(txFor(TX_PARAMS)).unsignedSerialized;
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(unsigned, APPROVED, signer.address, SELECTED),
|
verifySignedTx(unsigned, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/no valid signature/);
|
).toThrow(/no valid signature/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a missing or malformed payload", () => {
|
test("rejects a missing or malformed payload", () => {
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(undefined, APPROVED, signer.address, SELECTED),
|
verifySignedTx(undefined, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/missing or malformed/);
|
).toThrow(/missing or malformed/);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx("nope", APPROVED, signer.address, SELECTED),
|
verifySignedTx("nope", TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/missing or malformed/);
|
).toThrow(/missing or malformed/);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx("0xc0ffee", APPROVED, signer.address, SELECTED),
|
verifySignedTx("0xc0ffee", TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/could not be decoded/);
|
).toThrow(/could not be decoded/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("every rejection message is a full sentence", async () => {
|
test("every rejection message is a full sentence", async () => {
|
||||||
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
||||||
try {
|
try {
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED);
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED);
|
||||||
throw new Error("expected a rejection");
|
throw new Error("expected a rejection");
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
expect(e.message).toMatch(/^[A-Z].*\.$/);
|
expect(e.message).toMatch(/^[A-Z].*\.$/);
|
||||||
@@ -239,113 +201,20 @@ describe("verifySignedTx", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// The defect this file's approvals now stand against: for every field the dApp
|
|
||||||
// left out, the old comparison had nothing to compare and skipped the field,
|
|
||||||
// so the fee and the nonce the user read off the screen were checked by the
|
|
||||||
// ceilings alone. A populated approval fixes all of them, and an approval that
|
|
||||||
// does not fix one is a refusal rather than a pass.
|
|
||||||
describe("verifySignedTx against what was displayed", () => {
|
|
||||||
test("a fee differing from the displayed one is refused", async () => {
|
|
||||||
// Ten times the fee the screen showed, and far below the ceiling: the
|
|
||||||
// artifact the old comparison would have accepted.
|
|
||||||
const inflated = 20000000000n;
|
|
||||||
expect(inflated).toBeLessThan(MAX_FEE_PER_GAS);
|
|
||||||
const raw = await signedWith({ maxFeePerGas: inflated });
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved maximum fee per gas/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a nonce differing from the displayed one is refused", async () => {
|
|
||||||
const raw = await signedWith({ nonce: 8 });
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved nonce/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a gas limit differing from the displayed one is refused", async () => {
|
|
||||||
const raw = await signedWith({ gasLimit: 250000n });
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved gas limit/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an approval fixing no quantity is refused, not waved through", async () => {
|
|
||||||
const raw = await signedWith({});
|
|
||||||
for (const key of [
|
|
||||||
"chainId",
|
|
||||||
"nonce",
|
|
||||||
"gasLimit",
|
|
||||||
"maxFeePerGas",
|
|
||||||
"maxPriorityFeePerGas",
|
|
||||||
]) {
|
|
||||||
const incomplete = { ...APPROVED };
|
|
||||||
delete incomplete[key];
|
|
||||||
let thrown;
|
|
||||||
try {
|
|
||||||
verifySignedTx(raw, incomplete, signer.address, SELECTED);
|
|
||||||
throw new Error("expected a rejection for " + key);
|
|
||||||
} catch (e) {
|
|
||||||
thrown = e;
|
|
||||||
}
|
|
||||||
expect(thrown.message).toMatch(/fixes no /);
|
|
||||||
expect(thrown.approvalMismatch).toBe(true);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("no approved transaction at all is refused", async () => {
|
|
||||||
const raw = await signedWith({});
|
|
||||||
for (const approved of [undefined, null, "0xdeadbeef"]) {
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
|
||||||
).toThrow(/no approved transaction/);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an approval fixing no transaction type is refused", async () => {
|
|
||||||
const raw = await signedWith({});
|
|
||||||
const incomplete = { ...APPROVED };
|
|
||||||
delete incomplete.type;
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, incomplete, signer.address, SELECTED),
|
|
||||||
).toThrow(/fixes no transaction type/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an artifact of a type other than the approved one is refused", async () => {
|
|
||||||
// Same fee mechanism on both sides, so only the type differs: a type 1
|
|
||||||
// artifact against a type 2 approval.
|
|
||||||
const approved = approvedFor(TX_PARAMS, {
|
|
||||||
type: 1,
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: null,
|
|
||||||
maxPriorityFeePerGas: null,
|
|
||||||
});
|
|
||||||
const raw = await signedWith({
|
|
||||||
type: 0,
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: null,
|
|
||||||
maxPriorityFeePerGas: null,
|
|
||||||
});
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved transaction type/);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// One case per consequential field: the field alone differs from what was
|
// One case per consequential field: the field alone differs from what was
|
||||||
// approved, and that alone must refuse the signature.
|
// approved, and that alone must refuse the signature.
|
||||||
describe("verifySignedTx field comparison", () => {
|
describe("verifySignedTx field comparison", () => {
|
||||||
test("rejects a chain id that is not the selected network", async () => {
|
test("rejects a chain id that is not the selected network", async () => {
|
||||||
const raw = await signedWith({ chainId: 11155111 });
|
const raw = await signedWith({ chainId: 11155111 });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/different network than the one that is selected/);
|
).toThrow(/different network than the one that is selected/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a chain id that is not the approved one", async () => {
|
test("rejects a chain id that is not the approved one", async () => {
|
||||||
// Selected network and signed chain id agree; the approval was raised
|
// Selected network and signed chain id agree; the dApp asked for a
|
||||||
// for a different chain, so the artifact is not what was approved.
|
// different chain, so the artifact is not what was approved.
|
||||||
const approved = { ...APPROVED, chainId: SEPOLIA };
|
const approved = { ...TX_PARAMS, chainId: SEPOLIA };
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
@@ -355,59 +224,58 @@ describe("verifySignedTx field comparison", () => {
|
|||||||
test("refuses when the selected network is unknown", async () => {
|
test("refuses when the selected network is unknown", async () => {
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, undefined),
|
verifySignedTx(raw, TX_PARAMS, signer.address, undefined),
|
||||||
).toThrow(/selected network is unknown/);
|
).toThrow(/selected network is unknown/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a substituted nonce", async () => {
|
test("rejects a substituted nonce", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, nonce: 7 };
|
||||||
const raw = await signedWith({ nonce: 8 });
|
const raw = await signedWith({ nonce: 8 });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved nonce/);
|
).toThrow(/approved nonce/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a substituted gas limit", async () => {
|
test("rejects a substituted gas limit", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, gasLimit: "0x186a0" };
|
||||||
const raw = await signedWith({ gasLimit: 250000n });
|
const raw = await signedWith({ gasLimit: 250000n });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved gas limit/);
|
).toThrow(/approved gas limit/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a substituted maximum fee per gas", async () => {
|
test("rejects a substituted maximum fee per gas", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, maxFeePerGas: "0x77359400" };
|
||||||
const raw = await signedWith({ maxFeePerGas: 900000000000n });
|
const raw = await signedWith({ maxFeePerGas: 900000000000n });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved maximum fee per gas/);
|
).toThrow(/approved maximum fee per gas/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a substituted maximum priority fee per gas", async () => {
|
test("rejects a substituted maximum priority fee per gas", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, maxPriorityFeePerGas: "0x3b9aca00" };
|
||||||
const raw = await signedWith({ maxPriorityFeePerGas: 1500000000n });
|
const raw = await signedWith({ maxPriorityFeePerGas: 1500000000n });
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved maximum priority fee per gas/);
|
).toThrow(/approved maximum priority fee per gas/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects a substituted legacy gas price", async () => {
|
test("rejects a substituted legacy gas price", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, gasPrice: "0x77359400" };
|
||||||
const legacy = {
|
const legacy = {
|
||||||
type: 0,
|
type: 0,
|
||||||
gasPrice: 2000000000n,
|
gasPrice: 9000000000n,
|
||||||
maxFeePerGas: null,
|
maxFeePerGas: null,
|
||||||
maxPriorityFeePerGas: null,
|
maxPriorityFeePerGas: null,
|
||||||
};
|
};
|
||||||
const approved = approvedFor(TX_PARAMS, legacy);
|
const raw = await signedWith(legacy);
|
||||||
const raw = await signedWith({ ...legacy, gasPrice: 9000000000n });
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved gas price/);
|
).toThrow(/approved gas price/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects an approved legacy fee signed as an EIP-1559 fee", async () => {
|
test("rejects an approved legacy fee signed as an EIP-1559 fee", async () => {
|
||||||
const approved = approvedFor(TX_PARAMS, {
|
const approved = { ...TX_PARAMS, gasPrice: "0x77359400" };
|
||||||
type: 0,
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: null,
|
|
||||||
maxPriorityFeePerGas: null,
|
|
||||||
});
|
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
@@ -415,6 +283,7 @@ describe("verifySignedTx field comparison", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("rejects an approved EIP-1559 fee signed as a legacy fee", async () => {
|
test("rejects an approved EIP-1559 fee signed as a legacy fee", async () => {
|
||||||
|
const approved = { ...TX_PARAMS, maxFeePerGas: "0x77359400" };
|
||||||
const raw = await signedWith({
|
const raw = await signedWith({
|
||||||
type: 0,
|
type: 0,
|
||||||
gasPrice: 2000000000n,
|
gasPrice: 2000000000n,
|
||||||
@@ -422,72 +291,36 @@ describe("verifySignedTx field comparison", () => {
|
|||||||
maxPriorityFeePerGas: null,
|
maxPriorityFeePerGas: null,
|
||||||
});
|
});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).toThrow(/approved fee mechanism/);
|
).toThrow(/approved fee mechanism/);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The ceilings are a backstop against what the RPC node can talk the
|
|
||||||
// wallet into populating and displaying, so they are checked against an
|
|
||||||
// approval that carries the absurd value too — equality alone would accept
|
|
||||||
// it, which is exactly what the ceiling is there for.
|
|
||||||
test("rejects a gas limit above anything a supported network accepts", async () => {
|
test("rejects a gas limit above anything a supported network accepts", async () => {
|
||||||
const overrides = { gasLimit: MAX_GAS_LIMIT + 1n };
|
const raw = await signedWith({ gasLimit: MAX_GAS_LIMIT + 1n });
|
||||||
const raw = await signedWith(overrides);
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
raw,
|
|
||||||
approvedFor(TX_PARAMS, overrides),
|
|
||||||
signer.address,
|
|
||||||
SELECTED,
|
|
||||||
),
|
|
||||||
).toThrow(/gas limit no network this wallet supports/);
|
).toThrow(/gas limit no network this wallet supports/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("rejects an absurd fee per gas even when it was displayed", async () => {
|
test("rejects an absurd fee per gas the approval never fixed", async () => {
|
||||||
const overrides = {
|
const raw = await signedWith({
|
||||||
maxFeePerGas: MAX_FEE_PER_GAS + 1n,
|
maxFeePerGas: MAX_FEE_PER_GAS + 1n,
|
||||||
maxPriorityFeePerGas: MAX_FEE_PER_GAS + 1n,
|
maxPriorityFeePerGas: MAX_FEE_PER_GAS + 1n,
|
||||||
};
|
});
|
||||||
const raw = await signedWith(overrides);
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
raw,
|
|
||||||
approvedFor(TX_PARAMS, overrides),
|
|
||||||
signer.address,
|
|
||||||
SELECTED,
|
|
||||||
),
|
|
||||||
).toThrow(/fee per gas far above any plausible value/);
|
).toThrow(/fee per gas far above any plausible value/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("assertWithinCeilings is the same check on either side of the screen", () => {
|
|
||||||
expect(() =>
|
|
||||||
assertWithinCeilings({ gasLimit: MAX_GAS_LIMIT + 1n }),
|
|
||||||
).toThrow(/gas limit no network this wallet supports/);
|
|
||||||
for (const key of [
|
|
||||||
"gasPrice",
|
|
||||||
"maxFeePerGas",
|
|
||||||
"maxPriorityFeePerGas",
|
|
||||||
]) {
|
|
||||||
expect(() =>
|
|
||||||
assertWithinCeilings({ [key]: MAX_FEE_PER_GAS + 1n }),
|
|
||||||
).toThrow(/fee per gas far above any plausible value/);
|
|
||||||
}
|
|
||||||
expect(() =>
|
|
||||||
assertWithinCeilings({
|
|
||||||
gasLimit: MAX_GAS_LIMIT,
|
|
||||||
maxFeePerGas: MAX_FEE_PER_GAS,
|
|
||||||
maxPriorityFeePerGas: MAX_FEE_PER_GAS,
|
|
||||||
}),
|
|
||||||
).not.toThrow();
|
|
||||||
// Nothing to bound is not a failure: a type 2 approval carries no gas
|
|
||||||
// price, and a bare object must not be refused for lacking one.
|
|
||||||
expect(() => assertWithinCeilings({})).not.toThrow();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("every field mismatch is a refusal, not a warning", async () => {
|
test("every field mismatch is a refusal, not a warning", async () => {
|
||||||
const raw = await signedWith({ nonce: 8 });
|
const raw = await signedWith({ nonce: 8 });
|
||||||
try {
|
try {
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED);
|
verifySignedTx(
|
||||||
|
raw,
|
||||||
|
{ ...TX_PARAMS, nonce: 7 },
|
||||||
|
signer.address,
|
||||||
|
SELECTED,
|
||||||
|
);
|
||||||
throw new Error("expected a rejection");
|
throw new Error("expected a rejection");
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
expect(e.approvalMismatch).toBe(true);
|
expect(e.approvalMismatch).toBe(true);
|
||||||
@@ -498,17 +331,17 @@ describe("verifySignedTx field comparison", () => {
|
|||||||
|
|
||||||
// The transaction type decides which fields exist, so an artifact of a type
|
// The transaction type decides which fields exist, so an artifact of a type
|
||||||
// this wallet does not sign carries consequences the approval cannot describe
|
// this wallet does not sign carries consequences the approval cannot describe
|
||||||
// and none of the field comparisons can see. The refusal has to come from the
|
// and none of the field comparisons can see. The approval used here is the
|
||||||
// type allowlist rather than from a field comparison, so these run against an
|
// ordinary dApp shape with no fee fields — the common case, since
|
||||||
// approval whose every other field matches the artifact exactly.
|
// populateTransaction() fills them — which is exactly the case the
|
||||||
|
// fee-mechanism check cannot catch by accident.
|
||||||
describe("verifySignedTx transaction type", () => {
|
describe("verifySignedTx transaction type", () => {
|
||||||
const BARE_REQUEST = {
|
const BARE_APPROVAL = {
|
||||||
from: signer.address,
|
from: signer.address,
|
||||||
to: RECIPIENT,
|
to: RECIPIENT,
|
||||||
value: "0x2386f26fc10000",
|
value: "0x2386f26fc10000",
|
||||||
data: "0x",
|
data: "0x",
|
||||||
};
|
};
|
||||||
const BARE_APPROVAL = approvedFor(BARE_REQUEST);
|
|
||||||
|
|
||||||
// An EIP-7702 artifact that pays the approved amount to the approved
|
// An EIP-7702 artifact that pays the approved amount to the approved
|
||||||
// recipient and, in the same transaction, installs the attacker's code at
|
// recipient and, in the same transaction, installs the attacker's code at
|
||||||
@@ -520,7 +353,7 @@ describe("verifySignedTx transaction type", () => {
|
|||||||
chainId: 1,
|
chainId: 1,
|
||||||
nonce: 8,
|
nonce: 8,
|
||||||
});
|
});
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, {
|
const raw = await signedFor(BARE_APPROVAL, signer, {
|
||||||
type: 4,
|
type: 4,
|
||||||
authorizationList: [authorization],
|
authorizationList: [authorization],
|
||||||
});
|
});
|
||||||
@@ -533,7 +366,7 @@ describe("verifySignedTx transaction type", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("refuses a type 3 blob artifact", async () => {
|
test("refuses a type 3 blob artifact", async () => {
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, {
|
const raw = await signedFor(BARE_APPROVAL, signer, {
|
||||||
type: 3,
|
type: 3,
|
||||||
maxFeePerBlobGas: 1000000000n,
|
maxFeePerBlobGas: 1000000000n,
|
||||||
blobVersionedHashes: ["0x01" + "ab".repeat(31)],
|
blobVersionedHashes: ["0x01" + "ab".repeat(31)],
|
||||||
@@ -557,7 +390,7 @@ describe("verifySignedTx transaction type", () => {
|
|||||||
chainId: 1,
|
chainId: 1,
|
||||||
nonce: 8,
|
nonce: 8,
|
||||||
});
|
});
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, {
|
const raw = await signedFor(BARE_APPROVAL, signer, {
|
||||||
type: 4,
|
type: 4,
|
||||||
authorizationList: [authorization],
|
authorizationList: [authorization],
|
||||||
});
|
});
|
||||||
@@ -571,45 +404,40 @@ describe("verifySignedTx transaction type", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("accepts a legacy type 0 transaction", async () => {
|
test("accepts a legacy type 0 transaction", async () => {
|
||||||
const legacy = {
|
const approved = { ...BARE_APPROVAL, gasPrice: "0x77359400" };
|
||||||
|
const raw = await signedFor(approved, signer, {
|
||||||
type: 0,
|
type: 0,
|
||||||
gasPrice: 2000000000n,
|
gasPrice: 2000000000n,
|
||||||
maxFeePerGas: null,
|
maxFeePerGas: null,
|
||||||
maxPriorityFeePerGas: null,
|
maxPriorityFeePerGas: null,
|
||||||
};
|
});
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, legacy);
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
raw,
|
|
||||||
approvedFor(BARE_REQUEST, legacy),
|
|
||||||
signer.address,
|
|
||||||
SELECTED,
|
|
||||||
),
|
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("accepts a type 1 transaction whose access list is the approved one", async () => {
|
test("accepts a type 1 transaction whose access list is the approved one", async () => {
|
||||||
const overrides = {
|
const accessList = [{ address: OTHER_RECIPIENT, storageKeys: [] }];
|
||||||
|
const approved = {
|
||||||
|
...BARE_APPROVAL,
|
||||||
|
gasPrice: "0x77359400",
|
||||||
|
accessList,
|
||||||
|
};
|
||||||
|
const raw = await signedFor(approved, signer, {
|
||||||
type: 1,
|
type: 1,
|
||||||
gasPrice: 2000000000n,
|
gasPrice: 2000000000n,
|
||||||
maxFeePerGas: null,
|
maxFeePerGas: null,
|
||||||
maxPriorityFeePerGas: null,
|
maxPriorityFeePerGas: null,
|
||||||
accessList: [{ address: OTHER_RECIPIENT, storageKeys: [] }],
|
accessList,
|
||||||
};
|
});
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, overrides);
|
|
||||||
expect(Transaction.from(raw).type).toBe(1);
|
expect(Transaction.from(raw).type).toBe(1);
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
raw,
|
|
||||||
approvedFor(BARE_REQUEST, overrides),
|
|
||||||
signer.address,
|
|
||||||
SELECTED,
|
|
||||||
),
|
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("refuses an access list the approval never carried", async () => {
|
test("refuses an access list the approval never carried", async () => {
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, {
|
const raw = await signedFor(BARE_APPROVAL, signer, {
|
||||||
accessList: [{ address: OTHER_RECIPIENT, storageKeys: [] }],
|
accessList: [{ address: OTHER_RECIPIENT, storageKeys: [] }],
|
||||||
});
|
});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
@@ -618,11 +446,8 @@ describe("verifySignedTx transaction type", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("treats an absent access list and an empty one as the same thing", async () => {
|
test("treats an absent access list and an empty one as the same thing", async () => {
|
||||||
const approved = { ...BARE_APPROVAL };
|
const approved = { ...BARE_APPROVAL, accessList: [] };
|
||||||
delete approved.accessList;
|
const raw = await signedFor(BARE_APPROVAL, signer, {});
|
||||||
expect(approved.accessList).toBeUndefined();
|
|
||||||
const raw = await signedFor(BARE_REQUEST, signer, {});
|
|
||||||
expect(Transaction.from(raw).accessList).toEqual([]);
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
@@ -673,25 +498,6 @@ describe("verifySignedTx exhaustiveness", () => {
|
|||||||
expect(exposed.filter((name) => !accounted.has(name))).toEqual([]);
|
expect(exposed.filter((name) => !accounted.has(name))).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The comparison loop runs over the fields a type serializes and refuses a
|
|
||||||
// field it has no comparator for. That refusal is unreachable only while
|
|
||||||
// the table covers the whole of SERIALIZED_FIELDS, so the coverage is
|
|
||||||
// pinned here rather than assumed: adding a field to a type without a
|
|
||||||
// comparator would otherwise turn every transaction of that type into a
|
|
||||||
// refusal, and adding a comparator without the field would be a check that
|
|
||||||
// never runs.
|
|
||||||
test("every field a type serializes has a comparator", () => {
|
|
||||||
const serialized = new Set(
|
|
||||||
Object.values(SERIALIZED_FIELDS).flat().sort(),
|
|
||||||
);
|
|
||||||
expect([...serialized].filter((key) => !APPROVED_FIELDS[key])).toEqual(
|
|
||||||
[],
|
|
||||||
);
|
|
||||||
expect(
|
|
||||||
Object.keys(APPROVED_FIELDS).filter((key) => !serialized.has(key)),
|
|
||||||
).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The two layers behind the type allowlist. Nothing reachable through
|
// The two layers behind the type allowlist. Nothing reachable through
|
||||||
// verifySignedTx can trip either of them while the allowlist holds — that
|
// verifySignedTx can trip either of them while the allowlist holds — that
|
||||||
// is what they are for — so they are exercised directly rather than taken
|
// is what they are for — so they are exercised directly rather than taken
|
||||||
@@ -747,30 +553,49 @@ describe("verifySignedTx exhaustiveness", () => {
|
|||||||
test("an accepted artifact of each allowed type rebuilds byte for byte", async () => {
|
test("an accepted artifact of each allowed type rebuilds byte for byte", async () => {
|
||||||
const shapes = [
|
const shapes = [
|
||||||
{
|
{
|
||||||
type: 0,
|
approved: { ...TX_PARAMS, gasPrice: "0x77359400" },
|
||||||
gasPrice: 2000000000n,
|
overrides: {
|
||||||
maxFeePerGas: null,
|
type: 0,
|
||||||
maxPriorityFeePerGas: null,
|
gasPrice: 2000000000n,
|
||||||
|
maxFeePerGas: null,
|
||||||
|
maxPriorityFeePerGas: null,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: 1,
|
approved: {
|
||||||
gasPrice: 2000000000n,
|
...TX_PARAMS,
|
||||||
maxFeePerGas: null,
|
gasPrice: "0x77359400",
|
||||||
maxPriorityFeePerGas: null,
|
accessList: [
|
||||||
accessList: [
|
{
|
||||||
{
|
address: RECIPIENT,
|
||||||
address: RECIPIENT,
|
storageKeys: ["0x" + "11".repeat(32)],
|
||||||
storageKeys: ["0x" + "11".repeat(32)],
|
},
|
||||||
},
|
],
|
||||||
],
|
},
|
||||||
|
overrides: {
|
||||||
|
type: 1,
|
||||||
|
gasPrice: 2000000000n,
|
||||||
|
maxFeePerGas: null,
|
||||||
|
maxPriorityFeePerGas: null,
|
||||||
|
accessList: [
|
||||||
|
{
|
||||||
|
address: RECIPIENT,
|
||||||
|
storageKeys: ["0x" + "11".repeat(32)],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{},
|
{ approved: TX_PARAMS, overrides: {} },
|
||||||
];
|
];
|
||||||
for (const overrides of shapes) {
|
for (const shape of shapes) {
|
||||||
const raw = await signedFor(TX_PARAMS, signer, overrides);
|
const raw = await signedFor(
|
||||||
|
shape.approved,
|
||||||
|
signer,
|
||||||
|
shape.overrides,
|
||||||
|
);
|
||||||
const parsed = verifySignedTx(
|
const parsed = verifySignedTx(
|
||||||
raw,
|
raw,
|
||||||
approvedFor(TX_PARAMS, overrides),
|
shape.approved,
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
);
|
);
|
||||||
@@ -819,7 +644,7 @@ describe("verifySignedTx canonical encoding", () => {
|
|||||||
test("refuses an artifact that is not its own canonical encoding", async () => {
|
test("refuses an artifact that is not its own canonical encoding", async () => {
|
||||||
const mutated = await nonCanonical();
|
const mutated = await nonCanonical();
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(mutated, APPROVED, signer.address, SELECTED),
|
verifySignedTx(mutated, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/not encoded canonically/);
|
).toThrow(/not encoded canonically/);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -834,7 +659,7 @@ describe("verifySignedTx canonical encoding", () => {
|
|||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
const upper = "0x" + raw.slice(2).toUpperCase();
|
const upper = "0x" + raw.slice(2).toUpperCase();
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(upper, APPROVED, signer.address, SELECTED),
|
verifySignedTx(upper, TX_PARAMS, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -845,33 +670,46 @@ describe("verifySignedTx normalization", () => {
|
|||||||
test("accepts a decimal chain id against a hex selected network", async () => {
|
test("accepts a decimal chain id against a hex selected network", async () => {
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, 1),
|
verifySignedTx(raw, TX_PARAMS, signer.address, 1),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, APPROVED, signer.address, "1"),
|
verifySignedTx(raw, TX_PARAMS, signer.address, "1"),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
// The approved transaction crosses to the popup as JSON, so it comes back
|
test("accepts an approved chain id written in hex", async () => {
|
||||||
// spelled in hex quantities rather than in the bigints it was populated
|
|
||||||
// with. None of that is tampering.
|
|
||||||
test("accepts an approval spelled as the wire spells it", async () => {
|
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
const wire = {
|
const approved = { ...TX_PARAMS, chainId: "0x1" };
|
||||||
...APPROVED,
|
|
||||||
chainId: "0x1",
|
|
||||||
nonce: "0x7",
|
|
||||||
gasLimit: "0x186a0",
|
|
||||||
maxFeePerGas: "0x77359400",
|
|
||||||
maxPriorityFeePerGas: "0x3b9aca00",
|
|
||||||
value: "0x2386f26fc10000",
|
|
||||||
};
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, wire, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("accepts quantities spelled as hex, decimal, number and bigint", async () => {
|
test("accepts a hex nonce against a numeric one", async () => {
|
||||||
|
const raw = await signedWith({ nonce: 7 });
|
||||||
|
expect(() =>
|
||||||
|
verifySignedTx(
|
||||||
|
raw,
|
||||||
|
{ ...TX_PARAMS, nonce: "0x7" },
|
||||||
|
signer.address,
|
||||||
|
SELECTED,
|
||||||
|
),
|
||||||
|
).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("accepts a decimal gas limit against a hex one", async () => {
|
||||||
|
const raw = await signedWith({ gasLimit: 100000n });
|
||||||
|
expect(() =>
|
||||||
|
verifySignedTx(
|
||||||
|
raw,
|
||||||
|
{ ...TX_PARAMS, gasLimit: "100000" },
|
||||||
|
signer.address,
|
||||||
|
SELECTED,
|
||||||
|
),
|
||||||
|
).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("accepts fee fields spelled as hex, decimal, number and bigint", async () => {
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
for (const maxFee of [
|
for (const maxFee of [
|
||||||
"0x77359400",
|
"0x77359400",
|
||||||
@@ -882,7 +720,7 @@ describe("verifySignedTx normalization", () => {
|
|||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(
|
||||||
raw,
|
raw,
|
||||||
{ ...APPROVED, maxFeePerGas: maxFee },
|
{ ...TX_PARAMS, maxFeePerGas: maxFee },
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
),
|
),
|
||||||
@@ -890,19 +728,24 @@ describe("verifySignedTx normalization", () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("accepts an approval that fixes no nonce, gas or fee at all", async () => {
|
||||||
|
const raw = await signedWith({});
|
||||||
|
expect(() =>
|
||||||
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED),
|
||||||
|
).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
test("accepts an approval whose recipient case differs", async () => {
|
test("accepts an approval whose recipient case differs", async () => {
|
||||||
const raw = await signedWith({});
|
const raw = await signedWith({});
|
||||||
const approved = { ...APPROVED, to: RECIPIENT.toLowerCase() };
|
const approved = { ...TX_PARAMS, to: RECIPIENT.toLowerCase() };
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("accepts absent call data against 0x", async () => {
|
test("accepts absent call data against 0x", async () => {
|
||||||
const params = { to: RECIPIENT, value: "0x0" };
|
const approved = { to: RECIPIENT, value: "0x0" };
|
||||||
const approved = approvedFor(params);
|
const raw = await signedFor({ ...approved, data: "0x" });
|
||||||
delete approved.data;
|
|
||||||
const raw = await signedFor({ ...params, data: "0x" });
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(raw, approved, signer.address, SELECTED),
|
verifySignedTx(raw, approved, signer.address, SELECTED),
|
||||||
).not.toThrow();
|
).not.toThrow();
|
||||||
@@ -913,7 +756,7 @@ describe("verifySignedTx normalization", () => {
|
|||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(
|
||||||
raw,
|
raw,
|
||||||
{ ...APPROVED, maxFeePerGas: "cheap" },
|
{ ...TX_PARAMS, maxFeePerGas: "cheap" },
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
),
|
),
|
||||||
@@ -931,7 +774,7 @@ describe("verifySignedTx normalization", () => {
|
|||||||
try {
|
try {
|
||||||
verifySignedTx(
|
verifySignedTx(
|
||||||
raw,
|
raw,
|
||||||
{ ...APPROVED, value },
|
{ ...TX_PARAMS, value },
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
);
|
);
|
||||||
@@ -950,7 +793,7 @@ describe("verifySignedTx normalization", () => {
|
|||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(
|
verifySignedTx(
|
||||||
raw,
|
raw,
|
||||||
{ ...APPROVED, accessList: ["nope"] },
|
{ ...TX_PARAMS, accessList: ["nope"] },
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
),
|
),
|
||||||
@@ -1091,7 +934,7 @@ describe("signing failure and retry", () => {
|
|||||||
test("a mismatch spends the approval", async () => {
|
test("a mismatch spends the approval", async () => {
|
||||||
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
||||||
try {
|
try {
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED);
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED);
|
||||||
throw new Error("expected a rejection");
|
throw new Error("expected a rejection");
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
expect(failureIsRetryable(e)).toBe(false);
|
expect(failureIsRetryable(e)).toBe(false);
|
||||||
@@ -1164,7 +1007,7 @@ describe("signing failure and retry", () => {
|
|||||||
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
const raw = await signedFor({ ...TX_PARAMS, to: OTHER_RECIPIENT });
|
||||||
let outcome;
|
let outcome;
|
||||||
try {
|
try {
|
||||||
verifySignedTx(raw, APPROVED, signer.address, SELECTED);
|
verifySignedTx(raw, TX_PARAMS, signer.address, SELECTED);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
outcome = describeTxFailure(TX_STAGE_VERIFY, e);
|
outcome = describeTxFailure(TX_STAGE_VERIFY, e);
|
||||||
}
|
}
|
||||||
@@ -1218,13 +1061,12 @@ describe("signing failure and retry", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// End-to-end over the messaging boundary, without a browser: the background
|
// End-to-end over the messaging boundary, without a browser: run the exact
|
||||||
// populates the transaction, the object that produces crosses to the popup as
|
// sequence the approval popup runs, then hand the artifact to the exact check
|
||||||
// JSON and is signed there, and the artifact goes back to the exact check the
|
// the background runs before it broadcasts or resolves. Only what the popup
|
||||||
// background runs before it broadcasts. Only what each side puts on the wire is
|
// puts on the wire is passed along, so this also pins down that the wire
|
||||||
// passed along, so this also pins down that the wire payloads are sufficient on
|
// payload is sufficient on its own.
|
||||||
// their own.
|
describe("popup signing sequence to background verification", () => {
|
||||||
describe("background population to popup signing to verification", () => {
|
|
||||||
// Stand-in for the JSON-RPC provider. populateTransaction only needs the
|
// Stand-in for the JSON-RPC provider. populateTransaction only needs the
|
||||||
// nonce, the gas estimate, the network and the fee data.
|
// nonce, the gas estimate, the network and the fee data.
|
||||||
const fakeProvider = {
|
const fakeProvider = {
|
||||||
@@ -1242,52 +1084,33 @@ describe("background population to popup signing to verification", () => {
|
|||||||
// through getSignerForAddress() the way the popup does.
|
// through getSignerForAddress() the way the popup does.
|
||||||
const walletData = { type: "privkey" };
|
const walletData = { type: "privkey" };
|
||||||
|
|
||||||
// What the background does before the approval window opens.
|
async function popupSignsTx(txParams) {
|
||||||
async function backgroundPrepares(txParams) {
|
|
||||||
const approvedTx = await prepareApprovalTx(
|
|
||||||
fakeProvider,
|
|
||||||
signer.address,
|
|
||||||
txParams,
|
|
||||||
);
|
|
||||||
// Extension messaging is JSON; the popup sees the other side of it.
|
|
||||||
return JSON.parse(JSON.stringify(approvedTx));
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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, 0, SIGNER_KEY);
|
||||||
return localSigner.signTransaction({ ...approvedTx });
|
const connected = localSigner.connect(fakeProvider);
|
||||||
|
const populated = await connected.populateTransaction(txParams);
|
||||||
|
delete populated.from;
|
||||||
|
return connected.signTransaction(populated);
|
||||||
}
|
}
|
||||||
|
|
||||||
test("the populated transaction is what gets signed and what gets checked", async () => {
|
test("a populated, signed transaction is accepted and broadcastable", async () => {
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
const rawSignedTx = await popupSignsTx(TX_PARAMS);
|
||||||
const rawSignedTx = await popupSigns(approvedTx);
|
|
||||||
const parsed = verifySignedTx(
|
const parsed = verifySignedTx(
|
||||||
rawSignedTx,
|
rawSignedTx,
|
||||||
approvedTx,
|
TX_PARAMS,
|
||||||
signer.address,
|
signer.address,
|
||||||
SELECTED,
|
SELECTED,
|
||||||
);
|
);
|
||||||
expect(parsed.nonce).toBe(7);
|
expect(parsed.nonce).toBe(7);
|
||||||
expect(parsed.chainId).toBe(1n);
|
expect(parsed.chainId).toBe(1n);
|
||||||
expect(parsed.gasLimit).toBe(21000n);
|
expect(parsed.gasLimit).toBe(21000n);
|
||||||
expect(parsed.maxFeePerGas).toBe(2000000000n);
|
|
||||||
expect(parsed.to).toBe(RECIPIENT);
|
expect(parsed.to).toBe(RECIPIENT);
|
||||||
expect(parsed.value).toBe(BigInt(TX_PARAMS.value));
|
expect(parsed.value).toBe(BigInt(TX_PARAMS.value));
|
||||||
expect(parsed.data).toBe(TX_PARAMS.data);
|
expect(parsed.data).toBe(TX_PARAMS.data);
|
||||||
expect(parsed.signature).not.toBeNull();
|
expect(parsed.signature).not.toBeNull();
|
||||||
// Every field the screen shows, and the artifact, are the same numbers.
|
|
||||||
expect(BigInt(approvedTx.nonce)).toBe(BigInt(parsed.nonce));
|
|
||||||
expect(BigInt(approvedTx.gasLimit)).toBe(parsed.gasLimit);
|
|
||||||
expect(BigInt(approvedTx.maxFeePerGas)).toBe(parsed.maxFeePerGas);
|
|
||||||
expect(BigInt(approvedTx.maxPriorityFeePerGas)).toBe(
|
|
||||||
parsed.maxPriorityFeePerGas,
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the wire payload carries no password and no secret", async () => {
|
test("the wire payload carries no password and no secret", async () => {
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
const rawSignedTx = await popupSignsTx(TX_PARAMS);
|
||||||
const rawSignedTx = await popupSigns(approvedTx);
|
|
||||||
const payload = {
|
const payload = {
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
id: "test-approval-id",
|
id: "test-approval-id",
|
||||||
@@ -1305,54 +1128,20 @@ describe("background population to popup signing to verification", () => {
|
|||||||
expect(wire).not.toContain(SIGNER_KEY.slice(2).toLowerCase());
|
expect(wire).not.toContain(SIGNER_KEY.slice(2).toLowerCase());
|
||||||
});
|
});
|
||||||
|
|
||||||
// The popup is the component whose compromise this check exists to detect,
|
|
||||||
// so it is given the approved transaction and signs something else.
|
|
||||||
test("a popup that signs a different fee than it was given is refused", async () => {
|
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
|
||||||
const rawSignedTx = await popupSigns({
|
|
||||||
...approvedTx,
|
|
||||||
maxFeePerGas: "0x3b9aca000",
|
|
||||||
});
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(rawSignedTx, approvedTx, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved maximum fee per gas/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a popup that signs a different nonce than it was given is refused", async () => {
|
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
|
||||||
const rawSignedTx = await popupSigns({ ...approvedTx, nonce: "0x8" });
|
|
||||||
expect(() =>
|
|
||||||
verifySignedTx(rawSignedTx, approvedTx, signer.address, SELECTED),
|
|
||||||
).toThrow(/approved nonce/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the background rejects a transaction the popup did not approve", async () => {
|
test("the background rejects a transaction the popup did not approve", async () => {
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
const rawSignedTx = await popupSignsTx({
|
||||||
const rawSignedTx = await popupSigns({
|
...TX_PARAMS,
|
||||||
...approvedTx,
|
|
||||||
to: OTHER_RECIPIENT,
|
to: OTHER_RECIPIENT,
|
||||||
});
|
});
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(rawSignedTx, approvedTx, signer.address, SELECTED),
|
verifySignedTx(rawSignedTx, TX_PARAMS, signer.address, SELECTED),
|
||||||
).toThrow(/approved recipient/);
|
).toThrow(/approved recipient/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the background rejects a transaction populated on another network", async () => {
|
test("the background rejects a transaction populated on another network", async () => {
|
||||||
const approvedTx = await backgroundPrepares(TX_PARAMS);
|
const rawSignedTx = await popupSignsTx(TX_PARAMS);
|
||||||
const rawSignedTx = await popupSigns(approvedTx);
|
|
||||||
expect(() =>
|
expect(() =>
|
||||||
verifySignedTx(rawSignedTx, approvedTx, signer.address, SEPOLIA),
|
verifySignedTx(rawSignedTx, TX_PARAMS, signer.address, SEPOLIA),
|
||||||
).toThrow(/different network than the one that is selected/);
|
).toThrow(/different network than the one that is selected/);
|
||||||
});
|
});
|
||||||
|
|
||||||
// ethers refuses to sign for an address that is not the key's own, so a
|
|
||||||
// popup working from the approved object cannot quietly sign as whichever
|
|
||||||
// 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);
|
|
||||||
await expect(
|
|
||||||
otherSigner.signTransaction({ ...approvedTx }),
|
|
||||||
).rejects.toThrow(/from address mismatch/);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -8,24 +8,16 @@
|
|||||||
// already saw — which means the entry being present is not by itself proof
|
// already saw — which means the entry being present is not by itself proof
|
||||||
// that no attempt is running. A second response carrying the same id (a
|
// that no attempt is running. A second response carrying the same id (a
|
||||||
// reloaded approval window re-rendering a live Approve button, a popup that
|
// reloaded approval window re-rendering a live Approve button, a popup that
|
||||||
// emits the message twice) must not start a second verify and broadcast: the
|
// emits the message twice) must not start a second verify and broadcast: with
|
||||||
// same approved transaction signed twice verifies twice, and the transfer
|
// the ordinary dApp approval shape the page fixes no nonce, so two artifacts
|
||||||
// would go out twice.
|
// signed at different nonces both verify, and the approved transfer would go
|
||||||
//
|
// out twice.
|
||||||
// It also covers what the approval is verified against. The approval now
|
|
||||||
// carries the transaction the background populated and the screen displayed,
|
|
||||||
// and the address that was active when it was raised — so a fee, a nonce or an
|
|
||||||
// address that moved between approval and signing is refused rather than
|
|
||||||
// signed.
|
|
||||||
|
|
||||||
const { Network, Wallet } = require("ethers");
|
const { Wallet } = require("ethers");
|
||||||
|
|
||||||
const SIGNER_KEY =
|
const SIGNER_KEY =
|
||||||
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
||||||
const OTHER_KEY =
|
|
||||||
"0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a";
|
|
||||||
const signer = new Wallet(SIGNER_KEY);
|
const signer = new Wallet(SIGNER_KEY);
|
||||||
const other = new Wallet(OTHER_KEY);
|
|
||||||
const RECIPIENT = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
const RECIPIENT = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
const ORIGIN = "https://dapp.example";
|
const ORIGIN = "https://dapp.example";
|
||||||
@@ -41,16 +33,9 @@ const TX_PARAMS = {
|
|||||||
data: "0x",
|
data: "0x",
|
||||||
};
|
};
|
||||||
|
|
||||||
// The nonce the stubbed node reports, and so the nonce the background
|
// The fields the popup's populateTransaction() would fill in. The nonce is a
|
||||||
// populates the approval with.
|
// parameter because the duplicate case turns on the two artifacts differing
|
||||||
const NONCE = 7;
|
// in exactly the field nothing constrains.
|
||||||
|
|
||||||
// "Hello AutistMask" as the hex string a dApp passes to personal_sign.
|
|
||||||
const MESSAGE = "0x48656c6c6f204175746973744d61736b";
|
|
||||||
|
|
||||||
// The transaction the background populates and the approval screen displays.
|
|
||||||
// The nonce is a parameter because the duplicate case turns on two artifacts
|
|
||||||
// differing in a field the dApp fixed nothing for.
|
|
||||||
function populated(nonce) {
|
function populated(nonce) {
|
||||||
return {
|
return {
|
||||||
type: 2,
|
type: 2,
|
||||||
@@ -65,26 +50,8 @@ function populated(nonce) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function signedAtNonce(nonce, withWallet) {
|
function signedAtNonce(nonce) {
|
||||||
return (withWallet || signer).signTransaction(populated(nonce));
|
return signer.signTransaction(populated(nonce));
|
||||||
}
|
|
||||||
|
|
||||||
// The node the background populates against. Its answers are the numbers the
|
|
||||||
// approval screen shows, so they are also the numbers every artifact below is
|
|
||||||
// signed at.
|
|
||||||
function fakeProvider(broadcastTransaction, overrides) {
|
|
||||||
return {
|
|
||||||
broadcastTransaction,
|
|
||||||
getNetwork: async () => Network.from(1),
|
|
||||||
getTransactionCount: async () => NONCE,
|
|
||||||
estimateGas: async () => 100000n,
|
|
||||||
getFeeData: async () => ({
|
|
||||||
gasPrice: 2000000000n,
|
|
||||||
maxFeePerGas: 2000000000n,
|
|
||||||
maxPriorityFeePerGas: 1000000000n,
|
|
||||||
}),
|
|
||||||
...(overrides || {}),
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// A promise whose settlement the test controls, so a broadcast can be held in
|
// A promise whose settlement the test controls, so a broadcast can be held in
|
||||||
@@ -118,7 +85,7 @@ function loadBackground(options) {
|
|||||||
currentNetwork: () => ({ chainId: "0x1" }),
|
currentNetwork: () => ({ chainId: "0x1" }),
|
||||||
}));
|
}));
|
||||||
jest.doMock("../src/shared/balances", () => ({
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
getProvider: () => fakeProvider(broadcastTransaction, opts.provider),
|
getProvider: () => ({ broadcastTransaction }),
|
||||||
refreshBalances: jest.fn(async () => {}),
|
refreshBalances: jest.fn(async () => {}),
|
||||||
}));
|
}));
|
||||||
jest.doMock("../src/shared/phishingDomains", () => ({
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
@@ -204,7 +171,7 @@ function loadBackground(options) {
|
|||||||
|
|
||||||
// Raise a pending transaction approval the way a dApp does, and dig the
|
// Raise a pending transaction approval the way a dApp does, and dig the
|
||||||
// approval id back out of the popup URL the background opened.
|
// approval id back out of the popup URL the background opened.
|
||||||
function requestTx(txParams) {
|
function requestTx() {
|
||||||
let rpcResult = null;
|
let rpcResult = null;
|
||||||
const sendResponse = jest.fn((r) => {
|
const sendResponse = jest.fn((r) => {
|
||||||
rpcResult = r;
|
rpcResult = r;
|
||||||
@@ -213,7 +180,7 @@ function loadBackground(options) {
|
|||||||
{
|
{
|
||||||
type: "AUTISTMASK_RPC",
|
type: "AUTISTMASK_RPC",
|
||||||
method: "eth_sendTransaction",
|
method: "eth_sendTransaction",
|
||||||
params: [txParams || TX_PARAMS],
|
params: [TX_PARAMS],
|
||||||
},
|
},
|
||||||
{ origin: ORIGIN },
|
{ origin: ORIGIN },
|
||||||
sendResponse,
|
sendResponse,
|
||||||
@@ -224,30 +191,6 @@ function loadBackground(options) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// The same for a message-signing approval, which pins the signing address
|
|
||||||
// at approval time in exactly the same way.
|
|
||||||
function requestSign(from) {
|
|
||||||
let rpcResult = null;
|
|
||||||
messageListener(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_RPC",
|
|
||||||
method: "personal_sign",
|
|
||||||
params: [MESSAGE, from || signer.address],
|
|
||||||
},
|
|
||||||
{ origin: ORIGIN },
|
|
||||||
(r) => {
|
|
||||||
rpcResult = r;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
return {
|
|
||||||
id: () =>
|
|
||||||
new URL(created[created.length - 1].url).searchParams.get(
|
|
||||||
"approval",
|
|
||||||
),
|
|
||||||
result: () => rpcResult,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// The user closes the approval popup. `created` is index-aligned with the
|
// The user closes the approval popup. `created` is index-aligned with the
|
||||||
// ids the window stub hands back, so window 1 is the first popup opened.
|
// ids the window stub hands back, so window 1 is the first popup opened.
|
||||||
function closeWindow(windowId) {
|
function closeWindow(windowId) {
|
||||||
@@ -257,27 +200,18 @@ function loadBackground(options) {
|
|||||||
return {
|
return {
|
||||||
send,
|
send,
|
||||||
requestTx,
|
requestTx,
|
||||||
requestSign,
|
|
||||||
closeWindow,
|
closeWindow,
|
||||||
broadcastTransaction,
|
broadcastTransaction,
|
||||||
loadState,
|
loadState,
|
||||||
created,
|
created,
|
||||||
removed,
|
removed,
|
||||||
// The user switching account in the toolbar popup, as the background
|
|
||||||
// sees it: the persisted active address changes underneath a pending
|
|
||||||
// approval.
|
|
||||||
setActiveAddress: (address) => {
|
|
||||||
persisted.activeAddress = address;
|
|
||||||
},
|
|
||||||
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Let the handler's promise chain run to the next suspension point. Raising a
|
// Let the handler's promise chain run to the next suspension point.
|
||||||
// transaction approval now populates it against the node first, which is
|
|
||||||
// several awaits deep before the window is opened.
|
|
||||||
async function settle() {
|
async function settle() {
|
||||||
for (let i = 0; i < 50; i++) await Promise.resolve();
|
for (let i = 0; i < 10; i++) await Promise.resolve();
|
||||||
}
|
}
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
@@ -310,11 +244,9 @@ describe("one approval, one broadcast", () => {
|
|||||||
await settle();
|
await settle();
|
||||||
expect(bg.broadcastTransaction).toHaveBeenCalledTimes(1);
|
expect(bg.broadcastTransaction).toHaveBeenCalledTimes(1);
|
||||||
|
|
||||||
// A reloaded approval window signs the same approval again, at another
|
// A reloaded approval window signs the same approval again. Nothing
|
||||||
// nonce. The claim is taken before anything is verified, so what this
|
// in the approval fixes a nonce, so this artifact verifies just as
|
||||||
// asserts is the interlock and not the nonce comparison: the refusal
|
// well as the first one.
|
||||||
// below is the claim's own message, which a verification failure does
|
|
||||||
// not produce.
|
|
||||||
const second = bg.send(
|
const second = bg.send(
|
||||||
{
|
{
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
@@ -444,319 +376,6 @@ describe("one approval, one broadcast", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// The approval carries the transaction the user was shown and the address it
|
|
||||||
// was raised for, and the artifact is checked against both. Every case here is
|
|
||||||
// one the old comparison — against the dApp's request, for the address that is
|
|
||||||
// active now — would have broadcast.
|
|
||||||
describe("what the approval is verified against", () => {
|
|
||||||
// The approval screen showed the populated fee. An artifact at ten times
|
|
||||||
// that fee, still far below the ceilings, is what the ceilings alone could
|
|
||||||
// not catch.
|
|
||||||
test("a fee differing from the displayed one is refused, not sent", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
const raw = await signer.signTransaction({
|
|
||||||
...populated(NONCE),
|
|
||||||
maxFeePerGas: 20000000000n,
|
|
||||||
});
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: raw,
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith(
|
|
||||||
expect.objectContaining({
|
|
||||||
error: expect.stringMatching(/approved maximum fee per gas/),
|
|
||||||
retryable: false,
|
|
||||||
stage: "verify",
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: {
|
|
||||||
message: expect.stringMatching(/approved maximum fee per gas/),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a nonce differing from the displayed one is refused, not sent", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE + 1),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith(
|
|
||||||
expect.objectContaining({
|
|
||||||
error: expect.stringMatching(/approved nonce/),
|
|
||||||
retryable: false,
|
|
||||||
stage: "verify",
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The address switch. The approval named one account; the wallet is on
|
|
||||||
// another by the time the artifact arrives. Both halves are covered: the
|
|
||||||
// popup signing as the account that is active now, and the popup correctly
|
|
||||||
// signing as the approved account while the wallet has moved on.
|
|
||||||
test("an artifact signed by the address that is active now is refused", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE, other),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith(
|
|
||||||
expect.objectContaining({ retryable: false, stage: "verify" }),
|
|
||||||
);
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: { message: expect.stringMatching(/active address changed/) },
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an address switch refuses even the correctly signed artifact", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith(
|
|
||||||
expect.objectContaining({
|
|
||||||
error: expect.stringMatching(/active address changed/),
|
|
||||||
retryable: false,
|
|
||||||
stage: "verify",
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
// A refusal, so the approval is spent: the same artifact offered again
|
|
||||||
// finds nothing to answer.
|
|
||||||
const retry = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
expect(retry.sendResponse).not.toHaveBeenCalled();
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a switch back to the approved address still sends", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
bg.setActiveAddress(signer.address);
|
|
||||||
bg.broadcastTransaction.mockResolvedValue({ hash: "0xfeed" });
|
|
||||||
bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).toHaveBeenCalledTimes(1);
|
|
||||||
expect(pending.result()).toEqual({ result: "0xfeed" });
|
|
||||||
});
|
|
||||||
|
|
||||||
// The popup is handed the populated transaction and the address it is for,
|
|
||||||
// and nothing else it would have to fetch or decide.
|
|
||||||
test("the popup is given the transaction it is to sign", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
const details = bg.send(
|
|
||||||
{ type: "AUTISTMASK_GET_APPROVAL", id: pending.id() },
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
const shown = details.sendResponse.mock.calls[0][0];
|
|
||||||
expect(shown.type).toBe("tx");
|
|
||||||
expect(shown.approvedFrom).toBe(signer.address);
|
|
||||||
expect(shown.approvedTx).toEqual({
|
|
||||||
type: 2,
|
|
||||||
from: signer.address,
|
|
||||||
chainId: "0x1",
|
|
||||||
nonce: "0x7",
|
|
||||||
gasLimit: "0x186a0",
|
|
||||||
maxFeePerGas: "0x77359400",
|
|
||||||
maxPriorityFeePerGas: "0x3b9aca00",
|
|
||||||
to: RECIPIENT,
|
|
||||||
value: TX_PARAMS.value,
|
|
||||||
data: "0x",
|
|
||||||
accessList: [],
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// A request naming an account the wallet is not on is refused outright
|
|
||||||
// rather than signed as whichever account is active.
|
|
||||||
test("a request from another address raises no approval at all", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestTx({ ...TX_PARAMS, from: other.address });
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: {
|
|
||||||
code: 4100,
|
|
||||||
message: expect.stringMatching(/not the active one/),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
expect(bg.created).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Message signing pins the address the same way, and refuses the same way.
|
|
||||||
// A signature is not a transaction, but a permit signed by an account the
|
|
||||||
// approval did not name spends that account's tokens all the same.
|
|
||||||
test("a sign approval refuses a signature after an address switch", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestSign();
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
|
||||||
id: pending.id(),
|
|
||||||
approved: true,
|
|
||||||
signature: await signer.signMessage(
|
|
||||||
Buffer.from(MESSAGE.slice(2), "hex"),
|
|
||||||
),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith(
|
|
||||||
expect.objectContaining({
|
|
||||||
error: expect.stringMatching(/active address changed/),
|
|
||||||
retryable: false,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: { message: expect.stringMatching(/active address changed/) },
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a sign request from another address raises no approval at all", async () => {
|
|
||||||
const bg = loadBackground();
|
|
||||||
const pending = bg.requestSign(other.address);
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: {
|
|
||||||
code: 4100,
|
|
||||||
message: expect.stringMatching(/not the active one/),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
expect(bg.created).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Population is a network round trip with the user's hands free. An
|
|
||||||
// approval raised for the address that was active when it started could
|
|
||||||
// never be signed once the wallet has moved off it, so it is never raised.
|
|
||||||
test("an address switch during population raises no approval", async () => {
|
|
||||||
let bg;
|
|
||||||
bg = loadBackground({
|
|
||||||
provider: {
|
|
||||||
// The user switches account in the toolbar popup while the
|
|
||||||
// node is being asked for a gas estimate.
|
|
||||||
estimateGas: async () => {
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
return 100000n;
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: {
|
|
||||||
message: expect.stringMatching(
|
|
||||||
/active address changed while this transaction was being prepared/,
|
|
||||||
),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
expect(bg.created).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Population happens before the window exists, so its failure is a failure
|
|
||||||
// of the request: no approval, no window, and the error goes back to the
|
|
||||||
// page the click came from.
|
|
||||||
test("a transaction that cannot be prepared opens no window", async () => {
|
|
||||||
const bg = loadBackground({
|
|
||||||
provider: {
|
|
||||||
estimateGas: async () => {
|
|
||||||
throw new Error("execution reverted");
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
expect(pending.result()).toEqual({
|
|
||||||
error: {
|
|
||||||
message: expect.stringMatching(
|
|
||||||
/could not be prepared.*execution reverted/,
|
|
||||||
),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
expect(bg.created).toEqual([]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// The interlock must not cost the retry the approval exists to allow.
|
// The interlock must not cost the retry the approval exists to allow.
|
||||||
describe("the interlock releases a failed attempt", () => {
|
describe("the interlock releases a failed attempt", () => {
|
||||||
test("a retryable failure before the broadcast leaves the approval usable", async () => {
|
test("a retryable failure before the broadcast leaves the approval usable", async () => {
|
||||||
|
|||||||
@@ -1,51 +0,0 @@
|
|||||||
# Firefox end-to-end image: stock Firefox plus geckodriver on a node base,
|
|
||||||
# built by script/test-e2e-firefox. The repo is bind-mounted at /work; the
|
|
||||||
# harness itself has no dependencies, so nothing is installed for it.
|
|
||||||
#
|
|
||||||
# All three external artifacts are pinned by digest. The Firefox version in
|
|
||||||
# particular must not float: -remote-allow-system-access is mandatory on 153
|
|
||||||
# and was not on 142, so the flag the harness passes is version-coupled.
|
|
||||||
|
|
||||||
# node:22-bookworm-slim, 2026-08-12
|
|
||||||
FROM node@sha256:d649c27dae7ba0137b3cef5dd75baa422c08dc3d9e3fc0c23dfb172dc3cc6436
|
|
||||||
|
|
||||||
ENV DEBIAN_FRONTEND=noninteractive
|
|
||||||
|
|
||||||
# Firefox's shared-library dependencies on a slim base, plus the two tools
|
|
||||||
# needed to fetch and unpack the pinned tarballs.
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends \
|
|
||||||
ca-certificates \
|
|
||||||
curl \
|
|
||||||
libasound2 \
|
|
||||||
libdbus-glib-1-2 \
|
|
||||||
libgtk-3-0 \
|
|
||||||
libx11-xcb1 \
|
|
||||||
libxt6 \
|
|
||||||
libxtst6 \
|
|
||||||
xz-utils \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
# Firefox 153.0.3, linux-x86_64, en-US
|
|
||||||
ARG FIREFOX_URL=https://ftp.mozilla.org/pub/firefox/releases/153.0.3/linux-x86_64/en-US/firefox-153.0.3.tar.xz
|
|
||||||
ARG FIREFOX_SHA256=22b312280900bfb174b685ece32c7b3c6d72e7f8e53d6d30f21ac41a8dc500a2
|
|
||||||
RUN curl -fsSL -o /tmp/firefox.tar.xz "$FIREFOX_URL" \
|
|
||||||
&& echo "$FIREFOX_SHA256 /tmp/firefox.tar.xz" | sha256sum -c - \
|
|
||||||
&& tar -xJf /tmp/firefox.tar.xz -C /opt \
|
|
||||||
&& rm /tmp/firefox.tar.xz \
|
|
||||||
&& /opt/firefox/firefox --version
|
|
||||||
|
|
||||||
# geckodriver v0.36.0, linux64
|
|
||||||
ARG GECKODRIVER_URL=https://github.com/mozilla/geckodriver/releases/download/v0.36.0/geckodriver-v0.36.0-linux64.tar.gz
|
|
||||||
ARG GECKODRIVER_SHA256=0bde38707eb0a686a20c6bd50f4adcc7d60d4f73c60eb83ee9e0db8f65823e04
|
|
||||||
RUN curl -fsSL -o /tmp/geckodriver.tar.gz "$GECKODRIVER_URL" \
|
|
||||||
&& echo "$GECKODRIVER_SHA256 /tmp/geckodriver.tar.gz" | sha256sum -c - \
|
|
||||||
&& tar -xzf /tmp/geckodriver.tar.gz -C /usr/local/bin \
|
|
||||||
&& rm /tmp/geckodriver.tar.gz \
|
|
||||||
&& geckodriver --version
|
|
||||||
|
|
||||||
ENV FIREFOX_BIN=/opt/firefox/firefox
|
|
||||||
ENV GECKODRIVER=/usr/local/bin/geckodriver
|
|
||||||
|
|
||||||
WORKDIR /work
|
|
||||||
CMD ["node", "tests/e2e/firefox/run.js", "dist/firefox"]
|
|
||||||
@@ -1,238 +0,0 @@
|
|||||||
// A loopback dApp origin and stub Ethereum node for the Firefox suite.
|
|
||||||
//
|
|
||||||
// The Firefox container runs with --network none, and the harness note in
|
|
||||||
// driver.js records the consequence: with no http:// origin in reach, no
|
|
||||||
// content script was ever injected, so content-script behaviour was
|
|
||||||
// UNVERIFIED and the dApp flows could not be driven at all.
|
|
||||||
//
|
|
||||||
// --network none removes every interface except loopback, and loopback is
|
|
||||||
// enough. This serves the page and the JSON-RPC endpoint from 127.0.0.1
|
|
||||||
// inside the same container Firefox runs in, so the dApp round trips execute
|
|
||||||
// against a real http:// origin and the run stays as offline as it was: the
|
|
||||||
// only reachable peer is this process.
|
|
||||||
//
|
|
||||||
// The page itself is not written twice. DAPP_HTML comes from the Chrome
|
|
||||||
// suite's fixture, so both harnesses drive the same __dapp API and the same
|
|
||||||
// message log.
|
|
||||||
//
|
|
||||||
// Unlike driver.js this file does use ethers, and it has to: the node has to
|
|
||||||
// answer eth_sendRawTransaction with the hash ethers computes for the
|
|
||||||
// artifact it was handed, or provider.broadcastTransaction() refuses the
|
|
||||||
// answer, and the suite recovers signatures itself rather than believing the
|
|
||||||
// extension's own verdict.
|
|
||||||
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
const http = require("http");
|
|
||||||
|
|
||||||
const { Transaction } = require("ethers");
|
|
||||||
|
|
||||||
const { DAPP_HTML } = require("../network");
|
|
||||||
|
|
||||||
// The same fee shape the Chrome suite uses, for the same reason: it has to
|
|
||||||
// pass the ceilings in src/shared/approvalVerify.js and it has to leave the
|
|
||||||
// reserve and the estimate distinguishable.
|
|
||||||
const GAS_LIMIT = 21000n;
|
|
||||||
const BASE_FEE_WEI = 100000000000n; // 100 gwei
|
|
||||||
const PRIORITY_FEE_WEI = 1000000000n; // 1 gwei
|
|
||||||
const GAS_PRICE_WEI = BASE_FEE_WEI + PRIORITY_FEE_WEI;
|
|
||||||
|
|
||||||
const STUB_BLOCK_NUMBER = 21000000;
|
|
||||||
|
|
||||||
// A 32-byte zero word, returned for every eth_call. It is what makes ethers'
|
|
||||||
// ENS reverse lookup resolve to "no resolver set" instead of throwing, and a
|
|
||||||
// throw there reaches the console through src/shared/log.js, which fails the
|
|
||||||
// run on its own.
|
|
||||||
const ZERO_WORD = "0x" + "0".repeat(64);
|
|
||||||
|
|
||||||
// One ETH, so the popup's balance lines render something and the wallet does
|
|
||||||
// not look empty on the approval screen.
|
|
||||||
const STUB_BALANCE_WEI = 10n ** 18n;
|
|
||||||
|
|
||||||
function hex(value) {
|
|
||||||
return "0x" + BigInt(value).toString(16);
|
|
||||||
}
|
|
||||||
|
|
||||||
function latestBlock() {
|
|
||||||
return {
|
|
||||||
hash: "0x" + "11".repeat(32),
|
|
||||||
parentHash: "0x" + "22".repeat(32),
|
|
||||||
number: hex(STUB_BLOCK_NUMBER),
|
|
||||||
timestamp: hex(1767326645),
|
|
||||||
nonce: "0x0000000000000000",
|
|
||||||
difficulty: "0x0",
|
|
||||||
gasLimit: "0x1c9c380",
|
|
||||||
gasUsed: "0xf4240",
|
|
||||||
miner: "0xc0ffee0000000000000000000000000000c0ffee",
|
|
||||||
extraData: "0x",
|
|
||||||
baseFeePerGas: hex(BASE_FEE_WEI),
|
|
||||||
transactions: [],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const RPC_RESULTS = {
|
|
||||||
eth_chainId: "0x1",
|
|
||||||
net_version: "1",
|
|
||||||
eth_blockNumber: hex(STUB_BLOCK_NUMBER),
|
|
||||||
eth_getBalance: hex(STUB_BALANCE_WEI),
|
|
||||||
eth_call: ZERO_WORD,
|
|
||||||
eth_getCode: "0x",
|
|
||||||
eth_gasPrice: hex(GAS_PRICE_WEI),
|
|
||||||
eth_estimateGas: hex(GAS_LIMIT),
|
|
||||||
eth_getTransactionCount: "0x0",
|
|
||||||
eth_maxPriorityFeePerGas: hex(PRIORITY_FEE_WEI),
|
|
||||||
// "accepted but not mined", which is what a node says about a transaction
|
|
||||||
// it has only just taken. The wait screen the approval hands off to polls
|
|
||||||
// this for the rest of the run.
|
|
||||||
eth_getTransactionReceipt: null,
|
|
||||||
web3_clientVersion: "autistmask-e2e-firefox/0",
|
|
||||||
};
|
|
||||||
|
|
||||||
// Answer one JSON-RPC call. `broadcast` collects every raw transaction that
|
|
||||||
// reached this node, which is what the transaction assertions are made
|
|
||||||
// against — the artifact as the node saw it, never as the extension described
|
|
||||||
// it.
|
|
||||||
function rpcResult(req, state) {
|
|
||||||
const method = req.method;
|
|
||||||
|
|
||||||
if (method === "eth_sendRawTransaction") {
|
|
||||||
const raw = req.params && req.params[0];
|
|
||||||
state.broadcast.push(raw);
|
|
||||||
// ethers checks the hash it is given against the hash it computes for
|
|
||||||
// the artifact it sent, so this cannot be a fixed string.
|
|
||||||
return Transaction.from(raw).hash;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (method === "eth_getBlockByNumber" || method === "eth_getBlockByHash") {
|
|
||||||
return latestBlock();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (Object.prototype.hasOwnProperty.call(RPC_RESULTS, method)) {
|
|
||||||
return RPC_RESULTS[method];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Never a silent default. An unstubbed method answered with null looks
|
|
||||||
// like a working node returning nothing, and the assertion downstream
|
|
||||||
// fails somewhere unrelated.
|
|
||||||
state.unstubbed.push(method);
|
|
||||||
throw new Error("no fixture for JSON-RPC method " + method);
|
|
||||||
}
|
|
||||||
|
|
||||||
function readBody(req) {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
let body = "";
|
|
||||||
req.on("data", (chunk) => {
|
|
||||||
body += chunk;
|
|
||||||
});
|
|
||||||
req.on("end", () => resolve(body));
|
|
||||||
req.on("error", reject);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleRpcBody(body, state) {
|
|
||||||
const parsed = JSON.parse(body);
|
|
||||||
const answer = (req) => {
|
|
||||||
try {
|
|
||||||
return {
|
|
||||||
jsonrpc: "2.0",
|
|
||||||
id: req.id,
|
|
||||||
result: rpcResult(req, state),
|
|
||||||
};
|
|
||||||
} catch (e) {
|
|
||||||
return {
|
|
||||||
jsonrpc: "2.0",
|
|
||||||
id: req.id,
|
|
||||||
error: { code: -32601, message: e.message },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
};
|
|
||||||
return Array.isArray(parsed) ? parsed.map(answer) : answer(parsed);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Serve the dApp page and the stub node on loopback.
|
|
||||||
*
|
|
||||||
* @returns {Promise<Object>} the running fixture: `url` and `origin` of the
|
|
||||||
* page, `rpcUrl` for the extension's rpcUrl setting, `broadcast` (the raw
|
|
||||||
* transactions the node received, in order), `unstubbed` (JSON-RPC methods
|
|
||||||
* nothing answered) and `close()`.
|
|
||||||
*/
|
|
||||||
async function startDappServer() {
|
|
||||||
const state = { broadcast: [], unstubbed: [], requests: [] };
|
|
||||||
|
|
||||||
const server = http.createServer((req, res) => {
|
|
||||||
const url = new URL(req.url, "http://127.0.0.1");
|
|
||||||
state.requests.push(req.method + " " + url.pathname);
|
|
||||||
|
|
||||||
if (url.pathname === "/rpc" && req.method === "POST") {
|
|
||||||
readBody(req)
|
|
||||||
.then((body) => {
|
|
||||||
const payload = JSON.stringify(handleRpcBody(body, state));
|
|
||||||
res.writeHead(200, {
|
|
||||||
"Content-Type": "application/json",
|
|
||||||
// The extension fetches this from its background
|
|
||||||
// page, whose origin is moz-extension://. Without CORS
|
|
||||||
// the fetch fails and every transaction assertion
|
|
||||||
// fails for a reason that has nothing to do with the
|
|
||||||
// wallet.
|
|
||||||
"Access-Control-Allow-Origin": "*",
|
|
||||||
});
|
|
||||||
res.end(payload);
|
|
||||||
})
|
|
||||||
.catch((e) => {
|
|
||||||
res.writeHead(500, { "Content-Type": "text/plain" });
|
|
||||||
res.end(String(e && e.message));
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (url.pathname === "/") {
|
|
||||||
res.writeHead(200, { "Content-Type": "text/html; charset=utf-8" });
|
|
||||||
res.end(DAPP_HTML);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// An empty favicon rather than a 404: a 404 is a page error in
|
|
||||||
// Firefox's console under some settings, and the suite fails the run
|
|
||||||
// on those.
|
|
||||||
if (url.pathname === "/favicon.ico") {
|
|
||||||
res.writeHead(200, { "Content-Type": "image/x-icon" });
|
|
||||||
res.end("");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
res.writeHead(404, { "Content-Type": "text/plain" });
|
|
||||||
res.end("not found");
|
|
||||||
});
|
|
||||||
|
|
||||||
await new Promise((resolve, reject) => {
|
|
||||||
server.on("error", reject);
|
|
||||||
// Port 0: this host runs many sessions at once, and a fixed port is a
|
|
||||||
// guaranteed collision rather than a possible one.
|
|
||||||
server.listen(0, "127.0.0.1", resolve);
|
|
||||||
});
|
|
||||||
|
|
||||||
const { port } = server.address();
|
|
||||||
const origin = "http://127.0.0.1:" + port;
|
|
||||||
|
|
||||||
return {
|
|
||||||
origin,
|
|
||||||
url: origin + "/",
|
|
||||||
rpcUrl: origin + "/rpc",
|
|
||||||
broadcast: state.broadcast,
|
|
||||||
unstubbed: state.unstubbed,
|
|
||||||
requests: state.requests,
|
|
||||||
close: () =>
|
|
||||||
new Promise((resolve) => {
|
|
||||||
server.closeAllConnections();
|
|
||||||
server.close(() => resolve());
|
|
||||||
}),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
GAS_LIMIT,
|
|
||||||
GAS_PRICE_WEI,
|
|
||||||
STUB_BALANCE_WEI,
|
|
||||||
startDappServer,
|
|
||||||
};
|
|
||||||
@@ -1,556 +0,0 @@
|
|||||||
// A minimal WebDriver client for geckodriver, plus the privileged console
|
|
||||||
// reader the error assertions are built on. No npm dependencies: global
|
|
||||||
// fetch and child_process against geckodriver's HTTP API is less code than
|
|
||||||
// a driver library and keeps the harness at zero packages.
|
|
||||||
//
|
|
||||||
// Run through script/test-e2e-firefox, which builds dist/firefox/ and the
|
|
||||||
// pinned container around this. FIREFOX_BIN and GECKODRIVER locate the two
|
|
||||||
// binaries; the image sets both.
|
|
||||||
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
const { spawn } = require("child_process");
|
|
||||||
const net = require("net");
|
|
||||||
|
|
||||||
const FIREFOX_BIN = process.env.FIREFOX_BIN || "firefox";
|
|
||||||
const GECKODRIVER = process.env.GECKODRIVER || "geckodriver";
|
|
||||||
|
|
||||||
// The extension id declared in manifest/firefox.json, and the uuid the
|
|
||||||
// popup is served from. Firefox normally assigns that uuid randomly per
|
|
||||||
// profile, which would make the popup URL undiscoverable without querying
|
|
||||||
// privileged state; setting extensions.webextensions.uuids before launch
|
|
||||||
// pins it instead. This only works because the manifest declares a fixed
|
|
||||||
// browser_specific_settings.gecko.id — without one the mapping has no key.
|
|
||||||
const EXTENSION_ID = "autistmask@sneak.berlin";
|
|
||||||
const EXTENSION_UUID = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
|
|
||||||
const EXTENSION_ORIGIN = "moz-extension://" + EXTENSION_UUID;
|
|
||||||
|
|
||||||
// The W3C web element identifier. Getting the last character wrong yields
|
|
||||||
// an element reference of "undefined" and a bewildering "element with the
|
|
||||||
// reference undefined is not known" from geckodriver, so findElement()
|
|
||||||
// below checks for the key rather than indexing blindly.
|
|
||||||
const WEB_ELEMENT_KEY = "element-6066-11e4-a52e-4f735466cecf";
|
|
||||||
|
|
||||||
const SCRIPT_TIMEOUT_MS = 120000;
|
|
||||||
const DEFAULT_WAIT_MS = 20000;
|
|
||||||
const POLL_INTERVAL_MS = 100;
|
|
||||||
|
|
||||||
function sleep(ms) {
|
|
||||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
||||||
}
|
|
||||||
|
|
||||||
// An ephemeral port picked by the kernel, then handed to geckodriver.
|
|
||||||
// There is a race between closing this listener and geckodriver binding,
|
|
||||||
// but this host runs many sessions at once and a fixed 4444 is a
|
|
||||||
// guaranteed collision rather than a possible one.
|
|
||||||
function freePort() {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
const srv = net.createServer();
|
|
||||||
srv.on("error", reject);
|
|
||||||
srv.listen(0, "127.0.0.1", () => {
|
|
||||||
const { port } = srv.address();
|
|
||||||
srv.close(() => resolve(port));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
class WebDriverError extends Error {
|
|
||||||
constructor(command, body) {
|
|
||||||
const v = (body && body.value) || {};
|
|
||||||
super(
|
|
||||||
command +
|
|
||||||
" failed: " +
|
|
||||||
(v.error || "unknown error") +
|
|
||||||
": " +
|
|
||||||
(v.message || JSON.stringify(body)),
|
|
||||||
);
|
|
||||||
this.name = "WebDriverError";
|
|
||||||
this.error = v.error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class Driver {
|
|
||||||
constructor(proc, base) {
|
|
||||||
this.proc = proc;
|
|
||||||
this.base = base;
|
|
||||||
this.sessionId = null;
|
|
||||||
this.context = "content";
|
|
||||||
}
|
|
||||||
|
|
||||||
async send(method, path, body) {
|
|
||||||
const url = this.base + path;
|
|
||||||
const res = await fetch(url, {
|
|
||||||
method,
|
|
||||||
headers: { "Content-Type": "application/json" },
|
|
||||||
body: body === undefined ? undefined : JSON.stringify(body),
|
|
||||||
});
|
|
||||||
const text = await res.text();
|
|
||||||
let parsed;
|
|
||||||
try {
|
|
||||||
parsed = JSON.parse(text);
|
|
||||||
} catch (_) {
|
|
||||||
throw new Error(
|
|
||||||
method + " " + path + ": non-JSON response: " + text,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
if (!res.ok) throw new WebDriverError(method + " " + path, parsed);
|
|
||||||
return parsed.value;
|
|
||||||
}
|
|
||||||
|
|
||||||
session(method, path, body) {
|
|
||||||
return this.send(method, "/session/" + this.sessionId + path, body);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------------ setup
|
|
||||||
|
|
||||||
async newSession() {
|
|
||||||
const prefs = {
|
|
||||||
// See EXTENSION_UUID above. The pref is a string pref whose
|
|
||||||
// value is itself JSON.
|
|
||||||
"extensions.webextensions.uuids": JSON.stringify({
|
|
||||||
[EXTENSION_ID]: EXTENSION_UUID,
|
|
||||||
}),
|
|
||||||
// The container has loopback and nothing else. Firefox's own
|
|
||||||
// link-status detection can read that as "offline" and then
|
|
||||||
// refuse every request, including the ones to the loopback dApp
|
|
||||||
// origin the suite serves; this takes the decision away from it.
|
|
||||||
"network.manage-offline-status": false,
|
|
||||||
// Force the site-connection prompt down its windows.create()
|
|
||||||
// fallback.
|
|
||||||
//
|
|
||||||
// src/background/index.js prefers the toolbar-anchored popup for
|
|
||||||
// that one approval and opens a real window only when
|
|
||||||
// openPopup() refuses. A panel is not a top-level browsing
|
|
||||||
// context, so WebDriver cannot see it, list it or click in it —
|
|
||||||
// the same blind spot the Chrome harness documents. Leaving this
|
|
||||||
// at its default would make which path runs depend on whether a
|
|
||||||
// headless Firefox counts as having had a user gesture, which is
|
|
||||||
// not a thing to leave to chance in a suite that has to be able
|
|
||||||
// to fail. The window path is shipped code and the same approval
|
|
||||||
// id, so what is driven is real; what is NOT covered either way
|
|
||||||
// is the panel presentation itself.
|
|
||||||
"extensions.openPopupWithoutUserGesture.enabled": false,
|
|
||||||
};
|
|
||||||
|
|
||||||
const value = await this.send("POST", "/session", {
|
|
||||||
capabilities: {
|
|
||||||
alwaysMatch: {
|
|
||||||
browserName: "firefox",
|
|
||||||
"moz:firefoxOptions": {
|
|
||||||
binary: FIREFOX_BIN,
|
|
||||||
args: [
|
|
||||||
"-headless",
|
|
||||||
// Mandatory on Firefox 153: without it,
|
|
||||||
// navigating to moz-extension:// and running
|
|
||||||
// chrome-context script both fail with
|
|
||||||
// "unsupported operation".
|
|
||||||
//
|
|
||||||
// It grants the driver FULL CHROME PRIVILEGES
|
|
||||||
// over this browser. Acceptable only because
|
|
||||||
// the browser is a throwaway in a CI
|
|
||||||
// container; never point a session with this
|
|
||||||
// flag at anything you care about.
|
|
||||||
"-remote-allow-system-access",
|
|
||||||
],
|
|
||||||
prefs,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
this.sessionId = value.sessionId;
|
|
||||||
await this.session("POST", "/timeouts", { script: SCRIPT_TIMEOUT_MS });
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Installs the unpacked MV2 build straight from a directory.
|
|
||||||
// temporary:true bypasses signature checks, so no XPI and no signing
|
|
||||||
// are involved, and the add-on dies with the profile.
|
|
||||||
async installAddon(dir) {
|
|
||||||
return this.session("POST", "/moz/addon/install", {
|
|
||||||
path: dir,
|
|
||||||
temporary: true,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Classic navigation on purpose. BiDi's browsingContext.navigate
|
|
||||||
// refuses moz-extension:// URLs outright.
|
|
||||||
async navigate(url) {
|
|
||||||
await this.session("POST", "/url", { url });
|
|
||||||
}
|
|
||||||
|
|
||||||
async quit() {
|
|
||||||
if (this.sessionId) {
|
|
||||||
await this.session("DELETE", "").catch(() => {});
|
|
||||||
this.sessionId = null;
|
|
||||||
}
|
|
||||||
this.proc.kill("SIGTERM");
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------------- scripts
|
|
||||||
|
|
||||||
async setContext(context) {
|
|
||||||
if (this.context === context) return;
|
|
||||||
await this.session("POST", "/moz/context", { context });
|
|
||||||
this.context = context;
|
|
||||||
}
|
|
||||||
|
|
||||||
async execute(script, args = []) {
|
|
||||||
await this.setContext("content");
|
|
||||||
return this.session("POST", "/execute/sync", { script, args });
|
|
||||||
}
|
|
||||||
|
|
||||||
// The asynchronous form: the script is handed a resolve callback as its
|
|
||||||
// last argument and the call settles when that is invoked. Everything
|
|
||||||
// interesting about an extension page is promise-shaped — storage reads,
|
|
||||||
// the provider's own request() — and /execute/sync cannot wait for any
|
|
||||||
// of it.
|
|
||||||
async executeAsync(script, args = []) {
|
|
||||||
await this.setContext("content");
|
|
||||||
return this.session("POST", "/execute/async", { script, args });
|
|
||||||
}
|
|
||||||
|
|
||||||
// Runs in the privileged chrome scope, where Services and Ci exist.
|
|
||||||
async executeChrome(script, args = []) {
|
|
||||||
await this.setContext("chrome");
|
|
||||||
try {
|
|
||||||
return await this.session("POST", "/execute/sync", {
|
|
||||||
script,
|
|
||||||
args,
|
|
||||||
});
|
|
||||||
} finally {
|
|
||||||
await this.setContext("content");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------- page waits
|
|
||||||
|
|
||||||
// Polls a content-context expression until it returns truthy. Every
|
|
||||||
// wait in the suite goes through here so a timeout always says which
|
|
||||||
// condition it was waiting on rather than "timed out".
|
|
||||||
async waitFor(what, script, args = [], timeout = DEFAULT_WAIT_MS) {
|
|
||||||
const deadline = Date.now() + timeout;
|
|
||||||
let last = null;
|
|
||||||
for (;;) {
|
|
||||||
try {
|
|
||||||
const v = await this.execute(script, args);
|
|
||||||
if (v) return v;
|
|
||||||
last = null;
|
|
||||||
} catch (e) {
|
|
||||||
// A navigation or view swap in flight makes execute
|
|
||||||
// throw; that is a not-yet, not a failure, until the
|
|
||||||
// deadline says otherwise.
|
|
||||||
last = e.message;
|
|
||||||
}
|
|
||||||
if (Date.now() >= deadline) {
|
|
||||||
throw new Error(
|
|
||||||
"timed out after " +
|
|
||||||
timeout +
|
|
||||||
"ms waiting for " +
|
|
||||||
what +
|
|
||||||
(last ? " (last error: " + last + ")" : ""),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
await sleep(POLL_INTERVAL_MS);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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.
|
|
||||||
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;
|
|
||||||
const r = el.getBoundingClientRect();
|
|
||||||
return r.width > 0 && r.height > 0;`,
|
|
||||||
[selector],
|
|
||||||
timeout,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async isVisible(selector) {
|
|
||||||
return this.execute(
|
|
||||||
`const el = document.querySelector(arguments[0]);
|
|
||||||
if (!el) return false;
|
|
||||||
const r = el.getBoundingClientRect();
|
|
||||||
return r.width > 0 && r.height > 0;`,
|
|
||||||
[selector],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async count(selector) {
|
|
||||||
return this.execute(
|
|
||||||
"return document.querySelectorAll(arguments[0]).length;",
|
|
||||||
[selector],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async text(selector) {
|
|
||||||
return this.execute(
|
|
||||||
`const el = document.querySelector(arguments[0]);
|
|
||||||
return el ? el.textContent : null;`,
|
|
||||||
[selector],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async title() {
|
|
||||||
return this.session("GET", "/title");
|
|
||||||
}
|
|
||||||
|
|
||||||
// The id of the view element currently on top, which is what a
|
|
||||||
// failing step needs to report: "the screen did not change" is only
|
|
||||||
// useful if it says which screen it stayed on.
|
|
||||||
async currentView() {
|
|
||||||
return this.execute(
|
|
||||||
`const views = document.querySelectorAll('[id^="view-"]');
|
|
||||||
for (const v of views) {
|
|
||||||
const r = v.getBoundingClientRect();
|
|
||||||
if (r.width > 0 && r.height > 0) return v.id;
|
|
||||||
}
|
|
||||||
return null;`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ----------------------------------------------------- interactions
|
|
||||||
|
|
||||||
async findElement(selector) {
|
|
||||||
const value = await this.session("POST", "/element", {
|
|
||||||
using: "css selector",
|
|
||||||
value: selector,
|
|
||||||
});
|
|
||||||
const ref = value && value[WEB_ELEMENT_KEY];
|
|
||||||
if (typeof ref !== "string") {
|
|
||||||
throw new Error(
|
|
||||||
"no " +
|
|
||||||
WEB_ELEMENT_KEY +
|
|
||||||
" in the element response for " +
|
|
||||||
selector +
|
|
||||||
": " +
|
|
||||||
JSON.stringify(value),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return ref;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Real WebDriver clicks and real key events rather than in-page
|
|
||||||
// .click() and value assignment: the popup's handlers are wired to
|
|
||||||
// events, and synthesising them from inside the page would test the
|
|
||||||
// harness's idea of the UI instead of the UI.
|
|
||||||
async click(selector) {
|
|
||||||
await this.waitVisible(selector);
|
|
||||||
const id = await this.findElement(selector);
|
|
||||||
await this.session("POST", "/element/" + id + "/click", {});
|
|
||||||
}
|
|
||||||
|
|
||||||
async fill(selector, value) {
|
|
||||||
await this.waitVisible(selector);
|
|
||||||
const id = await this.findElement(selector);
|
|
||||||
await this.session("POST", "/element/" + id + "/clear", {});
|
|
||||||
await this.session("POST", "/element/" + id + "/value", {
|
|
||||||
text: String(value),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async value(selector) {
|
|
||||||
return this.execute(
|
|
||||||
`const el = document.querySelector(arguments[0]);
|
|
||||||
return el ? el.value : null;`,
|
|
||||||
[selector],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------------ windows
|
|
||||||
//
|
|
||||||
// The approval prompts this suite drives are separate top-level windows
|
|
||||||
// the extension opens itself, so every one of them is a window handle
|
|
||||||
// here and the suite has to move between them explicitly.
|
|
||||||
|
|
||||||
async windowHandles() {
|
|
||||||
return this.session("GET", "/window/handles");
|
|
||||||
}
|
|
||||||
|
|
||||||
async currentWindow() {
|
|
||||||
return this.session("GET", "/window");
|
|
||||||
}
|
|
||||||
|
|
||||||
async switchToWindow(handle) {
|
|
||||||
await this.setContext("content");
|
|
||||||
await this.session("POST", "/window", { handle });
|
|
||||||
}
|
|
||||||
|
|
||||||
async newWindow(type = "window") {
|
|
||||||
await this.setContext("content");
|
|
||||||
const value = await this.session("POST", "/window/new", { type });
|
|
||||||
return value.handle;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Closes the current window and leaves the session on `fallback`, because
|
|
||||||
// a session whose current window is gone fails every subsequent command
|
|
||||||
// with "no such window" rather than with anything diagnosable.
|
|
||||||
async closeWindow(fallback) {
|
|
||||||
await this.setContext("content");
|
|
||||||
await this.session("DELETE", "/window");
|
|
||||||
if (fallback) await this.switchToWindow(fallback);
|
|
||||||
}
|
|
||||||
|
|
||||||
async url() {
|
|
||||||
return this.session("GET", "/url");
|
|
||||||
}
|
|
||||||
|
|
||||||
// The handle of the first window whose URL matches, or null. Restores the
|
|
||||||
// window that was current before the search either way: a probe that
|
|
||||||
// silently relocates the session is a trap for the step after it.
|
|
||||||
async findWindow(predicate) {
|
|
||||||
const origin = await this.currentWindow();
|
|
||||||
try {
|
|
||||||
for (const handle of await this.windowHandles()) {
|
|
||||||
await this.switchToWindow(handle);
|
|
||||||
if (predicate(await this.url())) return handle;
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
} finally {
|
|
||||||
// Tolerated: the window the search started from may have been the
|
|
||||||
// one that just closed, and a throw in here would replace the
|
|
||||||
// real result with "no such window".
|
|
||||||
await this.switchToWindow(origin).catch(() => {});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------- error capture
|
|
||||||
|
|
||||||
// Uncaught errors from extension code, read out of the privileged console
|
|
||||||
// service.
|
|
||||||
//
|
|
||||||
// This is not the obvious mechanism, and the obvious one does not work:
|
|
||||||
// WebDriver BiDi's log.entryAdded delivers NOTHING for extension pages.
|
|
||||||
// Verified on Firefox 142 and 153 against a same-session control — a plain
|
|
||||||
// http:// page yields uncaught errors with stack traces, the
|
|
||||||
// moz-extension:// popup yields zero events, because the remote agent
|
|
||||||
// excludes extension browsing contexts from BiDi observation. A harness
|
|
||||||
// built on Playwright-BiDi or Puppeteer-BiDi therefore sees nothing and
|
|
||||||
// reports success. Do not "simplify" this back to BiDi.
|
|
||||||
//
|
|
||||||
// nsIConsoleService is not per-page: it also carries errors from the
|
|
||||||
// background page, which BiDi would not have covered even if it worked.
|
|
||||||
// Background-page capture is verified by probe — a throw at the top of
|
|
||||||
// src/background/index.js, which kills the background page outright, fails
|
|
||||||
// the run.
|
|
||||||
//
|
|
||||||
// Content scripts ARE now exercised: tests/e2e/firefox/dapp.js serves a page
|
|
||||||
// from loopback, which survives --network none, and the suite drives the
|
|
||||||
// EIP-1193 round trips through the content script injected into it. What is
|
|
||||||
// still unproven is the CAPTURE, not the execution — no probe has forced a
|
|
||||||
// throw from inside a content script and watched it fail the run, so an
|
|
||||||
// uncaught content-script error arriving by this route remains an
|
|
||||||
// expectation rather than a demonstrated fact. Do not claim otherwise.
|
|
||||||
//
|
|
||||||
// Warnings are excluded so the semantics match Playwright's pageerror:
|
|
||||||
// uncaught errors only.
|
|
||||||
//
|
|
||||||
// The read and the clear are ONE chrome script on purpose. Splitting them
|
|
||||||
// into two round trips leaves a blind window between them in which an
|
|
||||||
// error is logged into a buffer that is about to be discarded, and is
|
|
||||||
// destroyed unread rather than deferred to the next drain. That was not
|
|
||||||
// theoretical: with a separate reset() call, a probe of 100 sequenced
|
|
||||||
// throws at 20ms spacing lost one of them outright.
|
|
||||||
const DRAIN_ERRORS_SCRIPT = `
|
|
||||||
const origin = arguments[0];
|
|
||||||
const out = [];
|
|
||||||
for (const raw of Services.console.getMessageArray() || []) {
|
|
||||||
let e;
|
|
||||||
try {
|
|
||||||
e = raw.QueryInterface(Ci.nsIScriptError);
|
|
||||||
} catch (_) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (e.flags & Ci.nsIScriptError.warningFlag) continue;
|
|
||||||
const src = e.sourceName || "";
|
|
||||||
if (!src.startsWith(origin)) continue;
|
|
||||||
out.push({
|
|
||||||
msg: e.errorMessage,
|
|
||||||
src: src,
|
|
||||||
line: e.lineNumber,
|
|
||||||
cat: e.category,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
Services.console.reset();
|
|
||||||
return out;
|
|
||||||
`;
|
|
||||||
|
|
||||||
class ConsoleErrors {
|
|
||||||
constructor(driver, originPrefix) {
|
|
||||||
this.driver = driver;
|
|
||||||
this.originPrefix = originPrefix;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Everything logged since the last take, read and cleared atomically
|
|
||||||
// in a single chrome round trip. Poll-based, so an error is attributed
|
|
||||||
// to the step that was running when it was drained, not to the moment
|
|
||||||
// inside that step at which it happened — see the limitation note in
|
|
||||||
// run.js. An error that arrives mid-drain is not lost — it makes this
|
|
||||||
// batch or the next one — but the console service ring buffer holds
|
|
||||||
// only 250 messages, so more than that between two takes evicts the
|
|
||||||
// oldest unread. A clean run peaks at 4.
|
|
||||||
async take() {
|
|
||||||
const found = await this.driver.executeChrome(DRAIN_ERRORS_SCRIPT, [
|
|
||||||
this.originPrefix,
|
|
||||||
]);
|
|
||||||
return found || [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------------- startup
|
|
||||||
|
|
||||||
async function waitForDriverReady(base, timeoutMs) {
|
|
||||||
const deadline = Date.now() + timeoutMs;
|
|
||||||
for (;;) {
|
|
||||||
try {
|
|
||||||
const res = await fetch(base + "/status");
|
|
||||||
if (res.ok) {
|
|
||||||
const body = await res.json();
|
|
||||||
if (body && body.value && body.value.ready !== false) return;
|
|
||||||
}
|
|
||||||
} catch (_) {
|
|
||||||
// not listening yet
|
|
||||||
}
|
|
||||||
if (Date.now() >= deadline) {
|
|
||||||
throw new Error(
|
|
||||||
"geckodriver did not become ready within " + timeoutMs + "ms",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
await sleep(POLL_INTERVAL_MS);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function start() {
|
|
||||||
const port = await freePort();
|
|
||||||
const proc = spawn(
|
|
||||||
GECKODRIVER,
|
|
||||||
["--port", String(port), "--host", "127.0.0.1"],
|
|
||||||
{ stdio: ["ignore", "inherit", "inherit"] },
|
|
||||||
);
|
|
||||||
proc.on("error", (e) => {
|
|
||||||
console.error("geckodriver failed to spawn: " + e.message);
|
|
||||||
});
|
|
||||||
|
|
||||||
const base = "http://127.0.0.1:" + port;
|
|
||||||
try {
|
|
||||||
await waitForDriverReady(base, 30000);
|
|
||||||
} catch (e) {
|
|
||||||
proc.kill("SIGKILL");
|
|
||||||
throw e;
|
|
||||||
}
|
|
||||||
return new Driver(proc, base);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
ConsoleErrors,
|
|
||||||
Driver,
|
|
||||||
EXTENSION_ID,
|
|
||||||
EXTENSION_ORIGIN,
|
|
||||||
EXTENSION_UUID,
|
|
||||||
start,
|
|
||||||
sleep,
|
|
||||||
};
|
|
||||||
@@ -1,953 +0,0 @@
|
|||||||
// Firefox end-to-end suite: drives the real popup in a real Firefox with
|
|
||||||
// the unpacked MV2 build installed as a temporary add-on, and fails the run
|
|
||||||
// on any uncaught error coming from an extension source.
|
|
||||||
//
|
|
||||||
// Run via script/test-e2e-firefox, which builds dist/firefox/ and the pinned
|
|
||||||
// container. The extension directory is the one argument.
|
|
||||||
//
|
|
||||||
// node tests/e2e/firefox/run.js [dist/firefox]
|
|
||||||
//
|
|
||||||
// Deliberately not part of script/check, and deliberately not named
|
|
||||||
// *.test.js: REPO_POLICIES.md caps make test at 20 seconds and a browser
|
|
||||||
// suite does not fit.
|
|
||||||
//
|
|
||||||
// This shares no driver layer with the Chrome suite in tests/e2e/, and the
|
|
||||||
// UI steps below are written twice on purpose. Chrome runs on Playwright,
|
|
||||||
// which cannot see extension-page errors in Firefox at all (see the BiDi
|
|
||||||
// note in driver.js), so the two backends have no common substrate to
|
|
||||||
// abstract over. Duplicated steps do not pay for a shim; revisit if this
|
|
||||||
// suite grows to where they do. What IS shared is the dApp page fixture
|
|
||||||
// itself — DAPP_HTML, served here from loopback by dapp.js — so an assertion
|
|
||||||
// about the __dapp API means the same thing on both browsers.
|
|
||||||
//
|
|
||||||
// The dApp steps need an http:// origin, which --network none was thought to
|
|
||||||
// rule out. It does not: loopback survives it, so the page and the stub node
|
|
||||||
// are served from 127.0.0.1 inside the container and the run reaches nothing
|
|
||||||
// but this process. See tests/e2e/firefox/dapp.js.
|
|
||||||
//
|
|
||||||
// LIMITATION, and the difference from the Chrome suite worth knowing: error
|
|
||||||
// capture here is POLL-BASED, not event-streamed. The console service is
|
|
||||||
// drained at each step boundary, so an error is attributed to the step it
|
|
||||||
// was drained after, never to a moment within that step. What is drained
|
|
||||||
// covers the whole run from add-on install to the last drain below, which
|
|
||||||
// lands ~1.5s after the last step returns (500ms settle + 1000ms sleep +
|
|
||||||
// two drain round trips). That cut-off jitters run to run: three runs of
|
|
||||||
// throws at fixed offsets reported everything to +1.5s and one of them
|
|
||||||
// also +1.6s, and past it the browser is torn down first. Inside the
|
|
||||||
// window there is no race — the drain reads and clears in one chrome
|
|
||||||
// round trip — but there is a capacity limit: nsIConsoleService keeps
|
|
||||||
// only the newest 250 messages, so 400 throws in one step report as
|
|
||||||
// exactly 250. A clean run peaks at 4 of 250, so that is headroom today
|
|
||||||
// and not a guarantee for a step that logs heavily. The Chrome harness
|
|
||||||
// receives pageerror events as they happen and can say more. Do not read
|
|
||||||
// a green Firefox run as the same claim.
|
|
||||||
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
const fs = require("fs");
|
|
||||||
const path = require("path");
|
|
||||||
|
|
||||||
const {
|
|
||||||
Transaction,
|
|
||||||
formatEther,
|
|
||||||
getAddress,
|
|
||||||
getBytes,
|
|
||||||
hexlify,
|
|
||||||
parseEther,
|
|
||||||
toQuantity,
|
|
||||||
toUtf8Bytes,
|
|
||||||
verifyMessage,
|
|
||||||
} = require("ethers");
|
|
||||||
|
|
||||||
const { ConsoleErrors, EXTENSION_ORIGIN, start, sleep } = require("./driver");
|
|
||||||
const { startDappServer } = require("./dapp");
|
|
||||||
const { STUB_COUNTERPARTY } = require("../network");
|
|
||||||
|
|
||||||
const REPO_ROOT = path.resolve(__dirname, "..", "..", "..");
|
|
||||||
const POPUP_URL = EXTENSION_ORIGIN + "/src/popup/index.html";
|
|
||||||
const PASSWORD = "e2e-harness-password";
|
|
||||||
|
|
||||||
// Firefox installs the add-on and starts its background page asynchronously
|
|
||||||
// after the install call returns. Nothing observable marks the end of that,
|
|
||||||
// so the popup's own first render is the signal we wait on instead.
|
|
||||||
const STEP_TIMEOUT_MS = 120000;
|
|
||||||
|
|
||||||
const steps = [];
|
|
||||||
|
|
||||||
function step(name, fn) {
|
|
||||||
steps.push({ name, fn });
|
|
||||||
}
|
|
||||||
|
|
||||||
function assert(cond, message) {
|
|
||||||
if (!cond) throw new Error(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
function withTimeout(promise, name) {
|
|
||||||
let timer;
|
|
||||||
const timeout = new Promise((_, reject) => {
|
|
||||||
timer = setTimeout(
|
|
||||||
() =>
|
|
||||||
reject(
|
|
||||||
new Error(
|
|
||||||
name + " timed out after " + STEP_TIMEOUT_MS + "ms",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
STEP_TIMEOUT_MS,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
return Promise.race([promise, timeout]).finally(() => clearTimeout(timer));
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------------- steps
|
|
||||||
|
|
||||||
step("popup loads and reaches the welcome view", async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
await d.navigate(POPUP_URL);
|
|
||||||
await d.waitVisible("#view-welcome", STEP_TIMEOUT_MS);
|
|
||||||
const title = await d.title();
|
|
||||||
assert(title === "AutistMask", "unexpected popup title: " + title);
|
|
||||||
});
|
|
||||||
|
|
||||||
step("wallet creation through the UI reaches the main view", async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
await d.click("#btn-welcome-add");
|
|
||||||
await d.waitVisible("#view-add-wallet");
|
|
||||||
await d.click("#btn-generate-phrase");
|
|
||||||
await d.waitFor(
|
|
||||||
"a generated recovery phrase of at least 12 words",
|
|
||||||
`const el = document.getElementById("wallet-mnemonic");
|
|
||||||
return !!el && el.value.trim().split(/\\s+/).length >= 12;`,
|
|
||||||
);
|
|
||||||
env.phrase = (await d.value("#wallet-mnemonic")).trim();
|
|
||||||
|
|
||||||
await d.fill("#add-wallet-password", PASSWORD);
|
|
||||||
await d.fill("#add-wallet-password-confirm", PASSWORD);
|
|
||||||
await d.click("#btn-add-wallet-confirm");
|
|
||||||
// Argon2id under libsodium, for real, so this is the slow one.
|
|
||||||
await d.waitVisible("#view-main", STEP_TIMEOUT_MS);
|
|
||||||
|
|
||||||
assert(
|
|
||||||
env.phrase.split(/\s+/).length >= 12,
|
|
||||||
"wallet creation did not yield a recovery phrase",
|
|
||||||
);
|
|
||||||
const addrs = await d.count("#wallet-list .btn-addr-info");
|
|
||||||
assert(addrs > 0, "no addresses rendered in the wallet list");
|
|
||||||
});
|
|
||||||
|
|
||||||
step("add token screen opens from address detail", async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
if (!(await d.isVisible("#view-address"))) {
|
|
||||||
await d.waitVisible("#view-main");
|
|
||||||
await d.click("#wallet-list .btn-addr-info");
|
|
||||||
}
|
|
||||||
await d.waitVisible("#view-address");
|
|
||||||
|
|
||||||
await d.click("#btn-add-token");
|
|
||||||
// Reported with the view it actually stayed on: a screen that does
|
|
||||||
// not change is the symptom a missing import produces, and naming
|
|
||||||
// the screen is what makes that diagnosable.
|
|
||||||
try {
|
|
||||||
await d.waitVisible("#view-add-token");
|
|
||||||
} catch (e) {
|
|
||||||
throw new Error(
|
|
||||||
e.message + "; current view is " + (await d.currentView()),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const picks = await d.count("#common-token-list .common-token");
|
|
||||||
assert(picks > 0, "no common-token quick-pick buttons rendered");
|
|
||||||
});
|
|
||||||
|
|
||||||
// ------------------------------------------------- the dApp round trips
|
|
||||||
//
|
|
||||||
// Everything above drives the popup on its own. From here the page, the
|
|
||||||
// content script, the inpage provider, the background page and the approval
|
|
||||||
// window all have to work together, which on Firefox is exactly the seam
|
|
||||||
// https://git.eeqj.de/sneak/AutistMask/issues/153 is about: every one of
|
|
||||||
// these paths used to hand a Chrome-style callback to the promise-only
|
|
||||||
// browser.* namespace and simply never complete.
|
|
||||||
//
|
|
||||||
// The shape is the Chrome suite's (tests/e2e/run.js, the #183 section) and
|
|
||||||
// the assertions mean the same things:
|
|
||||||
//
|
|
||||||
// - the signature is recovered here, in the runner, from the artifact the
|
|
||||||
// extension produced, and compared against the address read out of
|
|
||||||
// extension storage. The background verifies too; these assertions do not
|
|
||||||
// lean on that, because a test that trusted the wallet's own verdict would
|
|
||||||
// pass against a wallet that verified nothing.
|
|
||||||
// - the transaction is asserted against the raw signed transaction that
|
|
||||||
// reached the stub node, not against anything the extension reported.
|
|
||||||
//
|
|
||||||
// What this does NOT cover: a real dApp with real funds against a real
|
|
||||||
// network. The node is a fixture on loopback.
|
|
||||||
|
|
||||||
const SIGN_TEXT = "AutistMask e2e round trip: personal_sign";
|
|
||||||
const SIGN_HEX = hexlify(toUtf8Bytes(SIGN_TEXT));
|
|
||||||
|
|
||||||
const TX_VALUE_ETH = "0.0123";
|
|
||||||
const TX_VALUE_WEI = parseEther(TX_VALUE_ETH);
|
|
||||||
// Call data that decodes as nothing, so the screen assertion compares the
|
|
||||||
// calldata itself rather than a decoder's summary of it.
|
|
||||||
const TX_DATA = "0xdeadbeef" + "01".repeat(28);
|
|
||||||
|
|
||||||
const USER_REJECTION_MESSAGE = "User rejected the request.";
|
|
||||||
|
|
||||||
// Read the extension's persisted state, point its rpcUrl at the loopback stub
|
|
||||||
// node, and hand back the active address. Runs on the popup page, which is
|
|
||||||
// the one moz-extension:// document the suite has open and therefore the only
|
|
||||||
// place the storage API is reachable from.
|
|
||||||
async function pointAtStubNode(d, rpcUrl) {
|
|
||||||
const outcome = await d.executeAsync(
|
|
||||||
`const done = arguments[arguments.length - 1];
|
|
||||||
const rpcUrl = arguments[0];
|
|
||||||
const api = typeof browser !== "undefined" ? browser : chrome;
|
|
||||||
Promise.resolve(api.storage.local.get("autistmask"))
|
|
||||||
.then((r) => {
|
|
||||||
const s = r.autistmask;
|
|
||||||
if (!s) throw new Error("the extension has no persisted state");
|
|
||||||
s.rpcUrl = rpcUrl;
|
|
||||||
const w = s.wallets && s.wallets[0];
|
|
||||||
const first = w && w.addresses && w.addresses[0];
|
|
||||||
const address = s.activeAddress || (first && first.address);
|
|
||||||
if (!address) throw new Error("the extension holds no address");
|
|
||||||
return Promise.resolve(api.storage.local.set({ autistmask: s }))
|
|
||||||
.then(() => done({ address: address }));
|
|
||||||
})
|
|
||||||
.catch((e) => done({ error: String((e && e.message) || e) }));`,
|
|
||||||
[rpcUrl],
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome && !outcome.error,
|
|
||||||
"could not point the extension at the stub node: " +
|
|
||||||
(outcome && outcome.error),
|
|
||||||
);
|
|
||||||
return getAddress(outcome.address);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The approval window the background opened. Approvals are raised from an RPC
|
|
||||||
// call rather than from a user gesture, so the extension opens a real window
|
|
||||||
// for them, which is an ordinary window handle here.
|
|
||||||
async function waitForApprovalWindow(d, timeout = 30000) {
|
|
||||||
const deadline = Date.now() + timeout;
|
|
||||||
for (;;) {
|
|
||||||
const handle = await d.findWindow((u) => u.includes("?approval="));
|
|
||||||
if (handle) return handle;
|
|
||||||
if (Date.now() > deadline) {
|
|
||||||
throw new Error(
|
|
||||||
"the extension opened no approval window within " +
|
|
||||||
timeout +
|
|
||||||
"ms",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
await sleep(100);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function startRequest(d, key, method, params) {
|
|
||||||
return d.execute(
|
|
||||||
"window.__dapp.start(arguments[0], arguments[1], arguments[2]);" +
|
|
||||||
" return true;",
|
|
||||||
[key, method, params],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The settled outcome of a parked request, or {settled:"pending"} if it is
|
|
||||||
// still outstanding. A bounded wait rather than a bare await: "returns a
|
|
||||||
// rejection rather than hanging" is one of the things under test, and an
|
|
||||||
// await would report a hang as a step timeout with no indication of which
|
|
||||||
// call never settled.
|
|
||||||
function settleRequest(d, key, timeout = 45000) {
|
|
||||||
return d.executeAsync(
|
|
||||||
`const done = arguments[arguments.length - 1];
|
|
||||||
const key = arguments[0];
|
|
||||||
const timeout = arguments[1];
|
|
||||||
Promise.race([
|
|
||||||
window.__dapp.settle(key),
|
|
||||||
new Promise((r) => setTimeout(() => r({ settled: "pending" }), timeout)),
|
|
||||||
]).then(done, (e) => done({ settled: "error", message: String(e) }));`,
|
|
||||||
[key, timeout],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Every AUTISTMASK_* message that has crossed between the page and the
|
|
||||||
// content script. This is the boundary half of the rejection assertion: the
|
|
||||||
// code has to be on the wire as well as on the Error the page catches, so a
|
|
||||||
// pass cannot come from the provider inventing one.
|
|
||||||
function dappMessages(d, type) {
|
|
||||||
return d.execute(
|
|
||||||
// `want` is bound outside the callback deliberately: inside it,
|
|
||||||
// arguments[0] is the message being tested, not the script argument,
|
|
||||||
// and the filter silently matches nothing.
|
|
||||||
"var want = arguments[0];" +
|
|
||||||
" return window.__dapp.messages.filter(function (m) {" +
|
|
||||||
" return !want || m.type === want; });",
|
|
||||||
[type || null],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function lastResponseError(d) {
|
|
||||||
const responses = await dappMessages(d, "AUTISTMASK_RESPONSE");
|
|
||||||
const last = responses[responses.length - 1];
|
|
||||||
assert(last, "the page received no AUTISTMASK_RESPONSE at all");
|
|
||||||
return last.error || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// A rejected prompt, asserted at both ends: the page's promise rejected
|
|
||||||
// rather than hanging or resolving, and the response that crossed the
|
|
||||||
// boundary carried EIP-1193 code 4001.
|
|
||||||
async function assertUserRejection(d, key, label) {
|
|
||||||
const outcome = await settleRequest(d, key);
|
|
||||||
assert(
|
|
||||||
outcome.settled !== "pending",
|
|
||||||
label + " never settled: the rejected prompt left the page hanging",
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.settled === "rejected",
|
|
||||||
label + " resolved instead of rejecting: " + JSON.stringify(outcome),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.message === USER_REJECTION_MESSAGE,
|
|
||||||
label + " rejected with the wrong message: " + outcome.message,
|
|
||||||
);
|
|
||||||
const error = await lastResponseError(d);
|
|
||||||
assert(
|
|
||||||
error && error.code === 4001,
|
|
||||||
label +
|
|
||||||
" did not carry EIP-1193 code 4001 across the boundary: " +
|
|
||||||
JSON.stringify(error),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.hasCode,
|
|
||||||
label +
|
|
||||||
" reached the page as an error with no code property at all, so a " +
|
|
||||||
"dApp cannot tell the user's refusal from a failure: " +
|
|
||||||
JSON.stringify(outcome),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.code === 4001,
|
|
||||||
label +
|
|
||||||
" reached the page with code " +
|
|
||||||
JSON.stringify(outcome.code) +
|
|
||||||
" rather than EIP-1193 4001",
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.name === "ProviderRpcError",
|
|
||||||
label +
|
|
||||||
" reached the page as " +
|
|
||||||
JSON.stringify(outcome.name) +
|
|
||||||
" rather than an EIP-1193 ProviderRpcError",
|
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
"# " +
|
|
||||||
label +
|
|
||||||
": code 4001 on the wire and on the page's " +
|
|
||||||
outcome.name,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
step("the loopback dApp page gets the real inpage provider", async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
|
|
||||||
// The popup is still the current window; point the extension at the stub
|
|
||||||
// node from there, then reload it so its in-memory copy of the state
|
|
||||||
// carries the new rpcUrl and cannot save the old one back over it.
|
|
||||||
env.address = await pointAtStubNode(d, env.server.rpcUrl);
|
|
||||||
await d.navigate(POPUP_URL);
|
|
||||||
await d.waitVisible("#view-main", STEP_TIMEOUT_MS);
|
|
||||||
env.popupWindow = await d.currentWindow();
|
|
||||||
|
|
||||||
env.dappWindow = await d.newWindow("tab");
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
await d.navigate(env.server.url);
|
|
||||||
|
|
||||||
// window.ethereum is not the fixture's doing — it is the shipped content
|
|
||||||
// script, injected into a real http:// origin. Waiting for it is waiting
|
|
||||||
// for the real provider to have installed itself.
|
|
||||||
await d.waitFor(
|
|
||||||
"the injected EIP-1193 provider and the test page API",
|
|
||||||
"return !!window.ethereum && !!window.__dapp;",
|
|
||||||
[],
|
|
||||||
STEP_TIMEOUT_MS,
|
|
||||||
);
|
|
||||||
|
|
||||||
// EIP-6963, asked of the provider itself. The announcement carries the
|
|
||||||
// uuid src/content/index.js reads out of extension storage — call site 1
|
|
||||||
// in the issue — and it has to name this extension and hand back the very
|
|
||||||
// object on window.ethereum.
|
|
||||||
const announced = await d.executeAsync(
|
|
||||||
`const done = arguments[arguments.length - 1];
|
|
||||||
const onAnnounce = (e) => {
|
|
||||||
window.removeEventListener("eip6963:announceProvider", onAnnounce);
|
|
||||||
done({
|
|
||||||
rdns: e.detail.info.rdns,
|
|
||||||
uuid: e.detail.info.uuid,
|
|
||||||
isWindowEthereum: e.detail.provider === window.ethereum,
|
|
||||||
});
|
|
||||||
};
|
|
||||||
window.addEventListener("eip6963:announceProvider", onAnnounce);
|
|
||||||
window.dispatchEvent(new Event("eip6963:requestProvider"));
|
|
||||||
setTimeout(() => done(null), 15000);`,
|
|
||||||
);
|
|
||||||
assert(announced, "the provider announced itself to no EIP-6963 request");
|
|
||||||
assert(
|
|
||||||
announced.rdns === "berlin.sneak.autistmask",
|
|
||||||
"the announced provider is not this extension: " +
|
|
||||||
JSON.stringify(announced),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
announced.isWindowEthereum,
|
|
||||||
"the announced provider is not the object on window.ethereum",
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
typeof announced.uuid === "string" && announced.uuid.length === 36,
|
|
||||||
"the announcement carries no stored provider uuid: " +
|
|
||||||
JSON.stringify(announced.uuid),
|
|
||||||
);
|
|
||||||
|
|
||||||
// A full page -> content script -> background round trip that needs no
|
|
||||||
// approval, so the relay is proven before any prompt is driven. This is
|
|
||||||
// call site 2, the one that used to fail for every window.ethereum
|
|
||||||
// request a dApp made.
|
|
||||||
const chainId = await d.executeAsync(
|
|
||||||
`const done = arguments[arguments.length - 1];
|
|
||||||
window.ethereum.request({ method: "eth_chainId" }).then(
|
|
||||||
(r) => done({ ok: r }),
|
|
||||||
(e) => done({ err: String((e && e.message) || e) }),
|
|
||||||
);`,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
chainId && chainId.ok === "0x1",
|
|
||||||
"eth_chainId did not round trip through the extension: " +
|
|
||||||
JSON.stringify(chainId),
|
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
"# dapp origin " + env.server.origin + " active address " + env.address,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
step(
|
|
||||||
"eth_requestAccounts approved returns the selected address",
|
|
||||||
async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
await startRequest(d, "accounts", "eth_requestAccounts", []);
|
|
||||||
|
|
||||||
const popup = await waitForApprovalWindow(d);
|
|
||||||
await d.switchToWindow(popup);
|
|
||||||
await d.waitVisible("#view-approve-site");
|
|
||||||
|
|
||||||
const hostname = await d.text("#approve-hostname");
|
|
||||||
assert(
|
|
||||||
hostname === "127.0.0.1",
|
|
||||||
"the site prompt names the wrong origin: " +
|
|
||||||
JSON.stringify(hostname),
|
|
||||||
);
|
|
||||||
const shown = await d.text("#approve-address");
|
|
||||||
assert(
|
|
||||||
shown.toLowerCase().includes(env.address.toLowerCase()),
|
|
||||||
"the site prompt shows the wrong address: " + JSON.stringify(shown),
|
|
||||||
);
|
|
||||||
|
|
||||||
// Remembered, so the origin stays authorized for the sign and transaction
|
|
||||||
// steps below.
|
|
||||||
const checked = await d.execute(
|
|
||||||
'return document.getElementById("approve-remember").checked;',
|
|
||||||
);
|
|
||||||
if (!checked) await d.click("#approve-remember");
|
|
||||||
await d.click("#btn-approve");
|
|
||||||
|
|
||||||
// The approve button closes its own window, so get off it before asking
|
|
||||||
// the page anything.
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
const outcome = await settleRequest(d, "accounts");
|
|
||||||
assert(
|
|
||||||
outcome.settled === "resolved",
|
|
||||||
"eth_requestAccounts did not resolve: " + JSON.stringify(outcome),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
Array.isArray(outcome.result) && outcome.result.length === 1,
|
|
||||||
"eth_requestAccounts returned no single account: " +
|
|
||||||
JSON.stringify(outcome.result),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
getAddress(outcome.result[0]) === env.address,
|
|
||||||
"eth_requestAccounts returned " +
|
|
||||||
outcome.result[0] +
|
|
||||||
", not the selected address " +
|
|
||||||
env.address,
|
|
||||||
);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
step(
|
|
||||||
"personal_sign returns a signature that recovers to the address",
|
|
||||||
async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
await startRequest(d, "sign", "personal_sign", [SIGN_HEX, env.address]);
|
|
||||||
|
|
||||||
const popup = await waitForApprovalWindow(d);
|
|
||||||
await d.switchToWindow(popup);
|
|
||||||
await d.waitVisible("#view-approve-sign");
|
|
||||||
|
|
||||||
const screen = await d.execute(
|
|
||||||
`return {
|
|
||||||
hostname: document.getElementById("approve-sign-hostname").textContent,
|
|
||||||
type: document.getElementById("approve-sign-type").textContent,
|
|
||||||
message: document.getElementById("approve-sign-message").textContent,
|
|
||||||
from: document.getElementById("approve-sign-from").textContent,
|
|
||||||
};`,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.hostname === "127.0.0.1",
|
|
||||||
"the sign prompt names the wrong origin: " +
|
|
||||||
JSON.stringify(screen.hostname),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.type === "Personal message",
|
|
||||||
"the sign prompt reports the wrong type: " +
|
|
||||||
JSON.stringify(screen.type),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.message === SIGN_TEXT,
|
|
||||||
"the sign prompt shows the wrong message: " +
|
|
||||||
JSON.stringify(screen.message),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.from.toLowerCase().includes(env.address.toLowerCase()),
|
|
||||||
"the sign prompt shows the wrong signing address: " +
|
|
||||||
JSON.stringify(screen.from),
|
|
||||||
);
|
|
||||||
|
|
||||||
await d.fill("#approve-sign-password", PASSWORD);
|
|
||||||
await d.click("#btn-approve-sign");
|
|
||||||
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
const outcome = await settleRequest(d, "sign");
|
|
||||||
assert(
|
|
||||||
outcome.settled === "resolved",
|
|
||||||
"personal_sign did not resolve: " + JSON.stringify(outcome),
|
|
||||||
);
|
|
||||||
const recovered = getAddress(
|
|
||||||
verifyMessage(getBytes(SIGN_HEX), outcome.result),
|
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
"# personal_sign: recovered=" +
|
|
||||||
recovered +
|
|
||||||
" expected=" +
|
|
||||||
env.address,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
recovered === env.address,
|
|
||||||
"the personal_sign signature recovers to " +
|
|
||||||
recovered +
|
|
||||||
", not to the approved address " +
|
|
||||||
env.address,
|
|
||||||
);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
step(
|
|
||||||
"eth_sendTransaction shows the transaction and returns its hash",
|
|
||||||
async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
const before = env.server.broadcast.length;
|
|
||||||
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
await startRequest(d, "tx", "eth_sendTransaction", [
|
|
||||||
{
|
|
||||||
from: env.address,
|
|
||||||
to: STUB_COUNTERPARTY,
|
|
||||||
value: toQuantity(TX_VALUE_WEI),
|
|
||||||
data: TX_DATA,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
|
|
||||||
const popup = await waitForApprovalWindow(d);
|
|
||||||
await d.switchToWindow(popup);
|
|
||||||
await d.waitVisible("#view-approve-tx");
|
|
||||||
|
|
||||||
const screen = await d.execute(
|
|
||||||
`return {
|
|
||||||
hostname: document.getElementById("approve-tx-hostname").textContent,
|
|
||||||
from: document.getElementById("approve-tx-from").textContent,
|
|
||||||
to: document.getElementById("approve-tx-to").textContent,
|
|
||||||
value: document.getElementById("approve-tx-value").textContent,
|
|
||||||
data: document.getElementById("approve-tx-data").textContent,
|
|
||||||
dataShown: !document
|
|
||||||
.getElementById("approve-tx-data-section")
|
|
||||||
.classList.contains("hidden"),
|
|
||||||
};`,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.hostname === "127.0.0.1",
|
|
||||||
"the transaction prompt names the wrong origin: " +
|
|
||||||
JSON.stringify(screen.hostname),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.from.toLowerCase().includes(env.address.toLowerCase()),
|
|
||||||
"the transaction prompt shows the wrong sender: " +
|
|
||||||
JSON.stringify(screen.from),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.to.toLowerCase().includes(STUB_COUNTERPARTY.toLowerCase()),
|
|
||||||
"the transaction prompt shows the wrong recipient: " +
|
|
||||||
JSON.stringify(screen.to),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.value.startsWith(TX_VALUE_ETH + " ETH"),
|
|
||||||
"the transaction prompt shows the wrong value: " +
|
|
||||||
JSON.stringify(screen.value),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
screen.dataShown && screen.data === TX_DATA,
|
|
||||||
"the transaction prompt does not show the approved call data: " +
|
|
||||||
JSON.stringify(screen.data),
|
|
||||||
);
|
|
||||||
|
|
||||||
await d.fill("#approve-tx-password", PASSWORD);
|
|
||||||
await d.click("#btn-approve-tx");
|
|
||||||
|
|
||||||
// The approval window hands off to the wait screen rather than closing,
|
|
||||||
// and the hash it shows is asserted before it is retired: left open it
|
|
||||||
// polls the stub node for a receipt for the rest of the run.
|
|
||||||
await d.waitVisible("#view-wait-tx", STEP_TIMEOUT_MS);
|
|
||||||
const waitHash = await d.text("#wait-tx-hash");
|
|
||||||
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
const outcome = await settleRequest(d, "tx");
|
|
||||||
assert(
|
|
||||||
outcome.settled === "resolved",
|
|
||||||
"eth_sendTransaction did not resolve: " + JSON.stringify(outcome),
|
|
||||||
);
|
|
||||||
|
|
||||||
// The artifact as the node saw it, not as the extension described it.
|
|
||||||
assert(
|
|
||||||
env.server.broadcast.length === before + 1,
|
|
||||||
"expected exactly one raw transaction to reach the node, got " +
|
|
||||||
(env.server.broadcast.length - before),
|
|
||||||
);
|
|
||||||
const signed = Transaction.from(
|
|
||||||
env.server.broadcast[env.server.broadcast.length - 1],
|
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
"# eth_sendTransaction: signer=" +
|
|
||||||
getAddress(signed.from) +
|
|
||||||
" to=" +
|
|
||||||
getAddress(signed.to) +
|
|
||||||
" value=" +
|
|
||||||
formatEther(signed.value) +
|
|
||||||
" chainId=" +
|
|
||||||
signed.chainId,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
getAddress(signed.from) === env.address,
|
|
||||||
"the broadcast transaction was signed by " +
|
|
||||||
getAddress(signed.from) +
|
|
||||||
", not by the approved address " +
|
|
||||||
env.address,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
getAddress(signed.to) === getAddress(STUB_COUNTERPARTY),
|
|
||||||
"the broadcast transaction goes to " + signed.to,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
signed.value === TX_VALUE_WEI,
|
|
||||||
"the broadcast transaction carries " +
|
|
||||||
formatEther(signed.value) +
|
|
||||||
" ETH, not the approved " +
|
|
||||||
TX_VALUE_ETH,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
signed.data === TX_DATA,
|
|
||||||
"the broadcast transaction carries different call data: " +
|
|
||||||
signed.data,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
signed.chainId === 1n,
|
|
||||||
"the broadcast transaction is for chain " + signed.chainId,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
outcome.result === signed.hash,
|
|
||||||
"the page received " +
|
|
||||||
outcome.result +
|
|
||||||
", not the hash of the broadcast transaction " +
|
|
||||||
signed.hash,
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
waitHash.includes(signed.hash),
|
|
||||||
"the wait screen shows a different hash: " +
|
|
||||||
JSON.stringify(waitHash),
|
|
||||||
);
|
|
||||||
|
|
||||||
await d.switchToWindow(popup);
|
|
||||||
await d.closeWindow(env.dappWindow);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
step(
|
|
||||||
"closing an approval window rejects the request with 4001",
|
|
||||||
async (env) => {
|
|
||||||
const d = env.driver;
|
|
||||||
const before = env.server.broadcast.length;
|
|
||||||
|
|
||||||
await d.switchToWindow(env.dappWindow);
|
|
||||||
await startRequest(d, "sign-closed", "personal_sign", [
|
|
||||||
SIGN_HEX,
|
|
||||||
env.address,
|
|
||||||
]);
|
|
||||||
|
|
||||||
const popup = await waitForApprovalWindow(d);
|
|
||||||
await d.switchToWindow(popup);
|
|
||||||
await d.waitVisible("#view-approve-sign");
|
|
||||||
|
|
||||||
// Closed, not rejected: this is the windows.onRemoved path, which can
|
|
||||||
// only fire if windows.create() handed back a window id for the approval
|
|
||||||
// to be matched against — call site 4 in the issue, where the id used to
|
|
||||||
// be assigned from a callback the browser.* namespace never invoked.
|
|
||||||
await d.closeWindow(env.dappWindow);
|
|
||||||
|
|
||||||
await assertUserRejection(d, "sign-closed", "a closed approval window");
|
|
||||||
assert(
|
|
||||||
env.server.broadcast.length === before,
|
|
||||||
"a closed approval window still put a transaction on the node",
|
|
||||||
);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
// ------------------------------------------------------------- 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 : "") + ")"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function main() {
|
|
||||||
// A suite that runs nothing must never report success.
|
|
||||||
if (steps.length === 0) {
|
|
||||||
console.log("1..0");
|
|
||||||
console.log("# FAILED: the Firefox e2e suite registered no steps");
|
|
||||||
process.exitCode = 1;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const extDir = path.resolve(REPO_ROOT, process.argv[2] || "dist/firefox");
|
|
||||||
if (!fs.existsSync(path.join(extDir, "manifest.json"))) {
|
|
||||||
console.error(
|
|
||||||
"e2e-firefox: no unpacked build at " +
|
|
||||||
extDir +
|
|
||||||
" — run make build first",
|
|
||||||
);
|
|
||||||
process.exitCode = 1;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Loopback survives --network none, so this is the http:// origin the
|
|
||||||
// dApp steps need and the node they talk to. Started before the browser
|
|
||||||
// so its url is available to the first step that asks for it.
|
|
||||||
let server;
|
|
||||||
try {
|
|
||||||
server = await startDappServer();
|
|
||||||
} catch (e) {
|
|
||||||
console.error(
|
|
||||||
"e2e-firefox: cannot serve the dApp fixture: " + e.message,
|
|
||||||
);
|
|
||||||
process.exitCode = 1;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.log("# dapp fixture: " + server.url + " rpc " + server.rpcUrl);
|
|
||||||
|
|
||||||
let driver;
|
|
||||||
try {
|
|
||||||
driver = await start();
|
|
||||||
await driver.newSession();
|
|
||||||
await driver.installAddon(extDir);
|
|
||||||
} catch (e) {
|
|
||||||
// A browser we cannot start is a failure of the suite, not an
|
|
||||||
// absent suite. Never skip and report success.
|
|
||||||
console.error("e2e-firefox: cannot run the suite: " + e.message);
|
|
||||||
if (driver) await driver.quit().catch(() => {});
|
|
||||||
await server.close();
|
|
||||||
process.exitCode = 1;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const errors = new ConsoleErrors(driver, EXTENSION_ORIGIN);
|
|
||||||
const env = {
|
|
||||||
driver,
|
|
||||||
server,
|
|
||||||
phrase: null,
|
|
||||||
address: null,
|
|
||||||
dappWindow: null,
|
|
||||||
popupWindow: null,
|
|
||||||
};
|
|
||||||
|
|
||||||
console.log("# extension origin: " + EXTENSION_ORIGIN);
|
|
||||||
console.log("1.." + steps.length);
|
|
||||||
|
|
||||||
let failed = 0;
|
|
||||||
let n = 0;
|
|
||||||
try {
|
|
||||||
// Drain, never reset: anything the add-on logged while installing
|
|
||||||
// and starting its background page has no earlier step to belong
|
|
||||||
// to, so it is folded into step 1 below. Services.console.reset()
|
|
||||||
// here would DELETE it instead, and a background page that throws
|
|
||||||
// at the top of the file — a dead background page — would then
|
|
||||||
// produce a fully green run.
|
|
||||||
let installErrors = [];
|
|
||||||
let installFailure = null;
|
|
||||||
try {
|
|
||||||
installErrors = await errors.take();
|
|
||||||
} catch (e) {
|
|
||||||
installFailure =
|
|
||||||
"could not read the console after install: " + e.message;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const s of steps) {
|
|
||||||
n += 1;
|
|
||||||
let failure = null;
|
|
||||||
try {
|
|
||||||
await withTimeout(s.fn(env), s.name);
|
|
||||||
} catch (e) {
|
|
||||||
failure = e.message;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Let anything the step provoked reach the console service
|
|
||||||
// before draining it. Without this a failure logged on the
|
|
||||||
// way out of the step lands in the next step's drain, which
|
|
||||||
// still fails the run but blames the wrong step.
|
|
||||||
await sleep(500);
|
|
||||||
|
|
||||||
let found = [];
|
|
||||||
try {
|
|
||||||
found = await errors.take();
|
|
||||||
} catch (e) {
|
|
||||||
failure = failure || "could not read the console: " + e.message;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (n === 1) {
|
|
||||||
found = installErrors.concat(found);
|
|
||||||
installErrors = [];
|
|
||||||
failure = failure || installFailure;
|
|
||||||
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) {
|
|
||||||
failure =
|
|
||||||
n === 1
|
|
||||||
? "uncaught extension errors during add-on install, " +
|
|
||||||
"background startup or this step"
|
|
||||||
: "uncaught extension errors during this step";
|
|
||||||
}
|
|
||||||
|
|
||||||
if (failure) {
|
|
||||||
failed += 1;
|
|
||||||
console.log("not ok " + n + " - " + s.name);
|
|
||||||
console.log(" " + failure);
|
|
||||||
for (const e of found) console.log(" " + formatError(e));
|
|
||||||
} else {
|
|
||||||
console.log("ok " + n + " - " + s.name);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The tail: errors logged after the last step returned cannot be
|
|
||||||
// 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));
|
|
||||||
console.log(
|
|
||||||
"# " +
|
|
||||||
(steps.length - failed) +
|
|
||||||
"/" +
|
|
||||||
steps.length +
|
|
||||||
" steps passed",
|
|
||||||
);
|
|
||||||
if (trailing.length > 0) {
|
|
||||||
console.log(
|
|
||||||
"# " +
|
|
||||||
trailing.length +
|
|
||||||
" extension error(s) recorded after the last step, not " +
|
|
||||||
"attributable to any single step:",
|
|
||||||
);
|
|
||||||
for (const e of trailing) console.log("# " + formatError(e));
|
|
||||||
}
|
|
||||||
// A JSON-RPC method nothing answered means the extension asked the
|
|
||||||
// node something this fixture does not model, and whatever depended
|
|
||||||
// on the answer took the error branch instead. That is a hole in the
|
|
||||||
// fixture, not a pass.
|
|
||||||
if (server.unstubbed.length > 0) {
|
|
||||||
console.log(
|
|
||||||
"# FAILED: no fixture for JSON-RPC method(s) " +
|
|
||||||
[...new Set(server.unstubbed)].join(", "),
|
|
||||||
);
|
|
||||||
process.exitCode = 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (failed > 0 || trailing.length > 0) {
|
|
||||||
console.log("# FAILED");
|
|
||||||
process.exitCode = 1;
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
await driver.quit().catch(() => {});
|
|
||||||
await server.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
main().catch((e) => {
|
|
||||||
console.error("e2e-firefox: " + (e && e.stack ? e.stack : e));
|
|
||||||
process.exitCode = 1;
|
|
||||||
});
|
|
||||||
@@ -53,47 +53,15 @@ function isAllowed(text) {
|
|||||||
// after that — the route handler and the console listeners are gone with
|
// after that — the route handler and the console listeners are gone with
|
||||||
// the context — so there is no post-teardown phase to collect, and this
|
// the context — so there is no post-teardown phase to collect, and this
|
||||||
// class deliberately offers no mechanism pretending to cover one.
|
// class deliberately offers no mechanism pretending to cover one.
|
||||||
//
|
|
||||||
// One narrow exception exists, and it is not a mute: expect(). A test that
|
|
||||||
// drives a failure path on purpose — a refused gas estimate, say — provokes
|
|
||||||
// the console.error the code is supposed to emit, and that error is the
|
|
||||||
// behaviour under test rather than an escape. Declaring it consumes exactly
|
|
||||||
// one matching record and no more, and an expectation nothing matched fails
|
|
||||||
// its test just as an unexpected error does. So it cannot be used to
|
|
||||||
// silence anything: it can only assert that a specific error happened.
|
|
||||||
class ErrorCollector {
|
class ErrorCollector {
|
||||||
constructor() {
|
constructor() {
|
||||||
this.entries = [];
|
this.entries = [];
|
||||||
this.taken = 0;
|
this.taken = 0;
|
||||||
this.expectations = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Declare a console.error this test is about to cause deliberately.
|
|
||||||
// `label` names it in the failure message if it never arrives.
|
|
||||||
expect(label, pattern) {
|
|
||||||
this.expectations.push({ label, pattern, matched: false });
|
|
||||||
}
|
|
||||||
|
|
||||||
// Declared expectations that nothing matched, clearing the list so each
|
|
||||||
// test starts with none outstanding.
|
|
||||||
unmatchedExpectations() {
|
|
||||||
const out = this.expectations
|
|
||||||
.filter((e) => !e.matched)
|
|
||||||
.map((e) => e.label);
|
|
||||||
this.expectations = [];
|
|
||||||
return out;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
record(kind, text) {
|
record(kind, text) {
|
||||||
const line = kind + ": " + String(text).split("\n")[0];
|
const line = kind + ": " + String(text).split("\n")[0];
|
||||||
if (isAllowed(line)) return;
|
if (isAllowed(line)) return;
|
||||||
const expected = this.expectations.find(
|
|
||||||
(e) => !e.matched && e.pattern.test(line),
|
|
||||||
);
|
|
||||||
if (expected) {
|
|
||||||
expected.matched = true;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this.entries.push(line);
|
this.entries.push(line);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -322,18 +290,13 @@ async function createWallet(page) {
|
|||||||
return phrase;
|
return phrase;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reach the address detail screen of the FIRST address of the first wallet,
|
// Reach the address detail screen from wherever the popup restored to.
|
||||||
// from wherever the popup restored to. Clicking .address-row does not open
|
// Clicking .address-row does not open it; the [info] button does.
|
||||||
// it; the [info] button does.
|
|
||||||
//
|
|
||||||
// .first() rather than a bare selector because the suite adds a second
|
|
||||||
// wallet partway through, and every later test would otherwise die in
|
|
||||||
// Playwright's strict mode rather than on an assertion.
|
|
||||||
async function openAddressDetail(page) {
|
async function openAddressDetail(page) {
|
||||||
const onAddress = await page.isVisible("#view-address");
|
const onAddress = await page.isVisible("#view-address");
|
||||||
if (!onAddress) {
|
if (!onAddress) {
|
||||||
await visible(page, "#view-main");
|
await visible(page, "#view-main");
|
||||||
await page.locator("#wallet-list .btn-addr-info").first().click();
|
await page.click("#wallet-list .btn-addr-info");
|
||||||
}
|
}
|
||||||
await visible(page, "#view-address");
|
await visible(page, "#view-address");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,8 +23,6 @@
|
|||||||
|
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
const { Transaction } = require("ethers");
|
|
||||||
|
|
||||||
// Fictional ERC-20 used to seed the transaction-detail test. The symbol
|
// Fictional ERC-20 used to seed the transaction-detail test. The symbol
|
||||||
// must not collide with any entry in src/shared/tokenList.js, or
|
// must not collide with any entry in src/shared/tokenList.js, or
|
||||||
// isSpoofedSymbol() in src/shared/transactions.js drops the transfer as a
|
// isSpoofedSymbol() in src/shared/transactions.js drops the transfer as a
|
||||||
@@ -55,189 +53,18 @@ const STUB_TX_TIMESTAMP = "2026-01-02T03:04:05.000000Z";
|
|||||||
// log.errorf(), i.e. console.error, which fails the run on its own.
|
// log.errorf(), i.e. console.error, which fails the run on its own.
|
||||||
const ZERO_WORD = "0x" + "0".repeat(64);
|
const ZERO_WORD = "0x" + "0".repeat(64);
|
||||||
|
|
||||||
function hex(value) {
|
|
||||||
return "0x" + BigInt(value).toString(16);
|
|
||||||
}
|
|
||||||
|
|
||||||
// A bigint as a 32-byte ABI word.
|
|
||||||
function word(value) {
|
|
||||||
return "0x" + BigInt(value).toString(16).padStart(64, "0");
|
|
||||||
}
|
|
||||||
|
|
||||||
// -------------------------------------------------------- dApp fixture
|
|
||||||
//
|
|
||||||
// The origin the EIP-1193 test page is served from, and the page itself.
|
|
||||||
//
|
|
||||||
// It is a fixture like every other one in this file: the route handler
|
|
||||||
// fulfils the navigation from the string below, so the page never comes
|
|
||||||
// from a remote origin and nothing about the dApp round trips leaves the
|
|
||||||
// container. `.test` is reserved by RFC 6761 and has no owner to reach in
|
|
||||||
// the first place; the launch arguments map every host to NOTFOUND anyway.
|
|
||||||
//
|
|
||||||
// What the page deliberately does NOT do is load a provider. window.ethereum
|
|
||||||
// is put there by the shipped manifest's MAIN-world content script, exactly
|
|
||||||
// as it is on any http(s) page a user visits, so what these tests speak to
|
|
||||||
// is the real inpage provider and not a copy the harness wired up.
|
|
||||||
//
|
|
||||||
// DAPP_HTML below is exported and served verbatim by the Firefox suite too
|
|
||||||
// (tests/e2e/firefox/dapp.js), from a loopback origin rather than through a
|
|
||||||
// route handler. The two suites drive different browsers over different
|
|
||||||
// protocols, but the page they drive — the __dapp API, the message log — is
|
|
||||||
// one fixture, so an assertion written against it means the same thing on
|
|
||||||
// both.
|
|
||||||
const DAPP_ORIGIN = "https://dapp.e2e.test";
|
|
||||||
const DAPP_URL = DAPP_ORIGIN + "/";
|
|
||||||
|
|
||||||
// Requests are parked rather than awaited. An approval prompt only exists
|
|
||||||
// while its call is in flight, so a test that awaited the promise could
|
|
||||||
// never drive the popup that has to settle it; start() files the promise
|
|
||||||
// under a key and settle() collects it once the prompt has been dealt with.
|
|
||||||
//
|
|
||||||
// The rejection branch records the whole observable shape of the error as it
|
|
||||||
// arrives — name, message, and whether a `code` is present at all as distinct
|
|
||||||
// from its value. EIP-1193 says a user rejection is a ProviderRpcError
|
|
||||||
// carrying code 4001; what the page can actually see is recorded here rather
|
|
||||||
// than assumed, and asserted in run.js.
|
|
||||||
//
|
|
||||||
// The message log is the page's half of the boundary observation: every
|
|
||||||
// AUTISTMASK_* message that crosses between this page and the content
|
|
||||||
// script, in both directions, verbatim.
|
|
||||||
const DAPP_HTML = [
|
|
||||||
"<!doctype html>",
|
|
||||||
'<html lang="en">',
|
|
||||||
"<head>",
|
|
||||||
'<meta charset="utf-8">',
|
|
||||||
"<title>AutistMask e2e dApp</title>",
|
|
||||||
// Inline and empty: without it Chromium asks for /favicon.ico, which
|
|
||||||
// the unstubbed-request guard would report as escaping traffic.
|
|
||||||
'<link rel="icon" href="data:,">',
|
|
||||||
"</head>",
|
|
||||||
"<body>",
|
|
||||||
"<h1>AutistMask e2e dApp</h1>",
|
|
||||||
"<script>",
|
|
||||||
"window.__dapp = {",
|
|
||||||
" messages: [],",
|
|
||||||
" calls: {},",
|
|
||||||
" start: function (key, method, params) {",
|
|
||||||
" window.__dapp.calls[key] = window.ethereum",
|
|
||||||
" .request({ method: method, params: params })",
|
|
||||||
" .then(",
|
|
||||||
" function (result) {",
|
|
||||||
" return { settled: 'resolved', result: result };",
|
|
||||||
" },",
|
|
||||||
" function (error) {",
|
|
||||||
" return {",
|
|
||||||
" settled: 'rejected',",
|
|
||||||
" message: String((error && error.message) || error),",
|
|
||||||
" name: error ? error.name : undefined,",
|
|
||||||
" hasCode: !!error && 'code' in Object(error),",
|
|
||||||
" code: error ? error.code : undefined,",
|
|
||||||
" };",
|
|
||||||
" },",
|
|
||||||
" );",
|
|
||||||
" },",
|
|
||||||
" settle: function (key) {",
|
|
||||||
" return window.__dapp.calls[key];",
|
|
||||||
" },",
|
|
||||||
"};",
|
|
||||||
"window.addEventListener('message', function (event) {",
|
|
||||||
" if (event.source !== window) return;",
|
|
||||||
" var d = event.data;",
|
|
||||||
" if (!d || typeof d.type !== 'string') return;",
|
|
||||||
" if (d.type.indexOf('AUTISTMASK') !== 0) return;",
|
|
||||||
" window.__dapp.messages.push(d);",
|
|
||||||
"});",
|
|
||||||
"</script>",
|
|
||||||
"</body>",
|
|
||||||
"</html>",
|
|
||||||
].join("\n");
|
|
||||||
|
|
||||||
// ------------------------------------------------------------ fee fixture
|
|
||||||
//
|
|
||||||
// The confirmation screen carries two different numbers for the same
|
|
||||||
// transaction and may gate on only one of them:
|
|
||||||
//
|
|
||||||
// reserve = gasLimit * maxFeePerGas — what a node requires to be
|
|
||||||
// available for a type-2 transaction, and what the spend gate
|
|
||||||
// must use.
|
|
||||||
// estimate = gasLimit * gasPrice — what the transfer is expected to
|
|
||||||
// actually cost. Display only.
|
|
||||||
//
|
|
||||||
// Issue #154 was the gate reading the smaller of the two. ethers derives
|
|
||||||
// maxFeePerGas as baseFeePerGas * 2 + maxPriorityFeePerGas, so the numbers
|
|
||||||
// below put the reserve at very nearly twice the estimate. That gap is the
|
|
||||||
// entire point of these values: it leaves room for a send that an
|
|
||||||
// estimate-based gate accepts and a reserve-based gate refuses, which is
|
|
||||||
// what lets the ConfirmTx tests tell the two apart at all. Collapse the gap
|
|
||||||
// — by dropping baseFeePerGas from the block below, say — and those tests
|
|
||||||
// go on passing while asserting nothing.
|
|
||||||
const GAS_LIMIT = 21000n;
|
|
||||||
const BASE_FEE_WEI = 100000000000n; // 100 gwei
|
|
||||||
const PRIORITY_FEE_WEI = 1000000000n; // 1 gwei
|
|
||||||
const GAS_PRICE_WEI = BASE_FEE_WEI + PRIORITY_FEE_WEI; // 101 gwei
|
|
||||||
const MAX_FEE_WEI = BASE_FEE_WEI * 2n + PRIORITY_FEE_WEI; // 201 gwei
|
|
||||||
|
|
||||||
const FEE_ESTIMATE_WEI = GAS_LIMIT * GAS_PRICE_WEI; // 0.002121 ETH
|
|
||||||
const FEE_RESERVE_WEI = GAS_LIMIT * MAX_FEE_WEI; // 0.004221 ETH
|
|
||||||
|
|
||||||
const RPC_RESULTS = {
|
const RPC_RESULTS = {
|
||||||
eth_chainId: "0x1",
|
eth_chainId: "0x1",
|
||||||
net_version: "1",
|
net_version: "1",
|
||||||
eth_blockNumber: "0x1406f40",
|
eth_blockNumber: "0x1406f40",
|
||||||
eth_getBalance: "0x0",
|
eth_getBalance: "0x0",
|
||||||
eth_call: ZERO_WORD,
|
eth_call: ZERO_WORD,
|
||||||
eth_getCode: "0x",
|
eth_gasPrice: "0x3b9aca00",
|
||||||
eth_gasPrice: hex(GAS_PRICE_WEI),
|
eth_estimateGas: "0x5208",
|
||||||
eth_estimateGas: hex(GAS_LIMIT),
|
|
||||||
eth_getTransactionCount: "0x0",
|
eth_getTransactionCount: "0x0",
|
||||||
eth_maxPriorityFeePerGas: hex(PRIORITY_FEE_WEI),
|
eth_maxPriorityFeePerGas: "0x3b9aca00",
|
||||||
// "not mined yet", which is what a node answers for a transaction it has
|
|
||||||
// only just accepted. The wait screen the dApp transaction approval hands
|
|
||||||
// off to polls this every 10 seconds; leaving it unstubbed would report
|
|
||||||
// the poll as escaping traffic the moment a test outlived one tick.
|
|
||||||
eth_getTransactionReceipt: null,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// The "latest" block, which ethers' getFeeData() reads baseFeePerGas from
|
|
||||||
// to derive maxFeePerGas. Without it every fee is a legacy gasPrice, the
|
|
||||||
// reserve and the estimate collapse to the same number, and the gate tests
|
|
||||||
// stop being able to distinguish them.
|
|
||||||
function latestBlock() {
|
|
||||||
return {
|
|
||||||
hash: "0x" + "11".repeat(32),
|
|
||||||
parentHash: "0x" + "22".repeat(32),
|
|
||||||
number: hex(STUB_BLOCK_NUMBER),
|
|
||||||
timestamp: hex(1767326645),
|
|
||||||
nonce: "0x0000000000000000",
|
|
||||||
difficulty: "0x0",
|
|
||||||
gasLimit: "0x1c9c380",
|
|
||||||
gasUsed: "0xf4240",
|
|
||||||
miner: STUB_COUNTERPARTY,
|
|
||||||
extraData: "0x",
|
|
||||||
baseFeePerGas: hex(BASE_FEE_WEI),
|
|
||||||
transactions: [],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// keccak("decimals()")[0:4].
|
|
||||||
const SELECTOR_DECIMALS = "0x313ce567";
|
|
||||||
|
|
||||||
// Every eth_call still answers with a zero word except decimals() on the
|
|
||||||
// stub token. ethers reads that before it can encode an ERC-20 transfer,
|
|
||||||
// and a zero there makes parseUnits() reject any fractional amount — so the
|
|
||||||
// ERC-20 confirmation path would fail its gas estimate for a reason that
|
|
||||||
// has nothing to do with what is being tested.
|
|
||||||
function ethCallResult(req) {
|
|
||||||
const call = Array.isArray(req.params) ? req.params[0] : null;
|
|
||||||
if (!call || typeof call !== "object") return ZERO_WORD;
|
|
||||||
const data = String(call.data || call.input || "").toLowerCase();
|
|
||||||
const to = String(call.to || "").toLowerCase();
|
|
||||||
if (data.startsWith(SELECTOR_DECIMALS) && to === STUB_TOKEN.address) {
|
|
||||||
return word(STUB_TOKEN.decimals);
|
|
||||||
}
|
|
||||||
return ZERO_WORD;
|
|
||||||
}
|
|
||||||
|
|
||||||
function tokenObject() {
|
function tokenObject() {
|
||||||
return {
|
return {
|
||||||
address_hash: STUB_TOKEN.address,
|
address_hash: STUB_TOKEN.address,
|
||||||
@@ -265,18 +92,6 @@ function tokenTransferItems(address) {
|
|||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
// A holding of 1.5 E2E, in the shape src/shared/balances.js parses. Serving
|
|
||||||
// this is what puts an ERC-20 in the send screen's token dropdown, which is
|
|
||||||
// the only way the confirmation screen's ERC-20 path can be reached.
|
|
||||||
function tokenBalanceItems() {
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
value: "1500000",
|
|
||||||
token: tokenObject(),
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Full details for STUB_TX_HASH. raw_input is "0x" so the calldata
|
// Full details for STUB_TX_HASH. raw_input is "0x" so the calldata
|
||||||
// decoder short-circuits; the on-chain detail fields still populate.
|
// decoder short-circuits; the on-chain detail fields still populate.
|
||||||
function transactionDetails() {
|
function transactionDetails() {
|
||||||
@@ -306,107 +121,7 @@ function blockscoutAddress(pathname) {
|
|||||||
return m ? m[1] : null;
|
return m ? m[1] : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
function sleep(ms) {
|
function handleRpc(route, postData, report) {
|
||||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
||||||
}
|
|
||||||
|
|
||||||
// How long a deliberately held reply is allowed to stay held, and how often
|
|
||||||
// the release flag is re-read while it is.
|
|
||||||
const HOLD_POLL_MS = 25;
|
|
||||||
const HOLD_MAX_MS = 30000;
|
|
||||||
|
|
||||||
// Hold a gas estimate open for as long as the test asks.
|
|
||||||
//
|
|
||||||
// opts.holdGasEstimate is read here rather than captured, so a test flips it
|
|
||||||
// on the same options object the route was registered with — the same
|
|
||||||
// pattern as seedTokenTransfer. This is the only way to observe the
|
|
||||||
// confirmation screen while its estimate is genuinely in flight; sampling
|
|
||||||
// the screen and hoping to win a race against the network would assert
|
|
||||||
// nothing on a slow machine.
|
|
||||||
//
|
|
||||||
// It never gives up quietly. A hold that outlives the bound is reported like
|
|
||||||
// any other harness fault, because a "pending" state that stopped being
|
|
||||||
// pending on its own is a green assertion about the wrong screen.
|
|
||||||
async function awaitRelease(opts, report) {
|
|
||||||
const started = Date.now();
|
|
||||||
while (opts.holdGasEstimate) {
|
|
||||||
if (Date.now() - started > HOLD_MAX_MS) {
|
|
||||||
report(
|
|
||||||
"held gas estimate was never released after " +
|
|
||||||
HOLD_MAX_MS +
|
|
||||||
"ms",
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
await sleep(HOLD_POLL_MS);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// One JSON-RPC reply. Methods whose answer depends on a fixture a test has
|
|
||||||
// set, or on the call itself, are resolved here; every other method is a
|
|
||||||
// constant in RPC_RESULTS.
|
|
||||||
function rpcReply(req, opts, report) {
|
|
||||||
const envelope = { jsonrpc: "2.0", id: req.id };
|
|
||||||
|
|
||||||
if (req.method === "eth_getBalance") {
|
|
||||||
return Object.assign(envelope, {
|
|
||||||
result: opts.ethBalanceWei || RPC_RESULTS.eth_getBalance,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (req.method === "eth_call") {
|
|
||||||
return Object.assign(envelope, { result: ethCallResult(req) });
|
|
||||||
}
|
|
||||||
if (req.method === "eth_getBlockByNumber") {
|
|
||||||
return Object.assign(envelope, { result: latestBlock() });
|
|
||||||
}
|
|
||||||
// The end of the dApp transaction round trip: the raw signed transaction
|
|
||||||
// the background hands to the node. It is recorded verbatim so a test can
|
|
||||||
// recover the signer from the exact bytes that were broadcast, rather than
|
|
||||||
// from anything the extension reported about them.
|
|
||||||
//
|
|
||||||
// The reply must be the transaction's real hash. ethers compares the hash
|
|
||||||
// the node returns against the one it computes itself and throws on a
|
|
||||||
// mismatch, so a constant here would fail the broadcast for a reason that
|
|
||||||
// has nothing to do with what is being tested.
|
|
||||||
if (req.method === "eth_sendRawTransaction") {
|
|
||||||
const raw = Array.isArray(req.params) ? req.params[0] : null;
|
|
||||||
let parsed;
|
|
||||||
try {
|
|
||||||
parsed = Transaction.from(raw);
|
|
||||||
} catch {
|
|
||||||
report("eth_sendRawTransaction with an undecodable transaction");
|
|
||||||
return Object.assign(envelope, {
|
|
||||||
error: { code: -32000, message: "undecodable transaction" },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (Array.isArray(opts.broadcastTransactions)) {
|
|
||||||
opts.broadcastTransactions.push(raw);
|
|
||||||
}
|
|
||||||
return Object.assign(envelope, { result: parsed.hash });
|
|
||||||
}
|
|
||||||
if (req.method === "eth_estimateGas" && opts.failGasEstimate) {
|
|
||||||
// A refusal the node itself would produce, not a transport error:
|
|
||||||
// this is the shape the confirmation screen has to turn into
|
|
||||||
// "Unable to estimate" rather than into a fee of zero.
|
|
||||||
return Object.assign(envelope, {
|
|
||||||
error: {
|
|
||||||
code: -32000,
|
|
||||||
message: "e2e fixture: gas required exceeds allowance",
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = RPC_RESULTS[req.method];
|
|
||||||
if (result === undefined) {
|
|
||||||
report("unstubbed RPC method: " + req.method);
|
|
||||||
return Object.assign(envelope, {
|
|
||||||
error: { code: -32601, message: "unstubbed in e2e harness" },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return Object.assign(envelope, { result });
|
|
||||||
}
|
|
||||||
|
|
||||||
async function handleRpc(route, postData, opts, report) {
|
|
||||||
let payload;
|
let payload;
|
||||||
try {
|
try {
|
||||||
payload = JSON.parse(postData || "null");
|
payload = JSON.parse(postData || "null");
|
||||||
@@ -417,36 +132,34 @@ async function handleRpc(route, postData, opts, report) {
|
|||||||
// ethers batches by default, so the body may be an array.
|
// ethers batches by default, so the body may be an array.
|
||||||
const batch = Array.isArray(payload) ? payload : [payload];
|
const batch = Array.isArray(payload) ? payload : [payload];
|
||||||
|
|
||||||
// Anything that is not a JSON-RPC object, or a NON-EMPTY batch of
|
// Anything that is not a JSON-RPC object, or a batch of them, is not
|
||||||
// them, is not RPC at all and must be reported like any other
|
// RPC at all and must be reported like any other unrecognised
|
||||||
// unrecognised outbound traffic rather than dereferenced.
|
// outbound traffic rather than dereferenced. request.postData()
|
||||||
//
|
// returns null both for a bodyless POST and for a body Playwright
|
||||||
// The length check is not decoration: every() is vacuously true on an
|
// cannot decode as UTF-8 (sendBeacon with a Blob, or any binary
|
||||||
// empty array, so without it a POST with body [] was answered 200 []
|
// payload), so this is not an empty-string special case: it rejects
|
||||||
// and escaped the guard entirely (issue #187). No real batch is empty,
|
// every non-object payload, exactly as the catch above rejects every
|
||||||
// so nothing legitimate is caught by it.
|
// unparseable one.
|
||||||
//
|
|
||||||
// Two distinct paths land a non-RPC body here, and neither is an
|
|
||||||
// empty-string special case. playwright-core's postData() is
|
|
||||||
// `buffer.toString("utf-8") || null`, so an absent or empty body
|
|
||||||
// decodes to null, JSON.parse("null") yields null, and the type guard
|
|
||||||
// below reports it. A binary body is instead decoded LOSSILY into
|
|
||||||
// mojibake — not null — which is not valid JSON, so the catch above
|
|
||||||
// reports that one. Both end up reported; only the route differs.
|
|
||||||
if (
|
if (
|
||||||
payload === null ||
|
payload === null ||
|
||||||
typeof payload !== "object" ||
|
typeof payload !== "object" ||
|
||||||
batch.length === 0 ||
|
|
||||||
!batch.every((req) => req !== null && typeof req === "object")
|
!batch.every((req) => req !== null && typeof req === "object")
|
||||||
) {
|
) {
|
||||||
report("unstubbed request: POST " + route.request().url());
|
report("unstubbed request: POST " + route.request().url());
|
||||||
return route.abort();
|
return route.abort();
|
||||||
}
|
}
|
||||||
if (batch.some((req) => req.method === "eth_estimateGas")) {
|
const replies = batch.map((req) => {
|
||||||
await awaitRelease(opts, report);
|
const result = RPC_RESULTS[req.method];
|
||||||
}
|
if (result === undefined) {
|
||||||
|
report("unstubbed RPC method: " + req.method);
|
||||||
const replies = batch.map((req) => rpcReply(req, opts, report));
|
return {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: req.id,
|
||||||
|
error: { code: -32601, message: "unstubbed in e2e harness" },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return { jsonrpc: "2.0", id: req.id, result };
|
||||||
|
});
|
||||||
return jsonResponse(route, Array.isArray(payload) ? replies : replies[0]);
|
return jsonResponse(route, Array.isArray(payload) ? replies : replies[0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -486,17 +199,6 @@ function traceEnabled(raw) {
|
|||||||
* @param {boolean} [opts.seedTokenTransfer] serve the stubbed ERC-20
|
* @param {boolean} [opts.seedTokenTransfer] serve the stubbed ERC-20
|
||||||
* transfer. Read at request time, so a test can flip it on the same
|
* transfer. Read at request time, so a test can flip it on the same
|
||||||
* options object without re-registering the route.
|
* options object without re-registering the route.
|
||||||
* @param {boolean} [opts.seedTokenBalance] serve the stubbed ERC-20
|
|
||||||
* holding, which is what makes the token reachable from the send screen.
|
|
||||||
* @param {string} [opts.ethBalanceWei] hex wei answered to eth_getBalance;
|
|
||||||
* defaults to zero, which is what every test that predates the funded
|
|
||||||
* fixture expects.
|
|
||||||
* @param {boolean} [opts.failGasEstimate] answer eth_estimateGas with a
|
|
||||||
* node-side refusal.
|
|
||||||
* @param {boolean} [opts.holdGasEstimate] hold every batch containing an
|
|
||||||
* eth_estimateGas until this is cleared again.
|
|
||||||
* @param {string[]} [opts.broadcastTransactions] every raw signed
|
|
||||||
* transaction handed to eth_sendRawTransaction, appended in order.
|
|
||||||
* @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) =>
|
* @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) =>
|
||||||
* Promise<string|null>}>}
|
* Promise<string|null>}>}
|
||||||
*/
|
*/
|
||||||
@@ -539,19 +241,7 @@ async function installNetworkStubs(ctx, opts) {
|
|||||||
|
|
||||||
// JSON-RPC endpoint (any host): a POST with a JSON-RPC body.
|
// JSON-RPC endpoint (any host): a POST with a JSON-RPC body.
|
||||||
if (req.method() === "POST") {
|
if (req.method() === "POST") {
|
||||||
return handleRpc(route, req.postData(), opts, report);
|
return handleRpc(route, req.postData(), report);
|
||||||
}
|
|
||||||
|
|
||||||
// The local EIP-1193 test page. Served from here so the dApp round
|
|
||||||
// trips run against a real http(s) origin — which is what makes the
|
|
||||||
// shipped content scripts inject at all — without any remote origin
|
|
||||||
// being involved.
|
|
||||||
if (url.origin === DAPP_ORIGIN && p === "/") {
|
|
||||||
return route.fulfill({
|
|
||||||
status: 200,
|
|
||||||
contentType: "text/html; charset=utf-8",
|
|
||||||
body: DAPP_HTML,
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Blockscout v2
|
// Blockscout v2
|
||||||
@@ -569,10 +259,7 @@ async function installNetworkStubs(ctx, opts) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
if (/\/addresses\/0x[0-9a-fA-F]{40}\/token-balances$/.test(p)) {
|
if (/\/addresses\/0x[0-9a-fA-F]{40}\/token-balances$/.test(p)) {
|
||||||
return jsonResponse(
|
return jsonResponse(route, []);
|
||||||
route,
|
|
||||||
opts.seedTokenBalance ? tokenBalanceItems() : [],
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
if (p.endsWith("/transactions/" + STUB_TX_HASH)) {
|
if (p.endsWith("/transactions/" + STUB_TX_HASH)) {
|
||||||
return jsonResponse(route, transactionDetails());
|
return jsonResponse(route, transactionDetails());
|
||||||
@@ -642,12 +329,6 @@ async function installNetworkStubs(ctx, opts) {
|
|||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
installNetworkStubs,
|
installNetworkStubs,
|
||||||
DAPP_HTML,
|
|
||||||
DAPP_ORIGIN,
|
|
||||||
DAPP_URL,
|
|
||||||
FEE_ESTIMATE_WEI,
|
|
||||||
FEE_RESERVE_WEI,
|
|
||||||
STUB_COUNTERPARTY,
|
|
||||||
STUB_TOKEN,
|
STUB_TOKEN,
|
||||||
STUB_TX_HASH,
|
STUB_TX_HASH,
|
||||||
};
|
};
|
||||||
|
|||||||
1603
tests/e2e/run.js
1603
tests/e2e/run.js
File diff suppressed because it is too large
Load Diff
@@ -247,7 +247,7 @@ describe("a reveal that is not interrupted", () => {
|
|||||||
|
|
||||||
expect(node("export-privkey-value").textContent).toBe("");
|
expect(node("export-privkey-value").textContent).toBe("");
|
||||||
expect(node("export-privkey-flash").textContent).toBe(
|
expect(node("export-privkey-flash").textContent).toBe(
|
||||||
"That password is incorrect. Please try again.",
|
"That password is not correct. Please try again.",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,310 +0,0 @@
|
|||||||
// The EIP-1193 error the page actually catches (src/content/inpage.js).
|
|
||||||
//
|
|
||||||
// The bug this pins down (issue #274): the provider rebuilt every failure as
|
|
||||||
// `new Error(error.message)`, so the `code` the background produced and the
|
|
||||||
// content script relayed intact was thrown away in the last hop. A dApp
|
|
||||||
// checking `err.code === 4001` — the standard way to tell "the user said no"
|
|
||||||
// from "the wallet broke" — saw undefined, and well-behaved sites showed an
|
|
||||||
// error or retried instead of accepting the refusal.
|
|
||||||
//
|
|
||||||
// inpage.js is a bare IIFE injected into the page's JS context, not a module:
|
|
||||||
// it takes no import and exports nothing, and reaches for `window` at load.
|
|
||||||
// So it is evaluated here the way the browser evaluates it, against a stub
|
|
||||||
// window, and the provider is collected from `window.ethereum`. The globals it
|
|
||||||
// touches are passed in as function parameters rather than assigned to
|
|
||||||
// globalThis: nothing leaks between tests, and the source is compiled in this
|
|
||||||
// realm, so the errors it constructs are comparable against this file's own
|
|
||||||
// `Error` — which a second realm's intrinsics would silently defeat.
|
|
||||||
//
|
|
||||||
// There is no jsdom in this repo; see tests/txStatus.test.js.
|
|
||||||
|
|
||||||
const fs = require("fs");
|
|
||||||
const path = require("path");
|
|
||||||
const { webcrypto } = require("crypto");
|
|
||||||
|
|
||||||
const SOURCE = fs.readFileSync(
|
|
||||||
path.join(__dirname, "..", "src", "content", "inpage.js"),
|
|
||||||
"utf8",
|
|
||||||
);
|
|
||||||
|
|
||||||
const loadInto = new Function(
|
|
||||||
"window",
|
|
||||||
"self",
|
|
||||||
"crypto",
|
|
||||||
"Event",
|
|
||||||
"CustomEvent",
|
|
||||||
SOURCE,
|
|
||||||
);
|
|
||||||
|
|
||||||
class StubEvent {
|
|
||||||
constructor(type) {
|
|
||||||
this.type = type;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class StubCustomEvent extends StubEvent {
|
|
||||||
constructor(type, init) {
|
|
||||||
super(type);
|
|
||||||
this.detail = init && init.detail;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Every code the background emits on the RPC path today, read out of
|
|
||||||
// src/background/index.js. The provider must not know this list — it passes
|
|
||||||
// through whatever arrived — but the cases below are the real ones.
|
|
||||||
const REJECTED = 4001; // user rejected the request
|
|
||||||
const UNAUTHORIZED = 4100; // site not connected / wrong address
|
|
||||||
const UNRECOGNIZED_CHAIN = 4902; // switch/add to an unsupported chain
|
|
||||||
|
|
||||||
// A stub window with the four things inpage.js touches: message listeners,
|
|
||||||
// postMessage out to the content script, window.ethereum, and dispatchEvent
|
|
||||||
// for the EIP-6963 announcement.
|
|
||||||
function loadProvider() {
|
|
||||||
const messageListeners = [];
|
|
||||||
const posted = [];
|
|
||||||
|
|
||||||
const win = {
|
|
||||||
addEventListener(type, fn) {
|
|
||||||
if (type === "message") messageListeners.push(fn);
|
|
||||||
},
|
|
||||||
removeEventListener(type, fn) {
|
|
||||||
const i = messageListeners.indexOf(fn);
|
|
||||||
if (type === "message" && i !== -1) messageListeners.splice(i, 1);
|
|
||||||
},
|
|
||||||
postMessage(data) {
|
|
||||||
posted.push(data);
|
|
||||||
},
|
|
||||||
dispatchEvent() {
|
|
||||||
return true;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
win.window = win;
|
|
||||||
|
|
||||||
loadInto(win, win, webcrypto, StubEvent, StubCustomEvent);
|
|
||||||
|
|
||||||
// Deliver the content script's answer to an outstanding request. The id is
|
|
||||||
// read back off the wire rather than assumed: inpage.js issues its own
|
|
||||||
// eth_chainId at load, so the first id a test sees is not 1.
|
|
||||||
function respond(response) {
|
|
||||||
const request = posted
|
|
||||||
.filter((m) => m.type === "AUTISTMASK_REQUEST")
|
|
||||||
.pop();
|
|
||||||
expect(request).toBeDefined();
|
|
||||||
const event = {
|
|
||||||
source: win,
|
|
||||||
data: { type: "AUTISTMASK_RESPONSE", id: request.id, ...response },
|
|
||||||
};
|
|
||||||
for (const fn of messageListeners.slice()) fn(event);
|
|
||||||
}
|
|
||||||
|
|
||||||
return { provider: win.ethereum, posted, respond };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Start a request, answer it with `response`, and hand back the rejection.
|
|
||||||
// Fails the test if the call resolves instead.
|
|
||||||
async function rejectionFrom(start, response) {
|
|
||||||
const { provider, respond } = loadProvider();
|
|
||||||
const settled = start(provider).then(
|
|
||||||
(result) => ({ resolved: result }),
|
|
||||||
(error) => ({ error }),
|
|
||||||
);
|
|
||||||
// The provider posts synchronously, so the request is already on the wire.
|
|
||||||
respond(response);
|
|
||||||
const outcome = await settled;
|
|
||||||
expect(outcome).not.toHaveProperty("resolved");
|
|
||||||
return outcome.error;
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("an EIP-1193 code reaches the page", () => {
|
|
||||||
test("a user rejection arrives as code 4001", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_requestAccounts" }),
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: REJECTED,
|
|
||||||
message: "User rejected the request.",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
expect(err.message).toBe("User rejected the request.");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("it is a ProviderRpcError, and an Error", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_requestAccounts" }),
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: REJECTED,
|
|
||||||
message: "User rejected the request.",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(err).toBeInstanceOf(Error);
|
|
||||||
expect(err.name).toBe("ProviderRpcError");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("4100 unauthorized arrives intact", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "personal_sign", params: ["0x00"] }),
|
|
||||||
{ error: { code: UNAUTHORIZED, message: "Unauthorized" } },
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(UNAUTHORIZED);
|
|
||||||
expect(err.message).toBe("Unauthorized");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("4902 unrecognized chain arrives intact", async () => {
|
|
||||||
const message =
|
|
||||||
"AutistMask supports Ethereum Mainnet and Sepolia Testnet only.";
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "wallet_switchEthereumChain" }),
|
|
||||||
{ error: { code: UNRECOGNIZED_CHAIN, message } },
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(UNRECOGNIZED_CHAIN);
|
|
||||||
expect(err.message).toBe(message);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The provider is not allowed to know the list above: a code added to the
|
|
||||||
// background later must reach the page without this file being edited.
|
|
||||||
test("a code the provider has never heard of is passed through", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_accounts" }),
|
|
||||||
{ error: { code: 4900, message: "Disconnected" } },
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(4900);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("data is carried when the boundary sent it", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_call" }),
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: -32000,
|
|
||||||
message: "execution reverted",
|
|
||||||
data: "0x08c379a0",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(-32000);
|
|
||||||
expect(err.data).toBe("0x08c379a0");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("no data property is invented when the boundary sent none", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_requestAccounts" }),
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: REJECTED,
|
|
||||||
message: "User rejected the request.",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
);
|
|
||||||
expect("data" in err).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("the message is untouched", () => {
|
|
||||||
test("a coded error keeps the message byte for byte", async () => {
|
|
||||||
const message =
|
|
||||||
"This site asked to sign as an address that is not " +
|
|
||||||
"the active one.";
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "personal_sign" }),
|
|
||||||
{ error: { code: UNAUTHORIZED, message } },
|
|
||||||
);
|
|
||||||
expect(err.message).toBe(message);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an error the background sent with no code keeps its message", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_sendTransaction" }),
|
|
||||||
{ error: { message: "No accounts available" } },
|
|
||||||
);
|
|
||||||
expect(err.message).toBe("No accounts available");
|
|
||||||
});
|
|
||||||
|
|
||||||
// A ProviderRpcError whose code is undefined would claim a conformance it
|
|
||||||
// does not have, and `'code' in err` is exactly what a careful dApp asks.
|
|
||||||
test("an error with no code gets no code property at all", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_sendTransaction" }),
|
|
||||||
{ error: { message: "No accounts available" } },
|
|
||||||
);
|
|
||||||
expect(err).toBeInstanceOf(Error);
|
|
||||||
expect("code" in err).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an error with no message keeps the generic fallback", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_sendTransaction" }),
|
|
||||||
{ error: { code: REJECTED } },
|
|
||||||
);
|
|
||||||
expect(err.message).toBe("Request failed");
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// Every entry point the provider exposes, not just eth_requestAccounts. They
|
|
||||||
// all funnel through the same response listener, and this is what says so.
|
|
||||||
describe("every request path carries the code", () => {
|
|
||||||
const rejection = {
|
|
||||||
error: { code: REJECTED, message: "User rejected the request." },
|
|
||||||
};
|
|
||||||
|
|
||||||
test("request()", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.request({ method: "eth_requestAccounts" }),
|
|
||||||
rejection,
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("enable()", async () => {
|
|
||||||
const err = await rejectionFrom((p) => p.enable(), rejection);
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("send(method, params)", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.send("eth_requestAccounts", []),
|
|
||||||
rejection,
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("send({ method, params })", async () => {
|
|
||||||
const err = await rejectionFrom(
|
|
||||||
(p) => p.send({ method: "personal_sign", params: ["0x00"] }),
|
|
||||||
rejection,
|
|
||||||
);
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("sendAsync() hands the code to its callback", async () => {
|
|
||||||
const { provider, respond } = loadProvider();
|
|
||||||
const called = new Promise((resolve) => {
|
|
||||||
provider.sendAsync({ id: 1, method: "eth_requestAccounts" }, (e) =>
|
|
||||||
resolve(e),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
respond(rejection);
|
|
||||||
const err = await called;
|
|
||||||
expect(err.name).toBe("ProviderRpcError");
|
|
||||||
expect(err.code).toBe(REJECTED);
|
|
||||||
expect(err.message).toBe("User rejected the request.");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("the success path is unchanged", () => {
|
|
||||||
test("a result still resolves", async () => {
|
|
||||||
const { provider, respond } = loadProvider();
|
|
||||||
const settled = provider.request({ method: "eth_requestAccounts" });
|
|
||||||
respond({ result: ["0xb61264DEFB0c4B8afb3D73724be15310036743a5"] });
|
|
||||||
await expect(settled).resolves.toEqual([
|
|
||||||
"0xb61264DEFB0c4B8afb3D73724be15310036743a5",
|
|
||||||
]);
|
|
||||||
expect(provider.selectedAddress).toBe(
|
|
||||||
"0xb61264DEFB0c4B8afb3D73724be15310036743a5",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,213 +0,0 @@
|
|||||||
// One wording for one condition (issue #172).
|
|
||||||
//
|
|
||||||
// Every screen that asks for the password decrypts the vault itself, and
|
|
||||||
// each one used to write its own sentence for the same failure: the send
|
|
||||||
// confirmation and the delete-wallet confirmation said "Wrong password."
|
|
||||||
// (a fragment, which RULES.md Language & Labeling forbids), the reveal
|
|
||||||
// screens said "That password is not correct.", and the two dApp approval
|
|
||||||
// paths said "That password is incorrect." A user hitting two of those
|
|
||||||
// minutes apart had no way to tell whether the wallet meant the same
|
|
||||||
// thing.
|
|
||||||
//
|
|
||||||
// This scans the source rather than driving six views, because the
|
|
||||||
// invariant is about the set of call sites and not about any one of them:
|
|
||||||
// a seventh screen that decrypts the vault has to join the set, and a
|
|
||||||
// DOM test per view cannot notice one that was never written.
|
|
||||||
//
|
|
||||||
// The assertions are per CALL SITE, not per file. approval.js decrypts in
|
|
||||||
// two places and is where the divergence came from; a per-file check that
|
|
||||||
// only asks whether the canonical sentence appears somewhere in the file
|
|
||||||
// passes while one of those two says something else entirely. So each
|
|
||||||
// call site is read back to its own catch handler and the prose that
|
|
||||||
// handler shows the user must be the canonical sentence and nothing else
|
|
||||||
// — which fails on a novel wording, not only on a known-superseded one.
|
|
||||||
|
|
||||||
const fs = require("fs");
|
|
||||||
const path = require("path");
|
|
||||||
|
|
||||||
const SRC = path.join(__dirname, "..", "src");
|
|
||||||
|
|
||||||
const CANONICAL = "That password is incorrect. Please try again.";
|
|
||||||
|
|
||||||
// Wordings this repo has actually shipped for the same condition. This is
|
|
||||||
// a secondary, whole-file sweep for stragglers outside a decrypt handler;
|
|
||||||
// divergence at a call site is caught by the exact-match assertion, which
|
|
||||||
// needs no list of phrasings to guess at.
|
|
||||||
const SUPERSEDED = [
|
|
||||||
"Wrong password.",
|
|
||||||
"That password is not correct. Please try again.",
|
|
||||||
];
|
|
||||||
|
|
||||||
function jsFilesUnder(dir) {
|
|
||||||
return fs.readdirSync(dir, { withFileTypes: true }).flatMap((entry) => {
|
|
||||||
const full = path.join(dir, entry.name);
|
|
||||||
if (entry.isDirectory()) return jsFilesUnder(full);
|
|
||||||
return entry.name.endsWith(".js") ? [full] : [];
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Blank out the interior of every comment and string literal, keeping the
|
|
||||||
// offsets and line breaks, so braces can be counted without a quote or a
|
|
||||||
// commented-out block throwing the count off. The literals are returned
|
|
||||||
// alongside with the offset of their opening quote, which is how a
|
|
||||||
// message is later attributed to the handler it sits in.
|
|
||||||
function scan(source) {
|
|
||||||
const masked = source.split("");
|
|
||||||
const strings = [];
|
|
||||||
const blank = (from, to) => {
|
|
||||||
for (let k = from; k < to; k++) if (masked[k] !== "\n") masked[k] = " ";
|
|
||||||
};
|
|
||||||
let i = 0;
|
|
||||||
while (i < source.length) {
|
|
||||||
const two = source.slice(i, i + 2);
|
|
||||||
if (two === "//") {
|
|
||||||
const nl = source.indexOf("\n", i);
|
|
||||||
const stop = nl === -1 ? source.length : nl;
|
|
||||||
blank(i, stop);
|
|
||||||
i = stop;
|
|
||||||
} else if (two === "/*") {
|
|
||||||
const close = source.indexOf("*/", i + 2);
|
|
||||||
const stop = close === -1 ? source.length : close + 2;
|
|
||||||
blank(i, stop);
|
|
||||||
i = stop;
|
|
||||||
} else if (
|
|
||||||
source[i] === '"' ||
|
|
||||||
source[i] === "'" ||
|
|
||||||
source[i] === "`"
|
|
||||||
) {
|
|
||||||
const quote = source[i];
|
|
||||||
let j = i + 1;
|
|
||||||
let value = "";
|
|
||||||
while (j < source.length && source[j] !== quote) {
|
|
||||||
if (source[j] === "\\") {
|
|
||||||
value += source[j + 1];
|
|
||||||
j += 2;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
value += source[j];
|
|
||||||
j += 1;
|
|
||||||
}
|
|
||||||
blank(i + 1, j);
|
|
||||||
strings.push({ offset: i, value });
|
|
||||||
i = j + 1;
|
|
||||||
} else {
|
|
||||||
i += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return { masked: masked.join(""), strings };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Offset of the `{` that opens the block containing `at`, or -1.
|
|
||||||
function enclosingBlockStart(masked, at) {
|
|
||||||
let depth = 0;
|
|
||||||
for (let i = at; i >= 0; i--) {
|
|
||||||
if (masked[i] === "}") depth += 1;
|
|
||||||
else if (masked[i] === "{") {
|
|
||||||
if (depth === 0) return i;
|
|
||||||
depth -= 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Offset just past the `}` matching the `{` at `open`.
|
|
||||||
function blockEnd(masked, open) {
|
|
||||||
let depth = 0;
|
|
||||||
for (let i = open; i < masked.length; i++) {
|
|
||||||
if (masked[i] === "{") depth += 1;
|
|
||||||
else if (masked[i] === "}") {
|
|
||||||
depth -= 1;
|
|
||||||
if (depth === 0) return i + 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
throw new Error("unterminated block");
|
|
||||||
}
|
|
||||||
|
|
||||||
// The catch handler guarding a given decryptWithPassword call: walk out to
|
|
||||||
// the try block the call sits in, then take the catch that follows it.
|
|
||||||
function handlerSpan(masked, callOffset, label) {
|
|
||||||
const tryOpen = enclosingBlockStart(masked, callOffset);
|
|
||||||
if (tryOpen === -1 || !/\btry\s*$/.test(masked.slice(0, tryOpen)))
|
|
||||||
throw new Error(`${label}: the decrypt is not inside a try block`);
|
|
||||||
const rest = masked.slice(blockEnd(masked, tryOpen));
|
|
||||||
const catchMatch = /^\s*catch\s*(\([^)]*\)\s*)?\{/.exec(rest);
|
|
||||||
if (!catchMatch)
|
|
||||||
throw new Error(`${label}: the decrypt's try block has no catch`);
|
|
||||||
const catchOpen = blockEnd(masked, tryOpen) + catchMatch[0].length - 1;
|
|
||||||
return [catchOpen, blockEnd(masked, catchOpen)];
|
|
||||||
}
|
|
||||||
|
|
||||||
// The prose the handler puts in front of the user. Element ids, class
|
|
||||||
// names and visibility keywords are single words; a sentence has a space
|
|
||||||
// in it, and that is the whole distinction needed here.
|
|
||||||
function handlerMessages(file, callOffset, label) {
|
|
||||||
const { masked, strings } = scan(fs.readFileSync(file, "utf8"));
|
|
||||||
const [from, to] = handlerSpan(masked, callOffset, label);
|
|
||||||
return strings
|
|
||||||
.filter((s) => s.offset >= from && s.offset < to)
|
|
||||||
.map((s) => s.value)
|
|
||||||
.filter((v) => v.includes(" "));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The call sites are found, not listed: the file layout moves (the private
|
|
||||||
// key export was in addressDetail.js when #172 was filed and is its own
|
|
||||||
// view now), and a hardcoded list would quietly stop covering a screen it
|
|
||||||
// no longer names.
|
|
||||||
function callSites() {
|
|
||||||
const sites = [];
|
|
||||||
for (const file of jsFilesUnder(SRC)) {
|
|
||||||
if (file === path.join(SRC, "shared", "vault.js")) continue;
|
|
||||||
const { masked } = scan(fs.readFileSync(file, "utf8"));
|
|
||||||
const rel = path.relative(SRC, file).split(path.sep).join("/");
|
|
||||||
let n = 0;
|
|
||||||
let at = masked.indexOf("decryptWithPassword(");
|
|
||||||
while (at !== -1) {
|
|
||||||
n += 1;
|
|
||||||
sites.push({ file, rel, offset: at, label: `${rel} #${n}` });
|
|
||||||
at = masked.indexOf("decryptWithPassword(", at + 1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return sites.sort((a, b) => a.label.localeCompare(b.label));
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("password failure messages", () => {
|
|
||||||
const sites = callSites();
|
|
||||||
const files = [...new Set(sites.map((s) => s.file))].sort();
|
|
||||||
|
|
||||||
test("the call sites are found where they are expected", () => {
|
|
||||||
const counts = {};
|
|
||||||
for (const site of sites)
|
|
||||||
counts[site.rel] = (counts[site.rel] ?? 0) + 1;
|
|
||||||
expect(counts).toEqual({
|
|
||||||
"popup/views/approval.js": 2,
|
|
||||||
"popup/views/confirmTx.js": 1,
|
|
||||||
"popup/views/deleteWallet.js": 1,
|
|
||||||
"popup/views/exportPrivkey.js": 1,
|
|
||||||
"popup/views/showPhrase.js": 1,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the canonical message is a full sentence", () => {
|
|
||||||
expect(CANONICAL).toMatch(/^[A-Z][^]*\.$/);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Exact equality, per call site: a message that is merely different
|
|
||||||
// rather than known-obsolete fails here too, which a scan for historic
|
|
||||||
// wordings cannot do.
|
|
||||||
test.each(sites.map((s) => [s.label, s]))(
|
|
||||||
"%s answers a rejected password with the canonical sentence",
|
|
||||||
(label, site) => {
|
|
||||||
expect(handlerMessages(site.file, site.offset, label)).toEqual([
|
|
||||||
CANONICAL,
|
|
||||||
]);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
test.each(files.map((f) => [path.relative(SRC, f), f]))(
|
|
||||||
"%s carries no superseded wording",
|
|
||||||
(_rel, file) => {
|
|
||||||
const source = fs.readFileSync(file, "utf8");
|
|
||||||
for (const old of SUPERSEDED) expect(source).not.toContain(old);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
});
|
|
||||||
@@ -159,113 +159,3 @@ describe("hideSpoofedSymbols persistence", () => {
|
|||||||
expect(second.mod.state.hideSpoofedSymbols).toBe(true);
|
expect(second.mod.state.hideSpoofedSymbols).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// restoreView() refuses to reopen ONTO a non-restorable view, but the stack
|
|
||||||
// behind it was restored verbatim, so Back could still walk onto a screen
|
|
||||||
// whose content is deliberately never re-rendered — and "show-phrase" has no
|
|
||||||
// Back control of its own to leave by. The stack is filtered on load, at the
|
|
||||||
// first entry the popup would not render, and everything above it goes too:
|
|
||||||
// those entries were reached THROUGH the dropped one.
|
|
||||||
describe("restored viewStack is filtered against RESTORABLE_VIEWS", () => {
|
|
||||||
const NON_RESTORABLE = ["export-privkey", "show-phrase"];
|
|
||||||
|
|
||||||
function restoredStack(viewStack, currentView = "settings") {
|
|
||||||
return loadModuleWith({
|
|
||||||
wallets: oneWallet(),
|
|
||||||
currentView,
|
|
||||||
viewStack,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
test("a non-restorable view at the top of the stack is dropped", async () => {
|
|
||||||
const { mod } = restoredStack(["main", "address", "export-privkey"]);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(["main", "address"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a non-restorable view in the middle truncates the stack there", async () => {
|
|
||||||
const { mod } = restoredStack(["main", "show-phrase", "address"]);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(["main"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Truncating a stack rooted at a non-restorable view leaves nothing, and
|
|
||||||
// the restored view still needs somewhere for Back to go.
|
|
||||||
test("a non-restorable view at the bottom leaves main to go back to", async () => {
|
|
||||||
const { mod } = restoredStack(["export-privkey", "address", "receive"]);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(["main"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("no restored stack retains a secret-bearing view", async () => {
|
|
||||||
for (const view of NON_RESTORABLE) {
|
|
||||||
const { mod } = restoredStack(["main", "address", view, "receive"]);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).not.toContain(view);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The rule is "views the popup will render", not a blocklist of the two
|
|
||||||
// secret screens: a name no longer in the set (or never a view at all)
|
|
||||||
// has to go the same way.
|
|
||||||
test("a name that is not a restorable view at all is dropped", async () => {
|
|
||||||
const { mod } = restoredStack(["main", "welcome", "address"]);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(["main"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Restorable entries are kept verbatim. That they are then unhidden
|
|
||||||
// without being re-rendered is a separate defect, tracked in #268; this
|
|
||||||
// filter is only about views the popup declined to restore.
|
|
||||||
test("an ordinary restorable stack is restored unchanged", async () => {
|
|
||||||
const stack = ["main", "address", "address-token"];
|
|
||||||
const { mod } = restoredStack(stack);
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(stack);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("restoring onto main keeps the stack empty", async () => {
|
|
||||||
const { mod } = restoredStack(["show-phrase"], "main");
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// main is not the only view that gets no ["main"] beneath it: restoreView()
|
|
||||||
// will not reopen onto a non-restorable view either, so nothing is left for
|
|
||||||
// Back to sit under and the stack stays empty.
|
|
||||||
test("restoring onto a view the popup will not reopen keeps the stack empty", async () => {
|
|
||||||
const { mod } = restoredStack(["export-privkey"], "show-phrase");
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Not an array means nothing survives, but the never-empty rule still
|
|
||||||
// applies: a corrupt stack must not leave a restored view with no Back
|
|
||||||
// target of its own.
|
|
||||||
test("a stack that is not an array still gets main beneath a restored view", async () => {
|
|
||||||
const { mod } = restoredStack("main");
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual(["main"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a stack that is not an array loads as empty under main", async () => {
|
|
||||||
const { mod } = restoredStack({ 0: "main" }, "main");
|
|
||||||
await mod.loadState();
|
|
||||||
expect(mod.state.viewStack).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Filtering belongs on load, not on save: the live in-session stack is
|
|
||||||
// legitimate — the user really is one Back away from a screen that is
|
|
||||||
// rendered right now — and only a load-side filter also cleans the
|
|
||||||
// stacks already sitting in storage.
|
|
||||||
test("saveState persists the live stack verbatim", async () => {
|
|
||||||
const { mod, set } = loadModuleWith(null);
|
|
||||||
mod.state.viewStack = ["main", "address", "export-privkey"];
|
|
||||||
await mod.saveState();
|
|
||||||
expect(set).toHaveBeenCalledWith({
|
|
||||||
autistmask: expect.objectContaining({
|
|
||||||
viewStack: ["main", "address", "export-privkey"],
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ global.chrome = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const { isSpoofedSymbol } = require("../src/shared/symbolSpoof");
|
const { isSpoofedSymbol } = require("../src/shared/symbolSpoof");
|
||||||
const { TOKENS, KNOWN_SYMBOLS } = require("../src/shared/tokenList");
|
const { KNOWN_SYMBOLS } = require("../src/shared/tokenList");
|
||||||
const { filterTransactions } = require("../src/shared/transactions");
|
const { filterTransactions } = require("../src/shared/transactions");
|
||||||
const {
|
const {
|
||||||
fetchTokenBalances,
|
fetchTokenBalances,
|
||||||
@@ -124,301 +124,6 @@ describe("the shared rule", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// Issue #260: the symbol is whatever the ERC-20 contract returns, and HTML
|
|
||||||
// collapses leading and trailing whitespace, so a token calling itself
|
|
||||||
// `" ETH "` reaches the user's eye as `ETH` while missing a raw
|
|
||||||
// KNOWN_SYMBOLS lookup. Normalizing inside the shared rule fixes all three
|
|
||||||
// surfaces at once, which is what consolidating the rule bought.
|
|
||||||
//
|
|
||||||
// Every character under test here is built from its code point rather than
|
|
||||||
// pasted in: most of them are invisible, and an invisible character in a
|
|
||||||
// test file is unreviewable.
|
|
||||||
const cp = (...codes) => String.fromCodePoint(...codes);
|
|
||||||
const NBSP = cp(0x00a0); // no-break space
|
|
||||||
const FIGURE_SPACE = cp(0x2007);
|
|
||||||
const IDEOGRAPHIC_SPACE = cp(0x3000);
|
|
||||||
const ZWSP = cp(0x200b); // zero-width space
|
|
||||||
const BOM = cp(0xfeff); // zero-width no-break space
|
|
||||||
const WORD_JOINER = cp(0x2060);
|
|
||||||
const SOFT_HYPHEN = cp(0x00ad);
|
|
||||||
const LRM = cp(0x200e); // left-to-right mark
|
|
||||||
const RLO = cp(0x202e); // right-to-left override
|
|
||||||
const HANGUL_FILLER = cp(0x3164);
|
|
||||||
const CHOSEONG_FILLER = cp(0x115f);
|
|
||||||
const VS16 = cp(0xfe0f); // variation selector-16
|
|
||||||
const VS1 = cp(0xfe00); // variation selector-1
|
|
||||||
const NEL = cp(0x0085); // next line, a C1 control
|
|
||||||
const DEL = cp(0x007f);
|
|
||||||
const FULLWIDTH_ETH = cp(0xff25, 0xff34, 0xff28);
|
|
||||||
const FULLWIDTH_USDC = cp(0xff55, 0xff53, 0xff44, 0xff43); // lowercase
|
|
||||||
const CYRILLIC_CAPITAL_IE = cp(0x0415);
|
|
||||||
|
|
||||||
describe("the shared rule: symbols that render as a known symbol", () => {
|
|
||||||
test("ASCII padding does not buy a pass", () => {
|
|
||||||
expect(isSpoofedSymbol(" ETH ", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
expect(isSpoofedSymbol("\tETH\n", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
expect(isSpoofedSymbol(" usdc ", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("non-breaking and other Unicode spaces do not either", () => {
|
|
||||||
expect(isSpoofedSymbol(NBSP + "ETH" + NBSP, FAKE_ETH_CONTRACT)).toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
expect(
|
|
||||||
isSpoofedSymbol(
|
|
||||||
FIGURE_SPACE + "ETH" + IDEOGRAPHIC_SPACE,
|
|
||||||
FAKE_ETH_CONTRACT,
|
|
||||||
),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// These render as nothing at all, in any position, so they are removed
|
|
||||||
// wherever they sit rather than only at the ends.
|
|
||||||
test("zero-width characters are stripped wherever they sit", () => {
|
|
||||||
expect(isSpoofedSymbol("E" + ZWSP + "TH", FAKE_ETH_CONTRACT)).toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
expect(isSpoofedSymbol(BOM + "ETH", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
expect(
|
|
||||||
isSpoofedSymbol("ET" + WORD_JOINER + "H", FAKE_ETH_CONTRACT),
|
|
||||||
).toBe(true);
|
|
||||||
expect(
|
|
||||||
isSpoofedSymbol("E" + SOFT_HYPHEN + "TH", FAKE_ETH_CONTRACT),
|
|
||||||
).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// An LRM is invisible and, in all-Latin text, moves nothing: dropping it
|
|
||||||
// leaves exactly the string the user saw.
|
|
||||||
test("an invisible bidi mark does not hide a known symbol", () => {
|
|
||||||
expect(isSpoofedSymbol(LRM + "ETH", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Invisibility is not confined to \p{Cf}. A Hangul filler is Lo and a
|
|
||||||
// variation selector is Mn, yet each of these four measures 32.00px in
|
|
||||||
// the repo's pinned e2e Chromium at 16px sans-serif — exactly the width
|
|
||||||
// of a plain `ETH` — so each reaches the user's eye as `ETH`. They are
|
|
||||||
// caught by \p{Default_Ignorable_Code_Point}, not by \p{Cf}.
|
|
||||||
test("invisible non-format characters are stripped too", () => {
|
|
||||||
expect(isSpoofedSymbol(HANGUL_FILLER + "ETH", FAKE_ETH_CONTRACT)).toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
expect(
|
|
||||||
isSpoofedSymbol(CHOSEONG_FILLER + "ETH", FAKE_ETH_CONTRACT),
|
|
||||||
).toBe(true);
|
|
||||||
expect(isSpoofedSymbol("ETH" + VS16, FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
expect(isSpoofedSymbol("E" + VS1 + "TH", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Nor is it confined to the Unicode classes. U+007F is a control (Cc)
|
|
||||||
// and is not default-ignorable, so neither class reaches it, but it
|
|
||||||
// measures 32.00px in the same browser — it paints nothing, so a
|
|
||||||
// symbol carrying it reaches the eye as `ETH`. It is named on its own
|
|
||||||
// in the strip for exactly that reason.
|
|
||||||
test("U+007F paints nothing and is stripped", () => {
|
|
||||||
expect(isSpoofedSymbol(DEL + "ETH", FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The other side of the boundary, which is not the class boundary but
|
|
||||||
// the visibility one: the remaining C0 and C1 controls render as a
|
|
||||||
// visible 48.00px box in the same browser, so a symbol carrying one
|
|
||||||
// does not look like `ETH` and must not be judged a spoof. Widening
|
|
||||||
// the strip to \p{Cc} — the obvious over-correction once U+007F is in
|
|
||||||
// it — fails this test.
|
|
||||||
test("visible control characters do not make a symbol a spoof", () => {
|
|
||||||
expect(isSpoofedSymbol(NEL + "ETH", FAKE_ETH_CONTRACT)).toBe(false);
|
|
||||||
expect(isSpoofedSymbol(cp(0x0001) + "ETH", FAKE_ETH_CONTRACT)).toBe(
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
expect(isSpoofedSymbol(cp(0x0090) + "ETH", FAKE_ETH_CONTRACT)).toBe(
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("compatibility forms fold onto the symbol they imitate", () => {
|
|
||||||
expect(isSpoofedSymbol(FULLWIDTH_ETH, FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
expect(isSpoofedSymbol(FULLWIDTH_USDC, FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The two knowingly open classes, asserted here so that the boundary is
|
|
||||||
// a fact in the suite and not a claim in a PR body. A Cyrillic capital
|
|
||||||
// Ie is a distinct letter rather than a compatibility variant, so NFKC
|
|
||||||
// leaves it alone; and a right-to-left override reverses the rendering
|
|
||||||
// of what follows it, which dropping the control character does not
|
|
||||||
// undo. Closing either needs a confusables table or a bidi resolver,
|
|
||||||
// and both are a separate change from this one.
|
|
||||||
test("a Cyrillic homoglyph is knowingly still not caught", () => {
|
|
||||||
expect(
|
|
||||||
isSpoofedSymbol(CYRILLIC_CAPITAL_IE + "TH", FAKE_ETH_CONTRACT),
|
|
||||||
).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a bidi-reordered symbol is knowingly still not caught", () => {
|
|
||||||
expect(isSpoofedSymbol(RLO + "HTE", FAKE_ETH_CONTRACT)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Normalization does not reach the native-asset exemption, which turns
|
|
||||||
// on the absence of a contract address and never on the symbol.
|
|
||||||
test("a padded symbol with no contract is still not a spoof", () => {
|
|
||||||
expect(isSpoofedSymbol(" ETH ", null)).toBe(false);
|
|
||||||
expect(isSpoofedSymbol(NBSP + "ETH", "")).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a genuine contract still bears its own padded symbol", () => {
|
|
||||||
expect(isSpoofedSymbol(" USDC ", USDC_CONTRACT)).toBe(false);
|
|
||||||
expect(isSpoofedSymbol(ZWSP + "WETH", WETH_CONTRACT)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Normalization must not invent a match. Interior ASCII whitespace is
|
|
||||||
// left alone: `E T H` renders as `E T H`, not as `ETH`, so folding it
|
|
||||||
// would filter a token no user could confuse with the native asset.
|
|
||||||
test("a symbol that renders differently is not judged a spoof", () => {
|
|
||||||
expect(isSpoofedSymbol("E T H", FAKE_ETH_CONTRACT)).toBe(false);
|
|
||||||
expect(isSpoofedSymbol("ETH2", FAKE_ETH_CONTRACT)).toBe(false);
|
|
||||||
expect(isSpoofedSymbol("MY ETH", FAKE_ETH_CONTRACT)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The false-positive question, answered against the shipped data rather
|
|
||||||
// than by assertion: no bundled symbol carries whitespace or a
|
|
||||||
// non-ASCII character, so the normalization cannot newly filter one.
|
|
||||||
// The character class starts at `!` rather than at the space so that it
|
|
||||||
// asserts the claim it stands for — `[ -~]` would admit an interior
|
|
||||||
// space and let a whitespace-bearing entry through the guard.
|
|
||||||
test("no bundled symbol is touched by the normalization", () => {
|
|
||||||
for (const [symbol, addresses] of KNOWN_SYMBOLS) {
|
|
||||||
expect(symbol).toBe(symbol.trim());
|
|
||||||
expect(symbol).toMatch(/^[!-~]+$/);
|
|
||||||
if (addresses === null) continue;
|
|
||||||
for (const address of addresses) {
|
|
||||||
expect(isSpoofedSymbol(symbol, address)).toBe(false);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// Issue #276: the guard that was missing. The suite walked KNOWN_SYMBOLS,
|
|
||||||
// which is built from TOKENS, so it could only ever assert that the table
|
|
||||||
// agrees with itself. Seven symbols appear twice in the bundled list at two
|
|
||||||
// different real contracts, and the table kept whichever came first, so the
|
|
||||||
// other seven contracts — tokens in our own shipped list, at their own
|
|
||||||
// addresses — were judged spoofs and hidden from the balance list, the
|
|
||||||
// history and the send selector. That is the over-filtering direction: it
|
|
||||||
// hides a holding the user cannot then spend.
|
|
||||||
//
|
|
||||||
// This walk is over TOKENS, the data the wallet actually ships, so it fails
|
|
||||||
// whenever a bundled token would be filtered at its own address no matter
|
|
||||||
// which side of the table the mistake is on.
|
|
||||||
describe("the shipped token list", () => {
|
|
||||||
test("no bundled token is filtered at its own address", () => {
|
|
||||||
const filtered = TOKENS.filter((t) =>
|
|
||||||
isSpoofedSymbol(t.symbol, t.address),
|
|
||||||
).map((t) => t.symbol + " @ " + t.address);
|
|
||||||
expect(filtered).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The third failure mode the issue asks about: a symbol whose table entry
|
|
||||||
// names an address that is in neither the table nor the list would be a
|
|
||||||
// contract we vouch for and do not ship. There is none, and the table is
|
|
||||||
// built from the list, so this asserts the derivation has not acquired a
|
|
||||||
// hand-written entry.
|
|
||||||
test("every address the table vouches for is a bundled token", () => {
|
|
||||||
const bundled = new Set(TOKENS.map((t) => t.address.toLowerCase()));
|
|
||||||
for (const [symbol, addresses] of KNOWN_SYMBOLS) {
|
|
||||||
if (addresses === null) continue;
|
|
||||||
expect(addresses.size).toBeGreaterThan(0);
|
|
||||||
for (const address of addresses) {
|
|
||||||
expect(address).toBe(address.toLowerCase());
|
|
||||||
expect(bundled.has(address)).toBe(true);
|
|
||||||
// And it is the token that actually reports that symbol.
|
|
||||||
const token = TOKENS.find(
|
|
||||||
(t) => t.address.toLowerCase() === address,
|
|
||||||
);
|
|
||||||
expect(token.symbol.toUpperCase()).toBe(symbol);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Both contracts behind a shared ticker must pass, from either side: a
|
|
||||||
// rule that admits only the one the table happens to visit first is the
|
|
||||||
// bug, not the fix.
|
|
||||||
test("both contracts behind a shared ticker are admitted", () => {
|
|
||||||
const bySymbol = new Map();
|
|
||||||
for (const t of TOKENS) {
|
|
||||||
const upper = t.symbol.toUpperCase();
|
|
||||||
if (!bySymbol.has(upper)) bySymbol.set(upper, []);
|
|
||||||
bySymbol.get(upper).push(t);
|
|
||||||
}
|
|
||||||
const shared = [...bySymbol].filter(([, list]) => list.length > 1);
|
|
||||||
// The shared tickers are a fact about the shipped data; if a future
|
|
||||||
// list has none, this test would silently assert nothing.
|
|
||||||
expect(shared.length).toBeGreaterThan(0);
|
|
||||||
for (const [, list] of shared) {
|
|
||||||
for (const t of list) {
|
|
||||||
expect(isSpoofedSymbol(t.symbol, t.address)).toBe(false);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The seven from issue #276, named so that the reconciliation is a fact
|
|
||||||
// in the suite: each is two real contracts from the same source fetch,
|
|
||||||
// and the table now holds both rather than the one that came first.
|
|
||||||
test("the seven shared tickers each name both bundled contracts", () => {
|
|
||||||
const expected = {
|
|
||||||
TON: [
|
|
||||||
"0x582d872a1b094fc48f5de31d3b73f2d9be47def1", // Toncoin
|
|
||||||
"0x2be5e8c109e2197d077d13a82daead6a9b3433c5", // Tokamak Network
|
|
||||||
],
|
|
||||||
FRAX: [
|
|
||||||
"0x853d955acef822db058eb8505911ed77f175b99e", // Legacy Frax Dollar
|
|
||||||
"0x3432b6a60d23ca0dfca7761b7ab56459d9c964d0", // Frax (prev. FXS)
|
|
||||||
],
|
|
||||||
REUSD: [
|
|
||||||
"0x5086bf358635b81d8c47c66d1c8b9e567db70c72", // Re Protocol reUSD
|
|
||||||
"0x57ab1e0003f623289cd798b1824be09a793e4bec", // Resupply USD
|
|
||||||
],
|
|
||||||
EURE: [
|
|
||||||
"0x39b8b6385416f4ca36a20319f70d28621895279d", // Monerium EUR emoney
|
|
||||||
"0x3231cb76718cdef2155fc47b5286d82e6eda273f", // Monerium EUR emoney [OLD]
|
|
||||||
],
|
|
||||||
MSUSD: [
|
|
||||||
"0x4ba01f22827018b4772cd326c7627fb4956a7c00", // Main Street USD
|
|
||||||
"0xab5eb14c09d416f0ac63661e57edb7aecdb9befa", // Metronome Synth USD
|
|
||||||
],
|
|
||||||
MUSD: [
|
|
||||||
"0xaca92e438df0b2401ff60da7e4337b687a2435da", // MetaMask USD
|
|
||||||
"0xdd468a1ddc392dcdbef6db6e34e89aa338f9f186", // Mezo USD
|
|
||||||
],
|
|
||||||
JPYC: [
|
|
||||||
"0x431d5dff03120afa4bdf332c61a6e1766ef37bdb", // JPY Coin
|
|
||||||
"0x2370f9d504c7a6e775bf6e14b3f12846b594cd53", // JPY Coin v1
|
|
||||||
],
|
|
||||||
};
|
|
||||||
for (const [symbol, addresses] of Object.entries(expected)) {
|
|
||||||
expect([...KNOWN_SYMBOLS.get(symbol)].sort()).toEqual(
|
|
||||||
[...addresses].sort(),
|
|
||||||
);
|
|
||||||
for (const address of addresses) {
|
|
||||||
expect(isSpoofedSymbol(symbol, address)).toBe(false);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The other direction, on the same symbols: widening the table to hold
|
|
||||||
// every bundled address for a ticker must not turn it into a pass for
|
|
||||||
// any other contract.
|
|
||||||
test("a shared ticker from a third contract is still a spoof", () => {
|
|
||||||
const bySymbol = new Map();
|
|
||||||
for (const t of TOKENS) {
|
|
||||||
const upper = t.symbol.toUpperCase();
|
|
||||||
if (!bySymbol.has(upper)) bySymbol.set(upper, []);
|
|
||||||
bySymbol.get(upper).push(t);
|
|
||||||
}
|
|
||||||
for (const [symbol, list] of bySymbol) {
|
|
||||||
if (list.length < 2) continue;
|
|
||||||
expect(isSpoofedSymbol(symbol, FAKE_ETH_CONTRACT)).toBe(true);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("surface 1: the transaction history", () => {
|
describe("surface 1: the transaction history", () => {
|
||||||
function fakeEthTransfer() {
|
function fakeEthTransfer() {
|
||||||
return {
|
return {
|
||||||
@@ -442,22 +147,6 @@ describe("surface 1: the transaction history", () => {
|
|||||||
expect(result.transactions).toEqual([]);
|
expect(result.transactions).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Issue #260 on this surface: the same transfer with a padded symbol.
|
|
||||||
test("a padded fake ETH token transfer is filtered too", () => {
|
|
||||||
const padded = { ...fakeEthTransfer(), symbol: " ETH " };
|
|
||||||
const result = filterTransactions([padded], {
|
|
||||||
hideSpoofedSymbols: true,
|
|
||||||
hideFraudContracts: true,
|
|
||||||
hideLowHolderTokens: true,
|
|
||||||
hideDustTransactions: true,
|
|
||||||
dustThresholdGwei: 100000,
|
|
||||||
});
|
|
||||||
expect(result.transactions).toEqual([]);
|
|
||||||
// The contract is learned as fraudulent, exactly as for the
|
|
||||||
// unpadded symbol: the padding must not cost the blocklist entry.
|
|
||||||
expect(result.newFraudContracts).toEqual([FAKE_ETH_CONTRACT]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a real native ETH transfer survives", () => {
|
test("a real native ETH transfer survives", () => {
|
||||||
const native = {
|
const native = {
|
||||||
hash: "0x" + "2".repeat(64),
|
hash: "0x" + "2".repeat(64),
|
||||||
@@ -512,36 +201,6 @@ describe("surface 2: the Send token selector", () => {
|
|||||||
expect(select.children).toEqual([]);
|
expect(select.children).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Issue #260 on this surface: the option text is rendered into HTML,
|
|
||||||
// which collapses the padding, so an unfiltered padded token would sit
|
|
||||||
// in the selector reading exactly `ETH`.
|
|
||||||
test("a padded fake ETH token is not selectable either", () => {
|
|
||||||
render([
|
|
||||||
{
|
|
||||||
address: FAKE_ETH_CONTRACT,
|
|
||||||
symbol: " ETH ",
|
|
||||||
decimals: 18,
|
|
||||||
balance: "0.005",
|
|
||||||
holders: 900000,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
expect(select.children).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a genuine token with a padded symbol stays selectable", () => {
|
|
||||||
render([
|
|
||||||
{
|
|
||||||
address: USDC_CONTRACT,
|
|
||||||
symbol: " USDC ",
|
|
||||||
decimals: 6,
|
|
||||||
balance: "12.5",
|
|
||||||
holders: 900000,
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
expect(select.children).toHaveLength(1);
|
|
||||||
expect(select.children[0].value).toBe(USDC_CONTRACT);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("native ETH remains the always-present option", () => {
|
test("native ETH remains the always-present option", () => {
|
||||||
render([]);
|
render([]);
|
||||||
expect(select.innerHTML).toBe('<option value="ETH">ETH</option>');
|
expect(select.innerHTML).toBe('<option value="ETH">ETH</option>');
|
||||||
@@ -592,35 +251,6 @@ describe("surface 3: the balance list", () => {
|
|||||||
expect(balances).toEqual([]);
|
expect(balances).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Issue #260 on this surface: the balance list is where the user forms
|
|
||||||
// their belief about what they own, and it renders the symbol into HTML.
|
|
||||||
test("a padded fake ETH token is filtered too", async () => {
|
|
||||||
respondWith([fakeEthItem({ symbol: " ETH " })]);
|
|
||||||
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a fake ETH token padded with a no-break space is filtered", async () => {
|
|
||||||
respondWith([fakeEthItem({ symbol: NBSP + "ETH" + NBSP })]);
|
|
||||||
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The false-positive direction on the surface that matters most: a real
|
|
||||||
// holding whose symbol happens to carry padding is still listed, and the
|
|
||||||
// list still shows the symbol the token actually reports.
|
|
||||||
test("a genuine token with a padded symbol is not newly filtered", async () => {
|
|
||||||
respondWith([
|
|
||||||
fakeEthItem({
|
|
||||||
address_hash: USDC_CONTRACT,
|
|
||||||
symbol: " USDC ",
|
|
||||||
name: "USD Coin",
|
|
||||||
decimals: "6",
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
|
|
||||||
expect(balances).toHaveLength(1);
|
|
||||||
expect(balances[0].symbol).toBe(" USDC ");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a genuine token keeps its place in the list", async () => {
|
test("a genuine token keeps its place in the list", async () => {
|
||||||
respondWith([
|
respondWith([
|
||||||
fakeEthItem({
|
fakeEthItem({
|
||||||
@@ -644,33 +274,6 @@ describe("surface 3: the balance list", () => {
|
|||||||
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The adjacent finding from the same review as issue #260: the type gate
|
|
||||||
// compared exactly, so an explorer that ever varied the casing would
|
|
||||||
// silently drop a real holding before any filter ran. The comparison is
|
|
||||||
// now case-insensitive, which changes nothing about which types are
|
|
||||||
// admitted.
|
|
||||||
test("a differently-cased ERC-20 type still lists a real holding", async () => {
|
|
||||||
respondWith([
|
|
||||||
fakeEthItem({
|
|
||||||
type: "erc-20",
|
|
||||||
address_hash: USDC_CONTRACT,
|
|
||||||
symbol: "USDC",
|
|
||||||
name: "USD Coin",
|
|
||||||
decimals: "6",
|
|
||||||
}),
|
|
||||||
]);
|
|
||||||
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
|
|
||||||
expect(balances).toHaveLength(1);
|
|
||||||
expect(balances[0].symbol).toBe("USDC");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("case insensitivity does not admit another token type", async () => {
|
|
||||||
respondWith([fakeEthItem({ type: "erc-721" })]);
|
|
||||||
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
|
||||||
respondWith([fakeEthItem({ type: "ERC-20-EXTRA" })]);
|
|
||||||
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The money test: the user holds real ETH and has been airdropped a fake
|
// The money test: the user holds real ETH and has been airdropped a fake
|
||||||
// ETH ERC-20. The fake is gone from the list of tokens; the real balance
|
// ETH ERC-20. The fake is gone from the list of tokens; the real balance
|
||||||
// is exactly what the node reported.
|
// is exactly what the node reported.
|
||||||
|
|||||||
@@ -207,8 +207,8 @@ describe("token list assumptions the fixtures rely on", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("USDC and WETH map to their genuine lowercased contracts", () => {
|
test("USDC and WETH map to their genuine lowercased contracts", () => {
|
||||||
expect([...KNOWN_SYMBOLS.get("USDC")]).toEqual([USDC_CONTRACT]);
|
expect(KNOWN_SYMBOLS.get("USDC")).toBe(USDC_CONTRACT);
|
||||||
expect([...KNOWN_SYMBOLS.get("WETH")]).toEqual([WETH_CONTRACT]);
|
expect(KNOWN_SYMBOLS.get("WETH")).toBe(WETH_CONTRACT);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the spam fixture symbol is not in the known token list", () => {
|
test("the spam fixture symbol is not in the known token list", () => {
|
||||||
|
|||||||
Reference in New Issue
Block a user