Author SHA1 Message Date
sneak 1e8691a3f6 fix: a split swap's Min. received is the sum of its steps' minimums (closes #647)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
The step that sets the output side gives the minimum. When that step
and earlier swap steps each pay the output token to the sender, the
minimum is now the sum of their minimums. There is no figure when the
decoder reads none from one of them, or when one of them pays part of
that token elsewhere.

These steps drop earlier steps from the sum:

- a V2 or V3 swap step that spends the output token;
- a V4 step with a swap action that spends that token, or with a SETTLE
  or SETTLE_ALL of that token;
- a PERMIT2_TRANSFER_FROM of that token.

A step after the step that sets the output side drops nothing from the
sum.

Model: opus-5-5
2026-10-27 09:50:02 +00:00
clawbot c0a3a02418 fix: a network switch in Settings leaves no balance from the previous network stored (closes #653)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
A network switch in Settings could leave the previous network's balance in the stored record. The switch clears the page's balances inside its save, but the save writes only fields the page changed since its last save. When the page had last saved "0" for an address, the cleared "0" was no change, so a balance the background's refresh stored meanwhile stayed under the new network. The switch's save now always writes the cleared balances and the time of the last balance refresh. Every other field merges as before.

Model: opus-5-5
2026-10-27 10:14:06 +01:00
clawbot f550d8c8d2 fix: a zero-minimum balance check never sets the output side (closes #649)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
A BALANCE_CHECK_ERC20 of the sender with a zero minimum, or one the router lets fail, no longer sets Token Out or the minimum. Before, it set both whenever the output side held no minimum, so after an UNWRAP_WETH that drops the minimum, a zero check of USDC named USDC as Token Out, a token the swap did not pay. A check with a positive minimum, not allowed to fail, sets the output side as before. Two existing tests that expected the wrong token are corrected, and README states the rule.

Model: opus-5-5
2026-10-27 08:57:59 +01:00
clawbot fc6cffcaba fix: a Permit2 transfer of the zero address never reads as ETH (closes #685)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
A PERMIT2_TRANSFER_FROM of the zero address read Token moved: ETH, with an ETH figure, though Permit2 moves no ETH. Such a move now names the zero address as its token on Token moved and Token moved into the router, and gives its amount in base units on Moved from the sender and Paid to. The zero-address check from the permit lines is now one function, permit2TokenInfo(), shared by the move lines. A V4 step of ETH that states no amount still gets its own lines beside such a move, so no line about ETH leaving is dropped.

Model: opus-5-5
2026-10-27 07:53:05 +01:00
clawbot 5615b08760 fix: Settings refuses an endpoint URL whose network changed before it was stored (closes #663)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
The RPC and Blockscout "Save" buttons in Settings now store a URL only for the network that Settings showed when "Save" was tapped. The URL is set inside the save, under the lock, so the popup cannot follow a network switch saved elsewhere between setting it and writing it. If that network is no longer active on the page or in the stored record, the save is refused and the flash reads "The URL was not saved because the network changed." "Saved." appears only for a stored URL. The RPC check compares the node's chain id with the network shown at the tap.

Model: opus-5-5
2026-10-27 07:27:15 +01:00
clawbot ec6b6b57a3 fix: a V4 SETTLE of ETH paid from the router reads as moved from the sender (closes #682)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
V4Router pays a SETTLE of ETH from the router's own ETH, whichever payer it names, and the router holds the transaction's value. A V4 SETTLE of ETH that names the router as payer now counts as ETH the user pays. With no ETH left in the router by an earlier step, it reads as a SETTLE the user pays. When an earlier step left ETH there, it gets lines of its own reading Up to and the amount. When the amount is not known, as for CONTRACT_BALANCE, its Moved from the sender line reads Unknown (could not be decoded). No line now shows less ETH than such a SETTLE can take.

Model: opus-5-5
2026-10-27 06:49:37 +01:00
clawbot 36b200247a fix: a permit on the zero address never reads as ETH (closes #660)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
Permit2 has no allowance of ETH, but the swap decoder read the zero address in a PERMIT2_PERMIT or a batch entry as ETH. Its Allowance token line now names the zero address, as for a token nothing knows. Its amount never stands as the Amount figure, and it never counts as an allowance of Token In, so a route that pays ETH after such a permit shows that ETH. Tests cover the single permit, the batch entry and the 1-wei route.

Model: opus-5-5
2026-10-27 05:12:38 +01:00
clawbot b4e166cdc7 fix: read USD prices from Chainlink price feeds through the RPC endpoint (closes #525)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
CoinDesk now refuses requests without an API key, so mainnet showed no USD prices. Mainnet prices now come from Chainlink's USD price feeds, read with eth_call through the user's RPC endpoint; no other service is asked. The bundled list pairs each of 53 tokens with its feed by contract address, and ETH and WETH use ETH/USD. The popup reads the feeds of ETH and the tokens the user holds or tracks in one batched request, at most every 5 minutes. A reading older than its heartbeat plus 30 minutes, or not positive, is no price. A token with no feed shows no USD value. CoinDesk is gone.

RULES.md still names the CoinDesk price API.

Model: opus-5-5
2026-10-27 04:23:17 +01:00
clawbot 53551c6382 fix: the StateRecovery erase warning names every kind of wallet backup (closes #593)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
The StateRecovery erase warning told every user to rely on each wallet's recovery phrase. A wallet imported from a private key or an extended private key has none; its backup is that key. The warning now names all three, in the words the delete-wallet screens use, and README's StateRecovery entry says what a wallet can be added again from. A test reads the warning.

Model: opus-5-5
2026-10-27 03:46:17 +01:00
clawbot 33ab99b7be fix: closing a transaction or signature approval window leaves the request pending (closes #673)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
Closing a transaction or signature approval window no longer rejects the request; only Cancel does. The browser can close that window when the user clicks away, for example to copy the password from a password manager. The request stays pending and the site gets no answer. Pressing the toolbar button opens the oldest such request, unless an approved attempt still holds it. A Reject the background refuses keeps the window open with the background's message. The worker points the toolbar back at the wallet when it starts.

While such a request waits, the transaction slot stays held, so another site's eth_sendTransaction gets -32002. An address switch still rejects pending approvals with 4001.

Model: opus-5-5
2026-10-27 00:56:36 +01:00
clawbot b58ecec1f9 fix: AutistMask does not work in Firefox private windows (closes #646)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
Firefox gives an extension page in a private window locks of its own, so a popup there could save between the background's read and its write and undo a network switch the background saved. `manifest/firefox.json` now sets `"incognito": "not_allowed"`, so such a page cannot read or write extension storage, and `tests/manifest.test.js` pins the key. README and the user guide say AutistMask does not work in Firefox private windows. Chrome needs no change: in its default incognito mode an extension page shares the background's lock.

A Firefox user on "Never remember history" can no longer run AutistMask at all.

Model: opus-5-5
2026-10-26 23:51:22 +01:00
clawbot 387f40689e feat: an "Allow weak passwords" setting lets a new wallet have a short password (closes #674)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
Settings has a new "Allow weak passwords" checkbox, off in a new profile. While it is off, AddWallet refuses a password shorter than 12 characters, as before. While it is on, AddWallet accepts any password that is not empty. Key derivation is unchanged: one Argon2id derivation at libsodium's interactive setting. README's Key Decisions now states those parameters and why one light derivation is enough: the password's length is what protects the stored secret.

The screens say "password", as README's wording rules require, so the setting is "Allow weak passwords".

Model: opus-5-5
2026-10-26 22:35:02 +01:00
clawbot bf8aa9f5dd fix: Blockscout and Etherscan lookups are off until the user turns them on (closes #668)
check / check (push) Waiting to run
e2e / e2e-chrome (push) Waiting to run
e2e / e2e-firefox (push) Waiting to run
Out of the box the wallet sent the user's addresses to Blockscout and each recipient's address to Etherscan. Two settings, "Use Blockscout" and "Check recipients on Etherscan", now gate every request that sends the user's data to those services. Both start off and are offered unticked on Welcome and in Settings. Each request reads its setting from storage before it asks. An answer that lands after the setting went off is dropped. While a setting is off, the screens that rely on it say so. ENS lookups ask only the RPC endpoint, so a name resolved off-chain does not resolve.

RULES.md's External Communication item is now out of date. Its new wording will be proposed on #211 once this lands.

Model: opus-5-5 (implementation, summary); fable-5-1 (prose)
2026-10-26 21:38:29 +01:00
81 changed files with 5260 additions and 1252 deletions
+509 -348
View File
File diff suppressed because it is too large Load Diff
+98 -67
View File
@@ -58,7 +58,7 @@ analytics, use a portfolio tracker. The wallet is not the place for any of that.
- **No NFT galleries or portfolio views.** This is a wallet, not a dashboard. - **No NFT galleries or portfolio views.** This is a wallet, not a dashboard.
- **No third-party token list APIs.** The balances of the tokens you track are - **No third-party token list APIs.** The balances of the tokens you track are
read from your RPC endpoint; while you have "Use Blockscout" on, the others read from your RPC endpoint. While "Use Blockscout" is on, the other tokens
come from the same block explorer you configure for transaction history. The come from the same block explorer you configure for transaction history. The
extension ships its own hardcoded list of top ERC-20 contract addresses for extension ships its own hardcoded list of top ERC-20 contract addresses for
symbol-spoofing detection. Any token you want tracked across all your symbol-spoofing detection. Any token you want tracked across all your
@@ -70,11 +70,13 @@ analytics, use a portfolio tracker. The wallet is not the place for any of that.
## How It Works ## How It Works
AutistMask is a browser extension that runs entirely in your browser. It does AutistMask is a browser extension that runs entirely in your browser. It does
not have a backend server. Out of the box it sends your data only to the not have a backend server. Out of the box it contacts only the Ethereum RPC
Ethereum RPC endpoint, and asks the CoinDesk price API for prices with nothing endpoint. USD prices are read from Chainlink price feed contracts through that
but token symbols. Blockscout and Etherscan are sent none of your data until you endpoint.
turn on "Use Blockscout" or "Check recipients on Etherscan", on the Welcome
screen or later in Settings. Both are off in a new install. Blockscout and Etherscan are sent none of your data until you turn on a setting
for each. The settings are "Use Blockscout" and "Check recipients on Etherscan".
Both are off in a new install. Welcome and Settings both offer them.
### External Services ### External Services
@@ -87,11 +89,20 @@ verify confirmations. The default is a free public RPC endpoint. You can change
this in Settings to any Ethereum JSON-RPC endpoint, including your own local this in Settings to any Ethereum JSON-RPC endpoint, including your own local
node. node.
When it is contacted: on every balance refresh (every 10 seconds while the popup On mainnet, AutistMask also reads USD prices through this endpoint. The prices
is open, every 60 seconds in the background), when you type an ENS name into the come from Chainlink's price feed contracts. A token with no Chainlink feed shows
Send screen, when a send is prepared and broadcast, while a pending transaction no USD value.
is polled for its receipt, and for the reverse ENS lookups used to label
addresses (cached for 12 hours). When it is contacted:
- on every balance refresh (every 10 seconds while the popup is open, every 60
seconds in the background)
- on mainnet, to read USD prices, at most every 5 minutes while the popup is
open
- when you review a send to an ENS name
- when a send is prepared and broadcast
- while a pending transaction is polled for its receipt
- for the reverse ENS lookups used to label addresses (cached for 12 hours)
What gets sent: standard Ethereum JSON-RPC requests (balance queries, What gets sent: standard Ethereum JSON-RPC requests (balance queries,
transaction broadcasts, gas estimates, ENS lookups, contract-code checks). Your transaction broadcasts, gas estimates, ENS lookups, contract-code checks). Your
@@ -100,52 +111,49 @@ addresses are necessarily visible to the RPC provider when querying balances.
**Blockscout API** (default: `eth.blockscout.com/api/v2`; **Blockscout API** (default: `eth.blockscout.com/api/v2`;
`eth-sepolia.blockscout.com/api/v2` on Sepolia) `eth-sepolia.blockscout.com/api/v2` on Sepolia)
Off until you turn on "Use Blockscout". Used to fetch transaction history, the Blockscout is an open-source blockchain explorer. AutistMask sends it your data
balances of the tokens you have not tracked, and the details of a transaction only while "Use Blockscout" is on. AutistMask then asks Blockscout for:
you open. Blockscout is an open-source blockchain explorer. AutistMask queries
it for your ERC-20 token balances (including the holder counts used for spam
filtering), your recent transactions and token transfers, and the block, fees
and calldata of a transaction you open. You can change this in Settings to a
self-hosted Blockscout instance. While it is off, the screens that would show
history say so, and only the tokens you track are listed.
When it is contacted: while "Use Blockscout" is on, on every balance refresh, - your recent transactions and token transfers
whenever a screen showing transaction history is opened, and when you open a - the balances of the tokens you have not tracked, with the holder counts used
transaction. The one exception, whether or not the setting is on, is pressing for spam filtering
"Save" beside the Blockscout URL in Settings, which checks that URL by asking it - the block, fees and calldata of a transaction you open
for `/stats` and sends none of your data.
You can change the endpoint in Settings to a self-hosted Blockscout instance.
While the setting is off, each screen that would show Blockscout's data says
instead that the setting is off. Only the tokens you track are listed. When you
turn the setting off, every other token leaves the lists at once.
When it is contacted, while "Use Blockscout" is on:
- on every balance refresh
- whenever a screen showing transaction history is opened
- when you open a transaction
Pressing "Save" beside the Blockscout URL in Settings checks the URL by asking
it for `/stats`. That happens whether or not the setting is on. The request
sends none of your data.
What gets sent: your Ethereum addresses (to look up balances and transactions) What gets sent: your Ethereum addresses (to look up balances and transactions)
and the hash of each transaction you open. and the hash of each transaction you open.
**CoinDesk CADLI price API** (`data-api.coindesk.com`)
Used to fetch current USD prices for ETH and the top 25 tokens. Prices are
cached for 5 minutes. No API key is required. This endpoint is not
user-configurable, and it is not contacted at all while you are on a testnet,
where no USD values are shown.
When it is contacted: while the popup is open, at most once every 5 minutes.
What gets sent: token symbol names (e.g. "ETH", "USDC"). No addresses, no
balances, no identifying information. As with any request, CoinDesk sees your IP
address.
**Etherscan address labels** (`etherscan.io`; `sepolia.etherscan.io` on Sepolia) **Etherscan address labels** (`etherscan.io`; `sepolia.etherscan.io` on Sepolia)
Off until you turn on "Check recipients on Etherscan". When you review a send, While "Check recipients on Etherscan" is on, AutistMask fetches the recipient's
AutistMask fetches the recipient's public Etherscan address page and looks for a public Etherscan address page when you review a send. AutistMask looks for a
"Fake_Phishing"/"Phish/Hack" label or a scam warning, and shows a red warning if "Fake_Phishing"/"Phish/Hack" label or a scam warning, and shows a red warning if
it finds one. This is a plain page fetch with no API key, made by your browser. it finds one. This is a plain page fetch with no API key, made by your browser.
It is best-effort: if it fails, it is silently ignored. This endpoint is not It is best-effort: if it fails, it is silently ignored. This endpoint is not
user-configurable. While it is off, the confirmation screen says that no user-configurable.
Etherscan check was made.
The setting is off in a new install. While it is off, the confirmation screen
says that no Etherscan check was made.
When it is contacted: only while "Check recipients on Etherscan" is on, each When it is contacted: only while "Check recipients on Etherscan" is on, each
time you reach the send confirmation screen. time you reach the send confirmation screen.
What gets sent: the recipient address you are about to send to, and your IP What gets sent: the recipient's address and nothing else. As with any request,
address. Your own addresses are not sent. Etherscan sees your IP address.
Etherscan links shown elsewhere in the UI (on addresses, transactions, and token Etherscan links shown elsewhere in the UI (on addresses, transactions, and token
contracts) are ordinary links. They contact nothing until you click them. contracts) are ordinary links. They contact nothing until you click them.
@@ -193,15 +201,18 @@ password.
3. Click "Load Temporary Add-on". 3. Click "Load Temporary Add-on".
4. Select `dist/firefox/manifest.json`. 4. Select `dist/firefox/manifest.json`.
AutistMask does not work in Firefox private windows. If Firefox is set to "Never
remember history", every window is private, so AutistMask does not work at all.
## Getting Started ## Getting Started
### Creating a New Wallet ### Creating a New Wallet
1. Click the AutistMask icon in your browser toolbar. 1. Click the AutistMask icon in your browser toolbar.
2. Click "Add wallet" (on first use), or open Settings and click "+ Add wallet". 2. Click "Add wallet" (on first use), or open Settings and click "+ Add wallet".
On first use the same screen offers "Use Blockscout" and "Check recipients on On first use, the screen with "Add wallet" also offers "Use Blockscout" and
Etherscan", both off; tick either if you want what it does (see External "Check recipients on Etherscan", both off. External Services above says what
Services). You can change both later in Settings. each one does. You can change both later in Settings.
3. On the "From Phrase" tab, click the die button to generate a random 12-word 3. On the "From Phrase" tab, click the die button to generate a random 12-word
recovery phrase. recovery phrase.
4. **Write down the recovery phrase and store it safely.** Anyone with these 4. **Write down the recovery phrase and store it safely.** Anyone with these
@@ -237,11 +248,14 @@ always produce the same sequence of addresses.
### Adding ERC-20 Tokens ### Adding ERC-20 Tokens
Tokens you hold show up automatically only while "Use Blockscout" is on, and The wallet looks for tokens you hold only while "Use Blockscout" is on. Even
then only if they are in the extension's bundled list of well-known tokens or then, a token shows up only if it is in the extension's bundled list of
have at least 1,000 holders; everything else is treated as spam and hidden. To well-known tokens or has at least 1,000 holders. Everything else is treated as
track a token explicitly (which also shows it at zero balance, and shows it spam and hidden.
whether or not "Use Blockscout" is on), add it by contract address:
The wallet shows every token you track, whether or not "Use Blockscout" is on.
By default a tracked token is shown at zero balance too (see Display in
Settings). To track a token, add it by contract address:
1. Go to an address detail view (click `[info]` on any address). 1. Go to an address detail view (click `[info]` on any address).
2. Click "+ Token". 2. Click "+ Token".
@@ -255,9 +269,12 @@ screen. Tokens can also be added from Settings, under "Tracked Tokens".
## Sending ## Sending
1. Click "Send" from the home screen or an address detail view. 1. Click "Send" from the home screen or an address detail view.
2. Select what to send (ETH, or any ERC-20 token with a balance on this address 2. Select what to send: ETH, or a token you track that this address holds. While
that survives the spam filters). "Use Blockscout" is on, Send also offers other tokens with a balance on this
3. Enter the recipient address or ENS name (e.g. `vitalik.eth`). address that survive the spam filters.
3. Enter the recipient address or ENS name (e.g. `vitalik.eth`). AutistMask does
not look up a name resolved off-chain. For such a name, enter the address
instead.
4. Enter the amount, or click "Max" to fill it in: a token's balance, cut to 18 4. Enter the amount, or click "Max" to fill it in: a token's balance, cut to 18
decimal places, or your ETH balance minus the amount reserved for the network decimal places, or your ETH balance minus the amount reserved for the network
fee. fee.
@@ -274,9 +291,13 @@ The confirmation screen shows:
estimate, and below it the larger amount reserved until it confirms. The estimate, and below it the larger amount reserved until it confirms. The
reserve is what the network requires up front and what the balance check gates reserve is what the network requires up front and what the balance check gates
on; the refund of the difference is why the two differ on; the refund of the difference is why the two differ
- **Warnings** if the recipient is a contract, a burn address, one of your own - **Warnings** if the recipient is:
addresses, on the bundled scam-address list, or labelled as a phisher on - a contract
Etherscan - a burn address
- one of your own addresses
- on the bundled scam-address list
- while "Check recipients on Etherscan" is on, labelled as a phisher on
Etherscan
After reviewing, enter your password and click "Sign & Send". The transaction After reviewing, enter your password and click "Sign & Send". The transaction
will be broadcast to the network and you will see a waiting screen with a timer. will be broadcast to the network and you will see a waiting screen with a timer.
@@ -287,8 +308,9 @@ screen with the transaction hash and an Etherscan link.
You can also send from a token-specific view: on the address detail screen, You can also send from a token-specific view: on the address detail screen,
click any token balance row. This opens a focused view showing only that token's click any token balance row. This opens a focused view showing only that token's
transactions. Clicking "Send" from here pre-selects and locks the token so you transactions. While "Use Blockscout" is off, the view says instead that no
cannot accidentally switch to a different one. transaction history is shown. Clicking "Send" from here pre-selects and locks
the token so you cannot accidentally switch to a different one.
## Receiving ## Receiving
@@ -324,6 +346,13 @@ enter your password and click "Confirm" to authorize it. Message and typed-data
signature requests work the same way, with a "Sign" button, and also require signature requests work the same way, with a "Sign" button, and also require
your password. your password.
If a transaction or signature popup closes before you answer, for example when
you click away to copy your password, the request stays open. Closing the popup
does not turn the request down. Click the AutistMask icon in your browser
toolbar to bring the request back. Until you answer, the icon opens the request
instead of your wallet. If several requests are waiting this way, the oldest
comes first.
A connected site can also ask to switch the wallet's network. A popup shows the A connected site can also ask to switch the wallet's network. A popup shows the
site's origin, the current network and the requested network. Nothing changes site's origin, the current network and the requested network. Nothing changes
unless you click "Switch"; clicking "Reject" or closing the popup leaves unless you click "Switch"; clicking "Reject" or closing the popup leaves
@@ -362,11 +391,12 @@ balances unless they are on the bundled known-token list or you added them
yourself. Legitimate tokens have substantial holder counts; scam tokens deployed yourself. Legitimate tokens have substantial holder counts; scam tokens deployed
for address poisoning typically have zero. When the explorer reports no holder for address poisoning typically have zero. When the explorer reports no holder
count for a token, or reports something other than a whole number in plain count for a token, or reports something other than a whole number in plain
digits (such as "1,000"), the count is unknown. An unknown count does not hide a digits (such as "1,000"), the count is unknown. While "Use Blockscout" is off,
token from your transaction history or the send token list, and it does not get no holder count is known. An unknown count does not hide a token from your
a token into your balances either: such a token is listed only if it is on the transaction history or the send token list, and it does not get a token into
bundled known-token list or you added it yourself. The screen you reach by your balances either: such a token is listed only if it is on the bundled
clicking a token balance shows a "Holders:" line only when the count is known. known-token list or you added it yourself. The screen you reach by clicking a
token balance shows a "Holders:" line only when the count is known.
**Fraud contract blocklist.** When AutistMask detects a fraudulent transfer, it **Fraud contract blocklist.** When AutistMask detects a fraudulent transfer, it
adds the contract address to a local blocklist. Future transactions from that adds the contract address to a local blocklist. Future transactions from that
@@ -398,6 +428,8 @@ see everything unfiltered.
Click the gear icon on the home screen to access settings: Click the gear icon on the home screen to access settings:
- **Wallets**: Your wallets, and "+ Add wallet". - **Wallets**: Your wallets, and "+ Add wallet".
- **Passwords**: Tick "Allow weak passwords" to choose a password shorter than
12 characters when you add a wallet.
- **Tracked Tokens**: The ERC-20 tokens tracked across all addresses, and "+ Add - **Tracked Tokens**: The ERC-20 tokens tracked across all addresses, and "+ Add
token". token".
- **Display**: Toggle whether tracked tokens with zero balance are shown, switch - **Display**: Toggle whether tracked tokens with zero balance are shown, switch
@@ -407,9 +439,8 @@ Click the gear icon on the home screen to access settings:
that network's defaults if you have not used it before. that network's defaults if you have not used it before.
- **Ethereum RPC**: Change the Ethereum node endpoint. Default is a public RPC. - **Ethereum RPC**: Change the Ethereum node endpoint. Default is a public RPC.
You can use your own node for maximum privacy. You can use your own node for maximum privacy.
- **Blockscout API**: "Use Blockscout", off until you tick it, and the - **Blockscout API**: the "Use Blockscout" checkbox, off until you tick it, and
Blockscout instance used for transaction history, the tokens you have not the URL of the Blockscout instance. You can use a self-hosted instance.
tracked and transaction details. You can use a self-hosted instance.
- **Etherscan**: "Check recipients on Etherscan", off until you tick it. - **Etherscan**: "Check recipients on Etherscan", off until you tick it.
- **Token Spam Protection**: Toggle individual scam filters and set the dust - **Token Spam Protection**: Toggle individual scam filters and set the dust
transaction threshold. transaction threshold.
+1
View File
@@ -4,6 +4,7 @@
"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>"],
"incognito": "not_allowed",
"content_security_policy": "default-src 'self'; script-src 'self' 'wasm-unsafe-eval'; object-src 'self'; style-src 'self'; img-src 'self' data:; connect-src 'self' https: http:; frame-src 'none'; form-action 'none'; base-uri 'none'", "content_security_policy": "default-src 'self'; script-src 'self' 'wasm-unsafe-eval'; object-src 'self'; style-src 'self'; img-src 'self' data:; connect-src 'self' https: http:; frame-src 'none'; form-action 'none'; base-uri 'none'",
"icons": { "icons": {
"16": "icons/icon16.png", "16": "icons/icon16.png",
+85 -69
View File
@@ -17,7 +17,11 @@ const { applyChainSwitchFields } = require("../shared/chainSwitchFields");
// the same prohibition reported early, not the guarantee. // the same prohibition reported early, not the guarantee.
const { getState, updateState } = require("./state"); const { getState, updateState } = require("./state");
const { StateUnusableError } = require("../shared/stateSchema"); const { StateUnusableError } = require("../shared/stateSchema");
const { refreshBalances, getProvider } = require("../shared/balances"); const {
refreshBalances,
dropUntrackedTokens,
getProvider,
} = require("../shared/balances");
const { debugFetch, log } = require("../shared/log"); const { debugFetch, log } = require("../shared/log");
const { const {
verifySignedTx, verifySignedTx,
@@ -157,9 +161,9 @@ let txApprovalSlot = null;
const APPROVAL_PENDING_CODE = -32002; const APPROVAL_PENDING_CODE = -32002;
// True at every moment this can be sent: the slot is taken immediately before // True at every moment this can be sent: the slot is taken immediately before
// the transaction is populated, so the other request is either being prepared // the transaction is populated, so the other request is being prepared, is on
// or on screen. It does not claim the other one is displayed yet, because for // screen, or waits with its window closed. It does not claim the other one is
// the length of one network round trip it is not. // displayed yet, because for the length of one network round trip it is not.
const TX_APPROVAL_PENDING_MESSAGE = const TX_APPROVAL_PENDING_MESSAGE =
"AutistMask handles one transaction at a time, and another one is" + "AutistMask handles one transaction at a time, and another one is" +
" already in progress, so this one was not sent. Please finish that" + " already in progress, so this one was not sent. Please finish that" +
@@ -379,14 +383,26 @@ async function proxyRpc(method, params) {
return json.result; return json.result;
} }
// The site-connection approval the toolbar popup is set to open, or null while // The approval the toolbar popup is set to open, or null while it opens the
// it opens the wallet. Set only by resetPopupUrl() and showInToolbarPopup(). // wallet. Set only by updateToolbarPopup() and showInToolbarPopup().
let toolbarPopupApprovalId = null; let toolbarPopupApprovalId = null;
function resetPopupUrl() { // Point the toolbar popup at the oldest pending approval whose window closed,
toolbarPopupApprovalId = null; // or at the wallet when there is none. The user can then answer that approval
// from the toolbar popup. pendingApprovals lists approvals in the order they
// were added, so the first one found is the oldest. An approval held by a
// running attempt is skipped until that attempt ends.
function updateToolbarPopup() {
const closed = Object.values(pendingApprovals).find(
(approval) => approval.windowClosed && !approval.attemptInFlight,
);
toolbarPopupApprovalId = closed ? closed.id : null;
if (actionNs && typeof actionNs.setPopup === "function") { if (actionNs && typeof actionNs.setPopup === "function") {
actionNs.setPopup({ popup: "src/popup/index.html" }); actionNs.setPopup({
popup: closed
? "src/popup/index.html?approval=" + closed.id
: "src/popup/index.html",
});
} }
} }
@@ -416,15 +432,16 @@ function settleApproval(id, result, options) {
// approval stops being alive. // approval stops being alive.
releaseTxApprovalSlotFor(id); releaseTxApprovalSlotFor(id);
approval.resolve(result); approval.resolve(result);
resetPopupUrl(); updateToolbarPopup();
return true; return true;
} }
// What a pending approval resolves to when it is given up on rather than // What a pending approval resolves to when it is given up on rather than
// answered: the window was closed, or could not be opened at all. A tx or sign // answered: a site-connection or network-switch window was closed, or the
// approval answers the requesting page in EIP-1193 shape; a site-connection or // window could not be opened at all. An address switch in the wallet gives up
// network-switch approval answers its handler in the shape the popup's // pending approvals too. A tx or sign approval answers the requesting page in
// decision has, as a refusal. // EIP-1193 shape; a site-connection or network-switch approval answers its
// handler in the shape the popup's decision has, as a refusal.
function abandonedResult(approval, code, message) { function abandonedResult(approval, code, message) {
if (approval.type === "tx" || approval.type === "sign") { if (approval.type === "tx" || approval.type === "sign") {
return { error: { code, message } }; return { error: { code, message } };
@@ -432,8 +449,9 @@ function abandonedResult(approval, code, message) {
return { approved: false, remember: false }; return { approved: false, remember: false };
} }
// A window the user closed without answering is a refusal by the user, which // A site-connection or network-switch window the user closed without answering
// is 4001 and the wording every other rejection path already uses. // is a refusal by the user, which is 4001 and the wording every other rejection
// path already uses.
const APPROVAL_REJECTED_CODE = 4001; const APPROVAL_REJECTED_CODE = 4001;
const APPROVAL_REJECTED_MESSAGE = "User rejected the request."; const APPROVAL_REJECTED_MESSAGE = "User rejected the request.";
@@ -461,31 +479,16 @@ const APPROVAL_WINDOW_FAILED_MESSAGE =
function claimApproval(approval) { function claimApproval(approval) {
if (approval.attemptInFlight) return false; if (approval.attemptInFlight) return false;
approval.attemptInFlight = true; approval.attemptInFlight = true;
updateToolbarPopup();
return true; return true;
} }
// Release an approval whose attempt failed in a way the user can retry. // Release an approval whose attempt failed in a way the user can retry.
// Nothing was broadcast, so the next attempt may claim it. // Nothing was broadcast, so the next attempt may claim it. If the user closed
// // its window while the attempt ran, the toolbar popup opens it for that retry.
// Unless the window it would be retried in is already gone. The user closed it
// while the attempt was running and settleApproval() declined then, correctly,
// because the attempt still owned the approval; the attempt has now failed, so
// nothing owns it and nothing can reach it. Left standing it would hold the
// requesting page's promise open forever and, with it, the transaction
// approval slot. It is settled here as the rejection the closed window
// already meant.
function releaseApproval(approval) { function releaseApproval(approval) {
approval.attemptInFlight = false; approval.attemptInFlight = false;
if (approval.windowClosed) { updateToolbarPopup();
settleApproval(
approval.id,
abandonedResult(
approval,
APPROVAL_REJECTED_CODE,
APPROVAL_REJECTED_MESSAGE,
),
);
}
} }
// Open approval in a separate popup window, unless it is no longer pending. // Open approval in a separate popup window, unless it is no longer pending.
@@ -708,9 +711,7 @@ function isExtensionSender(sender) {
// had refused. // had refused.
// //
// TX and sign approvals do not decide here. They stay pending across a // TX and sign approvals do not decide here. They stay pending across a
// disconnect. When their window closes, the windows.onRemoved listener below // disconnect, and across their window closing, until the user answers them.
// rejects them, unless an approved attempt is still running, in which case
// that attempt answers the page.
runtime.onConnect.addListener((port) => { runtime.onConnect.addListener((port) => {
if (port.name.startsWith("approval:")) { if (port.name.startsWith("approval:")) {
const id = port.name.split(":")[1]; const id = port.name.split(":")[1];
@@ -738,9 +739,7 @@ runtime.onConnect.addListener((port) => {
const approval = pendingApprovals[id]; const approval = pendingApprovals[id];
if (approval) { if (approval) {
if (approval.type === "tx" || approval.type === "sign") { if (approval.type === "tx" || approval.type === "sign") {
// When its window closes, windows.onRemoved rejects it, // It stays pending until the user answers it.
// unless an approved attempt is still running, in which
// case that attempt answers the page.
return; return;
} }
settleApproval(id, { approved: false, remember: false }); settleApproval(id, { approved: false, remember: false });
@@ -1293,7 +1292,7 @@ async function broadcastAccountsChanged() {
windowsRemove(approval.windowId).catch(() => {}); windowsRemove(approval.windowId).catch(() => {});
} }
} }
resetPopupUrl(); updateToolbarPopup();
// An address switch ends every connection allowed without "Remember". This // An address switch ends every connection allowed without "Remember". This
// waits on storage, so it comes after the pending approvals above, which // waits on storage, so it comes after the pending approvals above, which
// are still rejected the moment the switch arrives. // are still rejected the moment the switch arrives.
@@ -1386,6 +1385,10 @@ const RECENT_BALANCE_REFRESH_MS = Math.floor(BALANCE_REFRESH_PERIOD_MS / 2);
// back over them (https://git.eeqj.de/sneak/AutistMask/issues/577). // back over them (https://git.eeqj.de/sneak/AutistMask/issues/577).
// lastBalanceRefresh is left as the switch set it, so the next tick refreshes // lastBalanceRefresh is left as the switch set it, so the next tick refreshes
// the new network. // the new network.
//
// Blockscout may have answered just before the user turned "Use Blockscout"
// off. So the save reads the stored setting again, and drops every token the
// user has not tracked if the setting is off.
async function backgroundRefresh() { async function backgroundRefresh() {
const s = await getState(); const s = await getState();
const now = Date.now(); const now = Date.now();
@@ -1397,7 +1400,6 @@ async function backgroundRefresh() {
wallets, wallets,
s.rpcUrl, s.rpcUrl,
s.blockscoutUrl, s.blockscoutUrl,
s.useBlockscout,
s.trackedTokens, s.trackedTokens,
s.networkId, s.networkId,
); );
@@ -1424,6 +1426,9 @@ async function backgroundRefresh() {
} }
} }
} }
if (!fresh.useBlockscout) {
dropUntrackedTokens(fresh.wallets, fresh.trackedTokens);
}
fresh.lastBalanceRefresh = now; fresh.lastBalanceRefresh = now;
}); });
} }
@@ -1479,36 +1484,44 @@ if (runtime.onStartup) {
} }
startBackgroundJobs(); startBackgroundJobs();
// When approval window is closed without a response, treat as rejection. // The toolbar popup keeps its URL when the worker stops. A worker that starts
// "Without a response" is the operative part: the popup stays open across the // holds no approvals, so the toolbar popup is pointed back at the wallet.
// verify and broadcast it is waiting on, so a user closing an apparently-hung updateToolbarPopup();
// window is an ordinary event with an attempt already in flight behind it.
// settleApproval() refuses those, which leaves the attempt to report its real // A transaction or signature approval stays pending when its window closes.
// outcome to the page — and the window is recorded as gone, so that an attempt // The browser can close that window when the user clicks away from it, for
// which then fails retryably settles instead of waiting in a window that no // example to copy the password from a password manager. The approval is marked
// longer exists. // as closed, so the toolbar popup can open it (see updateToolbarPopup()). An
// attempt already running when the window closes goes on and reports its
// outcome to the page.
// //
// A site-connection or network-switch approval whose popup connected its port // This listener rejects a site-connection or network-switch approval whose
// is not decided here. That popup approves and closes in the same breath, and // window closes before its popup connected its port. Once the port is
// this event races the decision on a channel of its own — the same race the // connected, the approval is left to the port. That popup approves and closes
// port exists to end. Its port disconnect says the same thing this event does, // in the same breath, and this event races the decision on a channel of its
// in an order that is defined, so the disconnect is left to say it. The window // own — the same race the port exists to end. Its port disconnect says the
// closing before any port connected is the one case with nothing else to speak // same thing this event does, in an order that is defined, so the disconnect is
// for it, and is rejected here so the dApp is not left waiting on a window that // left to say it. The window closing before any port connected is the one case
// is gone. // with nothing else to speak for it, and is rejected here so the dApp is not
// left waiting on a window that is gone.
if (windowsNs && windowsNs.onRemoved) { if (windowsNs && windowsNs.onRemoved) {
windowsNs.onRemoved.addListener((windowId) => { windowsNs.onRemoved.addListener((windowId) => {
for (const [id, approval] of Object.entries(pendingApprovals)) { for (const [id, approval] of Object.entries(pendingApprovals)) {
if (approval.windowId !== windowId) continue; if (approval.windowId !== windowId) continue;
const decidedOnPort = if (approval.type === "tx" || approval.type === "sign") {
approval.type !== "tx" && approval.type !== "sign"; approval.windowClosed = true;
if (decidedOnPort && approval.portConnected) continue; updateToolbarPopup();
const rejection = abandonedResult( continue;
approval, }
APPROVAL_REJECTED_CODE, if (approval.portConnected) continue;
APPROVAL_REJECTED_MESSAGE, settleApproval(
id,
abandonedResult(
approval,
APPROVAL_REJECTED_CODE,
APPROVAL_REJECTED_MESSAGE,
),
); );
if (!settleApproval(id, rejection)) approval.windowClosed = true;
} }
}); });
} }
@@ -1653,7 +1666,9 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
}); });
return false; return false;
} }
return true; // The popup waits for this answer before it closes its window.
sendResponse(null);
return false;
} }
// The popup signs; it reports back here when it could not. Keep the // The popup signs; it reports back here when it could not. Keep the
@@ -1853,7 +1868,8 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
}); });
return false; return false;
} }
return true; sendResponse(null);
return false;
} }
// The popup signs; it reports back here when it could not. Keep the // The popup signs; it reports back here when it could not. Keep the
+5 -7
View File
@@ -18,11 +18,10 @@
// updateState(fn) read fresh, apply fn to that fresh record, write it // updateState(fn) read fresh, apply fn to that fresh record, write it
// back — all holding the lock every write of the stored // back — all holding the lock every write of the stored
// record takes, so no other write lands in between, by // record takes, so no other write lands in between, by
// the background or by any page except a page in a // the background or by any page (README, "Stored state
// Firefox private window (README, "Stored state and its // and its version"). The read is one storage round trip
// version"). The read is one storage round trip ahead of // ahead of the write rather than a page lifetime ahead of
// the write rather than a page lifetime ahead of it // it (which is what made the popup's saveState() need a
// (which is what made the popup's saveState() need a
// per-field merge against a baseline at all). // per-field merge against a baseline at all).
// //
// A handler that must both read and write therefore does its network work // A handler that must both read and write therefore does its network work
@@ -73,8 +72,7 @@ async function updateStateOnce(mutate) {
// src/shared/browserApi.js) is held from the read to the write: two // src/shared/browserApi.js) is held from the read to the write: two
// background turns, or a turn and a page's save, never interleave // background turns, or a turn and a page's save, never interleave
// (https://git.eeqj.de/sneak/AutistMask/issues/641). Every page's save waits // (https://git.eeqj.de/sneak/AutistMask/issues/641). Every page's save waits
// while it is held, except a page in a Firefox private window, which Firefox // while it is held (README, "Stored state and its version").
// gives locks of its own (README, "Stored state and its version").
// //
// `mutate` must also not call updateState() itself, directly or through // `mutate` must also not call updateState() itself, directly or through
// anything it awaits: the inner turn waits for the lock the outer one holds, // anything it awaits: the inner turn waits for the lock the outer one holds,
+66 -27
View File
@@ -46,8 +46,8 @@
<div class="bg-well p-3 mx-1 mb-3"> <div class="bg-well p-3 mx-1 mb-3">
<p class="text-xs mb-2"> <p class="text-xs mb-2">
This wallet sends your data only to the Ethereum RPC This wallet sends your data only to the Ethereum RPC
endpoint, unless you turn on either of these, here or endpoint, unless you turn on one of these. You can
later in Settings. change them later in Settings.
</p> </p>
<label <label
class="text-xs flex items-center gap-1 cursor-pointer mb-1" class="text-xs flex items-center gap-1 cursor-pointer mb-1"
@@ -56,10 +56,10 @@
Use Blockscout Use Blockscout
</label> </label>
<p class="text-xs text-muted mb-2"> <p class="text-xs text-muted mb-2">
Sends your addresses, and the hash of each transaction Shows transaction history, transaction details and the
you open, to the Blockscout API, for transaction tokens you have not tracked. Sends your addresses, and
history, tokens you have not tracked, and transaction the hash of each transaction you open, to the Blockscout
details. API.
</p> </p>
<label <label
class="text-xs flex items-center gap-1 cursor-pointer mb-1" class="text-xs flex items-center gap-1 cursor-pointer mb-1"
@@ -71,8 +71,8 @@
Check recipients on Etherscan Check recipients on Etherscan
</label> </label>
<p class="text-xs text-muted"> <p class="text-xs text-muted">
Sends the address you are about to send to, to Sends each recipient's address to Etherscan to check it
Etherscan, to look for a phishing or scam label on it. for a phishing or scam label.
</p> </p>
</div> </div>
<button <button
@@ -569,12 +569,23 @@
</div> </div>
<div class="mb-2"> <div class="mb-2">
<label class="block mb-1">What to send</label> <label class="block mb-1">What to send</label>
<select <!-- The token dropdown and the line under it. Both are
id="send-token" hidden when AddressToken opens Send for its own token. -->
class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg" <div id="send-token-dropdown">
> <select
<option value="ETH">ETH</option> id="send-token"
</select> class="border border-border p-1 w-full font-mono text-sm bg-bg text-fg"
>
<option value="ETH">ETH</option>
</select>
<p
id="send-tokens-note"
class="text-xs text-muted hidden"
>
Only tracked tokens are listed, because "Use
Blockscout" is off in Settings.
</p>
</div>
<div id="send-token-static" class="text-sm hidden"></div> <div id="send-token-static" class="text-sm hidden"></div>
</div> </div>
<div class="mb-2"> <div class="mb-2">
@@ -800,6 +811,7 @@
<div class="mb-3"> <div class="mb-3">
<div class="text-xs text-muted mb-1">Amount</div> <div class="text-xs text-muted mb-1">Amount</div>
<div id="wait-tx-summary" class="font-bold"></div> <div id="wait-tx-summary" class="font-bold"></div>
<div id="wait-tx-token-note"></div>
</div> </div>
<div class="mb-3"> <div class="mb-3">
<div class="text-xs text-muted mb-1">To</div> <div class="text-xs text-muted mb-1">To</div>
@@ -846,6 +858,7 @@
<div class="mb-3"> <div class="mb-3">
<div class="text-xs text-muted mb-1">Amount</div> <div class="text-xs text-muted mb-1">Amount</div>
<div id="error-tx-summary" class="font-bold"></div> <div id="error-tx-summary" class="font-bold"></div>
<div id="error-tx-token-note"></div>
</div> </div>
<div class="mb-3"> <div class="mb-3">
<div class="text-xs text-muted mb-1">To</div> <div class="text-xs text-muted mb-1">To</div>
@@ -967,6 +980,23 @@
</button> </button>
</div> </div>
<div class="bg-well p-3 mx-1 mb-3">
<h3 class="font-bold mb-1">Passwords</h3>
<label
class="text-xs flex items-center gap-1 cursor-pointer mb-1"
>
<input
type="checkbox"
id="settings-allow-weak-passwords"
/>
Allow weak passwords
</label>
<p class="text-xs text-muted">
Lets you choose a password shorter than 12 characters
when you add a wallet.
</p>
</div>
<div class="bg-well p-3 mx-1 mb-3"> <div class="bg-well p-3 mx-1 mb-3">
<h3 class="font-bold mb-1">Tracked Tokens</h3> <h3 class="font-bold mb-1">Tracked Tokens</h3>
<p class="text-xs text-muted mb-2"> <p class="text-xs text-muted mb-2">
@@ -1059,13 +1089,14 @@
Use Blockscout Use Blockscout
</label> </label>
<p class="text-xs text-muted mb-2"> <p class="text-xs text-muted mb-2">
Sends your addresses, and the hash of each transaction Shows transaction history, transaction details and the
you open, to the Blockscout API below, for transaction tokens you have not tracked. Sends your addresses, and
history, tokens you have not tracked, and transaction the hash of each transaction you open, to the Blockscout
details. API below.
</p> </p>
<p class="text-xs text-muted mb-1"> <p class="text-xs text-muted mb-1">
Change this if you run your own Blockscout instance. Change the URL below if you run your own Blockscout
instance.
</p> </p>
<input <input
type="text" type="text"
@@ -1092,8 +1123,8 @@
Check recipients on Etherscan Check recipients on Etherscan
</label> </label>
<p class="text-xs text-muted"> <p class="text-xs text-muted">
Sends the address you are about to send to, to Sends each recipient's address to Etherscan to check it
Etherscan, to look for a phishing or scam label on it. for a phishing or scam label.
</p> </p>
</div> </div>
@@ -1369,6 +1400,13 @@
> >
&nbsp; &nbsp;
</div> </div>
<p
id="delete-address-tokens-note"
class="text-xs text-muted mb-2 hidden"
>
Only tracked tokens are listed, because "Use Blockscout" is
off in Settings.
</p>
<p class="text-xs text-muted mb-3"> <p class="text-xs text-muted mb-3">
A wallet always keeps at least one address. To remove the A wallet always keeps at least one address. To remove the
last one, delete the whole wallet from Settings instead. last one, delete the whole wallet from Settings instead.
@@ -1588,8 +1626,8 @@
id="tx-detail-blockscout-note" id="tx-detail-blockscout-note"
class="text-xs text-muted mx-1 mb-3 hidden" class="text-xs text-muted mx-1 mb-3 hidden"
> >
No block, decoded details, network details or raw data are This screen shows no block, decoded details, network details
shown, because "Use Blockscout" is off in Settings. or raw data, because "Use Blockscout" is off in Settings.
</p> </p>
<!-- ── Decoded details ── --> <!-- ── Decoded details ── -->
@@ -1956,10 +1994,11 @@
>Erasing the saved data deletes every wallet stored in >Erasing the saved data deletes every wallet stored in
this browser.</strong this browser.</strong
> >
Nothing on the blockchain changes and no money is moved, but Nothing on the blockchain changes and no money is moved. If
without the exported copy above, or the recovery phrase for you kept a copy of a wallet's recovery phrase, private key
each wallet written down, everything they hold is gone or extended private key, you can add that wallet again.
forever. Without that copy or the exported copy above, everything the
wallet holds is gone forever.
</p> </p>
<p class="text-xs mb-1"> <p class="text-xs mb-1">
To confirm, type To confirm, type
+58 -22
View File
@@ -11,7 +11,7 @@ const {
const { StateUnusableError } = require("../shared/stateSchema"); const { StateUnusableError } = require("../shared/stateSchema");
const { log, setRuntimeDebug } = require("../shared/log"); const { log, setRuntimeDebug } = require("../shared/log");
const { refreshPrices } = require("../shared/prices"); const { refreshPrices } = require("../shared/prices");
const { refreshBalances } = require("../shared/balances"); const { refreshBalances, dropUntrackedTokens } = require("../shared/balances");
const { clearPopupCaches } = require("../shared/chainSwitch"); const { clearPopupCaches } = require("../shared/chainSwitch");
const { const {
$, $,
@@ -71,30 +71,36 @@ let refreshInFlight = false;
// the recovery screen: there is no profile left to refresh. // the recovery screen: there is no profile left to refresh.
let refreshTimer = null; let refreshTimer = null;
// The refresh first takes the stored network, "Use Blockscout" and "Check
// recipients on Etherscan" (followStoredSettings() below). So the screens it
// draws reflect any change saved elsewhere.
//
// The refresh writes into a copy of the wallets. Inside the save, under the // The refresh writes into a copy of the wallets. Inside the save, under the
// lock, its results are copied onto the address records in `state` only if the // lock, its results are copied onto the address records in `state` only if the
// network it ran on is still the active one, on this page and in the stored // network it ran on is still the active one, on this page and in the stored
// record; the background's switch, after the user approves a site's request, // record; the background's switch, after the user approves a site's request,
// reaches this page only after the stored record (followNetworkSwitch() below). // reaches this page only after the stored record (followStoredSettings()).
// A switch while the refresh ran cleared every address's balances // A switch while the refresh ran cleared every address's balances
// (applyChainSwitchFields() in src/shared/chainSwitchFields.js), and the // (applyChainSwitchFields() in src/shared/chainSwitchFields.js), and the
// previous network's must not come back over them // previous network's must not come back over them
// (https://git.eeqj.de/sneak/AutistMask/issues/577). A dropped refresh is not // (https://git.eeqj.de/sneak/AutistMask/issues/577). A dropped refresh is not
// recorded as done. Results are copied by address, so an address added or // recorded as done. Results are copied by address, so an address added or
// removed meanwhile is left as it is. // removed meanwhile is left as it is. Blockscout may have answered before the
// user turned "Use Blockscout" off. So the save drops every token the user has
// not tracked if the stored setting is off by then.
async function doRefreshAndRender() { async function doRefreshAndRender() {
if (refreshInFlight) return; if (refreshInFlight) return;
refreshInFlight = true; refreshInFlight = true;
try { try {
await followStoredSettings();
const networkId = state.networkId; const networkId = state.networkId;
const wallets = structuredClone(state.wallets); const wallets = structuredClone(state.wallets);
await Promise.all([ await Promise.all([
refreshPrices(), refreshPrices(pageClosed.signal),
refreshBalances( refreshBalances(
wallets, wallets,
state.rpcUrl, state.rpcUrl,
state.blockscoutUrl, state.blockscoutUrl,
state.useBlockscout,
state.trackedTokens, state.trackedTokens,
networkId, networkId,
pageClosed.signal, pageClosed.signal,
@@ -118,6 +124,9 @@ async function doRefreshAndRender() {
} }
} }
} }
if (!stored.useBlockscout) {
dropUntrackedTokens(state.wallets, stored.trackedTokens);
}
state.lastBalanceRefresh = Date.now(); state.lastBalanceRefresh = Date.now();
return true; return true;
}); });
@@ -229,17 +238,36 @@ function fallbackView() {
// src/shared/chainSwitch.js), so a record naming a network other than this // src/shared/chainSwitch.js), so a record naming a network other than this
// page's always holds a switch saved elsewhere, and a switch the user picks // page's always holds a switch saved elsewhere, and a switch the user picks
// here while this waits for the lock is made after it. // here while this waits for the lock is made after it.
async function followNetworkSwitch() { //
let switched = false; // Another page may change "Use Blockscout" or "Check recipients on Etherscan".
// This page takes either change the same way and draws its screens again. This
// page's own changes to the two settings are made under the lock too
// (views/settings.js, views/welcome.js).
async function followStoredSettings() {
let changed = false;
// A failed save is reported by saveState() itself: see onSaveFailure(). // A failed save is reported by saveState() itself: see onSaveFailure().
await saveState((stored) => { await saveState((stored) => {
if (stored.networkId === state.networkId) return false; if (stored.networkId !== state.networkId) {
settings.cutViewStack(); settings.cutViewStack();
takeStoredNetwork(stored); takeStoredNetwork(stored);
clearPopupCaches(); clearPopupCaches();
switched = true; changed = true;
}
if (stored.useBlockscout !== state.useBlockscout) {
settings.setUseBlockscout(stored.useBlockscout);
changed = true;
}
if (
stored.checkRecipientsOnEtherscan !==
state.checkRecipientsOnEtherscan
) {
state.checkRecipientsOnEtherscan =
stored.checkRecipientsOnEtherscan;
changed = true;
}
if (!changed) return false;
}).catch(() => {}); }).catch(() => {});
if (switched) settings.showNewNetwork(); if (changed) settings.showNewSettings();
} }
// The background opens the approval window as wide as the page, but the // The background opens the approval window as wide as the page, but the
@@ -253,9 +281,9 @@ async function followNetworkSwitch() {
// zoom it reports, 170% among them, so once the page has its new width (its // zoom it reports, 170% among them, so once the page has its new width (its
// resize event) it is measured again, and the window widened again while the // resize event) it is measured again, and the window widened again while the
// page still falls short, three times at most. A window that cannot grow sends // page still falls short, three times at most. A window that cannot grow sends
// no resize event, and the page stops there. The connection prompt can also // no resize event, and the page stops there. An approval can also show in the
// show in the toolbar popup, whose window is the user's browser window; that // toolbar popup, whose window is the user's browser window; that one is left
// one is left alone. // alone.
async function widenApprovalWindow() { async function widenApprovalWindow() {
const page = document.documentElement; const page = document.documentElement;
if (page.scrollWidth <= page.clientWidth) return; if (page.scrollWidth <= page.clientWidth) return;
@@ -386,16 +414,24 @@ async function init() {
settingsAddToken.init(ctx); settingsAddToken.init(ctx);
deleteAddress.init(ctx); deleteAddress.init(ctx);
// Only a record naming a network other than this page's is followed: the // This page follows a record only when its network, "Use Blockscout" or
// one this page's own switch in Settings saves names the network it // "Check recipients on Etherscan" differs from this page's. A record
// already has, and a record naming none is no switch. // written by this page's own save matches this page. A record naming no
// network is no switch.
onStorageChanged((changes) => { onStorageChanged((changes) => {
const written = changes.autistmask && changes.autistmask.newValue; const written = changes.autistmask && changes.autistmask.newValue;
if (!written || !written.networkId) return; if (!written || !written.networkId) return;
if (written.networkId !== state.networkId) followNetworkSwitch(); if (
written.networkId !== state.networkId ||
written.useBlockscout !== state.useBlockscout ||
written.checkRecipientsOnEtherscan !==
state.checkRecipientsOnEtherscan
) {
followStoredSettings();
}
}); });
// A switch saved since loadState() above, before there was a listener. // A change saved since loadState() above, before there was a listener.
followNetworkSwitch(); followStoredSettings();
if (!state.hasWallet) { if (!state.hasWallet) {
welcome.show(); welcome.show();
+10 -7
View File
@@ -38,13 +38,16 @@ function markViewRendered(view) {
if (view) renderedViews.add(view); if (view) renderedViews.add(view);
} }
// Begin a fresh page-load scope. The popup gets one by being loaded, and // Begin a fresh page-load scope. The popup gets one by being loaded. It also
// asks for one after a network switch, because every screen then on the page // asks for one when every screen on the page is out of date:
// shows the previous network (showNewNetwork() in views/settings.js), and //
// after "Use Blockscout" or "Check recipients on Etherscan" changes in // - after a network switch, since those screens show the previous network
// Settings, because every screen then on the page was drawn under the old // (showNewSettings() in views/settings.js)
// setting; the unit tests, which simulate several page loads against one // - after "Use Blockscout" or "Check recipients on Etherscan" changes, here
// module instance, ask for one too. // or on another page, since those screens were drawn under the old setting
//
// The unit tests ask for one too. They simulate several page loads against one
// module instance.
function resetRenderedViews() { function resetRenderedViews() {
renderedViews.clear(); renderedViews.clear();
} }
+2 -1
View File
@@ -132,7 +132,8 @@ function validatePassword() {
showError("add-wallet-password-error", "Please choose a password."); showError("add-wallet-password-error", "Please choose a password.");
return null; return null;
} }
if (pw.length < 12) { // "Allow weak passwords" in Settings lifts the 12-character minimum.
if (!state.allowWeakPasswords && pw.length < 12) {
showError( showError(
"add-wallet-password-error", "add-wallet-password-error",
"Password must be at least 12 characters.", "Password must be at least 12 characters.",
+2 -3
View File
@@ -84,7 +84,7 @@ function show() {
ctx.showAddressToken(); ctx.showAddressToken();
}); });
}); });
// Tokens the user has not tracked are Blockscout's to report. // Only Blockscout reports the tokens the user has not tracked.
$("address-tokens-note").classList.toggle("hidden", !!state.useBlockscout); $("address-tokens-note").classList.toggle("hidden", !!state.useBlockscout);
renderSendTokenSelect(addr); renderSendTokenSelect(addr);
$("tx-list").innerHTML = $("tx-list").innerHTML =
@@ -102,7 +102,6 @@ async function loadTransactions(address) {
const rawTxs = await fetchRecentTransactions( const rawTxs = await fetchRecentTransactions(
address, address,
state.blockscoutUrl, state.blockscoutUrl,
state.useBlockscout,
currentNetwork().chainId, currentNetwork().chainId,
); );
const result = filterTransactions(rawTxs, { const result = filterTransactions(rawTxs, {
@@ -237,7 +236,7 @@ function init(_ctx) {
} }
$("send-to").value = ""; $("send-to").value = "";
$("send-amount").value = ""; $("send-amount").value = "";
$("send-token").classList.remove("hidden"); $("send-token-dropdown").classList.remove("hidden");
$("send-token-static").classList.add("hidden"); $("send-token-static").classList.add("hidden");
updateSendBalance(); updateSendBalance();
resetSendValidation(); resetSendValidation();
+2 -3
View File
@@ -69,7 +69,7 @@ function show() {
// null when the scale is unknown: no quantity to show, and none to // null when the scale is unknown: no quantity to show, and none to
// price. balanceLine() states that rather than printing 0.0000. // price. balanceLine() states that rather than printing 0.0000.
amount = tb ? unknownableAmount(tb.balance) : 0; amount = tb ? unknownableAmount(tb.balance) : 0;
price = getPrice(symbol); price = getPrice(tokenId);
} }
currentSymbol = symbol; currentSymbol = symbol;
@@ -174,7 +174,6 @@ async function loadTransactions(address, tokenId) {
const rawTxs = await fetchRecentTransactions( const rawTxs = await fetchRecentTransactions(
address, address,
state.blockscoutUrl, state.blockscoutUrl,
state.useBlockscout,
currentNetwork().chainId, currentNetwork().chainId,
); );
const result = filterTransactions(rawTxs, { const result = filterTransactions(rawTxs, {
@@ -330,7 +329,7 @@ function init(_ctx) {
$("send-token").value = tokenId; $("send-token").value = tokenId;
} }
// Hide dropdown, show static token display // Hide dropdown, show static token display
$("send-token").classList.add("hidden"); $("send-token-dropdown").classList.add("hidden");
let staticHtml = `<div class="font-bold">${escapeHtml(displaySymbol(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>`;
+29 -11
View File
@@ -11,6 +11,7 @@ const {
onViewLeave, onViewLeave,
formatFee, formatFee,
tokenLabel, tokenLabel,
blockscoutOffTokenNoteHtml,
tokenSourcesByChainId, tokenSourcesByChainId,
} = require("./helpers"); } = require("./helpers");
const { state, saveState, currentNetwork } = require("../../shared/state"); const { state, saveState, currentNetwork } = require("../../shared/state");
@@ -54,7 +55,7 @@ const {
} = require("../../shared/approvalVerify"); } = require("../../shared/approvalVerify");
const txStatus = require("./txStatus"); const txStatus = require("./txStatus");
const uniswap = require("../../shared/uniswap"); const uniswap = require("../../shared/uniswap");
const { notify, runtimeApi, sendMessage } = require("../../shared/browserApi"); const { runtimeApi, sendMessage } = require("../../shared/browserApi");
const erc20Iface = new Interface(ERC20_ABI); const erc20Iface = new Interface(ERC20_ABI);
@@ -401,6 +402,10 @@ function showTxApproval(details) {
if (d.address) { if (d.address) {
if (d.isToken) { if (d.isToken) {
detailsHtml += `<div class="font-bold">${escapeHtml(tokenLabel(d.address, approvedTx.chainId) || "Unknown token")}</div>`; detailsHtml += `<div class="font-bold">${escapeHtml(tokenLabel(d.address, approvedTx.chainId) || "Unknown token")}</div>`;
detailsHtml += blockscoutOffTokenNoteHtml(
d.address,
approvedTx.chainId,
);
} }
detailsHtml += approvalAddressHtml( detailsHtml += approvalAddressHtml(
d.address, d.address,
@@ -623,10 +628,7 @@ function permitWarningHtml(types, primaryType, domain, message) {
return ""; return "";
} }
const sources = { const sources = tokenSourcesByChainId();
trackedTokens: state.trackedTokens,
wallets: state.wallets,
};
const spender = addressOrNull( const spender = addressOrNull(
declaredField(types, primaryType, message, "spender")?.value, declaredField(types, primaryType, message, "spender")?.value,
); );
@@ -655,6 +657,7 @@ function permitWarningHtml(types, primaryType, domain, message) {
html += `<div class="mb-2"><div>Token</div>`; html += `<div class="mb-2"><div>Token</div>`;
if (token) { if (token) {
html += `<div>${escapeHtml(tokenLabel(token) || "Unknown token")}</div>`; html += `<div>${escapeHtml(tokenLabel(token) || "Unknown token")}</div>`;
html += blockscoutOffTokenNoteHtml(token);
html += approvalAddressHtml(token); html += approvalAddressHtml(token);
} else { } else {
html += `<div>Unknown</div>`; html += `<div>Unknown</div>`;
@@ -1139,12 +1142,21 @@ function init(_ctx) {
} }
}); });
$("btn-reject-tx").addEventListener("click", () => { // The window closes only once the background has the rejection. A message
notify({ // sent as the window closes can be lost, and a closed window does not
// reject the request. After Confirm, the background refuses a rejection
// while the transaction is being sent. The window then stays open and
// shows the background's message.
$("btn-reject-tx").addEventListener("click", async () => {
const response = await sendMessage({
type: "AUTISTMASK_TX_RESPONSE", type: "AUTISTMASK_TX_RESPONSE",
id: approvalId, id: approvalId,
approved: false, approved: false,
}); }).catch(() => null);
if (response && response.error) {
showError("approve-tx-error", response.error);
return;
}
window.close(); window.close();
}); });
@@ -1267,12 +1279,18 @@ function init(_ctx) {
if (outcome.retryable) setSignButtonBusy(false); if (outcome.retryable) setSignButtonBusy(false);
}); });
$("btn-reject-sign").addEventListener("click", () => { // As for the transaction's Reject above. After Sign, the background
notify({ // refuses a rejection while the signature is being checked.
$("btn-reject-sign").addEventListener("click", async () => {
const response = await sendMessage({
type: "AUTISTMASK_SIGN_RESPONSE", type: "AUTISTMASK_SIGN_RESPONSE",
id: approvalId, id: approvalId,
approved: false, approved: false,
}); }).catch(() => null);
if (response && response.error) {
showError("approve-sign-error", response.error);
return;
}
window.close(); window.close();
}); });
} }
+4 -5
View File
@@ -129,7 +129,7 @@ function renderAmount(txInfo) {
const rawSymbol = isErc20 const rawSymbol = isErc20
? txInfo.tokenSymbol || "?" ? txInfo.tokenSymbol || "?"
: nativeCurrencyByChainId(txInfo.chainId); : nativeCurrencyByChainId(txInfo.chainId);
const price = getPrice(isErc20 ? rawSymbol : "ETH", txInfo.chainId); const price = getPrice(txInfo.token, txInfo.chainId);
const amountUsd = price ? parseFloat(txInfo.amount) * price : null; const amountUsd = price ? parseFloat(txInfo.amount) * price : null;
$("confirm-amount").textContent = valueWithUsd( $("confirm-amount").textContent = valueWithUsd(
shownAmount(txInfo) + " " + displaySymbol(rawSymbol), shownAmount(txInfo) + " " + displaySymbol(rawSymbol),
@@ -157,7 +157,7 @@ function renderBalance(txInfo) {
$("confirm-balance").textContent = "unknown (" + symbol + ")"; $("confirm-balance").textContent = "unknown (" + symbol + ")";
return; return;
} }
const price = getPrice(isErc20 ? rawSymbol : "ETH", txInfo.chainId); const price = getPrice(txInfo.token, txInfo.chainId);
const balUsd = price ? parseFloat(bal) * price : null; const balUsd = price ? parseFloat(bal) * price : null;
$("confirm-balance").textContent = valueWithUsd( $("confirm-balance").textContent = valueWithUsd(
truncateAmountNeverZero(bal) + " " + symbol, truncateAmountNeverZero(bal) + " " + symbol,
@@ -334,8 +334,8 @@ function show(txInfo) {
$("confirm-contract-warning").style.visibility = "hidden"; $("confirm-contract-warning").style.visibility = "hidden";
$("confirm-burn-warning").style.visibility = "hidden"; $("confirm-burn-warning").style.visibility = "hidden";
$("confirm-etherscan-warning").style.visibility = "hidden"; $("confirm-etherscan-warning").style.visibility = "hidden";
// While "Check recipients on Etherscan" is off there is no Etherscan // While "Check recipients on Etherscan" is off, there is no Etherscan
// warning to reserve space for, and a line in its place says so. // warning to reserve space for. A line in its place says the check is off.
const etherscanOn = !!state.checkRecipientsOnEtherscan; const etherscanOn = !!state.checkRecipientsOnEtherscan;
$("confirm-etherscan-warning").classList.toggle("hidden", !etherscanOn); $("confirm-etherscan-warning").classList.toggle("hidden", !etherscanOn);
$("confirm-etherscan-note").classList.toggle("hidden", etherscanOn); $("confirm-etherscan-note").classList.toggle("hidden", etherscanOn);
@@ -617,7 +617,6 @@ async function checkRecipientHistory(txInfo) {
const asyncWarnings = await getFullWarnings(txInfo.to, provider, { const asyncWarnings = await getFullWarnings(txInfo.to, provider, {
fromAddress: txInfo.from, fromAddress: txInfo.from,
chainId: txInfo.chainId, chainId: txInfo.chainId,
checkRecipientsOnEtherscan: state.checkRecipientsOnEtherscan,
}); });
// The user may have left this transaction while the checks were in // The user may have left this transaction while the checks were in
// flight; its warnings must not reach another recipient's screen. // flight; its warnings must not reach another recipient's screen.
+5
View File
@@ -119,6 +119,11 @@ function show(walletIdx, addrIdx) {
$("delete-address-recovery").textContent = recoveryPathText(wallet); $("delete-address-recovery").textContent = recoveryPathText(wallet);
$("delete-address-balance").innerHTML = balanceWarningHtml(addr); $("delete-address-balance").innerHTML = balanceWarningHtml(addr);
// Only Blockscout reports the tokens the user has not tracked.
$("delete-address-tokens-note").classList.toggle(
"hidden",
!!state.useBlockscout,
);
setFlash(""); setFlash("");
showView("delete-address-confirm"); showView("delete-address-confirm");
+50 -11
View File
@@ -21,7 +21,10 @@ const {
truncateAmountNeverZero, truncateAmountNeverZero,
isBelowOneMillionth, isBelowOneMillionth,
} = require("../../shared/amountDisplay"); } = require("../../shared/amountDisplay");
const { resolveTokenSymbol } = require("../../shared/approvalAmount"); const {
resolveTokenDecimals,
resolveTokenSymbol,
} = require("../../shared/approvalAmount");
const { getProvider } = require("../../shared/balances"); const { getProvider } = require("../../shared/balances");
const { DEBUG } = require("../../shared/constants"); const { DEBUG } = require("../../shared/constants");
const { escapeHtml } = require("../../shared/html"); const { escapeHtml } = require("../../shared/html");
@@ -306,10 +309,16 @@ function nativeCurrency() {
// names a token on one network only, and every token balance held is the // names a token on one network only, and every token balance held is the
// active network's, so another network gets the tokens tracked on it // active network's, so another network gets the tokens tracked on it
// (state.networkTrackedTokens, see applyChainSwitchFields()) and no balances. // (state.networkTrackedTokens, see applyChainSwitchFields()) and no balances.
//
// The wallets' balances hold what Blockscout reported for each token. So the
// wallets are returned only while "Use Blockscout" is on.
function tokenSourcesByChainId(chainId) { function tokenSourcesByChainId(chainId) {
const net = chainId ? networkByChainId(chainId) : currentNetwork(); const net = chainId ? networkByChainId(chainId) : currentNetwork();
if (net && net.id === state.networkId) { if (net && net.id === state.networkId) {
return { trackedTokens: state.trackedTokens, wallets: state.wallets }; return {
trackedTokens: state.trackedTokens,
wallets: state.useBlockscout ? state.wallets : [],
};
} }
return { return {
trackedTokens: (net && state.networkTrackedTokens[net.id]) || [], trackedTokens: (net && state.networkTrackedTokens[net.id]) || [],
@@ -317,11 +326,39 @@ function tokenSourcesByChainId(chainId) {
}; };
} }
// The symbol shown for a token line on the network with `chainId`, or on the // The line shown under a token while "Use Blockscout" is off. The token gets
// active network when none is given: from the bundled list, the tokens the // the line only when the bundled list and the tracked tokens lack its name or
// user tracks, and the explorer's report, the sources the amount line's scale // decimals. Otherwise this returns "". The token is a contract address on the
// comes from. Null when no source names one, so the token lines keep saying // network with `chainId`, or on the active network when none is given. "ETH"
// `Unknown token` for a token nothing knows. // and null are no contract, and get "". A token that is not text also gets "":
// WaitTx and ErrorTx pass a token restored from storage unchecked.
function blockscoutOffTokenNoteHtml(token, chainId) {
if (typeof token !== "string") return "";
if (state.useBlockscout || !token || token === "ETH") return "";
const sources = tokenSourcesByChainId(chainId);
if (
resolveTokenSymbol(token, sources) !== null &&
resolveTokenDecimals(token, sources) !== null
) {
return "";
}
return (
'<div class="text-xs text-muted">Blockscout\'s report of your balances' +
' is not used to name this token, because "Use Blockscout" is off in' +
" Settings.</div>"
);
}
// The symbol shown for a token line, from these sources in order:
//
// - the bundled list
// - the tokens the user tracks
// - the explorer's report, while "Use Blockscout" is on
//
// The network is the one with `chainId`, or the active network when none is
// given. The amount line's scale comes from the same sources. Null when no
// source names one, so the token lines keep saying `Unknown token` for a token
// nothing knows.
function tokenLabel(address, chainId) { function tokenLabel(address, chainId) {
return resolveTokenSymbol(address, tokenSourcesByChainId(chainId)); return resolveTokenSymbol(address, tokenSourcesByChainId(chainId));
} }
@@ -402,7 +439,7 @@ function balanceLinesForAddress(addr, trackedTokens, showZero) {
html += balanceLine( html += balanceLine(
t.symbol, t.symbol,
bal, bal,
getPrice(t.symbol), getPrice(t.address),
t.address.toLowerCase(), t.address.toLowerCase(),
); );
seen.add(t.address.toLowerCase()); seen.add(t.address.toLowerCase());
@@ -413,7 +450,7 @@ function balanceLinesForAddress(addr, trackedTokens, showZero) {
html += balanceLine( html += balanceLine(
t.symbol, t.symbol,
0, 0,
getPrice(t.symbol), getPrice(t.address),
t.address.toLowerCase(), t.address.toLowerCase(),
); );
} }
@@ -534,8 +571,9 @@ function addressTitle(address, wallets) {
const CONTRACT_CREATION_TEXT = const CONTRACT_CREATION_TEXT =
"This transaction creates a new contract. It has no recipient."; "This transaction creates a new contract. It has no recipient.";
// What the transaction lists on Home, AddressDetail and AddressToken say while // The line shown in place of the transaction history on Home, AddressDetail and
// the user has "Use Blockscout" off: the history comes from Blockscout alone. // AddressToken while "Use Blockscout" is off. That history comes from
// Blockscout alone.
const HISTORY_OFF_TEXT = const HISTORY_OFF_TEXT =
'No transaction history is shown, because "Use Blockscout" is off in Settings.'; 'No transaction history is shown, because "Use Blockscout" is off in Settings.';
@@ -796,6 +834,7 @@ module.exports = {
unknownableAmount, unknownableAmount,
nativeCurrency, nativeCurrency,
tokenSourcesByChainId, tokenSourcesByChainId,
blockscoutOffTokenNoteHtml,
tokenLabel, tokenLabel,
formatFee, formatFee,
addressDotHtml, addressDotHtml,
+2 -3
View File
@@ -197,7 +197,6 @@ async function loadHomeTxs(ctx) {
fetchRecentTransactions( fetchRecentTransactions(
addr, addr,
state.blockscoutUrl, state.blockscoutUrl,
state.useBlockscout,
currentNetwork().chainId, currentNetwork().chainId,
), ),
); );
@@ -306,7 +305,7 @@ function walletListHtml() {
function render(ctx) { function render(ctx) {
const container = $("wallet-list"); const container = $("wallet-list");
// Tokens the user has not tracked are Blockscout's to report. // Only Blockscout reports the tokens the user has not tracked.
$("home-tokens-note").classList.toggle("hidden", !!state.useBlockscout); $("home-tokens-note").classList.toggle("hidden", !!state.useBlockscout);
if (state.wallets.length === 0) { if (state.wallets.length === 0) {
container.innerHTML = container.innerHTML =
@@ -455,7 +454,7 @@ function init(ctx) {
} }
$("send-to").value = ""; $("send-to").value = "";
$("send-amount").value = ""; $("send-amount").value = "";
$("send-token").classList.remove("hidden"); $("send-token-dropdown").classList.remove("hidden");
$("send-token-static").classList.add("hidden"); $("send-token-static").classList.add("hidden");
renderSendTokenSelect(addr); renderSendTokenSelect(addr);
updateSendBalance(); updateSendBalance();
+12 -7
View File
@@ -10,6 +10,7 @@ const {
renderAddressHtml, renderAddressHtml,
attachCopyHandlers, attachCopyHandlers,
goBack, goBack,
tokenSourcesByChainId,
} = require("./helpers"); } = require("./helpers");
const { state, currentAddress } = require("../../shared/state"); const { state, currentAddress } = require("../../shared/state");
let ctx; let ctx;
@@ -141,6 +142,8 @@ function updateToValidation() {
} }
function renderSendTokenSelect(addr) { function renderSendTokenSelect(addr) {
// Only Blockscout reports the tokens the user has not tracked.
$("send-tokens-note").classList.toggle("hidden", !!state.useBlockscout);
const sel = $("send-token"); const sel = $("send-token");
sel.innerHTML = `<option value="ETH">${escapeHtml(nativeCurrency())}</option>`; sel.innerHTML = `<option value="ETH">${escapeHtml(nativeCurrency())}</option>`;
const fraudSet = new Set( const fraudSet = new Set(
@@ -185,7 +188,9 @@ function renderSendTokenSelect(addr) {
// so the transfer is encoded with the number the user read rather than with // so the transfer is encoded with the number the user read rather than with
// whatever the contract answers at signing time (see // whatever the contract answers at signing time (see
// src/shared/transferAmount.js). balances.js is formatting one explorer row at // src/shared/transferAmount.js). balances.js is formatting one explorer row at
// fetch time and cannot consult a state it is in the middle of replacing. // fetch time and cannot consult a state it is in the middle of replacing. As on
// the approval screens, tokenSourcesByChainId() gives the wallets only while
// "Use Blockscout" is on.
// //
// The two resolutions can therefore differ, and where they do, the stored // 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 // `balance` is a quantity computed at a scale this screen has just declined to
@@ -198,10 +203,7 @@ function tokenBalanceAndDecimals(addr, token) {
const tb = (addr.tokenBalances || []).find( const tb = (addr.tokenBalances || []).find(
(t) => t.address.toLowerCase() === token.toLowerCase(), (t) => t.address.toLowerCase() === token.toLowerCase(),
); );
const tokenDecimals = resolveTokenDecimals(token, { const tokenDecimals = resolveTokenDecimals(token, tokenSourcesByChainId());
trackedTokens: state.trackedTokens,
wallets: state.wallets,
});
if (!tb) return { tokenBalance: "0", tokenDecimals }; if (!tb) return { tokenBalance: "0", tokenDecimals };
if (tokenDecimals === null) return { tokenBalance: null, tokenDecimals }; if (tokenDecimals === null) return { tokenBalance: null, tokenDecimals };
return { tokenBalance: tb.balance ?? null, tokenDecimals }; return { tokenBalance: tb.balance ?? null, tokenDecimals };
@@ -401,8 +403,11 @@ function init(_ctx) {
try { try {
const provider = getProvider(state.rpcUrl, state.networkId); const provider = getProvider(state.rpcUrl, state.networkId);
const resolved = await provider.resolveName(to); const resolved = await provider.resolveName(to);
// getProvider() does not look up a name resolved off-chain,
// so such a name comes back with no address too. The message
// covers both, in the one line the flash area shows.
if (!resolved) { if (!resolved) {
showFlash("That ENS name has no address."); showFlash("That ENS name has no on-chain address.");
return; return;
} }
resolvedTo = resolved; resolvedTo = resolved;
@@ -426,7 +431,7 @@ function init(_ctx) {
}); });
$("btn-send-back").addEventListener("click", () => { $("btn-send-back").addEventListener("click", () => {
$("send-token").classList.remove("hidden"); $("send-token-dropdown").classList.remove("hidden");
$("send-token-static").classList.add("hidden"); $("send-token-static").classList.add("hidden");
goBack(); goBack();
}); });
+96 -32
View File
@@ -17,6 +17,7 @@ const {
const { state, saveState, currentNetwork } = require("../../shared/state"); const { state, saveState, currentNetwork } = require("../../shared/state");
const { onChainSwitch } = require("../../shared/chainSwitch"); const { onChainSwitch } = require("../../shared/chainSwitch");
const { restorableStack } = require("../../shared/persistedState"); const { restorableStack } = require("../../shared/persistedState");
const { dropUntrackedTokens } = require("../../shared/balances");
const { resetRenderedViews, markViewRendered } = require("../viewRouter"); const { resetRenderedViews, markViewRendered } = require("../viewRouter");
const { const {
log, log,
@@ -43,6 +44,12 @@ let ctx;
let versionClickCount = 0; let versionClickCount = 0;
let versionClickTimer = null; let versionClickTimer = null;
// The network that Settings was last drawn for. A follow of a switch saved
// elsewhere sets `state` to the new network first. Settings is drawn again only
// once the follow's write returns. So both "Save" buttons take this network,
// not the one in `state`.
let shownNetwork = null;
// One row per site origin, however many addresses it appears under, each with // One row per site origin, however many addresses it appears under, each with
// an [x] that hands it to onRemove. // an [x] that hands it to onRemove.
function renderSiteList(containerId, origins, onRemove) { function renderSiteList(containerId, origins, onRemove) {
@@ -198,6 +205,7 @@ function renderWalletListSettings() {
} }
function show() { function show() {
shownNetwork = currentNetwork();
$("settings-rpc").value = state.rpcUrl; $("settings-rpc").value = state.rpcUrl;
$("settings-blockscout").value = state.blockscoutUrl; $("settings-blockscout").value = state.blockscoutUrl;
$("settings-network").value = state.networkId; $("settings-network").value = state.networkId;
@@ -251,16 +259,20 @@ async function renderSiteLists() {
// A network switch, made by the user here or saved by the background once the // A network switch, made by the user here or saved by the background once the
// user approved a site's request (src/popup/index.js), leaves every screen on // user approved a site's request (src/popup/index.js), leaves every screen on
// the page showing the previous network. These two leave the page as README's // the page showing the previous network. Two functions leave the page as
// Screen Map describes, the first before the switch is saved, so that save // README's Screen Map describes:
// keeps the cut for a popup closed straight after, the second once `state` //
// holds the new network. // - cutViewStack(), before the switch is saved, so that save keeps the cut for
// a popup closed straight after
// - showNewSettings(), once `state` holds the new network
// //
// The stack is cut at the first screen that cannot be rendered from saved // The stack is cut at the first screen that cannot be rendered from saved
// state, such as Send or AddToken, and at AddressToken unless it shows the // state, such as Send or AddToken, and at AddressToken unless it shows the
// native token: any other token there was picked on the previous network, so // native token: any other token there was picked on the previous network, so
// it is no longer selected either. Without a wallet the stack starts at // it is no longer selected either. Without a wallet the stack starts at
// Welcome, which that cut would drop, and Welcome shows nothing from a network. // Welcome, which that cut would drop, and Welcome shows nothing from a network.
// A change to "Use Blockscout" cuts the stack the same way (setUseBlockscout()
// below).
function cutViewStack() { function cutViewStack() {
if (!state.hasWallet) return; if (!state.hasWallet) return;
if (state.selectedToken !== "ETH") { if (state.selectedToken !== "ETH") {
@@ -273,18 +285,41 @@ function cutViewStack() {
state.viewStack = restorableStack(state.viewStack, state.currentView); state.viewStack = restorableStack(state.viewStack, state.currentView);
} }
// Every screen counts as not yet rendered, so "Back" renders the one it lands // Sets "Use Blockscout" to `on` on this page. It is called inside a save,
// on for the new network. Settings on top is brought up to date in place; // holding the lock, for the user's change here or another page's
// any other screen is drawn again as a reopened popup draws it, which is Home // (followStoredSettings() in src/popup/index.js).
// for one that cannot be rendered from saved state. Without a wallet any other //
// screen is Welcome or AddWallet, which show nothing from a network. // Send's token dropdown was filled under the old setting, and Back cannot draw
function showNewNetwork() { // Send again. So the stack is cut, as for a network switch. Turning the setting
// off also drops every token the user has not tracked.
function setUseBlockscout(on) {
state.useBlockscout = on;
cutViewStack();
if (!on) dropUntrackedTokens(state.wallets, state.trackedTokens);
}
// Draws the page again after a network switch, or after another page changed
// "Use Blockscout" or "Check recipients on Etherscan". Every screen counts as
// not yet rendered, so "Back" renders again any screen that a reopened popup
// can render. Settings on top is brought up to date in place. Any other screen
// is drawn again as a reopened popup draws it, which is Home for one that
// cannot be rendered from saved state. Without a wallet any other screen is
// Welcome or AddWallet. Back only unhides Welcome, so its two checkboxes are
// set here.
function showNewSettings() {
resetRenderedViews(); resetRenderedViews();
$("welcome-use-blockscout").checked = state.useBlockscout;
$("welcome-check-recipients-on-etherscan").checked =
state.checkRecipientsOnEtherscan;
if (state.currentView === "settings") { if (state.currentView === "settings") {
markViewRendered("settings"); markViewRendered("settings");
shownNetwork = currentNetwork();
$("settings-network").value = state.networkId; $("settings-network").value = state.networkId;
$("settings-rpc").value = state.rpcUrl; $("settings-rpc").value = state.rpcUrl;
$("settings-blockscout").value = state.blockscoutUrl; $("settings-blockscout").value = state.blockscoutUrl;
$("settings-use-blockscout").checked = state.useBlockscout;
$("settings-check-recipients-on-etherscan").checked =
state.checkRecipientsOnEtherscan;
renderTrackedTokens(); renderTrackedTokens();
} else if (state.hasWallet) { } else if (state.hasWallet) {
ctx.restoreView(); ctx.restoreView();
@@ -292,6 +327,28 @@ function showNewNetwork() {
updateDebugBanner(state.currentView); updateDebugBanner(state.currentView);
} }
// Saves `url` as `field` ("rpcUrl" or "blockscoutUrl") of the network
// `networkId`, the one that Settings showed when the user tapped "Save". The
// URL is set in `state` inside the save, holding the lock. So the page cannot
// follow a switch saved elsewhere (followStoredSettings() in
// src/popup/index.js) between setting the URL and writing it. If the active
// network is no longer `networkId`, on this page or in the stored record,
// nothing is saved. The flash message then says that the network changed.
async function saveEndpoint(field, url, networkId) {
let refused = false;
await saveState((stored) => {
refused =
state.networkId !== networkId || stored.networkId !== networkId;
if (refused) return false;
state[field] = url;
});
if (refused) {
showFlash("The URL was not saved because the network changed.");
} else {
showFlash("Saved.");
}
}
function init(_ctx) { function init(_ctx) {
ctx = _ctx; ctx = _ctx;
deleteWallet.init(ctx); deleteWallet.init(ctx);
@@ -303,6 +360,8 @@ function init(_ctx) {
showFlash("Please enter an RPC URL."); showFlash("Please enter an RPC URL.");
return; return;
} }
// The URL is for the network that Settings shows when "Save" is tapped.
const net = shownNetwork;
showFlash("Testing endpoint..."); showFlash("Testing endpoint...");
try { try {
const resp = await debugFetch(url, { const resp = await debugFetch(url, {
@@ -321,7 +380,6 @@ function init(_ctx) {
showFlash("Endpoint returned an error."); showFlash("Endpoint returned an error.");
return; return;
} }
const net = currentNetwork();
if (json.result !== net.chainId) { if (json.result !== net.chainId) {
showFlash("Wrong network: expected " + net.name + "."); showFlash("Wrong network: expected " + net.name + ".");
return; return;
@@ -337,9 +395,7 @@ function init(_ctx) {
showFlash("Could not reach endpoint."); showFlash("Could not reach endpoint.");
return; return;
} }
state.rpcUrl = url; await saveEndpoint("rpcUrl", url, net.id);
await saveState();
showFlash("Saved.");
}); });
$("btn-save-blockscout").addEventListener("click", async () => { $("btn-save-blockscout").addEventListener("click", async () => {
@@ -348,6 +404,7 @@ function init(_ctx) {
showFlash("Please enter a Blockscout API URL."); showFlash("Please enter a Blockscout API URL.");
return; return;
} }
const net = shownNetwork;
showFlash("Testing endpoint..."); showFlash("Testing endpoint...");
try { try {
const resp = await debugFetch(url + "/stats"); const resp = await debugFetch(url + "/stats");
@@ -362,35 +419,35 @@ function init(_ctx) {
showFlash("Could not reach endpoint."); showFlash("Could not reach endpoint.");
return; return;
} }
state.blockscoutUrl = url; await saveEndpoint("blockscoutUrl", url, net.id);
await saveState();
showFlash("Saved.");
}); });
// The screens under Settings were drawn under the old setting, so each // Each change is made inside the save, holding the lock. So
// followStoredSettings() in src/popup/index.js never mistakes this page's
// unsaved change for one that another page saved.
//
// The screens under Settings were drawn under the old setting. So each
// change makes every screen but Settings count as not yet drawn, as a // change makes every screen but Settings count as not yet drawn, as a
// network switch does, and Back draws the one it lands on again. Welcome // network switch does. Back then draws again any screen that a reopened
// offers the same two settings and is only unhidden on Back, so its boxes // popup can draw. Back only unhides Welcome, so its boxes are set here too.
// are set here too.
$("settings-use-blockscout").addEventListener("change", async () => { $("settings-use-blockscout").addEventListener("change", async () => {
state.useBlockscout = $("settings-use-blockscout").checked; const on = $("settings-use-blockscout").checked;
$("welcome-use-blockscout").checked = state.useBlockscout; await saveState(() => setUseBlockscout(on));
$("welcome-use-blockscout").checked = on;
resetRenderedViews(); resetRenderedViews();
markViewRendered("settings"); markViewRendered("settings");
await saveState();
}); });
$("settings-check-recipients-on-etherscan").addEventListener( $("settings-check-recipients-on-etherscan").addEventListener(
"change", "change",
async () => { async () => {
state.checkRecipientsOnEtherscan = $( const on = $("settings-check-recipients-on-etherscan").checked;
"settings-check-recipients-on-etherscan", await saveState(() => {
).checked; state.checkRecipientsOnEtherscan = on;
$("welcome-check-recipients-on-etherscan").checked = });
state.checkRecipientsOnEtherscan; $("welcome-check-recipients-on-etherscan").checked = on;
resetRenderedViews(); resetRenderedViews();
markViewRendered("settings"); markViewRendered("settings");
await saveState();
}, },
); );
@@ -407,7 +464,7 @@ function init(_ctx) {
// Open pages are told by the background, as after a site's approved // Open pages are told by the background, as after a site's approved
// switch request. // switch request.
notify({ type: "AUTISTMASK_NETWORK_CHANGED", chainId: net.chainId }); notify({ type: "AUTISTMASK_NETWORK_CHANGED", chainId: net.chainId });
showNewNetwork(); showNewSettings();
showFlash("Switched to " + net.name + "."); showFlash("Switched to " + net.name + ".");
}); });
@@ -470,6 +527,12 @@ function init(_ctx) {
await saveState(); await saveState();
}); });
$("settings-allow-weak-passwords").checked = state.allowWeakPasswords;
$("settings-allow-weak-passwords").addEventListener("change", async () => {
state.allowWeakPasswords = $("settings-allow-weak-passwords").checked;
await saveState();
});
$("btn-main-add-wallet").addEventListener("click", ctx.showAddWalletView); $("btn-main-add-wallet").addEventListener("click", ctx.showAddWalletView);
$("btn-settings-add-token").addEventListener( $("btn-settings-add-token").addEventListener(
@@ -547,5 +610,6 @@ module.exports = {
show, show,
renderSiteLists, renderSiteLists,
cutViewStack, cutViewStack,
showNewNetwork, setUseBlockscout,
showNewSettings,
}; };
-2
View File
@@ -143,8 +143,6 @@ async function resetProfile() {
try { try {
// Under the lock every write of the stored record takes, so the erase // Under the lock every write of the stored record takes, so the erase
// cannot land between another write's read and its write and be undone. // cannot land between another write's read and its write and be undone.
// A page in a Firefox private window is the exception: Firefox gives
// it locks of its own (README, "Stored state and its version").
await withLock("autistmask", () => storageRemove("autistmask")); await withLock("autistmask", () => storageRemove("autistmask"));
} catch (e) { } catch (e) {
log.errorf("state recovery: reset failed:", e); log.errorf("state recovery: reset failed:", e);
+11 -6
View File
@@ -26,6 +26,7 @@ const { state } = require("../../shared/state");
const { nativeCurrencyByChainId } = require("../../shared/networks"); const { nativeCurrencyByChainId } = require("../../shared/networks");
const { formatEther, formatUnits } = require("ethers"); const { formatEther, formatUnits } = require("ethers");
const { log, debugFetch } = require("../../shared/log"); const { log, debugFetch } = require("../../shared/log");
const { storedSettingIsOn } = require("../../shared/storedSettings");
const { decodeCalldata } = require("./approval"); const { decodeCalldata } = require("./approval");
/** /**
@@ -172,7 +173,8 @@ function render() {
} }
} }
// Hide calldata and raw data sections; always fetch full tx details // Hide the calldata and raw data sections. loadFullTxDetails() shows them
// once it has their data.
const calldataSection = $("tx-detail-calldata-section"); const calldataSection = $("tx-detail-calldata-section");
if (calldataSection) calldataSection.classList.add("hidden"); if (calldataSection) calldataSection.classList.add("hidden");
const rawDataSection = $("tx-detail-rawdata-section"); const rawDataSection = $("tx-detail-rawdata-section");
@@ -191,7 +193,8 @@ function render() {
if (el) el.classList.add("hidden"); if (el) el.classList.add("hidden");
} }
// Those details are Blockscout's; this line says why there are none. // The block, network details, decoded details and raw data come from
// Blockscout. While the setting is off, this line says why none is shown.
$("tx-detail-blockscout-note").classList.toggle( $("tx-detail-blockscout-note").classList.toggle(
"hidden", "hidden",
!!state.useBlockscout, !!state.useBlockscout,
@@ -308,11 +311,12 @@ function populateOnChainDetails(txData, chainId) {
} }
} }
// The block, network details, calldata and its decoding, from Blockscout. While // Reads the block, network details and calldata from Blockscout, and decodes
// the user has "Use Blockscout" off, Blockscout is not asked and none of them // the calldata. While the stored "Use Blockscout" is off, Blockscout is not
// is shown. // asked. An answer that lands after the setting went off is dropped
// (src/shared/storedSettings.js). Either way none of them is shown.
async function loadFullTxDetails(txHash, chainId) { async function loadFullTxDetails(txHash, chainId) {
if (!state.useBlockscout) return; if (!(await storedSettingIsOn("useBlockscout"))) return;
const section = $("tx-detail-calldata-section"); const section = $("tx-detail-calldata-section");
const actionEl = $("tx-detail-calldata-action"); const actionEl = $("tx-detail-calldata-action");
const detailsEl = $("tx-detail-calldata-details"); const detailsEl = $("tx-detail-calldata-details");
@@ -328,6 +332,7 @@ async function loadFullTxDetails(txHash, chainId) {
); );
if (!resp.ok) return; if (!resp.ok) return;
const txData = await resp.json(); const txData = await resp.json();
if (!(await storedSettingIsOn("useBlockscout"))) return;
// Populate on-chain detail fields (block, nonce, gas, fee) // Populate on-chain detail fields (block, nonce, gas, fee)
populateOnChainDetails(txData, chainId); populateOnChainDetails(txData, chainId);
+15 -3
View File
@@ -14,6 +14,7 @@ const {
displaySymbol, displaySymbol,
clearViewStack, clearViewStack,
tokenLabel, tokenLabel,
blockscoutOffTokenNoteHtml,
reviewedNetworkProvider, reviewedNetworkProvider,
} = require("./helpers"); } = require("./helpers");
const { state } = require("../../shared/state"); const { state } = require("../../shared/state");
@@ -108,6 +109,10 @@ function startWait(txInfo, txHash, broadcastTime, pollNow) {
} }
$("wait-tx-summary").textContent = $("wait-tx-summary").textContent =
txInfo.amount + (symbol ? " " + symbol : ""); txInfo.amount + (symbol ? " " + symbol : "");
$("wait-tx-token-note").innerHTML = blockscoutOffTokenNoteHtml(
txInfo.token,
txInfo.chainId,
);
$("wait-tx-to").innerHTML = toAddressHtml(txInfo.to, txInfo.chainId); $("wait-tx-to").innerHTML = toAddressHtml(txInfo.to, txInfo.chainId);
$("wait-tx-hash").innerHTML = txHashHtml(txHash, txInfo.chainId); $("wait-tx-hash").innerHTML = txHashHtml(txHash, txInfo.chainId);
attachCopyHandlers("view-wait-tx"); attachCopyHandlers("view-wait-tx");
@@ -215,9 +220,10 @@ function showWait(txInfo, txHash) {
// init and leaving wait-tx on screen with no back control. A non-numeric // init and leaving wait-tx on screen with no back control. A non-numeric
// broadcastTime leaves an unexitable wait counting "NaNs". txInfo.chainId picks // broadcastTime leaves an unexitable wait counting "NaNs". txInfo.chainId picks
// the node the receipt is asked of and the explorer the links open, so it has // the node the receipt is asked of and the explorer the links open, so it has
// to name a network. txInfo.token and txInfo.tokenSymbol are deliberately // to name a network. txInfo.token and txInfo.tokenSymbol are not checked here.
// unchecked: they are compared and coalesced rather than dereferenced, and // blockscoutOffTokenNoteHtml() shows no line for a token that is not text.
// tokenSymbol is null for ETH. // Everything else only compares and coalesces them, and tokenSymbol is null for
// ETH.
function restoreWait() { function restoreWait() {
const d = state.viewData; const d = state.viewData;
if (!d || !d.pendingWait) return false; if (!d || !d.pendingWait) return false;
@@ -282,6 +288,7 @@ function decodedDetailsHtml(decoded, chainId) {
if (d.isToken) { if (d.isToken) {
const sym = tokenLabel(d.address, chainId) || "Unknown token"; const sym = tokenLabel(d.address, chainId) || "Unknown token";
html += `<div class="font-bold">${escapeHtml(sym)}</div>`; html += `<div class="font-bold">${escapeHtml(sym)}</div>`;
html += blockscoutOffTokenNoteHtml(d.address, chainId);
html += toAddressHtml(d.address, chainId); html += toAddressHtml(d.address, chainId);
} else { } else {
html += toAddressHtml(d.address, chainId); html += toAddressHtml(d.address, chainId);
@@ -345,6 +352,7 @@ function showError(txInfo, txHash, message) {
state.viewData = { state.viewData = {
amount: txInfo.amount, amount: txInfo.amount,
symbol: symbol, symbol: symbol,
token: txInfo.token,
to: txInfo.to, to: txInfo.to,
hash: txHash || null, hash: txHash || null,
message: message, message: message,
@@ -358,6 +366,10 @@ function renderError() {
if (!d || !d.message) return; if (!d || !d.message) return;
$("error-tx-summary").textContent = $("error-tx-summary").textContent =
d.amount + (d.symbol ? " " + d.symbol : ""); d.amount + (d.symbol ? " " + d.symbol : "");
$("error-tx-token-note").innerHTML = blockscoutOffTokenNoteHtml(
d.token,
d.chainId,
);
$("error-tx-to").innerHTML = toAddressHtml(d.to, d.chainId); $("error-tx-to").innerHTML = toAddressHtml(d.to, d.chainId);
$("error-tx-message").textContent = d.message; $("error-tx-message").textContent = d.message;
+12 -9
View File
@@ -1,6 +1,6 @@
// The first screen, shown while there is no wallet. It offers the two lookups // The first screen, shown while there is no wallet. It offers "Use Blockscout"
// at services other than the RPC endpoint, both off until the user ticks them, // and "Check recipients on Etherscan", which Settings offers too. Both are off
// which Settings offers as well. // until the user ticks them.
const { $, showView } = require("./helpers"); const { $, showView } = require("./helpers");
const { state, saveState } = require("../../shared/state"); const { state, saveState } = require("../../shared/state");
@@ -12,21 +12,24 @@ function show() {
showView("welcome"); showView("welcome");
} }
// Each change is made inside the save, holding the lock, as Settings makes it.
function init(ctx) { function init(ctx) {
$("btn-welcome-add").addEventListener("click", ctx.showAddWalletView); $("btn-welcome-add").addEventListener("click", ctx.showAddWalletView);
$("welcome-use-blockscout").addEventListener("change", async () => { $("welcome-use-blockscout").addEventListener("change", async () => {
state.useBlockscout = $("welcome-use-blockscout").checked; const on = $("welcome-use-blockscout").checked;
await saveState(); await saveState(() => {
state.useBlockscout = on;
});
}); });
$("welcome-check-recipients-on-etherscan").addEventListener( $("welcome-check-recipients-on-etherscan").addEventListener(
"change", "change",
async () => { async () => {
state.checkRecipientsOnEtherscan = $( const on = $("welcome-check-recipients-on-etherscan").checked;
"welcome-check-recipients-on-etherscan", await saveState(() => {
).checked; state.checkRecipientsOnEtherscan = on;
await saveState(); });
}, },
); );
} }
-3
View File
@@ -60,8 +60,6 @@ function getLocalWarnings(address, options = {}) {
* @param {string} [options.fromAddress] - Sender address (for self-send check). * @param {string} [options.fromAddress] - Sender address (for self-send check).
* @param {string} [options.chainId] - Chain id of the network whose explorer * @param {string} [options.chainId] - Chain id of the network whose explorer
* the Etherscan label check asks; the active network's when omitted. * the Etherscan label check asks; the active network's when omitted.
* @param {boolean} [options.checkRecipientsOnEtherscan] - The user's setting
* of that name. The Etherscan label check is made only while it is on.
* @returns {Promise<Array<{type: string, message: string, severity: string}>>} * @returns {Promise<Array<{type: string, message: string, severity: string}>>}
*/ */
async function getFullWarnings(address, provider, options = {}) { async function getFullWarnings(address, provider, options = {}) {
@@ -116,7 +114,6 @@ async function getFullWarnings(address, provider, options = {}) {
try { try {
const etherscanWarning = await checkEtherscanLabel( const etherscanWarning = await checkEtherscanLabel(
address, address,
options.checkRecipientsOnEtherscan,
options.chainId, options.chainId,
); );
if (etherscanWarning) { if (etherscanWarning) {
+41 -23
View File
@@ -1,7 +1,10 @@
// Balance fetching: ETH balances and the balances of the tokens the user // Balance fetching:
// tracks via RPC, the other ERC-20 token balances and the holder counts via //
// Blockscout while the user has "Use Blockscout" on, ENS reverse lookup via // - ETH balances, and the balances of the tokens the user tracks, via RPC
// RPC. // - the other ERC-20 token balances and the holder counts via Blockscout,
// while the user has "Use Blockscout" on. Those balances are dropped when
// the setting is off.
// - ENS reverse lookup via RPC
const { const {
JsonRpcProvider, JsonRpcProvider,
@@ -19,6 +22,7 @@ const { LOW_HOLDER_THRESHOLD, parseHoldersCount } = require("./holders");
const { isSpoofedSymbol } = require("./symbolSpoof"); const { isSpoofedSymbol } = require("./symbolSpoof");
const { toDecimals } = require("./transferAmount"); const { toDecimals } = require("./transferAmount");
const { resolveTokenDecimals } = require("./approvalAmount"); const { resolveTokenDecimals } = require("./approvalAmount");
const { storedSettingIsOn } = require("./storedSettings");
// 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).
@@ -39,12 +43,12 @@ const { resolveTokenDecimals } = require("./approvalAmount");
// is a caller bug and must not resolve to a working provider for some other // is a caller bug and must not resolve to a working provider for some other
// chain. // chain.
// //
// `disableCcipRead` keeps every ENS lookup on the RPC endpoint. Left on, as // `disableCcipRead` keeps every ENS lookup on the RPC endpoint. A resolver can
// ethers has it, a resolver that says a name is resolved off-chain makes ethers // say a name is resolved off-chain and give a web address for it. By default
// fetch the web address the resolver gives, straight from the browser, with the // ethers then fetches that address straight from the browser, sending the name
// name being looked up; for the reverse lookup of the user's addresses that is // being looked up. For the reverse lookup of the user's addresses, the name sent
// the user's own name (https://git.eeqj.de/sneak/AutistMask/issues/668). Such a // is the user's own (https://git.eeqj.de/sneak/AutistMask/issues/668). With the
// name does not resolve. // flag set, such a name does not resolve.
function getProvider(rpcUrl, networkId) { function getProvider(rpcUrl, networkId) {
const net = Network.from(requireNetworkId(networkId).id); const net = Network.from(requireNetworkId(networkId).id);
const provider = new JsonRpcProvider(rpcUrl, net, { staticNetwork: net }); const provider = new JsonRpcProvider(rpcUrl, net, { staticNetwork: net });
@@ -92,9 +96,10 @@ function rawUnits(value) {
// Fetch token balances for a single address from Blockscout. // Fetch token balances for a single address from Blockscout.
// Returns [{ address, name, symbol, decimals, balance, holders }]. // Returns [{ address, name, symbol, decimals, balance, holders }].
// //
// `useBlockscout` is the user's "Use Blockscout" setting. While it is off, // While the stored "Use Blockscout" is off, Blockscout is not asked. An answer
// Blockscout is not asked and the answer is an empty list: no token the user // that lands after the setting went off is dropped
// has not tracked is listed. // (src/shared/storedSettings.js). Either way this returns an empty list, so
// only tracked tokens are listed.
// //
// 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. A tracked token's // explicitly tracked by the user, or have >= 1000 holders. A tracked token's
@@ -111,11 +116,10 @@ function rawUnits(value) {
async function fetchTokenBalances( async function fetchTokenBalances(
address, address,
blockscoutUrl, blockscoutUrl,
useBlockscout,
trackedTokens, trackedTokens,
signal, signal,
) { ) {
if (!useBlockscout) return []; if (!(await storedSettingIsOn("useBlockscout"))) return [];
try { try {
const resp = await debugFetch( const resp = await debugFetch(
blockscoutUrl + "/addresses/" + address + "/token-balances", blockscoutUrl + "/addresses/" + address + "/token-balances",
@@ -125,6 +129,7 @@ async function fetchTokenBalances(
return null; return null;
} }
const items = await resp.json(); const items = await resp.json();
if (!(await storedSettingIsOn("useBlockscout"))) return [];
if (!Array.isArray(items)) return null; if (!Array.isArray(items)) return null;
const trackedSet = new Set( const trackedSet = new Set(
@@ -313,13 +318,12 @@ async function fetchTrackedTokenBalances(
} }
// 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.
// `trackedTokens` are the tokens tracked on the active network. // `trackedTokens` are the tokens tracked on the active network. `signal` is as
// `useBlockscout` and `signal` are as for fetchTokenBalances(). // for fetchTokenBalances().
async function refreshBalances( async function refreshBalances(
wallets, wallets,
rpcUrl, rpcUrl,
blockscoutUrl, blockscoutUrl,
useBlockscout,
trackedTokens, trackedTokens,
networkId, networkId,
signal, signal,
@@ -380,15 +384,14 @@ async function refreshBalances(
// ERC-20 token balances: the tracked tokens' through the RPC // ERC-20 token balances: the tracked tokens' through the RPC
// endpoint, and from Blockscout the tokens the user has not // endpoint, and from Blockscout the tokens the user has not
// tracked. When Blockscout fails, the untracked rows from before // tracked. When Blockscout fails, the untracked rows from before
// this refresh stay; while "Use Blockscout" is off there are none. // this refresh stay. While "Use Blockscout" is off, there are no
// The Blockscout request is started first and handed to // untracked rows. The Blockscout request is started first and
// fetchTrackedTokenBalances() too, which waits for it after // handed to fetchTrackedTokenBalances() too, which waits for it
// sending its balanceOf reads, so the two run side by side. // after sending its balanceOf reads, so the two run side by side.
const previous = addr.tokenBalances || []; const previous = addr.tokenBalances || [];
const explorerRequest = fetchTokenBalances( const explorerRequest = fetchTokenBalances(
addr.address, addr.address,
blockscoutUrl, blockscoutUrl,
useBlockscout,
tracked, tracked,
signal, signal,
); );
@@ -424,6 +427,20 @@ async function refreshBalances(
log.debugf("refreshBalances done"); log.debugf("refreshBalances done");
} }
// Drops the balance of each token not in `trackedTokens` from every address.
// Callers run it while "Use Blockscout" is off, since only Blockscout reports
// those tokens.
function dropUntrackedTokens(wallets, trackedTokens) {
const tracked = new Set(trackedTokens.map((t) => t.address.toLowerCase()));
for (const wallet of wallets) {
for (const addr of wallet.addresses || []) {
addr.tokenBalances = (addr.tokenBalances || []).filter((row) =>
tracked.has(String(row.address).toLowerCase()),
);
}
}
}
// 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.
// `signal` is as for fetchTokenBalances(). // `signal` is as for fetchTokenBalances().
@@ -542,6 +559,7 @@ async function scanForAddresses(xpub, rpcUrl, networkId, signal, gapLimit = 5) {
module.exports = { module.exports = {
fetchTokenBalances, fetchTokenBalances,
refreshBalances, refreshBalances,
dropUntrackedTokens,
lookupTokenInfo, lookupTokenInfo,
getProvider, getProvider,
scanForAddresses, scanForAddresses,
+21 -3
View File
@@ -4,7 +4,7 @@
// //
// - onChainSwitch() below makes the switch the user picks in Settings, with // - onChainSwitch() below makes the switch the user picks in Settings, with
// applyChainSwitchFields() (chainSwitchFields.js). // applyChainSwitchFields() (chainSwitchFields.js).
// - followNetworkSwitch() in src/popup/index.js takes a switch the background // - followStoredSettings() in src/popup/index.js takes a switch the background
// or another popup page saved, from the stored record, with // or another popup page saved, from the stored record, with
// takeStoredNetwork() (state.js), which copies it with // takeStoredNetwork() (state.js), which copies it with
// copyChainSwitchFields() (chainSwitchFields.js). // copyChainSwitchFields() (chainSwitchFields.js).
@@ -45,14 +45,32 @@ function clearPopupCaches() {
// //
// `state` is switched inside the save that stores the switch, holding the // `state` is switched inside the save that stores the switch, holding the
// lock, so it is never switched while a follow of a switch saved elsewhere // lock, so it is never switched while a follow of a switch saved elsewhere
// waits for the lock (followNetworkSwitch() in src/popup/index.js): that // waits for the lock (followStoredSettings() in src/popup/index.js): that
// follow runs first, and this switch is made after it. // follow runs first, and this switch is made after it.
//
// The save writes only the fields that differ from what this page last saved.
// When this page last saved a balance of "0", clearing that balance is no
// change. So the switch also resets these fields in the stored record:
//
// - every address's balance and token balances;
// - the time of the last balance refresh.
//
// A balance that the background or another page stored since this page's last
// save is then not kept under the new network
// (https://git.eeqj.de/sneak/AutistMask/issues/653).
async function onChainSwitch(newNetworkId) { async function onChainSwitch(newNetworkId) {
const { state, saveState } = require("./state"); const { state, saveState } = require("./state");
let net = null; let net = null;
await saveState(() => { await saveState((stored) => {
if (state.networkId === newNetworkId) return false; if (state.networkId === newNetworkId) return false;
net = applyChainSwitchFields(state, newNetworkId); net = applyChainSwitchFields(state, newNetworkId);
stored.lastBalanceRefresh = 0;
for (const wallet of stored.wallets) {
for (const addr of wallet.addresses) {
addr.balance = "0";
addr.tokenBalances = [];
}
}
clearPopupCaches(); clearPopupCaches();
}); });
return net; return net;
+11 -9
View File
@@ -3,6 +3,7 @@
// This is a best-effort enrichment: network failures return null silently. // This is a best-effort enrichment: network failures return null silently.
const { networkByChainId } = require("./networks"); const { networkByChainId } = require("./networks");
const { storedSettingIsOn } = require("./storedSettings");
// Patterns in the page title that indicate a flagged address. // Patterns in the page title that indicate a flagged address.
// Title format: "Fake_Phishing184810 | Address: 0x... | Etherscan" // Title format: "Fake_Phishing184810 | Address: 0x... | Etherscan"
@@ -78,21 +79,19 @@ function parseEtherscanPage(html) {
* when it is omitted: etherscan.io on mainnet, sepolia.etherscan.io on * when it is omitted: etherscan.io on mainnet, sepolia.etherscan.io on
* Sepolia. * Sepolia.
* *
* While the user's "Check recipients on Etherscan" setting is off, Etherscan * While the stored "Check recipients on Etherscan" is off, Etherscan is not
* is not asked and the answer is null. * asked. An answer that lands after the setting went off is dropped
* (src/shared/storedSettings.js). Either way the answer is null.
* *
* @param {string} address - Ethereum address to check. * @param {string} address - Ethereum address to check.
* @param {boolean} checkRecipientsOnEtherscan - The user's setting.
* @param {string} [chainId] - Chain id of the network to look it up on. * @param {string} [chainId] - Chain id of the network to look it up on.
* @returns {Promise<{type: string, message: string, severity: string}|null>} * @returns {Promise<{type: string, message: string, severity: string}|null>}
*/ */
async function checkEtherscanLabel( async function checkEtherscanLabel(address, chainId) {
address,
checkRecipientsOnEtherscan,
chainId,
) {
if (!checkRecipientsOnEtherscan) return null;
try { try {
if (!(await storedSettingIsOn("checkRecipientsOnEtherscan"))) {
return null;
}
// Lazy require to avoid pulling in chrome.storage at module scope // Lazy require to avoid pulling in chrome.storage at module scope
// (which breaks unit tests that only exercise parseEtherscanPage). // (which breaks unit tests that only exercise parseEtherscanPage).
const { currentNetwork } = require("./state"); const { currentNetwork } = require("./state");
@@ -103,6 +102,9 @@ async function checkEtherscanLabel(
}); });
if (!resp.ok) return null; if (!resp.ok) return null;
const html = await resp.text(); const html = await resp.text();
if (!(await storedSettingIsOn("checkRecipientsOnEtherscan"))) {
return null;
}
const result = parseEtherscanPage(html); const result = parseEtherscanPage(html);
if (result.isPhishing) { if (result.isPhishing) {
return { return {
+16 -10
View File
@@ -48,12 +48,17 @@ const DEFAULT_STATE = {
hideDustTransactions: true, hideDustTransactions: true,
dustThresholdGwei: 100000, dustThresholdGwei: 100000,
utcTimestamps: false, utcTimestamps: false,
// "Use Blockscout" and "Check recipients on Etherscan" in Settings, one // "Use Blockscout" and "Check recipients on Etherscan" in Settings. Each
// setting each for every network. Both off until the user turns them on: // setting applies to every network. Both are off until the user turns them
// the requests they allow send the user's addresses to a service other // on. With "Use Blockscout" on, Blockscout is sent the user's addresses and
// than the RPC endpoint. // the hash of each transaction opened. With "Check recipients on
// Etherscan" on, Etherscan is sent the recipient's address and nothing
// else.
useBlockscout: false, useBlockscout: false,
checkRecipientsOnEtherscan: false, checkRecipientsOnEtherscan: false,
// "Allow weak passwords" in Settings. While it is off, AddWallet refuses a
// password shorter than 12 characters.
allowWeakPasswords: false,
fraudContracts: [], fraudContracts: [],
tokenHolderCache: {}, tokenHolderCache: {},
theme: "system", theme: "system",
@@ -412,12 +417,13 @@ function normalizePersisted(saved) {
: 100000; : 100000;
out.utcTimestamps = out.utcTimestamps =
saved.utcTimestamps !== undefined ? saved.utcTimestamps : false; saved.utcTimestamps !== undefined ? saved.utcTimestamps : false;
out.useBlockscout = // Anything but true is off: each setting lets a request reach another
saved.useBlockscout !== undefined ? saved.useBlockscout : false; // service.
out.checkRecipientsOnEtherscan = out.useBlockscout = saved.useBlockscout === true;
saved.checkRecipientsOnEtherscan !== undefined out.checkRecipientsOnEtherscan = saved.checkRecipientsOnEtherscan === true;
? saved.checkRecipientsOnEtherscan // Anything but true is off: the setting lets AddWallet accept a short
: false; // password.
out.allowWeakPasswords = saved.allowWeakPasswords === true;
// A list of contract addresses, floored the same way: send.js builds its // A list of contract addresses, floored the same way: send.js builds its
// fraud set as `(state.fraudContracts || []).map((a) => a.toLowerCase())` // fraud set as `(state.fraudContracts || []).map((a) => a.toLowerCase())`
// and filterTransactions() maps the same list through normalizeAddress(), // and filterTransactions() maps the same list through normalizeAddress(),
+97 -21
View File
@@ -1,31 +1,105 @@
// Price fetching with 5-minute cache, USD formatting, value aggregation. // USD prices, read from Chainlink price feeds on Ethereum mainnet, with USD
// formatting and value aggregation. The feeds are in src/shared/tokenList.js.
const { getTopTokenPrices } = require("./tokenList"); const { Contract } = require("ethers");
const { ETH_USD_FEED, PRICE_FEED_BY_ADDRESS } = require("./tokenList");
const { getProvider } = require("./balances");
const { isBelowOneMillionth } = require("./amountDisplay"); const { isBelowOneMillionth } = require("./amountDisplay");
const { networkByChainId } = require("./networks"); const { networkByChainId } = require("./networks");
const { log } = require("./log");
const PRICE_CACHE_TTL = 300000; // 5 minutes const PRICE_CACHE_TTL = 300000; // 5 minutes
// A reading older than its feed's heartbeat plus this many seconds is no price.
const STALE_MARGIN = 1800; // 30 minutes
const FEED_ABI = [
"function latestRoundData() view returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound)",
];
// USD prices: ether's under "ETH", each token's under its lowercased contract
// address.
const prices = {}; const prices = {};
let lastFetchedAt = 0; let lastFetchedAt = 0;
async function refreshPrices() { // Reads the price of ether and of each token any address holds or the user
// Testnet tokens have no real market value — skip price fetching // tracks, when that token has a feed. Mainnet only. The reads go to the RPC
// and clear any stale mainnet prices so the UI shows no USD values. // endpoint as one batched request, at most every 5 minutes. A failed read is
const { currentNetwork } = require("./state"); // logged, and that token then has no price.
if (currentNetwork().isTestnet) { //
// `signal`, passed by the popup, is aborted when the popup closes. A read that
// fails once `signal` is aborted is not logged, because closing the popup
// cancelled it.
async function refreshPrices(signal) {
const { state, currentNetwork } = require("./state");
if (currentNetwork().id !== "mainnet") {
clearPrices(); clearPrices();
return; return;
} }
const now = Date.now(); const now = Date.now();
if (now - lastFetchedAt < PRICE_CACHE_TTL) return; if (now - lastFetchedAt < PRICE_CACHE_TTL) return;
try { const feeds = new Map([["ETH", ETH_USD_FEED]]);
const fetched = await getTopTokenPrices(25); for (const address of heldOrTrackedTokens(state)) {
Object.assign(prices, fetched); const feed = PRICE_FEED_BY_ADDRESS.get(address);
lastFetchedAt = now; if (feed) feeds.set(address, feed);
} catch {
// prices stay stale on error
} }
// ethers sends calls made together on one provider as one batch.
const provider = getProvider(state.rpcUrl, state.networkId);
const read = {};
await Promise.all(
[...feeds].map(async ([key, feed]) => {
try {
const contract = new Contract(feed.address, FEED_ABI, provider);
const round = await contract.latestRoundData();
const price = priceFromRound(round, feed, now);
if (price === null) {
log.warnf(
"price feed reading is stale or not positive",
key,
);
return;
}
read[key] = price;
} catch (e) {
if (signal?.aborted) return;
log.errorf(
"price feed read failed",
key,
e.shortMessage || e.message,
);
}
}),
);
clearPrices();
Object.assign(prices, read);
lastFetchedAt = now;
}
// The lowercased contract address of each token that any address holds or
// that the user tracks.
function heldOrTrackedTokens(state) {
const addresses = new Set();
for (const wallet of state.wallets) {
for (const addr of wallet.addresses) {
for (const token of addr.tokenBalances || []) {
addresses.add(token.address.toLowerCase());
}
}
}
for (const token of state.trackedTokens || []) {
addresses.add(token.address.toLowerCase());
}
return addresses;
}
// The USD price in a feed's latestRoundData() result, or null when the answer
// is not positive or was written longer ago than the feed's heartbeat plus
// STALE_MARGIN. `now` is in milliseconds.
function priceFromRound(round, feed, now) {
const ageSeconds = now / 1000 - Number(round.updatedAt);
if (ageSeconds > feed.heartbeat + STALE_MARGIN) return null;
if (round.answer <= 0n) return null;
return Number(round.answer) / 10 ** feed.decimals;
} }
// Clear all cached prices and reset the fetch timestamp so the // Clear all cached prices and reset the fetch timestamp so the
@@ -37,14 +111,15 @@ function clearPrices() {
lastFetchedAt = 0; lastFetchedAt = 0;
} }
// Return the USD price for a symbol on the network with `chainId`, or on the // Return the USD price of the token at the contract address `token`, or of
// active network when no chain id is given; null on testnet, on a chain id // ether when `token` is "ETH". The price is for the network with `chainId`, or
// that names no network, or for a symbol with no price. // for the active network when no chain id is given. Returns null on testnet,
function getPrice(symbol, chainId) { // on a chain id that names no network, and for a token with no price.
function getPrice(token, chainId) {
const { currentNetwork } = require("./state"); const { currentNetwork } = require("./state");
const network = chainId ? networkByChainId(chainId) : currentNetwork(); const network = chainId ? networkByChainId(chainId) : currentNetwork();
if (!network || network.isTestnet) return null; if (!network || network.isTestnet) return null;
return prices[symbol] || null; return prices[token === "ETH" ? "ETH" : token.toLowerCase()] || null;
} }
function formatUsd(amount) { function formatUsd(amount) {
@@ -62,7 +137,7 @@ function formatUsd(amount) {
// What an address is worth, as { usd, partial }. // What an address is worth, as { usd, partial }.
// //
// Prices are fetched for the top 25 tokens only, so an address can hold real // Only a token with a price feed has a price, so an address can hold real
// assets this code has no price for. Adding up the priced ones and calling the // assets this code has no price for. Adding up the priced ones and calling the
// result the total states a number the holdings do not support: an address // result the total states a number the holdings do not support: an address
// holding nothing but unpriced tokens comes out at $0.00, which tells the user // holding nothing but unpriced tokens comes out at $0.00, which tells the user
@@ -99,8 +174,9 @@ function getAddressValue(addr) {
// nor make it incomplete. Anything that is not a number at all is not // 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. // 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]) { const price = prices[token.address.toLowerCase()];
usd += tokenBal * prices[token.symbol]; if (price) {
usd += tokenBal * price;
} else { } else {
partial = true; partial = true;
} }
+11 -9
View File
@@ -469,9 +469,11 @@ function mergeNetworkEndpoints(base, ours, theirs) {
// exists to remove, just delayed and confined to one page instead of two // 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 // (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 // does not own goes on being whatever its last loadState() saw, same as
// before this fix; only the persisted record is guaranteed current. The // before this fix; only the persisted record is guaranteed current. Three
// network is the exception: the popup takes a switch another context saved // fields are the exceptions: the network, "Use Blockscout" and "Check
// through `beforeWrite` (followNetworkSwitch() in src/popup/index.js). // recipients on Etherscan". Through `beforeWrite`, the popup takes a change to
// any of them that another context saved (followStoredSettings() in
// src/popup/index.js).
async function saveStateOnce(beforeWrite) { async function saveStateOnce(beforeWrite) {
const result = await storageGet("autistmask"); const result = await storageGet("autistmask");
// The record in storage right now is about to be merged into and written // The record in storage right now is about to be merged into and written
@@ -579,9 +581,7 @@ function reportSaveFailure(err) {
// Each save runs start to finish holding the lock every write of the stored // Each save runs start to finish holding the lock every write of the stored
// record takes (withLock() in src/shared/browserApi.js), so no write by // record takes (withLock() in src/shared/browserApi.js), so no write by
// another page or the background lands between its read and its write and is // another page or the background lands between its read and its write and is
// lost (https://git.eeqj.de/sneak/AutistMask/issues/641). A page in a Firefox // lost (https://git.eeqj.de/sneak/AutistMask/issues/641).
// private window is the exception: Firefox gives it locks of its own (README,
// "Stored state and its version").
// //
// The same lock orders this page's own saves. showView() calls saveState() on // The same lock orders this page's own saves. showView() calls saveState() on
// every navigation without awaiting it, so two saves from one page can be // every navigation without awaiting it, so two saves from one page can be
@@ -591,8 +591,10 @@ function reportSaveFailure(err) {
// //
// `beforeWrite`, when given, is called inside the lock with the stored record // `beforeWrite`, when given, is called inside the lock with the stored record
// as just read, before this page's state is compared against it. It may change // as just read, before this page's state is compared against it. It may change
// `state`, and this save writes that change. When it returns false, nothing is // `state`, and this save writes that change. It may also change the stored
// written; any other return lets the save go ahead. // record. A field that this page did not change is then written as
// `beforeWrite` left it. When it returns false, nothing is written; any other
// return lets the save go ahead.
function saveState(beforeWrite) { function saveState(beforeWrite) {
const turn = withLock("autistmask", () => saveStateOnce(beforeWrite)); const turn = withLock("autistmask", () => saveStateOnce(beforeWrite));
// Every failed save is reported, whether or not the caller awaited this // Every failed save is reported, whether or not the caller awaited this
@@ -603,7 +605,7 @@ function saveState(beforeWrite) {
} }
// Give this page the network switch held by `stored`, a record a save of this // Give this page the network switch held by `stored`, a record a save of this
// page has just read (followNetworkSwitch() in src/popup/index.js calls this // page has just read (followStoredSettings() in src/popup/index.js calls this
// from `beforeWrite`), in `state` and in `baseline` alike, as loadState() does // from `beforeWrite`), in `state` and in `baseline` alike, as loadState() does
// with a whole record. The switch is then not this page's own change, even when // with a whole record. The switch is then not this page's own change, even when
// that save fails to write: a later switch back to the previous network still // that save fails to write: a later switch back to the previous network still
+27
View File
@@ -0,0 +1,27 @@
// Reads "Use Blockscout" or "Check recipients on Etherscan" from the stored
// profile.
//
// Before each request that sends the user's data to Blockscout or Etherscan, the
// wallet reads that service's setting from storage. The wallet reads the setting
// again when the answer lands. While the setting is off, no such request is
// made, and an answer that lands after the setting went off is dropped. A page's
// own copy of the setting is not used, because another page may have just
// changed it.
const { storageGet } = require("./browserApi");
const { normalizePersisted } = require("./persistedState");
// Whether the setting `name` is on in the stored profile. `name` is
// "useBlockscout" or "checkRecipientsOnEtherscan". The profile is read through
// normalizePersisted(), as a load reads it, so only a stored true is on. A
// failed read counts as off.
async function storedSettingIsOn(name) {
try {
const { autistmask } = await storageGet("autistmask");
return normalizePersisted(autistmask)[name];
} catch {
return false;
}
}
module.exports = { storedSettingIsOn };
+351 -31
View File
@@ -4,12 +4,12 @@
// Addresses are EIP-55 checksummed. // Addresses are EIP-55 checksummed.
// //
// 511 tokens. // 511 tokens.
//
// Below the list, USD_PRICE_FEEDS gives the Chainlink USD price feed of each
// token that has one.
const { debugFetch } = require("./log");
const { NETWORKS } = require("./networks"); const { NETWORKS } = require("./networks");
const COINDESK_API = "https://data-api.coindesk.com/index/cc/v1/latest/tick";
const TOKENS = [ const TOKENS = [
{ {
address: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", address: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
@@ -3597,6 +3597,351 @@ const TOKENS = [
}, },
]; ];
// Chainlink price feeds on Ethereum mainnet. Each feed is a contract whose
// latestRoundData() returns a USD price and the time the price was written.
// The fields of a feed:
//
// - address: the feed's contract
// - heartbeat: the most seconds the feed goes without a new price
// - decimals: the number of decimal places in the price
//
// Each feed's address and heartbeat come from Chainlink's published list of
// mainnet feeds. Each feed was checked on mainnet by reading its description()
// and decimals().
// The ETH/USD feed, which prices ether and WETH.
const ETH_USD_FEED = {
address: "0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419",
heartbeat: 3600,
decimals: 8,
};
// The USD feed of each token in TOKENS that has one, keyed by the token's
// contract address as TOKENS spells it. A token is paired with its feed by its
// address alone, so a token that copies a listed token's symbol gets no feed.
const USD_PRICE_FEEDS = {
// WETH
"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2": ETH_USD_FEED,
// USDT
"0xdAC17F958D2ee523a2206206994597C13D831ec7": {
address: "0x3E7d1eAB13ad0104d2750B8863b489D65364e32D",
heartbeat: 86400,
decimals: 8,
},
// BNB
"0xB8c77482e45F1F44dE1745F52C74426C631bDD52": {
address: "0x14e613AC84a31f709eadbdF89C6CC390fDc9540A",
heartbeat: 86400,
decimals: 8,
},
// USDC
"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48": {
address: "0x8fFfFfd4AfB6115b954Bd326cbe7B4BA576818f6",
heartbeat: 82800,
decimals: 8,
},
// USDS
"0xdC035D45d973E3EC169d2276DDab16f1e407384F": {
address: "0xfF30586cD0F29eD462364C7e81375FC0C71219b1",
heartbeat: 82800,
decimals: 8,
},
// LINK
"0x514910771AF9Ca656af840dff83E8264EcF986CA": {
address: "0x2c1d072e956AFFC0D435Cb7AC38EF18d24d9127c",
heartbeat: 3600,
decimals: 8,
},
// USDE
"0x4c9EDD5852cd905f086C759E8383e09bff1E68B3": {
address: "0xa569d910839Ae8865Da8F8e70FfFb0cBA869F961",
heartbeat: 82800,
decimals: 8,
},
// USD1
"0x8d0D000Ee44948FC98c9B98A4FA4921476f08B0d": {
address: "0xF0d9bb015Cd7BfAb877B7156146dc09Bf461370d",
heartbeat: 86400,
decimals: 8,
},
// DAI
"0x6B175474E89094C44Da98b954EedeAC495271d0F": {
address: "0xAed0c38402a5d19df6E4c03F4E2DceD6e29c1ee9",
heartbeat: 3600,
decimals: 8,
},
// PYUSD
"0x6c3ea9036406852006290770BEdFcAbA0e23A0e8": {
address: "0x8f1dF6D7F2db73eECE86a18b4381F4707b918FB1",
heartbeat: 86400,
decimals: 8,
},
// WLFI
"0xdA5e1988097297dCdc1f90D4dFE7909e847CBeF6": {
address: "0x14E5FC91Ddb3f97C33013Cc9fA74F54062Ad1Aa1",
heartbeat: 86400,
decimals: 8,
},
// UNI
"0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984": {
address: "0x553303d460EE0afB37EdFf9bE42922D8FF63220e",
heartbeat: 3600,
decimals: 8,
},
// PAXG
"0x45804880De22913dAFE09f4980848ECE6EcbAf78": {
address: "0x9944D86CEB9160aF5C5feB251FD671923323f8C3",
heartbeat: 86400,
decimals: 8,
},
// AAVE
"0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9": {
address: "0x547a514d5e3769680Ce22B2361c10Ea13619e8a9",
heartbeat: 3600,
decimals: 8,
},
// USDF
"0xFa2B947eEc368f42195f24F36d2aF29f7c24CeC2": {
address: "0xb177857a1799aA5F7fEb5799Fdf12CbE8fdF78B1",
heartbeat: 86400,
decimals: 8,
},
// USDG
"0xe343167631d89B6Ffc58B88d6b7fB0228795491D": {
address: "0x14f0737d6b705259e521EA6E9E3506AC78dBd311",
heartbeat: 86400,
decimals: 8,
},
// SKY
"0x56072C95FAA701256059aa122697B133aDEd9279": {
address: "0xee10fE5E7aa92dd7b136597449c3d5813cFC5F18",
heartbeat: 86400,
decimals: 8,
},
// RLUSD
"0x8292Bb45bf1Ee4d140127049757C2E0fF06317eD": {
address: "0x26C46B7aD0012cA71F2298ada567dC9Af14E7f2A",
heartbeat: 86400,
decimals: 8,
},
// USDTB
"0xC139190F447e929f090Edeb554D95AbB8b18aC1C": {
address: "0x66704DAD467A7cA508B3be15865D9B9F3E186c90",
heartbeat: 86400,
decimals: 8,
},
// ARB
"0xB50721BCf8d664c30412Cfbc6cf7a15145234ad1": {
address: "0x31697852a68433DbCc2Ff612c516d69E3D9bd08F",
heartbeat: 86400,
decimals: 8,
},
// USD0
"0x73A15FeD60Bf67631dC6cd7Bc5B6e8da8190aCF5": {
address: "0x7e891DEbD8FA0A4Cf6BE58Ddff5a8ca174FebDCB",
heartbeat: 86400,
decimals: 8,
},
// GHO
"0x40D16FC0246aD3160Ccc09B8D0D3A2cD28aE6C2f": {
address: "0x3f12643D3f6f874d39C2a4c9f2Cd6f2DbAC877FC",
heartbeat: 86400,
decimals: 8,
},
// TUSD
"0x0000000000085d4780B73119b644AE5ecd22b376": {
address: "0xec746eCF986E2927Abd291a2A1716c940100f8Ba",
heartbeat: 86400,
decimals: 8,
},
// EURC
"0x1aBaEA1f7C830bD89Acc67eC4af516284b1bC33c": {
address: "0x04F84020Fdf10d9ee64D1dcC2986EDF2F556DA11",
heartbeat: 86400,
decimals: 8,
},
// FDUSD
"0xc5f0f7b66764F6ec8C8Dff7BA683102295E16409": {
address: "0xfAA9147190c2C2cc5B8387B4f49016bDB3380572",
heartbeat: 86400,
decimals: 8,
},
// CRV
"0xD533a949740bb3306d119CC777fa900bA034cd52": {
address: "0xCd627aA160A6fA45Eb793D19Ef54f5062F20f33f",
heartbeat: 86400,
decimals: 8,
},
// GRT
"0xc944E90C64B2c07662A292be6244BDf05Cda44a7": {
address: "0x86cF33a451dE9dc61a2862FD94FF4ad4Bd65A5d2",
heartbeat: 86400,
decimals: 8,
},
// CRVUSD
"0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E": {
address: "0xEEf0C605546958c1f899b6fB336C20671f9cD49F",
heartbeat: 86400,
decimals: 8,
},
// FRAX, the Legacy Frax Dollar, priced by Chainlink's FRAX / USD feed
"0x853d955aCEf822Db058eb8505911ED77F175b99e": {
address: "0xB9E1E3A9feFf48998E45Fa90847ed4D467E8BcfD",
heartbeat: 3600,
decimals: 8,
},
// ENS
"0xC18360217D8F7Ab5e7c516566761Ea12Ce7F9D72": {
address: "0x5C00128d4d1c2F4f652C267d7bcdD7aC99C16E16",
heartbeat: 86400,
decimals: 8,
},
// SAND
"0x3845badAde8e6dFF049820680d1F14bD3903a5d0": {
address: "0x35E3f7E558C04cE7eEE1629258EcbbA03B36Ec56",
heartbeat: 86400,
decimals: 8,
},
// AUSD
"0x00000000eFE302BEAA2b3e6e1b18d08D69a9012a": {
address: "0xB00341502DfEA6Ced8A5786b4059d29dA5E4D1FD",
heartbeat: 86400,
decimals: 18,
},
// COMP
"0xc00e94Cb662C3520282E6f5717214004A7f26888": {
address: "0xdbd020CAeF83eFd542f4De03e3cF0C28A4428bd5",
heartbeat: 3600,
decimals: 8,
},
// XCN
"0xA2cd3D43c775978A96BdBf12d733D5A1ED94fb18": {
address: "0xeb988B77b94C186053282BfcD8B7ED55142D3cAB",
heartbeat: 86400,
decimals: 8,
},
// CVX
"0x4e3FBD56CD56c3e72c1403e103b45Db9da5B9D2B": {
address: "0xd962fC30A72A84cE50161031391756Bf2876Af5D",
heartbeat: 86400,
decimals: 8,
},
// IMX
"0xF57e7e7C23978C3cAEC3C3548E3D615c346e79fF": {
address: "0xBAEbEFc1D023c0feCcc047Bff42E75F15Ff213E6",
heartbeat: 86400,
decimals: 8,
},
// 1INCH
"0x111111111117dC0aa78b770fA6A738034120C302": {
address: "0xc929ad75B72593967DE83E7F7Cda0493458261D9",
heartbeat: 86400,
decimals: 8,
},
// SNX
"0xC011a73ee8576Fb46F5E1c5751cA3B9Fe0af2a6F": {
address: "0xDC3EA94CD0AC27d9A86C180091e7f78C683d3699",
heartbeat: 86400,
decimals: 8,
},
// DOLA
"0x865377367054516e17014CcdED1e7d814EDC9ce4": {
address: "0xE33592594f72Cc7ec8a05788be8E8455746C3a32",
heartbeat: 86400,
decimals: 8,
},
// FRXUSD
"0xCAcd6fd266aF91b8AeD52aCCc382b4e165586E29": {
address: "0x9B4a96210bc8D9D55b1908B465D8B0de68B7fF83",
heartbeat: 86400,
decimals: 8,
},
// YFI
"0x0bc529c00C6401aEF6D220BE8C6Ea1667F6Ad93e": {
address: "0xA027702dbb89fbd58938e4324ac03B58d812b0E1",
heartbeat: 86400,
decimals: 8,
},
// RSR
"0x320623b8E4fF03373931769A31Fc52A4E78B5d70": {
address: "0x759bBC1be8F90eE6457C44abc7d443842a976d02",
heartbeat: 86400,
decimals: 8,
},
// ZRX
"0xE41d2489571d322189246DaFA5ebDe1F4699F498": {
address: "0x2885d15b8Af22648b98B122b22FDF4D2a56c6023",
heartbeat: 86400,
decimals: 8,
},
// FRAX, formerly FXS, priced by Chainlink's FXS / USD feed
"0x3432B6A60D23Ca0dFCa7761B7ab56459D9C964D0": {
address: "0x6Ebc52C8C1089be9eB3945C4350B68B8E4C2233f",
heartbeat: 86400,
decimals: 8,
},
// SXT
"0xE6Bfd33F52d82Ccb5b37E16D3dD81f9FFDAbB195": {
address: "0x2D27d9e1b74936D8E83c4BA118F09A4c4a897f62",
heartbeat: 86400,
decimals: 8,
},
// SUSHI
"0x6B3595068778DD592e39A122f4f5a5cF09C90fE2": {
address: "0xCc70F09A6CC17553b2E31954cD36E4A2d89501f7",
heartbeat: 86400,
decimals: 8,
},
// RPL
"0xD33526068D116cE69F19A9ee46F0bd304F21A51f": {
address: "0x4E155eD98aFE9034b7A5962f6C84c86d869daA9d",
heartbeat: 86400,
decimals: 8,
},
// USDP
"0x8E870D67F660D95d5be530380D0eC0bd388289E1": {
address: "0x09023c0DA49Aaf8fc3fA3ADF34C6A7016D38D5e3",
heartbeat: 86400,
decimals: 8,
},
// SPELL
"0x090185f2135308BaD17527004364eBcC2D37e5F6": {
address: "0x8c110B94C5f1d347fAcF5E1E938AB2db60E3c9a8",
heartbeat: 86400,
decimals: 8,
},
// LUSD
"0x5f98805A4E8be255a32880FDeC7F6728C6568bA0": {
address: "0x3D7aE7E594f2f2091Ad8798313450130d0Aba3a0",
heartbeat: 86400,
decimals: 8,
},
// STG
"0xAf5191B0De278C7286d6C7CC6ab6BB8A73bA2Cd6": {
address: "0x7A9f34a0Aa917D438e9b6E630067062B7F8f6f3d",
heartbeat: 86400,
decimals: 8,
},
// KNC
"0xdeFA4e8a7bcBA345F687a2f1456F5Edd9CE97202": {
address: "0xf8fF43E991A81e6eC886a3D281A2C6cC19aE70Fc",
heartbeat: 86400,
decimals: 8,
},
// MUSD (the other MUSD in TOKENS has no feed)
"0xacA92E438df0B2401fF60dA7E4337B687a2435DA": {
address: "0xc90E3460424fb8ea79775089E9053113FEE34Ed0",
heartbeat: 86400,
decimals: 8,
},
};
// Build a map of token address (lowercased) -> its USD price feed.
const PRICE_FEED_BY_ADDRESS = new Map();
for (const [address, feed] of Object.entries(USD_PRICE_FEEDS)) {
PRICE_FEED_BY_ADDRESS.set(address.toLowerCase(), feed);
}
// Return the top N tokens from the list. // Return the top N tokens from the list.
function getTopTokens(n) { function getTopTokens(n) {
return TOKENS.slice(0, n); return TOKENS.slice(0, n);
@@ -3643,33 +3988,6 @@ for (const t of TOKENS) {
} }
} }
// Fetch USD prices for the top N tokens from CoinDesk.
// Also always includes ETH. Returns { ETH: 1234.56, LINK: 8.60, ... }.
// n must be <= 30 (API and sanity limit).
async function getTopTokenPrices(n) {
if (n > 30) {
throw new Error("getTopTokenPrices: n must be <= 30, got " + n);
}
const symbols = ["ETH", ...TOKENS.slice(0, n).map((t) => t.symbol)];
const unique = [...new Set(symbols)];
const instruments = unique.map((s) => s + "-USD").join(",");
const url =
COINDESK_API +
"?market=cadli&instruments=" +
instruments +
"&apply_mapping=true";
const resp = await debugFetch(url);
const json = await resp.json();
const prices = {};
for (const [instrument, data] of Object.entries(json.Data || {})) {
const symbol = instrument.split("-")[0];
if (data.VALUE !== undefined) {
prices[symbol] = data.VALUE;
}
}
return prices;
}
// Resolve a token symbol from multiple sources, never returning "?". // Resolve a token symbol from multiple sources, never returning "?".
function resolveSymbol(tokenAddress, tokenBalances, trackedTokens) { function resolveSymbol(tokenAddress, tokenBalances, trackedTokens) {
const lower = (tokenAddress || "").toLowerCase(); const lower = (tokenAddress || "").toLowerCase();
@@ -3690,7 +4008,9 @@ module.exports = {
TOKENS, TOKENS,
TOKEN_BY_ADDRESS, TOKEN_BY_ADDRESS,
KNOWN_SYMBOLS, KNOWN_SYMBOLS,
ETH_USD_FEED,
USD_PRICE_FEEDS,
PRICE_FEED_BY_ADDRESS,
getTopTokens, getTopTokens,
getTopTokenPrices,
resolveSymbol, resolveSymbol,
}; };
+6 -5
View File
@@ -21,6 +21,7 @@ const { toDecimals } = require("./transferAmount");
// detail view is the authoritative record and already shows exact precision. // detail view is the authoritative record and already shows exact precision.
const { truncateAmount: formatTxValue } = require("./amountDisplay"); const { truncateAmount: formatTxValue } = require("./amountDisplay");
const { routerRelease } = require("./uniswap"); const { routerRelease } = require("./uniswap");
const { storedSettingIsOn } = require("./storedSettings");
// 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
@@ -236,17 +237,16 @@ function mergeTransactions(txs, tokenTransfers) {
// carries it, and a native entry is labelled with that network's // carries it, and a native entry is labelled with that network's
// `nativeCurrency` from networks.js (`ETH`, `SepoliaETH`). // `nativeCurrency` from networks.js (`ETH`, `SepoliaETH`).
// //
// `useBlockscout` is the user's "Use Blockscout" setting. While it is off, // While the stored "Use Blockscout" is off, Blockscout is not asked. An answer
// Blockscout is not asked and there is no history: the answer is an empty // that lands after the setting went off is dropped
// list. // (src/shared/storedSettings.js). Either way the answer is an empty list.
async function fetchRecentTransactions( async function fetchRecentTransactions(
address, address,
blockscoutUrl, blockscoutUrl,
useBlockscout,
chainId, chainId,
count = 25, count = 25,
) { ) {
if (!useBlockscout) return []; if (!(await storedSettingIsOn("useBlockscout"))) return [];
log.debugf("fetchRecentTransactions", address); log.debugf("fetchRecentTransactions", address);
const addrLower = normalizeAddress(address); const addrLower = normalizeAddress(address);
@@ -277,6 +277,7 @@ async function fetchRecentTransactions(
const txJson = txResp.ok ? await txResp.json() : {}; const txJson = txResp.ok ? await txResp.json() : {};
const ttJson = ttResp.ok ? await ttResp.json() : {}; const ttJson = ttResp.ok ? await ttResp.json() : {};
if (!(await storedSettingIsOn("useBlockscout"))) return [];
const txs = mergeTransactions( const txs = mergeTransactions(
(txJson.items || []).map((tx) => parseTx(tx, addrLower, chainId)), (txJson.items || []).map((tx) => parseTx(tx, addrLower, chainId)),
+245 -71
View File
@@ -479,6 +479,17 @@ function tokenInfo(address, sources) {
}; };
} }
// The token of a Permit2 allowance or of a PERMIT2_TRANSFER_FROM, in the
// shape tokenInfo() gives. Permit2 has no allowance of ETH and moves no ETH.
// The zero address there reads as a token nothing knows: its amount in base
// units, and the zero address as its token.
function permit2TokenInfo(address, sources) {
if (address === "0x0000000000000000000000000000000000000000") {
return { symbol: null, decimals: null, address };
}
return tokenInfo(address, sources);
}
// A swap amount line. With a scale it is the token quantity; with none it is // 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 // 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` // ERC-20 amount line makes, so the screen has one way of saying it. `display`
@@ -497,16 +508,18 @@ function amountText(raw, info) {
// The line giving a moved token, or the token of a permit, under `label`, in // The line giving a moved token, or the token of a permit, under `label`, in
// the shape of the Token In line, so the screens show it as they show that // the shape of the Token In line, so the screens show it as they show that
// one. ETH has no address. // one. `info` is what tokenInfo() or permit2TokenInfo() gives for the token.
function tokenMovedLine(label, token, sources) { // ETH has no address.
const info = tokenInfo(token, sources); function tokenMovedLine(label, info) {
if (!present(info.address)) { if (!present(info.address)) {
return { label, value: info.symbol }; return { label, value: info.symbol };
} }
return { return {
label, label,
value: info.symbol ? info.symbol + " (" + token + ")" : token, value: info.symbol
address: token, ? info.symbol + " (" + info.address + ")"
: info.address,
address: info.address,
isToken: true, isToken: true,
}; };
} }
@@ -975,6 +988,9 @@ function totalAmount(amounts) {
// pays it of Token In as the step's amount in place of the rules' Amount, or // pays it of Token In as the step's amount in place of the rules' Amount, or
// no amount when this decoder cannot tell what that is. // no amount when this decoder cannot tell what that is.
// //
// `spent` lists the currency that each swap action spends, for each swap
// action that this decoder could read.
//
// `takes` is every TAKE, TAKE_ALL and TAKE_PORTION, as the currency it takes // `takes` is every TAKE, TAKE_ALL and TAKE_PORTION, as the currency it takes
// and its recipient as written, MSG_SENDER for a TAKE_ALL. TAKE_PORTION takes // and its recipient as written, MSG_SENDER for a TAKE_ALL. TAKE_PORTION takes
// a share of the currency, so it does not name the output side as TAKE does. // a share of the currency, so it does not name the output side as TAKE does.
@@ -1150,6 +1166,8 @@ function decodeV4Swap(input) {
} }
} }
const spent = swaps.map((s) => s.tokenIn);
// Rule 3. // Rule 3.
if (swapUndecoded) { if (swapUndecoded) {
return { return {
@@ -1157,6 +1175,7 @@ function decodeV4Swap(input) {
tokenOut: takeToken, tokenOut: takeToken,
amountIn: null, amountIn: null,
amountOutMin: null, amountOutMin: null,
spent,
takes, takes,
settledFromRouter, settledFromRouter,
paidByUser, paidByUser,
@@ -1167,7 +1186,6 @@ function decodeV4Swap(input) {
}; };
} }
const spent = swaps.map((s) => s.tokenIn);
const bought = swaps.map((s) => s.tokenOut); const bought = swaps.map((s) => s.tokenOut);
// Rules 1 and 2 for Token In. // Rules 1 and 2 for Token In.
@@ -1203,6 +1221,7 @@ function decodeV4Swap(input) {
tokenOut, tokenOut,
amountIn, amountIn,
amountOutMin, amountOutMin,
spent,
takes, takes,
settledFromRouter, settledFromRouter,
paidByUser, paidByUser,
@@ -1240,9 +1259,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
let inputEstablished = false; let inputEstablished = false;
// Whether the user pays the step that set the input side: a V2 or V3 // Whether the user pays the step that set the input side: a V2 or V3
// swap step with `payerIsUser` true, a V4 step the user pays some of // swap step with `payerIsUser` true, a V4 step the user pays some of
// its input currency (see decodeV4Swap()), or a WRAP_ETH, whose ETH // its input currency (see paidByUser in the loop), or a WRAP_ETH,
// comes from the transaction's value. A step paid from the router // whose ETH comes from the transaction's value. A step that pays an
// takes nothing from the sender. // ERC-20 token from the router takes none of that token from the
// sender.
let inputPaidByUser = false; let inputPaidByUser = false;
// The last PERMIT2_PERMIT this decoder read before a step set the // The last PERMIT2_PERMIT this decoder read before a step set the
// input side, or null (see permitStands after the loop). // input side, or null (see permitStands after the loop).
@@ -1293,8 +1313,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
const commandNames = []; const commandNames = [];
// THE INVARIANT: an amount and the token it is counted in always come // THE INVARIANT: an amount and the token it is counted in always come
// from the same hop, or from hops that all spend that token. A figure // from the same hop, or from hops that all spend that token or all buy
// is never rendered against a token that did not supply it. // it. 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 // 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 // never on truthiness. An address is never falsy once set but an
@@ -1338,7 +1359,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// What the steps take from the sender beyond the amount of the step // What the steps take from the sender beyond the amount of the step
// that sets the input side, as { token, amount }, in step order. // that sets the input side, as { token, amount }, in step order.
// After the loop each joins the Amount line or gets lines of its own // After the loop each joins the Amount line or gets lines of its own
// (see permitStands). // (see permitStands). A take with `atMost` set may take less than
// `amount`: it never joins the Amount line, and its line reads
// "Up to" and the amount.
const userPaid = []; const userPaid = [];
// A swap step the user pays for (`payerIsUser` true) takes `amount` // A swap step the user pays for (`payerIsUser` true) takes `amount`
// of `token` from the sender. A V2 exact-in of ALREADY_PAID takes // of `token` from the sender. A V2 exact-in of ALREADY_PAID takes
@@ -1407,6 +1430,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
const r = recipient.toLowerCase(); const r = recipient.toLowerCase();
return r === ADDRESS_THIS || r === toAddress.toLowerCase(); return r === ADDRESS_THIS || r === toAddress.toLowerCase();
}; };
const isSender = (recipient) => {
const r = recipient.toLowerCase();
return r === MSG_SENDER || r === sender;
};
// A swap step or V4 SETTLE pays `amount` of `token` from the router's // A swap step or V4 SETTLE pays `amount` of `token` from the router's
// own balance. CONTRACT_BALANCE pays all of it. Any other quantity // own balance. CONTRACT_BALANCE pays all of it. Any other quantity
// counts against the amount a WRAP_ETH stated, and the steps pay all // counts against the amount a WRAP_ETH stated, and the steps pay all
@@ -1439,17 +1466,73 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// A step pays `recipient`. `output` is the token a swap step or a V4 // A step pays `recipient`. `output` is the token a swap step or a V4
// TAKE or TAKE_PORTION pays; other steps pass none. // TAKE or TAKE_PORTION pays; other steps pass none.
const addPayee = (recipient, output) => { const addPayee = (recipient, output) => {
const r = recipient.toLowerCase();
if (isRouter(recipient)) { if (isRouter(recipient)) {
if (present(output)) { if (present(output)) {
heldByRouter.set(output.toLowerCase(), null); heldByRouter.set(output.toLowerCase(), null);
} }
} else if (r === MSG_SENDER || r === sender) { } else if (isSender(recipient)) {
paidToSender = true; paidToSender = true;
} else { } else {
addPaidElsewhere(recipient); addPaidElsewhere(recipient);
} }
}; };
// Each swap step that paid the sender some of the token it bought,
// as { step, token, amount, onlyToSender }:
// - `step` is the step's index;
// - `token` is that token;
// - `amount` is the step's stated minimum;
// - `onlyToSender` is whether the step paid all of that token to the
// sender.
// A later step that spends that token takes the step off this list
// (see dropFromSum()).
let swapsPayingSender = [];
// The step being read spends `token`, so it may spend what an earlier
// swap step paid the sender. Each step on swapsPayingSender that
// bought `token` leaves the list. A step spends a token as follows:
// - a V2 or V3 swap step spends its input token;
// - a V4 step spends each token that one of its swap actions spends,
// and each token that one of its SETTLEs or SETTLE_ALLs pays;
// - a PERMIT2_TRANSFER_FROM spends the token it moves.
const dropFromSum = (token) => {
swapsPayingSender = swapsPayingSender.filter(
(s) => !sameAddress(s.token, token),
);
};
// The minimum the output side shows for the swap step at `step`. The
// step buys `token` with the stated minimum `amount`, and pays
// `token` to `recipients`. The minimum is the step's own, unless this
// step and an earlier one on swapsPayingSender both pay `token` to
// the sender, as a route split across steps does. The minimum is then
// the total of all such steps' minimums. There is none when this
// decoder reads no minimum from one of them, or when one of them pays
// some of `token` elsewhere. There is also none when this decoder did
// not read one of them, or a step between them, in full (see
// stepsUnread).
const swapMinimum = (step, token, amount, recipients) => {
const toSender = recipients.filter(
(r) => present(r) && isSender(r),
);
if (toSender.length === 0) return amount;
swapsPayingSender.push({
step,
token,
amount,
onlyToSender: toSender.length === recipients.length,
});
const split = swapsPayingSender.filter((s) =>
sameAddress(s.token, token),
);
if (split.length < 2) return amount;
if (
split.some(
(s) => !s.onlyToSender || typeof s.amount !== "bigint",
) ||
stepsUnread.some((unread) => unread >= split[0].step)
) {
return null;
}
return split.reduce((sum, s) => sum + s.amount, 0n);
};
// A step that pays `token` to `recipient` is a hop, not a payout, // A step that pays `token` to `recipient` is a hop, not a payout,
// when the very next step is a V2 exact-in whose input is already // when the very next step is a V2 exact-in whose input is already
// paid, whose path starts at `token`, and whose pair (see v2PairFor()) // paid, whose path starts at `token`, and whose pair (see v2PairFor())
@@ -1591,6 +1674,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
: null, : null,
}); });
} }
if (p) dropFromSum(p.token);
} else if (command === "BALANCE_CHECK_ERC20") { } else if (command === "BALANCE_CHECK_ERC20") {
const b = decodeBalanceCheck(inputs[i]); const b = decodeBalanceCheck(inputs[i]);
if (!b) { if (!b) {
@@ -1613,13 +1697,13 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else { } else {
// The router passes this check whenever the owner // The router passes this check whenever the owner
// holds at least minBalance, so a zero one guarantees // holds at least minBalance, so a zero one guarantees
// nothing and does not replace a minimum an earlier // nothing. A check the router lets fail guarantees
// step stated. A check the router lets fail guarantees // nothing either, so it is read as a zero one. A zero
// nothing either, so it is read as a zero one. Any // check sets neither Token Out nor the minimum. Any
// other minBalance sets the output side as a swap // other minBalance sets the output side as a swap
// does. It pays nobody. // does. The check pays nobody.
const minBalance = allowedToFail ? 0n : b.minBalance; const minBalance = allowedToFail ? 0n : b.minBalance;
if (!(minBalance === 0n && present(minOutput))) { if (minBalance !== 0n) {
setOutput(i, b.token, minBalance, []); setOutput(i, b.token, minBalance, []);
} }
keepsRouterWeth = true; keepsRouterWeth = true;
@@ -1633,10 +1717,18 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (s.payerIsUser) { } else if (s.payerIsUser) {
addUserPaid(s.tokenIn, s.amountIn); addUserPaid(s.tokenIn, s.amountIn);
} }
dropFromSum(s.tokenIn);
// 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
// and minimum received amount. // token. swapMinimum() gives the minimum.
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]); setOutput(
i,
s.tokenOut,
swapMinimum(i, s.tokenOut, s.amountOutMin, [
s.recipient,
]),
[s.recipient],
);
if (!s.payerIsUser) { if (!s.payerIsUser) {
spendFromRouter(s.tokenIn, s.amountIn); spendFromRouter(s.tokenIn, s.amountIn);
} }
@@ -1657,7 +1749,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (s.payerIsUser) { } else if (s.payerIsUser) {
addUserPaid(s.tokenIn, s.amountIn); addUserPaid(s.tokenIn, s.amountIn);
} }
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]); dropFromSum(s.tokenIn);
setOutput(
i,
s.tokenOut,
swapMinimum(i, s.tokenOut, s.amountOutMin, [
s.recipient,
]),
[s.recipient],
);
if (!s.payerIsUser) { if (!s.payerIsUser) {
spendFromRouter(s.tokenIn, s.amountIn); spendFromRouter(s.tokenIn, s.amountIn);
} }
@@ -1689,7 +1789,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (s.payerIsUser) { } else if (s.payerIsUser) {
addUserPaid(s.tokenIn, s.amountInMax); addUserPaid(s.tokenIn, s.amountInMax);
} }
setOutput(i, s.tokenOut, s.amountOut, [s.recipient]); dropFromSum(s.tokenIn);
setOutput(
i,
s.tokenOut,
swapMinimum(i, s.tokenOut, s.amountOut, [
s.recipient,
]),
[s.recipient],
);
if (!isHop(i, s.tokenOut, s.recipient)) { if (!isHop(i, s.tokenOut, s.recipient)) {
addPayee(s.recipient, s.tokenOut); addPayee(s.recipient, s.tokenOut);
} }
@@ -1815,6 +1923,41 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (command === "V4_SWAP") { } else if (command === "V4_SWAP") {
const v4 = decodeV4Swap(inputs[i]); const v4 = decodeV4Swap(inputs[i]);
const inputSetBefore = inputEstablished; const inputSetBefore = inputEstablished;
// V4Router pays a SETTLE of ETH from the router's own
// ETH, whichever payer the SETTLE names. The router holds
// the transaction's value, and any ETH an earlier step
// left it (see heldByRouter). So the user also pays a
// SETTLE of ETH that names the router as payer. The user
// pays all of its amount when the router holds no other
// ETH, and up to its amount otherwise. CONTRACT_BALANCE
// pays all the router holds, an amount the calldata does
// not state.
const routerHeldEth = heldByRouter.has(
"0x0000000000000000000000000000000000000000",
);
const ethFromRouter = (v4?.settledFromRouter ?? [])
.filter(
(s) =>
s.currency ===
"0x0000000000000000000000000000000000000000",
)
.map((s) => ({
currency: s.currency,
amount:
s.amount === CONTRACT_BALANCE ? null : s.amount,
}));
// What the user pays the step: what decodeV4Swap() says,
// and the ETH of each SETTLE from the router of a known
// amount when the router holds no other ETH.
const paidByUser = v4
? v4.paidByUser.concat(
routerHeldEth
? []
: ethFromRouter.filter((s) =>
present(s.amount),
),
)
: [];
if (v4) { if (v4) {
// Each SETTLE paid from the router spends the amount // Each SETTLE paid from the router spends the amount
// decodeV4Swap() says it pays. // decodeV4Swap() says it pays.
@@ -1826,6 +1969,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
addPayee(t.recipient, t.currency); addPayee(t.recipient, t.currency);
} }
} }
for (const token of v4.spent) dropFromSum(token);
for (const s of v4.paidByUser) dropFromSum(s.currency);
for (const s of v4.settledFromRouter) {
dropFromSum(s.currency);
}
} }
if (!v4 || v4.recipientUnread) { if (!v4 || v4.recipientUnread) {
payeeUnread = true; payeeUnread = true;
@@ -1845,10 +1993,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
commandNames[i] += " (could not be decoded)"; commandNames[i] += " (could not be decoded)";
} }
// The step's amount, if it sets the input side: what the // The step's amount, if it sets the input side: what the
// user pays it of its input currency (see // user pays it of its input currency, or, when the user
// decodeV4Swap()), or, when the user pays none of it, // pays none of it, what its swap actions spend of it,
// what its swap actions spend of it, whoever pays that. // whoever pays that.
const paidIn = v4?.paidByUser.find( const paidIn = paidByUser.find(
(p) => p.currency === v4.tokenIn, (p) => p.currency === v4.tokenIn,
); );
const amountIn = paidIn ? paidIn.amount : v4?.amountIn; const amountIn = paidIn ? paidIn.amount : v4?.amountIn;
@@ -1874,7 +2022,12 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
setInput(v4.tokenIn, amountIn); setInput(v4.tokenIn, amountIn);
} }
outputToken = v4.tokenOut; outputToken = v4.tokenOut;
minOutput = v4.amountOutMin; minOutput = swapMinimum(
i,
v4.tokenOut,
v4.amountOutMin,
takeRecipients,
);
outputEstablished = true; outputEstablished = true;
outputUnwrapped = false; outputUnwrapped = false;
unwrapIntoRouterStep = null; unwrapIntoRouterStep = null;
@@ -1902,10 +2055,24 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// router still runs it. // router still runs it.
const setInputHere = inputEstablished && !inputSetBefore; const setInputHere = inputEstablished && !inputSetBefore;
if (setInputHere) inputPaidByUser = paidIn !== undefined; if (setInputHere) inputPaidByUser = paidIn !== undefined;
if (v4) { for (const p of paidByUser) {
for (const p of v4.paidByUser) { if (setInputHere && p === paidIn) continue;
if (setInputHere && p === paidIn) continue; addUserPaid(p.currency, p.amount);
addUserPaid(p.currency, p.amount); }
// A SETTLE of ETH from the router that `paidByUser` leaves
// out is a take of its own, even on the step that sets
// the input side. Either this decoder does not know its
// amount, or ETH an earlier step left in the router may
// pay part of that amount (see userPaid).
for (const p of ethFromRouter) {
if (!present(p.amount)) {
addUserPaid(p.currency, null);
} else if (routerHeldEth) {
userPaid.push({
token: p.currency,
amount: p.amount,
atMost: true,
});
} }
} }
if (!v4 || v4.settleUnread) { if (!v4 || v4.settleUnread) {
@@ -2013,10 +2180,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// The total is what the steps take of Token In: the amount of the // The total is what the steps take of Token In: the amount of the
// step that set the input side, with each later take of that token // step that set the input side, with each later take of that token
// added to it while both are quantities. A take that cannot be added, // added to it while both are quantities. A take that cannot be added,
// being of another token or coming after an amount that is not a // being of another token, coming after an amount that is not a
// quantity (a V4 open delta, ALREADY_PAID, or none stated), gets // quantity (a V4 open delta, ALREADY_PAID, or none stated), or having
// lines of its own. One whose amount is not known also leaves the // `atMost` set, gets lines of its own. One whose amount is not known
// total unknown, with no figure. // also leaves the total unknown, with no figure.
// //
// A PERMIT2_PERMIT names Token In only when its amount stands as the // A PERMIT2_PERMIT names Token In only when its amount stands as the
// Amount figure in place of the total, which it does only in the // Amount figure in place of the total, which it does only in the
@@ -2032,12 +2199,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// it may take more. A later permit or batch, or a later step this // it may take more. A later permit or batch, or a later step this
// decoder did not read, may raise what Permit2 lets the router take. // decoder did not read, may raise what Permit2 lets the router take.
// Every other PERMIT2_PERMIT leaves Token In and the Amount line as // Every other PERMIT2_PERMIT leaves Token In and the Amount line as
// they read with no permit, and gets lines of its own below. A step // they read with no permit, and gets lines of its own below. A permit
// that may take from the sender what this decoder did not read leaves // on the zero address never stands as the Amount figure, because
// no figure, permit or not (see spentUnread()), and so do a permit // Permit2 has no allowance of ETH. A step that may take from the
// or batch whose input it cannot read (see permitUnread()) and an // sender what this decoder did not read leaves no figure, permit or
// allowance of Token In to another spender (see toAnotherSpender). An // not (see spentUnread()), and so do a permit or batch whose input it
// EXECUTE_SUB_PLAN step leaves both sides unknown (below). // cannot read (see permitUnread()) and an allowance of Token In to
// another spender (see toAnotherSpender). An EXECUTE_SUB_PLAN step
// leaves both sides unknown (below).
const stepCommands = Array.from( const stepCommands = Array.from(
commandsBytes, commandsBytes,
(b) => commands[b & commandTypeMask], (b) => commands[b & commandTypeMask],
@@ -2047,6 +2216,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
stepCommands.filter((c) => c === "PERMIT2_PERMIT").length === 1 && stepCommands.filter((c) => c === "PERMIT2_PERMIT").length === 1 &&
!stepCommands.includes("PERMIT2_PERMIT_BATCH") && !stepCommands.includes("PERMIT2_PERMIT_BATCH") &&
sameAddress(permit.spender, toAddress) && sameAddress(permit.spender, toAddress) &&
permit.token !== "0x0000000000000000000000000000000000000000" &&
!permit.allowedToFail && !permit.allowedToFail &&
permit.beforeEveryTake && permit.beforeEveryTake &&
!stepsUnread.some((step) => step > permit.step); !stepsUnread.some((step) => step > permit.step);
@@ -2057,14 +2227,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
let total = null; let total = null;
// The takes from the sender that `total` adds up, each a quantity, as // The takes from the sender that `total` adds up, each a quantity, as
// { token, amount }. When there is no Amount line, each gets lines of // { token, amount }. When there is no Amount line, each gets lines of
// its own (see below). The amount of a step that set the input side // its own (see below). The amount of the step that set the input side
// and is paid from the router counts in `total` but is not among them. // counts in `total` whoever pays that step. That amount is among them
// only when the user pays the step (see inputPaidByUser).
const inTotal = []; const inTotal = [];
// Whether the step that set the input side counts as a take from the // Whether the step that set the input side counts as a take from the
// sender, which may get lines of its own. The amount it stated counts // sender, which may get lines of its own. The amount it stated counts
// whoever pays it. Stating none, it counts only when the user pays it // whoever pays it. Stating none, it counts only when the user pays it
// some of its input token: paid from the router, it takes nothing // some of its input token.
// from the sender.
const hasFirstTake = const hasFirstTake =
inputEstablished && (present(inputAmount) || inputPaidByUser); inputEstablished && (present(inputAmount) || inputPaidByUser);
// The take of the step that set the input side, when the total // The take of the step that set the input side, when the total
@@ -2090,7 +2260,8 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
if ( if (
ofTokenIn && ofTokenIn &&
typeof total === "bigint" && typeof total === "bigint" &&
typeof t.amount === "bigint" typeof t.amount === "bigint" &&
!t.atMost
) { ) {
total += t.amount; total += t.amount;
inTotal.push(t); inTotal.push(t);
@@ -2193,8 +2364,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// V2's already-paid zero, neither of which is a quantity at all (see // V2's already-paid zero, neither of which is a quantity at all (see
// OPEN_DELTA and ALREADY_PAID), and an unbounded permit. Those two // OPEN_DELTA and ALREADY_PAID), and an unbounded permit. Those two
// tests come first — the sentinels are not bigints and cannot be // tests come first — the sentinels are not bigints and cannot be
// compared with one. // compared with one. `atMost` marks an amount that is only the most a
const spentText = (amount, info) => { // take may be (see userPaid).
const spentText = (amount, info, atMost) => {
if (amount === OPEN_DELTA) { if (amount === OPEN_DELTA) {
return { raw: OPEN_DELTA_AMOUNT, display: OPEN_DELTA_AMOUNT }; return { raw: OPEN_DELTA_AMOUNT, display: OPEN_DELTA_AMOUNT };
} }
@@ -2207,7 +2379,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
if (amount >= MAX_UINT160) { if (amount >= MAX_UINT160) {
return { raw: "Unlimited", display: "Unlimited" }; return { raw: "Unlimited", display: "Unlimited" };
} }
if (hasV2OrV3ExactOut) { if (hasV2OrV3ExactOut || atMost) {
// A V2 or V3 exact-out swap spends at most this figure, // A V2 or V3 exact-out swap spends at most this figure,
// whichever steps gave it (an amountInMax, the WRAP_ETH of a // whichever steps gave it (an amountInMax, the WRAP_ETH of a
// swap paid in ETH, a permit, or several steps' total), so it // swap paid in ETH, a permit, or several steps' total), so it
@@ -2234,17 +2406,19 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// A null token in `spentFromSender`, a step this decoder did not read // A null token in `spentFromSender`, a step this decoder did not read
// or a token it does not know, and an allowance to another spender // or a token it does not know, and an allowance to another spender
// that may be of Token In, leave no Amount figure, which may then be // that may be of Token In, leave no Amount figure, which may then be
// too low. With no Amount line, each take the total adds up gets // too low. An allowance of the zero address is never one of Token In,
// lines of its own, first, so that every amount this decoder read is // because Permit2 has no allowance of ETH. With no Amount line, each
// shown. // take the total adds up gets lines of its own, first, so that every
// amount this decoder read is shown.
if ( if (
present(inputAmount) && present(inputAmount) &&
spentFromSender.every((s) => present(s.token)) && spentFromSender.every((s) => present(s.token)) &&
toAnotherSpender.every( toAnotherSpender.every(
(p) => (p) =>
present(p.token) && p.token === "0x0000000000000000000000000000000000000000" ||
present(inputToken) && (present(p.token) &&
!sameAddress(p.token, inputToken), present(inputToken) &&
!sameAddress(p.token, inputToken)),
) )
) { ) {
const amount = spentText(inputAmount, inInfo); const amount = spentText(inputAmount, inInfo);
@@ -2265,11 +2439,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
details.push({ details.push({
label: "Moved from the sender", label: "Moved from the sender",
value: present(s.amount) value: present(s.amount)
? spentText(s.amount, tokenInfo(s.token, sources)).display ? spentText(s.amount, tokenInfo(s.token, sources), s.atMost)
.display
: UNDECODED_CURRENCY, : UNDECODED_CURRENCY,
}); });
if (present(s.token)) { if (present(s.token)) {
details.push(tokenMovedLine("Token moved", s.token, sources)); details.push(
tokenMovedLine("Token moved", tokenInfo(s.token, sources)),
);
details.push({ details.push({
label: "Moved to", label: "Moved to",
value: "The swap step that spends it", value: "The swap step that spends it",
@@ -2280,12 +2457,12 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// What each PERMIT2_TRANSFER_FROM moves: its amount, its token and // What each PERMIT2_TRANSFER_FROM moves: its amount, its token and
// where it goes, an address on a line of its own. // where it goes, an address on a line of its own.
for (const m of movedFromSender) { for (const m of movedFromSender) {
const info = permit2TokenInfo(m.token, sources);
details.push({ details.push({
label: "Moved from the sender", label: "Moved from the sender",
value: amountText(m.amount, tokenInfo(m.token, sources)) value: amountText(m.amount, info).display,
.display,
}); });
details.push(tokenMovedLine("Token moved", m.token, sources)); details.push(tokenMovedLine("Token moved", info));
details.push( details.push(
present(m.to) present(m.to)
? { label: "Moved to", value: m.to } ? { label: "Moved to", value: m.to }
@@ -2315,15 +2492,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
}); });
continue; continue;
} }
const info = permit2TokenInfo(p.token, sources);
details.push({ details.push({
label: "Permit2 allowance", label: "Permit2 allowance",
value: value:
p.amount >= MAX_UINT160 p.amount >= MAX_UINT160
? "Unlimited" ? "Unlimited"
: amountText(p.amount, tokenInfo(p.token, sources)) : amountText(p.amount, info).display,
.display,
}); });
details.push(tokenMovedLine("Allowance token", p.token, sources)); details.push(tokenMovedLine("Allowance token", info));
details.push({ details.push({
label: "Allowance spender", label: "Allowance spender",
value: p.spender, value: p.spender,
@@ -2381,7 +2558,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
paidTo.push({ label: "Paid to", value: PAID_TO_BRIDGE }); paidTo.push({ label: "Paid to", value: PAID_TO_BRIDGE });
} }
for (const m of movedIntoRouter) { for (const m of movedIntoRouter) {
const info = tokenInfo(m.token, sources); const info = permit2TokenInfo(m.token, sources);
paidTo.push({ paidTo.push({
label: "Paid to", label: "Paid to",
value: value:
@@ -2389,9 +2566,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
amountText(m.amount, info).display + amountText(m.amount, info).display +
" from the sender (later steps may not spend all of it)", " from the sender (later steps may not spend all of it)",
}); });
paidTo.push( paidTo.push(tokenMovedLine("Token moved into the router", info));
tokenMovedLine("Token moved into the router", m.token, sources),
);
} }
if (outputHeld) { if (outputHeld) {
paidTo.push({ label: "Paid to", value: STAYS_IN_ROUTER }); paidTo.push({ label: "Paid to", value: STAYS_IN_ROUTER });
@@ -2408,8 +2583,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
paidTo.push( paidTo.push(
tokenMovedLine( tokenMovedLine(
"Token moved into the router", "Token moved into the router",
getAddress(token), tokenInfo(getAddress(token), sources),
sources,
), ),
); );
} }
+4 -4
View File
@@ -1,9 +1,9 @@
// The USD total of an address that holds something this build cannot price // The USD total of an address that holds something this build cannot price
// (issue #261). // (issue #261).
// //
// Prices exist for the top 25 tokens only, so an address can hold real assets // Only a token with a price feed has a price, so an address can hold real
// with no price attached. Summing what is priced and printing the result as // assets with no price attached. Summing what is priced and printing the result
// the total says "$0.00" for an address holding nothing but unpriced tokens — // as the total says "$0.00" for an address holding nothing but unpriced tokens —
// worth-nothing and worth-an-unknown-amount collapsed into one number, in the // worth-nothing and worth-an-unknown-amount collapsed into one number, in the
// direction that matters. The two are separate facts here, the same way an // direction that matters. The two are separate facts here, the same way an
// absent holders_count is not a count of zero. // absent holders_count is not a count of zero.
@@ -63,7 +63,7 @@ const PARTLY_PRICED = {
beforeEach(() => { beforeEach(() => {
clearPrices(); clearPrices();
prices.ETH = 2000; prices.ETH = 2000;
prices.USDC = 1; prices[USDC] = 1;
state.wallets = []; state.wallets = [];
state.trackedTokens = []; state.trackedTokens = [];
state.showZeroBalanceTokens = false; state.showZeroBalanceTokens = false;
+2
View File
@@ -41,6 +41,8 @@ jest.mock("../src/shared/balances", () => ({
refreshBalances: jest.fn(async () => { refreshBalances: jest.fn(async () => {
mockBalanceRefreshAt.push(Date.now()); mockBalanceRefreshAt.push(Date.now());
}), }),
dropUntrackedTokens: jest.requireActual("../src/shared/balances")
.dropUntrackedTokens,
getProvider: jest.fn(() => ({})), getProvider: jest.fn(() => ({})),
})); }));
+87
View File
@@ -0,0 +1,87 @@
// "Allow weak passwords" in Settings is off until the user ticks it. While it
// is off, AddWallet refuses a password shorter than 12 characters. While it is
// on, AddWallet accepts any password that is not empty
// (https://git.eeqj.de/sneak/AutistMask/issues/674). These boot the real popup,
// set the checkbox in Settings as the user does, and then add a wallet.
jest.mock("../src/shared/vault", () => ({
decryptWithPassword: jest.fn(),
encryptWithPassword: jest.fn(async () => ({
salt: "salt",
nonce: "nonce",
ciphertext: "ciphertext",
})),
}));
const {
bootPopup,
cleanupPopup,
unversionedValidProfile,
} = require("./support/popupBoot");
const CHECKBOX = "settings-allow-weak-passwords";
const ERROR = "add-wallet-password-error";
afterEach(() => {
cleanupPopup();
});
// Boots a popup that holds one wallet and opens Settings, where the checkbox
// starts unticked. Ticks it when `allow` is true. Then opens AddWallet and
// presses the die for a recovery phrase.
async function openAddWallet(allow) {
const page = await bootPopup(unversionedValidProfile());
await page.click("btn-settings");
const checkbox = page.node(CHECKBOX);
expect(checkbox.checked).toBe(false);
if (allow) {
checkbox.checked = true;
for (const fn of checkbox.listeners.change) await fn();
expect(page.storage.read("autistmask").allowWeakPasswords).toBe(true);
}
await page.click("btn-main-add-wallet");
await page.click("btn-generate-phrase");
return page;
}
// Types `password` into both password fields and presses Import.
async function importWith(page, password) {
page.node("add-wallet-password").value = password;
page.node("add-wallet-password-confirm").value = password;
await page.click("btn-add-wallet-confirm");
}
function storedWalletCount(page) {
return page.storage.read("autistmask").wallets.length;
}
describe("Allow weak passwords", () => {
test("unticked: a password shorter than 12 characters is refused", async () => {
const page = await openAddWallet(false);
await importWith(page, "short");
expect(page.text(ERROR)).toBe(
"Password must be at least 12 characters.",
);
expect(storedWalletCount(page)).toBe(1);
expect(page.visibleViews()).toEqual(["add-wallet"]);
});
test("ticked: a password shorter than 12 characters is accepted", async () => {
const page = await openAddWallet(true);
await importWith(page, "short");
expect(page.text(ERROR)).toBe("");
expect(storedWalletCount(page)).toBe(2);
expect(page.visibleViews()).toEqual(["main"]);
});
test.each([false, true])(
"an empty password is refused (ticked: %s)",
async (allow) => {
const page = await openAddWallet(allow);
await importWith(page, "");
expect(page.text(ERROR)).toBe("Please choose a password.");
expect(storedWalletCount(page)).toBe(1);
expect(page.visibleViews()).toEqual(["add-wallet"]);
},
);
});
+3
View File
@@ -84,6 +84,9 @@ function walletsHolding(token, decimals) {
beforeEach(() => { beforeEach(() => {
state.trackedTokens = []; state.trackedTokens = [];
state.wallets = []; state.wallets = [];
// The approval screen reads the explorer's report only while "Use
// Blockscout" is on.
state.useBlockscout = true;
}); });
describe("resolveTokenDecimals", () => { describe("resolveTokenDecimals", () => {
+308
View File
@@ -0,0 +1,308 @@
// While "Use Blockscout" is off, the approval screens, and the screens that
// follow TxApproval, take a token's name and scale from the bundled list and
// the tracked tokens alone (https://git.eeqj.de/sneak/AutistMask/issues/668).
// A token missing from both gets a line under it. The line says Blockscout's
// report of the user's balances is not used to name the token. While the
// setting is on, Blockscout's report of the user's holding is a source too, as
// before.
//
// Booted through the real popup entry point, as the approval window or as a
// popup reopened onto SuccessTx, WaitTx or ErrorTx. The vault is mocked so that
// no password has to be hashed: the stored secret decrypts to the test key
// below.
jest.mock("../src/shared/vault", () => ({
decryptWithPassword: jest.fn(),
encryptWithPassword: jest.fn(),
}));
const { Interface, Wallet } = require("ethers");
const {
bootPopup,
cleanupPopup,
unversionedValidProfile,
} = require("./support/popupBoot");
// A published test key, never used for real funds.
const SIGNER_KEY =
"0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d";
const signer = new Wallet(SIGNER_KEY);
const ORIGIN = "https://dapp.example";
const RECIPIENT = "0x2222222222222222222222222222222222222222";
const TX_HASH = "0x" + "ab".repeat(32);
// Outside the bundled list, and not tracked.
const TOKEN = "0xE2E0000000000000000000000000000000000E2e";
// In the bundled list, at 6 decimals.
const USDC = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
const LINE =
'Blockscout\'s report of your balances is not used to name this token, because "Use Blockscout" is off in Settings.';
// TOKEN as Blockscout reports the user's holding of it.
const TOKEN_ROW = {
address: TOKEN,
name: "Novel",
symbol: "NOVEL",
decimals: "6",
balance: "5000.0",
holders: 5000,
};
// A transfer of 5,000 of a 6-decimal token to RECIPIENT.
const TRANSFER_DATA = new Interface([
"function transfer(address to, uint256 amount)",
]).encodeFunctionData("transfer", [RECIPIENT, 5000000000n]);
// An EIP-2612 permit letting RECIPIENT take 5,000 of TOKEN.
const PERMIT = {
types: {
EIP712Domain: [
{ name: "name", type: "string" },
{ name: "chainId", type: "uint256" },
{ name: "verifyingContract", type: "address" },
],
Permit: [
{ name: "owner", type: "address" },
{ name: "spender", type: "address" },
{ name: "value", type: "uint256" },
{ name: "nonce", type: "uint256" },
{ name: "deadline", type: "uint256" },
],
},
primaryType: "Permit",
domain: { name: "Novel", chainId: 1, verifyingContract: TOKEN },
message: {
owner: signer.address,
spender: RECIPIENT,
value: "5000000000",
nonce: "0",
deadline: "1790000000",
},
};
// The stored profile: the user's one address holds `tokenBalances`.
function profile(useBlockscout, tokenBalances, extra) {
return unversionedValidProfile({
useBlockscout,
wallets: [
{
type: "key",
name: "Wallet 1",
encryptedSecret: "encrypted-key",
addresses: [
{
address: signer.address,
balance: "1.0",
tokenBalances,
},
],
},
],
activeAddress: signer.address,
allowedSites: { [signer.address]: [ORIGIN] },
...extra,
});
}
// The approval window for the site's request. The request is a transfer sent to
// `token`, or a signature request when `signParams` is given. The background
// answers the signed transaction with `txResponse`.
function bootApproval(stored, { token = TOKEN, signParams, txResponse } = {}) {
return bootPopup(stored, {
search: "?approval=approval-1",
runtime: {
connect: () => ({ postMessage: () => {} }),
sendMessage: (msg, reply) => {
if (msg.type === "AUTISTMASK_GET_APPROVAL") {
reply({
type: signParams ? "sign" : "tx",
origin: ORIGIN,
isPhishingDomain: false,
approvedFrom: signer.address,
signParams,
approvedTx: {
type: 2,
from: signer.address,
chainId: "0x1",
nonce: "0x7",
gasLimit: "0x30d40",
maxPriorityFeePerGas: "0x3b9aca00",
maxFeePerGas: "0x77359400",
to: token,
value: "0x0",
data: TRANSFER_DATA,
accessList: [],
},
});
} else if (msg.type === "AUTISTMASK_TX_RESPONSE") {
reply(txResponse);
} else {
reply(undefined);
}
},
},
});
}
beforeEach(() => {
// The page logs its failed RPC reads; the stub node in popupBoot.js
// answers none.
jest.spyOn(console, "error").mockImplementation(() => {});
});
afterEach(() => {
cleanupPopup();
jest.restoreAllMocks();
});
describe("TxApproval", () => {
test("has the line under a token it cannot name while Use Blockscout is off", async () => {
const page = await bootApproval(profile(false, []));
const details = page.node("approve-tx-decoded-details").innerHTML;
expect(details).toContain("Unknown token");
expect(details).toContain(LINE);
expect(details).toContain("5000000000 base units (decimals unknown)");
cleanupPopup();
// The bundled list names USDC, so there is nothing to say.
const bundled = await bootApproval(profile(false, []), {
token: USDC,
});
expect(
bundled.node("approve-tx-decoded-details").innerHTML,
).not.toContain(LINE);
cleanupPopup();
const on = await bootApproval(profile(true, [TOKEN_ROW]));
const named = on.node("approve-tx-decoded-details").innerHTML;
expect(named).toContain("5000.0000 NOVEL");
expect(named).not.toContain(LINE);
});
test("names nothing from a Blockscout entry still in the balances while Use Blockscout is off", async () => {
const page = await bootApproval(profile(false, [TOKEN_ROW]));
const details = page.node("approve-tx-decoded-details").innerHTML;
expect(details).not.toContain("NOVEL");
expect(details).toContain("Unknown token");
expect(details).toContain(LINE);
});
test.each([
["WaitTx", { txHash: TX_HASH }, "wait-tx"],
[
"ErrorTx",
{ error: "The transaction could not be sent.", retryable: false },
"error-tx",
],
])(
"%s after it says so under the amount while Use Blockscout is off",
async (_name, txResponse, view) => {
const page = await bootApproval(profile(false, []), {
txResponse,
});
const { decryptWithPassword } = require("../src/shared/vault");
decryptWithPassword.mockResolvedValue(SIGNER_KEY);
page.node("approve-tx-password").value = "any password";
await page.click("btn-approve-tx");
expect(page.visibleViews()).toEqual([view]);
expect(page.node(view + "-token-note").innerHTML).toBe(
`<div class="text-xs text-muted">${LINE}</div>`,
);
},
);
});
test("SuccessTx says so under the decoded token while Use Blockscout is off", async () => {
const page = await bootPopup(
profile(false, [], {
currentView: "success-tx",
viewStack: ["main"],
viewData: {
amount: "5000000000 base units (decimals unknown)",
symbol: "?",
to: RECIPIENT,
hash: TX_HASH,
blockNumber: 21000000,
chainId: "0x1",
decoded: {
name: "Token Transfer",
description: "Transfer ERC-20 token",
details: [
{
label: "Token",
value: TOKEN,
address: TOKEN,
isToken: true,
},
],
},
},
}),
);
expect(page.visibleViews()).toEqual(["success-tx"]);
const decoded = page.node("success-tx-decoded").innerHTML;
expect(decoded).toContain("Unknown token");
expect(decoded).toContain(LINE);
});
test.each([
[
"wait-tx",
{
pendingWait: {
hash: TX_HASH,
txInfo: {
to: RECIPIENT,
amount: "1",
token: 42,
chainId: "0x1",
},
broadcastTime: Date.now(),
},
},
],
[
"error-tx",
{
amount: "1",
symbol: "?",
token: 42,
to: RECIPIENT,
hash: TX_HASH,
message: "The transaction failed.",
chainId: "0x1",
},
],
])(
"a popup reopened onto %s shows no line for a stored token that is not text",
async (view, viewData) => {
const page = await bootPopup(
profile(false, [], {
currentView: view,
viewStack: ["main"],
viewData,
}),
);
expect(page.pageErrors).toEqual([]);
expect(page.visibleViews()).toEqual([view]);
expect(page.node(view + "-token-note").innerHTML).toBe("");
},
);
test("SignApproval says so under a permit's token while Use Blockscout is off", async () => {
const signParams = {
method: "eth_signTypedData_v4",
typedData: JSON.stringify(PERMIT),
from: signer.address,
};
const page = await bootApproval(profile(false, []), { signParams });
const message = page.node("approve-sign-message").innerHTML;
expect(message).toContain("Unknown token");
expect(message).toContain(LINE);
cleanupPopup();
const on = await bootApproval(profile(true, [TOKEN_ROW]), { signParams });
const named = on.node("approve-sign-message").innerHTML;
expect(named).toContain("5000.0000 NOVEL");
expect(named).not.toContain(LINE);
});
+134
View File
@@ -12,6 +12,7 @@ const {
cleanupPopup, cleanupPopup,
settle, settle,
unversionedValidProfile, unversionedValidProfile,
ADDRESS,
} = require("./support/popupBoot"); } = require("./support/popupBoot");
afterEach(cleanupPopup); afterEach(cleanupPopup);
@@ -174,3 +175,136 @@ test("a connection prompt in the toolbar popup leaves the browser window alone",
expect(windows.updates).toEqual([]); expect(windows.updates).toEqual([]);
expect(env.pageErrors).toEqual([]); expect(env.pageErrors).toEqual([]);
}); });
// Each row holds a transaction or signature approval as the background
// describes it, plus the element ids of the screen that shows it. `refusal` is
// the message the background refuses a Reject with.
const TX_AND_SIGN_APPROVALS = [
{
kind: "transaction",
view: "approve-tx",
reject: "btn-reject-tx",
error: "approve-tx-error",
type: "AUTISTMASK_TX_RESPONSE",
refusal: "This transaction is already being sent.",
approval: {
type: "tx",
approvedFrom: ADDRESS,
approvedTx: {
chainId: 1,
to: ADDRESS,
value: "0",
data: "0x",
gasLimit: "21000",
maxFeePerGas: "1000000000",
maxPriorityFeePerGas: "1000000000",
nonce: 0,
},
},
},
{
kind: "signature",
view: "approve-sign",
reject: "btn-reject-sign",
error: "approve-sign-error",
type: "AUTISTMASK_SIGN_RESPONSE",
refusal: "This request is already being signed.",
approval: {
type: "sign",
approvedFrom: ADDRESS,
signParams: {
method: "personal_sign",
message: "0x48656c6c6f",
from: ADDRESS,
},
},
},
];
// A closed transaction or signature window leaves its request pending
// (https://git.eeqj.de/sneak/AutistMask/issues/673). So Reject closes the
// window only once the background has the rejection. A message sent as the
// window closes can be lost, and the request would stay pending although the
// user rejected it.
test.each(TX_AND_SIGN_APPROVALS)(
"Reject on a $kind approval closes the window only once the background has answered",
async ({ view, reject, type, approval }) => {
let describeApproval = null;
let answerReject = null;
const sent = [];
const env = await bootPopup(unversionedValidProfile(), {
search: "?approval=approval-1",
runtime: {
connect: () => ({ postMessage: () => {} }),
sendMessage: (msg, reply) => {
if (msg.type === "AUTISTMASK_GET_APPROVAL") {
describeApproval = reply;
}
if (msg.type === type) {
sent.push(msg);
answerReject = reply;
}
},
},
});
describeApproval({
...approval,
origin: "https://dapp.example",
isPhishingDomain: false,
});
await settle();
expect(env.visibleViews()).toEqual([view]);
const close = jest.fn();
globalThis.window.close = close;
const clicked = env.click(reject);
await settle();
expect(sent).toEqual([{ type, id: "approval-1", approved: false }]);
expect(close).not.toHaveBeenCalled();
answerReject(null);
await clicked;
expect(close).toHaveBeenCalledTimes(1);
expect(env.pageErrors).toEqual([]);
},
);
// After Confirm or Sign, the background refuses a Reject while the transaction
// is being sent or the signature checked. The request is not rejected then, so
// the window stays open and shows the background's message.
test.each(TX_AND_SIGN_APPROVALS)(
"Reject on a $kind approval that the background refuses shows the background's message and keeps the window open",
async ({ view, reject, error, type, refusal, approval }) => {
let describeApproval = null;
let answerReject = null;
const env = await bootPopup(unversionedValidProfile(), {
search: "?approval=approval-1",
runtime: {
connect: () => ({ postMessage: () => {} }),
sendMessage: (msg, reply) => {
if (msg.type === "AUTISTMASK_GET_APPROVAL") {
describeApproval = reply;
}
if (msg.type === type) answerReject = reply;
},
},
});
describeApproval({
...approval,
origin: "https://dapp.example",
isPhishingDomain: false,
});
await settle();
const close = jest.fn();
globalThis.window.close = close;
const clicked = env.click(reject);
await settle();
answerReject({ error: refusal, retryable: false });
await clicked;
expect(close).not.toHaveBeenCalled();
expect(env.visibleViews()).toEqual([view]);
expect(env.text(error)).toBe(refusal);
expect(env.pageErrors).toEqual([]);
},
);
+294 -47
View File
@@ -241,10 +241,11 @@ function loadBackground(options) {
let connectListener = null; let connectListener = null;
const created = []; const created = [];
const removed = []; const removed = [];
// Every URL the background put on the browser action. A site approval // Every URL the background put on the browser action. When a test gives
// raised through action.openPopup() opens no window at all, so this is // the URL the action holds before the worker starts, that URL comes
// the only place its id appears. // first. A site approval raised through action.openPopup() opens no
const actionPopups = []; // window at all, so this is the only place its id appears.
const actionPopups = opts.toolbarPopup ? [opts.toolbarPopup] : [];
const openPopup = jest.fn(() => Promise.resolve()); const openPopup = jest.fn(() => Promise.resolve());
global.chrome = { global.chrome = {
@@ -774,10 +775,9 @@ describe("one transaction approval at a time", () => {
// The user closes an approval window that looks hung while the attempt // The user closes an approval window that looks hung while the attempt
// behind it is still running, and that attempt then fails in a way that // behind it is still running, and that attempt then fails in a way that
// would normally leave the approval standing for a retry. There is no // leaves the approval standing for a retry. The toolbar popup opens it, so
// window left to retry in, so leaving it standing answers the requesting // the user can still retry it, and answering it frees the slot.
// 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 retried from the toolbar popup, 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();
@@ -808,11 +808,28 @@ describe("one transaction approval at a time", () => {
stalled.resolve(); stalled.resolve();
await settle(); await settle();
expect(first.result()).toEqual({ expect(first.result()).toBeNull();
error: { code: 4001, message: "User rejected the request." }, expect(bg.actionPopups[bg.actionPopups.length - 1]).toBe(
}); "src/popup/index.html?approval=" + first.id(),
);
bg.setStateReadHook(null); bg.setStateReadHook(null);
bg.broadcastTransaction.mockResolvedValue({ hash: "0xfeed" });
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: first.id(),
approved: true,
rawSignedTx: await signedAtNonce(NONCE),
},
{ url: bg.fromPopup.url },
);
await settle();
expect(first.result()).toEqual({ result: "0xfeed" });
expect(bg.actionPopups[bg.actionPopups.length - 1]).toBe(
"src/popup/index.html",
);
const second = bg.requestTx(); const second = bg.requestTx();
await settle(); await settle();
expect(second.result()).toBeNull(); expect(second.result()).toBeNull();
@@ -853,8 +870,10 @@ describe("one transaction approval at a time", () => {
const first = bg.requestTx(); const first = bg.requestTx();
await settle(); await settle();
// The user closes the approval window, which rejects it. bg.send(
bg.closeWindow(1); { type: "AUTISTMASK_TX_RESPONSE", id: first.id(), approved: false },
{ url: bg.fromPopup.url },
);
await settle(); await settle();
expect(first.result()).toEqual({ expect(first.result()).toEqual({
error: { code: 4001, message: "User rejected the request." }, error: { code: 4001, message: "User rejected the request." },
@@ -897,7 +916,7 @@ describe("the worker keeps running while an approval is pending", () => {
try { try {
const bg = loadBackground(); const bg = loadBackground();
const calls = global.chrome.runtime.getPlatformInfo; const calls = global.chrome.runtime.getPlatformInfo;
bg.requestTx(); const pending = bg.requestTx();
await settle(); await settle();
expect(startTimer).toHaveBeenCalledTimes(1); expect(startTimer).toHaveBeenCalledTimes(1);
expect(startTimer.mock.calls[0][1]).toBe(20000); expect(startTimer.mock.calls[0][1]).toBe(20000);
@@ -906,11 +925,23 @@ describe("the worker keeps running while an approval is pending", () => {
tick(); tick();
expect(calls).toHaveBeenCalledTimes(1); expect(calls).toHaveBeenCalledTimes(1);
// The user closes the approval window, which rejects it. // A closed window leaves the approval pending, so the calls go on.
bg.closeWindow(1); bg.closeWindow(1);
await settle(); await settle();
tick(); tick();
expect(calls).toHaveBeenCalledTimes(1); expect(calls).toHaveBeenCalledTimes(2);
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: pending.id(),
approved: false,
},
{ url: bg.fromPopup.url },
);
await settle();
tick();
expect(calls).toHaveBeenCalledTimes(2);
expect(stopTimer).toHaveBeenCalledWith(1); expect(stopTimer).toHaveBeenCalledWith(1);
} finally { } finally {
startTimer.mockRestore(); startTimer.mockRestore();
@@ -1841,6 +1872,237 @@ describe("the interlock releases a failed attempt", () => {
}); });
}); });
// A transaction or signature approval stays pending when its window closes.
// The browser can close that window when the user clicks away from it, for
// example to copy the password from a password manager. The toolbar popup then
// opens the approval, and the user answers it there
// (https://git.eeqj.de/sneak/AutistMask/issues/673).
describe("a closed approval window leaves the request pending", () => {
// The URL the toolbar popup opens now.
function toolbarPopup(bg) {
return bg.actionPopups[bg.actionPopups.length - 1];
}
// The timer that keeps the worker running while an approval is pending is
// stubbed, so no test here leaves that timer running when it ends.
let keepRunningTimer;
beforeEach(() => {
keepRunningTimer = jest
.spyOn(global, "setInterval")
.mockImplementation(() => 1);
});
afterEach(() => {
keepRunningTimer.mockRestore();
});
test("the toolbar popup opens a closed transaction approval, and approving it there sends", async () => {
const bg = loadBackground();
const pending = bg.requestTx();
await settle();
bg.closeWindow(1);
await settle();
expect(pending.result()).toBeNull();
expect(toolbarPopup(bg)).toBe(
"src/popup/index.html?approval=" + pending.id(),
);
bg.broadcastTransaction.mockResolvedValue({ hash: "0xfeed" });
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: pending.id(),
approved: true,
rawSignedTx: await signedAtNonce(NONCE),
},
{ url: bg.fromPopup.url },
);
await settle();
expect(pending.result()).toEqual({ result: "0xfeed" });
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
test("Reject in the toolbar popup answers 4001, and the toolbar popup opens the wallet again", async () => {
const bg = loadBackground();
const pending = bg.requestSign();
await settle();
bg.closeWindow(1);
await settle();
expect(pending.result()).toBeNull();
expect(toolbarPopup(bg)).toBe(
"src/popup/index.html?approval=" + pending.id(),
);
const reject = bg.send(
{
type: "AUTISTMASK_SIGN_RESPONSE",
id: pending.id(),
approved: false,
},
{ url: bg.fromPopup.url },
);
await settle();
expect(pending.result()).toEqual({
error: { code: 4001, message: "User rejected the request." },
});
// The popup closes its window only once this answer arrives.
expect(reject.sendResponse).toHaveBeenCalledWith(null);
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
test("with two closed, the toolbar popup opens the older one first, then the other", async () => {
const bg = loadBackground();
const sign = bg.requestSign();
await settle();
const signId = sign.id();
const tx = bg.requestTx();
await settle();
// The signature request is in window 1 and the transaction in window
// 2. The newer window is closed first.
bg.closeWindow(2);
bg.closeWindow(1);
await settle();
expect(toolbarPopup(bg)).toBe(
"src/popup/index.html?approval=" + signId,
);
bg.send(
{ type: "AUTISTMASK_SIGN_RESPONSE", id: signId, approved: false },
{ url: bg.fromPopup.url },
);
await settle();
expect(toolbarPopup(bg)).toBe(
"src/popup/index.html?approval=" + tx.id(),
);
const reject = bg.send(
{ type: "AUTISTMASK_TX_RESPONSE", id: tx.id(), approved: false },
{ url: bg.fromPopup.url },
);
await settle();
expect(tx.result()).toEqual({
error: { code: 4001, message: "User rejected the request." },
});
expect(reject.sendResponse).toHaveBeenCalledWith(null);
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
// The user can close the window while the attempt after Confirm runs. That
// attempt answers the request, so meanwhile the toolbar popup opens the
// wallet. Opened from the toolbar, the approval would look unanswered.
test("when the window closes during an attempt that sends, the toolbar popup keeps opening the wallet", async () => {
const bg = loadBackground();
const pending = bg.requestTx();
await settle();
const inFlight = deferred();
bg.broadcastTransaction.mockReturnValue(inFlight.promise);
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: pending.id(),
approved: true,
rawSignedTx: await signedAtNonce(NONCE),
},
{ url: bg.fromPopup.url },
);
await settle();
bg.closeWindow(1);
await settle();
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
inFlight.resolve({ hash: "0xfeed" });
await settle();
expect(pending.result()).toEqual({ result: "0xfeed" });
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
test("when the window closes during an attempt that fails retryably, the toolbar popup opens the wallet until the attempt ends, then the approval", async () => {
const stalled = deferred();
const bg = loadBackground();
const pending = bg.requestTx();
await settle();
bg.setStateReadHook(async () => {
await stalled.promise;
throw new Error("The wallet data could not be read.");
});
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: pending.id(),
approved: true,
rawSignedTx: await signedAtNonce(NONCE),
},
{ url: bg.fromPopup.url },
);
await settle();
bg.closeWindow(1);
await settle();
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
stalled.resolve();
await settle();
expect(pending.result()).toBeNull();
expect(toolbarPopup(bg)).toBe(
"src/popup/index.html?approval=" + pending.id(),
);
// A retry from the toolbar popup holds the approval again, so the
// toolbar popup opens the wallet while that retry runs.
bg.setStateReadHook(null);
const inFlight = deferred();
bg.broadcastTransaction.mockReturnValue(inFlight.promise);
bg.send(
{
type: "AUTISTMASK_TX_RESPONSE",
id: pending.id(),
approved: true,
rawSignedTx: await signedAtNonce(NONCE),
},
{ url: bg.fromPopup.url },
);
await settle();
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
inFlight.resolve({ hash: "0xfeed" });
await settle();
expect(pending.result()).toEqual({ result: "0xfeed" });
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
test("an address switch still rejects a closed approval", async () => {
const bg = loadBackground();
const pending = bg.requestTx();
await settle();
bg.closeWindow(1);
await settle();
expect(pending.result()).toBeNull();
bg.send(
{ type: "AUTISTMASK_ACTIVE_CHANGED" },
{ url: bg.fromPopup.url },
);
await settle();
expect(pending.result()).toEqual({
error: { code: 4001, message: "User rejected the request." },
});
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
// The worker can stop while an approval waits with its window closed. The
// approval is lost with the worker, but the toolbar popup keeps its URL.
// The next worker points the toolbar popup back at the wallet.
test("a worker that starts points the toolbar popup back at the wallet", () => {
const bg = loadBackground({
toolbarPopup: "src/popup/index.html?approval=lost-approval",
});
expect(toolbarPopup(bg)).toBe("src/popup/index.html");
});
});
// The claim is what makes one approval one broadcast, so it has to hold // The claim is what makes one approval one broadcast, so it has to hold
// against everything else that retires an approval, not just against a second // against everything else that retires an approval, not just against a second
// AUTISTMASK_TX_RESPONSE. Each of these paths used to resolve the waiting // AUTISTMASK_TX_RESPONSE. Each of these paths used to resolve the waiting
@@ -1961,20 +2223,6 @@ describe("a claimed approval outlives every other retirement path", () => {
}); });
// The refusals above must not cost the rejection its ordinary meaning. // The refusals above must not cost the rejection its ordinary meaning.
test("with no attempt running, closing the window still rejects", async () => {
const bg = loadBackground();
const pending = bg.requestTx();
await settle();
bg.closeWindow(1);
await settle();
expect(pending.result()).toEqual({
error: { code: 4001, message: "User rejected the request." },
});
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
});
test("with no attempt running, an active-address switch still rejects and closes", async () => { test("with no attempt running, an active-address switch still rejects and closes", async () => {
const bg = loadBackground(); const bg = loadBackground();
const pending = bg.requestTx(); const pending = bg.requestTx();
@@ -2584,15 +2832,12 @@ describe("a site connection decided as the popup closes", () => {
}); });
}); });
// The `isSite &&` half of that skip, which is what keeps it from reaching // That skip must not reach a tx or sign approval. The popup connects its
// a tx or sign approval. The popup connects its port in show() before it // port in show() before it knows the approval's type, and the background
// knows the approval's type, and the background sets portConnected without // sets portConnected without looking at the type either, so a tx approval
// looking at the type either, so a tx approval in the fallback window // carries the flag too. If the window event skipped it, windowClosed would
// carries the flag too. Without the conjunct the window event would skip // never be set, and the toolbar popup would never open the approval.
// it, windowClosed would never be set, releaseApproval() would never settle test("a tx window closed with the port connected is still opened by the toolbar popup", async () => {
// it, and the page would hang — the #271 regression this guard is written
// around.
test("a tx window closed with the port connected still rejects", async () => {
const bg = loadBackground(); const bg = loadBackground();
const pending = bg.requestTx(); const pending = bg.requestTx();
await settle(); await settle();
@@ -2600,9 +2845,10 @@ describe("a site connection decided as the popup closes", () => {
await settle(); await settle();
bg.closeWindow(1); bg.closeWindow(1);
await settle(); await settle();
expect(pending.result()).toEqual({ expect(pending.result()).toBeNull();
error: { code: 4001, message: "User rejected the request." }, expect(bg.actionPopups[bg.actionPopups.length - 1]).toBe(
}); "src/popup/index.html?approval=" + pending.id(),
);
}); });
}); });
@@ -2994,13 +3240,14 @@ describe("where an approval window opens", () => {
expect(bg.created[1].left).toBeUndefined(); expect(bg.created[1].left).toBeUndefined();
expect(bg.created[1].top).toBeUndefined(); expect(bg.created[1].top).toBeUndefined();
// The request waits on the second window rather than failing: // The request waits on the second window rather than failing. Once
// closing that window is refusing the prompt. // that window closes, the toolbar popup opens the request.
expect(sign.result()).toBeNull(); expect(sign.result()).toBeNull();
bg.closeWindow(2); bg.closeWindow(2);
await settle(); await settle();
expect(sign.result()).toEqual({ expect(sign.result()).toBeNull();
error: { code: 4001, message: "User rejected the request." }, expect(bg.actionPopups[bg.actionPopups.length - 1]).toBe(
}); "src/popup/index.html?approval=" + sign.id(),
);
}); });
}); });
+54 -8
View File
@@ -142,6 +142,8 @@ function loadWorker(networkId, opts) {
}, },
refreshBalances: refreshBalances:
options.refreshBalances || jest.fn(async () => undefined), options.refreshBalances || jest.fn(async () => undefined),
dropUntrackedTokens: jest.requireActual("../src/shared/balances")
.dropUntrackedTokens,
})); }));
jest.doMock("../src/shared/phishingDomains", () => ({ jest.doMock("../src/shared/phishingDomains", () => ({
isPhishingDomain: () => false, isPhishingDomain: () => false,
@@ -410,14 +412,7 @@ describe("a balance refresh under a network switch", () => {
const ranOn = []; const ranOn = [];
const bg = loadWorker("sepolia", { const bg = loadWorker("sepolia", {
refreshBalances: async ( refreshBalances: async (wallets, rpcUrl, explorer, tokens, id) => {
wallets,
rpcUrl,
explorer,
useBlockscout,
tokens,
id,
) => {
ranOn.push(id); ranOn.push(id);
reachedNetwork.resolve(); reachedNetwork.resolve();
await roundTrip.promise; await roundTrip.promise;
@@ -450,3 +445,54 @@ describe("a balance refresh under a network switch", () => {
); );
}); });
}); });
describe("a balance refresh under a change of Use Blockscout", () => {
// Turning "Use Blockscout" off drops the tokens the user has not tracked
// (src/popup/views/settings.js). Blockscout may have answered a refresh
// just before. That refresh still saves its balances when it returns, but
// not those tokens. The same refresh in the popup is in
// tests/blockscoutEtherscanSettings.test.js.
test("a refresh that returns after Use Blockscout was turned off saves its balances without the untracked token", async () => {
const roundTrip = deferred();
const started = deferred();
const bg = loadWorker("mainnet", {
refreshBalances: async (wallets) => {
started.resolve();
await roundTrip.promise;
wallets[0].addresses[0].balance = "7.0";
wallets[0].addresses[0].tokenBalances = [
{
address: "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
name: "Test Token",
symbol: "TST",
decimals: 18,
balance: "5.0",
holders: 50000,
},
];
},
});
global.chrome.storage.write("autistmask", {
...bg.persisted(),
useBlockscout: true,
});
const refresh = bg.fireBalanceAlarm();
await started.promise;
// The user unticks "Use Blockscout" in Settings while the round trip
// is out.
global.chrome.storage.write("autistmask", {
...bg.persisted(),
useBlockscout: false,
});
roundTrip.resolve();
await refresh;
const after = bg.persisted();
expect(after.wallets[0].addresses[0].balance).toBe("7.0");
expect(after.wallets[0].addresses[0].tokenBalances).toEqual([]);
});
});
+6 -1
View File
@@ -24,6 +24,12 @@ const TRACKED = {
decimals: 6, decimals: 6,
}; };
// Blockscout is asked only while the stored "Use Blockscout" is on.
const { makeStorageStub } = require("./support/storageStub");
globalThis.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
};
const realFetch = globalThis.fetch; const realFetch = globalThis.fetch;
let logged; let logged;
@@ -54,7 +60,6 @@ function refresh(signal) {
wallets, wallets,
RPC_URL, RPC_URL,
EXPLORER_URL, EXPLORER_URL,
true,
[TRACKED], [TRACKED],
"mainnet", "mainnet",
signal, signal,
+52 -1
View File
@@ -6,6 +6,10 @@
// approved a site's request, which changes only the stored record. Driven // approved a site's request, which changes only the stored record. Driven
// through the real popup over a stored profile on Ethereum Mainnet. The same // through the real popup over a stored profile on Ethereum Mainnet. The same
// refresh in the background is in tests/backgroundStateIsolation.test.js. // refresh in the background is in tests/backgroundStateIsolation.test.js.
//
// The last test covers a balance refresh by the background that is saved while
// a switch in Settings waits for the lock
// (https://git.eeqj.de/sneak/AutistMask/issues/653).
const { const {
bootPopup, bootPopup,
@@ -91,7 +95,7 @@ test("a refresh that returns after a switch in Settings writes nothing, and the
await page.tick(); await page.tick();
expect(refreshBalances.mock.lastCall[5]).toBe("sepolia"); expect(refreshBalances.mock.lastCall[4]).toBe("sepolia");
expect(page.storage.read("autistmask").lastBalanceRefresh).toBeGreaterThan( expect(page.storage.read("autistmask").lastBalanceRefresh).toBeGreaterThan(
0, 0,
); );
@@ -159,3 +163,50 @@ test("a refresh that returns after the background switched the network writes no
expectNothingStored(page); expectNothingStored(page);
}); });
// The background's refresh saves Ethereum Mainnet's balances while the switch
// in Settings waits for the lock. This page last saved a balance of "0" and no
// token balances, the values that the switch sets.
test("a background refresh saved while a switch in Settings waits for the lock leaves none of its balances stored", async () => {
const profile = unversionedValidProfile();
profile.wallets[0].addresses[0].balance = "0";
const page = await bootPopup(profile);
expect(page.pageErrors).toEqual([]);
const background = require("../src/background/state");
await page.click("btn-settings");
// The background takes the lock first and holds it until the test calls
// `letGo()`. It then saves balances as backgroundRefresh() in
// src/background/index.js does.
let letGo;
const refreshSave = background.updateState(async (fresh) => {
await new Promise((resolve) => {
letGo = resolve;
});
fresh.wallets[0].addresses[0].balance = "7.0";
fresh.wallets[0].addresses[0].tokenBalances = [
{
address: TOKEN_ADDRESS,
name: "Test Token",
symbol: "TST",
decimals: 18,
balance: "5.0",
holders: null,
},
];
fresh.lastBalanceRefresh = Date.now();
});
await page.settle();
const select = page.node("settings-network");
select.value = "sepolia";
const switching = Promise.all(select.listeners.change.map((fn) => fn()));
await page.settle();
letGo();
await refreshSave;
await switching;
await page.settle();
expectNothingStored(page);
});
+506 -128
View File
@@ -1,17 +1,26 @@
// Blockscout and Etherscan are sent none of the user's data until the user // Blockscout and Etherscan are sent none of the user's data until the user
// turns them on (https://git.eeqj.de/sneak/AutistMask/issues/668). A new // turns on a setting for each
// profile has "Use Blockscout" and "Check recipients on Etherscan" both off. // (https://git.eeqj.de/sneak/AutistMask/issues/668). A new profile has "Use
// Each request to either service is skipped where it is made while its setting // Blockscout" and "Check recipients on Etherscan" both off. While a setting is
// is off, and made while it is on; the popup and the background hand the // off, no request sends its service the user's data.
// stored setting to the code that makes the request. The one exception is the //
// endpoint check Settings makes when the user presses "Save" beside the // One request still reaches Blockscout while "Use Blockscout" is off: the check
// Blockscout URL. It asks only for `/stats` and carries no user data; it is // behind "Save" beside the Blockscout URL in Settings. That check asks the URL
// made whether or not the setting is on. // only for `/stats` and sends none of the user's data.
//
// Before any other request to Blockscout or Etherscan, the wallet reads that
// service's setting from storage, not the page's copy. The wallet reads the
// setting again when the answer lands. So a change saved by another page
// applies at once. An open page also takes such a change and draws its screens
// again.
//
// Only Blockscout reports the tokens the user has not tracked. While "Use
// Blockscout" is off, no address keeps them and no screen lists them.
// //
// The functions that make the requests are driven directly, against a fetch() // The functions that make the requests are driven directly, against a fetch()
// that records every URL it is asked for. The screens are driven through the // that records every URL it is asked for. The screens are driven through the
// real popup over a stored profile (tests/support/popupBoot.js), whose fetch() // real popup over a stored profile (tests/support/popupBoot.js). The fetch()
// stub records the same way. // stub in popupBoot.js records the same way.
"use strict"; "use strict";
@@ -21,6 +30,7 @@ const {
cleanupPopup, cleanupPopup,
unversionedValidProfile, unversionedValidProfile,
ADDRESS, ADDRESS,
TOKEN_ADDRESS,
} = require("./support/popupBoot"); } = require("./support/popupBoot");
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
const { const {
@@ -33,6 +43,7 @@ const {
} = require("../src/shared/balances"); } = require("../src/shared/balances");
const { fetchRecentTransactions } = require("../src/shared/transactions"); const { fetchRecentTransactions } = require("../src/shared/transactions");
const { getFullWarnings } = require("../src/shared/addressWarnings"); const { getFullWarnings } = require("../src/shared/addressWarnings");
const { checkEtherscanLabel } = require("../src/shared/etherscanLabels");
const { HISTORY_OFF_TEXT, escapeHtml } = require("../src/popup/views/helpers"); const { HISTORY_OFF_TEXT, escapeHtml } = require("../src/popup/views/helpers");
const RPC_URL = "https://rpc.example.invalid"; const RPC_URL = "https://rpc.example.invalid";
@@ -54,6 +65,25 @@ const USDC_ROW = {
}, },
}; };
// A transfer of 1 ETH from RECIPIENT to ADDRESS, as Blockscout lists it in
// ADDRESS's history.
const HISTORY_ITEM = {
hash: TX_HASH,
block_number: 21000000,
timestamp: "2026-02-27T12:00:00.000Z",
from: { hash: RECIPIENT },
to: { hash: ADDRESS, is_contract: false },
value: "1000000000000000000",
method: null,
status: "ok",
};
// Etherscan's page for RECIPIENT, which labels it a phishing address.
const PHISHING_PAGE =
"<html><head><title>Fake_Phishing1 | Address: " +
RECIPIENT +
" | Etherscan</title></head><body></body></html>";
const realFetch = globalThis.fetch; const realFetch = globalThis.fetch;
afterEach(() => { afterEach(() => {
@@ -81,36 +111,58 @@ describe("a new profile", () => {
}); });
describe("where each request is made", () => { describe("where each request is made", () => {
// Every URL fetch() was asked for, in order. // Every URL that fetch() was asked for, in order.
let asked; let asked;
// What Blockscout and Etherscan answer: USDC among ADDRESS's tokens,
// HISTORY_ITEM in its history, and PHISHING_PAGE for RECIPIENT.
function answer(url) {
return {
ok: true,
status: 200,
json: async () => {
if (url.endsWith("/token-balances")) return [USDC_ROW];
if (url.endsWith("/transactions")) {
return { items: [HISTORY_ITEM] };
}
return { items: [] };
},
text: async () => PHISHING_PAGE,
};
}
async function recordAndAnswer(url) {
asked.push(String(url));
return answer(String(url));
}
beforeEach(() => { beforeEach(() => {
asked = []; asked = [];
globalThis.fetch = jest.fn(async (url) => { globalThis.fetch = jest.fn(recordAndAnswer);
asked.push(String(url));
return {
ok: true,
status: 200,
json: async () =>
String(url).endsWith("/token-balances")
? [USDC_ROW]
: { items: [] },
text: async () => "<html><body></body></html>",
};
});
}); });
afterEach(() => { afterEach(() => {
globalThis.fetch = realFetch; globalThis.fetch = realFetch;
delete globalThis.chrome;
}); });
// Storage holds `profile` as the stored profile, or nothing when it is
// undefined.
function storing(profile) {
globalThis.chrome = {
storage: makeStorageStub(
profile === undefined ? {} : { autistmask: profile },
),
};
}
test("Blockscout's token balances are asked for only while Use Blockscout is on", async () => { test("Blockscout's token balances are asked for only while Use Blockscout is on", async () => {
expect( storing({ useBlockscout: false });
await fetchTokenBalances(ADDRESS, BLOCKSCOUT, false, []), expect(await fetchTokenBalances(ADDRESS, BLOCKSCOUT, [])).toEqual([]);
).toEqual([]);
expect(asked).toEqual([]); expect(asked).toEqual([]);
const rows = await fetchTokenBalances(ADDRESS, BLOCKSCOUT, true, []); storing({ useBlockscout: true });
const rows = await fetchTokenBalances(ADDRESS, BLOCKSCOUT, []);
expect(rows.map((row) => row.symbol)).toEqual(["USDC"]); expect(rows.map((row) => row.symbol)).toEqual(["USDC"]);
expect(asked).toEqual([ expect(asked).toEqual([
BLOCKSCOUT + "/addresses/" + ADDRESS + "/token-balances", BLOCKSCOUT + "/addresses/" + ADDRESS + "/token-balances",
@@ -118,12 +170,14 @@ describe("where each request is made", () => {
}); });
test("the transaction history is asked for only while Use Blockscout is on", async () => { test("the transaction history is asked for only while Use Blockscout is on", async () => {
storing({ useBlockscout: false });
expect( expect(
await fetchRecentTransactions(ADDRESS, BLOCKSCOUT, false, "0x1"), await fetchRecentTransactions(ADDRESS, BLOCKSCOUT, "0x1"),
).toEqual([]); ).toEqual([]);
expect(asked).toEqual([]); expect(asked).toEqual([]);
await fetchRecentTransactions(ADDRESS, BLOCKSCOUT, true, "0x1"); storing({ useBlockscout: true });
await fetchRecentTransactions(ADDRESS, BLOCKSCOUT, "0x1");
expect(asked.sort()).toEqual([ expect(asked.sort()).toEqual([
BLOCKSCOUT + BLOCKSCOUT +
"/addresses/" + "/addresses/" +
@@ -133,29 +187,91 @@ describe("where each request is made", () => {
]); ]);
}); });
test("the Etherscan label check is made only while Check recipients on Etherscan is on", async () => { test("the Etherscan label check is made only while the stored profile has Check recipients on Etherscan on", async () => {
const provider = { const provider = {
getCode: async () => "0x", getCode: async () => "0x",
getTransactionCount: async () => 1, getTransactionCount: async () => 1,
getBalance: async () => 0n, getBalance: async () => 0n,
}; };
await getFullWarnings(RECIPIENT, provider, { chainId: "0x1" }); const checkWith = async (profile) => {
await getFullWarnings(RECIPIENT, provider, { storing(profile);
chainId: "0x1", await getFullWarnings(RECIPIENT, provider, { chainId: "0x1" });
checkRecipientsOnEtherscan: false, };
});
await checkWith(undefined);
await checkWith({ checkRecipientsOnEtherscan: false });
// Only a stored true is on, as when the profile is loaded.
await checkWith({ checkRecipientsOnEtherscan: "true" });
await checkWith({ checkRecipientsOnEtherscan: 42 });
expect(asked).toEqual([]); expect(asked).toEqual([]);
await getFullWarnings(RECIPIENT, provider, { await checkWith({ checkRecipientsOnEtherscan: true });
chainId: "0x1",
checkRecipientsOnEtherscan: true,
});
expect(asked).toEqual(["https://etherscan.io/address/" + RECIPIENT]); expect(asked).toEqual(["https://etherscan.io/address/" + RECIPIENT]);
}); });
// Asks with `setting` on in storage. Once every request is out, storage
// holds `after` for the setting, as when the user changes it here or on
// another page. Only then does each request get its answer.
async function answeredAfter(setting, after, ask) {
storing({ [setting]: true });
let release;
const held = new Promise((resolve) => {
release = resolve;
});
let requested;
const out = new Promise((resolve) => {
requested = resolve;
});
globalThis.fetch = jest.fn(async (url) => {
requested();
await held;
return recordAndAnswer(url);
});
const result = ask();
await out;
globalThis.chrome.storage.write("autistmask", { [setting]: after });
release();
return result;
}
// One row per request, giving:
//
// - its name
// - the setting that gates it
// - how to make it
// - its answer while that setting is off
test.each([
[
"Blockscout's token balances",
"useBlockscout",
() => fetchTokenBalances(ADDRESS, BLOCKSCOUT, []),
[],
],
[
"the transaction history",
"useBlockscout",
() => fetchRecentTransactions(ADDRESS, BLOCKSCOUT, "0x1"),
[],
],
[
"the Etherscan label check",
"checkRecipientsOnEtherscan",
() => checkEtherscanLabel(RECIPIENT, "0x1"),
null,
],
])(
"%s keeps an answer that lands while its setting is on, and drops one that lands after it went off",
async (_what, setting, ask, dropped) => {
expect(await answeredAfter(setting, true, ask)).not.toEqual(
dropped,
);
expect(await answeredAfter(setting, false, ask)).toEqual(dropped);
},
);
describe("a balance refresh", () => { describe("a balance refresh", () => {
// The RPC endpoint answers every balance with zero, and every other // The RPC endpoint answers every balance with zero. The ENS reverse
// call, the ENS reverse lookup's, with no resolver. // lookup makes the only other calls, and it finds no resolver.
beforeEach(() => { beforeEach(() => {
FetchRequest.registerGetUrl(async (req) => { FetchRequest.registerGetUrl(async (req) => {
const body = JSON.parse(Buffer.from(req.body).toString("utf8")); const body = JSON.parse(Buffer.from(req.body).toString("utf8"));
@@ -180,8 +296,8 @@ describe("where each request is made", () => {
FetchRequest.registerGetUrl(FetchRequest.createGetUrlFunc()); FetchRequest.registerGetUrl(FetchRequest.createGetUrlFunc());
}); });
// An address that was refreshed while Use Blockscout was on, and holds // An address refreshed while "Use Blockscout" was on. It holds the USDC
// the USDC Blockscout reported then. // that Blockscout reported then.
function addressWithUsdc() { function addressWithUsdc() {
return { return {
address: ADDRESS, address: ADDRESS,
@@ -199,11 +315,11 @@ describe("where each request is made", () => {
} }
async function refresh(addr, useBlockscout) { async function refresh(addr, useBlockscout) {
storing({ useBlockscout });
await refreshBalances( await refreshBalances(
[{ addresses: [addr] }], [{ addresses: [addr] }],
RPC_URL, RPC_URL,
BLOCKSCOUT, BLOCKSCOUT,
useBlockscout,
[], [],
"mainnet", "mainnet",
); );
@@ -245,29 +361,6 @@ describe("the popup", () => {
jest.spyOn(console, "error").mockImplementation(() => {}); jest.spyOn(console, "error").mockImplementation(() => {});
}); });
test("hands its balance refresh and Home's history the stored Use Blockscout setting", async () => {
await bootPopup(unversionedValidProfile());
const {
refreshBalances: popupRefresh,
} = require("../src/shared/balances");
const {
fetchRecentTransactions: popupHistory,
} = require("../src/shared/transactions");
expect(popupRefresh.mock.calls[0][3]).toBe(false);
expect(popupHistory.mock.calls[0][2]).toBe(false);
cleanupPopup();
await bootPopup(unversionedValidProfile({ useBlockscout: true }));
const {
refreshBalances: onRefresh,
} = require("../src/shared/balances");
const {
fetchRecentTransactions: onHistory,
} = require("../src/shared/transactions");
expect(onRefresh.mock.calls[0][3]).toBe(true);
expect(onHistory.mock.calls[0][2]).toBe(true);
});
test("Home says why there is no history and only tracked tokens while Use Blockscout is off", async () => { test("Home says why there is no history and only tracked tokens while Use Blockscout is off", async () => {
const page = await bootPopup(unversionedValidProfile()); const page = await bootPopup(unversionedValidProfile());
expect(page.node("home-tx-list").innerHTML).toContain( expect(page.node("home-tx-list").innerHTML).toContain(
@@ -328,6 +421,51 @@ describe("the popup", () => {
expect(on.hidden("tx-detail-blockscout-note")).toBe(true); expect(on.hidden("tx-detail-blockscout-note")).toBe(true);
}); });
// Another page turns "Use Blockscout" off while TransactionDetail's request
// to Blockscout is out. This page draws TransactionDetail again with its
// line, and only then does Blockscout answer.
test("TransactionDetail shows nothing from an answer that lands after another page turned Use Blockscout off", async () => {
const page = await bootPopup(
onTransactionScreen({ useBlockscout: true }),
);
let release;
const held = new Promise((resolve) => {
release = resolve;
});
globalThis.fetch = jest.fn(async () => {
await held;
return {
ok: true,
status: 200,
json: async () => ({
block_number: 21000000,
fee: { value: "21000000000000" },
raw_input: "0x12345678",
method: "doSomething",
}),
};
});
require("../src/popup/views/transactionDetail").render();
await page.settle();
expect(fetched()).toEqual([BLOCKSCOUT + "/transactions/" + TX_HASH]);
await anotherPageAnnounces(page, { useBlockscout: false });
release();
await page.settle();
expect(page.visibleViews()).toEqual(["transaction"]);
expect(page.hidden("tx-detail-blockscout-note")).toBe(false);
for (const id of [
"tx-detail-block-section",
"tx-detail-network-section",
"tx-detail-calldata-section",
"tx-detail-rawdata-section",
]) {
expect(page.hidden(id)).toBe(true);
}
expect(fetched()).toHaveLength(1);
});
// The confirmation screen for a send of 0.1 ETH to RECIPIENT, as a // The confirmation screen for a send of 0.1 ETH to RECIPIENT, as a
// reopened popup draws it. // reopened popup draws it.
function onConfirmScreen(extra) { function onConfirmScreen(extra) {
@@ -367,10 +505,10 @@ describe("the popup", () => {
expect(on.hidden("confirm-etherscan-warning")).toBe(false); expect(on.hidden("confirm-etherscan-warning")).toBe(false);
}); });
// Ticks a checkbox on the page, as the user does. // Ticks or unticks a checkbox on the page, as the user does.
async function tick(page, id) { async function setBox(page, id, checked) {
const box = page.node(id); const box = page.node(id);
box.checked = true; box.checked = checked;
for (const fn of box.listeners.change) await fn(); for (const fn of box.listeners.change) await fn();
await page.settle(); await page.settle();
} }
@@ -383,9 +521,9 @@ describe("the popup", () => {
false, false,
); );
await tick(page, "welcome-use-blockscout"); await setBox(page, "welcome-use-blockscout", true);
expect(page.storage.read("autistmask").useBlockscout).toBe(true); expect(page.storage.read("autistmask").useBlockscout).toBe(true);
await tick(page, "welcome-check-recipients-on-etherscan"); await setBox(page, "welcome-check-recipients-on-etherscan", true);
expect(page.storage.read("autistmask").checkRecipientsOnEtherscan).toBe( expect(page.storage.read("autistmask").checkRecipientsOnEtherscan).toBe(
true, true,
); );
@@ -399,72 +537,312 @@ describe("the popup", () => {
page.node("settings-check-recipients-on-etherscan").checked, page.node("settings-check-recipients-on-etherscan").checked,
).toBe(false); ).toBe(false);
await tick(page, "settings-use-blockscout"); await setBox(page, "settings-use-blockscout", true);
expect(page.storage.read("autistmask").useBlockscout).toBe(true); expect(page.storage.read("autistmask").useBlockscout).toBe(true);
await tick(page, "settings-check-recipients-on-etherscan"); await setBox(page, "settings-check-recipients-on-etherscan", true);
expect(page.storage.read("autistmask").checkRecipientsOnEtherscan).toBe( expect(page.storage.read("autistmask").checkRecipientsOnEtherscan).toBe(
true, true,
); );
}); });
});
describe("the background", () => { // A token the user tracks, and an untracked one that Blockscout reported.
afterEach(() => { // Both are written in lower case, because the balance rows' and the
delete globalThis.chrome; // dropdown's token ids are compared in lower case below.
jest.dontMock("../src/shared/balances"); const TRACKED = "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
}); const UNTRACKED = TOKEN_ADDRESS.toLowerCase();
const SECOND_ADDRESS = "0x3333333333333333333333333333333333333333";
// Starts the background over `profile`, fires its balance alarm, and function tokenRow(address, symbol) {
// answers with the Use Blockscout setting its refresh was handed. return {
async function settingTheRefreshIsHanded(profile) { address,
jest.resetModules(); name: symbol,
let handed; symbol,
const called = new Promise((resolve) => { decimals: 18,
handed = resolve; balance: "5.0",
}); holders: 50000,
jest.doMock("../src/shared/balances", () => ({
getProvider: () => ({}),
refreshBalances: async (...args) => handed(args[3]),
}));
let onAlarm = null;
globalThis.chrome = {
storage: makeStorageStub({ autistmask: profile }),
alarms: {
create: () => {},
get: async () => undefined,
clear: async () => false,
onAlarm: {
addListener: (fn) => {
onAlarm = fn;
},
},
},
runtime: {
onMessage: { addListener: () => {} },
onConnect: { addListener: () => {} },
onInstalled: { addListener: () => {} },
onStartup: { addListener: () => {} },
getURL: (p) => "chrome-extension://test/" + p,
lastError: null,
},
windows: { onRemoved: { addListener: () => {} } },
tabs: { query: () => {}, sendMessage: () => {} },
action: { setPopup: () => {} },
}; };
require("../src/background/index");
const { BALANCE_REFRESH_ALARM } = require("../src/shared/alarms");
onAlarm({ name: BALANCE_REFRESH_ALARM });
return called;
} }
test("hands its balance refresh the stored Use Blockscout setting", async () => { // AddressDetail of the first of two addresses, as a reopened popup draws
const profile = { ...unversionedValidProfile(), lastBalanceRefresh: 0 }; // it. Both addresses hold the tracked token. While "Use Blockscout" is on,
expect(await settingTheRefreshIsHanded(profile)).toBe(false); // both hold the untracked one too.
function onAddressDetail(useBlockscout) {
const profile = unversionedValidProfile({
useBlockscout,
currentView: "address",
viewStack: ["main"],
selectedWallet: 0,
selectedAddress: 0,
trackedTokens: [
{ address: TRACKED, name: "TRK", symbol: "TRK", decimals: 18 },
],
});
const wallet = profile.wallets[0];
wallet.nextIndex = 2;
wallet.addresses.push({ address: SECOND_ADDRESS, balance: "0.0" });
for (const addr of wallet.addresses) {
addr.tokenBalances = useBlockscout
? [tokenRow(TRACKED, "TRK"), tokenRow(UNTRACKED, "TST")]
: [tokenRow(TRACKED, "TRK")];
}
return profile;
}
// The token ids of the options created after the first `from` elements.
// The page stub keeps no children, so this reads the options for Send's
// dropdown from the elements the page created.
function optionsSince(page, from) {
return page.document.created
.slice(from)
.filter((el) => el.tagName === "OPTION")
.map((el) => el.value.toLowerCase());
}
test("unticking Use Blockscout from AddressDetail's gear takes the untracked token off AddressDetail, Send's dropdown and Home on Back", async () => {
const page = await bootPopup(onAddressDetail(true));
expect(page.visibleViews()).toEqual(["address"]);
expect(page.node("address-balances").innerHTML).toContain(UNTRACKED);
await page.click("btn-settings");
await setBox(page, "settings-use-blockscout", false);
const from = page.document.created.length;
await page.click("btn-settings-back");
expect(page.visibleViews()).toEqual(["address"]);
const balances = page.node("address-balances").innerHTML;
expect(balances).toContain(TRACKED);
expect(balances).not.toContain(UNTRACKED);
expect(page.hidden("address-tokens-note")).toBe(false);
expect(optionsSince(page, from)).toEqual([TRACKED]);
await page.click("btn-send");
expect(page.visibleViews()).toEqual(["send"]);
expect(page.hidden("send-token-dropdown")).toBe(false);
expect(page.hidden("send-tokens-note")).toBe(false);
await page.click("btn-send-back");
await page.click("btn-address-back");
expect(page.visibleViews()).toEqual(["main"]);
const home = page.node("wallet-list").innerHTML;
expect(home).toContain(TRACKED);
expect(home).not.toContain(UNTRACKED);
const stored = page.storage.read("autistmask");
for (const addr of stored.wallets[0].addresses) {
expect(
addr.tokenBalances.map((row) => row.address.toLowerCase()),
).toEqual([TRACKED]);
}
});
// Send's dropdown was filled under the old setting, and Back cannot draw
// Send again. So Back lands on the screen under it.
test.each([
["unticking", true],
["ticking", false],
])(
"%s Use Blockscout from Send's gear lands Back on AddressDetail",
async (_how, before) => {
const page = await bootPopup(onAddressDetail(before));
await page.click("btn-send");
expect(page.visibleViews()).toEqual(["send"]);
await page.click("btn-settings");
await setBox(page, "settings-use-blockscout", !before);
await page.click("btn-settings-back");
expect(page.visibleViews()).toEqual(["address"]);
expect(page.hidden("address-tokens-note")).toBe(!before);
},
);
test("Send says under its token dropdown that only tracked tokens are listed while Use Blockscout is off", async () => {
const off = await bootPopup(onAddressDetail(false));
await off.click("btn-send");
expect(off.hidden("send-token-dropdown")).toBe(false);
expect(off.hidden("send-tokens-note")).toBe(false);
cleanupPopup();
const on = await bootPopup(onAddressDetail(true));
await on.click("btn-send");
expect(on.hidden("send-token-dropdown")).toBe(false);
expect(on.hidden("send-tokens-note")).toBe(true);
});
test("Send opened from AddressToken shows neither the dropdown nor its line", async () => {
const page = await bootPopup({
...onAddressDetail(false),
currentView: "address-token",
viewStack: ["main", "address"],
selectedToken: "ETH",
});
expect(page.visibleViews()).toEqual(["address-token"]);
await page.click("btn-address-token-send");
expect(page.visibleViews()).toEqual(["send"]);
expect(page.hidden("send-token-dropdown")).toBe(true);
expect(page.hidden("send-token-static")).toBe(false);
});
test("DeleteAddress says only tracked tokens are listed while Use Blockscout is off", async () => {
for (const useBlockscout of [false, true]) {
const page = await bootPopup(onAddressDetail(useBlockscout));
require("../src/popup/views/deleteAddress").show(0, 1);
expect(page.visibleViews()).toEqual(["delete-address-confirm"]);
expect(page.hidden("delete-address-tokens-note")).toBe(
useBlockscout,
);
cleanupPopup();
}
});
// The token ids of the first address's balances in the stored profile.
function storedTokens(page) {
return page.storage
.read("autistmask")
.wallets[0].addresses[0].tokenBalances.map((row) =>
row.address.toLowerCase(),
);
}
// Turning the setting off dropped the untracked token. A refresh that
// started while the setting was on still saves its balances when it
// returns, but not that token. The same refresh in the background is in
// tests/backgroundStateIsolation.test.js.
test("a refresh that returns after Use Blockscout was turned off saves its balances without the untracked token", async () => {
const page = await bootPopup(onAddressDetail(true));
const { refreshBalances: held } = require("../src/shared/balances");
let answer;
held.mockImplementationOnce(async (wallets) => {
await new Promise((resolve) => {
answer = resolve;
});
wallets[0].addresses[0].balance = "7.0";
wallets[0].addresses[0].tokenBalances = [
tokenRow(TRACKED, "TRK"),
tokenRow(UNTRACKED, "TST"),
];
});
const ticking = page.tick();
await page.settle();
await page.click("btn-settings");
await setBox(page, "settings-use-blockscout", false);
answer();
await ticking;
expect( expect(
await settingTheRefreshIsHanded({ page.storage.read("autistmask").wallets[0].addresses[0].balance,
...profile, ).toBe("7.0");
useBlockscout: true, expect(storedTokens(page)).toEqual([TRACKED]);
}), await page.click("btn-settings-back");
).toBe(true); expect(page.node("address-balances").innerHTML).not.toContain(
UNTRACKED,
);
});
// Another page saves `change` over the stored profile. The browser is not
// made to tell this page, so this page sees the change only by reading the
// stored profile.
function anotherPageSaves(page, change) {
page.storage.write("autistmask", {
...page.storage.read("autistmask"),
...change,
});
}
test.each([
["off", true, false],
["on", false, true],
])(
"after another page turns Use Blockscout %s, this page takes the change and its next refresh is saved",
async (_how, before, after) => {
const page = await bootPopup(onAddressDetail(before));
// The refresh answers as it does under the stored setting.
const { refreshBalances: held } = require("../src/shared/balances");
held.mockImplementationOnce(async (wallets) => {
const addr = wallets[0].addresses[0];
addr.balance = "7.0";
addr.tokenBalances = after
? [tokenRow(TRACKED, "TRK"), tokenRow(UNTRACKED, "TST")]
: [tokenRow(TRACKED, "TRK")];
});
anotherPageSaves(page, { useBlockscout: after });
await page.tick();
expect(
page.storage.read("autistmask").wallets[0].addresses[0].balance,
).toBe("7.0");
expect(storedTokens(page)).toEqual(
after ? [TRACKED, UNTRACKED] : [TRACKED],
);
expect(page.hidden("address-tokens-note")).toBe(after);
},
);
test.each([
["off", true, false],
["on", false, true],
])(
"after another page turns Check recipients on Etherscan %s, this page's next Etherscan check follows the stored setting",
async (_how, before, after) => {
const page = await bootPopup(
onConfirmScreen({ checkRecipientsOnEtherscan: before }),
);
anotherPageSaves(page, { checkRecipientsOnEtherscan: after });
const from = fetched().length;
require("../src/popup/views/confirmTx").show({
token: "ETH",
from: ADDRESS,
to: RECIPIENT,
amount: "0.1",
chainId: "0x1",
});
await page.settle();
// The page also takes the change and draws ConfirmTx again, which
// checks once more. So the test counts each URL once, however often
// it was asked for.
const asked = new Set(
fetched().slice(from).filter(blockscoutOrEtherscan),
);
expect([...asked]).toEqual(
after ? ["https://etherscan.io/address/" + RECIPIENT] : [],
);
},
);
// Another page's save of the whole profile with `change`, which the
// browser announces to this page as it announces any write.
async function anotherPageAnnounces(page, change) {
await page.storage.local.set({
autistmask: { ...page.storage.read("autistmask"), ...change },
});
await page.settle();
}
test("a page open on AddressDetail draws it again when another page turns Use Blockscout off", async () => {
const page = await bootPopup(onAddressDetail(true));
expect(page.hidden("address-tokens-note")).toBe(true);
await anotherPageAnnounces(page, { useBlockscout: false });
expect(page.visibleViews()).toEqual(["address"]);
expect(page.hidden("address-tokens-note")).toBe(false);
expect(page.node("address-balances").innerHTML).not.toContain(
UNTRACKED,
);
expect(storedTokens(page)).toEqual([TRACKED]);
});
test("a page open on ConfirmTx draws it again when another page turns Check recipients on Etherscan off", async () => {
const page = await bootPopup(
onConfirmScreen({ checkRecipientsOnEtherscan: true }),
);
expect(page.hidden("confirm-etherscan-note")).toBe(true);
await anotherPageAnnounces(page, { checkRecipientsOnEtherscan: false });
expect(page.visibleViews()).toEqual(["confirm-tx"]);
expect(page.hidden("confirm-etherscan-note")).toBe(false);
}); });
}); });
+2
View File
@@ -73,6 +73,8 @@ function loadColdWorker(networkId, opts) {
jest.doMock("../src/shared/balances", () => ({ jest.doMock("../src/shared/balances", () => ({
getProvider: () => ({}), getProvider: () => ({}),
refreshBalances: options.refreshBalances || jest.fn(async () => {}), refreshBalances: options.refreshBalances || jest.fn(async () => {}),
dropUntrackedTokens: jest.requireActual("../src/shared/balances")
.dropUntrackedTokens,
})); }));
jest.doMock("../src/shared/phishingDomains", () => ({ jest.doMock("../src/shared/phishingDomains", () => ({
isPhishingDomain: () => false, isPhishingDomain: () => false,
+8 -2
View File
@@ -108,7 +108,10 @@ global.fetch = jest.fn(() => {
}); });
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
global.chrome = { storage: makeStorageStub(), runtime: { sendMessage() {} } }; global.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
runtime: { sendMessage() {} },
};
// A stub DOM: every id resolves to a recording element. // A stub DOM: every id resolves to a recording element.
const elements = new Map(); const elements = new Map();
@@ -243,11 +246,14 @@ async function openSend(token, tokenUnits = null) {
]; ];
state.selectedWallet = 0; state.selectedWallet = 0;
state.selectedAddress = 0; state.selectedAddress = 0;
// Blockscout is asked only while the stored "Use Blockscout" is on. The
// screens save this page's copy of "Use Blockscout" over the stored one. So
// the page's copy is turned on here too.
state.useBlockscout = true;
await refreshBalances( await refreshBalances(
state.wallets, state.wallets,
"https://rpc.example.invalid", "https://rpc.example.invalid",
"https://blockscout.example/api/v2", "https://blockscout.example/api/v2",
true,
state.trackedTokens, state.trackedTokens,
"mainnet", "mainnet",
); );
+4 -3
View File
@@ -226,6 +226,7 @@ const PRIVATE_KEY = "0x" + "11".repeat(32);
const HOLDER = new Wallet(PRIVATE_KEY).address; const HOLDER = new Wallet(PRIVATE_KEY).address;
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe"; const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
const TOKEN = "0x7070707070707070707070707070707070707070"; const TOKEN = "0x7070707070707070707070707070707070707070";
const USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
const PASSWORD = "correct horse battery staple"; const PASSWORD = "correct horse battery staple";
function el(id) { function el(id) {
@@ -318,7 +319,7 @@ async function switchReopenAndGoBack(reviewedOn, switchedTo) {
setBackRenderer(makeBackRenderer(state, { confirmTx })); setBackRenderer(makeBackRenderer(state, { confirmTx }));
confirmTx.init({}); confirmTx.init({});
prices.ETH = 2000; prices.ETH = 2000;
prices.USDC = 1; prices[USDC] = 1;
mockNode.asked = []; mockNode.asked = [];
global.fetch.mockClear(); global.fetch.mockClear();
goBack(); goBack();
@@ -641,7 +642,7 @@ describe.each([
test("of an ERC-20 token, links the token contract to that network's explorer and prices the token by that network", async () => { test("of an ERC-20 token, links the token contract to that network's explorer and prices the token by that network", async () => {
mockNode.tokenUnits[reviewedOn] = 50000000n; mockNode.tokenUnits[reviewedOn] = 50000000n;
await review(reviewedOn, { await review(reviewedOn, {
token: TOKEN, token: USDC,
tokenSymbol: "USDC", tokenSymbol: "USDC",
tokenDecimals: 6, tokenDecimals: 6,
amount: "10", amount: "10",
@@ -652,7 +653,7 @@ describe.each([
"ERC-20 token transfer (USDC)", "ERC-20 token transfer (USDC)",
); );
expect(el("confirm-token-contract").innerHTML).toContain( expect(el("confirm-token-contract").innerHTML).toContain(
`href="${explorerUrl}/address/${TOKEN}"`, `href="${explorerUrl}/address/${USDC}"`,
); );
expect(el("confirm-amount").textContent).toBe( expect(el("confirm-amount").textContent).toBe(
"10.0000 USDC" + usdOn(reviewedOn, "$10.00"), "10.0000 USDC" + usdOn(reviewedOn, "$10.00"),
+1 -1
View File
@@ -153,7 +153,7 @@ describe("the balance warning on the removal confirmation", () => {
test("the USD total is shown when prices are known", () => { test("the USD total is shown when prices are known", () => {
prices.ETH = 2000; prices.ETH = 2000;
prices.USDC = 1; prices[USDC] = 1;
expect(balanceWarningHtml(TOKEN_ONLY)).toContain("Total: $2,500.00"); expect(balanceWarningHtml(TOKEN_ONLY)).toContain("Total: $2,500.00");
expect(balanceWarningHtml(ETH_ONLY)).toContain("Total: $3,000.00"); expect(balanceWarningHtml(ETH_ONLY)).toContain("Total: $3,000.00");
}); });
+13 -1
View File
@@ -43,12 +43,15 @@ const GAS_PRICE_WEI = BASE_FEE_WEI + PRIORITY_FEE_WEI;
const STUB_BLOCK_NUMBER = 21000000; const STUB_BLOCK_NUMBER = 21000000;
// A 32-byte zero word, returned for every eth_call. It is what makes ethers' // A 32-byte zero word, returned for every eth_call but a price feed's
// latestRoundData() (see rpcResult() below). It is what makes ethers'
// ENS reverse lookup resolve to "no resolver set" instead of throwing, and a // ENS reverse lookup resolve to "no resolver set" instead of throwing, and a
// throw there reaches the console through src/shared/log.js, which fails the // throw there reaches the console through src/shared/log.js, which fails the
// run on its own. // run on its own.
const ZERO_WORD = "0x" + "0".repeat(64); const ZERO_WORD = "0x" + "0".repeat(64);
const SELECTOR_LATEST_ROUND_DATA = "0xfeaf968c";
// One ETH, so the popup's balance lines render something and the wallet does // One ETH, so the popup's balance lines render something and the wallet does
// not look empty on the approval screen. // not look empty on the approval screen.
const STUB_BALANCE_WEI = 10n ** 18n; const STUB_BALANCE_WEI = 10n ** 18n;
@@ -111,6 +114,15 @@ function rpcResult(req, state) {
return latestBlock(); return latestBlock();
} }
// A price feed's latestRoundData() gets five zero words, as in network.js:
// a price of zero, which the wallet counts as no price.
const data = String(
(req.params && req.params[0] && req.params[0].data) || "",
);
if (method === "eth_call" && data.startsWith(SELECTOR_LATEST_ROUND_DATA)) {
return "0x" + "0".repeat(64 * 5);
}
if (Object.prototype.hasOwnProperty.call(RPC_RESULTS, method)) { if (Object.prototype.hasOwnProperty.call(RPC_RESULTS, method)) {
return RPC_RESULTS[method]; return RPC_RESULTS[method];
} }
+41 -8
View File
@@ -1035,11 +1035,14 @@ step(
}, },
); );
// A closed approval window leaves its request pending, and the toolbar button
// opens it (https://git.eeqj.de/sneak/AutistMask/issues/673). WebDriver cannot
// see the toolbar popup, so its page is opened in a tab, at the URL the
// extension put on the button.
step( step(
"closing an approval window rejects the request with 4001", "a closed approval window leaves the request pending until it is rejected",
async (env) => { async (env) => {
const d = env.driver; const d = env.driver;
const before = env.server.broadcast.length;
await d.switchToWindow(env.dappWindow); await d.switchToWindow(env.dappWindow);
await startRequest(d, "sign-closed", "personal_sign", [ await startRequest(d, "sign-closed", "personal_sign", [
@@ -1053,15 +1056,45 @@ step(
// Closed, not rejected: this is the windows.onRemoved path, which can // Closed, not rejected: this is the windows.onRemoved path, which can
// only fire if windows.create() handed back a window id for the // only fire if windows.create() handed back a window id for the
// approval to be matched against — call site 4 in the issue, and the // approval to be matched against. Without that id the toolbar button
// reason suppressing that write-back turns this step red. // never opens the approval, and this step fails.
await d.closeWindow(env.dappWindow); await d.closeWindow(env.dappWindow);
const outcome = await settleRequest(d, "sign-closed", 2000);
await assertUserRejection(d, "sign-closed", "a closed approval window");
assert( assert(
env.server.broadcast.length === before, outcome.settled === "pending",
"a closed approval window still put a transaction on the node", "closing the approval window answered the page: " +
JSON.stringify(outcome),
); );
await d.switchToWindow(env.popupWindow);
const url = await d.executeAsync(
`const done = arguments[arguments.length - 1];
browser.browserAction.getPopup({}).then(done, (e) => done(String(e)));`,
);
assert(
url.includes("?approval="),
"the toolbar button does not open the pending approval: " + url,
);
const reopened = await d.newWindow("tab");
await d.switchToWindow(reopened);
await d.navigate(url);
await d.waitVisible("#view-approve-sign");
await d.click("#btn-reject-sign");
await d.switchToWindow(env.dappWindow);
await assertUserRejection(
d,
"sign-closed",
"the signature request rejected from the toolbar button",
);
// A page may close only a window a script opened, so the tab can
// still be open.
const left = await d.findWindow((u) => u.includes("?approval="));
if (left) {
await d.switchToWindow(left);
await d.closeWindow(env.dappWindow);
}
}, },
); );
+12 -9
View File
@@ -251,8 +251,13 @@ const SELECTOR_DECIMALS = "0x313ce567";
const SELECTOR_SYMBOL = "0x95d89b41"; const SELECTOR_SYMBOL = "0x95d89b41";
const SELECTOR_NAME = "0x06fdde03"; const SELECTOR_NAME = "0x06fdde03";
const SELECTOR_BALANCE_OF = "0x70a08231"; const SELECTOR_BALANCE_OF = "0x70a08231";
const SELECTOR_LATEST_ROUND_DATA = "0xfeaf968c";
// Every eth_call still answers with a zero word except decimals(), symbol(), // On any contract, a latestRoundData() call is answered with five zero words.
// That is a round with a price of zero, which the wallet counts as no
// price. So no screen shows a USD value beside the amounts the tests compare.
//
// Every other eth_call answers with a zero word except decimals(), symbol(),
// name() and balanceOf() on the stub token. The wallet reads decimals() back // name() and balanceOf() on the stub token. The wallet reads decimals() back
// at signing time to compare with the scale the confirmation screen rendered // at signing time to compare with the scale the confirmation screen rendered
// (issue #305). Adding the token by its contract address reads the first three // (issue #305). Adding the token by its contract address reads the first three
@@ -273,6 +278,9 @@ function ethCallResult(req, opts) {
if (!call || typeof call !== "object") return ZERO_WORD; if (!call || typeof call !== "object") return ZERO_WORD;
const data = String(call.data || call.input || "").toLowerCase(); const data = String(call.data || call.input || "").toLowerCase();
const to = String(call.to || "").toLowerCase(); const to = String(call.to || "").toLowerCase();
if (data.startsWith(SELECTOR_LATEST_ROUND_DATA)) {
return "0x" + "0".repeat(64 * 5);
}
if (to !== STUB_TOKEN.address) return ZERO_WORD; if (to !== STUB_TOKEN.address) return ZERO_WORD;
if (data.startsWith(SELECTOR_DECIMALS)) { if (data.startsWith(SELECTOR_DECIMALS)) {
return word(opts.tokenDecimalsOverride ?? STUB_TOKEN.decimals); return word(opts.tokenDecimalsOverride ?? STUB_TOKEN.decimals);
@@ -656,9 +664,9 @@ function traceEnabled(raw) {
* @param {string} [opts.etherscanLabel] the label Etherscan's page gives the * @param {string} [opts.etherscanLabel] the label Etherscan's page gives the
* address asked about, such as "Fake_Phishing1"; none when unset. Read at * address asked about, such as "Fake_Phishing1"; none when unset. Read at
* request time. * request time.
* @param {object[]} [opts.requests] every request this handler sees, from the * @param {object[]} [opts.requests] a list for the requests this handler
* popup's pages and the background worker alike, appended in order as * sees. Each is appended in order as { method, url, fromWorker }, whether it
* { method, url, fromWorker }. * came from a popup page or the background worker.
* @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) => * @returns {Promise<{waitForServiceWorkerTraffic: (ms: number) =>
* Promise<string|null>}>} * Promise<string|null>}>}
*/ */
@@ -764,11 +772,6 @@ async function installNetworkStubs(ctx, opts) {
} }
} }
// CoinDesk price tick
if (url.hostname.endsWith("coindesk.com")) {
return jsonResponse(route, { Data: {} });
}
// The interception canary's own request. Answered with nothing: what // The interception canary's own request. Answered with nothing: what
// is being observed is that it arrived here at all. // is being observed is that it arrived here at all.
if (url.href === WORKER_PROBE_URL) { if (url.href === WORKER_PROBE_URL) {
+227 -42
View File
@@ -272,23 +272,30 @@ test("the exact confirmation phrase erases the record and reloads into Welcome (
// ------------------ Blockscout and Etherscan are sent no user data (#668) // ------------------ Blockscout and Etherscan are sent no user data (#668)
// //
// A fresh install sends Blockscout and Etherscan none of the user's data until // A fresh install sends Blockscout and Etherscan none of the user's data until
// the user turns on "Use Blockscout" or "Check recipients on Etherscan". The // the user turns on "Use Blockscout" or "Check recipients on Etherscan". One
// endpoint check Settings makes when the user presses "Save" beside the // request still reaches Blockscout while "Use Blockscout" is off: pressing
// Blockscout URL asks only for `/stats` and carries no user data; it is made // "Save" beside the Blockscout URL asks that URL for `/stats`. That request
// whether or not the setting is on. The route handler in tests/e2e/network.js // carries no user data.
// records every request the extension makes, from its pages and its background //
// worker, in env.routeOpts.requests. Recording starts when launch() in // The route handler in tests/e2e/network.js records in env.routeOpts.requests
// tests/e2e/harness.js installs that handler, before the first popup page // every request the extension makes, from its pages and its background worker.
// opens; a request the background worker makes while it starts up, before // Recording starts when launch() in tests/e2e/harness.js installs that handler,
// then, is not recorded. These tests drive Home, AddressDetail, AddressToken // before the first popup page opens. The background worker starts earlier, but
// and ConfirmTx, and the background's own balance refresh, before either // it makes no request while it starts up.
// setting is changed, then turn each on and watch its requests start. //
// TransactionDetail, which also asks Blockscout, is left to the unit tests in // Before either setting is changed, these tests drive:
// tests/blockscoutEtherscanSettings.test.js. //
// - Home, AddressDetail, AddressToken and ConfirmTx
// - the background's own balance refresh
//
// Then they turn each setting on and watch its requests start. "Use Blockscout"
// is also turned off once and on again, to see an untracked token leave every
// list. TransactionDetail, which also asks Blockscout, is left to the unit
// tests in tests/blockscoutEtherscanSettings.test.js.
// What the three transaction lists say while Use Blockscout is off. Written // The line shown in place of the three transaction histories while "Use
// out here rather than imported, so the assertion does not compare the popup // Blockscout" is off. Written out here rather than imported, so the assertion
// with itself. // does not compare the popup with itself.
const HISTORY_OFF = const HISTORY_OFF =
'No transaction history is shown, because "Use Blockscout" is off in Settings.'; 'No transaction history is shown, because "Use Blockscout" is off in Settings.';
@@ -300,7 +307,7 @@ function explorerRequests(env) {
}); });
} }
// Waits until the list `listId` says what Use Blockscout being off leaves out. // Waits until the list `listId` shows the line saying "Use Blockscout" is off.
async function waitForHistoryOff(page, listId) { async function waitForHistoryOff(page, listId) {
await page.waitForFunction( await page.waitForFunction(
([id, want]) => document.getElementById(id).textContent.trim() === want, ([id, want]) => document.getElementById(id).textContent.trim() === want,
@@ -395,11 +402,11 @@ test("with neither setting changed, Home, AddressDetail, AddressToken and Confir
} }
}); });
// The background refreshes balances on its alarm, once a minute, and skips a // The background refreshes balances on its alarm, once a minute. It skips a
// refresh when the stored record says one ran in the last 30 seconds, which // refresh when the stored record says one ran in the last 30 seconds. The open
// the open popup's own refresh does every 10. So the popup is closed, and that // popup's own refresh runs every 10. So the popup is closed first. The test then
// record is written back to say no refresh has run, from the background // has the background worker set the stored time of the last refresh to 0, so
// worker, as another extension page saving it would. // its next alarm runs a refresh.
test("with neither setting changed, nothing has reached Blockscout or Etherscan, the background's refresh included (#668)", async (env) => { test("with neither setting changed, nothing has reached Blockscout or Etherscan, the background's refresh included (#668)", async (env) => {
await waitForPersisted( await waitForPersisted(
env.page, env.page,
@@ -432,7 +439,7 @@ test("with neither setting changed, nothing has reached Blockscout or Etherscan,
); );
await sleep(250); await sleep(250);
} }
// Its RPC reads and any Blockscout request start together. // The refresh's RPC reads and any Blockscout request start together.
await sleep(3000); await sleep(3000);
const seen = explorerRequests(env); const seen = explorerRequests(env);
@@ -446,7 +453,7 @@ test("with neither setting changed, nothing has reached Blockscout or Etherscan,
env.routeOpts.requests.some((r) => !r.fromWorker), env.routeOpts.requests.some((r) => !r.fromWorker),
"no request from the popup was recorded", "no request from the popup was recorded",
); );
// It reopens on the address screen the test above left it on. // The popup reopens on the address screen the test above left it on.
env.page = await openPopup(env.ctx, env.popupUrl); env.page = await openPopup(env.ctx, env.popupUrl);
await visible(env.page, "#view-address"); await visible(env.page, "#view-address");
}); });
@@ -500,9 +507,68 @@ test("turning on Use Blockscout from AddressDetail's gear asks Blockscout for th
); );
}); });
// Unticked from AddressDetail's gear while the address holds the stub token,
// which the user has not tracked and only Blockscout reports. Ticked again at
// the end, so the rest of the run has Blockscout as before.
test("turning off Use Blockscout from AddressDetail's gear takes an untracked token off AddressDetail, Send and Home on Back (#668)", async (env) => {
env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
env.routeOpts.seedTokenBalance = true;
const tokenRow = '[data-token="' + STUB_TOKEN.address + '"]';
try {
await settleOnMain(env, { ethWei: FUNDED_ETH_WEI, expectToken: true });
await openAddressDetail(env.page);
await visible(env.page, "#address-balances " + tokenRow);
await openSettings(env.page);
await env.page.uncheck("#settings-use-blockscout");
await waitForPersisted(
env.page,
"useBlockscout",
false,
"once unticked",
);
await env.page.click("#btn-settings-back");
await visible(env.page, "#view-address");
await visible(env.page, "#address-tokens-note");
assert(
(await env.page
.locator("#address-balances " + tokenRow)
.count()) === 0,
"AddressDetail still lists the untracked token",
);
await env.page.click("#btn-send");
await visible(env.page, "#view-send");
await visible(env.page, "#send-tokens-note");
const offered = await env.page.$$eval("#send-token option", (opts) =>
opts.map((opt) => opt.value.toLowerCase()),
);
assert(
!offered.includes(STUB_TOKEN.address),
"Send's dropdown still offers the untracked token",
);
await env.page.click("#btn-send-back");
await visible(env.page, "#view-address");
await goHome(env.page);
await visible(env.page, "#home-tokens-note");
assert(
(await env.page.locator("#wallet-list " + tokenRow).count()) === 0,
"Home still lists the untracked token",
);
} finally {
await openSettings(env.page);
await env.page.check("#settings-use-blockscout");
await waitForPersisted(env.page, "useBlockscout", true, "ticked again");
await env.page.click("#btn-settings-back");
env.routeOpts.ethBalanceWei = null;
env.routeOpts.seedTokenBalance = false;
}
});
// Ticked from ConfirmTx's gear, so Back lands on the screen that said no // Ticked from ConfirmTx's gear, so Back lands on the screen that said no
// Etherscan check was made. Left on for the rest of the run, as the check was // Etherscan check was made. Left on for the rest of the run, so the later
// always made before #668. // confirmation screens are driven with the check made.
test("turning on Check recipients on Etherscan from ConfirmTx's gear has ConfirmTx ask Etherscan on Back and show its label (#668)", async (env) => { test("turning on Check recipients on Etherscan from ConfirmTx's gear has ConfirmTx ask Etherscan on Back and show its label (#668)", async (env) => {
env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI); env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
env.routeOpts.etherscanLabel = "Fake_Phishing668"; env.routeOpts.etherscanLabel = "Fake_Phishing668";
@@ -4044,11 +4110,12 @@ async function waitForApprovalWindow(ctx, timeout = 30000) {
// reservation exists. // reservation exists.
// How long the tab creation above is given to take effect before the request // How long the tab creation above is given to take effect before the request
// that raises the next prompt is issued. Dismissing a browser-action popup // that raises the next prompt is issued. Dismissing a browser-action popup
// disconnects its port, and src/background/index.js calls resetPopupUrl() on // disconnects its port, and src/background/index.js calls
// that disconnect; issued too early, the next request's setPopup() is undone // updateToolbarPopup() on that disconnect; issued too early, the next
// by the previous popup's teardown, chrome.action.openPopup() then rejects, // request's setPopup() is undone by the previous popup's teardown,
// and the fallback window it opens dismisses the popup that was just raised — // chrome.action.openPopup() then rejects, and the fallback window it opens
// which settles the fresh approval as a rejection before it can be seen. // dismisses the popup that was just raised — which settles the fresh approval
// as a rejection before it can be seen.
// Every one of those steps was observed. 1.5s is comfortably past it. // Every one of those steps was observed. 1.5s is comfortably past it.
const APPROVAL_TAB_SETTLE_MS = 1500; const APPROVAL_TAB_SETTLE_MS = 1500;
@@ -4074,6 +4141,17 @@ async function reserveApprovalTab(env) {
return env.approvalTab; return env.approvalTab;
} }
// The URL the extension has put on the action: the page the toolbar button
// opens.
function toolbarPopupUrl(env) {
return env.page.evaluate(
() =>
new Promise((resolve) => {
chrome.action.getPopup({}, (u) => resolve(String(u)));
}),
);
}
// The site-connection prompt: the window the extension opened if it managed // The site-connection prompt: the window the extension opened if it managed
// to open one, and the reserved tab at the action's approval URL otherwise. // to open one, and the reserved tab at the action's approval URL otherwise.
async function openSiteApprovalPopup(env, timeout = 30000) { async function openSiteApprovalPopup(env, timeout = 30000) {
@@ -4084,12 +4162,7 @@ async function openSiteApprovalPopup(env, timeout = 30000) {
.find((p) => !p.isClosed() && p.url().includes("?approval=")); .find((p) => !p.isClosed() && p.url().includes("?approval="));
if (existing) return existing; if (existing) return existing;
const url = await env.page.evaluate( const url = await toolbarPopupUrl(env);
() =>
new Promise((resolve) => {
chrome.action.getPopup({}, (u) => resolve(String(u)));
}),
);
if (url.includes("?approval=")) { if (url.includes("?approval=")) {
await env.approvalTab.goto(url); await env.approvalTab.goto(url);
return env.approvalTab; return env.approvalTab;
@@ -4961,6 +5034,116 @@ test("eth_sendTransaction rejected broadcasts nothing (#183)", async (env) => {
); );
}); });
// A transaction or signature approval stays pending when its window closes.
// The browser can close that window when the user clicks away from it, for
// example to copy the password from a password manager. The toolbar button then
// opens the approval, and the user answers it there
// (https://git.eeqj.de/sneak/AutistMask/issues/673).
//
// This closes the approval window of request `key` and checks that the page
// has no answer. It then opens the approval again from the toolbar button.
// Playwright cannot click that button, so its page is opened in a tab, at the
// URL the extension put on the button.
async function closeAndReopen(env, key, view) {
const approvalWindow = await waitForApprovalWindow(env.ctx);
await visible(approvalWindow, view);
await approvalWindow.close();
const outcome = await settleRequest(env.dapp, key, 2000);
assert(
outcome.settled === "pending",
"closing the approval window answered the page: " +
JSON.stringify(outcome),
);
const url = await toolbarPopupUrl(env);
assert(
url.includes("?approval="),
"the toolbar button does not open the pending approval: " + url,
);
const reopened = await env.ctx.newPage();
await reopened.goto(url);
await visible(reopened, view);
return reopened;
}
// The stub node answers every nonce request with 0, and the wallet refuses a
// nonce it has already broadcast. A run can therefore approve one dApp
// transaction only, so here the signature is approved and the transaction
// rejected.
test("a closed signature approval is signed from the toolbar button (#673)", async (env) => {
await startRequest(env.dapp, "sign-closed", "personal_sign", [
SIGN_HEX,
env.expectedAddress,
]);
const popup = await closeAndReopen(
env,
"sign-closed",
"#view-approve-sign",
);
let outcome;
try {
await popup.fill("#approve-sign-password", PASSWORD);
await clickAndClose(popup, "#btn-approve-sign");
outcome = await settleRequest(env.dapp, "sign-closed");
} finally {
await closeApprovalPages(env.ctx);
}
assert(
outcome.settled === "resolved",
"personal_sign did not resolve: " + JSON.stringify(outcome),
);
const recovered = getAddress(
verifyMessage(getBytes(SIGN_HEX), outcome.result),
);
assert(
recovered === env.expectedAddress,
"the personal_sign signature recovers to " +
recovered +
", not to the approved address " +
env.expectedAddress,
);
const url = await toolbarPopupUrl(env);
assert(
!url.includes("?approval="),
"the toolbar button still opens the answered approval: " + url,
);
});
test("a closed transaction approval is rejected from the toolbar button (#673)", async (env) => {
const before = env.routeOpts.broadcastTransactions.length;
await startRequest(env.dapp, "tx-closed", "eth_sendTransaction", [
{
from: env.expectedAddress,
to: STUB_COUNTERPARTY,
value: toQuantity(TX_VALUE_WEI),
data: TX_DATA,
},
]);
const popup = await closeAndReopen(env, "tx-closed", "#view-approve-tx");
try {
await clickAndClose(popup, "#btn-reject-tx");
await assertUserRejection(
env.dapp,
"tx-closed",
"the transaction rejected from the toolbar button",
);
} finally {
await closeApprovalPages(env.ctx);
}
assert(
env.routeOpts.broadcastTransactions.length === before,
"a rejected transaction still reached the RPC",
);
const url = await toolbarPopupUrl(env);
assert(
!url.includes("?approval="),
"the toolbar button still opens the answered approval: " + url,
);
});
// The extension used to centre every approval window on the last focused // The extension used to centre every approval window on the last focused
// window. Centred on another approval window, the new one landed where the // window. Centred on another approval window, the new one landed where the
// browser refused to create it, and the request failed with no window at all // browser refused to create it, and the request failed with no window at all
@@ -5004,8 +5187,8 @@ test("a prompt raised while another approval window has focus opens its own (#29
}); });
await visible(txWindow, "#view-approve-tx"); await visible(txWindow, "#view-approve-tx");
// Closing a window is refusing its prompt, so both answer 4001. await clickAndClose(txWindow, "#btn-reject-tx");
await closeApprovalPages(env.ctx); await clickAndClose(signWindow, "#btn-reject-sign");
await assertUserRejection(env.dapp, "focus-tx", "the transaction prompt"); await assertUserRejection(env.dapp, "focus-tx", "the transaction prompt");
await assertUserRejection(env.dapp, "focus-sign", "the sign prompt"); await assertUserRejection(env.dapp, "focus-sign", "the sign prompt");
}); });
@@ -5612,9 +5795,11 @@ async function main() {
// for the new one. After a test that passed, its windows get five // for the new one. After a test that passed, its windows get five
// seconds to close, and one still open then fails the test: it should // seconds to close, and one still open then fails the test: it should
// have closed itself, and closing it here unreported would hide that. // have closed itself, and closing it here unreported would hide that.
// After a test that already failed, they are closed unreported, so // After a test that already failed, they are closed unreported. That
// that a prompt it left unanswered does not refuse the next one from // rejects a site-connection or network-switch prompt it left
// its site. // unanswered, so the prompt does not refuse the next one from its
// site. A transaction or signature approval stays pending, and can
// fail the tests after it.
if (!failure) { if (!failure) {
const deadline = Date.now() + 5000; const deadline = Date.now() + 5000;
let open; let open;
+16 -13
View File
@@ -1,13 +1,14 @@
// ENS lookups ask nothing but the RPC endpoint. A resolver can answer that a // ENS lookups ask nothing but the RPC endpoint. A resolver can answer that a
// name is resolved off-chain, naming a web address to fetch the answer from; // name is resolved off-chain, naming a web address to fetch the answer from.
// ethers fetches it unless the provider has `disableCcipRead` set, and that // ethers fetches that address unless the provider has `disableCcipRead` set.
// request would carry the name to a server other than the RPC endpoint // That request would carry the name to a server other than the RPC endpoint
// (https://git.eeqj.de/sneak/AutistMask/issues/668). With it set, such a name // (https://git.eeqj.de/sneak/AutistMask/issues/668). With the flag set, such a
// does not resolve. // name does not resolve.
// //
// The provider getProvider() builds runs against a fake JSON-RPC node, // The test builds its provider with getProvider() and runs it against a fake
// answered through ethers' own request hook, which also records the address of // JSON-RPC node. The fake node answers through ethers' own request hook. The
// every request ethers makes, the off-chain fetch included. // hook also records the address of every request ethers makes, the off-chain
// fetch included.
const { FetchRequest, Interface } = require("ethers"); const { FetchRequest, Interface } = require("ethers");
const { getProvider } = require("../src/shared/balances"); const { getProvider } = require("../src/shared/balances");
@@ -17,11 +18,13 @@ const RESOLVER = "0x5555555555555555555555555555555555555555";
const USER = "0x1111111111111111111111111111111111111111"; const USER = "0x1111111111111111111111111111111111111111";
const NAME = "offchain.eth"; const NAME = "offchain.eth";
// The ENS registry's resolver(), and the resolver's functions ethers calls: the // The ENS registry's resolver(), and the resolver's functions ethers calls:
// registry names RESOLVER for every name, the resolver says it resolves names //
// through resolve(), gives NAME as the reverse record of any address, and // - the registry names RESOLVER for every name
// answers resolve() with the OffchainLookup error that says the name is // - the resolver says it resolves names through resolve()
// resolved off-chain. // - it gives NAME as the reverse record of any address
// - it answers resolve() with the OffchainLookup error, which says the name
// is resolved off-chain
const ens = new Interface([ const ens = new Interface([
"function resolver(bytes32) view returns (address)", "function resolver(bytes32) view returns (address)",
"function supportsInterface(bytes4) view returns (bool)", "function supportsInterface(bytes4) view returns (bool)",
+7 -2
View File
@@ -35,8 +35,11 @@ global.fetch = jest.fn(() => {
throw new Error("tests must not perform network requests"); throw new Error("tests must not perform network requests");
}); });
// Blockscout is asked only while the stored "Use Blockscout" is on.
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
global.chrome = { storage: makeStorageStub() }; global.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
};
const { AbiCoder, Interface } = require("ethers"); const { AbiCoder, Interface } = require("ethers");
const { ERC20_ABI } = require("../src/shared/constants"); const { ERC20_ABI } = require("../src/shared/constants");
@@ -114,7 +117,6 @@ async function fetchOnto(items, trackedTokens = []) {
const balances = await fetchTokenBalances( const balances = await fetchTokenBalances(
HOLDER, HOLDER,
BLOCKSCOUT, BLOCKSCOUT,
true,
trackedTokens, trackedTokens,
); );
state.trackedTokens = trackedTokens; state.trackedTokens = trackedTokens;
@@ -166,6 +168,9 @@ beforeEach(() => {
debugFetch.mockReset(); debugFetch.mockReset();
state.trackedTokens = []; state.trackedTokens = [];
state.wallets = []; state.wallets = [];
// The approval screens read the explorer's report only while the page's
// "Use Blockscout" is on.
state.useBlockscout = true;
}); });
describe("what fetchTokenBalances stores for an absent scale", () => { describe("what fetchTokenBalances stores for an absent scale", () => {
+10 -10
View File
@@ -21,7 +21,11 @@ jest.mock("../src/shared/log", () => ({
global.fetch = jest.fn(() => { global.fetch = jest.fn(() => {
throw new Error("tests must not perform network requests"); throw new Error("tests must not perform network requests");
}); });
global.chrome = { storage: { local: {} } }; // Blockscout is asked only while the stored "Use Blockscout" is on.
const { makeStorageStub } = require("./support/storageStub");
global.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
};
const { const {
LOW_HOLDER_THRESHOLD, LOW_HOLDER_THRESHOLD,
@@ -150,23 +154,19 @@ describe("the balance-list spam gate", () => {
test("a token with plenty of reported holders is listed", async () => { test("a token with plenty of reported holders is listed", async () => {
respondWith([item()]); respondWith([item()]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
expect(balances[0].holders).toBe(50000); expect(balances[0].holders).toBe(50000);
}); });
test("a token reporting zero holders is still excluded", async () => { test("a token reporting zero holders is still excluded", async () => {
respondWith([item({ token: { holders_count: "0" } })]); respondWith([item({ token: { holders_count: "0" } })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
test("an unknown holder count does not admit an unvouched token", async () => { test("an unknown holder count does not admit an unvouched token", async () => {
respondWith([item({ token: { holders_count: null } })]); respondWith([item({ token: { holders_count: null } })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
// The path that reaches the send selector and the history filter: a token // The path that reaches the send selector and the history filter: a token
@@ -175,7 +175,7 @@ describe("the balance-list spam gate", () => {
// zero that would then hide it downstream. // zero that would then hide it downstream.
test("a tracked token with an unknown count is listed with holders null", async () => { test("a tracked token with an unknown count is listed with holders null", async () => {
respondWith([item({ token: { holders_count: undefined } })]); respondWith([item({ token: { holders_count: undefined } })]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [ const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, [
{ address: NOVEL_TOKEN.toUpperCase() }, { address: NOVEL_TOKEN.toUpperCase() },
]); ]);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
@@ -192,7 +192,7 @@ describe("the balance-list spam gate", () => {
}, },
}), }),
]); ]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
expect(balances[0].holders).toBeNull(); expect(balances[0].holders).toBeNull();
}); });
+9
View File
@@ -165,6 +165,15 @@ describe("declared icons", () => {
}); });
}); });
// Firefox gives a page in a private window locks of its own, so that page's
// save could land between the background's read and its write (README,
// "Stored state and its version").
describe("private windows", () => {
test("a page in a firefox private window cannot read or write extension storage", () => {
expect(readManifest("firefox").incognito).toBe("not_allowed");
});
});
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.
+6 -1
View File
@@ -436,8 +436,13 @@ describe.each([
}); });
test("the transaction detail screen's type line and fee", async () => { test("the transaction detail screen's type line and fee", async () => {
// The fee is Blockscout's. // The fee is Blockscout's, asked for only while the stored "Use
// Blockscout" is on.
state.useBlockscout = true; state.useBlockscout = true;
global.chrome.storage.write("autistmask", {
...global.chrome.storage.read("autistmask"),
useBlockscout: true,
});
debugFetch.mockImplementationOnce(async () => ({ debugFetch.mockImplementationOnce(async () => ({
ok: true, ok: true,
status: 200, status: 200,
+5 -1
View File
@@ -286,8 +286,12 @@ describe("a malformed fraudContracts", () => {
function stubSendDocument() { function stubSendDocument() {
const select = { innerHTML: "", children: [] }; const select = { innerHTML: "", children: [] };
select.appendChild = (child) => select.children.push(child); select.appendChild = (child) => select.children.push(child);
const elements = {
"send-token": select,
"send-tokens-note": { classList: { toggle: () => {} } },
};
globalThis.document = { globalThis.document = {
getElementById: (id) => (id === "send-token" ? select : null), getElementById: (id) => elements[id] || null,
createElement: () => ({ value: "", textContent: "" }), createElement: () => ({ value: "", textContent: "" }),
}; };
return select; return select;
+17 -5
View File
@@ -618,8 +618,6 @@ const CONTRACT = [
"hideFraudContracts", "hideFraudContracts",
"hideDustTransactions", "hideDustTransactions",
"utcTimestamps", "utcTimestamps",
"useBlockscout",
"checkRecipientsOnEtherscan",
"debugMode", "debugMode",
].map((field) => ({ ].map((field) => ({
field, field,
@@ -627,11 +625,25 @@ const CONTRACT = [
// A flag: only ever tested for truthiness, and written back verbatim. // A flag: only ever tested for truthiness, and written back verbatim.
hostile: [42, "notabool", { a: 1 }], hostile: [42, "notabool", { a: 1 }],
// Both answers to that truthiness test have to be driven, and 0 is a // Both answers to that truthiness test have to be driven, and 0 is a
// value src/ never writes for a flag. For utcTimestamps, // value src/ never writes for a flag. For utcTimestamps and debugMode
// useBlockscout, checkRecipientsOnEtherscan and debugMode the falsy // the falsy answer is also the DEFAULT_STATE default.
// answer is also the DEFAULT_STATE default.
falsy: [0], falsy: [0],
})), })),
// Anything but true is off for these three settings:
// - useBlockscout and checkRecipientsOnEtherscan let a request reach
// another service.
// - allowWeakPasswords lets AddWallet accept a short password.
...[
"useBlockscout",
"checkRecipientsOnEtherscan",
"allowWeakPasswords",
].map((field) => ({
field,
kind: KIND.SCALAR,
hostile: [42, "notabool", { a: 1 }],
floorOnly: [0, null, "true"],
holds: (v) => v === false,
})),
]; ];
function siteMapHolds(v) { function siteMapHolds(v) {
+3 -2
View File
@@ -44,8 +44,9 @@ test("a flash message's timer does not fire after cleanupPopup()", async () => {
// A boot onto a screen that sends a request no mocked module answers: that // A boot onto a screen that sends a request no mocked module answers: that
// request reaches the boot's fetch() stub, never the internet // request reaches the boot's fetch() stub, never the internet
// (https://git.eeqj.de/sneak/AutistMask/issues/559). Both requests are made // (https://git.eeqj.de/sneak/AutistMask/issues/559). TransactionDetail asks
// only while the user has the setting for them on. // Blockscout only while "Use Blockscout" is on. ConfirmTx asks Etherscan only
// while "Check recipients on Etherscan" is on. So the profile turns both on.
function restoringOnto(view, viewData) { function restoringOnto(view, viewData) {
return unversionedValidProfile({ return unversionedValidProfile({
currentView: view, currentView: view,
+266 -1
View File
@@ -87,7 +87,7 @@ test("the popup open on AddressDetail shows the new network and its balances", a
// Its next refresh runs on Sepolia, and what it fetched is stored. // Its next refresh runs on Sepolia, and what it fetched is stored.
await page.tick(); await page.tick();
const { refreshBalances } = require("../src/shared/balances"); const { refreshBalances } = require("../src/shared/balances");
expect(refreshBalances.mock.lastCall[5]).toBe("sepolia"); expect(refreshBalances.mock.lastCall[4]).toBe("sepolia");
const stored = page.storage.read("autistmask"); const stored = page.storage.read("autistmask");
expect(stored.networkId).toBe("sepolia"); expect(stored.networkId).toBe("sepolia");
expect(stored.lastBalanceRefresh).toBeGreaterThan(0); expect(stored.lastBalanceRefresh).toBeGreaterThan(0);
@@ -253,6 +253,271 @@ test("a switch back in Settings after a follow whose write failed is stored", as
expect(told.at(-1).chainId).toBe(NETWORKS.mainnet.chainId); expect(told.at(-1).chainId).toBe(NETWORKS.mainnet.chainId);
}); });
// The user saves an endpoint URL in Settings on Ethereum Mainnet. Before the
// URL is stored, the background saves a switch to Sepolia. Another write holds
// the lock, so the popup's follow of that switch and the URL's save both wait
// for the lock. Either may take it first. The URL is stored for neither
// network. The flash message says that the network changed.
test.each([
{ button: "btn-save-rpc", field: "settings-rpc", first: "follow" },
{ button: "btn-save-rpc", field: "settings-rpc", first: "save" },
{
button: "btn-save-blockscout",
field: "settings-blockscout",
first: "follow",
},
{
button: "btn-save-blockscout",
field: "settings-blockscout",
first: "save",
},
])(
"$button saves nothing when the network changes before the URL is stored ($first first)",
async ({ button, field, first }) => {
const page = await bootOnAddress();
await page.click("btn-settings");
// This answer passes both endpoint checks. The RPC check reads
// Ethereum Mainnet's chain id from it. The Blockscout check reads `ok`.
globalThis.fetch.mockResolvedValue({
ok: true,
json: async () => ({ result: NETWORKS.mainnet.chainId }),
});
const url = "https://own-node.example.invalid";
let releaseLock;
const lockHeld = navigator.locks.request(
"autistmask",
() =>
new Promise((resolve) => {
releaseLock = resolve;
}),
);
// The click handler runs until its save waits for the lock.
const tapSave = async () => {
page.node(field).value = url;
const saving = page.node(button).listeners.click.map((fn) => fn());
await page.settle();
return saving;
};
let saving;
if (first === "save") saving = await tapSave();
await backgroundSwitch(page, "sepolia");
if (first === "follow") saving = await tapSave();
releaseLock();
await lockHeld;
await Promise.all(saving);
await page.settle();
const { state } = require("../src/shared/state");
expect(state.networkId).toBe("sepolia");
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
url,
);
expect(page.text("flash-msg")).toBe(
"The URL was not saved because the network changed.",
);
},
);
// The popup's follow of the background's switch to Sepolia has set `state` to
// Sepolia. The follow's write has not returned yet, so Settings still shows
// Ethereum Mainnet. The user taps "Save" there. The URL is for Ethereum
// Mainnet, so the save stores the URL for neither network.
test.each([
{ button: "btn-save-rpc", field: "settings-rpc" },
{ button: "btn-save-blockscout", field: "settings-blockscout" },
])(
"$button saves nothing when tapped while the follow's write waits",
async ({ button, field }) => {
const page = await bootOnAddress();
await page.click("btn-settings");
// This answer passes both endpoint checks on Ethereum Mainnet.
globalThis.fetch.mockResolvedValue({
ok: true,
json: async () => ({ result: NETWORKS.mainnet.chainId }),
});
const url = "https://own-node.example.invalid";
const { set } = page.storage.local;
const write = set.getMockImplementation();
let releaseWrite;
const writeHeld = new Promise((resolve) => {
releaseWrite = resolve;
});
// The background's write lands; the next, the follow's, waits.
set.mockImplementationOnce(write).mockImplementationOnce(
async (items) => {
await writeHeld;
await write(items);
},
);
await backgroundSwitch(page, "sepolia");
const { state } = require("../src/shared/state");
expect(state.networkId).toBe("sepolia");
expect(page.value("settings-network")).toBe("mainnet");
page.node(field).value = url;
const saving = page.node(button).listeners.click.map((fn) => fn());
await page.settle();
releaseWrite();
await Promise.all(saving);
await page.settle();
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
url,
);
expect(page.text("flash-msg")).toBe(
"The URL was not saved because the network changed.",
);
},
);
// The user taps the RPC "Save" on Ethereum Mainnet. While the check waits for
// the node's answer, the popup follows the background's switch to Sepolia. The
// node answers with Sepolia's chain id. So the check refuses the node for
// Ethereum Mainnet, and nothing is stored.
test("the RPC check compares the answer with the network at the tap", async () => {
const page = await bootOnAddress();
await page.click("btn-settings");
let answer;
globalThis.fetch.mockReturnValue(
new Promise((resolve) => {
answer = resolve;
}),
);
const url = "https://sepolia-node.example.invalid";
page.node("settings-rpc").value = url;
const saving = page.node("btn-save-rpc").listeners.click.map((fn) => fn());
await page.settle();
await backgroundSwitch(page, "sepolia");
const { state } = require("../src/shared/state");
expect(state.networkId).toBe("sepolia");
answer({ json: async () => ({ result: NETWORKS.sepolia.chainId }) });
await Promise.all(saving);
await page.settle();
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(url);
expect(page.text("flash-msg")).toBe(
"Wrong network: expected Ethereum Mainnet.",
);
});
// The user taps the Blockscout "Save" on Ethereum Mainnet. While the check
// waits for Blockscout's answer, the popup follows the background's switch to
// Sepolia. The URL is for Ethereum Mainnet, so nothing is stored.
test("the Blockscout save is for the network at the tap", async () => {
const page = await bootOnAddress();
await page.click("btn-settings");
let answer;
globalThis.fetch.mockReturnValue(
new Promise((resolve) => {
answer = resolve;
}),
);
const url = "https://own-explorer.example.invalid/api/v2";
page.node("settings-blockscout").value = url;
const saving = page
.node("btn-save-blockscout")
.listeners.click.map((fn) => fn());
await page.settle();
await backgroundSwitch(page, "sepolia");
expect(page.value("settings-network")).toBe("sepolia");
answer({ ok: true });
await Promise.all(saving);
await page.settle();
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(url);
expect(page.text("flash-msg")).toBe(
"The URL was not saved because the network changed.",
);
});
// Settings is open when the network changes to Sepolia. The popup follows the
// background's switch, or the user picks Sepolia in the network selector. Each
// "Save" after the switch stores its URL for Sepolia.
test.each([
["a follow", (page) => backgroundSwitch(page, "sepolia")],
[
"the network selector",
async (page) => {
const select = page.node("settings-network");
select.value = "sepolia";
for (const fn of select.listeners.change) await fn();
await page.settle();
},
],
])(
"after a switch to Sepolia by %s, Settings saves each URL for Sepolia",
async (_how, switchToSepolia) => {
const page = await bootOnAddress();
await page.click("btn-settings");
await switchToSepolia(page);
// This answer passes both endpoint checks on Sepolia. The RPC check
// reads Sepolia's chain id from it. The Blockscout check reads `ok`.
globalThis.fetch.mockResolvedValue({
ok: true,
json: async () => ({ result: NETWORKS.sepolia.chainId }),
});
const rpcUrl = "https://own-node.example.invalid";
const blockscoutUrl = "https://own-explorer.example.invalid/api/v2";
page.node("settings-rpc").value = rpcUrl;
await page.click("btn-save-rpc");
expect(page.text("flash-msg")).toBe("Saved.");
page.node("settings-blockscout").value = blockscoutUrl;
await page.click("btn-save-blockscout");
expect(page.text("flash-msg")).toBe("Saved.");
const stored = page.storage.read("autistmask");
expect(stored.networkId).toBe("sepolia");
expect(stored.rpcUrl).toBe(rpcUrl);
expect(stored.blockscoutUrl).toBe(blockscoutUrl);
},
);
// The user picks Sepolia in Settings, but the switch's write fails. The page is
// then on Sepolia, while Settings was last drawn for Ethereum Mainnet. A "Save"
// after the failed switch stores nothing for either network.
test.each([
{ button: "btn-save-rpc", field: "settings-rpc" },
{ button: "btn-save-blockscout", field: "settings-blockscout" },
])(
"$button saves nothing after a switch in Settings whose write failed",
async ({ button, field }) => {
const page = await bootOnAddress();
await page.click("btn-settings");
page.storage.local.set.mockRejectedValueOnce(
new Error("quota exceeded"),
);
const select = page.node("settings-network");
select.value = "sepolia";
for (const fn of select.listeners.change) {
await expect(fn()).rejects.toThrow("quota exceeded");
}
await page.settle();
const { state } = require("../src/shared/state");
expect(state.networkId).toBe("sepolia");
// This answer passes both endpoint checks on Ethereum Mainnet.
globalThis.fetch.mockResolvedValue({
ok: true,
json: async () => ({ result: NETWORKS.mainnet.chainId }),
});
const url = "https://own-node.example.invalid";
page.node(field).value = url;
await page.click(button);
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
url,
);
expect(page.text("flash-msg")).toBe(
"The URL was not saved because the network changed.",
);
},
);
// Such as one a newer build wrote, which this build cannot read. Nothing reads // Such as one a newer build wrote, which this build cannot read. Nothing reads
// or writes the stored record for it: the popup's next save finds it, as // or writes the stored record for it: the popup's next save finds it, as
// before. // before.
+272
View File
@@ -0,0 +1,272 @@
// USD prices are read from Chainlink price feeds on mainnet, through the RPC
// endpoint (https://git.eeqj.de/sneak/AutistMask/issues/525).
//
// The real refreshPrices() runs against a fake JSON-RPC node, answered through
// ethers' own request hook. The hook also records the body of every HTTP
// request, so a test can count them.
// prices.js pulls in state.js, which reads chrome.storage.local at load.
globalThis.chrome = {
storage: { local: { get: async () => ({}), set: async () => {} } },
};
const { AbiCoder, FetchRequest } = require("ethers");
const {
prices,
refreshPrices,
clearPrices,
getPrice,
getAddressValue,
} = require("../src/shared/prices");
const { state } = require("../src/shared/state");
const {
TOKENS,
ETH_USD_FEED,
USD_PRICE_FEEDS,
PRICE_FEED_BY_ADDRESS,
} = require("../src/shared/tokenList");
const RPC_URL = "https://rpc.example.invalid";
const NOW = Date.UTC(2026, 9, 27, 12, 0, 0);
const NOW_SECONDS = NOW / 1000;
const USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
const LINK = "0x514910771af9ca656af840dff83e8264ecf986ca";
const DAI = "0x6b175474e89094c44da98b954eedeac495271d0f";
// A token at an address of its own that calls itself USDC.
const FAKE_USDC = "0x9999999999999999999999999999999999999999";
const ETH_FEED = ETH_USD_FEED.address.toLowerCase();
const USDC_FEED = PRICE_FEED_BY_ADDRESS.get(USDC).address.toLowerCase();
const LINK_FEED = PRICE_FEED_BY_ADDRESS.get(LINK).address.toLowerCase();
const DAI_FEED = PRICE_FEED_BY_ADDRESS.get(DAI).address.toLowerCase();
// What each feed answers, by its lowercased address: the price in the feed's
// own units and the time it was written. A feed that is not here makes the
// call fail.
let rounds;
// The parsed body of every HTTP request the node received.
let requests;
let logged;
function round(answer, updatedAt = NOW_SECONDS) {
return { answer, updatedAt };
}
// One JSON-RPC answer, to a latestRoundData() call.
function reply(req) {
const envelope = { jsonrpc: "2.0", id: req.id };
const answer = rounds[req.params[0].to.toLowerCase()];
if (!answer) {
return {
...envelope,
error: { code: -32000, message: "fixture: read failed" },
};
}
return {
...envelope,
result: AbiCoder.defaultAbiCoder().encode(
["uint80", "int256", "uint256", "uint256", "uint80"],
[1, answer.answer, answer.updatedAt, answer.updatedAt, 1],
),
};
}
// The feed addresses one HTTP request read, sorted.
function feedsRead(body) {
return [body]
.flat()
.map((req) => req.params[0].to.toLowerCase())
.sort();
}
// One address that holds `held`, a list of [contract address, symbol].
function holdTokens(held) {
state.wallets = [
{
addresses: [
{
address: "0x" + "a".repeat(40),
balance: "1.0",
tokenBalances: held.map(([address, symbol]) => ({
address,
symbol,
balance: "10.0",
})),
},
],
},
];
}
beforeEach(() => {
clearPrices();
state.networkId = "mainnet";
state.rpcUrl = RPC_URL;
state.wallets = [];
state.trackedTokens = [];
rounds = { [ETH_FEED]: round(2000n * 10n ** 8n) };
requests = [];
logged = [];
jest.spyOn(Date, "now").mockReturnValue(NOW);
for (const level of ["error", "warn"]) {
jest.spyOn(console, level).mockImplementation((...args) => {
logged.push(args.map(String).join(" "));
});
}
FetchRequest.registerGetUrl(async (req) => {
const body = JSON.parse(Buffer.from(req.body).toString("utf8"));
requests.push(body);
const answer = Array.isArray(body) ? body.map(reply) : reply(body);
return {
statusCode: 200,
statusMessage: "OK",
headers: { "content-type": "application/json" },
body: Buffer.from(JSON.stringify(answer)),
};
});
});
afterEach(() => {
FetchRequest.registerGetUrl(FetchRequest.createGetUrlFunc());
jest.restoreAllMocks();
clearPrices();
});
describe("refreshPrices", () => {
test("reads ETH and each held or tracked token that has a feed in one HTTP request", async () => {
holdTokens([
[USDC, "USDC"],
[LINK, "LINK"],
]);
state.trackedTokens = [{ address: DAI, symbol: "DAI", decimals: 18 }];
rounds[USDC_FEED] = round(10n ** 8n);
rounds[LINK_FEED] = round(1150000000n);
rounds[DAI_FEED] = round(99990000n);
await refreshPrices();
expect(requests).toHaveLength(1);
expect(feedsRead(requests[0])).toEqual(
[ETH_FEED, USDC_FEED, LINK_FEED, DAI_FEED].sort(),
);
expect(getPrice("ETH")).toBe(2000);
expect(getPrice(USDC)).toBe(1);
expect(getPrice(LINK)).toBe(11.5);
expect(getPrice(DAI)).toBe(0.9999);
});
test("reads again only once 5 minutes have passed", async () => {
await refreshPrices();
Date.now.mockReturnValue(NOW + 299999);
await refreshPrices();
expect(requests).toHaveLength(1);
Date.now.mockReturnValue(NOW + 300000);
rounds[ETH_FEED] = round(2100n * 10n ** 8n, NOW_SECONDS + 300);
await refreshPrices();
expect(requests).toHaveLength(2);
expect(getPrice("ETH")).toBe(2100);
});
test("on Sepolia, reads nothing and keeps no price", async () => {
await refreshPrices();
expect(getPrice("ETH")).toBe(2000);
state.networkId = "sepolia";
await refreshPrices();
expect(requests).toHaveLength(1);
expect(Object.keys(prices)).toEqual([]);
});
});
describe("pairing by contract address", () => {
test("a token that copies a bundled token's symbol gets no price", async () => {
holdTokens([
[USDC, "USDC"],
[FAKE_USDC, "USDC"],
]);
rounds[USDC_FEED] = round(10n ** 8n);
await refreshPrices();
expect(feedsRead(requests[0])).toEqual([ETH_FEED, USDC_FEED].sort());
expect(getPrice(USDC)).toBe(1);
expect(getPrice(FAKE_USDC)).toBeNull();
// 1 ETH and 10 real USDC are priced; the 10 look-alikes are not.
expect(getAddressValue(state.wallets[0].addresses[0])).toEqual({
usd: 2010,
partial: true,
});
});
});
describe("freshness", () => {
test("a reading older than its feed's heartbeat plus 30 minutes is no price", async () => {
const heartbeatAgo =
NOW_SECONDS - PRICE_FEED_BY_ADDRESS.get(USDC).heartbeat;
holdTokens([[USDC, "USDC"]]);
rounds[USDC_FEED] = round(10n ** 8n, heartbeatAgo - 1800 - 1);
await refreshPrices();
expect(getPrice(USDC)).toBeNull();
clearPrices();
rounds[USDC_FEED] = round(10n ** 8n, heartbeatAgo - 1800);
await refreshPrices();
expect(getPrice(USDC)).toBe(1);
});
test.each([0n, -1n])("an answer of %s is no price", async (answer) => {
rounds[ETH_FEED] = round(answer);
await refreshPrices();
expect(getPrice("ETH")).toBeNull();
});
});
describe("a failed read", () => {
test("leaves the token with no price and is logged with its error", async () => {
holdTokens([[USDC, "USDC"]]);
rounds[USDC_FEED] = round(10n ** 8n);
await refreshPrices();
expect(getPrice(USDC)).toBe(1);
Date.now.mockReturnValue(NOW + 300000);
delete rounds[USDC_FEED];
await refreshPrices();
expect(getPrice(USDC)).toBeNull();
expect(getPrice("ETH")).toBe(2000);
expect(
logged.some(
(line) =>
line.includes("price feed read failed") &&
line.includes(USDC),
),
).toBe(true);
});
test("an HTTP error is logged with its status", async () => {
FetchRequest.registerGetUrl(async () => ({
statusCode: 401,
statusMessage: "Unauthorized",
headers: { "content-type": "text/plain" },
body: Buffer.from("API key required"),
}));
await refreshPrices();
expect(getPrice("ETH")).toBeNull();
expect(logged.some((line) => line.includes("401"))).toBe(true);
});
});
describe("the feed table", () => {
test("names each token by its address as the bundled list spells it", () => {
const listed = new Set(TOKENS.map((t) => t.address));
const unlisted = Object.keys(USD_PRICE_FEEDS).filter(
(address) => !listed.has(address),
);
expect(unlisted).toEqual([]);
});
});
-1
View File
@@ -88,7 +88,6 @@ test("the balance refresh", async () => {
wallets, wallets,
RPC_URL, RPC_URL,
"https://explorer.example.invalid/api/v2", "https://explorer.example.invalid/api/v2",
true,
[], [],
"mainnet", "mainnet",
); );
+5 -2
View File
@@ -90,7 +90,7 @@ let approvalDetails = null;
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
global.chrome = { global.chrome = {
storage: makeStorageStub(), storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
runtime: { runtime: {
connect: () => ({ connect: () => ({
postMessage() {}, postMessage() {},
@@ -220,11 +220,14 @@ async function refreshWith(balanceWei, tokenItems = []) {
state.wallets = [{ name: "Wallet 1", addresses: [{ address: HOLDER }] }]; state.wallets = [{ name: "Wallet 1", addresses: [{ address: HOLDER }] }];
state.selectedWallet = 0; state.selectedWallet = 0;
state.selectedAddress = 0; state.selectedAddress = 0;
// Blockscout is asked only while the stored "Use Blockscout" is on. The
// screens save this page's copy of "Use Blockscout" over the stored one. So
// the page's copy is turned on here too.
state.useBlockscout = true;
await refreshBalances( await refreshBalances(
state.wallets, state.wallets,
"https://rpc.example.invalid", "https://rpc.example.invalid",
"https://blockscout.example/api/v2", "https://blockscout.example/api/v2",
true,
state.trackedTokens, state.trackedTokens,
"mainnet", "mainnet",
); );
+8 -2
View File
@@ -100,7 +100,10 @@ global.fetch = jest.fn(() => {
}); });
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
global.chrome = { storage: makeStorageStub(), runtime: { sendMessage() {} } }; global.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
runtime: { sendMessage() {} },
};
// A stub DOM: every id resolves to a recording element. // A stub DOM: every id resolves to a recording element.
const elements = new Map(); const elements = new Map();
@@ -213,11 +216,14 @@ async function refreshWith(balanceWei, tokenItems = []) {
]; ];
state.selectedWallet = 0; state.selectedWallet = 0;
state.selectedAddress = 0; state.selectedAddress = 0;
// Blockscout is asked only while the stored "Use Blockscout" is on. The
// screens save this page's copy of "Use Blockscout" over the stored one. So
// the page's copy is turned on here too.
state.useBlockscout = true;
await refreshBalances( await refreshBalances(
state.wallets, state.wallets,
"https://rpc.example.invalid", "https://rpc.example.invalid",
"https://blockscout.example/api/v2", "https://blockscout.example/api/v2",
true,
state.trackedTokens, state.trackedTokens,
"mainnet", "mainnet",
); );
+5 -1
View File
@@ -27,8 +27,12 @@ let select;
function installStubDocument() { function installStubDocument() {
select = { innerHTML: "", children: [] }; select = { innerHTML: "", children: [] };
select.appendChild = (child) => select.children.push(child); select.appendChild = (child) => select.children.push(child);
const elements = {
"send-token": select,
"send-tokens-note": { classList: { toggle: () => {} } },
};
globalThis.document = { globalThis.document = {
getElementById: (id) => (id === "send-token" ? select : null), getElementById: (id) => elements[id] || null,
createElement: () => ({ value: "", textContent: "" }), createElement: () => ({ value: "", textContent: "" }),
}; };
} }
+36 -7
View File
@@ -23,6 +23,9 @@
// version field, and showing those users a wipe prompt would be a worse defect // 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. // than the one being fixed. It is migrated in place and keeps working.
const fs = require("fs");
const path = require("path");
const { const {
bootPopup, bootPopup,
cleanupPopup, cleanupPopup,
@@ -148,6 +151,29 @@ describe("the destructive reset on the recovery screen", () => {
}); });
}); });
// A key or xprv wallet has no recovery phrase, so the erase warning names all
// three backups (https://git.eeqj.de/sneak/AutistMask/issues/593). The boot
// harness holds no static text, so this reads the markup itself.
describe("the erase warning on the recovery screen", () => {
test("names the recovery phrase, the private key and the extended private key", () => {
const html = fs.readFileSync(
path.join(__dirname, "..", "src", "popup", "index.html"),
"utf8",
);
const start = html.indexOf('id="view-state-recovery"');
const end = html.indexOf('id="btn-state-recovery-reset"', start);
const screenText = html
.slice(start, end)
.replace(/<[^>]*>/g, " ")
.replace(/\s+/g, " ");
expect(screenText).toContain(
"If you kept a copy of a wallet's recovery phrase, private key or " +
"extended private key, you can add that wallet again.",
);
});
});
describe("a popup already open when the stored profile becomes unreadable", () => { describe("a popup already open when the stored profile becomes unreadable", () => {
// https://git.eeqj.de/sneak/AutistMask/issues/373. The popup used to stay // https://git.eeqj.de/sneak/AutistMask/issues/373. The popup used to stay
// on the wallet list with the last good balances, and only a reopen // on the wallet list with the last good balances, and only a reopen
@@ -523,13 +549,16 @@ describe("a garbage value in a field the gate does not check", () => {
}); });
test("a malformed tokenBalances entry is dropped, and the wallet and its address survive", async () => { test("a malformed tokenBalances entry is dropped, and the wallet and its address survive", async () => {
const env = await bootPopup( // "Use Blockscout" is on. Otherwise the boot's balance refresh would
profileWithTokenBalances([ // drop the well-formed entry too, since the user has not tracked its
null, // token.
42, const profile = profileWithTokenBalances([
{ address: TOKEN_ADDRESS, symbol: "AAA", balance: "2.0" }, null,
]), 42,
); { address: TOKEN_ADDRESS, symbol: "AAA", balance: "2.0" },
]);
profile.useBlockscout = true;
const env = await bootPopup(profile);
const stored = env.storage.read("autistmask"); const stored = env.storage.read("autistmask");
expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1"); expect(stored.wallets[0].encryptedSecret).toBe("encrypted-secret-1");
+2 -3
View File
@@ -6,9 +6,8 @@
// now holds a lock from its read to its write. // now holds a lock from its read to its write.
// //
// The popup and the background run here as the real modules over one shared // The popup and the background run here as the real modules over one shared
// storage stub, and share the lock the way the background and a page outside // storage stub, and share the lock the way the background and its pages share
// a Firefox private window share the browser's // the browser's (tests/support/navigatorLocks.js).
// (tests/support/navigatorLocks.js).
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
+2 -3
View File
@@ -4,9 +4,8 @@
// the callback settles, whether it resolved or rejected. That is what the // the callback settles, whether it resolved or rejected. That is what the
// browser's own does for the one call the extension makes, // browser's own does for the one call the extension makes,
// `navigator.locks.request(name, callback)`. Every module a test file loads // `navigator.locks.request(name, callback)`. Every module a test file loads
// shares it, as the extension's background and its pages share the browser's, // shares it, as the extension's background and its pages share the browser's
// except a page in a Firefox private window (README, "Stored state and its // (README, "Stored state and its version").
// version").
// //
// Run before each test file by `setupFiles` in package.json. // Run before each test file by `setupFiles` in package.json.
+2
View File
@@ -283,6 +283,8 @@ async function bootPopup(stored, options) {
jest.doMock("../../src/shared/balances", () => ({ jest.doMock("../../src/shared/balances", () => ({
fetchTokenBalances: jest.fn(async () => []), fetchTokenBalances: jest.fn(async () => []),
refreshBalances: jest.fn(async () => {}), refreshBalances: jest.fn(async () => {}),
dropUntrackedTokens: jest.requireActual("../../src/shared/balances")
.dropUntrackedTokens,
lookupTokenInfo: jest.fn(async () => null), lookupTokenInfo: jest.fn(async () => null),
getProvider: () => ({}), getProvider: () => ({}),
scanForAddresses: jest.fn(async () => ({ scanForAddresses: jest.fn(async () => ({
+22 -25
View File
@@ -52,8 +52,14 @@ jest.mock("../src/shared/log", () => ({
global.fetch = jest.fn(() => { global.fetch = jest.fn(() => {
throw new Error("tests must not perform network requests"); throw new Error("tests must not perform network requests");
}); });
// Blockscout is asked only while the stored "Use Blockscout" is on.
global.chrome = { global.chrome = {
storage: { local: { get: async () => ({}), set: async () => {} } }, storage: {
local: {
get: async () => ({ autistmask: { useBlockscout: true } }),
set: async () => {},
},
},
}; };
const { isSpoofedSymbol } = require("../src/shared/symbolSpoof"); const { isSpoofedSymbol } = require("../src/shared/symbolSpoof");
@@ -485,8 +491,12 @@ describe("surface 2: the Send token selector", () => {
function render(tokenBalances) { function render(tokenBalances) {
select = { innerHTML: "", children: [] }; select = { innerHTML: "", children: [] };
select.appendChild = (child) => select.children.push(child); select.appendChild = (child) => select.children.push(child);
const elements = {
"send-token": select,
"send-tokens-note": { classList: { toggle: () => {} } },
};
globalThis.document = { globalThis.document = {
getElementById: (id) => (id === "send-token" ? select : null), getElementById: (id) => elements[id] || null,
createElement: () => ({ value: "", textContent: "" }), createElement: () => ({ value: "", textContent: "" }),
}; };
renderSendTokenSelect({ renderSendTokenSelect({
@@ -582,14 +592,12 @@ describe("surface 3: the balance list", () => {
// 1,000-holder floor and was listed as a holding named ETH. // 1,000-holder floor and was listed as a holding named ETH.
test("a fake ETH token clearing the holder floor is filtered", async () => { test("a fake ETH token clearing the holder floor is filtered", async () => {
respondWith([fakeEthItem()]); respondWith([fakeEthItem()]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
test("tracking the fake token manually does not admit it either", async () => { test("tracking the fake token manually does not admit it either", async () => {
respondWith([fakeEthItem({ holders_count: "0" })]); respondWith([fakeEthItem({ holders_count: "0" })]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [ const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, [
{ address: FAKE_ETH_CONTRACT }, { address: FAKE_ETH_CONTRACT },
]); ]);
expect(balances).toEqual([]); expect(balances).toEqual([]);
@@ -599,16 +607,12 @@ describe("surface 3: the balance list", () => {
// their belief about what they own, and it renders the symbol into HTML. // their belief about what they own, and it renders the symbol into HTML.
test("a padded fake ETH token is filtered too", async () => { test("a padded fake ETH token is filtered too", async () => {
respondWith([fakeEthItem({ symbol: " ETH " })]); respondWith([fakeEthItem({ symbol: " ETH " })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
test("a fake ETH token padded with a no-break space is filtered", async () => { test("a fake ETH token padded with a no-break space is filtered", async () => {
respondWith([fakeEthItem({ symbol: NBSP + "ETH" + NBSP })]); respondWith([fakeEthItem({ symbol: NBSP + "ETH" + NBSP })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
// The false-positive direction on the surface that matters most: a real // The false-positive direction on the surface that matters most: a real
@@ -623,7 +627,7 @@ describe("surface 3: the balance list", () => {
decimals: "6", decimals: "6",
}), }),
]); ]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
expect(balances[0].symbol).toBe(" USDC "); expect(balances[0].symbol).toBe(" USDC ");
}); });
@@ -637,7 +641,7 @@ describe("surface 3: the balance list", () => {
decimals: "6", decimals: "6",
}), }),
]); ]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
expect(balances[0].symbol).toBe("USDC"); expect(balances[0].symbol).toBe("USDC");
}); });
@@ -648,9 +652,7 @@ describe("surface 3: the balance list", () => {
// before the symbol rule is consulted. // before the symbol rule is consulted.
test("a non-ERC-20 row claiming ETH never reaches the symbol rule", async () => { test("a non-ERC-20 row claiming ETH never reaches the symbol rule", async () => {
respondWith([fakeEthItem({ type: "ERC-721" })]); respondWith([fakeEthItem({ type: "ERC-721" })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
// The adjacent finding from the same review as issue #260: the type gate // The adjacent finding from the same review as issue #260: the type gate
@@ -668,20 +670,16 @@ describe("surface 3: the balance list", () => {
decimals: "6", decimals: "6",
}), }),
]); ]);
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
expect(balances).toHaveLength(1); expect(balances).toHaveLength(1);
expect(balances[0].symbol).toBe("USDC"); expect(balances[0].symbol).toBe("USDC");
}); });
test("case insensitivity does not admit another token type", async () => { test("case insensitivity does not admit another token type", async () => {
respondWith([fakeEthItem({ type: "erc-721" })]); respondWith([fakeEthItem({ type: "erc-721" })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
respondWith([fakeEthItem({ type: "ERC-20-EXTRA" })]); respondWith([fakeEthItem({ type: "ERC-20-EXTRA" })]);
expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, [])).toEqual( expect(await fetchTokenBalances(HOLDER, BLOCKSCOUT, [])).toEqual([]);
[],
);
}); });
// The money test: the user holds real ETH and has been airdropped a fake // The money test: the user holds real ETH and has been airdropped a fake
@@ -694,7 +692,6 @@ describe("surface 3: the balance list", () => {
[{ addresses: [addr] }], [{ addresses: [addr] }],
"https://rpc.example.invalid", "https://rpc.example.invalid",
BLOCKSCOUT, BLOCKSCOUT,
true,
[], [],
"mainnet", "mainnet",
); );
+7 -5
View File
@@ -38,8 +38,14 @@ jest.mock("../src/shared/log", () => ({
isDebug: () => false, isDebug: () => false,
})); }));
// Blockscout is asked only while the stored "Use Blockscout" is on.
globalThis.chrome = { globalThis.chrome = {
storage: { local: { get: async () => ({}), set: async () => {} } }, storage: {
local: {
get: async () => ({ autistmask: { useBlockscout: true } }),
set: async () => {},
},
},
}; };
const { state } = require("../src/shared/state"); const { state } = require("../src/shared/state");
@@ -178,7 +184,6 @@ test("a token transfer's decoded details name the token contract and the amount
const [row] = await fetchRecentTransactions( const [row] = await fetchRecentTransactions(
HOLDER, HOLDER,
EXPLORER, EXPLORER,
true,
NETWORKS.mainnet.chainId, NETWORKS.mainnet.chainId,
); );
expect(row.to).toBe(RECIPIENT); expect(row.to).toBe(RECIPIENT);
@@ -211,7 +216,6 @@ test("with mainnet active, a Sepolia transaction is read from Sepolia's Blocksco
const [row] = await fetchRecentTransactions( const [row] = await fetchRecentTransactions(
HOLDER, HOLDER,
EXPLORER, EXPLORER,
true,
NETWORKS.sepolia.chainId, NETWORKS.sepolia.chainId,
); );
@@ -240,7 +244,6 @@ test("with mainnet active and no Blockscout remembered for Sepolia, a Sepolia tr
const [row] = await fetchRecentTransactions( const [row] = await fetchRecentTransactions(
HOLDER, HOLDER,
EXPLORER, EXPLORER,
true,
NETWORKS.sepolia.chainId, NETWORKS.sepolia.chainId,
); );
mockAsked.length = 0; mockAsked.length = 0;
@@ -262,7 +265,6 @@ async function showSepoliaTransferWithMainnetActive() {
const [row] = await fetchRecentTransactions( const [row] = await fetchRecentTransactions(
HOLDER, HOLDER,
EXPLORER, EXPLORER,
true,
NETWORKS.sepolia.chainId, NETWORKS.sepolia.chainId,
); );
transactionDetail.show(row); transactionDetail.show(row);
+6 -1
View File
@@ -9,6 +9,12 @@
const { AbiCoder, FetchRequest } = require("ethers"); const { AbiCoder, FetchRequest } = require("ethers");
const { refreshBalances } = require("../src/shared/balances"); const { refreshBalances } = require("../src/shared/balances");
const { makeStorageStub } = require("./support/storageStub");
// Blockscout is asked only while the stored "Use Blockscout" is on.
globalThis.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
};
const RPC_URL = "https://rpc.example.invalid"; const RPC_URL = "https://rpc.example.invalid";
const EXPLORER_URL = "https://explorer.example.invalid/api/v2"; const EXPLORER_URL = "https://explorer.example.invalid/api/v2";
@@ -132,7 +138,6 @@ async function refresh(addresses, trackedTokens) {
[{ addresses }], [{ addresses }],
RPC_URL, RPC_URL,
EXPLORER_URL, EXPLORER_URL,
true,
trackedTokens, trackedTokens,
"mainnet", "mainnet",
new AbortController().signal, new AbortController().signal,
+72
View File
@@ -177,6 +177,78 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
expect(onSepolia).not.toContain("DAI"); expect(onSepolia).not.toContain("DAI");
}); });
// Another popup page tracks DAI on Ethereum Mainnet after this page's last
// save. The switch's save writes only the token lists that this page changed.
// So DAI stays in `trackedTokens`, the active network's list.
test("a token another page tracked before a switch in Settings stays in trackedTokens", async () => {
const boot = await bootPopup(unversionedValidProfile());
expect(boot.pageErrors).toEqual([]);
boot.storage.write("autistmask", {
...boot.storage.read("autistmask"),
trackedTokens: [MAINNET_TOKEN],
});
await boot.click("btn-settings");
await chooseNetwork(boot, "sepolia");
const stored = boot.storage.read("autistmask");
expect(stored.networkId).toBe("sepolia");
expect(stored.trackedTokens).toEqual([MAINNET_TOKEN]);
expect(stored.networkTrackedTokens.mainnet).toEqual([]);
});
// The contract lookup on SettingsAddToken answers on Ethereum Mainnet while the
// switch to Sepolia waits for the lock. The page adds the token to Ethereum
// Mainnet's list. The switch then keeps that list for Ethereum Mainnet.
test("a token added while a switch in Settings waits for the lock stays tracked on Ethereum Mainnet", async () => {
const boot = await bootOnAddToken("mainnet");
expect(boot.pageErrors).toEqual([]);
const { lookupTokenInfo } = require("../src/shared/balances");
let answer;
lookupTokenInfo.mockImplementationOnce(
() =>
new Promise((resolve) => {
answer = resolve;
}),
);
boot.node("settings-addtoken-address").value = NEW_TOKEN_ADDRESS;
const adding = boot.click("btn-settings-addtoken-manual");
await boot.click("btn-settings");
// Another write holds the lock, so the switch's save waits for it.
let releaseLock;
const lockHeld = navigator.locks.request(
"autistmask",
() =>
new Promise((resolve) => {
releaseLock = resolve;
}),
);
const select = boot.node("settings-network");
select.value = "sepolia";
const switching = Promise.all(select.listeners.change.map((fn) => fn()));
await boot.settle();
answer({ symbol: "NEW", decimals: 18, name: "New Token" });
await boot.settle();
releaseLock();
await lockHeld;
await switching;
await adding;
const stored = boot.storage.read("autistmask");
expect(stored.networkId).toBe("sepolia");
expect(stored.trackedTokens).toEqual([]);
expect(stored.networkTrackedTokens.mainnet).toEqual([
{
address: NEW_TOKEN_ADDRESS,
symbol: "NEW",
decimals: 18,
name: "New Token",
},
]);
});
describe("Back after a switch from the Settings gear", () => { describe("Back after a switch from the Settings gear", () => {
test("SettingsAddToken no longer offers the common tokens", async () => { test("SettingsAddToken no longer offers the common tokens", async () => {
const boot = await bootOnAddToken("mainnet"); const boot = await bootOnAddToken("mainnet");
+11 -51
View File
@@ -1215,11 +1215,13 @@ function respondWith(txItems, tokenTransferItems) {
describe("fetchRecentTransactions merge and dedup", () => { describe("fetchRecentTransactions merge and dedup", () => {
beforeEach(() => { beforeEach(() => {
debugFetch.mockReset(); debugFetch.mockReset();
// Blockscout is asked only while the stored "Use Blockscout" is on.
global.chrome.storage.write("autistmask", { useBlockscout: true });
}); });
test("queries only the two Blockscout endpoints for the address", async () => { test("queries only the two Blockscout endpoints for the address", async () => {
respondWith([], []); respondWith([], []);
await fetchRecentTransactions(VICTIM, BLOCKSCOUT, true, "0x1"); await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
expect(debugFetch).toHaveBeenCalledTimes(2); expect(debugFetch).toHaveBeenCalledTimes(2);
const urls = debugFetch.mock.calls.map((c) => c[0]); const urls = debugFetch.mock.calls.map((c) => c[0]);
expect(urls).toContain( expect(urls).toContain(
@@ -1283,12 +1285,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
], ],
); );
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs).toHaveLength(1); expect(txs).toHaveLength(1);
const merged = txs[0]; const merged = txs[0];
// The received leg (the swap output) supplies the display amount. // The received leg (the swap output) supplies the display amount.
@@ -1325,12 +1322,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
], ],
); );
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs).toHaveLength(1); expect(txs).toHaveLength(1);
expect(txs[0].symbol).toBe("USDC"); expect(txs[0].symbol).toBe("USDC");
expect(txs[0].value).toBe("1500.5000"); expect(txs[0].value).toBe("1500.5000");
@@ -1356,12 +1348,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
}); });
respondWith([], [leg("1000000"), leg("2000000")]); respondWith([], [leg("1000000"), leg("2000000")]);
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs).toHaveLength(1); expect(txs).toHaveLength(1);
// Keyed by hash plus contract, so the later leg wins. // Keyed by hash plus contract, so the later leg wins.
expect(txs[0].exactValue).toBe("2.0"); expect(txs[0].exactValue).toBe("2.0");
@@ -1401,12 +1388,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
], ],
); );
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs.map((t) => t.symbol).sort()).toEqual(["USDC", "WETH"]); expect(txs.map((t) => t.symbol).sort()).toEqual(["USDC", "WETH"]);
}); });
@@ -1447,12 +1429,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
], ],
); );
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs).toHaveLength(1); expect(txs).toHaveLength(1);
expect(txs[0].symbol).toBe("USDC"); expect(txs[0].symbol).toBe("USDC");
expect(txs[0].exactValue).toBe("1.0"); expect(txs[0].exactValue).toBe("1.0");
@@ -1478,13 +1455,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
}); });
respondWith([item(6), item(8), item(7)], []); respondWith([item(6), item(8), item(7)], []);
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1", 2);
VICTIM,
BLOCKSCOUT,
true,
"0x1",
2,
);
expect(txs.map((t) => t.blockNumber)).toEqual([21000008, 21000007]); expect(txs.map((t) => t.blockNumber)).toEqual([21000008, 21000007]);
}); });
@@ -1510,7 +1481,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const sepolia = await fetchRecentTransactions( const sepolia = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0xaa36a7", "0xaa36a7",
); );
expect(sepolia[0].symbol).toBe("SepoliaETH"); expect(sepolia[0].symbol).toBe("SepoliaETH");
@@ -1519,7 +1489,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const mainnet = await fetchRecentTransactions( const mainnet = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0x1", "0x1",
); );
expect(mainnet[0].symbol).toBe("ETH"); expect(mainnet[0].symbol).toBe("ETH");
@@ -1546,12 +1515,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
], ],
); );
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1");
VICTIM,
BLOCKSCOUT,
true,
"0x1",
);
expect(txs).toHaveLength(1); expect(txs).toHaveLength(1);
expect(txs[0].contractAddress).toBe(FAKE_ETH_CONTRACT); expect(txs[0].contractAddress).toBe(FAKE_ETH_CONTRACT);
expect(txs[0].holders).toBe(0); expect(txs[0].holders).toBe(0);
@@ -1593,7 +1557,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0x1", "0x1",
); );
expect(txs[0].holders).toBeNull(); expect(txs[0].holders).toBeNull();
@@ -1604,7 +1567,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0x1", "0x1",
); );
expect(txs[0].holders).toBeNull(); expect(txs[0].holders).toBeNull();
@@ -1615,7 +1577,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0x1", "0x1",
); );
expect(filterTransactions(txs, filters()).transactions).toEqual( expect(filterTransactions(txs, filters()).transactions).toEqual(
@@ -1632,7 +1593,6 @@ describe("fetchRecentTransactions merge and dedup", () => {
const txs = await fetchRecentTransactions( const txs = await fetchRecentTransactions(
VICTIM, VICTIM,
BLOCKSCOUT, BLOCKSCOUT,
true,
"0x1", "0x1",
); );
expect(txs[0].holders).toBe(0); expect(txs[0].holders).toBe(0);
@@ -1650,7 +1610,7 @@ describe("fetchRecentTransactions merge and dedup", () => {
}, },
})); }));
await expect( await expect(
fetchRecentTransactions(VICTIM, BLOCKSCOUT, true, "0x1"), fetchRecentTransactions(VICTIM, BLOCKSCOUT, "0x1"),
).resolves.toEqual([]); ).resolves.toEqual([]);
}); });
+693 -9
View File
@@ -2871,8 +2871,9 @@ describe("uniswap decoder", () => {
...USDT_400_GROUP, ...USDT_400_GROUP,
...ONE_USDT_LINES(OTHER_ADDR), ...ONE_USDT_LINES(OTHER_ADDR),
], ],
// The last swap step's minimum. // Both swap steps pay USDC to the user, so the minimum
minimum: "390.0000 USDC", // is the sum of their two minimums.
minimum: "980.0000 USDC",
}, },
])( ])(
"$kind shows each take's own lines and the allowances, and no Amount figure or Min. received", "$kind shows each take's own lines and the allowances, and no Amount figure or Min. received",
@@ -3310,6 +3311,683 @@ describe("uniswap decoder", () => {
expect(detail(result, "Amount").value).toBe("Up to 1000.0000 USDT"); expect(detail(result, "Amount").value).toBe("Up to 1000.0000 USDT");
}); });
// https://git.eeqj.de/sneak/AutistMask/issues/660 — Permit2 has no
// allowance of ETH, so a permit on the zero address reads as one on a
// token nothing knows. On next at 53551c6 such a permit's Allowance
// token line read ETH. A permit of 1 wei of the zero address before a
// V4 step of 5 ETH made the Amount line read 0.000000000000000001 ETH.
// With that permit to another spender and a SETTLE the router pays, no
// line gave the 5 ETH.
describe("a permit on the zero address", () => {
const FIVE_ETH = 5000000000000000000n;
// The lines of a permit of `amount` base units of the zero
// address for `spender`.
const zeroAddressLines = (amount, spender) => [
[
"Permit2 allowance",
amount + " base units (decimals unknown)",
],
["Allowance token", ZERO_ADDR],
["Allowance spender", getAddress(spender)],
];
// A V4 swap of 5 ETH for USDC. The user pays its SETTLE when
// `payerIsUser` is true; otherwise the router pays it from the
// transaction's value.
const v4FiveEth = (payerIsUser) =>
encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactInSingle(
ZERO_ADDR,
USDC_ADDR,
FIVE_ETH,
1n,
),
settle(ZERO_ADDR, FIVE_ETH, payerIsUser),
encodeV4TakeAll(USDC_ADDR, 1n),
],
);
test("a PERMIT2_PERMIT on the zero address names the address", () => {
const result = decodeSteps(
[0x00, 0x0a],
[
V3_600,
encodePermit2(
ZERO_ADDR,
1000000000000000000n,
ROUTER_ADDR,
),
],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "600.0000 USDT"],
...zeroAddressLines("1000000000000000000", ROUTER_ADDR),
]);
expect(detail(result, "Allowance token").address).toBe(
ZERO_ADDR,
);
});
test("a PERMIT2_PERMIT_BATCH entry on the zero address names the address", () => {
const result = decodeSteps(
[0x03, 0x00],
[
encodePermit2Batch(
[
[USDT_ADDR, USDT_600],
[ZERO_ADDR, 1000000000000000000n],
],
ROUTER_ADDR,
),
V3_600,
],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "600.0000 USDT"],
...USDT_600_LINES,
...zeroAddressLines("1000000000000000000", ROUTER_ADDR),
]);
});
test("a PERMIT2_PERMIT of 1 wei of the zero address, then a V4 step of 5 ETH the user settles, shows the 5 ETH", () => {
const result = decodeSteps(
[0x0a, 0x10],
[
encodePermit2(ZERO_ADDR, 1n, ROUTER_ADDR),
v4FiveEth(true),
],
);
expect(detail(result, "Token In").value).toBe("ETH (native)");
expect(linesBetweenTokens(result)).toEqual([
["Amount", "5.0000 ETH"],
...zeroAddressLines("1", ROUTER_ADDR),
]);
});
test("a PERMIT2_PERMIT of 1 wei of the zero address to another spender, then a V4 step of 5 ETH the router settles, shows the 5 ETH", () => {
const result = decodeSteps(
[0x0a, 0x10],
[
encodePermit2(ZERO_ADDR, 1n, OTHER_ADDR),
v4FiveEth(false),
],
);
expect(detail(result, "Token In").value).toBe("ETH (native)");
expect(linesBetweenTokens(result)).toEqual([
["Amount", "5.0000 ETH"],
...zeroAddressLines("1", OTHER_ADDR),
]);
});
test("a PERMIT2_PERMIT_BATCH entry of 1 wei of the zero address to another spender, then a V4 step of 5 ETH the router settles, shows the 5 ETH", () => {
const result = decodeSteps(
[0x03, 0x10],
[
encodePermit2Batch([[ZERO_ADDR, 1n]], OTHER_ADDR),
v4FiveEth(false),
],
);
expect(detail(result, "Token In").value).toBe("ETH (native)");
expect(linesBetweenTokens(result)).toEqual([
["Amount", "5.0000 ETH"],
...zeroAddressLines("1", OTHER_ADDR),
]);
});
});
// https://git.eeqj.de/sneak/AutistMask/issues/685 — Permit2 moves no
// ETH, so a PERMIT2_TRANSFER_FROM of the zero address reads as a move
// of a token nothing knows. On next at ec6b6b5 its lines read ETH,
// with an ETH figure.
describe("a PERMIT2_TRANSFER_FROM of the zero address", () => {
const MOVED_AMOUNT =
"1000000000000000000 base units (decimals unknown)";
test("to another address names the address", () => {
const result = decodeSteps(
[0x00, 0x02],
[V3_600, transfer(ZERO_ADDR, OTHER_ADDR, ONE_WETH)],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "600.0000 USDT"],
["Moved from the sender", MOVED_AMOUNT],
["Token moved", ZERO_ADDR],
["Moved to", OTHER_ADDR],
]);
expect(detail(result, "Token moved").address).toBe(ZERO_ADDR);
});
test("into the router names the address", () => {
const result = decodeSteps(
[0x02, 0x00],
[transfer(ZERO_ADDR, ROUTER_ADDR, ONE_WETH), V3_600],
);
expect(detail(result, "Paid to").value).toBe(
"The router, " +
MOVED_AMOUNT +
" from the sender (later steps may not spend all of it)",
);
expect(detail(result, "Token moved into the router")).toEqual({
label: "Token moved into the router",
value: ZERO_ADDR,
address: ZERO_ADDR,
isToken: true,
});
});
// The V4 step's SETTLE names the user as payer and states no
// amount. The step's lines say that the ETH amount is not known.
test("after a V4 exact-out step of ETH, also shows that the ETH amount is not known", () => {
const v4EthExactOut = encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_OUT_SINGLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactOutSingle(
ZERO_ADDR,
USDC_ADDR,
590000000n,
ONE_WETH,
),
encodeV4Settle(ZERO_ADDR),
encodeV4TakeAll(USDC_ADDR, 0n),
],
);
const result = decodeSteps(
[0x10, 0x02],
[v4EthExactOut, transfer(ZERO_ADDR, OTHER_ADDR, ONE_WETH)],
);
expect(detail(result, "Token In").value).toBe("ETH (native)");
expect(linesBetweenTokens(result)).toEqual([
["Moved from the sender", UNDECODED],
["Token moved", "ETH"],
["Moved to", "The swap step that spends it"],
["Moved from the sender", MOVED_AMOUNT],
["Token moved", ZERO_ADDR],
["Moved to", OTHER_ADDR],
]);
});
});
// https://git.eeqj.de/sneak/AutistMask/issues/682 — V4 pays a SETTLE
// of ETH from the router's own ETH, whichever payer the SETTLE names,
// and the router holds the transaction's value. On next at 36b2002 a
// SETTLE of 1 ETH that names the router as payer gave no ETH line.
describe("a V4 SETTLE of ETH that names the router as payer", () => {
const ONE_ETH = 1000000000000000000n;
// A V4 swap of `amount` of ETH for USDC. The SETTLE names the
// router as payer.
const v4EthFromRouter = (amount) =>
encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactInSingle(ZERO_ADDR, USDC_ADDR, amount, 1n),
settle(ZERO_ADDR, amount, false),
encodeV4TakeAll(USDC_ADDR, 1n),
],
);
test("after a V3 exact-in of 600 USDT, shows the 1 ETH moved from the sender", () => {
const result = decodeSteps(
[0x00, 0x10],
[V3_600, v4EthFromRouter(ONE_ETH)],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "600.0000 USDT"],
["Moved from the sender", "1.0000 ETH"],
["Token moved", "ETH"],
["Moved to", "The swap step that spends it"],
]);
});
// The UNWRAP_WETH leaves ETH in the router. The SETTLE may spend
// that ETH before the transaction's value.
test("after an UNWRAP_WETH into the router, shows at most 1 ETH moved from the sender", () => {
const result = decodeSteps(
[0x00, 0x0c, 0x10],
[
encodeV3SwapExactIn(ROUTER_ADDR, USDT_600, 1n, [
USDT_ADDR,
WETH_ADDR,
]),
encodeWrapEth(ROUTER_ADDR, 0n), // UNWRAP_WETH, same encoding
v4EthFromRouter(ONE_ETH),
],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "600.0000 USDT"],
["Moved from the sender", "Up to 1.0000 ETH"],
["Token moved", "ETH"],
["Moved to", "The swap step that spends it"],
]);
});
test("after a WRAP_ETH of 0.5 ETH, adds the SETTLE's 0.5 ETH to the Amount line", () => {
const result = decodeSteps(
[0x0b, 0x10],
[
encodeWrapEth(ROUTER_ADDR, ONE_ETH / 2n),
v4EthFromRouter(ONE_ETH / 2n),
],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "1.0000 ETH"],
]);
});
// The WRAP_ETH sets Token In to ETH, and the UNWRAP_WETH leaves
// ETH in the router. The SETTLE may spend that ETH before the
// transaction's value, so its 1 ETH never joins the Amount line.
test("after a WRAP_ETH and an UNWRAP_WETH into the router, keeps the Amount line and shows at most 1 ETH moved from the sender", () => {
const result = decodeSteps(
[0x0b, 0x0c, 0x10],
[
encodeWrapEth(ROUTER_ADDR, ONE_ETH / 2n),
encodeWrapEth(ROUTER_ADDR, 0n), // UNWRAP_WETH, same encoding
v4EthFromRouter(ONE_ETH),
],
);
expect(linesBetweenTokens(result)).toEqual([
["Amount", "0.5000 ETH"],
["Moved from the sender", "Up to 1.0000 ETH"],
["Token moved", "ETH"],
["Moved to", "The swap step that spends it"],
]);
});
// A SETTLE of CONTRACT_BALANCE pays all the router holds, an
// amount the calldata does not state.
test("of CONTRACT_BALANCE, on the step that sets the input side, shows an unknown amount moved from the sender", () => {
const result = decodeSteps(
[0x10],
[
encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactInSingle(
ZERO_ADDR,
USDC_ADDR,
ONE_ETH,
1n,
),
settle(ZERO_ADDR, 2n ** 255n, false), // CONTRACT_BALANCE
encodeV4TakeAll(USDC_ADDR, 1n),
],
),
],
);
expect(linesBetweenTokens(result)).toEqual([
["Moved from the sender", UNDECODED],
["Token moved", "ETH"],
["Moved to", "The swap step that spends it"],
]);
});
});
// https://git.eeqj.de/sneak/AutistMask/issues/647 — on next at
// f550d8c, a split whose steps each pay WETH to the user showed only
// the last step's minimum.
describe("the minimum of a split that pays WETH to the user", () => {
const WETH_01 = 100000000000000000n;
const WETH_02 = 200000000000000000n;
const WETH_03 = 300000000000000000n;
// A V3 exact-in of 600 USDT for at least 0.3 WETH, and a V2
// exact-in of 400 USDT for at least 0.2 WETH, each paid to the
// user.
const V3_TO_WETH = encodeV3SwapExactIn(
USER_ADDR,
USDT_600,
WETH_03,
[USDT_ADDR, WETH_ADDR],
);
const V2_TO_WETH = encodeV2SwapExactIn(
USER_ADDR,
USDT_400,
WETH_02,
[USDT_ADDR, WETH_ADDR],
);
// A V4 step that swaps 400 USDT for at least 0.2 WETH, with these
// TAKEs of the WETH.
const v4ToWeth = (...takes) =>
encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
...takes.map(() => V4_TAKE_ID),
]),
[
encodeV4ExactInSingle(
USDT_ADDR,
WETH_ADDR,
USDT_400,
WETH_02,
),
encodeV4Settle(USDT_ADDR), // paid by the user
...takes,
],
);
// The swap's minimum line as [label, value], or undefined.
const minimum = (result) =>
result.details
.filter(
(d) =>
d.label === "Min. received" ||
d.label === "Min. paid out",
)
.map((d) => [d.label, d.value])[0];
test("a V3 and a V2 exact-in show the total of their minimums", () => {
const result = decodeSteps(
[0x00, 0x08],
[V3_TO_WETH, V2_TO_WETH],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.5000 WETH",
]);
});
test("a V3 exact-in and a V4 step show the total of their minimums", () => {
const result = decodeSteps(
[0x00, 0x10],
[V3_TO_WETH, v4ToWeth(encodeV4Take(WETH_ADDR))],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.5000 WETH",
]);
});
// The second route buys DAI for the router, then swaps all of it
// from the router for at least 0.2 WETH.
test("a route that hops through DAI counts its last hop's minimum", () => {
const result = decodeSteps(
[0x00, 0x08, 0x00],
[
V3_TO_WETH,
encodeV2SwapExactIn(ROUTER_ADDR, USDT_400, DAI_400, [
USDT_ADDR,
DAI_ADDR,
]),
coder.encode(
["address", "uint256", "uint256", "bytes", "bool"],
[
USER_ADDR,
2n ** 255n, // CONTRACT_BALANCE
WETH_02,
encodeV3Path([DAI_ADDR, WETH_ADDR]),
false, // paid from the router
],
),
],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.5000 WETH",
]);
});
// The middle step swaps 0.3 of the user's WETH for USDC, so the
// sum of minimums starts again after it.
test.each([
{
kind: "a V3 exact-in",
command: 0x00,
input: encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
WETH_ADDR,
USDC_ADDR,
]),
},
{
kind: "a V2 exact-in",
command: 0x08,
input: encodeV2SwapExactIn(USER_ADDR, WETH_03, 1n, [
WETH_ADDR,
USDC_ADDR,
]),
},
{
kind: "a V2 exact-out",
command: 0x09,
input: encodeV2SwapExactOut(USER_ADDR, 1n, WETH_03, [
WETH_ADDR,
USDC_ADDR,
]),
},
{
kind: "a V3 exact-out",
command: 0x01,
input: encodeV3SwapExactOut(USER_ADDR, 1n, WETH_03, [
USDC_ADDR,
WETH_ADDR,
]),
},
])(
"$kind that spends WETH between them leaves the last step's minimum",
({ command, input }) => {
const result = decodeSteps(
[0x00, command, 0x08],
[V3_TO_WETH, input, V2_TO_WETH],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.2000 WETH",
]);
},
);
// The middle step swaps 0.3 WETH and 400 DAI for USDC, both paid
// by the user. It spends WETH whichever SETTLE comes last.
test.each([
{ order: "WETH first", settled: [WETH_ADDR, DAI_ADDR] },
{ order: "DAI first", settled: [DAI_ADDR, WETH_ADDR] },
])(
"a V4 step that spends WETH and DAI between them leaves the last step's minimum, with the SETTLE of $order",
({ settled }) => {
const wethAndDaiForUsdc = encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactInSingle(
WETH_ADDR,
USDC_ADDR,
WETH_03,
1n,
),
encodeV4ExactInSingle(
DAI_ADDR,
USDC_ADDR,
DAI_400,
1n,
),
...settled.map((token) => encodeV4Settle(token)),
encodeV4TakeAll(USDC_ADDR, 0n),
],
);
const result = decodeSteps(
[0x00, 0x10, 0x08],
[V3_TO_WETH, wethAndDaiForUsdc, V2_TO_WETH],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.2000 WETH",
]);
},
);
// The middle step's swap actions buy WETH with the user's USDT,
// then swap all of that WETH for USDC.
test("a V4 step that swaps through WETH between them leaves the last step's minimum", () => {
const usdtToUsdcThroughWeth = encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SWAP_EXACT_IN_SINGLE_ID,
V4_SETTLE_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactInSingle(
USDT_ADDR,
WETH_ADDR,
USDT_400,
WETH_01,
),
encodeV4ExactInSingle(WETH_ADDR, USDC_ADDR, 0n, 1n),
encodeV4Settle(USDT_ADDR), // paid by the user
encodeV4TakeAll(USDC_ADDR, 0n),
],
);
const result = decodeSteps(
[0x00, 0x10, 0x08],
[V3_TO_WETH, usdtToUsdcThroughWeth, V2_TO_WETH],
);
expect(minimum(result)).toEqual([
"Min. received",
"0.2000 WETH",
]);
});
// The middle step has no swap action. Its SETTLE or SETTLE_ALL
// pays 0.3 WETH, and its TAKE pays that WETH to another address.
test.each([
{
payment: "a SETTLE of WETH paid by the user",
actions: [V4_SETTLE_ID, V4_TAKE_ID],
params: [
settle(WETH_ADDR, WETH_03, true),
take(WETH_ADDR, OTHER_ADDR, 0n),
],
},
{
payment: "a SETTLE of WETH paid from the router",
actions: [V4_SETTLE_ID, V4_TAKE_ID],
params: [
settle(WETH_ADDR, WETH_03, false),
take(WETH_ADDR, OTHER_ADDR, 0n),
],
},
{
payment: "a SETTLE_ALL of WETH",
actions: [V4_TAKE_ID, V4_SETTLE_ALL_ID],
params: [
take(WETH_ADDR, OTHER_ADDR, WETH_03),
encodeV4SettleAll(WETH_ADDR, WETH_03),
],
},
])(
"a V4 step with $payment between them leaves the last step's minimum",
({ actions, params }) => {
const wethToOther = encodeV4Swap(
new Uint8Array(actions),
params,
);
const result = decodeSteps(
[0x00, 0x10, 0x08],
[V3_TO_WETH, wethToOther, V2_TO_WETH],
);
expect(minimum(result)).toEqual([
"Min. paid out",
"0.2000 WETH",
]);
},
);
test("a PERMIT2_TRANSFER_FROM of WETH between them leaves the last step's minimum", () => {
const result = decodeSteps(
[0x00, 0x02, 0x08],
[
V3_TO_WETH,
permit2TransferFrom(WETH_ADDR, OTHER_ADDR, WETH_03),
V2_TO_WETH,
],
);
expect(minimum(result)).toEqual([
"Min. paid out",
"0.2000 WETH",
]);
});
// The decoder reads no minimum from a V4 exact-out action.
test("a step that states no minimum leaves no figure", () => {
const exactOut = encodeV4Swap(
new Uint8Array([
V4_SWAP_EXACT_OUT_SINGLE_ID,
V4_SETTLE_ALL_ID,
V4_TAKE_ALL_ID,
]),
[
encodeV4ExactOutSingle(
USDT_ADDR,
WETH_ADDR,
WETH_02,
USDT_400,
),
encodeV4SettleAll(USDT_ADDR, USDT_400),
encodeV4TakeAll(WETH_ADDR, 0n),
],
);
const result = decodeSteps(
[0x10, 0x00],
[exactOut, V3_TO_WETH],
);
expect(minimum(result)).toBeUndefined();
});
test("a step that pays some of its WETH to the router leaves no figure", () => {
const result = decodeSteps(
[0x00, 0x10],
[
V3_TO_WETH,
v4ToWeth(
take(WETH_ADDR, USER_ADDR, WETH_01),
take(WETH_ADDR, ROUTER_ADDR, 0n),
),
],
);
expect(minimum(result)).toBeUndefined();
});
// The router still runs a swap step whose recipient cannot be
// read, and that step may spend the WETH the first step paid.
test("a step between them that cannot be read leaves no figure", () => {
const result = decodeSteps(
[0x00, 0x00, 0x08],
[
V3_TO_WETH,
dirtyWord(
encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
WETH_ADDR,
USDC_ADDR,
]),
0,
),
V2_TO_WETH,
],
);
expect(minimum(result)).toBeUndefined();
});
});
}); });
// https://git.eeqj.de/sneak/AutistMask/issues/359 — the output half, in // https://git.eeqj.de/sneak/AutistMask/issues/359 — the output half, in
@@ -4052,10 +4730,9 @@ describe("uniswap decoder", () => {
expect(detail(result, "Min. received").value).toBe("2.0000 USDC"); expect(detail(result, "Min. received").value).toBe("2.0000 USDC");
}); });
// With no minimum stated before it, a zero balance check is what sets the // A zero balance check sets neither Token Out nor the minimum. The route
// output side, and it guarantees nothing. No step pays anyone, so the // pays only the WRAP_ETH's WETH, to the router, where it stays.
// minimum is not said to be received. test("a zero balance check after a WRAP_ETH into the router names no output token and no minimum", () => {
test("a zero balance check with no earlier minimum states no minimum", () => {
const data = buildExecute( const data = buildExecute(
solidityPacked(["uint8", "uint8"], [0x0b, 0x0e]), solidityPacked(["uint8", "uint8"], [0x0b, 0x0e]),
[ [
@@ -4068,9 +4745,16 @@ describe("uniswap decoder", () => {
const result = uniswap.decode(data, ROUTER_ADDR, "0x1", {}, USER_ADDR); const result = uniswap.decode(data, ROUTER_ADDR, "0x1", {}, USER_ADDR);
expect(result).not.toBeNull(); expect(result).not.toBeNull();
expect(detail(result, "Token Out").value).toContain("USDT"); expect(detail(result, "Token Out").value).toBe(
expect(detail(result, "Min. paid out").value).toBe( "Unknown (not named in the calldata)",
"None (no minimum guaranteed)", );
expect(detail(result, "Min. paid out")).toBeUndefined();
expect(detail(result, "Min. received")).toBeUndefined();
expect(detail(result, "Paid to").value).toBe(
"The router, where it stays (no later step pays it out)",
);
expect(detail(result, "Token moved into the router").address).toBe(
WETH_ADDR,
); );
}); });
+96 -15
View File
@@ -42,8 +42,14 @@ jest.mock("../src/shared/log", () => ({
isDebug: () => false, isDebug: () => false,
})); }));
// Blockscout is asked only while the stored "Use Blockscout" is on.
globalThis.chrome = { globalThis.chrome = {
storage: { local: { get: async () => ({}), set: async () => {} } }, storage: {
local: {
get: async () => ({ autistmask: { useBlockscout: true } }),
set: async () => {},
},
},
}; };
const uniswap = require("../src/shared/uniswap"); const uniswap = require("../src/shared/uniswap");
@@ -682,6 +688,62 @@ describe("an UNWRAP_WETH makes the output ETH only when the router holds it", ()
]); ]);
}); });
// The same route, then a balance check of the sender's USDC with a zero
// minimum. The check guarantees nothing, so Token Out stays ETH
// (https://git.eeqj.de/sneak/AutistMask/issues/649).
test("the same route, then a zero balance check of USDC, still reads as ETH with no minimum", () => {
const result = decode(
execute(
v4Swap(
SWAP_USDT_FOR_WETH,
SETTLE_USDT,
take(WETH, MSG_SENDER, (ONE_WETH * 6n) / 10n),
take(WETH, ADDRESS_THIS),
),
unwrapWeth(MSG_SENDER),
balanceCheck(USDC, 0n),
),
);
expect(result.name).toBe("Swap USDT → ETH");
expect(detail(result, "Token Out").value).toBe("ETH");
expect(labels(result)).toEqual([
"Protocol",
"Token In",
"Amount",
"Token Out",
"Steps",
"Deadline",
]);
});
// A PERMIT2_TRANSFER_FROM moves the sender's WETH into the router. An
// UNWRAP_WETH pays that WETH to the user as ETH. A zero balance check of
// USDC sets neither Token Out nor the minimum, before the UNWRAP_WETH or
// after it (https://git.eeqj.de/sneak/AutistMask/issues/649).
test.each([
{
kind: "before the UNWRAP_WETH",
steps: [balanceCheck(USDC, 0n), unwrapWeth(MSG_SENDER)],
},
{
kind: "after the UNWRAP_WETH",
steps: [unwrapWeth(MSG_SENDER), balanceCheck(USDC, 0n)],
},
])(
"WETH moved into the router and unwrapped, with a zero balance check of USDC $kind, reads as ETH with no minimum",
({ steps }) => {
const result = decode(
execute(
permit2TransferFrom(WETH, ADDRESS_THIS, ONE_WETH),
...steps,
),
);
expect(detail(result, "Token Out").value).toBe("ETH");
expect(detail(result, "Min. received")).toBeUndefined();
expect(detail(result, "Min. paid out")).toBeUndefined();
},
);
// A TAKE the decoder cannot read may pay part of the WETH to the user. // A TAKE the decoder cannot read may pay part of the WETH to the user.
test("one V4 step paying WETH to the router beside a TAKE that cannot be read, then an UNWRAP_WETH, reads as ETH with no minimum", () => { test("one V4 step paying WETH to the router beside a TAKE that cannot be read, then an UNWRAP_WETH, reads as ETH with no minimum", () => {
const result = decode( const result = decode(
@@ -1655,9 +1717,18 @@ describe("any token left in the router is not received", () => {
), ),
min: "1990.0000 USDC", min: "1990.0000 USDC",
}, },
{ ])("$kind reads as a swap paid to the user", ({ data, min }) => {
kind: "a swap paying WETH to the router, an UNWRAP_WETH into the router, then a V4 swap settling all the ETH from the router", const result = decode(data);
data: execute( expect(labels(result)).toEqual(PAID_TO_USER);
expect(detail(result, "Min. received").value).toBe(min);
});
// https://git.eeqj.de/sneak/AutistMask/issues/682 — the SETTLE spends all
// the router's ETH, the transaction's value included, so the sender pays
// an amount the calldata does not state.
test("a swap paying WETH to the router, an UNWRAP_WETH into the router, then a V4 swap settling all the ETH from the router reads as a swap paid to the user", () => {
const result = decode(
execute(
swapToWeth(ADDRESS_THIS), swapToWeth(ADDRESS_THIS),
unwrapWeth(ADDRESS_THIS), unwrapWeth(ADDRESS_THIS),
v4Swap( v4Swap(
@@ -1666,12 +1737,23 @@ describe("any token left in the router is not received", () => {
takeAll(USDC), takeAll(USDC),
), ),
), ),
min: "1990.0000 USDC", );
}, expect(labels(result)).toEqual([
])("$kind reads as a swap paid to the user", ({ data, min }) => { "Protocol",
const result = decode(data); "Token In",
expect(labels(result)).toEqual(PAID_TO_USER); "Amount",
expect(detail(result, "Min. received").value).toBe(min); "Moved from the sender",
"Token moved",
"Moved to",
"Token Out",
"Min. received",
"Steps",
"Deadline",
]);
expect(detail(result, "Moved from the sender").value).toBe(
"Unknown (could not be decoded)",
);
expect(detail(result, "Min. received").value).toBe("1990.0000 USDC");
}); });
}); });
@@ -2794,17 +2876,16 @@ describe("the allow-revert flag", () => {
}, },
); );
test("a BALANCE_CHECK_ERC20 with the flag, and no minimum before it, states none", () => { test("a BALANCE_CHECK_ERC20 with the flag, and no minimum before it, names no output token and no minimum", () => {
const check = balanceCheck(WETH, ONE_WETH); const check = balanceCheck(WETH, ONE_WETH);
expect(detail(decode(execute(check)), "Min. paid out").value).toBe( expect(detail(decode(execute(check)), "Min. paid out").value).toBe(
"1.0000 WETH", "1.0000 WETH",
); );
const withFlag = decode(execute(flagged(check))); const withFlag = decode(execute(flagged(check)));
expect(detail(withFlag, "Token Out").address).toBe(WETH); expect(detail(withFlag, "Token Out").value).toBe(UNNAMED);
expect(detail(withFlag, "Min. paid out").value).toBe( expect(detail(withFlag, "Min. paid out")).toBeUndefined();
"None (no minimum guaranteed)", expect(detail(withFlag, "Min. received")).toBeUndefined();
);
}); });
// Only the routers from UniversalRouterV2 on let a PERMIT2_PERMIT fail. // Only the routers from UniversalRouterV2 on let a PERMIT2_PERMIT fail.
+7 -2
View File
@@ -34,8 +34,14 @@ jest.mock("../src/shared/log", () => ({
isDebug: () => false, isDebug: () => false,
})); }));
// Blockscout is asked only while the stored "Use Blockscout" is on.
globalThis.chrome = { globalThis.chrome = {
storage: { local: { get: async () => ({}), set: async () => {} } }, storage: {
local: {
get: async () => ({ autistmask: { useBlockscout: true } }),
set: async () => {},
},
},
}; };
const { state } = require("../src/shared/state"); const { state } = require("../src/shared/state");
@@ -288,7 +294,6 @@ async function historyRow(method, sentTo, chainId) {
const rows = await fetchRecentTransactions( const rows = await fetchRecentTransactions(
RECIPIENT, RECIPIENT,
"https://explorer.example/api/v2", "https://explorer.example/api/v2",
true,
chainId, chainId,
); );
return rows[0]; return rows[0];
+3
View File
@@ -90,6 +90,9 @@ function swapDetail(data, label) {
beforeEach(() => { beforeEach(() => {
state.trackedTokens = []; state.trackedTokens = [];
state.wallets = []; state.wallets = [];
// The approval screen reads the explorer's report only while "Use
// Blockscout" is on.
state.useBlockscout = true;
}); });
describe("a swap of a token outside the bundled list", () => { describe("a swap of a token outside the bundled list", () => {
+3 -3
View File
@@ -103,7 +103,7 @@ describe("balanceLine", () => {
}); });
test("an unknown quantity produces no fiat figure, a zero one does", () => { test("an unknown quantity produces no fiat figure, a zero one does", () => {
prices.NOVEL = 3; prices[NOVEL] = 3;
const unknown = balanceLine("NOVEL", null, 3, NOVEL); const unknown = balanceLine("NOVEL", null, 3, NOVEL);
const zero = balanceLine("NOVEL", 0, 3, NOVEL); const zero = balanceLine("NOVEL", 0, 3, NOVEL);
// A price times an unknown quantity is not $0.00: that is the same // A price times an unknown quantity is not $0.00: that is the same
@@ -162,7 +162,7 @@ describe("getAddressValue", () => {
// make it incomplete. // make it incomplete.
test("an unknown balance makes the total partial, a zero balance does not", () => { test("an unknown balance makes the total partial, a zero balance does not", () => {
prices.ETH = 2000; prices.ETH = 2000;
prices.NOVEL = 3; prices[NOVEL] = 3;
const unknown = getAddressValue(address(null)); const unknown = getAddressValue(address(null));
const zero = getAddressValue(address("0.0")); const zero = getAddressValue(address("0.0"));
expect(unknown).not.toEqual(zero); expect(unknown).not.toEqual(zero);
@@ -172,7 +172,7 @@ describe("getAddressValue", () => {
test("an unknown balance is not priced as zero of the token", () => { test("an unknown balance is not priced as zero of the token", () => {
prices.ETH = 2000; prices.ETH = 2000;
prices.NOVEL = 3; prices[NOVEL] = 3;
// The same row with a real quantity of 10 is worth $30. Neither that // The same row with a real quantity of 10 is worth $30. Neither that
// figure nor a confident $0.00 may be stated for the unknown one. // figure nor a confident $0.00 may be stated for the unknown one.
expect(getAddressValue(address("10.0"))).toEqual({ expect(getAddressValue(address("10.0"))).toEqual({
+11 -4
View File
@@ -72,8 +72,12 @@ global.fetch = jest.fn(() => {
throw new Error("tests must not perform network requests"); throw new Error("tests must not perform network requests");
}); });
// Blockscout is asked only while the stored "Use Blockscout" is on.
const { makeStorageStub } = require("./support/storageStub"); const { makeStorageStub } = require("./support/storageStub");
global.chrome = { storage: makeStorageStub(), runtime: { sendMessage() {} } }; global.chrome = {
storage: makeStorageStub({ autistmask: { useBlockscout: true } }),
runtime: { sendMessage() {} },
};
// A stub DOM. Every id in index.html that these two views touch resolves to a // A stub DOM. Every id in index.html that these two views touch resolves to a
// fresh recording element; nothing here depends on layout, only on what the // fresh recording element; nothing here depends on layout, only on what the
@@ -172,7 +176,7 @@ async function fetchOnto(items) {
statusText: "OK", statusText: "OK",
json: async () => items, json: async () => items,
})); }));
const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const balances = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
state.wallets = [ state.wallets = [
{ {
name: "Wallet 1", name: "Wallet 1",
@@ -197,14 +201,14 @@ async function fetchOntoBoth(itemsA, itemsB) {
statusText: "OK", statusText: "OK",
json: async () => itemsA, json: async () => itemsA,
})); }));
const a = await fetchTokenBalances(HOLDER, BLOCKSCOUT, true, []); const a = await fetchTokenBalances(HOLDER, BLOCKSCOUT, []);
debugFetch.mockImplementation(async () => ({ debugFetch.mockImplementation(async () => ({
ok: true, ok: true,
status: 200, status: 200,
statusText: "OK", statusText: "OK",
json: async () => itemsB, json: async () => itemsB,
})); }));
const b = await fetchTokenBalances(SECOND_HOLDER, BLOCKSCOUT, true, []); const b = await fetchTokenBalances(SECOND_HOLDER, BLOCKSCOUT, []);
state.wallets = [ state.wallets = [
{ {
name: "Wallet 1", name: "Wallet 1",
@@ -268,6 +272,9 @@ beforeEach(() => {
state.fraudContracts = []; state.fraudContracts = [];
state.hideLowHolderTokens = false; state.hideLowHolderTokens = false;
state.currentView = null; state.currentView = null;
// The screens save this page's copy of "Use Blockscout" over the stored
// one. So the page's copy is turned on here too.
state.useBlockscout = true;
}); });
describe("the Send screen resolves the scale rather than reading the stored one", () => { describe("the Send screen resolves the scale rather than reading the stored one", () => {